This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Datadog output plugin Dynatrace plugin »

› ›

Datadog_metrics output plugin

edit

Datadog_metrics output plugin

edit

Plugin version: v3.0.6
Released on: 2024-08-09
Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

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.

Getting help

edit

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.

Description

edit

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.

Datadog_metrics Output Configuration Options

edit

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

Setting	Input type	Required
`api_key`	password	Yes
`api_url`	string	No
`dd_tags`	array	No
`device`	string	No
`host`	string	No
`metric_name`	string	No
`metric_type`	string, one of `["gauge", "counter", "%{metric_type}"]`	No
`metric_value`	<<,>>	No
`queue_size`	number	No
`timeframe`	number	No

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

`api_key`

edit

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

`api_url`

edit

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

Set the api endpoint for Datadog EU Site users

`dd_tags`

edit

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.

`device`

edit

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

The name of the device that produced the metric.

`host`

edit

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

The name of the host that produced the metric.

`metric_name`

edit

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

The name of the time series.

`metric_type`

edit

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

The type of the metric.

`metric_value`

edit

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

The value.

`queue_size`

edit

Value type is number
Default value is 10

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

`timeframe`

edit

Value type is number
Default value is 10

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

Common options

edit

These configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

`codec`

edit

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.

`enable_metric`

edit

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.

`id`

edit

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"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

« Datadog output plugin Dynatrace plugin »