Welcome to Statsd Metrics’s documentation!¶
Contents:
Introduction¶
Statsd metrics is an API to create, parse or send metrics to a Statsd server.
Metric Classes¶
Metric classes are used to define the data type and values for each metric, and to create the contents of the request that will be setn to the Statsd server.
Available metrics:
The metrics
module also provides helper functions to normalize metric names, and a parse a Statsd request
and return the corresponding metric object. This could be used on the server side to parse the received requests.
Clients¶
Client
: Default client, sends request on each call using UDPBatchClient
: Buffers metrics and flushes them in batch requests using UDPTCPClient
: Sends request on each call using TCPTCPBatchClient
: Buffers metrics and flushes them in batch requests using TCP
Installation¶
pip install statsdmetrics
Dependencies¶
There are no specific dependencies, it runs on Python 2.7+ (CPython 2.7, 3.2, 3.3 3.4 and 3.5, PyPy 2.6 and PyPy3 2.4, and Jython 2.7 are tested)
However on development (and test) environment mock is required, and distutilazy (or setuptools as a fallback) is used to run the tests.
# on dev/test env
pip install -r requirements-dev.txt
License¶
Statsd metrics is released under the terms of the MIT license.
Development¶
- Code is on GitHub
- Documentations are on Read The Docs