root/src/modules/collectd.xml

Revision df11ea950c1f8d4c95b1f013004cd5c8f3611fff, 3.7 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 1 year ago)

update actual docs

  • Property mode set to 100644
Line 
1 <module>
2   <name>collectd</name>
3   <description><para>The collectd module provides collectd support for Reconnoiter.  The collectd modules listens on a UDP port and waits for metrics to come from a collectd agent. It also provides support for signing and encrypting metrics from the collectd agent, which is supported in version 4.7.0 and above.  Only one is supported per target.</para>
4     <para>Additionally, this module registers a REST handler to support collectd's write_http output plugin.  This exposes a REST endpoint at /module/collectd.</para></description>
5   <loader>C</loader>
6   <image>collectd.so</image>
7   <moduleconfig>
8     <parameter name="collectd_port"
9                required="required"
10                default="25826"
11                allowed="\d+">The port which collectd packets are received</parameter>
12     <parameter name="notifications"
13                required="options"
14                default="true"
15                allowed="(?:true|on|false|off)">Specify whether collectd notifications are acted upon.</parameter>
16   </moduleconfig>
17   <checkconfig>
18     <parameter name="security_level"
19                required="optional"
20                allowed="\d+">An integer detailing the security level which to allow.  0 for all packets allowed, 1 for signed and encrypted packets allowed, 2 for only encrypted packets allowed.</parameter>
21     <parameter name="username"
22                required="optional"
23                allowed=".+">The collectd username for authenticating signed and encrypted packets. Also the username used for HTTP authentication when using the write_http ingestion method.</parameter>
24     <parameter name="secret"
25                required="optional"
26                allowed=".+">The collectd password for authenticating signed and encrypted packets. Also the password used for HTTP authentication when using the write_http ingestion method.</parameter>
27   </checkconfig>
28   <examples>
29     <example>
30       <title>Simple encrypted passive checking.</title>
31       <para>The following example allows a collectd agent to send any metric to the noit
32       system.  In this example the collectd agent must be version 4.7.0 to support encryption
33       and must be configured with parameters similar to the ones below.  Like the snmptrap
34       module the collectd disregards the timeout value completely, but uses the period to
35       batch all the checks in one commit.  If there are >1 metrics within the period the
36       check is marked as G and A for state and availability respectively.  The first program
37       listing shows a collectd configuration and the second listing shows the corresponding
38       check configuration in reconnoiter.</para>
39       <programlisting><![CDATA[
40       <Plugin network>
41         <Server "127.0.0.1" "25826">
42           SecurityLevel "encrypt"
43           Username "us3rname"
44           Password "s3cr3t"
45         </Server>
46       </Plugin>
47
48       <Plugin write_http>
49         <URL "https://127.0.0.1:43191/module/collectd/">
50           User "us3rname"
51           Password "s3cr3t"
52           VerifyPeer false
53           VerifyHost false
54           CACert "/etc/ssl/ca.crt"
55           Format "JSON"
56           StoreRates false
57         </URL>
58       </Plugin>
59       ]]></programlisting>
60
61       <programlisting><![CDATA[
62       <noit>
63         <modules>
64           <module image="collectd" name="collectd">
65             <config>
66               <username>us3rname</username>
67               <secret>s3cr3t</secret>
68               <security_level>2</security_level>
69             </config>
70           </module>
71         </modules>
72         <checks>
73           <check uuid="1b4e28ba-2fa1-11d2-883f-e9b761bde3fb" module="collectd"
74                  target="127.0.0.1" period="60000" timeout="30000"/>
75         </checks>
76       </noit>
77       ]]></programlisting>
78     </example>
79   </examples>
80 </module>
Note: See TracBrowser for help on using the browser.