datadog_metricsedit

  • Version: 3.0.0
  • Released on: 2016-09-09
  • Changelog
Note

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

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.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

datadog_metrics {
    api_key => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

api_key

string

Yes

codec

codec

No

"plain"

dd_tags

array

No

device

string

No

"%{metric_device}"

enable_metric

boolean

No

true

host

string

No

"%{host}"

id

string

No

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

<<,>>

No

1

Detailsedit

 

api_keyedit

  • 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

codecedit

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

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

deviceedit

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

The name of the device that produced the metric.

enable_metricedit

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

hostedit

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

The name of the host that produced the metric.

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

metric_nameedit

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

The name of the time series.

metric_typeedit

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

The type of the metric.

metric_valueedit

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

The value.

queue_sizeedit

  • Value type is number
  • Default value is 10

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

timeframeedit

  • Value type is number
  • Default value is 10

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

workersedit

  • Value type is string
  • Default value is 1