docs: restructure Setup, update SNMP prerequisites, and fix SNMP options (#20977)
Ilya Mashchenko committed
Sep 14, 2025 at 19:02 UTC
8b7837ae9dc1ee3bf04fc581c959232481cbe670
3 files changed
+36
-15
integrations/templates/setup.md
+22
-3
@@ -10,6 +10,23 @@
10
There is no configuration needed for this integration.
11
[% else %]
12
13
+[% if entry.meta.plugin_name == 'go.d.plugin' %]
14
+
15
+You can configure the **[[ entry.meta.module_name ]]** collector in two ways:
16
+
17
+| Method | Best for | How to |
18
+|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
19
+| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **[[ entry.meta.module_name ]]**, then click **+** to add a job. |
20
+| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `[[ entry.setup.configuration.file.name ]]` and add a job. |
21
+
22
+:::important
23
+
24
+UI configuration requires paid Netdata Cloud plan. File-based configuration uses the same options and is useful if you prefer configuring via file or need to automate deployments.
25
+
26
+:::
27
+
28
+[% endif %]
29
+
30
[% if entry.setup.description %]
31
[[ entry.setup.description ]]
32
[% else %]
@@ -63,14 +80,16 @@ There are no configuration options.
80
[% if entry.meta.plugin_name == 'go.d.plugin' %]
81
#### via UI
82
66
-The **[[ entry.meta.module_name ]]** collector can be configured directly through the Netdata web interface:
83
+Configure the **[[ entry.meta.module_name ]]** collector from the Netdata web interface:
84
85
1. Go to **Nodes**.
69
-2. Select the node **where you want the [[ entry.meta.module_name ]] data-collection job to run** and click the :gear: (**Configure this node**). This node will be responsible for collecting metrics.
86
+2. Select the node **where you want the [[ entry.meta.module_name ]] data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
87
3. The **Collectors → Jobs** view opens by default.
88
4. In the Search box, type _[[ entry.meta.module_name ]]_ (or scroll the list) to locate the **[[ entry.meta.module_name ]]** collector.
89
5. Click the **+** next to the **[[ entry.meta.module_name ]]** collector to add a new job.
73
-6. Fill in the job fields, then **Test** the configuration and **Submit**.
90
+6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
91
+ - **Test** runs the job with the provided settings and shows whether data can be collected.
92
+ - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
93
94
[% endif %]
95
integrations/templates/setup/sample-go-config.md
+1
-1
@@ -5,5 +5,5 @@ update_every: 1
5
autodetection_retry: 0
6
jobs:
7
- name: some_name1
8
- - name: some_name1
8
+ - name: some_name2
9
```
src/go/plugin/go.d/collector/snmp/metadata.yaml
+13
-11
@@ -65,7 +65,13 @@ modules:
65
**Concurrent access**: If multiple collectors or tools access the same SNMP device simultaneously, data points might be skipped. This is a limitation of the device itself, not this collector. To mitigate this, consider increasing the collection interval (update_every) to reduce the frequency of requests.
66
setup:
67
prerequisites:
68
- list: []
68
+ list:
69
+ - title: "Prepare the SNMP device"
70
+ description: |
71
+ Before configuring the collector:
72
+ - Enable the SNMP service on the target device (through its management interface).
73
+ - Make sure the device is reachable from the Netdata node on port 161/UDP.
74
+ - Have ready the required connection details: IP address, SNMP version, and either a community string (v1/v2c) or user credentials (v3).
75
configuration:
76
file:
77
name: go.d/snmp.conf
@@ -85,7 +91,7 @@ modules:
91
default_value: 0
92
required: false
93
- name: hostname
88
- description: Target ipv4 address.
94
+ description: Target host (IP or DNS name, IPv4/IPv6).
95
default_value: ""
96
required: true
97
- name: enable_profiles
@@ -93,7 +99,7 @@ modules:
99
default_value: "true"
100
required: false
101
- name: enable_profiles_table_metrics
96
- description: Enable collection of SNMP table metrics from profiles. Enabling this may **increase collection time and memory usage** for devices with many network interfaces*.
102
+ description: Enable collection of SNMP table metrics from profiles. Enabling this may **increase collection time and memory usage** for devices with many network interfaces.
103
default_value: "true"
104
required: false
105
- name: disable_legacy_collection
@@ -160,11 +166,7 @@ modules:
166
description: SNMPv3 user name.
167
default_value: ""
168
required: false
163
- - name: user.name
164
- description: Security level of SNMPv3 messages.
165
- default_value: ""
166
- required: false
167
- - name: user.auth_proto
169
+ - name: user.level
170
description: Security level of SNMPv3 messages.
171
default_value: ""
172
required: false
@@ -176,7 +178,7 @@ modules:
178
| none | 1 | no message authentication or encryption |
179
| authNoPriv | 2 | message authentication and no encryption |
180
| authPriv | 3 | message authentication and encryption |
179
- - name: user.name
181
+ - name: user.auth_proto
182
description: Authentication protocol for SNMPv3 messages.
183
default_value: ""
184
required: false
@@ -193,7 +195,7 @@ modules:
195
| sha384 | 6 | SHA message authentication (HMAC-SHA-384) |
196
| sha512 | 7 | SHA message authentication (HMAC-SHA-512) |
197
- name: user.auth_key
196
- description: Authentication protocol pass phrase.
198
+ description: Authentication protocol pass phrase for SNMPv3 messages.
199
default_value: ""
200
required: false
201
- name: user.priv_proto
@@ -213,7 +215,7 @@ modules:
215
| aes192c | 6 | 192-bit AES encryption (CFB-AES-192) with "Reeder" key localization |
216
| aes256c | 7 | 256-bit AES encryption (CFB-AES-256) with "Reeder" key localization |
217
- name: user.priv_key
216
- description: Privacy protocol pass phrase.
218
+ description: Privacy protocol pass phrase for SNMPv3 messages.
219
default_value: ""
220
required: false
221
examples: