diff --git a/CHANGELOG.md b/CHANGELOG.md index f8cef8831..debe91be2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ ### Release Notes +**Breaking Change** The SNMP plugin is being deprecated in it's current form. +There is a [new SNMP plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/snmp) +which fixes many of the issues and confusions +of it's predecessor. For users wanting to continue to use the deprecated SNMP +plugin, you will need to change your config file from `[[inputs.snmp]]` to +`[[inputs.snmp_legacy]]`. The configuration of the new SNMP plugin is _not_ +backwards-compatible. + - Telegraf now supports being installed as an official windows service, which can be installed via `> C:\Program Files\Telegraf\telegraf.exe --service install` diff --git a/etc/telegraf.conf b/etc/telegraf.conf index c934a89ab..902c7f7fb 100644 --- a/etc/telegraf.conf +++ b/etc/telegraf.conf @@ -1393,8 +1393,8 @@ # servers = ["http://localhost:8098"] -# # Reads oids value from one or many snmp agents -# [[inputs.snmp]] +# # DEPRECATED! PLEASE USE inputs.snmp INSTEAD. +# [[inputs.snmp_legacy]] # ## Use 'oids.txt' file to translate oids to names # ## To generate 'oids.txt' you need to run: # ## snmptranslate -m all -Tz -On | sed -e 's/"//g' > /tmp/oids.txt diff --git a/plugins/inputs/all/all.go b/plugins/inputs/all/all.go index dacbff644..57f26df08 100644 --- a/plugins/inputs/all/all.go +++ b/plugins/inputs/all/all.go @@ -61,7 +61,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" _ "github.com/influxdata/telegraf/plugins/inputs/sysstat" diff --git a/plugins/inputs/snmp/README.md b/plugins/inputs/snmp_legacy/README.md similarity index 100% rename from plugins/inputs/snmp/README.md rename to plugins/inputs/snmp_legacy/README.md diff --git a/plugins/inputs/snmp/snmp.go b/plugins/inputs/snmp_legacy/snmp_legacy.go similarity index 99% rename from plugins/inputs/snmp/snmp.go rename to plugins/inputs/snmp_legacy/snmp_legacy.go index 3cbfa0db1..b8b9a1232 100644 --- a/plugins/inputs/snmp/snmp.go +++ b/plugins/inputs/snmp_legacy/snmp_legacy.go @@ -1,4 +1,4 @@ -package snmp +package snmp_legacy import ( "io/ioutil" @@ -225,7 +225,7 @@ func (s *Snmp) SampleConfig() string { // Description returns description of Zookeeper plugin func (s *Snmp) Description() string { - return `Reads oids value from one or many snmp agents` + return `DEPRECATED! PLEASE USE inputs.snmp INSTEAD.` } func fillnode(parentNode Node, oid_name string, ids []string) { @@ -812,7 +812,7 @@ func (h *Host) HandleResponse( } func init() { - inputs.Add("snmp", func() telegraf.Input { + inputs.Add("snmp_legacy", func() telegraf.Input { return &Snmp{} }) } diff --git a/plugins/inputs/snmp/snmp_test.go b/plugins/inputs/snmp_legacy/snmp_legacy_test.go similarity index 99% rename from plugins/inputs/snmp/snmp_test.go rename to plugins/inputs/snmp_legacy/snmp_legacy_test.go index 2faaa1408..a6bf2922b 100644 --- a/plugins/inputs/snmp/snmp_test.go +++ b/plugins/inputs/snmp_legacy/snmp_legacy_test.go @@ -1,4 +1,4 @@ -package snmp +package snmp_legacy import ( "testing" diff --git a/plugins/inputs/snmp/testdata/oids.txt b/plugins/inputs/snmp_legacy/testdata/oids.txt similarity index 100% rename from plugins/inputs/snmp/testdata/oids.txt rename to plugins/inputs/snmp_legacy/testdata/oids.txt