StatsD client Python library
Geneos
You are currently viewing an older version of the documentation. End of life for version 5.x.x is scheduled for 30 September 2025.
If you are currently using version 5.x.x, we advise you to upgrade to the latest version before the EOL date. You can find the latest documentation here.

StatsD client Python library

Overview

This StatsD client itrsstatsd is a Python module used for collecting custom application metrics.

It is intended to be used with the Collection Agent and the StatsD plug-in. The workflow is as follows:

  1. The StatsD client sends metrics via UDP or TCP to the agent.
  2. The agent aggregates and reports the metrics every 10 seconds by default.

You need to have Python 3.7 or higher to use it.

Specification

The StatsD client is based on the StatsD protocol with the following enhancements:

  • Dimensions (tags) can be added to all metrics or to specific metrics.
  • Unit of measure can be specified per metric.

Install

To install the module from PyPi:

pip3 install itrsstatsd

You can also file the installation files at ITRS Downloads.

Usage

Once the module has been installed, documentation and usage examples are available via the pydoc:

pydoc3 itrsstatsd


­