statsdedit

  • Version: 3.1.1
  • Released on: 2016-07-14
  • Changelog

statsd is a network daemon for aggregating statistics, such as counters and timers, and shipping over UDP to backend services, such as Graphite or Datadog. The general idea is that you send metrics to statsd and every few seconds it will emit the aggregated values to the backend. Example aggregates are sums, average and maximum values, their standard deviation, etc. This plugin makes it easy to send such metrics based on data in Logstash events.

You can learn about statsd here:

Typical examples of how this can be used with Logstash include counting HTTP hits by response code, summing the total number of bytes of traffic served, and tracking the 50th and 95th percentile of the processing time of requests.

Each metric emitted to statsd has a dot-separated path, a type, and a value. The metric path is built from the namespace and sender options together with the metric name that’s picked up depending on the type of metric. All in all, the metric path will follow this pattern:

namespace.sender.metric

With regards to this plugin, the default namespace is "logstash", the default sender is the host field, and the metric name depends on what is set as the metric name in the increment, decrement, timing, count, set or gauge options. In metric paths, colons (":"), pipes ("|") and at signs ("@") are reserved and will be replaced by underscores ("_").

Example:

output {
  statsd {
    host => "statsd.example.org"
    count => {
      "http.bytes" => "%{bytes}"
    }
  }
}

If run on a host named hal9000 the configuration above will send the following metric to statsd if the current event has 123 in its bytes field:

logstash.hal9000.http.bytes:123|c

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

statsd {
}

Available configuration options:

Setting Input typeRequiredDefault value

codec

codec

No

"plain"

count

hash

No

{}

decrement

array

No

[]

enable_metric

boolean

No

true

gauge

hash

No

{}

host

string

No

"localhost"

id

string

No

increment

array

No

[]

namespace

string

No

"logstash"

port

number

No

8125

sample_rate

number

No

1

sender

string

No

"%{host}"

set

hash

No

{}

timing

hash

No

{}

workers

<<,>>

No

1

Detailsedit

 

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.

countedit

  • Value type is hash
  • Default value is {}

A count metric. metric_name => count as hash. %{fieldname} substitutions are allowed in the metric names.

decrementedit

  • Value type is array
  • Default value is []

A decrement metric. Metric names as array. %{fieldname} substitutions are allowed in the metric names.

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.

gaugeedit

  • Value type is hash
  • Default value is {}

A gauge metric. metric_name => gauge as hash. %{fieldname} substitutions are allowed in the metric names.

hostedit

  • Value type is string
  • Default value is "localhost"

The hostname or IP address of the statsd server.

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

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

incrementedit

  • Value type is array
  • Default value is []

An increment metric. Metric names as array. %{fieldname} substitutions are allowed in the metric names.

namespaceedit

  • Value type is string
  • Default value is "logstash"

The statsd namespace to use for this metric. %{fieldname} substitutions are allowed.

portedit

  • Value type is number
  • Default value is 8125

The port to connect to on your statsd server.

sample_rateedit

  • Value type is number
  • Default value is 1

The sample rate for the metric.

senderedit

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

The name of the sender. Dots will be replaced with underscores. %{fieldname} substitutions are allowed.

setedit

  • Value type is hash
  • Default value is {}

A set metric. metric_name => "string" to append as hash. %{fieldname} substitutions are allowed in the metric names.

timingedit

  • Value type is hash
  • Default value is {}

A timing metric. metric_name => duration as hash. %{fieldname} substitutions are allowed in the metric names.

workersedit

  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne