|
Revision 76bc8e8991f5ed9e8336b0130c92de4d48def93c, 3.4 kB
(checked in by Theo Schlossnagle <jesus@omniti.com>, 1 year ago)
|
fix ntp default port in docs and do sweeping docs update
|
- Property mode set to
100644
|
| Line | |
|---|
| 1 |
<?xml version="1.0"?> |
|---|
| 2 |
<section> |
|---|
| 3 |
<title>statsd</title> |
|---|
| 4 |
<para>The statsd module provides a simple way to push data into reconnoiter from other applications. See https://github.com/etsy/statsd for more details.</para> |
|---|
| 5 |
<variablelist> |
|---|
| 6 |
<varlistentry> |
|---|
| 7 |
<term>loader</term> |
|---|
| 8 |
<listitem> |
|---|
| 9 |
<para>C</para> |
|---|
| 10 |
</listitem> |
|---|
| 11 |
</varlistentry> |
|---|
| 12 |
<varlistentry> |
|---|
| 13 |
<term>image</term> |
|---|
| 14 |
<listitem> |
|---|
| 15 |
<para>statsd.so</para> |
|---|
| 16 |
</listitem> |
|---|
| 17 |
</varlistentry> |
|---|
| 18 |
</variablelist> |
|---|
| 19 |
<section> |
|---|
| 20 |
<title>Module Configuration</title> |
|---|
| 21 |
<variablelist> |
|---|
| 22 |
<varlistentry> |
|---|
| 23 |
<term>port</term> |
|---|
| 24 |
<listitem> |
|---|
| 25 |
<variablelist> |
|---|
| 26 |
<varlistentry> |
|---|
| 27 |
<term>required</term> |
|---|
| 28 |
<listitem> |
|---|
| 29 |
<para>optional</para> |
|---|
| 30 |
</listitem> |
|---|
| 31 |
</varlistentry> |
|---|
| 32 |
<varlistentry> |
|---|
| 33 |
<term>default</term> |
|---|
| 34 |
<listitem> |
|---|
| 35 |
<para>8125</para> |
|---|
| 36 |
</listitem> |
|---|
| 37 |
</varlistentry> |
|---|
| 38 |
<varlistentry> |
|---|
| 39 |
<term>allowed</term> |
|---|
| 40 |
<listitem> |
|---|
| 41 |
<para>^\d+$</para> |
|---|
| 42 |
</listitem> |
|---|
| 43 |
</varlistentry> |
|---|
| 44 |
</variablelist> |
|---|
| 45 |
<para>The port on which to listen for statsd packets.</para> |
|---|
| 46 |
</listitem> |
|---|
| 47 |
</varlistentry> |
|---|
| 48 |
</variablelist> |
|---|
| 49 |
<variablelist> |
|---|
| 50 |
<varlistentry> |
|---|
| 51 |
<term>packets_per_cycle</term> |
|---|
| 52 |
<listitem> |
|---|
| 53 |
<variablelist> |
|---|
| 54 |
<varlistentry> |
|---|
| 55 |
<term>required</term> |
|---|
| 56 |
<listitem> |
|---|
| 57 |
<para>optional</para> |
|---|
| 58 |
</listitem> |
|---|
| 59 |
</varlistentry> |
|---|
| 60 |
<varlistentry> |
|---|
| 61 |
<term>default</term> |
|---|
| 62 |
<listitem> |
|---|
| 63 |
<para>100</para> |
|---|
| 64 |
</listitem> |
|---|
| 65 |
</varlistentry> |
|---|
| 66 |
<varlistentry> |
|---|
| 67 |
<term>allowed</term> |
|---|
| 68 |
<listitem> |
|---|
| 69 |
<para>^\d+$</para> |
|---|
| 70 |
</listitem> |
|---|
| 71 |
</varlistentry> |
|---|
| 72 |
</variablelist> |
|---|
| 73 |
<para>The number of packets to recv() during each eventer cycle.</para> |
|---|
| 74 |
</listitem> |
|---|
| 75 |
</varlistentry> |
|---|
| 76 |
</variablelist> |
|---|
| 77 |
<variablelist> |
|---|
| 78 |
<varlistentry> |
|---|
| 79 |
<term>check</term> |
|---|
| 80 |
<listitem> |
|---|
| 81 |
<variablelist> |
|---|
| 82 |
<varlistentry> |
|---|
| 83 |
<term>required</term> |
|---|
| 84 |
<listitem> |
|---|
| 85 |
<para>optional</para> |
|---|
| 86 |
</listitem> |
|---|
| 87 |
</varlistentry> |
|---|
| 88 |
<varlistentry> |
|---|
| 89 |
<term>allowed</term> |
|---|
| 90 |
<listitem> |
|---|
| 91 |
<para>^[0-9a-fA-F]{4}(?:[0-9a-fA-F]{4}-){4}[0-9a-fA-F]{12}$</para> |
|---|
| 92 |
</listitem> |
|---|
| 93 |
</varlistentry> |
|---|
| 94 |
</variablelist> |
|---|
| 95 |
<para>A specific check to which all statsd data will be delegated.</para> |
|---|
| 96 |
</listitem> |
|---|
| 97 |
</varlistentry> |
|---|
| 98 |
</variablelist> |
|---|
| 99 |
</section> |
|---|
| 100 |
<section> |
|---|
| 101 |
<title>Check Configuration</title> |
|---|
| 102 |
</section> |
|---|
| 103 |
<example> |
|---|
| 104 |
<title>A sample statsd configuration.</title> |
|---|
| 105 |
<programlisting> |
|---|
| 106 |
<noit> |
|---|
| 107 |
<modules> |
|---|
| 108 |
<module image="statsd" name="statsd"/> |
|---|
| 109 |
</modules> |
|---|
| 110 |
<checks> |
|---|
| 111 |
<check uuid="1b4e28ba-2fa1-11d2-893f-e9b761bde3fb" module="statsd" |
|---|
| 112 |
target="127.0.0.1" period="60000" timeout="30000"> |
|---|
| 113 |
<config><port>8125</port></config> |
|---|
| 114 |
</check> |
|---|
| 115 |
</checks> |
|---|
| 116 |
</noit> |
|---|
| 117 |
</programlisting> |
|---|
| 118 |
</example> |
|---|
| 119 |
</section> |
|---|
