| Line | |
|---|
| 1 |
<?xml version="1.0"?> |
|---|
| 2 |
<section> |
|---|
| 3 |
<title>httptrap</title> |
|---|
| 4 |
<para>The httptrap module provides a simple way to push data into reconnoiter from other applications. Simply structure a json document and use the PUT method against reconnoiter's psuedo-webserver on port 43191.</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>httptrap.so</para> |
|---|
| 16 |
</listitem> |
|---|
| 17 |
</varlistentry> |
|---|
| 18 |
</variablelist> |
|---|
| 19 |
<section> |
|---|
| 20 |
<title>Module Configuration</title> |
|---|
| 21 |
<variablelist> |
|---|
| 22 |
<varlistentry> |
|---|
| 23 |
<term>asynch_metrics</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>true</para> |
|---|
| 36 |
</listitem> |
|---|
| 37 |
</varlistentry> |
|---|
| 38 |
<varlistentry> |
|---|
| 39 |
<term>allowed</term> |
|---|
| 40 |
<listitem> |
|---|
| 41 |
<para>(?:true|on|false|off)</para> |
|---|
| 42 |
</listitem> |
|---|
| 43 |
</varlistentry> |
|---|
| 44 |
</variablelist> |
|---|
| 45 |
<para>Specify whether httptrap metrics are logged immediately or help until the status message is to be emitted.</para> |
|---|
| 46 |
</listitem> |
|---|
| 47 |
</varlistentry> |
|---|
| 48 |
</variablelist> |
|---|
| 49 |
</section> |
|---|
| 50 |
<section> |
|---|
| 51 |
<title>Check Configuration</title> |
|---|
| 52 |
<variablelist> |
|---|
| 53 |
<varlistentry> |
|---|
| 54 |
<term>asynch_metrics</term> |
|---|
| 55 |
<listitem> |
|---|
| 56 |
<variablelist> |
|---|
| 57 |
<varlistentry> |
|---|
| 58 |
<term>required</term> |
|---|
| 59 |
<listitem> |
|---|
| 60 |
<para>optional</para> |
|---|
| 61 |
</listitem> |
|---|
| 62 |
</varlistentry> |
|---|
| 63 |
<varlistentry> |
|---|
| 64 |
<term>default</term> |
|---|
| 65 |
<listitem> |
|---|
| 66 |
<para>true</para> |
|---|
| 67 |
</listitem> |
|---|
| 68 |
</varlistentry> |
|---|
| 69 |
<varlistentry> |
|---|
| 70 |
<term>allowed</term> |
|---|
| 71 |
<listitem> |
|---|
| 72 |
<para>(?:true|on|false|off)</para> |
|---|
| 73 |
</listitem> |
|---|
| 74 |
</varlistentry> |
|---|
| 75 |
</variablelist> |
|---|
| 76 |
<para>Specify whether httptrap metrics are logged immediately or help until the status message is to be emitted.</para> |
|---|
| 77 |
</listitem> |
|---|
| 78 |
</varlistentry> |
|---|
| 79 |
</variablelist> |
|---|
| 80 |
</section> |
|---|
| 81 |
<example> |
|---|
| 82 |
<title>Posting a string and a number.</title> |
|---|
| 83 |
<para> |
|---|
| 84 |
<code>curl -X PUT https://noit:43191/module/httptrap/1b4e28ba-2fa1-11d2-893f-e9b761bde3fb/s3cr3tk3y</code> |
|---|
| 85 |
</para> |
|---|
| 86 |
<para>PUT payload:</para> |
|---|
| 87 |
<programlisting> |
|---|
| 88 |
{ "version": "1.alpha", |
|---|
| 89 |
"requests": 123853, |
|---|
| 90 |
"bignumber": { "_type": "L", "_value": "18426744073707551616" } |
|---|
| 91 |
} |
|---|
| 92 |
</programlisting> |
|---|
| 93 |
<programlisting> |
|---|
| 94 |
<noit> |
|---|
| 95 |
<modules> |
|---|
| 96 |
<module image="httptrap" name="httptrap"/> |
|---|
| 97 |
</modules> |
|---|
| 98 |
<checks> |
|---|
| 99 |
<check uuid="1b4e28ba-2fa1-11d2-893f-e9b761bde3fb" module="httptrap" |
|---|
| 100 |
target="127.0.0.1" period="60000" timeout="30000"> |
|---|
| 101 |
<config><secret>s3cr3tk3y</secret></config> |
|---|
| 102 |
</check> |
|---|
| 103 |
</checks> |
|---|
| 104 |
</noit> |
|---|
| 105 |
</programlisting> |
|---|
| 106 |
</example> |
|---|
| 107 |
</section> |
|---|
