Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 3.16 KB

README.md

File metadata and controls

62 lines (48 loc) · 3.16 KB
Raw

AWS CloudWatch Logs Exporter

Status
Stability beta
Supported pipeline types logs
Distributions contrib

AWS CloudWatch Logs Exporter sends logs data to AWS CloudWatch Logs. AWS credentials are retrieved from the default credential chain. Region must be configured in the configuration if not set in the default credential chain.

NOTE: OpenTelemetry Logging support is experimental, hence this exporter is subject to change.

Configuration

The following settings are required:

  • log_group_name: The group name of the CloudWatch logs.
  • log_stream_name: The stream name of the CloudWatch logs.

The following settings can be optionally configured:

  • region: The AWS region where the log stream is in.
  • endpoint: The CloudWatch Logs service endpoint which the requests are forwarded to. See the CloudWatch Logs endpoints for a list.
  • log_retention: LogRetention is the option to set the log retention policy for only newly created CloudWatch Log Groups. Defaults to Never Expire if not specified or set to 0. Possible values for retention in days are 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, or 3653.
  • tags: Tags is the option to set tags for the CloudWatch Log Group. If specified, please add at most 50 tags. Input is a string to string map like so: { 'key': 'value' }. Keys must be between 1-128 characters and follow the regex pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$(alphanumerics, whitespace, and _.:/=+-!). Values must be between 1-256 characters and follow the regex pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$(alphanumerics, whitespace, and _.:/=+-!). Link to tagging restrictions
  • role_arn: The AWS IAM role to upload segments to a same/different account
  • raw_log: Boolean default false. If you want to export only the log message to cw logs. This is required for emf logs.

Examples

Simplest configuration:

exporters:
  awscloudwatchlogs:
    log_group_name: "testing-logs"
    log_stream_name: "testing-integrations-stream"

All configuration options:

exporters:
  awscloudwatchlogs:
    log_group_name: "testing-logs"
    log_stream_name: "testing-integrations-stream"
    region: "us-east-1"
    role_arn: "arn:aws:iam::123456789:role/monitoring-application-logs"
    endpoint: "logs.us-east-1.amazonaws.com"
    log_retention: 365
    tags: { 'sampleKey': 'sampleValue'}
    sending_queue:
      queue_size: 50
    retry_on_failure:
      enabled: true
      initial_interval: 10ms