summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/icecast
diff options
context:
space:
mode:
authorTasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com>2023-02-20 16:56:42 +0200
committerGitHub <noreply@github.com>2023-02-20 06:56:42 -0800
commit7ca95ce4cda8308d01dbb574f3d1023abc04bf1b (patch)
treed5d8cdda809454c16e4987380d3ad6db1beabb3f /collectors/python.d.plugin/icecast
parentff14cf0df6e7d29c6f0a0ee152f20d5ef7608fa5 (diff)
Include troubleshooting section in the docs of python.d modules (#13721)
Add troubleshooting sections to all python modules Signed-off-by: Tasos Katsoulas <tasos@netdata.cloud>
Diffstat (limited to 'collectors/python.d.plugin/icecast')
-rw-r--r--collectors/python.d.plugin/icecast/README.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/collectors/python.d.plugin/icecast/README.md b/collectors/python.d.plugin/icecast/README.md
index 1188822bee..95209b16ee 100644
--- a/collectors/python.d.plugin/icecast/README.md
+++ b/collectors/python.d.plugin/icecast/README.md
@@ -42,6 +42,26 @@ remote:
Without configuration, module attempts to connect to `http://localhost:8443/status-json.xsl`
----
+
+### Troubleshooting
+
+To troubleshoot issues with the `icecast` module, run the `python.d.plugin` with the debug option enabled. The
+output will give you the output of the data collection job or error messages on why the collector isn't working.
+
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
+plugin's directory, switch to the `netdata` user.
+
+```bash
+cd /usr/libexec/netdata/plugins.d/
+sudo su -s /bin/bash netdata
+```
+
+Now you can manually run the `icecast` module in debug mode:
+
+```bash
+./python.d.plugin icecast debug trace
+```
+