Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / statsd / 79fca5d81116ee91a636fbfc6a681188eb537e58 / . / README.rst
blob: a473d987853e323b55d82387167a8485c93a22e3 [file] [log] [blame]
Ales Komareka75a89c2014-01-19 17:50:15 +0100[diff] [blame]1
Ales Komarek89938d82017-02-19 20:19:29 +0100[diff] [blame]2==============
3Statsd formula
4==============
Ales Komareka75a89c2014-01-19 17:50:15 +0100[diff] [blame]5
Ales Komarek97a1ebb2014-08-08 08:11:36 +0200[diff] [blame]6Simple daemon for easy stats aggregation.
7
Ales Komarek89938d82017-02-19 20:19:29 +0100[diff] [blame]8
Ales Komarekf7fb4522015-10-20 17:02:34 +0200[diff] [blame]9Sample pillars
10==============
Ales Komareka75a89c2014-01-19 17:50:15 +0100[diff] [blame]11
Ales Komarek1b21d0c2014-08-08 08:09:47 +0200[diff] [blame]12Standalone Statsd server with Graphite/carbon backend
Ales Komarekceefc482014-04-10 10:13:23 +0200[diff] [blame]13
Ales Komarek434a5982016-01-15 16:40:13 +0100[diff] [blame]14.. code-block:: yaml
15
Ales Komarek92ab7662014-01-19 18:01:45 +0100[diff] [blame]16 statsd:
17 server:
18 enabled: true
Ales Komareka9717312014-01-19 18:02:39 +0100[diff] [blame]19 bind:
20 port: 8125
21 address: 0.0.0.0
Ales Komarek1b21d0c2014-08-08 08:09:47 +0200[diff] [blame]22 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 +0100[diff] [blame]29.. code-block:: yaml
30
Ales Komarek1b21d0c2014-08-08 08:09:47 +0200[diff] [blame]31 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 +0100[diff] [blame]40 port: 5672
Ales Komarek1b21d0c2014-08-08 08:09:47 +0200[diff] [blame]41
42Standalone Statsd server with OpenTSDB backend
43
Ales Komarek434a5982016-01-15 16:40:13 +0100[diff] [blame]44.. code-block:: yaml
45
Ales Komarek1b21d0c2014-08-08 08:09:47 +0200[diff] [blame]46 statsd:
47 server:
48 enabled: true
49 bind:
50 port: 8125
51 address: 0.0.0.0
52 backend:
Martin Polreich79fca5d2018-07-18 12:19:14 +0200[diff] [blame^]53 engine: opentsdb
Ales Komarek92ab7662014-01-19 18:01:45 +0100[diff] [blame]54 host: metrics1.domain.com
55 port: 2003
Ales Komarek89938d82017-02-19 20:19:29 +0100[diff] [blame]56
57
58More information
59================
Ales Komareka75a89c2014-01-19 17:50:15 +0100[diff] [blame]60
61* https://github.com/etsy/statsd/
Ales Komarek1b21d0c2014-08-08 08:09:47 +0200[diff] [blame]62* https://github.com/mrtazz/statsd-amqp-backend
63* https://github.com/danslimmon/statsd-opentsdb-backend
Filip Pytloun51af22c2017-02-02 13:02:03 +0100[diff] [blame]64
Ales Komarek89938d82017-02-19 20:19:29 +0100[diff] [blame]65
Filip Pytloun51af22c2017-02-02 13:02:03 +0100[diff] [blame]66Documentation and Bugs
67======================
68
69To learn how to install and update salt-formulas, consult the documentation
70available online at:
71
72 http://salt-formulas.readthedocs.io/
73
74In the unfortunate event that bugs are discovered, they should be reported to
75the appropriate issue tracker. Use Github issue tracker for specific salt
76formula:
77
78 https://github.com/salt-formulas/salt-formula-statsd/issues
79
80For feature requests, bug reports or blueprints affecting entire ecosystem,
81use Launchpad salt-formulas project:
82
83 https://launchpad.net/salt-formulas
84
85You can also join salt-formulas-users team and subscribe to mailing list:
86
87 https://launchpad.net/~salt-formulas-users
88
89Developers wishing to work on the salt-formulas projects should always base
90their work on master branch and submit pull request against specific formula.
91
92 https://github.com/salt-formulas/salt-formula-statsd
93
94Any questions or feedback is always welcome so feel free to join our IRC
95channel:
96
97 #salt-formulas @ irc.freenode.net