Skip to content

Commit

Permalink
all: document valid time duration units
Browse files Browse the repository at this point in the history
Also harmonise docs and clean up some copy/paste errors.
  • Loading branch information
efd6 committed Jul 26, 2023
1 parent 3aa857b commit f6ac0a7
Show file tree
Hide file tree
Showing 191 changed files with 495 additions and 232 deletions.
5 changes: 5 additions & 0 deletions packages/1password/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.16.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "1.15.0"
changes:
- description: Convert dashboard to lens.
Expand Down
3 changes: 2 additions & 1 deletion packages/1password/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: 1password
title: "1Password"
version: "1.15.0"
version: "1.16.0"
description: Collect logs from 1Password with Elastic Agent.
type: integration
categories:
Expand Down Expand Up @@ -57,6 +57,7 @@ policy_templates:
- name: http_client_timeout
type: text
title: HTTP Client Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: false
show_user: true
Expand Down
5 changes: 5 additions & 0 deletions packages/akamai/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "2.13.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "2.12.0"
changes:
- description: Add event limit parameter to REST endpoint stream.
Expand Down
3 changes: 2 additions & 1 deletion packages/akamai/data_stream/siem/manifest.yml
Expand Up @@ -46,6 +46,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP Client Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: false
show_user: true
Expand Down Expand Up @@ -177,7 +178,7 @@ streams:
required: false
show_user: true
default: 120s
description: Defines the maximum time that the sdk will wait for a bucket api response before timing out.
description: Defines the maximum time that the sdk will wait for a bucket api response before timing out. Valid time units are ns, us, ms, s, m, h.
- name: buckets
type: yaml
title: Buckets
Expand Down
2 changes: 1 addition & 1 deletion packages/akamai/manifest.yml
@@ -1,6 +1,6 @@
name: akamai
title: Akamai
version: "2.12.0"
version: "2.13.0"
description: Collect logs from Akamai with Elastic Agent.
type: integration
format_version: 2.7.0
Expand Down
5 changes: 5 additions & 0 deletions packages/atlassian_bitbucket/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.13.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "1.12.0"
changes:
- description: Document valid duration units.
Expand Down
Expand Up @@ -83,6 +83,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP Client Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: false
show_user: true
Expand Down
2 changes: 1 addition & 1 deletion packages/atlassian_bitbucket/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: atlassian_bitbucket
title: Atlassian Bitbucket
version: "1.12.0"
version: "1.13.0"
description: Collect logs from Atlassian Bitbucket with Elastic Agent.
type: integration
categories:
Expand Down
5 changes: 5 additions & 0 deletions packages/atlassian_confluence/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.14.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "1.13.0"
changes:
- description: Document valid duration units.
Expand Down
Expand Up @@ -91,6 +91,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP Client Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: false
show_user: true
Expand Down
2 changes: 1 addition & 1 deletion packages/atlassian_confluence/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: atlassian_confluence
title: Atlassian Confluence
version: "1.13.0"
version: "1.14.0"
description: Collect logs from Atlassian Confluence with Elastic Agent.
type: integration
categories:
Expand Down
5 changes: 5 additions & 0 deletions packages/atlassian_jira/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.14.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "1.13.0"
changes:
- description: Document valid duration units.
Expand Down
1 change: 1 addition & 0 deletions packages/atlassian_jira/data_stream/audit/manifest.yml
Expand Up @@ -91,6 +91,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP Client Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: false
show_user: true
Expand Down
2 changes: 1 addition & 1 deletion packages/atlassian_jira/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: atlassian_jira
title: Atlassian Jira
version: "1.13.0"
version: "1.14.0"
description: Collect logs from Atlassian Jira with Elastic Agent.
type: integration
categories:
Expand Down
5 changes: 5 additions & 0 deletions packages/bitwarden/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.1.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "1.0.1"
changes:
- description: Remove confusing error message tag prefix.
Expand Down
2 changes: 1 addition & 1 deletion packages/bitwarden/data_stream/collection/manifest.yml
Expand Up @@ -17,7 +17,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP client timeout
description: "Duration before declaring that the HTTP client connection has timed out. NOTE: Valid time units are ns, us, ms, s, m, h."
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: true
show_user: false
Expand Down
2 changes: 1 addition & 1 deletion packages/bitwarden/data_stream/event/manifest.yml
Expand Up @@ -25,7 +25,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP client timeout
description: "Duration before declaring that the HTTP client connection has timed out. NOTE: Valid time units are ns, us, ms, s, m, h."
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: true
show_user: false
Expand Down
2 changes: 1 addition & 1 deletion packages/bitwarden/data_stream/group/manifest.yml
Expand Up @@ -17,7 +17,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP client timeout
description: "Duration before declaring that the HTTP client connection has timed out. NOTE: Valid time units are ns, us, ms, s, m, h."
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: true
show_user: false
Expand Down
2 changes: 1 addition & 1 deletion packages/bitwarden/data_stream/policy/manifest.yml
Expand Up @@ -17,7 +17,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP client timeout
description: "Duration before declaring that the HTTP client connection has timed out. NOTE: Valid time units are ns, us, ms, s, m, h."
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: true
show_user: false
Expand Down
2 changes: 1 addition & 1 deletion packages/bitwarden/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: bitwarden
title: Bitwarden
version: "1.0.1"
version: "1.1.0"
source:
license: Elastic-2.0
description: Collect logs from Bitwarden with Elastic Agent.
Expand Down
5 changes: 5 additions & 0 deletions packages/carbon_black_cloud/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.12.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "1.11.0"
changes:
- description: Ensure event.kind is correctly set for pipeline errors.
Expand Down
10 changes: 5 additions & 5 deletions packages/carbon_black_cloud/data_stream/alert/manifest.yml
Expand Up @@ -9,15 +9,15 @@ streams:
- name: interval
type: text
title: Interval
description: Interval to fetch alerts from Carbon Black Cloud. NOTE:- Supported units for this parameter are h/m/s.
description: Interval to fetch alerts from Carbon Black Cloud. Supported units for this parameter are h/m/s.
multi: false
required: true
show_user: true
default: 1m
- name: initial_interval
type: text
title: Initial Interval
description: How far back to pull the alerts from the Carbon Black Cloud API. NOTE:- Supported units for this parameter are h/m/s.
description: How far back to pull the alerts from the Carbon Black Cloud API. Supported units for this parameter are h/m/s.
default: 24h
multi: false
required: true
Expand Down Expand Up @@ -67,7 +67,7 @@ streams:
required: false
show_user: true
default: 1m
description: Time interval for polling listing of the S3 bucket. NOTE:- Supported units for this parameter are h/m/s.
description: Time interval for polling listing of the S3 bucket. Supported units for this parameter are h/m/s.
- name: number_of_workers
type: integer
title: "[S3] Number of Workers"
Expand All @@ -83,15 +83,15 @@ streams:
required: false
show_user: true
default: 300s
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours. NOTE:- Supported units for this parameter are h/m/s.
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours. Supported units for this parameter are h/m/s.
- name: api_timeout
type: text
title: "[SQS] API Timeout"
multi: false
required: false
show_user: true
default: 120s
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value. NOTE:- Supported units for this parameter are h/m/s.
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value. Supported units for this parameter are h/m/s.
- name: max_number_of_messages
type: integer
title: "[SQS] Maximum Concurrent SQS Messages"
Expand Down
Expand Up @@ -9,7 +9,7 @@ streams:
- name: interval
type: text
title: Interval
description: Interval to query asset vulnerability summary in Carbon Black Cloud. NOTE:- Supported units for this parameter are h/m/s.
description: Interval to query asset vulnerability summary in Carbon Black Cloud. Supported units for this parameter are h/m/s.
multi: false
required: true
show_user: true
Expand Down
2 changes: 1 addition & 1 deletion packages/carbon_black_cloud/data_stream/audit/manifest.yml
Expand Up @@ -9,7 +9,7 @@ streams:
- name: interval
type: text
title: Interval
description: Interval to fetch audit logs from Carbon Black Cloud. NOTE:- Supported units for this parameter are h/m/s.
description: Interval to fetch audit logs from Carbon Black Cloud. Supported units for this parameter are h/m/s.
multi: false
required: true
show_user: true
Expand Down
Expand Up @@ -21,7 +21,7 @@ streams:
required: false
show_user: true
default: 1m
description: Time interval for polling listing of the S3 bucket. NOTE:- Supported units for this parameter are h/m/s.
description: Time interval for polling listing of the S3 bucket. Supported units for this parameter are h/m/s.
- name: number_of_workers
type: integer
title: "[S3] Number of Workers"
Expand All @@ -37,15 +37,15 @@ streams:
required: false
show_user: true
default: 300s
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours. NOTE:- Supported units for this parameter are h/m/s.
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours. Supported units for this parameter are h/m/s.
- name: api_timeout
type: text
title: "[SQS] API Timeout"
multi: false
required: false
show_user: true
default: 120s
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value. NOTE:- Supported units for this parameter are h/m/s.
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value. Supported units for this parameter are h/m/s.
- name: max_number_of_messages
type: integer
title: "[SQS] Maximum Concurrent SQS Messages"
Expand Down
Expand Up @@ -21,7 +21,7 @@ streams:
required: false
show_user: true
default: 1m
description: Time interval for polling listing of the S3 bucket. NOTE:- Supported units for this parameter are h/m/s.
description: Time interval for polling listing of the S3 bucket. Supported units for this parameter are h/m/s.
- name: number_of_workers
type: integer
title: "[S3] Number of Workers"
Expand All @@ -37,15 +37,15 @@ streams:
required: false
show_user: true
default: 300s
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours. NOTE:- Supported units for this parameter are h/m/s.
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours. Supported units for this parameter are h/m/s.
- name: api_timeout
type: text
title: "[SQS] API Timeout"
multi: false
required: false
show_user: true
default: 120s
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value. NOTE:- Supported units for this parameter are h/m/s.
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value. Supported units for this parameter are h/m/s.
- name: max_number_of_messages
type: integer
title: "[SQS] Maximum Concurrent SQS Messages"
Expand Down
2 changes: 1 addition & 1 deletion packages/carbon_black_cloud/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: carbon_black_cloud
title: VMware Carbon Black Cloud
version: "1.11.0"
version: "1.12.0"
description: Collect logs from VMWare Carbon Black Cloud with Elastic Agent.
type: integration
categories:
Expand Down
5 changes: 5 additions & 0 deletions packages/cisco_secure_endpoint/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "2.17.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "2.16.0"
changes:
- description: Document valid duration units.
Expand Down
Expand Up @@ -27,6 +27,7 @@ streams:
- name: http_client_timeout
type: text
title: HTTP Client Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are ns, us, ms, s, m, h.
multi: false
required: false
show_user: true
Expand Down
2 changes: 1 addition & 1 deletion packages/cisco_secure_endpoint/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: cisco_secure_endpoint
title: Cisco Secure Endpoint
version: "2.16.0"
version: "2.17.0"
description: Collect logs from Cisco Secure Endpoint (AMP) with Elastic Agent.
type: integration
categories:
Expand Down
5 changes: 5 additions & 0 deletions packages/cisco_umbrella/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.15.0"
changes:
- description: Document duration units.
type: enhancement
link: https://github.com/elastic/integrations/pull/6992
- version: "1.14.0"
changes:
- description: Ensure event.kind is correctly set for pipeline errors.
Expand Down
4 changes: 2 additions & 2 deletions packages/cisco_umbrella/data_stream/log/manifest.yml
Expand Up @@ -111,14 +111,14 @@ streams:
multi: false
required: false
show_user: false
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours.
description: The duration that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. The maximum is 12 hours. Valid time units are h, m, s.
- name: api_timeout
type: text
title: API Timeout
multi: false
required: false
show_user: false
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value.
description: The maximum duration of AWS API can take. The maximum is half of the visibility timeout value. Valid time units are h, m, s.
- name: fips_enabled
type: bool
title: Enable S3 FIPS
Expand Down
2 changes: 1 addition & 1 deletion packages/cisco_umbrella/manifest.yml
@@ -1,7 +1,7 @@
format_version: 2.7.0
name: cisco_umbrella
title: Cisco Umbrella
version: "1.14.0"
version: "1.15.0"
description: Collect logs from Cisco Umbrella with Elastic Agent.
type: integration
categories:
Expand Down

0 comments on commit f6ac0a7

Please sign in to comment.