docs: reword go.d Troubleshooting section for clarity (#20259)
Ilya Mashchenko committed
May 8, 2025 at 20:08 UTC
cf5cd7c25753bd6932bc32a3e665133d5cf620b4
1 file changed
+11
-8
src/go/plugin/go.d/README.md
+11
-8
@@ -190,7 +190,7 @@ Then [restart netdata](/docs/netdata-agent/start-stop-restart.md) for the change
190
191
## Troubleshooting
192
193
-### Plugin CLI:
193
+### Plugin CLI
194
195
```sh
196
Usage:
@@ -207,19 +207,22 @@ Help Options:
207
-h, --help Show this help message
208
```
209
210
-### To debug specific module:
210
+### Debugging a Specific Module
211
+
212
+To debug a particular module, first switch to the Netdata user:
213
214
```bash
213
-# become user netdata
215
sudo su -s /bin/bash netdata
216
```
217
217
-Depending on where Netdata was installed, execute one of the following commands to trace the execution of a python module:
218
+Then run the plugin in debug mode, specifying your target module:
219
220
```bash
220
-# execute the plugin in debug mode, for a specific module
221
-/opt/netdata/usr/libexec/netdata/plugins.d/go.d.plugin -d -m <module name>
222
-/usr/libexec/netdata/plugins.d/go.d.plugin -d -m <module name>
221
+# For standard installations
222
+/usr/libexec/netdata/plugins.d/go.d.plugin -d -m <module_name>
223
+
224
+# For static installations (e.g., in /opt)
225
+/opt/netdata/usr/libexec/netdata/plugins.d/go.d.plugin -d -m <module_name>
226
```
227
225
-Change `<module name>` to the [module name](#available-modules) you want to debug.
228
+Replace` <module_name>` with the [specific module](#available-modules) you wish to debug.