itrsstatsd 1.3.0

ITRS StatsD Client

itrsstatsd

Python module for publishing custom metrics to an ITRS StatsD server.

The module is part of the Orchestrated Netprobe solution for collecting metrics in orchestrated environments. See the docs for complete details.

Requirements

• Python 3.7

Installation

The module is available via PyPI:

pip3 install itrsstatsd

Module Documentation

How to get and use a statsd API handle:

pydoc3 itrsstatsd  

API documentation:

pydoc3 itrsstatsd.api

Units of measure documentation:

pydoc3 itrsstatsd.units

Getting Started

from itrsstatsd import build_statsd
from itrsstatsd.units import Unit

# Create an instance of the client that sends to localhost:8125
statsd = build_statsd()

# Optionally add dimension(s) to all metrics
statsd.default_dimensions(app_name="pyapp")

# Record some metrics
statsd.increment("failed_logins")
statsd.gauge("cache_size", 52.5, Unit.Megabytes)
statsd.timer("query_time", 56)

Refer to the pydoc for complete usage details.

Change Log

v1.3.0 (2019-09-11)

New Features:

• License changed to BSD 3-Clause
• C2-77: Nano and micro resolution in timer metrics

Resolved:

• C2-78: Statsd client sends malformed message with sample rate

v1.2.0 (2019-08-23)

New Features:

• C2-72: Discard oldest metrics when sending queue full

v1.1.0 (2019-08-23)

New Features:

• C2-69: Statsd over TCP

v1.0.0 (2019-08-15)

First version.