Browse Source

Added collector config to relevant READMEs (#8052)

Joel Hans 5 years ago
parent
commit
8166f8bc2a

+ 9 - 2
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
 

+ 8 - 2
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)](<>)

+ 8 - 2
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:
 

+ 10 - 2
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

+ 8 - 2
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)](<>)

+ 10 - 2
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

+ 10 - 2
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)

+ 8 - 0
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:

+ 8 - 0
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:

+ 8 - 0
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

Some files were not shown because too many files changed in this diff