X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcollectd-snmp.pod;h=fd7a50896486211c3fac9b0ef6d10304738dcb4c;hb=HEAD;hp=ea490293f17ab21990536ed06eb533056edd1d77;hpb=917abf10c462903cd3bb37faadba68f91f5ca8b1;p=collectd.git diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod index ea490293..fd7a5089 100644 --- a/src/collectd-snmp.pod +++ b/src/collectd-snmp.pod @@ -1,3 +1,5 @@ +=encoding UTF-8 + =head1 NAME collectd-snmp - Documentation of collectd's C @@ -85,7 +87,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 @@ -175,7 +177,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. @@ -184,7 +187,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. @@ -221,16 +224,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