community.general.statsd – Send metrics to StatsD

Note

This plugin is part of the community.general collection (version 2.5.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.statsd.

New in version 2.1.0: of community.general

Synopsis

• The statsd module sends metrics to StatsD.

• For more information, see https://statsd-metrics.readthedocs.io/en/latest/.

• Supported metric types are counter and gauge. Currently unupported metric types are timer, set, and gaugedelta.

Requirements

The below requirements are needed on the host that executes this module.

• statsd

Parameters

Parameter	Choices/Defaults	Comments
delta boolean	Choices: no ← yes	If the metric is of type gauge, change the value by delta.
host string	Default: "localhost"	StatsD host (hostname or IP) to send metrics to.
metric string / required		The name of the metric.
metric_prefix string		The prefix to add to the metric.
metric_type string / required	Choices: counter gauge	The type of metric.
port integer	Default: 8125	The port on host which StatsD is listening on.
protocol string	Choices: udp ← tcp	The transport protocol to send metrics over.
state string	Choices: present ←	State of the check, only present makes sense.
timeout float	Default: 1.0	Sender timeout, only applicable if protocol is tcp.
value integer / required		The value of the metric.

Examples

- name: Increment the metric my_counter by 1
  community.general.statsd:
    host: localhost
    port: 9125
    protocol: tcp
    metric: my_counter
    metric_type: counter
    value: 1

- name: Set the gauge my_gauge to 7
  community.general.statsd:
    host: localhost
    port: 9125
    protocol: tcp
    metric: my_gauge
    metric_type: gauge
    value: 7

Authors

• Mark Mercado (@mamercad)