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

« Sqs output plugin Stdout output plugin »

› ›

Statsd output plugin

edit

Statsd output plugin

edit

Plugin version: v3.2.0
Released on: 2018-06-05
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-statsd. 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

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

Statsd Output Configuration Options

edit

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

Setting	Input type	Required
`count`	hash	No
`decrement`	array	No
`gauge`	hash	No
`host`	string	No
`increment`	array	No
`namespace`	string	No
`port`	number	No
`sample_rate`	number	No
`sender`	string	No
`set`	hash	No
`timing`	hash	No

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

`count`

edit

Value type is hash
Default value is {}

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

`decrement`

edit

Value type is array
Default value is []

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

`gauge`

edit

Value type is hash
Default value is {}

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

`host`

edit

Value type is string
Default value is "localhost"

The hostname or IP address of the statsd server.

`increment`

edit

Value type is array
Default value is []

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

`namespace`

edit

Value type is string
Default value is "logstash"

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

`port`

edit

Value type is number
Default value is 8125

The port to connect to on your statsd server.

`protocol`

edit

Value type is string
Default value is "udp"

The protocol to connect to on your statsd server.

`sample_rate`

edit

Value type is number
Default value is 1

The sample rate for the metric.

`sender`

edit

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

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

`set`

edit

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.

`timing`

edit

Value type is hash
Default value is {}

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

Common Options

edit

The following 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 statsd outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  statsd {
    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.

« Sqs output plugin Stdout output plugin »