summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-02-12 05:11:32 -0700
committerGitHub <noreply@github.com>2020-02-12 05:11:32 -0700
commit8166f8bc2aed417285cf08c2a9b60d2ebc3b872c (patch)
treef67382d28c26a182a7ff9d1667854303834c3e50
parent162b78443a0a48bf0c012da094760375b755173e (diff)
Added collector config to relevant READMEs (#8052)
-rw-r--r--collectors/charts.d.plugin/ap/README.md11
-rw-r--r--collectors/charts.d.plugin/apcupsd/README.md10
-rw-r--r--collectors/charts.d.plugin/libreswan/README.md10
-rw-r--r--collectors/charts.d.plugin/nut/README.md12
-rw-r--r--collectors/charts.d.plugin/opensips/README.md10
-rw-r--r--collectors/charts.d.plugin/sensors/README.md12
-rw-r--r--collectors/python.d.plugin/adaptec_raid/README.md12
-rw-r--r--collectors/python.d.plugin/am2320/README.md8
-rw-r--r--collectors/python.d.plugin/apache/README.md8
-rw-r--r--collectors/python.d.plugin/beanstalk/README.md8
-rw-r--r--collectors/python.d.plugin/bind_rndc/README.md8
-rw-r--r--collectors/python.d.plugin/boinc/README.md8
-rw-r--r--collectors/python.d.plugin/ceph/README.md8
-rw-r--r--collectors/python.d.plugin/chrony/README.md8
-rw-r--r--collectors/python.d.plugin/couchdb/README.md8
-rw-r--r--collectors/python.d.plugin/dns_query_time/README.md10
-rw-r--r--collectors/python.d.plugin/dnsdist/README.md8
-rw-r--r--collectors/python.d.plugin/dockerd/README.md8
-rw-r--r--collectors/python.d.plugin/dovecot/README.md8
-rw-r--r--collectors/python.d.plugin/elasticsearch/README.md8
-rw-r--r--collectors/python.d.plugin/energid/README.md8
-rw-r--r--collectors/python.d.plugin/fail2ban/README.md8
-rw-r--r--collectors/python.d.plugin/freeradius/README.md8
-rw-r--r--collectors/python.d.plugin/gearman/README.md10
-rw-r--r--collectors/python.d.plugin/go_expvar/README.md10
-rw-r--r--collectors/python.d.plugin/haproxy/README.md10
-rw-r--r--collectors/python.d.plugin/hddtemp/README.md10
-rw-r--r--collectors/python.d.plugin/hpssa/README.md8
-rw-r--r--collectors/python.d.plugin/httpcheck/README.md10
-rw-r--r--collectors/python.d.plugin/icecast/README.md10
-rw-r--r--collectors/python.d.plugin/ipfs/README.md10
-rw-r--r--collectors/python.d.plugin/isc_dhcpd/README.md10
-rw-r--r--collectors/python.d.plugin/litespeed/README.md10
-rw-r--r--collectors/python.d.plugin/logind/README.md10
-rw-r--r--collectors/python.d.plugin/megacli/README.md12
-rw-r--r--collectors/python.d.plugin/memcached/README.md10
-rw-r--r--collectors/python.d.plugin/mongodb/README.md10
-rw-r--r--collectors/python.d.plugin/monit/README.md10
-rw-r--r--collectors/python.d.plugin/mysql/README.md10
-rw-r--r--collectors/python.d.plugin/nginx/README.md12
-rw-r--r--collectors/python.d.plugin/nginx_plus/README.md14
-rw-r--r--collectors/python.d.plugin/ntpd/README.md10
-rw-r--r--collectors/python.d.plugin/nvidia_smi/README.md10
-rw-r--r--collectors/python.d.plugin/openldap/README.md10
-rw-r--r--collectors/python.d.plugin/oracledb/README.md10
-rw-r--r--collectors/python.d.plugin/ovpn_status_log/README.md10
-rw-r--r--collectors/python.d.plugin/phpfpm/README.md8
-rw-r--r--collectors/python.d.plugin/portcheck/README.md10
-rw-r--r--collectors/python.d.plugin/postgres/README.md14
-rw-r--r--collectors/python.d.plugin/powerdns/README.md10
-rw-r--r--collectors/python.d.plugin/proxysql/README.md10
-rw-r--r--collectors/python.d.plugin/puppet/README.md10
-rw-r--r--collectors/python.d.plugin/rabbitmq/README.md14
-rw-r--r--collectors/python.d.plugin/redis/README.md10
-rw-r--r--collectors/python.d.plugin/rethinkdbs/README.md10
-rw-r--r--collectors/python.d.plugin/retroshare/README.md8
-rw-r--r--collectors/python.d.plugin/riakkv/README.md10
-rw-r--r--collectors/python.d.plugin/samba/README.md12
-rw-r--r--collectors/python.d.plugin/sensors/README.md8
-rw-r--r--collectors/python.d.plugin/smartd_log/README.md10
-rw-r--r--collectors/python.d.plugin/spigotmc/README.md10
-rw-r--r--collectors/python.d.plugin/springboot/README.md8
-rw-r--r--collectors/python.d.plugin/squid/README.md10
-rw-r--r--collectors/python.d.plugin/tomcat/README.md10
-rw-r--r--collectors/python.d.plugin/tor/README.md12
-rw-r--r--collectors/python.d.plugin/traefik/README.md10
-rw-r--r--collectors/python.d.plugin/uwsgi/README.md10
-rw-r--r--collectors/python.d.plugin/varnish/README.md8
-rw-r--r--collectors/python.d.plugin/w1sensor/README.md10
-rw-r--r--collectors/python.d.plugin/web_log/README.md12
-rw-r--r--docs/step-by-step/step-04.md2
71 files changed, 619 insertions, 70 deletions
diff --git a/collectors/charts.d.plugin/ap/README.md b/collectors/charts.d.plugin/ap/README.md
index befe21eecf..60c547237f 100644
--- a/collectors/charts.d.plugin/ap/README.md
+++ b/collectors/charts.d.plugin/ap/README.md
@@ -76,8 +76,15 @@ Station 40:b8:37:5a:ed:5e (on wlan0)
## Configuration
-You can only set `ap_update_every=NUMBER` to `/etc/netdata/charts.d/ap.conf`, to give the data collection frequency.
-To edit this file on your system run `/etc/netdata/edit-config charts.d/ap.conf`.
+Edit the `charts.d/ap.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config charts.d/ap.conf
+```
+
+You can only set `ap_update_every=NUMBER` to change the data collection frequency.
## Auto-detection
diff --git a/collectors/charts.d.plugin/apcupsd/README.md b/collectors/charts.d.plugin/apcupsd/README.md
index 51bb6eccd0..2aff8b6e11 100644
--- a/collectors/charts.d.plugin/apcupsd/README.md
+++ b/collectors/charts.d.plugin/apcupsd/README.md
@@ -1,7 +1,13 @@
# apcupsd
-_Under construction_
+## Configuration
-Collects UPS metrics
+Edit the `charts.d/apcupsd.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config charts.d/apcupsd.conf
+```
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fcharts.d.plugin%2Fapcupsd%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/collectors/charts.d.plugin/libreswan/README.md b/collectors/charts.d.plugin/libreswan/README.md
index d75c1ea96b..372866c603 100644
--- a/collectors/charts.d.plugin/libreswan/README.md
+++ b/collectors/charts.d.plugin/libreswan/README.md
@@ -13,9 +13,15 @@ The following charts are created, **per tunnel**:
- bytes in
- bytes out
-## configuration
+## Configuration
-Its config file is `/etc/netdata/charts.d/libreswan.conf`.
+Edit the `charts.d/libreswan.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config charts.d/libreswan.conf
+```
The plugin executes 2 commands to collect all the information it needs:
diff --git a/collectors/charts.d.plugin/nut/README.md b/collectors/charts.d.plugin/nut/README.md
index ea93318f84..04f2694933 100644
--- a/collectors/charts.d.plugin/nut/README.md
+++ b/collectors/charts.d.plugin/nut/README.md
@@ -42,9 +42,17 @@ The following charts will be created:
- current temperature
-## configuration
+## Configuration
-This is the internal default for `/etc/netdata/nut.conf`
+Edit the `charts.d/nut.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config charts.d/nut.conf
+```
+
+This is the internal default for `charts.d/nut.conf`
```sh
# a space separated list of UPS names
diff --git a/collectors/charts.d.plugin/opensips/README.md b/collectors/charts.d.plugin/opensips/README.md
index d41b41120a..20698f9b82 100644
--- a/collectors/charts.d.plugin/opensips/README.md
+++ b/collectors/charts.d.plugin/opensips/README.md
@@ -1,7 +1,13 @@
# OpenSIPS
-_Under construction_
+## Configuration
-Collects OpenSIPS metrics
+Edit the `charts.d/opensips.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config charts.d/opensips.conf
+```
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fcharts.d.plugin%2Fopensips%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/collectors/charts.d.plugin/sensors/README.md b/collectors/charts.d.plugin/sensors/README.md
index a3fa9d20f7..de7f908548 100644
--- a/collectors/charts.d.plugin/sensors/README.md
+++ b/collectors/charts.d.plugin/sensors/README.md
@@ -24,9 +24,17 @@ The plugin will create Netdata charts for:
One chart for every sensor chip found and each of the above will be created.
-## configuration
+## Configuration
-This is the internal default for `/etc/netdata/sensors.conf`
+Edit the `charts.d/sensors.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config charts.d/sensors.conf
+```
+
+This is the internal default for `charts.d/sensors.conf`
```sh
# the directory the kernel keeps sensor data
diff --git a/collectors/python.d.plugin/adaptec_raid/README.md b/collectors/python.d.plugin/adaptec_raid/README.md
index 127d595b23..91663aead4 100644
--- a/collectors/python.d.plugin/adaptec_raid/README.md
+++ b/collectors/python.d.plugin/adaptec_raid/README.md
@@ -35,14 +35,22 @@ Add to `sudoers`:
netdata ALL=(root) NOPASSWD: /path/to/arcconf
```
-## configuration
+## Configuration
- **adaptec_raid** is disabled by default. Should be explicitly enabled in `python.d.conf`.
+**adaptec_raid** is disabled by default. Should be explicitly enabled in `python.d.conf`.
```yaml
adaptec_raid: yes
```
+Edit the `python.d/adaptec_raid.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/adaptec_raid.conf
+```
+
### Screenshot:
![image](https://user-images.githubusercontent.com/22274335/47278133-6d306680-d601-11e8-87c2-cc9c0f42d686.png)
diff --git a/collectors/python.d.plugin/am2320/README.md b/collectors/python.d.plugin/am2320/README.md
index a0c47e80db..516f54d932 100644
--- a/collectors/python.d.plugin/am2320/README.md
+++ b/collectors/python.d.plugin/am2320/README.md
@@ -13,6 +13,14 @@ It produces the following charts:
## configuration
+Edit the `python.d/am2320.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/am2320.conf
+```
+
Raspbery Pi Instructions:
Hardware install:
diff --git a/collectors/python.d.plugin/apache/README.md b/collectors/python.d.plugin/apache/README.md
index 8f0ec0c1c7..4201bfbe40 100644
--- a/collectors/python.d.plugin/apache/README.md
+++ b/collectors/python.d.plugin/apache/README.md
@@ -45,6 +45,14 @@ It produces the following charts:
## configuration
+Edit the `python.d/apache.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/apache.conf
+```
+
Needs only `url` to server's `server-status?auto`
Here is an example for 2 servers:
diff --git a/collectors/python.d.plugin/beanstalk/README.md b/collectors/python.d.plugin/beanstalk/README.md
index c93dfa0d42..c294ac0589 100644
--- a/collectors/python.d.plugin/beanstalk/README.md
+++ b/collectors/python.d.plugin/beanstalk/README.md
@@ -105,6 +105,14 @@ Module provides server and tube-level statistics:
## configuration
+Edit the `python.d/beanstalk.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/beanstalk.conf
+```
+
Sample:
```yaml
diff --git a/collectors/python.d.plugin/bind_rndc/README.md b/collectors/python.d.plugin/bind_rndc/README.md
index 021a5d660f..7b8badbe94 100644
--- a/collectors/python.d.plugin/bind_rndc/README.md
+++ b/collectors/python.d.plugin/bind_rndc/README.md
@@ -51,6 +51,14 @@ It produces:
## configuration
+Edit the `python.d/bind_rndc.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/bind_rndc.conf
+```
+
Sample:
```yaml
diff --git a/collectors/python.d.plugin/boinc/README.md b/collectors/python.d.plugin/boinc/README.md
index 260ae54b6c..1b68ae0cbc 100644
--- a/collectors/python.d.plugin/boinc/README.md
+++ b/collectors/python.d.plugin/boinc/README.md
@@ -9,6 +9,14 @@ as well as ones tracking each of the possible states for tasks.
## configuration
+Edit the `python.d/boinc.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/boinc.conf
+```
+
BOINC requires use of a password to access it's RPC interface. You can
find this password in the `gui_rpc_auth.cfg` file in your BOINC directory.
diff --git a/collectors/python.d.plugin/ceph/README.md b/collectors/python.d.plugin/ceph/README.md
index f5b36e1493..ae2cd489e0 100644
--- a/collectors/python.d.plugin/ceph/README.md
+++ b/collectors/python.d.plugin/ceph/README.md
@@ -23,6 +23,14 @@ It produces:
## Configuration
+Edit the `python.d/ceph.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/ceph.conf
+```
+
Sample:
```yaml
diff --git a/collectors/python.d.plugin/chrony/README.md b/collectors/python.d.plugin/chrony/README.md
index a45adb3338..8830da351c 100644
--- a/collectors/python.d.plugin/chrony/README.md
+++ b/collectors/python.d.plugin/chrony/README.md
@@ -18,6 +18,14 @@ Verify that user Netdata can execute `chronyc tracking`. If necessary, update `/
## Configuration
+Edit the `python.d/chrony.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different
+sudo ./edit-config python.d/chrony.conf
+```
+
Sample:
```yaml
diff --git a/collectors/python.d.plugin/couchdb/README.md b/collectors/python.d.plugin/couchdb/README.md
index 288970674f..c241b2aa83 100644
--- a/collectors/python.d.plugin/couchdb/README.md
+++ b/collectors/python.d.plugin/couchdb/README.md
@@ -13,6 +13,14 @@ This module monitors vital statistics of a local Apache CouchDB 2.x server, incl
## Configuration
+Edit the `python.d/couchdb.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/couchdb.conf
+```
+
Sample for a local server running on port 5984:
```yaml
diff --git a/collectors/python.d.plugin/dns_query_time/README.md b/collectors/python.d.plugin/dns_query_time/README.md
index ebf34a3d6e..b3575f1ae0 100644
--- a/collectors/python.d.plugin/dns_query_time/README.md
+++ b/collectors/python.d.plugin/dns_query_time/README.md
@@ -8,6 +8,16 @@ This module provides DNS query time statistics.
It produces one aggregate chart or one chart per DNS server, showing the query time.
+## Configuration
+
+Edit the `python.d/dns_query_time.conf` configuration file using `edit-config` from the your agent's [config
+directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata