X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-snmp.pod;h=3c6e79970dacff29c556c423899b480ca1d85bf8;hb=adee81fe60077d03345c94e3780752a8c2c712cf;hp=001925453c27897a9c5645b6dd3fabcf645668cd;hpb=8dfe4231f01b23205be2128a6f5c1e49a701ee83;p=collectd.git diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod index 00192545..3c6e7997 100644 --- a/src/collectd-snmp.pod +++ b/src/collectd-snmp.pod @@ -33,7 +33,7 @@ collectd-snmp - Documentation of collectd's C Version 1 Community "community_string" Collect "std_traffic" - Inverval 120 + Interval 120 Address "192.168.0.42" @@ -67,9 +67,8 @@ and ten threads are used. Since the aim of the C is to provide a generic interface to SNMP, it's configuration is not trivial and may take some time. -Since the C library is used you can use all the environment -variables that are interpreted by that package. See L for more -details. +Since the C library is used you can use all the environment variables +that are interpreted by that package. See L for more details. There are two types of blocks that can be contained in the CPluginEsnmpE> block: B and B: @@ -86,7 +85,7 @@ queried. The following options can be set: collectd's type that is to be used, e.Eg. "if_octets" for interface traffic or "users" for a user count. The types are read from the B (see L), so you may want to check for which types are -defined. +defined. See L for a description of the format of this file. =item B I @@ -176,7 +175,8 @@ traffic. The gauge-values returned by the SNMP-agent are multiplied by I. This is useful when values are transfered as a fixed point real number. For example, thermometers may transfer B<243> but actually mean B<24.3>, so you can specify -a scale value of B<0.1> to correct this. The default value is of course B<1.0>. +a scale value of B<0.1> to correct this. The default value is, of course, +B<1.0>. This value is not applied to counter-values. @@ -185,7 +185,7 @@ This value is not applied to counter-values. I is added to gauge-values returned by the SNMP-agent after they have been multiplied by any B value. If, for example, a thermometer returns degrees Kelvin you could specify a shift of B<273.15> here to store values in -degrees Celsius. The default value is is course B<0.0>. +degrees Celsius. The default value is, of course, B<0.0>. This value is not applied to counter-values. @@ -207,7 +207,7 @@ Set the address to connect to. =item B B<1>|B<2> -Set the SNMP version to use. When giving B<2> version 2c is actually used. +Set the SNMP version to use. When giving B<2> version C<2c> is actually used. Version 3 is not supported by this plugin. =item B I @@ -222,16 +222,11 @@ before using it here. =item B I -Collect data from this host every I seconds. This value needs to be a -multiple of the global B setting and, if it is not, will be rounded -B to one and a warning is logged in this case. So if your global -B is set to I<10> and you configure I<25> here, it's rounded down to -I<20>. By default the global B setting will be used. - -This option is meant for devices with not much CPU power, e.Eg. network -equipment such as switches, embedded devices, rack monitoring systems and so -on. Since the B of generated RRD files depends on this setting it's -wise to select a reasonable value once and never change it. +Collect data from this host every I seconds. This option is meant for +devices with not much CPU power, e.Eg. network equipment such as +switches, embedded devices, rack monitoring systems and so on. Since the +B of generated RRD files depends on this setting it's wise to select a +reasonable value once and never change it. =back