From 4ea39142424a27ad3da3ec700a8b771e666ffbd3 Mon Sep 17 00:00:00 2001 From: kaiyan-sheng Date: Mon, 18 Oct 2021 14:48:53 -0600 Subject: [PATCH] Add config parameter descriptions into README.md (#1917) --- packages/aws/_dev/build/docs/README.md | 14 ++++++++++++++ packages/aws/changelog.yml | 5 +++++ packages/aws/docs/README.md | 14 ++++++++++++++ packages/aws/manifest.yml | 2 +- 4 files changed, 34 insertions(+), 1 deletion(-) diff --git a/packages/aws/_dev/build/docs/README.md b/packages/aws/_dev/build/docs/README.md index 6aadab7573e..c40242cdf67 100644 --- a/packages/aws/_dev/build/docs/README.md +++ b/packages/aws/_dev/build/docs/README.md @@ -15,6 +15,20 @@ AWS credentials are required for running AWS integration. * *endpoint*: URL of the entry point for an AWS web service. * *role_arn*: AWS IAM Role to assume. +#### Data stream specific configuration parameters +* *latency*: Some AWS services send monitoring metrics to CloudWatch with a +latency to process larger than Metricbeat collection period. This will cause +data points missing or none get collected by Metricbeat. In this case, please +specify a latency parameter so collection start time and end time will be +shifted by the given latency amount. +* *period*: How often the data stream is executed. +* *regions*: Specify which AWS regions to query metrics from. If the `regions` +is not set in the config, then by default, the integration will query metrics +from all available AWS regions. If `endpoint` is specified, `regions` becomes a +required config parameter. +* *tags_filter*: Tag key value pairs from aws resources. A tag is a label that +user assigns to an AWS resource. + ### Credential Types There are three types of AWS credentials can be used: access keys, temporary security credentials and IAM role ARN. diff --git a/packages/aws/changelog.yml b/packages/aws/changelog.yml index edeb44215e3..8b76874bc19 100644 --- a/packages/aws/changelog.yml +++ b/packages/aws/changelog.yml @@ -1,4 +1,9 @@ # newer versions go on top +- version: "1.3.1" + changes: + - description: Add config parameter descriptions + type: enhancement + link: https://github.com/elastic/integrations/pull/1917 - version: "1.3.0" changes: - description: Add WAF datastream diff --git a/packages/aws/docs/README.md b/packages/aws/docs/README.md index 6aadab7573e..c40242cdf67 100644 --- a/packages/aws/docs/README.md +++ b/packages/aws/docs/README.md @@ -15,6 +15,20 @@ AWS credentials are required for running AWS integration. * *endpoint*: URL of the entry point for an AWS web service. * *role_arn*: AWS IAM Role to assume. +#### Data stream specific configuration parameters +* *latency*: Some AWS services send monitoring metrics to CloudWatch with a +latency to process larger than Metricbeat collection period. This will cause +data points missing or none get collected by Metricbeat. In this case, please +specify a latency parameter so collection start time and end time will be +shifted by the given latency amount. +* *period*: How often the data stream is executed. +* *regions*: Specify which AWS regions to query metrics from. If the `regions` +is not set in the config, then by default, the integration will query metrics +from all available AWS regions. If `endpoint` is specified, `regions` becomes a +required config parameter. +* *tags_filter*: Tag key value pairs from aws resources. A tag is a label that +user assigns to an AWS resource. + ### Credential Types There are three types of AWS credentials can be used: access keys, temporary security credentials and IAM role ARN. diff --git a/packages/aws/manifest.yml b/packages/aws/manifest.yml index b12cb44d190..d5ff93c8e35 100644 --- a/packages/aws/manifest.yml +++ b/packages/aws/manifest.yml @@ -1,7 +1,7 @@ format_version: 1.0.0 name: aws title: AWS -version: 1.3.0 +version: 1.3.1 license: basic description: This integration collects logs and metrics from Amazon Web Services (AWS) type: integration