From 3894ca6b914492c6ad1fab9a7c67da1ca0754b5a Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Tue, 7 Feb 2023 09:19:29 -0700 Subject: [PATCH] docs(inputs.snmp): Explain different snmp backends (#12627) --- plugins/inputs/snmp/README.md | 16 +++++++++++++++- plugins/inputs/snmp/sample.conf | 2 +- plugins/inputs/snmp_trap/README.md | 14 ++++++++++++++ 3 files changed, 30 insertions(+), 2 deletions(-) diff --git a/plugins/inputs/snmp/README.md b/plugins/inputs/snmp/README.md index 65b90ca19..247b4f3ad 100644 --- a/plugins/inputs/snmp/README.md +++ b/plugins/inputs/snmp/README.md @@ -18,6 +18,20 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins +## SNMP backend: gosmi and netsnmp + +Telegraf has two backends to translate SNMP objects. By default, Telegraf will +use `netsnmp`, however, this option is deprecated and it is encouraged that +users migrate to `gosmi`. If users find issues with `gosmi` that do not occur +with `netsnmp` please open a project issue on GitHub. + +The SNMP backend setting is a global-level setting that applies to all use of +SNMP in Telegraf. Users can set this option in the `[agent]` configuration via +the `snmp_translator` option. See the [agent configuration][AGENT] for more +details. + +[AGENT]: ../../../docs/CONFIGURATION.md#agent + ## Configuration ```toml @sample.conf @@ -43,7 +57,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ## When true, SNMP reponses are accepted from any address not just ## the requested address. This can be useful when gathering from ## redundant/failover systems. - # unconnected_udp_socket = false + # unconnected_udp_socket = false ## Path to mib files ## Used by the gosmi translator. diff --git a/plugins/inputs/snmp/sample.conf b/plugins/inputs/snmp/sample.conf index ea0fe6b7e..d2049eb5a 100644 --- a/plugins/inputs/snmp/sample.conf +++ b/plugins/inputs/snmp/sample.conf @@ -20,7 +20,7 @@ ## When true, SNMP reponses are accepted from any address not just ## the requested address. This can be useful when gathering from ## redundant/failover systems. - # unconnected_udp_socket = false + # unconnected_udp_socket = false ## Path to mib files ## Used by the gosmi translator. diff --git a/plugins/inputs/snmp_trap/README.md b/plugins/inputs/snmp_trap/README.md index 3ada7cb21..4cc392520 100644 --- a/plugins/inputs/snmp_trap/README.md +++ b/plugins/inputs/snmp_trap/README.md @@ -29,6 +29,20 @@ to use them. [SECRETSTORE]: ../../../docs/CONFIGURATION.md#secret-store-secrets +## SNMP backend: gosmi and netsnmp + +Telegraf has two backends to translate SNMP objects. By default, Telegraf will +use `netsnmp`, however, this option is deprecated and it is encouraged that +users migrate to `gosmi`. If users find issues with `gosmi` that do not occur +with `netsnmp` please open a project issue on GitHub. + +The SNMP backend setting is a global-level setting that applies to all use of +SNMP in Telegraf. Users can set this option in the `[agent]` configuration via +the `snmp_translator` option. See the [agent configuration][AGENT] for more +details. + +[AGENT]: ../../../docs/CONFIGURATION.md#agent + ## Configuration ```toml @sample.conf