Skip to content

Cherry-pick #16731 to 7.x: [Metricbeat] Add documentation for tags_filter and tags #16759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaiyan-sheng merged 1 commit into from
Mar 3, 2020
Merged

Cherry-pick #16731 to 7.x: [Metricbeat] Add documentation for tags_filter and tags #16759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions metricbeat/docs/modules/aws.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,9 @@ metricbeat.modules:
credential_profile_name: test-mb
metricsets:
- ec2
tags_filter:
- key: "Organization"
value: "Engineering"
- module: aws
period: 300s
credential_profile_name: test-mb
Expand Down Expand Up @@ -292,6 +295,9 @@ metricbeat.modules:
- namespace: AWS/EBS
- namespace: AWS/ELB
tags.resource_type_filter: elasticloadbalancing
tags:
- key: "Organization"
value: "Engineering"
- module: aws
period: 60s
credential_profile_name: test-mb
Expand Down
6 changes: 6 additions & 0 deletions x-pack/metricbeat/metricbeat.reference.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,9 @@ metricbeat.modules:
credential_profile_name: test-mb
metricsets:
- ec2
tags_filter:
- key: "Organization"
value: "Engineering"
- module: aws
period: 300s
credential_profile_name: test-mb
Expand Down Expand Up @@ -213,6 +216,9 @@ metricbeat.modules:
- namespace: AWS/EBS
- namespace: AWS/ELB
tags.resource_type_filter: elasticloadbalancing
tags:
- key: "Organization"
value: "Engineering"
- module: aws
period: 60s
credential_profile_name: test-mb
Expand Down
6 changes: 6 additions & 0 deletions x-pack/metricbeat/module/aws/_meta/config.reference.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
credential_profile_name: test-mb
metricsets:
- ec2
tags_filter:
- key: "Organization"
value: "Engineering"
- module: aws
period: 300s
credential_profile_name: test-mb
Expand Down Expand Up @@ -32,6 +35,9 @@
- namespace: AWS/EBS
- namespace: AWS/ELB
tags.resource_type_filter: elasticloadbalancing
tags:
- key: "Organization"
value: "Engineering"
- module: aws
period: 60s
credential_profile_name: test-mb
Expand Down
8 changes: 8 additions & 0 deletions x-pack/metricbeat/module/aws/cloudwatch/_meta/docs.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ For example, specifying a resource type of ec2 returns all Amazon EC2 resources
only EC2 instances.
* *statistic*: Statistics are metric data aggregations over specified periods of time.
By default, statistic includes Average, Sum, Count, Maximum and Minimum.
* *tags*: The tags to filter against. If tags are given in config, then only
collect metrics from resources that have tag key and tag value matches the filter.
For example, if tags parameter is given as `Organization=Engineering` under
`AWS/ELB` namespace, then only collect metrics from ELBs with tag name equals to
`Organization` and tag value equals to `Engineering`.

[float]
=== Configuration examples
Expand All @@ -48,6 +53,9 @@ in configurations in order for this metricset to make proper AWS API calls.
- namespace: AWS/EBS <1>
- namespace: AWS/ELB <2>
tags.resource_type_filter: elasticloadbalancing
tags:
- key: "Organization"
value: "Engineering"
- namespace: AWS/EC2 <3>
name: CPUUtilization
statistic: ["Average"]
Expand Down