root/src/modules/httptrap.xml

Revision 4a5b2f2c9dddb991a084bc3fc4ed37d3da07b28b, 2.0 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 3 years ago)

add secret param to docs

  • Property mode set to 100644
Line 
1 <module>
2   <name>httptrap</name>
3   <description><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></description>
4   <loader>C</loader>
5   <image>httptrap.so</image>
6   <moduleconfig>
7     <parameter name="asynch_metrics"
8                required="optional"
9                default="true"
10                allowed="(?:true|on|false|off)">Specify whether httptrap metrics are logged immediately or help until the status message is to be emitted.</parameter>
11   </moduleconfig>
12   <checkconfig>
13     <parameter name="asynch_metrics"
14                required="optional"
15                default="true"
16                allowed="(?:true|on|false|off)">Specify whether httptrap metrics are logged immediately or help until the status message is to be emitted.</parameter>
17     <parameter name="secret"
18                required="optional"
19                default=""
20                allowed=".+">Specify the secret with which metrics may be submitted.</parameter>
21   </checkconfig>
22   <examples>
23     <example>
24       <title>Posting a string and a number.</title>
25       <para><code>curl -X PUT https://noit:43191/module/httptrap/1b4e28ba-2fa1-11d2-893f-e9b761bde3fb/s3cr3tk3y</code></para>
26       <para>PUT payload:</para>
27       <programlisting><![CDATA[
28       { "version": "1.alpha",
29         "requests": 123853,
30         "bignumber": { "_type": "L", "_value": "18426744073707551616" }
31       }
32       ]]></programlisting>
33
34       <programlisting><![CDATA[
35       <noit>
36         <modules>
37           <module image="httptrap" name="httptrap"/>
38         </modules>
39         <checks>
40           <check uuid="1b4e28ba-2fa1-11d2-893f-e9b761bde3fb" module="httptrap"
41             target="127.0.0.1" period="60000" timeout="30000">
42             <config><secret>s3cr3tk3y</secret></config>
43           </check>
44         </checks>
45       </noit>
46       ]]></programlisting>
47     </example>
48   </examples>
49 </module>
Note: See TracBrowser for help on using the browser.