src/collectd-snmp.pod

   1 =encoding UTF-8
   2
   3 =head1 NAME
   4
   5 collectd-snmp - Documentation of collectd's C<snmp plugin>
   6
   7 =head1 SYNOPSIS
   8
   9   LoadPlugin snmp
  10   # ...
  11   <Plugin snmp>
  12     <Data "powerplus_voltge_input">
  13       Table false
  14       Type "voltage"
  15       TypeInstance "input_line1"
  16       Scale 0.1
  17       Values "SNMPv2-SMI::enterprises.6050.5.4.1.1.2.1"
  18     </Data>
  19     <Data "hr_users">
  20       Table false
  21       Type "users"
  22       Shift -1
  23       Values "HOST-RESOURCES-MIB::hrSystemNumUsers.0"
  24     </Data>
  25     <Data "std_traffic">
  26       Table true
  27       Type "if_octets"
  28       TypeInstanceOID "IF-MIB::ifDescr"
  29       #FilterOID "IF-MIB::ifOperStatus"
  30       #FilterValues "1", "2"
  31       Values "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
  32     </Data>
  33
  34     <Host "some.switch.mydomain.org">
  35       Address "192.168.0.2"
  36       Version 1
  37       Community "community_string"
  38       Collect "std_traffic"
  39       Interval 120
  40       Timeout 10
  41       Retries 1
  42     </Host>
  43     <Host "some.server.mydomain.org">
  44       Address "192.168.0.42"
  45       Version 2
  46       Community "another_string"
  47       Collect "std_traffic" "hr_users"
  48     </Host>
  49     <Host "secure.router.mydomain.org">
  50       Address "192.168.0.7:165"
  51       Version 3
  52       SecurityLevel "authPriv"
  53       Username "cosmo"
  54       AuthProtocol "SHA"
  55       AuthPassphrase "setec_astronomy"
  56       PrivacyProtocol "AES"
  57       PrivacyPassphrase "too_many_secrets"
  58       Collect "std_traffic"
  59     </Host>
  60     <Host "some.ups.mydomain.org">
  61       Address "tcp:192.168.0.3"
  62       Version 1
  63       Community "more_communities"
  64       Collect "powerplus_voltge_input"
  65       Interval 300
  66       Timeout 5
  67       Retries 5
  68     </Host>
  69   </Plugin>
  70
  71 =head1 DESCRIPTION
  72
  73 The C<snmp plugin> queries other hosts using SNMP, the simple network
  74 management protocol, and translates the value it receives to collectd's
  75 internal format and dispatches them. Depending on the write plugins you have
  76 loaded they may be written to disk or submitted to another instance or
  77 whatever you configured.
  78
  79 Because querying a host via SNMP may produce a timeout the "complex reads"
  80 polling method is used. The ReadThreads parameter in the main configuration
  81 influences the number of parallel polling jobs which can be undertaken. If
  82 you expect timeouts or some polling to take a long time, you should increase
  83 this parameter. Note that other plugins also use the same threads.
  84
  85 =head1 CONFIGURATION
  86
  87 Since the aim of the C<snmp plugin> is to provide a generic interface to SNMP,
  88 its configuration is not trivial and may take some time.
  89
  90 Since the C<Net-SNMP> library is used you can use all the environment variables
  91 that are interpreted by that package. See L<snmpcmd(1)> for more details.
  92
  93 There are two types of blocks that can be contained in the
  94 C<E<lt>PluginE<nbsp>snmpE<gt>> block: B<Data> and B<Host>:
  95
  96 =head2 The B<Data> block
  97
  98 The B<Data> block defines a list of values or a table of values that are to be
  99 queried. The following options can be set:
 100
 101 =over 4
 102
 103 =item B<Type> I<type>
 104
 105 collectd's type that is to be used, e.E<nbsp>g. "if_octets" for interface
 106 traffic or "users" for a user count. The types are read from the B<TypesDB>
 107 (see L<collectd.conf(5)>), so you may want to check for which types are
 108 defined. See L<types.db(5)> for a description of the format of this file.
 109
 110 =item B<Table> I<true|false>
 111
 112 Define if this is a single list of values or a table of values. The difference
 113 is the following:
 114
 115 When B<Table> is set to B<false>, the OIDs given to B<Values> (see below) are
 116 queried using the C<GET> SNMP command (see L<snmpget(1)>) and transmitted to
 117 collectd. B<One> value list is dispatched and, eventually, one file will be
 118 written.
 119
 120 When B<Table> is set to B<true>, the OIDs given to B<Values>, B<TypeInstanceOID>,
 121 B<PluginInstanceOID>, B<HostOID> and B<FilterOID> (see below) are queried using
 122 the C<GETNEXT> SNMP command until the subtree is left. After all
 123 the lists (think: all columns of the table) have been read B<several> values
 124 sets will be dispatches and, eventually, several files will be written. If you
 125 configure a B<Type> (see above) which needs more than one data source (for
 126 example C<if_octets> which needs C<rx> and C<tx>) you will need to specify more
 127 than one (two, in the example case) OIDs with the B<Values> option. This has
 128 nothing to do with the B<Table> setting.
 129
 130 For example, if you want to query the number of users on a system, you can use
 131 C<HOST-RESOURCES-MIB::hrSystemNumUsers.0>. This is one value and belongs to one
 132 value list, therefore B<Table> must be set to B<false>. Please note that, in
 133 this case, you have to include the sequence number (zero in this case) in the
 134 OID.
 135
 136 Counter example: If you want to query the interface table provided by the
 137 C<IF-MIB>, e.E<nbsp>g. the bytes transmitted. There are potentially many
 138 interfaces, so you will want to set B<Table> to B<true>. Because the
 139 C<if_octets> type needs two values, received and transmitted bytes, you need to
 140 specify two OIDs in the B<Values> setting, in this case likely
 141 C<IF-MIB::ifHCInOctets> and C<IF-MIB::ifHCOutOctets>. But, this is because of
 142 the B<Type> setting, not the B<Table> setting.
 143
 144 Since the semantic of B<Instance> and B<Values> depends on this setting you
 145 need to set it before setting them. Doing vice versa will result in undefined
 146 behavior.
 147
 148 =item B<Plugin> I<Plugin>
 149
 150 Use I<Plugin> as the plugin name of the values that are dispatched.
 151 Defaults to C<snmp>.
 152
 153 =item B<PluginInstance> I<Instance>
 154
 155 Sets the plugin-instance of the values that are dispatched to I<Instance> value.
 156
 157 When B<Table> is set to I<true> and B<PluginInstanceOID> is set then this option
 158 has no effect.
 159
 160 Defaults to an empty string.
 161
 162 =item B<TypeInstance> I<Instance>
 163
 164 Sets the type-instance of the values that are dispatched to I<Instance> value.
 165
 166 When B<Table> is set to I<true> and B<TypeInstanceOID> is set then this option
 167 has no effect.
 168
 169 Defaults to an empty string.
 170
 171 =item B<TypeInstanceOID> I<OID>
 172
 173 =item B<PluginInstanceOID> I<OID>
 174
 175 =item B<HostOID> I<OID>
 176
 177 If B<Table> is set to I<true>, I<OID> is interpreted as an SNMP-prefix that will
 178 return a list of values. Those values are then used as the actual type-instance,
 179 plugin-instance or host of dispatched metrics. An example would be the
 180 C<IF-MIB::ifDescr> subtree. L<variables(5)> from the SNMP distribution describes
 181 the format of OIDs. When option is set to empty string, then "SUBID" will be used
 182 as the value.
 183
 184 Prefix may be set for values with use of appropriate B<TypeInstancePrefix>,
 185 B<PluginInstancePrefix> and B<HostPrefix> options.
 186
 187 When B<Table> is set to I<false> these options has no effect.
 188
 189 Defaults: When no one of these options is configured explicitly,
 190 B<TypeInstanceOID> defaults to an empty string.
 191
 192 =item B<TypeInstancePrefix>
 193
 194 =item B<PluginInstancePrefix>
 195
 196 =item B<HostPrefix>
 197
 198 These options are intented to be used together with B<TypeInstanceOID>,
 199 B<PluginInstanceOID> and B<HostOID> respectively.
 200
 201 If set, I<String> is preprended to values received by querying the agent.
 202
 203 When B<Table> is set to I<false> these options has no effect.
 204
 205 The C<UPS-MIB> is an example where you need this setting: It has voltages of
 206 the inlets, outlets and the battery of an UPS. However, it doesn't provide a
 207 descriptive column for these voltages. In this case having 1, 2,E<nbsp>... as
 208 instances is not enough, because the inlet voltages and outlet voltages may
 209 both have the subids 1, 2,E<nbsp>... You can use this setting to distinguish
 210 between the different voltages.
 211
 212 =item B<Instance> I<Instance>
 213
 214 Attention: this option exists for backwards compatibility only and will be
 215 removed in next major release. Please use B<TypeInstance> / B<TypeInstanceOID>
 216 instead.
 217
 218 The meaning of this setting depends on whether B<Table> is set to I<true> or
 219 I<false>.
 220
 221 If B<Table> is set to I<true>, option behaves as B<TypeInstanceOID>.
 222 If B<Table> is set to I<false>, option behaves as B<TypeInstance>.
 223
 224 Note what B<Table> option must be set before setting B<Instance>.
 225
 226 =item B<InstancePrefix> I<String>
 227
 228 Attention: this option exists for backwards compatibility only and will be
 229 removed in next major release. Please use B<TypeInstancePrefix> instead.
 230
 231 =item B<Values> I<OID> [I<OID> ...]
 232
 233 Configures the values to be queried from the SNMP host. The meaning slightly
 234 changes with the B<Table> setting. L<variables(5)> from the SNMP distribution
 235 describes the format of OIDs.
 236
 237 If B<Table> is set to I<true>, each I<OID> must be the prefix of all the
 238 values to query, e.E<nbsp>g. C<IF-MIB::ifInOctets> for all the counters of
 239 incoming traffic. This subtree is walked (using C<GETNEXT>) until a value from
 240 outside the subtree is returned.
 241
 242 If B<Table> is set to I<false>, each I<OID> must be the OID of exactly one
 243 value, e.E<nbsp>g. C<IF-MIB::ifInOctets.3> for the third counter of incoming
 244 traffic.
 245
 246 =item B<Scale> I<Value>
 247
 248 The gauge-values returned by the SNMP-agent are multiplied by I<Value>.  This
 249 is useful when values are transferred as a fixed point real number. For example,
 250 thermometers may transfer B<243> but actually mean B<24.3>, so you can specify
 251 a scale value of B<0.1> to correct this. The default value is, of course,
 252 B<1.0>.
 253
 254 This value is not applied to counter-values.
 255
 256 =item B<Shift> I<Value>
 257
 258 I<Value> is added to gauge-values returned by the SNMP-agent after they have
 259 been multiplied by any B<Scale> value. If, for example, a thermometer returns
 260 degrees Kelvin you could specify a shift of B<273.15> here to store values in
 261 degrees Celsius. The default value is, of course, B<0.0>.
 262
 263 This value is not applied to counter-values.
 264
 265 =item B<Ignore> I<Value> [, I<Value> ...]
 266
 267 The ignore values allows one to ignore TypeInstances based on their name and
 268 the patterns specified by the various values you've entered. The match is a
 269 glob-type shell matching.
 270
 271 When B<Table> is set to I<false> then this option has no effect.
 272
 273 =item B<InvertMatch> I<true|false(default)>
 274
 275 The invertmatch value should be use in combination of the Ignore option.
 276 It changes the behaviour of the Ignore option, from a blacklist behaviour
 277 when InvertMatch is set to false, to a whitelist when specified to true.
 278
 279 =item B<FilterOID> I<OID>
 280
 281 =item B<FilterValues> I<Value> [, I<Value> ...]
 282
 283 =item B<FilterIgnoreSelected> I<true|false(default)>
 284
 285 When B<Table> is set to I<true>, these options allow to configure filtering
 286 based on MIB values.
 287
 288 The B<FilterOID> declares I<OID> to fill table column with values.
 289 The B<FilterValues> declares values list to do match. Whether table row will be
 290 collected or ignored depends on the B<FilterIgnoreSelected> setting.
 291 As with other plugins that use the daemon's ignorelist functionality, a string
 292 that starts and ends with a slash is interpreted as a regular expression.
 293
 294 If no selection is configured at all, B<all> table rows are selected.
 295
 296 When B<Table> is set to I<false> then these options has no effect.
 297
 298 See B<Table> and F</"IGNORELISTS"> for details.
 299
 300 =back
 301
 302 =head2 The Host block
 303
 304 The B<Host> block defines which hosts to query, which SNMP community and
 305 version to use and which of the defined B<Data> to query.
 306
 307 The argument passed to the B<Host> block is used as the hostname in the data
 308 stored by collectd.
 309
 310 =over 4
 311
 312 =item B<Address> I<IP-Address>|I<Hostname>
 313
 314 Set the address to connect to. Address may include transport specifier and/or
 315 port number.
 316
 317 =item B<Version> B<1>|B<2>|B<3>
 318
 319 Set the SNMP version to use. When giving B<2> version C<2c> is actually used.
 320
 321 =item B<Community> I<Community>
 322
 323 Pass I<Community> to the host. (Ignored for SNMPv3).
 324
 325 =item B<Username> I<Username>
 326
 327 Sets the I<Username> to use for SNMPv3 security.
 328
 329 =item B<SecurityLevel> I<authPriv>|I<authNoPriv>|I<noAuthNoPriv>
 330
 331 Selects the security level for SNMPv3 security.
 332
 333 =item B<Context> I<Context>
 334
 335 Sets the I<Context> for SNMPv3 security.
 336
 337 =item B<AuthProtocol> I<MD5>|I<SHA>
 338
 339 Selects the authentication protocol for SNMPv3 security.
 340
 341 =item B<AuthPassphrase> I<Passphrase>
 342
 343 Sets the authentication passphrase for SNMPv3 security.
 344
 345 =item B<PrivacyProtocol> I<AES>|I<DES>
 346
 347 Selects the privacy (encryption) protocol for SNMPv3 security.
 348
 349 =item B<PrivacyPassphrase> I<Passphrase>
 350
 351 Sets the privacy (encryption) passphrase for SNMPv3 security.
 352
 353 =item B<Collect> I<Data> [I<Data> ...]
 354
 355 Defines which values to collect. I<Data> refers to one of the B<Data> block
 356 above. Since the config file is read top-down you need to define the data
 357 before using it here.
 358
 359 =item B<Interval> I<Seconds>
 360
 361 Collect data from this host every I<Seconds> seconds. This option is meant for
 362 devices with not much CPU power, e.E<nbsp>g. network equipment such as
 363 switches, embedded devices, rack monitoring systems and so on. Since the
 364 B<Step> of generated RRD files depends on this setting it's wise to select a
 365 reasonable value once and never change it.
 366
 367 =item B<Timeout> I<Seconds>
 368
 369 How long to wait for a response. The C<Net-SNMP> library default is 1 second.
 370
 371 =item B<Retries> I<Integer>
 372
 373 The number of times that a query should be retried after the Timeout expires.
 374 The C<Net-SNMP> library default is 5.
 375
 376 =back
 377
 378 =head1 SEE ALSO
 379
 380 L<collectd(1)>,
 381 L<collectd.conf(5)>,
 382 L<snmpget(1)>,
 383 L<snmpgetnext(1)>,
 384 L<variables(5)>,
 385 L<unix(7)>
 386
 387 =head1 AUTHORS
 388
 389 Florian Forster E<lt>octo@collectd.orgE<gt>
 390 Michael Pilat E<lt>mike@mikepilat.comE<gt>
 391
 392 =cut