Datadog_metrics output plugin

• Plugin version: v3.0.7
• Released on: 2024-10-25
• Changelog

For other versions, see the Versioned plugin docs.

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-datadog_metrics. See Working with plugins for more details.

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

This output lets you send metrics to DataDogHQ based on Logstash events. Default queue_size and timeframe are low in order to provide near realtime alerting. If you do not use Datadog for alerting, consider raising these thresholds.

This plugin supports the following configuration options plus the Common options described later.

Also see Common options for a list of options supported by all output plugins.

• This is a required setting.
• Value type is password
• There is no default value for this setting.

Your DatadogHQ API key. https://app.datadoghq.com/account/settings#api

• Value type is string
• Default value is "https://api.datadoghq.com/api/v1/series"

Set the api endpoint for Datadog EU Site users

• Value type is array
• There is no default value for this setting.

Set any custom tags for this event, default are the Logstash tags if any.

• Value type is string
• Default value is "%{{metric_device}}"

The name of the device that produced the metric.

• Value type is string
• Default value is %{{host}}

The name of the host that produced the metric.

• Value type is string
• Default value is "%{{metric_name}}"

The name of the time series.

• Value can be any of: gauge, counter, %{{metric_type}}
• Default value is "%{{metric_type}}"

The type of the metric.

• Value type is string
• Default value is "%{{metric_value}}"

The value.

• Value type is number
• Default value is 10

How many events to queue before flushing to Datadog prior to schedule set in @timeframe

• Value type is number
• Default value is 10

How often (in seconds) to flush queued events to Datadog

These configuration options are supported by all output plugins:

• Value type is codec
• Default value is "plain"

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.

• Value type is boolean
• Default value is true

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.

• Value type is string
• There is no default value for this setting.

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 datadog_metrics outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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