blob: 11f7aa4de5b3051f9be283dc06ad8de024135924 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
.. Python StatsD documentation master file, created by
sphinx-quickstart on Mon Apr 9 15:47:23 2012.
You can adapt this file completely to your liking, but it should at
least contain the root `toctree` directive.
Welcome to Python StatsD's documentation!
=========================================
statsd_ is a friendly front-end to Graphite_. This is a Python client
for the statsd daemon.
.. image:: https://travis-ci.org/jsocol/pystatsd.png?branch=master
:target: https://travis-ci.org/jsocol/pystatsd
:alt: Travis-CI build status
.. image:: https://pypip.in/v/statsd/badge.png
:target: https://pypi.python.org/pypi/statsd/
:alt: Latest release
.. image:: https://pypip.in/d/statsd/badge.png
:target: https://pypi.python.org/pypi/statsd/
:alt: Downloads
: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:
.. code-block:: pycon
>>> 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:
.. code-block:: pycon
>>> 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:
.. code-block:: bash
$ pip install statsd
Or GitHub:
.. code-block:: bash
$ pip install -e git+https://github.com/jsocol/pystatsd#egg=statsd
Or from source:
.. code-block:: bash
$ 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
reference.rst
contributing.rst
Indices and tables
------------------
* :ref:`search`
.. _statsd: https://github.com/etsy/statsd
.. _Graphite: https://graphite.readthedocs.io/
|
