collectd.conf(5): Added informatioin about the netlink plugin.

[collectd.git] / src / collectd-snmp.pod

diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod
index af41675..22d6e37 100644 (file)
--- a/src/collectd-snmp.pod
+++ b/src/collectd-snmp.pod
@@ -31,6 +31,7 @@ collectd-snmp - Documentation of collectd's C<snmp plugin>
       Version 1
       Community "community_string"
       Collect "std_traffic"
+      Inverval 120
     </Host>
     <Host "some.server.mydomain.org">
       Address "192.168.0.42"
@@ -43,6 +44,7 @@ collectd-snmp - Documentation of collectd's C<snmp plugin>
       Version 1
       Community "more_communities"
       Collect "powerplus_voltge_input"
+      Interval 300
     </Host>
   </Plugin>
 
@@ -101,7 +103,7 @@ setting depends on wether B<Table> is set to I<true> or I<false>:
 If B<Table> is set to I<true>, I<Instance> is interpreted as an SNMP-prefix
 that will return a list of strings. Those strings are then used as the actual
 type-instance. An example would be the C<IF-MIB::ifDescr> subtree.
-L<variables(5)> describes the format of OIDs.
+L<variables(5)> from the SNMP distribution describes the format of OIDs.
 
 If B<Table> is set to I<false> the actual string configured for I<Instance> is
 copied into the value-list. In this case I<Instance> may be empty, i.E<nbsp>e.
@@ -110,8 +112,8 @@ copied into the value-list. In this case I<Instance> may be empty, i.E<nbsp>e.
 =item B<Values> I<OID> [I<OID> ...]
 
 Configures the values to be queried from the SNMP host. The meaning slightly
-changes with the B<Table> setting. L<variables(5)> describes the format of
-OIDs.
+changes with the B<Table> setting. L<variables(5)> from the SNMP distribution
+describes the format of OIDs.
 
 If B<Table> is set to I<true>, each I<OID> must be the prefix of all the
 values to query, e.E<nbsp>g. C<IF-MIB::ifInOctets> for all the counters of
@@ -124,7 +126,7 @@ traffic.
 
 =back
 
-=head2 The Head block
+=head2 The Host block
 
 The B<Host> block defines which hosts to query, which SNMP community and
 version to use and which of the defined B<Data> to query.
@@ -153,6 +155,19 @@ Defines which values to collect. I<Data> refers to one of the B<Data> block
 above. Since the config file is read top-down you need to define the data
 before using it here.
 
+=item B<Interval> I<Seconds>
+
+Collect data from this host every I<Seconds> seconds. This value needs to be a
+multiple of the global B<Interval> setting and, if it is not, will be rounded
+B<down> to one and a warning is logged in this case. So if your global
+B<Interval> is set to I<10> and you configure I<25> here, it's rounded down to
+I<20>. By default the global B<Interval> setting will be used.
+
+This option is meant for devices with not much CPU power, e.E<nbsp>g. network
+equipment such as switches, embedded devices, rack monitoring systems and so
+on. Since the B<Step> of generated RRD files depends on this setting it's
+wise to select a reasonable value once and never change it.
+
 =back
 
 =head1 BUGS