statsd
editstatsd
editstatsd 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 most basic coverage of this plugin is that the namespace, sender, and metric names are combined into the full metric path like so:
`namespace.sender.metric`
The general idea is that you send statsd count or latency data and every few
seconds it will emit the aggregated values to the backend. Example aggregates are
average
, max
, stddev
, etc.
You can learn about statsd here:
A simple example usage of this is to count HTTP hits by response code; to learn more about that, check out the ../tutorials/metrics-from-logs[log metrics tutorial]
The default final metric sent to statsd would look like this:
`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
variable.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
statsd { }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
Details
edit
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.
debug
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is boolean
-
Default value is
false
Enable debugging.
exclude_tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without any of these tags. Optional.
namespace
edit- Value type is string
-
Default value is
"logstash"
The statsd namespace to use for this metric.
sender
edit- Value type is string
-
Default value is
"%{host}"
The name of the sender. Dots will be replaced with underscores.
set
edit- Value type is hash
-
Default value is
{}
A set metric. metric_name => "string"
to append as hash
tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all of these tags. Optional.
type
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- 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.