| 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>snmp.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="snmptrapd_host" |
|---|
| 12 |
required="optional" |
|---|
| 13 |
default="*" |
|---|
| 14 |
allowed="\d+">The host interface on which packets are accepted.</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.</para> |
|---|
| 36 |
<programlisting><![CDATA[ |
|---|
| 37 |
<Plugin network> |
|---|
| 38 |
<Server "127.0.0.1" "25826"> |
|---|
| 39 |
SecurityLevel "encrypt" |
|---|
| 40 |
Username "us3rname" |
|---|
| 41 |
Password "s3cr3t" |
|---|
| 42 |
</Server> |
|---|
| 43 |
</Plugin> |
|---|
| 44 |
|
|---|
| 45 |
<noit> |
|---|
| 46 |
<modules> |
|---|
| 47 |
<module image="collectd" name="collectd"> |
|---|
| 48 |
<config> |
|---|
| 49 |
<username>us3rname</username> |
|---|
| 50 |
<password>s3cr3t</password> |
|---|
| 51 |
<security_level>2</security_level> |
|---|
| 52 |
</config> |
|---|
| 53 |
</module> |
|---|
| 54 |
</modules> |
|---|
| 55 |
<checks> |
|---|
| 56 |
<check uuid="1b4e28ba-2fa1-11d2-883f-e9b761bde3fb" module="collectd" |
|---|
| 57 |
period="60000" timeout="30000"/> |
|---|
| 58 |
</checks> |
|---|
| 59 |
</noit> |
|---|
| 60 |
]]></programlisting> |
|---|
| 61 |
</example> |
|---|
| 62 |
</examples> |
|---|
| 63 |
</module> |
|---|
