Cloudwatch output plugin

This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:

Path to YAML file containing a hash of AWS credentials. This file will only be loaded if access_key_id and secret_access_key aren’t set. The contents of the file should look like this:

    :access_key_id: "12345"
    :secret_access_key: "54321"

How many data points can be given in one call to the CloudWatch API

The default dimensions [ name, value, …​ ] to use for events which do not have a CW_dimensions field

The name of the field used to set the dimensions on an event metric The field named here, if present in an event, must have an array of one or more key & value pairs, for example…​ add_field => [ "CW_dimensions", "Environment", "CW_dimensions", "prod" ] or, equivalently…​ add_field => [ "CW_dimensions", "Environment" ] add_field => [ "CW_dimensions", "prod" ]

The name of the field used to set the metric name on an event The author of this plugin recommends adding this field to events in inputs & filters rather than using the per-output default setting so that one output plugin on your logstash indexer can serve all events (which of course had fields set on your logstash shippers.)

The name of the field used to set a different namespace per event Note: Only one namespace can be sent to CloudWatch per API call so setting different namespaces will increase the number of API calls and those cost money.

The name of the field used to set the unit on an event metric

The name of the field used to set the value (float) on an event metric

The default metric name to use for events which do not have a CW_metricname field. Beware: If this is provided then all events which pass through this output will be aggregated and sent to CloudWatch, so use this carefully. Furthermore, when providing this option, you will probably want to also restrict events from passing through this output using event type, tag, and field matching

The default namespace to use for events which do not have a CW_namespace field

URI to proxy server if required

How many events to queue before forcing a call to the CloudWatch API ahead of timeframe schedule Set this to the number of events-per-timeframe you will be sending to CloudWatch to avoid extra API calls

The AWS Region

The AWS Secret Access Key

The AWS Session token for temporary credential

Constants aggregate_key members Units How often to send data to CloudWatch This does not affect the event timestamps, events will always have their actual timestamp (to-the-minute) sent to CloudWatch.

We only call the API if there is data to send.

See the Rufus Scheduler docs for an explanation of allowed values

The default unit to use for events which do not have a CW_unit field If you set this option you should probably set the "value" option along with it

The default value to use for events which do not have a CW_value field If provided, this must be a string which can be converted to a float, for example…​ "1", "2.34", ".5", and "0.67" If you set this option you should probably set the unit option along with it

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 cloudwatch outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  cloudwatch {
    id => "my_plugin_id"
  }
}