Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
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
statsd module sends metrics to StatsD.counter and gauge. Currently unupported metric types are timer, set, and gaugedelta.The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| delta boolean |
| 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 |
| The type of metric. |
| port integer | Default: 8125 | The port on host which StatsD is listening on. |
| protocol string |
| The transport protocol to send metrics over. |
| state string |
| 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. |
- 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
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/statsd_module.html