Skip to content

Commit

Permalink
Added SNMPInterfaceCollector README
Browse files Browse the repository at this point in the history
  • Loading branch information
bcakipp committed Jul 13, 2011
1 parent b3b094f commit dd9a859
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions src/collectors/snmp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
SNMPInterfaceCollector
=====

The SNMPInterfaceCollector is designed for collecting interface data from remote SNMP-enabled devices such as routers and switches.

Installation
=====

The snmpinterfacecollector.py module should be installed into your Diamond installation collectors directory. This directory is defined
in diamond.cfg under the *collectors_path* directive. This defaults to */usr/lib/diamond/collectors/* on Ubuntu.

The SNMPInterfaceCollector.cfg file should be installed into your diamond installation config directory. This directory is defined
in diamond.cfg under the *collectors_config_path* directive. This defaults to */etc/diamond/* on Ubuntu.

Once the collector is installed and configured, you can wait for diamond to pick up the new collector automatically, or simply restart diamond.

Configuration
=====

Below is an example configuration for the SNMPInterfaceCollector. The collector can collect data any number of devices by adding configuration sections
under the *devices* header. By default the collector will collect every 60 seconds. This might be a bit excessive and put unnecessary load on the
devices being polled. You may wish to change this to every 300 seconds. However you need modify your graphite data retentions to handle this properly.

# Options for SNMPInterfaceCollector
path = interface
interval = 60

[devices]

[[router1]]
host = router1.example.com
port = 161
community = public

[[router2]]
host = router1.example.com
port = 161
community = public

Note: If you modify the SNMPInterfaceCollector configuration, you will need to restart diamond.
File renamed without changes.

0 comments on commit dd9a859

Please sign in to comment.