Regenerate integrations docs (#21211)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Oct 26, 2025 at 20:12 UTC
30acbe49d1b1cf608e944b654f15bd99f4d0ccad
1 file changed
+22
-1
src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md
+22
-1
@@ -23,6 +23,21 @@ Module: snmp
23
24
This SNMP collector discovers and monitors SNMP-enabled devices using **profiles**.
25
26
+:::tip
27
+
28
+See: [SNMP Profile Format](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/profile-format.md) to learn how to write profiles and define their fields.
29
+
30
+**Profile locations**
31
+
32
+| Type | Default path | Notes |
33
+|------|---------------|--------|
34
+| **Stock profiles** | `/usr/lib/netdata/conf.d/go.d/snmp.profiles/default/` | Provided with Netdata. |
35
+| **User profiles** | `/etc/netdata/go.d/snmp.profiles/` | Place your custom or modified profiles here. |
36
+
37
+Depending on your installation method, both paths may include the `/opt/netdata` prefix.
38
+
39
+:::
40
+
41
A *profile* declares:
42
- device selectors (e.g. `sysObjectID`, `sysDescr`) for auto-matching,
43
- which OIDs to collect (scalars and tables),
@@ -58,7 +73,7 @@ SNMP service discovery can automatically scan configured networks and feed the S
73
- Supports single IPs, ranges, and CIDR blocks (up to 512 IPs per subnet).
74
- Uses the provided SNMP credentials (v1/v2c/v3) to probe devices.
75
- Caches discovery results (configurable) to reduce network load.
61
-- At collection time, each discovered device is matched to the appropriate profile based on its `sysObjectID`, `sysDescr`, and the profile’s selector rules.
76
+- At collection time, each discovered device is matched to the appropriate [profile](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/profile-format.md) based on its `sysObjectID`, `sysDescr`, and the profile’s selector rules.
77
78
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).
79
@@ -85,6 +100,12 @@ The default configuration for this integration does not impose any limits on dat
100
101
Metrics and charts are **defined by the matched SNMP profile(s)** at runtime. They differ by vendor/model/OS and may include, for example, interface counters, optics, CPU/memory, temperature, VLANs, and more. Use the **Metrics** tab on the device’s dashboard to see exactly what is collected for that device.
102
103
+:::tip
104
+
105
+ To understand the structure of these profiles (metrics, tags, virtual metrics, etc.), see **[SNMP Profile Format](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/profile-format.md)**.
106
+
107
+:::
108
+
109
If `ping.enabled` is true, ICMP latency/packet-loss charts are also provided (or exclusively, when `ping_only: true`).
110
111