datadog_metrics

Milestone: 1

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

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.

Synopsis

This is what it might look like in your config file:
output {
  datadog_metrics {
    api_key => ... # string (required)
    codec => ... # codec (optional), default: "plain"
    dd_tags => ... # array (optional)
    device => ... # string (optional), default: "%{metric_device}"
    host => ... # string (optional), default: "%{host}"
    metric_name => ... # string (optional), default: "%{metric_name}"
    metric_type => ... # string, one of ["gauge", "counter", "%{metric_type}"] (optional), default: "%{metric_type}"
    metric_value => ... #  (optional), default: "%{metric_value}"
    queue_size => ... # number (optional), default: 10
    timeframe => ... # number (optional), default: 10
    workers => ... # number (optional), default: 1
  }
}

Details

api_key (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

  • 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

  • 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

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

The name of the device that produced the metric.

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

host

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

The name of the host that produced the metric.

metric_name

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

The name of the time series.

metric_type

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

The type of the metric.

metric_value

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

The value.

queue_size

  • Value type is number
  • Default value is 10

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

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

timeframe

  • Value type is number
  • Default value is 10

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

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

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


This is documentation from lib/logstash/outputs/datadog_metrics.rb