Difference between revisions of "Plugin:SNMP"

From collectd Wiki
Jump to: navigation, search
(Extended the "User comments".)
Line 67: Line 67:
  
 
{{No Example Graph}}
 
{{No Example Graph}}
 +
 +
== User comments ==
 +
 +
=== Unique instance names ===
 +
 +
You should be careful with the OID you use for the ''Instance'' parameter: For example <code>IF-MIB::ifDescr</code> is often not sufficiently unique, using <code>IF-MIB::ifName</code> may be better. In some of the provided examples this will bite you with certain devices (for example switches by Cisco).
 +
 +
Another problem may arise from instance names being too long. Currently there is a 63&nbsp;character limit on instance names, see [[Naming schema]]. If two strings only differ after the 63<sup>rd</sup> character, the resulting name will not be unique.
  
 
== Dependencies ==
 
== Dependencies ==
  
 
* [http://net-snmp.sourceforge.net/ Net-SNMP library]
 
* [http://net-snmp.sourceforge.net/ Net-SNMP library]
 
== User comments ==
 
 
You may want to be careful with the OID you use for the 'Instance' parameter: Often 'IF-MIB::ifDescr' ist not sufficiently unique, using 'IF-MIB::ifName' is better. In some of the provided examples this will bite you with certain devices (e.g. Ciscos).
 
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]

Revision as of 09:00, 6 July 2009

SNMP plugin
Type: read
Status: supported
First version: 4.1
Copyright: 2007–2008 Florian octo Forster
License: GPLv2
Manpage: collectd.conf(5)
List of Plugins

Description

The SNMP plugin uses the Net-SNMP library to read values from network devices using the Simple Network Management Protocol (SNMP). SNMP is a widespread standard to provide management data from devices such as switches, routers, rack monitoring systems, uninterruptible power supplies (UPS), etc. While theoretically possible, collecting values from other computers via this protocol is discouraged in favor of collectd's own protocol, implemented by the Network plugin.

This plugin is a generic plugin, i.e. it cannot work without configuration, because there is no reasonable default behavior. Please read the Plugin snmp section of the collectd.conf(5) manual page for an in-depth description of the plugin's configuration. The majority of documentation for this plugin has been moved to the collectd-snmp(5) manual page.

Some data definitions for the SNMP plugin can be find in the contrib/snmp-data.conf file in the source tarball. If you have additions to this file, feel free to send them to the mailing list, see Contact.

Synopsis

LoadPlugin snmp
# ...
<Plugin snmp>
  
    Type "voltage"
    Table false
    Instance "input_line1"
    Scale 0.1
    Values "SNMPv2-SMI::enterprises.6050.5.4.1.1.2.1"
   
  
    Type "users" 
    Table false
    Instance ""
    Shift -1
    Values "HOST-RESOURCES-MIB::hrSystemNumUsers.0"
   
  
    Type "if_octets"
    Table true
    Instance "IF-MIB::ifDescr"
    Values "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
   

  <Host "some.switch.mydomain.org">
    Address "192.168.0.2"
    Version 1
    Community "community_string"
    Collect "std_traffic"
    Interval 120
  </Host> 
  <Host "some.server.mydomain.org">
    Address "192.168.0.42"
    Version 2
    Community "another_string"
    Collect "std_traffic" "hr_users"
  </Host> 
  <Host "some.ups.mydomain.org">
    Address "192.168.0.3"
    Version 1
    Community "more_communities"
    Collect "powerplus_voltge_input"
    Interval 300
  </Host> 
</Plugin>

Example graphs

None yet. Add one now!

User comments

Unique instance names

You should be careful with the OID you use for the Instance parameter: For example IF-MIB::ifDescr is often not sufficiently unique, using IF-MIB::ifName may be better. In some of the provided examples this will bite you with certain devices (for example switches by Cisco).

Another problem may arise from instance names being too long. Currently there is a 63 character limit on instance names, see Naming schema. If two strings only differ after the 63rd character, the resulting name will not be unique.

Dependencies