IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« datadog email »

› ›

datadog_metrics

edit

datadog_metrics

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-datadog_metrics.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

datadog_metrics {
    api_key => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`api_key`	string	Yes
`codec`	codec	No	`"plain"`
`dd_tags`	array	No
`device`	string	No	`"%{metric_device}"`
`host`	string	No	`"%{host}"`
`metric_name`	string	No	`"%{metric_name}"`
`metric_type`	string, one of `["gauge", "counter", "%{metric_type}"]`	No	`"%{metric_type}"`
`metric_value`	<<,>>	No	`"%{metric_value}"`
`queue_size`	number	No	`10`
`timeframe`	number	No	`10`
`workers`	number	No	`1`

Details

edit

`api_key`

edit

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

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

`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.

`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

<li> Value type is <<string,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

`workers`

edit

Value type is number
Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

« datadog email »