Skip to content

statsd plugin
Plugin name statsd
Type read
Callbacks config, init, read, shutdown
Status supported
Since 5.4
Copyright 2013 Florian Forster
License MIT License
Configuration collectd.conf(5)

The StatsD plugin implements the StatsD network protocol to allow clients to report "events", such as the serving of a web page. These events are aggregated by collectd and dispatched regularly.

The plugin supports four event types:

  • Counter
  • Timer
  • Gauge
  • Set

It also supports "multi metric packets", i.e. packets containing multiple metrics and different metric types with the same name.

Synopsis

 <Plugin statsd>
   Host "::"
   Port "8125"
   DeleteSets     true
   TimerPercentile 90.0
 </Plugin>

Example graph

None yet. Add one now!

Dependencies

  • none

See also

Configuration

Configuration options · from collectd.conf(5)

See this section in the full configuration reference

The statsd plugin listens to a UDP socket, reads "events" in the statsd protocol and dispatches rates or other aggregates of these numbers periodically.

The plugin implements the Counter, Timer, Gauge and Set types which are dispatched as the collectd types derive, latency, gauge and objects respectively.

The following configuration options are valid:

Host Host
Bind to the hostname / address Host. By default, the plugin will bind to the "any" address, i.e. accept packets sent to any of the hosts addresses.
Port Port
UDP port to listen to. This can be either a service name or a port number. Defaults to 8125.
DeleteCounters false|true
DeleteTimers false|true
DeleteGauges false|true
DeleteSets false|true
These options control what happens if metrics are not updated in an interval. If set to False, the default, metrics are dispatched unchanged, i.e. the rate of counters and size of sets will be zero, timers report NaN and gauges are unchanged. If set to True, the such metrics are not dispatched and removed from the internal cache.
CounterSum false|true
When enabled, creates a count metric which reports the change since the last read. This option primarily exists for compatibility with the statsd implementation by Etsy.
TimerPercentile Percent

Calculate and dispatch the configured percentile, i.e. compute the latency, so that Percent of all reported timers are smaller than or equal to the computed latency. This is useful for cutting off the long tail latency, as it's often done in Service Level Agreements (SLAs).

Different percentiles can be calculated by setting this option several times. If none are specified, no percentiles are calculated / dispatched.

TimerLower false|true
TimerUpper false|true
TimerSum false|true
TimerCount false|true

Calculate and dispatch various values out of Timer metrics received during an interval. If set to False, the default, these values aren't calculated / dispatched.

Please note what reported timer values less than 0.001 are ignored in all Timer* reports.