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>
Tasos Katsoulas committed
Feb 20, 2023 at 16:56 UTC
7ca95ce4cda8308d01dbb574f3d1023abc04bf1b
45 files changed
+916
-37
collectors/python.d.plugin/adaptec_raid/README.md
+21
-1
@@ -78,6 +78,26 @@ sudo ./edit-config python.d/adaptec_raid.conf
78
79
80
81
----
81
82
83
+
84
+### Troubleshooting
85
+
86
+To troubleshoot issues with the `adaptec_raid` module, run the `python.d.plugin` with the debug option enabled. The
87
+output will give you the output of the data collection job or error messages on why the collector isn't working.
88
+
89
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
90
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
91
+plugin's directory, switch to the `netdata` user.
92
+
93
+```bash
94
+cd /usr/libexec/netdata/plugins.d/
95
+sudo su -s /bin/bash netdata
96
+```
97
+
98
+Now you can manually run the `adaptec_raid` module in debug mode:
99
+
100
+```bash
101
+./python.d.plugin adaptec_raid debug trace
102
+```
103
+
collectors/python.d.plugin/alarms/README.md
+20
@@ -67,3 +67,23 @@ local:
67
```
68
69
It will default to pulling all alarms at each time step from the Netdata rest api at `http://127.0.0.1:19999/api/v1/alarms?all`
70
+### Troubleshooting
71
+
72
+To troubleshoot issues with the `alarms` module, run the `python.d.plugin` with the debug option enabled. The
73
+output will give you the output of the data collection job or error messages on why the collector isn't working.
74
+
75
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
76
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
77
+plugin's directory, switch to the `netdata` user.
78
+
79
+```bash
80
+cd /usr/libexec/netdata/plugins.d/
81
+sudo su -s /bin/bash netdata
82
+```
83
+
84
+Now you can manually run the `alarms` module in debug mode:
85
+
86
+```bash
87
+./python.d.plugin alarms debug trace
88
+```
89
+
collectors/python.d.plugin/am2320/README.md
+20
@@ -54,3 +54,23 @@ Software install:
54
- restart the netdata service.
55
- check the dashboard.
56
57
+### Troubleshooting
58
+
59
+To troubleshoot issues with the `am2320` module, run the `python.d.plugin` with the debug option enabled. The
60
+output will give you the output of the data collection job or error messages on why the collector isn't working.
61
+
62
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
63
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
64
+plugin's directory, switch to the `netdata` user.
65
+
66
+```bash
67
+cd /usr/libexec/netdata/plugins.d/
68
+sudo su -s /bin/bash netdata
69
+```
70
+
71
+Now you can manually run the `am2320` module in debug mode:
72
+
73
+```bash
74
+./python.d.plugin am2320 debug trace
75
+```
76
+
collectors/python.d.plugin/anomalies/README.md
+1
-1
@@ -83,7 +83,7 @@ sudo ./edit-config python.d/anomalies.conf
83
The default configuration should look something like this. Here you can see each parameter (with sane defaults) and some information about each one and what it does.
84
85
```conf
86
-# ----------------------------------------------------------------------
86
+# -
87
# JOBS (data collection sources)
88
89
# Pull data from local Netdata node.
collectors/python.d.plugin/beanstalk/README.md
+21
-1
@@ -131,6 +131,26 @@ port : 11300
131
132
If no configuration is given, module will attempt to connect to beanstalkd on `127.0.0.1:11300` address
133
134
----
134
135
136
+
137
+### Troubleshooting
138
+
139
+To troubleshoot issues with the `beanstalk` module, run the `python.d.plugin` with the debug option enabled. The
140
+output will give you the output of the data collection job or error messages on why the collector isn't working.
141
+
142
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
143
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
144
+plugin's directory, switch to the `netdata` user.
145
+
146
+```bash
147
+cd /usr/libexec/netdata/plugins.d/
148
+sudo su -s /bin/bash netdata
149
+```
150
+
151
+Now you can manually run the `beanstalk` module in debug mode:
152
+
153
+```bash
154
+./python.d.plugin beanstalk debug trace
155
+```
156
+
collectors/python.d.plugin/bind_rndc/README.md
+21
-1
@@ -77,6 +77,26 @@ local:
77
78
If no configuration is given, module will attempt to read named.stats file at `/var/log/bind/named.stats`
79
80
----
80
81
82
+
83
+### Troubleshooting
84
+
85
+To troubleshoot issues with the `bind_rndc` module, run the `python.d.plugin` with the debug option enabled. The
86
+output will give you the output of the data collection job or error messages on why the collector isn't working.
87
+
88
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
89
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
90
+plugin's directory, switch to the `netdata` user.
91
+
92
+```bash
93
+cd /usr/libexec/netdata/plugins.d/
94
+sudo su -s /bin/bash netdata
95
+```
96
+
97
+Now you can manually run the `bind_rndc` module in debug mode:
98
+
99
+```bash
100
+./python.d.plugin bind_rndc debug trace
101
+```
102
+
collectors/python.d.plugin/boinc/README.md
+21
-1
@@ -39,6 +39,26 @@ remote:
39
password: some-password
40
```
41
42
----
42
43
44
+
45
+### Troubleshooting
46
+
47
+To troubleshoot issues with the `boinc` module, run the `python.d.plugin` with the debug option enabled. The
48
+output will give you the output of the data collection job or error messages on why the collector isn't working.
49
+
50
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
51
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
52
+plugin's directory, switch to the `netdata` user.
53
+
54
+```bash
55
+cd /usr/libexec/netdata/plugins.d/
56
+sudo su -s /bin/bash netdata
57
+```
58
+
59
+Now you can manually run the `boinc` module in debug mode:
60
+
61
+```bash
62
+./python.d.plugin boinc debug trace
63
+```
64
+
collectors/python.d.plugin/ceph/README.md
+21
-1
@@ -46,6 +46,26 @@ local:
46
keyring_file: '/etc/ceph/ceph.client.admin.keyring'
47
```
48
49
----
49
50
51
+
52
+### Troubleshooting
53
+
54
+To troubleshoot issues with the `ceph` module, run the `python.d.plugin` with the debug option enabled. The
55
+output will give you the output of the data collection job or error messages on why the collector isn't working.
56
+
57
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
58
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
59
+plugin's directory, switch to the `netdata` user.
60
+
61
+```bash
62
+cd /usr/libexec/netdata/plugins.d/
63
+sudo su -s /bin/bash netdata
64
+```
65
+
66
+Now you can manually run the `ceph` module in debug mode:
67
+
68
+```bash
69
+./python.d.plugin ceph debug trace
70
+```
71
+
collectors/python.d.plugin/changefinder/README.md
+21
-1
@@ -108,7 +108,7 @@ The default configuration should look something like this. Here you can see each
108
information about each one and what it does.
109
110
```yaml
111
-# ----------------------------------------------------------------------
111
+# -
112
# JOBS (data collection sources)
113
114
# Pull data from local Netdata node.
@@ -219,3 +219,23 @@ sudo su -s /bin/bash netdata
219
- Novelty and outlier detection in
220
the [scikit-learn documentation](https://scikit-learn.org/stable/modules/outlier_detection.html).
221
222
+### Troubleshooting
223
+
224
+To troubleshoot issues with the `changefinder` module, run the `python.d.plugin` with the debug option enabled. The
225
+output will give you the output of the data collection job or error messages on why the collector isn't working.
226
+
227
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
228
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
229
+plugin's directory, switch to the `netdata` user.
230
+
231
+```bash
232
+cd /usr/libexec/netdata/plugins.d/
233
+sudo su -s /bin/bash netdata
234
+```
235
+
236
+Now you can manually run the `changefinder` module in debug mode:
237
+
238
+```bash
239
+./python.d.plugin changefinder debug trace
240
+```
241
+
collectors/python.d.plugin/dovecot/README.md
+21
-1
@@ -103,6 +103,26 @@ localsocket:
103
104
If no configuration is given, module will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`
105
106
----
106
107
108
+
109
+### Troubleshooting
110
+
111
+To troubleshoot issues with the `dovecot` module, run the `python.d.plugin` with the debug option enabled. The
112
+output will give you the output of the data collection job or error messages on why the collector isn't working.
113
+
114
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
115
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
116
+plugin's directory, switch to the `netdata` user.
117
+
118
+```bash
119
+cd /usr/libexec/netdata/plugins.d/
120
+sudo su -s /bin/bash netdata
121
+```
122
+
123
+Now you can manually run the `dovecot` module in debug mode:
124
+
125
+```bash
126
+./python.d.plugin dovecot debug trace
127
+```
128
+
collectors/python.d.plugin/example/README.md
+20
@@ -16,3 +16,23 @@ Netdata provides an [example python data collection module](https://github.com/n
16
If you want to write your own collector, read our [writing a new Python module](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#how-to-write-a-new-module) tutorial.
17
18
19
+### Troubleshooting
20
+
21
+To troubleshoot issues with the `example` module, run the `python.d.plugin` with the debug option enabled. The
22
+output will give you the output of the data collection job or error messages on why the collector isn't working.
23
+
24
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
25
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
26
+plugin's directory, switch to the `netdata` user.
27
+
28
+```bash
29
+cd /usr/libexec/netdata/plugins.d/
30
+sudo su -s /bin/bash netdata
31
+```
32
+
33
+Now you can manually run the `example` module in debug mode:
34
+
35
+```bash
36
+./python.d.plugin example debug trace
37
+```
38
+
collectors/python.d.plugin/exim/README.md
+21
-1
@@ -39,6 +39,26 @@ It produces only one chart:
39
40
Configuration is not needed.
41
42
----
42
43
44
+
45
+### Troubleshooting
46
+
47
+To troubleshoot issues with the `exim` module, run the `python.d.plugin` with the debug option enabled. The
48
+output will give you the output of the data collection job or error messages on why the collector isn't working.
49
+
50
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
51
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
52
+plugin's directory, switch to the `netdata` user.
53
+
54
+```bash
55
+cd /usr/libexec/netdata/plugins.d/
56
+sudo su -s /bin/bash netdata
57
+```
58
+
59
+Now you can manually run the `exim` module in debug mode:
60
+
61
+```bash
62
+./python.d.plugin exim debug trace
63
+```
64
+
collectors/python.d.plugin/fail2ban/README.md
+21
-1
@@ -80,6 +80,26 @@ local:
80
If no configuration is given, module will attempt to read log file at `/var/log/fail2ban.log` and conf file
81
at `/etc/fail2ban/jail.local`. If conf file is not found default jail is `ssh`.
82
83
----
83
84
85
+
86
+### Troubleshooting
87
+
88
+To troubleshoot issues with the `fail2ban` module, run the `python.d.plugin` with the debug option enabled. The
89
+output will give you the output of the data collection job or error messages on why the collector isn't working.
90
+
91
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
92
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
93
+plugin's directory, switch to the `netdata` user.
94
+
95
+```bash
96
+cd /usr/libexec/netdata/plugins.d/
97
+sudo su -s /bin/bash netdata
98
+```
99
+
100
+Now you can manually run the `fail2ban` module in debug mode:
101
+
102
+```bash
103
+./python.d.plugin fail2ban debug trace
104
+```
105
+
collectors/python.d.plugin/gearman/README.md
+20
@@ -51,3 +51,23 @@ localhost:
51
52
When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`.
53
54
+### Troubleshooting
55
+
56
+To troubleshoot issues with the `gearman` module, run the `python.d.plugin` with the debug option enabled. The
57
+output will give you the output of the data collection job or error messages on why the collector isn't working.
58
+
59
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
60
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
61
+plugin's directory, switch to the `netdata` user.
62
+
63
+```bash
64
+cd /usr/libexec/netdata/plugins.d/
65
+sudo su -s /bin/bash netdata
66
+```
67
+
68
+Now you can manually run the `gearman` module in debug mode:
69
+
70
+```bash
71
+./python.d.plugin gearman debug trace
72
+```
73
+
collectors/python.d.plugin/go_expvar/README.md
+20
@@ -320,3 +320,23 @@ The images below show how do the final charts in Netdata look.
320
321
322
323
+### Troubleshooting
324
+
325
+To troubleshoot issues with the `go_expvar` module, run the `python.d.plugin` with the debug option enabled. The
326
+output will give you the output of the data collection job or error messages on why the collector isn't working.
327
+
328
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
329
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
330
+plugin's directory, switch to the `netdata` user.
331
+
332
+```bash
333
+cd /usr/libexec/netdata/plugins.d/
334
+sudo su -s /bin/bash netdata
335
+```
336
+
337
+Now you can manually run the `go_expvar` module in debug mode:
338
+
339
+```bash
340
+./python.d.plugin go_expvar debug trace
341
+```
342
+
collectors/python.d.plugin/haproxy/README.md
+21
-1
@@ -67,4 +67,24 @@ via_socket:
67
68
If no configuration is given, module will fail to run.
69
70
----
70
+
71
+### Troubleshooting
72
+
73
+To troubleshoot issues with the `haproxy` module, run the `python.d.plugin` with the debug option enabled. The
74
+output will give you the output of the data collection job or error messages on why the collector isn't working.
75
+
76
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
77
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
78
+plugin's directory, switch to the `netdata` user.
79
+
80
+```bash
81
+cd /usr/libexec/netdata/plugins.d/
82
+sudo su -s /bin/bash netdata
83
+```
84
+
85
+Now you can manually run the `haproxy` module in debug mode:
86
+
87
+```bash
88
+./python.d.plugin haproxy debug trace
89
+```
90
+
collectors/python.d.plugin/hddtemp/README.md
+21
-1
@@ -36,6 +36,26 @@ port: 7634
36
37
If no configuration is given, module will attempt to connect to hddtemp daemon on `127.0.0.1:7634` address
38
39
----
39
40
41
+
42
+### Troubleshooting
43
+
44
+To troubleshoot issues with the `hddtemp` module, run the `python.d.plugin` with the debug option enabled. The
45
+output will give you the output of the data collection job or error messages on why the collector isn't working.
46
+
47
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
48
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
49
+plugin's directory, switch to the `netdata` user.
50
+
51
+```bash
52
+cd /usr/libexec/netdata/plugins.d/
53
+sudo su -s /bin/bash netdata
54
+```
55
+
56
+Now you can manually run the `hddtemp` module in debug mode:
57
+
58
+```bash
59
+./python.d.plugin hddtemp debug trace
60
+```
61
+
collectors/python.d.plugin/hpssa/README.md
+20
@@ -84,3 +84,23 @@ ssacli_path: /usr/sbin/ssacli
84
Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate
85
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
86
87
+### Troubleshooting
88
+
89
+To troubleshoot issues with the `hpssa` module, run the `python.d.plugin` with the debug option enabled. The
90
+output will give you the output of the data collection job or error messages on why the collector isn't working.
91
+
92
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
93
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
94
+plugin's directory, switch to the `netdata` user.
95
+
96
+```bash
97
+cd /usr/libexec/netdata/plugins.d/
98
+sudo su -s /bin/bash netdata
99
+```
100
+
101
+Now you can manually run the `hpssa` module in debug mode:
102
+
103
+```bash
104
+./python.d.plugin hpssa debug trace
105
+```
106
+
collectors/python.d.plugin/icecast/README.md
+21
-1
@@ -42,6 +42,26 @@ remote:
42
43
Without configuration, module attempts to connect to `http://localhost:8443/status-json.xsl`
44
45
----
45
46
47
+
48
+### Troubleshooting
49
+
50
+To troubleshoot issues with the `icecast` module, run the `python.d.plugin` with the debug option enabled. The
51
+output will give you the output of the data collection job or error messages on why the collector isn't working.
52
+
53
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
54
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
55
+plugin's directory, switch to the `netdata` user.
56
+
57
+```bash
58
+cd /usr/libexec/netdata/plugins.d/
59
+sudo su -s /bin/bash netdata
60
+```
61
+
62
+Now you can manually run the `icecast` module in debug mode:
63
+
64
+```bash
65
+./python.d.plugin icecast debug trace
66
+```
67
+
collectors/python.d.plugin/ipfs/README.md
+22
-2
@@ -30,7 +30,7 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
30
sudo ./edit-config python.d/ipfs.conf
31
```
32
33
----
33
+
34
35
Calls to the following endpoints are disabled due to `IPFS` bugs:
36
@@ -49,6 +49,26 @@ remote:
49
url: 'http://203.0.113.10::5001'
50
```
51
52
----
52
53
54
+
55
+### Troubleshooting
56
+
57
+To troubleshoot issues with the `ipfs` module, run the `python.d.plugin` with the debug option enabled. The
58
+output will give you the output of the data collection job or error messages on why the collector isn't working.
59
+
60
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
61
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
62
+plugin's directory, switch to the `netdata` user.
63
+
64
+```bash
65
+cd /usr/libexec/netdata/plugins.d/
66
+sudo su -s /bin/bash netdata
67
+```
68
+
69
+Now you can manually run the `ipfs` module in debug mode:
70
+
71
+```bash
72
+./python.d.plugin ipfs debug trace
73
+```
74
+
collectors/python.d.plugin/litespeed/README.md
+21
-1
@@ -70,6 +70,26 @@ local:
70
71
If no configuration is given, module will use "/tmp/lshttpd/".
72
73
----
73
74
75
+
76
+### Troubleshooting
77
+
78
+To troubleshoot issues with the `litespeed` module, run the `python.d.plugin` with the debug option enabled. The
79
+output will give you the output of the data collection job or error messages on why the collector isn't working.
80
+
81
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
82
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
83
+plugin's directory, switch to the `netdata` user.
84
+
85
+```bash
86
+cd /usr/libexec/netdata/plugins.d/
87
+sudo su -s /bin/bash netdata
88
+```
89
+
90
+Now you can manually run the `litespeed` module in debug mode:
91
+
92
+```bash
93
+./python.d.plugin litespeed debug trace
94
+```
95
+
collectors/python.d.plugin/megacli/README.md
+20
@@ -87,3 +87,23 @@ Save the file and restart the Netdata Agent with `sudo systemctl restart netdata
87
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
88
89
90
+### Troubleshooting
91
+
92
+To troubleshoot issues with the `megacli` module, run the `python.d.plugin` with the debug option enabled. The
93
+output will give you the output of the data collection job or error messages on why the collector isn't working.
94
+
95
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
96
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
97
+plugin's directory, switch to the `netdata` user.
98
+
99
+```bash
100
+cd /usr/libexec/netdata/plugins.d/
101
+sudo su -s /bin/bash netdata
102
+```
103
+
104
+Now you can manually run the `megacli` module in debug mode:
105
+
106
+```bash
107
+./python.d.plugin megacli debug trace
108
+```
109
+
collectors/python.d.plugin/memcached/README.md
+21
-1
@@ -97,6 +97,26 @@ localtcpip:
97
98
If no configuration is given, module will attempt to connect to memcached instance on `127.0.0.1:11211` address.
99
100
----
100
101
102
+
103
+### Troubleshooting
104
+
105
+To troubleshoot issues with the `memcached` module, run the `python.d.plugin` with the debug option enabled. The
106
+output will give you the output of the data collection job or error messages on why the collector isn't working.
107
+
108
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
109
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
110
+plugin's directory, switch to the `netdata` user.
111
+
112
+```bash
113
+cd /usr/libexec/netdata/plugins.d/
114
+sudo su -s /bin/bash netdata
115
+```
116
+
117
+Now you can manually run the `memcached` module in debug mode:
118
+
119
+```bash
120
+./python.d.plugin memcached debug trace
121
+```
122
+
collectors/python.d.plugin/monit/README.md
+21
-1
@@ -53,6 +53,26 @@ local:
53
54
If no configuration is given, module will attempt to connect to monit as `http://localhost:2812`.
55
56
----
56
57
58
+
59
+### Troubleshooting
60
+
61
+To troubleshoot issues with the `monit` module, run the `python.d.plugin` with the debug option enabled. The
62
+output will give you the output of the data collection job or error messages on why the collector isn't working.
63
+
64
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
65
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
66
+plugin's directory, switch to the `netdata` user.
67
+
68
+```bash
69
+cd /usr/libexec/netdata/plugins.d/
70
+sudo su -s /bin/bash netdata
71
+```
72
+
73
+Now you can manually run the `monit` module in debug mode:
74
+
75
+```bash
76
+./python.d.plugin monit debug trace
77
+```
78
+
collectors/python.d.plugin/nsd/README.md
+21
-1
@@ -66,6 +66,26 @@ It produces:
66
67
Configuration is not needed.
68
69
----
69
70
71
+
72
+### Troubleshooting
73
+
74
+To troubleshoot issues with the `nsd` module, run the `python.d.plugin` with the debug option enabled. The
75
+output will give you the output of the data collection job or error messages on why the collector isn't working.
76
+
77
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
78
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
79
+plugin's directory, switch to the `netdata` user.
80
+
81
+```bash
82
+cd /usr/libexec/netdata/plugins.d/
83
+sudo su -s /bin/bash netdata
84
+```
85
+
86
+Now you can manually run the `nsd` module in debug mode:
87
+
88
+```bash
89
+./python.d.plugin nsd debug trace
90
+```
91
+
collectors/python.d.plugin/nvidia_smi/README.md
+20
@@ -67,3 +67,23 @@ exclude_zero_memory_users : yes
67
```
68
69
70
+### Troubleshooting
71
+
72
+To troubleshoot issues with the `nvidia_smi` module, run the `python.d.plugin` with the debug option enabled. The
73
+output will give you the output of the data collection job or error messages on why the collector isn't working.
74
+
75
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
76
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
77
+plugin's directory, switch to the `netdata` user.
78
+
79
+```bash
80
+cd /usr/libexec/netdata/plugins.d/
81
+sudo su -s /bin/bash netdata
82
+```
83
+
84
+Now you can manually run the `nvidia_smi` module in debug mode:
85
+
86
+```bash
87
+./python.d.plugin nvidia_smi debug trace
88
+```
89
+
collectors/python.d.plugin/openldap/README.md
+21
-1
@@ -77,6 +77,26 @@ openldap:
77
port : 389
78
```
79
80
----
80
81
82
+
83
+### Troubleshooting
84
+
85
+To troubleshoot issues with the `openldap` module, run the `python.d.plugin` with the debug option enabled. The
86
+output will give you the output of the data collection job or error messages on why the collector isn't working.
87
+
88
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
89
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
90
+plugin's directory, switch to the `netdata` user.
91
+
92
+```bash
93
+cd /usr/libexec/netdata/plugins.d/
94
+sudo su -s /bin/bash netdata
95
+```
96
+
97
+Now you can manually run the `openldap` module in debug mode:
98
+
99
+```bash
100
+./python.d.plugin openldap debug trace
101
+```
102
+
collectors/python.d.plugin/oracledb/README.md
+20
@@ -98,3 +98,23 @@ remote:
98
All parameters are required. Without them module will fail to start.
99
100
101
+### Troubleshooting
102
+
103
+To troubleshoot issues with the `oracledb` module, run the `python.d.plugin` with the debug option enabled. The
104
+output will give you the output of the data collection job or error messages on why the collector isn't working.
105
+
106
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
107
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
108
+plugin's directory, switch to the `netdata` user.
109
+
110
+```bash
111
+cd /usr/libexec/netdata/plugins.d/
112
+sudo su -s /bin/bash netdata
113
+```
114
+
115
+Now you can manually run the `oracledb` module in debug mode:
116
+
117
+```bash
118
+./python.d.plugin oracledb debug trace
119
+```
120
+
collectors/python.d.plugin/postfix/README.md
+20
@@ -37,3 +37,23 @@ It produces only two charts:
37
## Configuration
38
39
Configuration is not needed.
40
+### Troubleshooting
41
+
42
+To troubleshoot issues with the `postfix` module, run the `python.d.plugin` with the debug option enabled. The
43
+output will give you the output of the data collection job or error messages on why the collector isn't working.
44
+
45
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
46
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
47
+plugin's directory, switch to the `netdata` user.
48
+
49
+```bash
50
+cd /usr/libexec/netdata/plugins.d/
51
+sudo su -s /bin/bash netdata
52
+```
53
+
54
+Now you can manually run the `postfix` module in debug mode:
55
+
56
+```bash
57
+./python.d.plugin postfix debug trace
58
+```
59
+
collectors/python.d.plugin/puppet/README.md
+21
-1
@@ -65,6 +65,26 @@ When no configuration is given, module uses `https://fqdn.example.com:8140`.
65
- Secure PuppetDB config may require client certificate. Not applies
66
to default PuppetDB configuration though.
67
68
----
68
69
70
+
71
+### Troubleshooting
72
+
73
+To troubleshoot issues with the `puppet` module, run the `python.d.plugin` with the debug option enabled. The
74
+output will give you the output of the data collection job or error messages on why the collector isn't working.
75
+
76
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
77
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
78
+plugin's directory, switch to the `netdata` user.
79
+
80
+```bash
81
+cd /usr/libexec/netdata/plugins.d/
82
+sudo su -s /bin/bash netdata
83
+```
84
+
85
+Now you can manually run the `puppet` module in debug mode:
86
+
87
+```bash
88
+./python.d.plugin puppet debug trace
89
+```
90
+
collectors/python.d.plugin/rethinkdbs/README.md
+21
-1
@@ -52,6 +52,26 @@ localhost:
52
53
When no configuration file is found, module tries to connect to `127.0.0.1:28015`.
54
55
----
55
56
57
+
58
+### Troubleshooting
59
+
60
+To troubleshoot issues with the `rethinkdbs` module, run the `python.d.plugin` with the debug option enabled. The
61
+output will give you the output of the data collection job or error messages on why the collector isn't working.
62
+
63
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
64
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
65
+plugin's directory, switch to the `netdata` user.
66
+
67
+```bash
68
+cd /usr/libexec/netdata/plugins.d/
69
+sudo su -s /bin/bash netdata
70
+```
71
+
72
+Now you can manually run the `rethinkdbs` module in debug mode:
73
+
74
+```bash
75
+./python.d.plugin rethinkdbs debug trace
76
+```
77
+
collectors/python.d.plugin/retroshare/README.md
+21
-1
@@ -45,6 +45,26 @@ remote:
45
user : "user"
46
password : "pass"
47
```
48
----
48
49
50
+
51
+### Troubleshooting
52
+
53
+To troubleshoot issues with the `retroshare` module, run the `python.d.plugin` with the debug option enabled. The
54
+output will give you the output of the data collection job or error messages on why the collector isn't working.
55
+
56
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
57
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
58
+plugin's directory, switch to the `netdata` user.
59
+
60
+```bash
61
+cd /usr/libexec/netdata/plugins.d/
62
+sudo su -s /bin/bash netdata
63
+```
64
+
65
+Now you can manually run the `retroshare` module in debug mode:
66
+
67
+```bash
68
+./python.d.plugin retroshare debug trace
69
+```
70
+
collectors/python.d.plugin/riakkv/README.md
+20
@@ -127,3 +127,23 @@ With no explicit configuration given, the module will attempt to connect to
127
The default update frequency for the plugin is set to 2 seconds as Riak
128
internally updates the metrics every second. If we were to update the metrics
129
every second, the resulting graph would contain odd jitter.
130
+### Troubleshooting
131
+
132
+To troubleshoot issues with the `riakkv` module, run the `python.d.plugin` with the debug option enabled. The
133
+output will give you the output of the data collection job or error messages on why the collector isn't working.
134
+
135
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
136
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
137
+plugin's directory, switch to the `netdata` user.
138
+
139
+```bash
140
+cd /usr/libexec/netdata/plugins.d/
141
+sudo su -s /bin/bash netdata
142
+```
143
+
144
+Now you can manually run the `riakkv` module in debug mode:
145
+
146
+```bash
147
+./python.d.plugin riakkv debug trace
148
+```
149
+
collectors/python.d.plugin/samba/README.md
+21
-1
@@ -119,6 +119,26 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
119
sudo ./edit-config python.d/samba.conf
120
```
121
122
----
122
123
124
+
125
+### Troubleshooting
126
+
127
+To troubleshoot issues with the `samba` module, run the `python.d.plugin` with the debug option enabled. The
128
+output will give you the output of the data collection job or error messages on why the collector isn't working.
129
+
130
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
131
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
132
+plugin's directory, switch to the `netdata` user.
133
+
134
+```bash
135
+cd /usr/libexec/netdata/plugins.d/
136
+sudo su -s /bin/bash netdata
137
+```
138
+
139
+Now you can manually run the `samba` module in debug mode:
140
+
141
+```bash
142
+./python.d.plugin samba debug trace
143
+```
144
+
collectors/python.d.plugin/sensors/README.md
+24
-5
@@ -25,12 +25,31 @@ sudo ./edit-config python.d/sensors.conf
25
26
### possible issues
27
28
-There have been reports from users that on certain servers, ACPI ring buffer errors are printed by the kernel (`dmesg`) when ACPI sensors are being accessed.
29
-We are tracking such cases in issue [#827](https://github.com/netdata/netdata/issues/827).
30
-Please join this discussion for help.
28
+There have been reports from users that on certain servers, ACPI ring buffer errors are printed by the kernel (`dmesg`)
29
+when ACPI sensors are being accessed. We are tracking such cases in
30
+issue [#827](https://github.com/netdata/netdata/issues/827). Please join this discussion for help.
31
32
-When `lm-sensors` doesn't work on your device (e.g. for RPi temperatures), use [the legacy bash collector](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/sensors/README.md)
32
+When `lm-sensors` doesn't work on your device (e.g. for RPi temperatures),
33
+use [the legacy bash collector](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/sensors/README.md)
34
34
----
35
36
+### Troubleshooting
37
+
38
+To troubleshoot issues with the `sensors` module, run the `python.d.plugin` with the debug option enabled. The
39
+output will give you the output of the data collection job or error messages on why the collector isn't working.
40
+
41
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
42
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
43
+plugin's directory, switch to the `netdata` user.
44
+
45
+```bash
46
+cd /usr/libexec/netdata/plugins.d/
47
+sudo su -s /bin/bash netdata
48
+```
49
+
50
+Now you can manually run the `sensors` module in debug mode:
51
+
52
+```bash
53
+./python.d.plugin sensors debug trace
54
+```
55
collectors/python.d.plugin/smartd_log/README.md
+21
-1
@@ -123,6 +123,26 @@ local:
123
124
If no configuration is given, module will attempt to read log files in `/var/log/smartd/` directory.
125
126
----
126
127
128
+
129
+### Troubleshooting
130
+
131
+To troubleshoot issues with the `smartd_log` module, run the `python.d.plugin` with the debug option enabled. The
132
+output will give you the output of the data collection job or error messages on why the collector isn't working.
133
+
134
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
135
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
136
+plugin's directory, switch to the `netdata` user.
137
+
138
+```bash
139
+cd /usr/libexec/netdata/plugins.d/
140
+sudo su -s /bin/bash netdata
141
+```
142
+
143
+Now you can manually run the `smartd_log` module in debug mode:
144
+
145
+```bash
146
+./python.d.plugin smartd_log debug trace
147
+```
148
+
collectors/python.d.plugin/spigotmc/README.md
+21
-1
@@ -36,6 +36,26 @@ password: pass
36
37
By default, a connection to port 25575 on the local system is attempted with an empty password.
38
39
----
39
40
41
+
42
+### Troubleshooting
43
+
44
+To troubleshoot issues with the `spigotmc` module, run the `python.d.plugin` with the debug option enabled. The
45
+output will give you the output of the data collection job or error messages on why the collector isn't working.
46
+
47
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
48
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
49
+plugin's directory, switch to the `netdata` user.
50
+
51
+```bash
52
+cd /usr/libexec/netdata/plugins.d/
53
+sudo su -s /bin/bash netdata
54
+```
55
+
56
+Now you can manually run the `spigotmc` module in debug mode:
57
+
58
+```bash
59
+./python.d.plugin spigotmc debug trace
60
+```
61
+
collectors/python.d.plugin/squid/README.md
+21
-1
@@ -56,6 +56,26 @@ local:
56
57
Without any configuration module will try to autodetect where squid presents its `counters` data
58
59
----
59
60
61
+
62
+### Troubleshooting
63
+
64
+To troubleshoot issues with the `squid` module, run the `python.d.plugin` with the debug option enabled. The
65
+output will give you the output of the data collection job or error messages on why the collector isn't working.
66
+
67
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
68
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
69
+plugin's directory, switch to the `netdata` user.
70
+
71
+```bash
72
+cd /usr/libexec/netdata/plugins.d/
73
+sudo su -s /bin/bash netdata
74
+```
75
+
76
+Now you can manually run the `squid` module in debug mode:
77
+
78
+```bash
79
+./python.d.plugin squid debug trace
80
+```
81
+
collectors/python.d.plugin/tomcat/README.md
+21
-1
@@ -51,6 +51,26 @@ localhost:
51
Without configuration, module attempts to connect to `http://localhost:8080/manager/status?XML=true`, without any credentials.
52
So it will probably fail.
53
54
----
54
55
56
+
57
+### Troubleshooting
58
+
59
+To troubleshoot issues with the `tomcat` module, run the `python.d.plugin` with the debug option enabled. The
60
+output will give you the output of the data collection job or error messages on why the collector isn't working.
61
+
62
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
63
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
64
+plugin's directory, switch to the `netdata` user.
65
+
66
+```bash
67
+cd /usr/libexec/netdata/plugins.d/
68
+sudo su -s /bin/bash netdata
69
+```
70
+
71
+Now you can manually run the `tomcat` module in debug mode:
72
+
73
+```bash
74
+./python.d.plugin tomcat debug trace
75
+```
76
+
collectors/python.d.plugin/tor/README.md
+21
-1
@@ -64,6 +64,26 @@ For more options please read the manual.
64
65
Without configuration, module attempts to connect to `127.0.0.1:9051`.
66
67
----
67
68
69
+
70
+### Troubleshooting
71
+
72
+To troubleshoot issues with the `tor` module, run the `python.d.plugin` with the debug option enabled. The
73
+output will give you the output of the data collection job or error messages on why the collector isn't working.
74
+
75
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
76
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
77
+plugin's directory, switch to the `netdata` user.
78
+
79
+```bash
80
+cd /usr/libexec/netdata/plugins.d/
81
+sudo su -s /bin/bash netdata
82
+```
83
+
84
+Now you can manually run the `tor` module in debug mode:
85
+
86
+```bash
87
+./python.d.plugin tor debug trace
88
+```
89
+
collectors/python.d.plugin/traefik/README.md
+21
-1
@@ -73,6 +73,26 @@ local:
73
74
Without configuration, module attempts to connect to `http://localhost:8080/health`.
75
76
----
76
77
78
+
79
+### Troubleshooting
80
+
81
+To troubleshoot issues with the `traefik` module, run the `python.d.plugin` with the debug option enabled. The
82
+output will give you the output of the data collection job or error messages on why the collector isn't working.
83
+
84
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
85
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
86
+plugin's directory, switch to the `netdata` user.
87
+
88
+```bash
89
+cd /usr/libexec/netdata/plugins.d/
90
+sudo su -s /bin/bash netdata
91
+```
92
+
93
+Now you can manually run the `traefik` module in debug mode:
94
+
95
+```bash
96
+./python.d.plugin traefik debug trace
97
+```
98
+
collectors/python.d.plugin/uwsgi/README.md
+20
@@ -53,3 +53,23 @@ localhost:
53
When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:1717`.
54
55
56
+### Troubleshooting
57
+
58
+To troubleshoot issues with the `uwsgi` module, run the `python.d.plugin` with the debug option enabled. The
59
+output will give you the output of the data collection job or error messages on why the collector isn't working.
60
+
61
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
62
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
63
+plugin's directory, switch to the `netdata` user.
64
+
65
+```bash
66
+cd /usr/libexec/netdata/plugins.d/
67
+sudo su -s /bin/bash netdata
68
+```
69
+
70
+Now you can manually run the `uwsgi` module in debug mode:
71
+
72
+```bash
73
+./python.d.plugin uwsgi debug trace
74
+```
75
+
collectors/python.d.plugin/varnish/README.md
+21
-1
@@ -63,6 +63,26 @@ instance_name: 'name'
63
64
The name of the `varnishd` instance to get logs from. If not specified, the host name is used.
65
66
----
66
67
68
+
69
+### Troubleshooting
70
+
71
+To troubleshoot issues with the `varnish` module, run the `python.d.plugin` with the debug option enabled. The
72
+output will give you the output of the data collection job or error messages on why the collector isn't working.
73
+
74
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
75
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
76
+plugin's directory, switch to the `netdata` user.
77
+
78
+```bash
79
+cd /usr/libexec/netdata/plugins.d/
80
+sudo su -s /bin/bash netdata
81
+```
82
+
83
+Now you can manually run the `varnish` module in debug mode:
84
+
85
+```bash
86
+./python.d.plugin varnish debug trace
87
+```
88
+
collectors/python.d.plugin/w1sensor/README.md
+21
-1
@@ -26,6 +26,26 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
26
sudo ./edit-config python.d/w1sensor.conf
27
```
28
29
----
29
30
31
+
32
+### Troubleshooting
33
+
34
+To troubleshoot issues with the `w1sensor` module, run the `python.d.plugin` with the debug option enabled. The
35
+output will give you the output of the data collection job or error messages on why the collector isn't working.
36
+
37
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
38
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
39
+plugin's directory, switch to the `netdata` user.
40
+
41
+```bash
42
+cd /usr/libexec/netdata/plugins.d/
43
+sudo su -s /bin/bash netdata
44
+```
45
+
46
+Now you can manually run the `w1sensor` module in debug mode:
47
+
48
+```bash
49
+./python.d.plugin w1sensor debug trace
50
+```
51
+
collectors/python.d.plugin/zscores/README.md
+20
@@ -146,3 +146,23 @@ per_chart_agg: 'mean' # 'absmax' will take the max absolute value across all dim
146
- If you activate this collector on a fresh node, it might take a little while to build up enough data to calculate a
147
proper zscore. So until you actually have `train_secs` of available data the mean and stddev calculated will be subject
148
to more noise.
149
+### Troubleshooting
150
+
151
+To troubleshoot issues with the `zscores` module, run the `python.d.plugin` with the debug option enabled. The
152
+output will give you the output of the data collection job or error messages on why the collector isn't working.
153
+
154
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
155
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
156
+plugin's directory, switch to the `netdata` user.
157
+
158
+```bash
159
+cd /usr/libexec/netdata/plugins.d/
160
+sudo su -s /bin/bash netdata
161
+```
162
+
163
+Now you can manually run the `zscores` module in debug mode:
164
+
165
+```bash
166
+./python.d.plugin zscores debug trace
167
+```
168
+