Adding upstream version 1.34.4.

Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-05-24 07:26:29 +02:00 · 2025-05-24 07:26:29 +02:00 · 4978089aab
commit 4978089aab
parent e393c3af3f
4963 changed files with 677545 additions and 0 deletions
--- a/plugins/outputs/cloudwatch_logs/README.md
+++ b/plugins/outputs/cloudwatch_logs/README.md
@ -0,0 +1,114 @@
+# Amazon CloudWatch Logs Output Plugin
+
+This plugin writes log-metrics to the [Amazon CloudWatch][cloudwatch] service.
+
+⭐ Telegraf v1.19.0
+🏷️ cloud, logging
+💻 all
+
+[cloudwatch]: https://aws.amazon.com/cloudwatch
+
+## Amazon Authentication
+
+This plugin uses a credential chain for Authentication with the CloudWatch Logs
+API endpoint. In the following order the plugin will attempt to authenticate.
+
+1. Web identity provider credentials via STS if `role_arn` and
+   `web_identity_token_file` are specified
+1. Assumed credentials via STS if `role_arn` attribute is specified (source
+   credentials are evaluated from subsequent rules). The `endpoint_url`
+   attribute is used only for Cloudwatch Logs service. When fetching
+   credentials, STS global endpoint will be used.
+1. Explicit credentials from `access_key`, `secret_key`, and `token` attributes
+1. Shared profile from `profile` attribute
+1. [Environment Variables][1]
+1. [Shared Credentials][2]
+1. [EC2 Instance Profile][3]
+
+The IAM user needs the following permissions (see this [reference][4] for more):
+
+- `logs:DescribeLogGroups` - required for check if configured log group exist
+- `logs:DescribeLogStreams` - required to view all log streams associated with a
+  log group.
+- `logs:CreateLogStream` - required to create a new log stream in a log group.)
+- `logs:PutLogEvents` - required to upload a batch of log events into log
+  stream.
+
+[1]: https://github.com/aws/aws-sdk-go/wiki/configuring-sdk#environment-variables
+[2]: https://github.com/aws/aws-sdk-go/wiki/configuring-sdk#shared-credentials-file
+[3]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
+[4]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/permissions-reference-cwl.html
+
+## Global configuration options <!-- @/docs/includes/plugin_config.md -->
+
+In addition to the plugin-specific configuration settings, plugins support
+additional global and plugin configuration settings. These settings are used to
+modify metrics, tags, and field or create aliases and configure ordering, etc.
+See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
+
+[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
+
+## Configuration
+
+```toml @sample.conf
+# Configuration for AWS CloudWatchLogs output.
+[[outputs.cloudwatch_logs]]
+  ## The region is the Amazon region that you wish to connect to.
+  ## Examples include but are not limited to:
+  ## - us-west-1
+  ## - us-west-2
+  ## - us-east-1
+  ## - ap-southeast-1
+  ## - ap-southeast-2
+  ## ...
+  region = "us-east-1"
+
+  ## Amazon Credentials
+  ## Credentials are loaded in the following order
+  ## 1) Web identity provider credentials via STS if role_arn and
+  ##    web_identity_token_file are specified
+  ## 2) Assumed credentials via STS if role_arn is specified
+  ## 3) explicit credentials from 'access_key' and 'secret_key'
+  ## 4) shared profile from 'profile'
+  ## 5) environment variables
+  ## 6) shared credentials file
+  ## 7) EC2 Instance Profile
+  #access_key = ""
+  #secret_key = ""
+  #token = ""
+  #role_arn = ""
+  #web_identity_token_file = ""
+  #role_session_name = ""
+  #profile = ""
+  #shared_credential_file = ""
+
+  ## Endpoint to make request against, the correct endpoint is automatically
+  ## determined and this option should only be set if you wish to override the
+  ## default, e.g endpoint_url = "http://localhost:8000"
+  # endpoint_url = ""
+
+  ## Cloud watch log group. Must be created in AWS cloudwatch logs upfront!
+  ## For example, you can specify the name of the k8s cluster here to group logs
+  ## from all cluster in oine place
+  log_group = "my-group-name"
+
+  ## Log stream in log group
+  ## Either log group name or reference to metric attribute, from which it can
+  ## be parsed, tag:<TAG_NAME> or field:<FIELD_NAME>. If the log stream is not
+  ## exist, it will be created. Since AWS is not automatically delete logs
+  ## streams with expired logs entries (i.e. empty log stream) you need to put
+  ## in place appropriate house-keeping (https://forums.aws.amazon.com/thread.jspa?threadID=178855)
+  log_stream = "tag:location"
+
+  ## Source of log data - metric name
+  ## specify the name of the metric, from which the log data should be
+  ## retrieved. I.e., if you are using docker_log plugin to stream logs from
+  ## container, then specify log_data_metric_name = "docker_log"
+  log_data_metric_name  = "docker_log"
+
+  ## Specify from which metric attribute the log data should be retrieved:
+  ## tag:<TAG_NAME> or field:<FIELD_NAME>.
+  ## I.e., if you are using docker_log plugin to stream logs from container,
+  ## then specify log_data_source = "field:message"
+  log_data_source  = "field:message"
+```