Skip to content
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

Jump to bottom

docs: Update Processors/awsec2 readme #9567

Merged
merged 1 commit into from
Aug 3, 2021
Merged

docs: Update Processors/awsec2 readme #9567

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
21 changes: 18 additions & 3 deletions plugins/processors/aws/ec2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ to metrics associated with EC2 instances.

```toml
[[processors.aws_ec2]]
## Tags to attach to metrics. Available tags:
## Available tags:
## * accountId
## * architecture
## * availabilityZone
Expand All @@ -23,9 +23,19 @@ to metrics associated with EC2 instances.
## * ramdiskId
## * region
## * version
tags = []
imds_tags = []

## Timeout for http requests made by against AWS EC2 metadata endpoint.
## EC2 instance tags retrieved with DescribeTags action.
## In case tag is empty upon retrieval it's omitted when tagging metrics.
## Note that in order for this to work, role attached to EC2 instance or AWS
## credentials available from the environment must have a policy attached, that
## allows ec2:DescribeTags.
##
## For more information see:
## https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTags.html
ec2_tags = []

## Timeout for http requests made by against aws ec2 metadata endpoint.
timeout = "10s"

## ordered controls whether or not the metrics need to stay in the same order
Expand All @@ -35,6 +45,11 @@ to metrics associated with EC2 instances.
## depending on the order of metrics staying the same. If so, set this to true.
## Keeping the metrics ordered may be slightly slower.
ordered = false

## max_parallel_calls is the maximum number of AWS API calls to be in flight
## at the same time.
## It's probably best to keep this number fairly low.
max_parallel_calls = 10
```

## Example
Expand Down