blob: 70fff0ff984b374e86c4f1463a08253a9b096939 [file] [log] [blame]
Ales Komareka75a89c2014-01-19 17:50:15 +01001
Ales Komarek89938d82017-02-19 20:19:29 +01002==============
3Statsd formula
4==============
Ales Komareka75a89c2014-01-19 17:50:15 +01005
Ales Komarek97a1ebb2014-08-08 08:11:36 +02006Simple daemon for easy stats aggregation.
7
Ales Komarek89938d82017-02-19 20:19:29 +01008
Ales Komarekf7fb4522015-10-20 17:02:34 +02009Sample pillars
10==============
Ales Komareka75a89c2014-01-19 17:50:15 +010011
Ales Komarek1b21d0c2014-08-08 08:09:47 +020012Standalone Statsd server with Graphite/carbon backend
Ales Komarekceefc482014-04-10 10:13:23 +020013
Ales Komarek434a5982016-01-15 16:40:13 +010014.. code-block:: yaml
15
Ales Komarek92ab7662014-01-19 18:01:45 +010016 statsd:
17 server:
18 enabled: true
Ales Komareka9717312014-01-19 18:02:39 +010019 bind:
20 port: 8125
21 address: 0.0.0.0
Ales Komarek1b21d0c2014-08-08 08:09:47 +020022 backend:
23 engine: carbon
24 host: metrics1.domain.com
25 port: 2003
26
27Standalone Statsd server with Graphite/AMQP backend
28
Ales Komarek434a5982016-01-15 16:40:13 +010029.. code-block:: yaml
30
Ales Komarek1b21d0c2014-08-08 08:09:47 +020031 statsd:
32 server:
33 enabled: true
34 bind:
35 port: 8125
36 address: 0.0.0.0
37 backend:
38 engine: amqp
39 host: metrics1.domain.com
Ales Komarek434a5982016-01-15 16:40:13 +010040 port: 5672
41
Ales Komarek1b21d0c2014-08-08 08:09:47 +020042
43Standalone Statsd server with OpenTSDB backend
44
Ales Komarek434a5982016-01-15 16:40:13 +010045.. code-block:: yaml
46
Ales Komarek1b21d0c2014-08-08 08:09:47 +020047 statsd:
48 server:
49 enabled: true
50 bind:
51 port: 8125
52 address: 0.0.0.0
53 backend:
54 engine: amqp
Ales Komarek92ab7662014-01-19 18:01:45 +010055 host: metrics1.domain.com
56 port: 2003
Ales Komarek89938d82017-02-19 20:19:29 +010057
58
59More information
60================
Ales Komareka75a89c2014-01-19 17:50:15 +010061
62* https://github.com/etsy/statsd/
Ales Komarek1b21d0c2014-08-08 08:09:47 +020063* https://github.com/mrtazz/statsd-amqp-backend
64* https://github.com/danslimmon/statsd-opentsdb-backend
Filip Pytloun51af22c2017-02-02 13:02:03 +010065
Ales Komarek89938d82017-02-19 20:19:29 +010066
Filip Pytloun51af22c2017-02-02 13:02:03 +010067Documentation and Bugs
68======================
69
70To learn how to install and update salt-formulas, consult the documentation
71available online at:
72
73 http://salt-formulas.readthedocs.io/
74
75In the unfortunate event that bugs are discovered, they should be reported to
76the appropriate issue tracker. Use Github issue tracker for specific salt
77formula:
78
79 https://github.com/salt-formulas/salt-formula-statsd/issues
80
81For feature requests, bug reports or blueprints affecting entire ecosystem,
82use Launchpad salt-formulas project:
83
84 https://launchpad.net/salt-formulas
85
86You can also join salt-formulas-users team and subscribe to mailing list:
87
88 https://launchpad.net/~salt-formulas-users
89
90Developers wishing to work on the salt-formulas projects should always base
91their work on master branch and submit pull request against specific formula.
92
93 https://github.com/salt-formulas/salt-formula-statsd
94
95Any questions or feedback is always welcome so feel free to join our IRC
96channel:
97
98 #salt-formulas @ irc.freenode.net