sprockets.clients.statsd

The sprockets.clients.statsd package implements a simple statsd client that is used by the sprockets.mixins.statsd package. It can be used in your applications for sending metric values to statsd.

The default statsd server that is used is localhost:8125. The STATSD environment variable can be used to set the statsd server connection parameters. This should take the form of a URL, such as udp://statsd.service:8675. Note that the socket for communicating with statsd is created once upon module import and will not change until the application is restarted or the module is reloaded.

Installation

sprockets.clients.statsd is available on the Python Package Index and can be installed via pip or easy_install:

pip install sprockets.clients.statsd

Documentation

https://sprocketsclientsstatsd.readthedocs.org

Example

The following example demonstrates how to use sprockets.clients.statsd by incrementing a counter, setting a gauge value, and adding a timing value:

from sprockets.clients import statsd

# Increment foo.bar.baz by 1
statsd.incr('foo', 'bar', 'baz')

# Set a gauge value
statsd.set_gauge('foo', 'bar', 'baz', value=10)

# Add a timing value
statsd.add_timing('foo', 'bar', 'baz', value=3.14159)