root/src/modules/collectd.xml

Revision 7d308b7989cb04229e214e3ca04435922d9965c8, 3.1 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 3 years ago)

make collect work better and support watches

  • 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></description>
4   <loader>C</loader>
5   <image>collectd.so</image>
6   <moduleconfig>
7     <parameter name="collectd_port"
8                required="required"
9                default="25826"
10                allowed="\d+">The port which collectd packets are received</parameter>
11     <parameter name="notifications"
12                required="options"
13                default="true"
14                allowed="(?:true|on|false|off)">Specify whether collectd notifications are acted upon.</parameter>
15   </moduleconfig>
16   <checkconfig>
17     <parameter name="security_level"
18                required="optional"
19                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>
20     <parameter name="username"
21                required="optional"
22                allowed=".+">The collectd username for authenticating signed and encrypted packets</parameter>
23     <parameter name="password"
24                required="optional"
25                allowed=".+">The collectd password for authenticating signed and encrypted packets</parameter>
26   </checkconfig>
27   <examples>
28     <example>
29       <title>Simple encrypted passive checking.</title>
30       <para>The following example allows a collectd agent to send any metric to the noit
31       system.  In this example the collectd agent must be version 4.7.0 to support encryption
32       and must be configured with parameters similar to the ones below.  Like the snmptrap
33       module the collectd disregards the timeout value completely, but uses the period to
34       batch all the checks in one commit.  If there are >1 metrics within the period the
35       check is marked as G and A for state and availability respectively.  The first program
36       listing shows a collectd configuration and the second listing shows the corresponding
37       check configuration in reconnoiter.</para>
38       <programlisting><![CDATA[
39       <Plugin network>
40         <Server "127.0.0.1" "25826">
41           SecurityLevel "encrypt"
42           Username "us3rname"
43           Password "s3cr3t"
44         </Server>
45       </Plugin>
46       ]]></programlisting>
47
48       <programlisting><![CDATA[
49       <noit>
50         <modules>
51           <module image="collectd" name="collectd">
52             <config>
53               <username>us3rname</username>
54               <password>s3cr3t</password>
55               <security_level>2</security_level>
56             </config>
57           </module>
58         </modules>
59         <checks>
60           <check uuid="1b4e28ba-2fa1-11d2-883f-e9b761bde3fb" module="collectd"
61                  period="60000" timeout="30000"/>
62         </checks>
63       </noit>
64       ]]></programlisting>
65     </example>
66   </examples>
67 </module>
Note: See TracBrowser for help on using the browser.