index.rst

Welcome to Python StatsD's documentation!

statsd is a friendly front-end to Graphite. This is a Python client for the statsd daemon.

Code:	https://github.com/jsocol/pystatsd
License:	MIT; see LICENSE file
Issues:	https://github.com/jsocol/pystatsd/issues
Documentation:	https://statsd.readthedocs.io/

Quickly, to use:

>>> import statsd
>>> c = statsd.StatsClient('localhost', 8125)
>>> c.incr('foo')  # Increment the 'foo' counter.
>>> c.timing('stats.timed', 320)  # Record a 320ms 'stats.timed'.

You can also add a prefix to all your stats:

>>> import statsd
>>> c = statsd.StatsClient('localhost', 8125, prefix='foo')
>>> c.incr('bar')  # Will be 'foo.bar' in statsd/graphite.

Installing

The easiest way to install statsd is with pip!

You can install from PyPI:

$ pip install statsd

Or GitHub:

$ pip install -e git+https://github.com/jsocol/pystatsd#egg=statsd

Or from source:

$ git clone https://github.com/jsocol/pystatsd
$ cd statsd
$ python setup.py install

Contents

.. toctree::
   :maxdepth: 2

   configure.rst
   types.rst
   timing.rst
   pipeline.rst
   tcp.rst
   unix_socket.rst
   async.rst
   reference.rst
   contributing.rst

Indices and tables

• :ref:`search`