Skip to main content

aws_cloudwatch

Send metrics to AWS CloudWatch using the PutMetricData endpoint.

Introduced in version 3.36.0.

# Common config fields, showing default values
metrics:
  aws_cloudwatch:
    namespace: Benthos
  mapping: ""

It is STRONGLY recommended that you reduce the metrics that are exposed with a mapping like this:

metrics:
  mapping: |
    if ![
      "input_received",
      "input_latency",
      "output_sent",
    ].contains(this) { deleted() }
  aws_cloudwatch:
    namespace: Foo

Fields​

namespace​

The namespace used to distinguish metrics from other services.

Type: string
Default: "Benthos"

flush_period​

The period of time between PutMetricData requests.

Type: string
Default: "100ms"

region​

The AWS region to target.

Type: string
Default: ""

endpoint​

Allows you to specify a custom endpoint for the AWS API.

Type: string
Default: ""

credentials​

Optional manual configuration of AWS credentials to use. More information can be found in this document.

Type: object

credentials.profile​

A profile from ~/.aws/credentials to use.

Type: string
Default: ""

credentials.id​

The ID of credentials to use.

Type: string
Default: ""

credentials.secret​

The secret for the credentials being used.

Type: string
Default: ""

credentials.token​

The token for the credentials being used, required when using short term credentials.

Type: string
Default: ""

credentials.role​

A role ARN to assume.

Type: string
Default: ""

credentials.role_external_id​

An external ID to provide when assuming a role.

Type: string
Default: ""