opensourcemirror
/
netdata
mirror of https://github.com/netdata/netdata.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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>
This commit is contained in:
Tasos Katsoulas 2023-02-20 16:56:42 +02:00 committed by GitHub
parent ff14cf0df6
commit 7ca95ce4cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
45 changed files with 917 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
collectors/python.d.plugin/adaptec_raid/README.md
View File

@ -78,6 +78,26 @@ sudo ./edit-config python.d/adaptec_raid.conf
![image](https://user-images.githubusercontent.com/22274335/47278133-6d306680-d601-11e8-87c2-cc9c0f42d686.png)
---
### Troubleshooting
To troubleshoot issues with the `adaptec_raid` 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 `adaptec_raid` module in debug mode:
```bash
./python.d.plugin adaptec_raid debug trace
```

20
collectors/python.d.plugin/alarms/README.md
View File

@ -67,3 +67,23 @@ local:
```
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`
### Troubleshooting
To troubleshoot issues with the `alarms` 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 `alarms` module in debug mode:
```bash
./python.d.plugin alarms debug trace
```

20
collectors/python.d.plugin/am2320/README.md
View File

@ -54,3 +54,23 @@ Software install:
- restart the netdata service.
- check the dashboard.
### Troubleshooting
To troubleshoot issues with the `am2320` 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 `am2320` module in debug mode:
```bash
./python.d.plugin am2320 debug trace
```

2
collectors/python.d.plugin/anomalies/README.md
View File

@ -83,7 +83,7 @@ sudo ./edit-config python.d/anomalies.conf
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.
```conf
# ----------------------------------------------------------------------
# -
# JOBS (data collection sources)
# Pull data from local Netdata node.

22
collectors/python.d.plugin/beanstalk/README.md
View File

@ -131,6 +131,26 @@ port : 11300
If no configuration is given, module will attempt to connect to beanstalkd on `127.0.0.1:11300` address
---
### Troubleshooting
To troubleshoot issues with the `beanstalk` 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 `beanstalk` module in debug mode:
```bash
./python.d.plugin beanstalk debug trace
```

22
collectors/python.d.plugin/bind_rndc/README.md
View File

@ -77,6 +77,26 @@ local:
If no configuration is given, module will attempt to read named.stats file at `/var/log/bind/named.stats`
---
### Troubleshooting
To troubleshoot issues with the `bind_rndc` 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 `bind_rndc` module in debug mode:
```bash
./python.d.plugin bind_rndc debug trace
```

22
collectors/python.d.plugin/boinc/README.md
View File

@ -39,6 +39,26 @@ remote:
password: some-password
```
---
### Troubleshooting
To troubleshoot issues with the `boinc` 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 `boinc` module in debug mode:
```bash
./python.d.plugin boinc debug trace
```

22
collectors/python.d.plugin/ceph/README.md
View File

@ -46,6 +46,26 @@ local:
keyring_file: '/etc/ceph/ceph.client.admin.keyring'
```
---
### Troubleshooting
To troubleshoot issues with the `ceph` 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 `ceph` module in debug mode:
```bash
./python.d.plugin ceph debug trace
```

22
collectors/python.d.plugin/changefinder/README.md
View File

@ -108,7 +108,7 @@ The default configuration should look something like this. Here you can see each
information about each one and what it does.
```yaml
# ----------------------------------------------------------------------
# -
# JOBS (data collection sources)
# Pull data from local Netdata node.
@ -219,3 +219,23 @@ sudo su -s /bin/bash netdata
- Novelty and outlier detection in
the [scikit-learn documentation](https://scikit-learn.org/stable/modules/outlier_detection.html).
### Troubleshooting
To troubleshoot issues with the `changefinder` 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 `changefinder` module in debug mode:
```bash
./python.d.plugin changefinder debug trace
```

22
collectors/python.d.plugin/dovecot/README.md
View File

@ -103,6 +103,26 @@ localsocket:
If no configuration is given, module will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`
---
### Troubleshooting
To troubleshoot issues with the `dovecot` 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 `dovecot` module in debug mode:
```bash
./python.d.plugin dovecot debug trace
```

20
collectors/python.d.plugin/example/README.md
View File

@ -16,3 +16,23 @@ Netdata provides an [example python data collection module](https://github.com/n
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.
### Troubleshooting
To troubleshoot issues with the `example` 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 `example` module in debug mode:
```bash
./python.d.plugin example debug trace
```

22
collectors/python.d.plugin/exim/README.md
View File

@ -39,6 +39,26 @@ It produces only one chart:
Configuration is not needed.
---
### Troubleshooting
To troubleshoot issues with the `exim` 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 `exim` module in debug mode:
```bash
./python.d.plugin exim debug trace
```

22
collectors/python.d.plugin/fail2ban/README.md
View File

@ -80,6 +80,26 @@ local:
If no configuration is given, module will attempt to read log file at `/var/log/fail2ban.log` and conf file
at `/etc/fail2ban/jail.local`. If conf file is not found default jail is `ssh`.
---
### Troubleshooting
To troubleshoot issues with the `fail2ban` 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 `fail2ban` module in debug mode:
```bash
./python.d.plugin fail2ban debug trace
```

20
collectors/python.d.plugin/gearman/README.md
View File

@ -51,3 +51,23 @@ localhost:
When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`.
### Troubleshooting
To troubleshoot issues with the `gearman` 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 `gearman` module in debug mode:
```bash
./python.d.plugin gearman debug trace
```

20
collectors/python.d.plugin/go_expvar/README.md
View File

@ -320,3 +320,23 @@ The images below show how do the final charts in Netdata look.
![Custom charts](https://cloud.githubusercontent.com/assets/15180106/26762051/62ae915e-493b-11e7-8518-bd25a3886650.png)
### Troubleshooting
To troubleshoot issues with the `go_expvar` 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 `go_expvar` module in debug mode:
```bash
./python.d.plugin go_expvar debug trace
```

22
collectors/python.d.plugin/haproxy/README.md
View File

@ -67,4 +67,24 @@ via_socket:
If no configuration is given, module will fail to run.
---
### Troubleshooting
To troubleshoot issues with the `haproxy` 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 `haproxy` module in debug mode:
```bash
./python.d.plugin haproxy debug trace
```

22
collectors/python.d.plugin/hddtemp/README.md
View File

@ -36,6 +36,26 @@ port: 7634
If no configuration is given, module will attempt to connect to hddtemp daemon on `127.0.0.1:7634` address
---
### Troubleshooting
To troubleshoot issues with the `hddtemp` 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 `hddtemp` module in debug mode:
```bash
./python.d.plugin hddtemp debug trace
```

20
collectors/python.d.plugin/hpssa/README.md
View File

@ -84,3 +84,23 @@ ssacli_path: /usr/sbin/ssacli
Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
### Troubleshooting
To troubleshoot issues with the `hpssa` 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 `hpssa` module in debug mode:
```bash
./python.d.plugin hpssa debug trace
```

22
collectors/python.d.plugin/icecast/README.md
View File

@ -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
```

24
collectors/python.d.plugin/ipfs/README.md
View File

@ -30,7 +30,7 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
sudo ./edit-config python.d/ipfs.conf
```
---
Calls to the following endpoints are disabled due to `IPFS` bugs:
@ -49,6 +49,26 @@ remote:
url: 'http://203.0.113.10::5001'
```
---
### Troubleshooting
To troubleshoot issues with the `ipfs` 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 `ipfs` module in debug mode:
```bash
./python.d.plugin ipfs debug trace
```

22
collectors/python.d.plugin/litespeed/README.md
View File

@ -70,6 +70,26 @@ local:
If no configuration is given, module will use "/tmp/lshttpd/".
---
### Troubleshooting
To troubleshoot issues with the `litespeed` 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 `litespeed` module in debug mode:
```bash
./python.d.plugin litespeed debug trace
```

20
collectors/python.d.plugin/megacli/README.md
View File

@ -87,3 +87,23 @@ Save the file and restart the Netdata Agent with `sudo systemctl restart netdata
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
### Troubleshooting
To troubleshoot issues with the `megacli` 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 `megacli` module in debug mode:
```bash
./python.d.plugin megacli debug trace
```

22
collectors/python.d.plugin/memcached/README.md
View File

@ -97,6 +97,26 @@ localtcpip:
If no configuration is given, module will attempt to connect to memcached instance on `127.0.0.1:11211` address.
---
### Troubleshooting
To troubleshoot issues with the `memcached` 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 `memcached` module in debug mode:
```bash
./python.d.plugin memcached debug trace
```

22
collectors/python.d.plugin/monit/README.md
View File

@ -53,6 +53,26 @@ local:
If no configuration is given, module will attempt to connect to monit as `http://localhost:2812`.
---
### Troubleshooting
To troubleshoot issues with the `monit` 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 `monit` module in debug mode:
```bash
./python.d.plugin monit debug trace
```

22
collectors/python.d.plugin/nsd/README.md
View File

@ -66,6 +66,26 @@ It produces:
Configuration is not needed.
---
### Troubleshooting
To troubleshoot issues with the `nsd` 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 `nsd` module in debug mode:
```bash
./python.d.plugin nsd debug trace
```

20
collectors/python.d.plugin/nvidia_smi/README.md
View File

@ -67,3 +67,23 @@ exclude_zero_memory_users : yes
```
### Troubleshooting
To troubleshoot issues with the `nvidia_smi` 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 `nvidia_smi` module in debug mode:
```bash
./python.d.plugin nvidia_smi debug trace
```

22
collectors/python.d.plugin/openldap/README.md
View File

@ -77,6 +77,26 @@ openldap:
port : 389
```
---
### Troubleshooting
To troubleshoot issues with the `openldap` 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 `openldap` module in debug mode:
```bash
./python.d.plugin openldap debug trace
```

20
collectors/python.d.plugin/oracledb/README.md
View File

@ -98,3 +98,23 @@ remote:
All parameters are required. Without them module will fail to start.
### Troubleshooting
To troubleshoot issues with the `oracledb` 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 `oracledb` module in debug mode:
```bash
./python.d.plugin oracledb debug trace
```

20
collectors/python.d.plugin/postfix/README.md
View File

@ -37,3 +37,23 @@ It produces only two charts:
## Configuration
Configuration is not needed.
### Troubleshooting
To troubleshoot issues with the `postfix` 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 `postfix` module in debug mode:
```bash
./python.d.plugin postfix debug trace
```

22
collectors/python.d.plugin/puppet/README.md
View File

@ -65,6 +65,26 @@ When no configuration is given, module uses `https://fqdn.example.com:8140`.
- Secure PuppetDB config may require client certificate. Not applies
to default PuppetDB configuration though.
---
### Troubleshooting
To troubleshoot issues with the `puppet` 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 `puppet` module in debug mode:
```bash
./python.d.plugin puppet debug trace
```

22
collectors/python.d.plugin/rethinkdbs/README.md
View File

@ -52,6 +52,26 @@ localhost:
When no configuration file is found, module tries to connect to `127.0.0.1:28015`.
---
### Troubleshooting
To troubleshoot issues with the `rethinkdbs` 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 `rethinkdbs` module in debug mode:
```bash
./python.d.plugin rethinkdbs debug trace
```

22
collectors/python.d.plugin/retroshare/README.md
View File

@ -45,6 +45,26 @@ remote:
user : "user"
password : "pass"
```
---
### Troubleshooting
To troubleshoot issues with the `retroshare` 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 `retroshare` module in debug mode:
```bash
./python.d.plugin retroshare debug trace
```

20
collectors/python.d.plugin/riakkv/README.md
View File

@ -127,3 +127,23 @@ With no explicit configuration given, the module will attempt to connect to
The default update frequency for the plugin is set to 2 seconds as Riak
internally updates the metrics every second. If we were to update the metrics
every second, the resulting graph would contain odd jitter.
### Troubleshooting
To troubleshoot issues with the `riakkv` 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 `riakkv` module in debug mode:
```bash
./python.d.plugin riakkv debug trace
```

22
collectors/python.d.plugin/samba/README.md
View File

@ -119,6 +119,26 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
sudo ./edit-config python.d/samba.conf
```
---
### Troubleshooting
To troubleshoot issues with the `samba` 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 `samba` module in debug mode:
```bash
./python.d.plugin samba debug trace
```

31
collectors/python.d.plugin/sensors/README.md
View File

@ -25,12 +25,31 @@ sudo ./edit-config python.d/sensors.conf
### possible issues
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.
We are tracking such cases in issue [#827](https://github.com/netdata/netdata/issues/827).
Please join this discussion for help.
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. We are tracking such cases in
issue [#827](https://github.com/netdata/netdata/issues/827). Please join this discussion for help.
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)
---
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)
### Troubleshooting
To troubleshoot issues with the `sensors` 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 `sensors` module in debug mode:
```bash
./python.d.plugin sensors debug trace
```

22
collectors/python.d.plugin/smartd_log/README.md
View File

@ -123,6 +123,26 @@ local:
If no configuration is given, module will attempt to read log files in `/var/log/smartd/` directory.
---
### Troubleshooting
To troubleshoot issues with the `smartd_log` 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 `smartd_log` module in debug mode:
```bash
./python.d.plugin smartd_log debug trace
```

22
collectors/python.d.plugin/spigotmc/README.md
View File

@ -36,6 +36,26 @@ password: pass
By default, a connection to port 25575 on the local system is attempted with an empty password.
---
### Troubleshooting
To troubleshoot issues with the `spigotmc` 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 `spigotmc` module in debug mode:
```bash
./python.d.plugin spigotmc debug trace
```

22
collectors/python.d.plugin/squid/README.md
View File

@ -56,6 +56,26 @@ local:
Without any configuration module will try to autodetect where squid presents its `counters` data
---
### Troubleshooting
To troubleshoot issues with the `squid` 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 `squid` module in debug mode:
```bash
./python.d.plugin squid debug trace
```

22
collectors/python.d.plugin/tomcat/README.md
View File

@ -51,6 +51,26 @@ localhost:
Without configuration, module attempts to connect to `http://localhost:8080/manager/status?XML=true`, without any credentials.
So it will probably fail.
---
### Troubleshooting
To troubleshoot issues with the `tomcat` 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 `tomcat` module in debug mode:
```bash
./python.d.plugin tomcat debug trace
```

22
collectors/python.d.plugin/tor/README.md
View File

@ -64,6 +64,26 @@ For more options please read the manual.
Without configuration, module attempts to connect to `127.0.0.1:9051`.
---
### Troubleshooting
To troubleshoot issues with the `tor` 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 `tor` module in debug mode:
```bash
./python.d.plugin tor debug trace
```

22
collectors/python.d.plugin/traefik/README.md
View File

@ -73,6 +73,26 @@ local:
Without configuration, module attempts to connect to `http://localhost:8080/health`.
---
### Troubleshooting
To troubleshoot issues with the `traefik` 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 `traefik` module in debug mode:
```bash
./python.d.plugin traefik debug trace
```

20
collectors/python.d.plugin/uwsgi/README.md
View File

@ -53,3 +53,23 @@ localhost:
When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:1717`.
### Troubleshooting
To troubleshoot issues with the `uwsgi` 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 `uwsgi` module in debug mode:
```bash
./python.d.plugin uwsgi debug trace
```

22
collectors/python.d.plugin/varnish/README.md
View File

@ -63,6 +63,26 @@ instance_name: 'name'
The name of the `varnishd` instance to get logs from. If not specified, the host name is used.
---
### Troubleshooting
To troubleshoot issues with the `varnish` 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 `varnish` module in debug mode:
```bash
./python.d.plugin varnish debug trace
```

22
collectors/python.d.plugin/w1sensor/README.md
View File

@ -26,6 +26,26 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
sudo ./edit-config python.d/w1sensor.conf
```
---
### Troubleshooting
To troubleshoot issues with the `w1sensor` 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 `w1sensor` module in debug mode:
```bash
./python.d.plugin w1sensor debug trace
```

20
collectors/python.d.plugin/zscores/README.md
View File

@ -146,3 +146,23 @@ per_chart_agg: 'mean' # 'absmax' will take the max absolute value across all dim
- If you activate this collector on a fresh node, it might take a little while to build up enough data to calculate a
proper zscore. So until you actually have `train_secs` of available data the mean and stddev calculated will be subject
to more noise.
### Troubleshooting
To troubleshoot issues with the `zscores` 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 `zscores` module in debug mode:
```bash
./python.d.plugin zscores debug trace
```