diff --git a/plugins/inputs/snmp/README.md b/plugins/inputs/snmp/README.md index 7fa7f2563..8f2b9519b 100644 --- a/plugins/inputs/snmp/README.md +++ b/plugins/inputs/snmp/README.md @@ -67,7 +67,8 @@ details. ## SNMP community string. # community = "public" - ## Agent host tag + ## Agent host tag; should be set to "source" for consistent usage across plugins + ## example: agent_host_tag = "source" # agent_host_tag = "agent_host" ## Number of retries to attempt. @@ -100,17 +101,18 @@ details. ## full plugin documentation for configuration details. [[inputs.snmp.field]] oid = "RFC1213-MIB::sysUpTime.0" - name = "uptime" + name = "sysUptime" + conversion = "float(2)" [[inputs.snmp.field]] oid = "RFC1213-MIB::sysName.0" - name = "source" + name = "sysName" is_tag = true [[inputs.snmp.table]] oid = "IF-MIB::ifTable" name = "interface" - inherit_tags = ["source"] + inherit_tags = ["sysName"] [[inputs.snmp.table.field]] oid = "IF-MIB::ifDescr" @@ -290,7 +292,7 @@ name = "EntPhyIndex" oid = "CISCO-POWER-ETHERNET-EXT-MIB::cpeExtPsePortEntPhyIndex" ``` -Partial result (removed agent_host and host columns from all following outputs +Partial result (removed agent and host tags from all following outputs in this section): ```text @@ -386,13 +388,17 @@ sudo tcpdump -s 0 -i eth0 -w telegraf-snmp.pcap host 127.0.0.1 and port 161 The field and tags will depend on the table and fields configured. +* snmp + * tags: + * agent_host (deprecated in 1.29: use `source` instead) + ## Example Output ```text -snmp,agent_host=127.0.0.1,source=loaner uptime=11331974i 1575509815000000000 -interface,agent_host=127.0.0.1,ifDescr=wlan0,ifIndex=3,source=example.org ifAdminStatus=1i,ifInDiscards=0i,ifInErrors=0i,ifInNUcastPkts=0i,ifInOctets=3436617431i,ifInUcastPkts=2717778i,ifInUnknownProtos=0i,ifLastChange=0i,ifMtu=1500i,ifOperStatus=1i,ifOutDiscards=0i,ifOutErrors=0i,ifOutNUcastPkts=0i,ifOutOctets=581368041i,ifOutQLen=0i,ifOutUcastPkts=1354338i,ifPhysAddress="c8:5b:76:c9:e6:8c",ifSpecific=".0.0",ifSpeed=0i,ifType=6i 1575509815000000000 -interface,agent_host=127.0.0.1,ifDescr=eth0,ifIndex=2,source=example.org ifAdminStatus=1i,ifInDiscards=0i,ifInErrors=0i,ifInNUcastPkts=21i,ifInOctets=3852386380i,ifInUcastPkts=3634004i,ifInUnknownProtos=0i,ifLastChange=9088763i,ifMtu=1500i,ifOperStatus=1i,ifOutDiscards=0i,ifOutErrors=0i,ifOutNUcastPkts=0i,ifOutOctets=434865441i,ifOutQLen=0i,ifOutUcastPkts=2110394i,ifPhysAddress="c8:5b:76:c9:e6:8c",ifSpecific=".0.0",ifSpeed=1000000000i,ifType=6i 1575509815000000000 -interface,agent_host=127.0.0.1,ifDescr=lo,ifIndex=1,source=example.org ifAdminStatus=1i,ifInDiscards=0i,ifInErrors=0i,ifInNUcastPkts=0i,ifInOctets=51555569i,ifInUcastPkts=339097i,ifInUnknownProtos=0i,ifLastChange=0i,ifMtu=65536i,ifOperStatus=1i,ifOutDiscards=0i,ifOutErrors=0i,ifOutNUcastPkts=0i,ifOutOctets=51555569i,ifOutQLen=0i,ifOutUcastPkts=339097i,ifSpecific=".0.0",ifSpeed=10000000i,ifType=24i 1575509815000000000 +snmp,agent_host=127.0.0.1,sysName=example.org uptime=113319.74 1575509815000000000 +interface,agent_host=127.0.0.1,ifDescr=wlan0,ifIndex=3,sysName=example.org ifAdminStatus=1i,ifInDiscards=0i,ifInErrors=0i,ifInNUcastPkts=0i,ifInOctets=3436617431i,ifInUcastPkts=2717778i,ifInUnknownProtos=0i,ifLastChange=0i,ifMtu=1500i,ifOperStatus=1i,ifOutDiscards=0i,ifOutErrors=0i,ifOutNUcastPkts=0i,ifOutOctets=581368041i,ifOutQLen=0i,ifOutUcastPkts=1354338i,ifPhysAddress="c8:5b:76:c9:e6:8c",ifSpecific=".0.0",ifSpeed=0i,ifType=6i 1575509815000000000 +interface,agent_host=127.0.0.1,ifDescr=eth0,ifIndex=2,sysName=example.org ifAdminStatus=1i,ifInDiscards=0i,ifInErrors=0i,ifInNUcastPkts=21i,ifInOctets=3852386380i,ifInUcastPkts=3634004i,ifInUnknownProtos=0i,ifLastChange=9088763i,ifMtu=1500i,ifOperStatus=1i,ifOutDiscards=0i,ifOutErrors=0i,ifOutNUcastPkts=0i,ifOutOctets=434865441i,ifOutQLen=0i,ifOutUcastPkts=2110394i,ifPhysAddress="c8:5b:76:c9:e6:8c",ifSpecific=".0.0",ifSpeed=1000000000i,ifType=6i 1575509815000000000 +interface,agent_host=127.0.0.1,ifDescr=lo,ifIndex=1,sysName=example.org ifAdminStatus=1i,ifInDiscards=0i,ifInErrors=0i,ifInNUcastPkts=0i,ifInOctets=51555569i,ifInUcastPkts=339097i,ifInUnknownProtos=0i,ifLastChange=0i,ifMtu=65536i,ifOperStatus=1i,ifOutDiscards=0i,ifOutErrors=0i,ifOutNUcastPkts=0i,ifOutOctets=51555569i,ifOutQLen=0i,ifOutUcastPkts=339097i,ifSpecific=".0.0",ifSpeed=10000000i,ifType=24i 1575509815000000000 ``` [metric filtering]: /docs/CONFIGURATION.md#metric-filtering diff --git a/plugins/inputs/snmp/sample.conf b/plugins/inputs/snmp/sample.conf index d2049eb5a..62e0a9d93 100644 --- a/plugins/inputs/snmp/sample.conf +++ b/plugins/inputs/snmp/sample.conf @@ -30,7 +30,8 @@ ## SNMP community string. # community = "public" - ## Agent host tag + ## Agent host tag; should be set to "source" for consistent usage across plugins + ## example: agent_host_tag = "source" # agent_host_tag = "agent_host" ## Number of retries to attempt. @@ -63,17 +64,18 @@ ## full plugin documentation for configuration details. [[inputs.snmp.field]] oid = "RFC1213-MIB::sysUpTime.0" - name = "uptime" + name = "sysUptime" + conversion = "float(2)" [[inputs.snmp.field]] oid = "RFC1213-MIB::sysName.0" - name = "source" + name = "sysName" is_tag = true [[inputs.snmp.table]] oid = "IF-MIB::ifTable" name = "interface" - inherit_tags = ["source"] + inherit_tags = ["sysName"] [[inputs.snmp.table.field]] oid = "IF-MIB::ifDescr" diff --git a/plugins/inputs/snmp/snmp.go b/plugins/inputs/snmp/snmp.go index d037a9f80..ae68f5fac 100644 --- a/plugins/inputs/snmp/snmp.go +++ b/plugins/inputs/snmp/snmp.go @@ -18,6 +18,7 @@ import ( "github.com/influxdata/telegraf" "github.com/influxdata/telegraf/config" "github.com/influxdata/telegraf/internal/snmp" + "github.com/influxdata/telegraf/models" "github.com/influxdata/telegraf/plugins/inputs" ) @@ -108,6 +109,12 @@ func (s *Snmp) Init() error { if len(s.AgentHostTag) == 0 { s.AgentHostTag = "agent_host" } + if s.AgentHostTag != "source" { + models.PrintOptionValueDeprecationNotice(telegraf.Warn, "inputs.snmp", "agent_host_tag", s.AgentHostTag, telegraf.DeprecationInfo{ + Since: "1.29.0", + Notice: `should be set to "source" for consistent usage across plugins`, + }) + } return nil }