Alternate SNMP plugin

CHANGELOG.md

@@ -89,6 +89,7 @@ consistent with the behavior of `collection_jitter`.
 - [#1213](https://github.com/influxdata/telegraf/issues/1213): Add inactive & active memory to mem plugin.
 - [#1543](https://github.com/influxdata/telegraf/pull/1543): Official Windows service.
 - [#1414](https://github.com/influxdata/telegraf/pull/1414): Forking sensors command to remove C package dependency.
+- [#1389](https://github.com/influxdata/telegraf/pull/1389): Add a new SNMP plugin.
 
 ### Bugfixes
 

Godeps

@@ -47,7 +47,7 @@ github.com/prometheus/common e8eabff8812b05acf522b45fdcd725a785188e37
 github.com/prometheus/procfs 406e5b7bfd8201a36e2bb5f7bdae0b03380c2ce8
 github.com/samuel/go-zookeeper 218e9c81c0dd8b3b18172b2bbfad92cc7d6db55f
 github.com/shirou/gopsutil 4d0c402af66c78735c5ccf820dc2ca7de5e4ff08
-github.com/soniah/gosnmp b1b4f885b12c5dcbd021c5cee1c904110de6db7d
+github.com/soniah/gosnmp eb32571c2410868d85849ad67d1e51d01273eb84
 github.com/sparrc/aerospike-client-go d4bb42d2c2d39dae68e054116f4538af189e05d5
 github.com/streadway/amqp b4f3ceab0337f013208d31348b578d83c0064744
 github.com/stretchr/testify 1f4a1643a57e798696635ea4c126e9127adb7d3c

README.md

@@ -190,6 +190,7 @@ Currently implemented sources:
 * [riak](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/riak)
 * [sensors](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/sensors)
 * [snmp](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/snmp)
+* [snmp_legacy](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/snmp_legacy)
 * [sql server](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/sqlserver) (microsoft)
 * [twemproxy](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/twemproxy)
 * [varnish](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/varnish)

plugins/inputs/all/all.go

@@ -60,6 +60,7 @@ import (
 	_ "github.com/influxdata/telegraf/plugins/inputs/rethinkdb"
 	_ "github.com/influxdata/telegraf/plugins/inputs/riak"
 	_ "github.com/influxdata/telegraf/plugins/inputs/sensors"
+	_ "github.com/influxdata/telegraf/plugins/inputs/snmp"
 	_ "github.com/influxdata/telegraf/plugins/inputs/snmp_legacy"
 	_ "github.com/influxdata/telegraf/plugins/inputs/sqlserver"
 	_ "github.com/influxdata/telegraf/plugins/inputs/statsd"

plugins/inputs/snmp/README.md

@@ -0,0 +1,167 @@
+# SNMP Plugin
+
+The SNMP input plugin gathers metrics from SNMP agents.
+
+## Configuration:
+
+### Example:
+
+SNMP data:
+```
+.1.0.0.0.1.1.0 octet_str "foo"
+.1.0.0.0.1.1.1 octet_str "bar"
+.1.0.0.0.1.102 octet_str "bad"
+.1.0.0.0.1.2.0 integer 1
+.1.0.0.0.1.2.1 integer 2
+.1.0.0.0.1.3.0 octet_str "0.123"
+.1.0.0.0.1.3.1 octet_str "0.456"
+.1.0.0.0.1.3.2 octet_str "9.999"
+.1.0.0.1.1 octet_str "baz"
+.1.0.0.1.2 uinteger 54321
+.1.0.0.1.3 uinteger 234
+```
+
+Telegraf config:
+```toml
+[[inputs.snmp]]
+  agents = [ "127.0.0.1:161" ]
+  version = 2
+  community = "public"
+
+  name = "system"
+  [[inputs.snmp.field]]
+    name = "hostname"
+    oid = ".1.0.0.1.1"
+    is_tag = true
+  [[inputs.snmp.field]]
+    name = "uptime"
+    oid = ".1.0.0.1.2"
+  [[inputs.snmp.field]]
+    name = "loadavg"
+    oid = ".1.0.0.1.3"
+    conversion = "float(2)"
+
+  [[inputs.snmp.table]]
+    name = "remote_servers"
+    inherit_tags = [ "hostname" ]
+    [[inputs.snmp.table.field]]
+      name = "server"
+      oid = ".1.0.0.0.1.1"
+      is_tag = true
+    [[inputs.snmp.table.field]]
+      name = "connections"
+      oid = ".1.0.0.0.1.2"
+    [[inputs.snmp.table.field]]
+      name = "latency"
+      oid = ".1.0.0.0.1.3"
+      conversion = "float"
+```
+
+Resulting output:
+```
+* Plugin: snmp, Collection 1
+> system,agent_host=127.0.0.1,host=mylocalhost,hostname=baz loadavg=2.34,uptime=54321i 1468953135000000000
+> remote_servers,agent_host=127.0.0.1,host=mylocalhost,hostname=baz,server=foo connections=1i,latency=0.123 1468953135000000000
+> remote_servers,agent_host=127.0.0.1,host=mylocalhost,hostname=baz,server=bar connections=2i,latency=0.456 1468953135000000000
+```
+
+#### Configuration via MIB:
+
+This example uses the SNMP data above, but is configured via the MIB.  
+The example MIB file can be found in the `testdata` directory. See the [MIB lookups](#mib-lookups) section for more information.
+
+Telegraf config:
+```toml
+[[inputs.snmp]]
+  agents = [ "127.0.0.1:161" ]
+  version = 2
+  community = "public"
+
+  [[inputs.snmp.field]]
+    oid = "TEST::hostname"
+    is_tag = true
+
+  [[inputs.snmp.table]]
+    oid = "TEST::testTable"
+    inherit_tags = "hostname"
+```
+
+Resulting output:
+```
+* Plugin: snmp, Collection 1
+> testTable,agent_host=127.0.0.1,host=mylocalhost,hostname=baz,server=foo connections=1i,latency="0.123" 1468953135000000000
+> testTable,agent_host=127.0.0.1,host=mylocalhost,hostname=baz,server=bar connections=2i,latency="0.456" 1468953135000000000
+```
+
+### Config parameters
+
+* `agents`: Default: `[]`  
+List of SNMP agents to connect to in the form of `IP[:PORT]`. If `:PORT` is unspecified, it defaults to `161`.
+
+* `version`: Default: `2`  
+SNMP protocol version to use.
+
+* `community`: Default: `"public"`  
+SNMP community to use.
+
+* `max_repetitions`: Default: `50`  
+Maximum number of iterations for repeating variables.
+
+* `sec_name`:  
+Security name for authenticated SNMPv3 requests.
+
+* `auth_protocol`: Values: `"MD5"`,`"SHA"`,`""`. Default: `""`  
+Authentication protocol for authenticated SNMPv3 requests.
+
+* `auth_password`:  
+Authentication password for authenticated SNMPv3 requests.
+
+* `sec_level`: Values: `"noAuthNoPriv"`,`"authNoPriv"`,`"authPriv"`. Default: `"noAuthNoPriv"`  
+Security level used for SNMPv3 messages.
+
+* `context_name`:  
+Context name used for SNMPv3 requests.
+
+* `priv_protocol`: Values: `"DES"`,`"AES"`,`""`. Default: `""`  
+Privacy protocol used for encrypted SNMPv3 messages.
+
+* `priv_password`:  
+Privacy password used for encrypted SNMPv3 messages.
+
+
+* `name`:  
+Output measurement name.
+
+#### Field parameters:
+* `oid`:  
+OID to get. May be a numeric or textual OID.
+
+* `name`:  
+Output field/tag name.
+If not specified, it defaults to the value of `oid`. If `oid` is numeric, an attempt to translate the numeric OID into a texual OID will be made.
+
+* `is_tag`:  
+Output this field as a tag.
+
+* `conversion`: Values: `"float(X)"`,`"float"`,`"int"`,`""`. Default: `""`  
+Converts the value according to the given specification.
+
+    - `float(X)`: Converts the input value into a float and divides by the Xth power of 10. Efficively just moves the decimal left X places. For example a value of `123` with `float(2)` will result in `1.23`.
+    - `float`: Converts the value into a float with no adjustment. Same as `float(0)`.
+    - `int`: Convertes the value into an integer.
+
+#### Table parameters:
+* `oid`:  
+Automatically populates the table's fields using data from the MIB.
+
+* `name`:  
+Output measurement name.
+If not specified, it defaults to the value of `oid`.  If `oid` is numeric, an attempt to translate the numeric OID into a texual OID will be made.
+
+* `inherit_tags`:  
+Which tags to inherit from the top-level config and to use in the output of this table's measurement.
+
+### MIB lookups
+If the plugin is configured such that it needs to perform lookups from the MIB, it will use the net-snmp utilities `snmptranslate` and `snmptable`.
+
+When performing the lookups, the plugin will load all available MIBs. If your MIB files are in a custom path, you may add the path using the `MIBDIRS` environment variable. See [`man 1 snmpcmd`](http://net-snmp.sourceforge.net/docs/man/snmpcmd.html#lbAK) for more information on the variable.