docs(go.d/snmp): improve auto-detection section (#19882)
* docs(go.d/snmp): improve auto-detection section * fix warnings
Ilya Mashchenko committed
Mar 17, 2025 at 13:43 UTC
097571cf555153897e09f12a0494c92007bb4bb6
1 file changed
+14
-1
src/go/plugin/go.d/collector/snmp/metadata.yaml
+14
-1
@@ -47,7 +47,20 @@ modules:
47
default_behavior:
48
auto_detection:
49
description: |
50
- SNMP service discovery is a dedicated component that automatically scans configured networks to find SNMP-enabled devices. This feature is disabled by default and requires explicit user configuration to activate. When enabled, it discovers devices using customizable credentials, supports various IP range formats (single IPs, ranges, CIDR) with a limit of 512 IPs per subnet, and optimizes network traffic through configurable caching of discovery results. Discovered devices are automatically made available to the SNMP collector for monitoring. See [configuration examples](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d/sd/snmp.conf) for details on setting up credentials and networks to scan.
50
+ SNMP service discovery is a dedicated component that automatically scans configured networks to find SNMP-enabled devices.
51
+
52
+ - This feature is disabled by default and requires explicit user configuration to activate.
53
+ - When enabled, it discovers devices using customizable credentials, supports various IP range formats (single IPs, ranges, CIDR) with a limit of 512 IPs per subnet, and optimizes network traffic through configurable caching of discovery results.
54
+ - Discovered devices are automatically made available to the SNMP collector for monitoring.
55
+
56
+ The configuration file name is [go.d/sd/snmp.conf](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d/sd/snmp.conf).
57
+
58
+ You can edit the configuration file using the edit-config script from the Netdata [config directory](https://learn.netdata.cloud/docs/netdata-agent/configuration#the-netdata-config-directory).
59
+
60
+ ```bash
61
+ cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
62
+ sudo ./edit-config go.d/sd/snmp.conf
63
+ ```
64
limits:
65
description: ""
66
performance_impact: