@cryptotaxi247 / netdata-1 / commits / 6c5035df5

docs(go.d/snmp): add keywords and improve overview (#21442)

Ilya Mashchenko committed Dec 11, 2025 at 11:07 UTC 6c5035df577bd3ac73faf403af6119ee31572a99
1 file changed +188 -29
src/go/plugin/go.d/collector/snmp/metadata.yaml
+188 -29
@@ -11,7 +11,152 @@ modules:
11 categories:
12 - data-collection.generic-data-collection
13 keywords:
14 + # Protocol/generic
15 - snmp
16 + - mib
17 + - oid
18 + - network
19 + # Device types
20 + - router
21 + - switch
22 + - firewall
23 + - ap
24 + - access point
25 + - wireless controller
26 + - wlc
27 + - wifi
28 + - vpn
29 + - pdu
30 + - ups
31 + - nas
32 + - san
33 + - printer
34 + # Standard MIB-related (from std-* profiles)
35 + - bgp
36 + - ospf
37 + - ucd
38 + # Vendors (from profiles) + common variants
39 + - 3com
40 + - a10
41 + - alcatel
42 + - lucent
43 + - nokia
44 + - anue
45 + - apc
46 + - netbotz
47 + - arista
48 + - aruba
49 + - audiocodes
50 + - avaya
51 + - avocent
52 + - avtech
53 + - roomalert
54 + - barracuda
55 + - bluecat
56 + - brocade
57 + - brother
58 + - chatsworth
59 + - checkpoint
60 + - chrysalis
61 + - cisco
62 + - cisco asa
63 + - cisco asr
64 + - cisco catalyst
65 + - cisco nexus
66 + - cisco ironport
67 + - cisco ics
68 + - cisco wlc
69 + - cisco ucs
70 + - meraki
71 + - citrix
72 + - netscaler
73 + - cradlepoint
74 + - cyberpower
75 + - dell
76 + - dell emc
77 + - poweredge
78 + - sonicwall
79 + - dialogic
80 + - dlink
81 + - d-link
82 + - eaton
83 + - exagrid
84 + - extreme
85 + - f5
86 + - big-ip
87 + - fireeye
88 + - fortinet
89 + - fortigate
90 + - fortiswitch
91 + - gigamon
92 + - hp
93 + - hewlett packard
94 + - hp ilo
95 + - ilo
96 + - ilo4
97 + - hp h3c
98 + - hp icf
99 + - hpe
100 + - proliant
101 + - huawei
102 + - 3com huawei
103 + - ibm
104 + - datapower
105 + - lenovo
106 + - idrac
107 + - dell idrac
108 + - infinera
109 + - coriant
110 + - infoblox
111 + - isilon
112 + - ixsystems
113 + - truenas
114 + - juniper
115 + - junos
116 + - kyocera
117 + - linksys
118 + - mcafee
119 + - mikrotik
120 + - nasuni
121 + - nec
122 + - net-snmp
123 + - netsnmp
124 + - netapp
125 + - netgear
126 + - readynas
127 + - omron
128 + - opengear
129 + - palo alto
130 + - cloudgenix
131 + - peplink
132 + - raritan
133 + - riverbed
134 + - ruckus
135 + - serveriron
136 + - server-iron
137 + - servertech
138 + - silverpeak
139 + - silver peak
140 + - edgeconnect
141 + - sinetica
142 + - sophos
143 + - synology
144 + - diskstation
145 + - tp-link
146 + - tplink
147 + - tripplite
148 + - tripp lite
149 + - ubiquiti
150 + - unifi
151 + - velocloud
152 + - vertiv
153 + - liebert
154 + - watchguard
155 + - western digital
156 + - wd
157 + - mycloud
158 + - zebra
159 + - zyxel
160 related_resources:
161 integrations:
162 list: []
@@ -21,40 +166,54 @@ modules:
166 overview:
167 data_collection:
168 metrics_description: |
24 - This SNMP collector discovers and monitors SNMP-enabled devices using **profiles**.
169 + This collector discovers and monitors any SNMP-enabled network device.
170 +
171 + - **Built-in vendor profiles**: Netdata ships with a [large library of profiles](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/config/go.d/snmp.profiles/default) for major vendors, enabling automatic, out-of-the-box monitoring—**no manual OID configuration needed** for common hardware.
172 + - **Custom profiles supported**: Users can extend or override stock profiles to add new devices, modify charts, or collect additional OIDs.
173 + - **Automatic vendor/model detection**: Devices are matched to the right profile using selectors such as `sysObjectID` and `sysDescr`.
174 + - **ICMP ping**: Optional round-trip latency monitoring alongside SNMP, with a `ping_only` mode available.
175 + - **SNMP v1, v2c, and v3 support**: Fully implemented via the [gosnmp](https://github.com/gosnmp/gosnmp) library.
176 +
177 +
178 + **Built-in profiles for major vendors:**
179 +
180 + | Category | Vendors |
181 + |----------|---------|
182 + | Switches & Routers | Cisco (Catalyst, Nexus, ASR, ISR), Arista, Juniper, HP/HPE, Dell, Extreme |
183 + | Firewalls | Palo Alto, Fortinet FortiGate, Cisco ASA, Checkpoint, SonicWall |
184 + | Wireless | Aruba, Cisco WLC, Ubiquiti, Alcatel-Lucent |
185 + | Load Balancers | F5 BIG-IP, Citrix NetScaler, A10 Thunder |
186 + | Infrastructure | APC UPS/PDU, Dell servers, plus standard MIBs (BGP, OSPF, TCP/UDP) |
187 +
188 + > This list highlights major vendors—any SNMP-enabled device can be monitored using stock or custom profiles.
189 + method_description: |
190 + ::: info
191 +
192 + See: [SNMP Profile Format](/src/go/plugin/go.d/collector/snmp/profile-format.md) to learn how to write your own or extend stock ones.
193
26 - :::tip
27 -
28 - See: [SNMP Profile Format](/src/go/plugin/go.d/collector/snmp/profile-format.md) to learn how to write profiles and define their fields.
194 + :::
195
196 **Profile locations**
197
198 | 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),
44 - - how to label rows (metric tags), and
45 - - chart/metric metadata (units, families, types), including optional **virtual metrics**.
46 -
47 - At runtime, the collector:
48 - 1) identifies the device by reading standard system OIDs (e.g. `sysObjectID`, `sysDescr`),
49 - 2) picks the best-matching profile(s), and
50 - 3) collects exactly the metrics defined by those profiles.
51 -
52 - Because profiles vary per vendor/model/OS, there is **no fixed list of metrics** in this page. Netdata renders the charts that each matched profile defines (interfaces, optics, CPU/mem, environment, VLANs, etc., depending on the device).
53 -
54 - The collector optionally runs **ICMP round-trip (ping)** alongside SNMP for availability and latency. A `ping_only` mode is available to skip periodic SNMP polling.
55 -
56 - SNMP versions v1, v2c, and v3 are supported, implemented via the [gosnmp](https://github.com/gosnmp/gosnmp) library.
57 - method_description: ""
199 + |------|--------------|-------|
200 + | **Stock profiles** | `/usr/lib/netdata/conf.d/go.d/snmp.profiles/default/` | Shipped with Netdata |
201 + | **User profiles** | `/etc/netdata/go.d/snmp.profiles/` | Place custom or modified profiles here |
202 +
203 + > Depending on installation, paths may be prefixed with `/opt/netdata`.
204 +
205 + A **profile** defines:
206 +
207 + - Device selectors for auto-matching (e.g. `sysObjectID`, `sysDescr`)
208 + - The exact OIDs to collect (scalars and tables)
209 + - How to label table rows (metric tags)
210 + - Chart/metric metadata (units, families, types), including optional **virtual metrics**
211 +
212 + **At runtime, the collector**:
213 +
214 + 1. Reads standard system OIDs (e.g. `sysObjectID`, `sysDescr`) to identify the device
215 + 2. Picks the best matching vendor/model profile(s)
216 + 3. Collects exactly the metrics those profiles define
217 supported_platforms:
218 include: []
219 exclude: []