summaryrefslogtreecommitdiffstats
path: root/collectors
diff options
context:
space:
mode:
authorPatti Short <35278231+shortpatti@users.noreply.github.com>2020-02-13 11:25:04 -0800
committerGitHub <noreply@github.com>2020-02-13 11:25:04 -0800
commita7eb8b2555a345641a11eb6511e2ceeea18c1538 (patch)
treeae663adea50784e822bdda82b0b2d4608b194923 /collectors
parent52a4ec66142ecb824fe25db1570f5c97f5befe7a (diff)
updates for issue 8006 (#8074)
* updates for issue 8006 * removed unbound from python.d.plugin * incorporated suggested changes * incorporated more suggestions
Diffstat (limited to 'collectors')
-rw-r--r--collectors/charts.d.plugin/ap/README.md2
-rw-r--r--collectors/charts.d.plugin/apcupsd/README.md4
-rw-r--r--collectors/charts.d.plugin/libreswan/README.md4
-rw-r--r--collectors/charts.d.plugin/nut/README.md4
-rw-r--r--collectors/charts.d.plugin/opensips/README.md2
-rw-r--r--collectors/charts.d.plugin/sensors/README.md2
-rw-r--r--collectors/node.d.plugin/fronius/README.md4
-rw-r--r--collectors/node.d.plugin/named/README.md4
-rw-r--r--collectors/node.d.plugin/sma_webbox/README.md2
-rw-r--r--collectors/node.d.plugin/snmp/README.md4
-rw-r--r--collectors/node.d.plugin/stiebeleltron/README.md4
-rw-r--r--collectors/python.d.plugin/adaptec_raid/README.md32
-rw-r--r--collectors/python.d.plugin/am2320/README.md9
-rw-r--r--collectors/python.d.plugin/apache/README.md10
-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.md11
-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.md4
-rw-r--r--collectors/python.d.plugin/dns_query_time/README.md4
-rw-r--r--collectors/python.d.plugin/dnsdist/README.md6
-rw-r--r--collectors/python.d.plugin/dockerd/README.md6
-rw-r--r--collectors/python.d.plugin/dovecot/README.md6
-rw-r--r--collectors/python.d.plugin/elasticsearch/README.md6
-rw-r--r--collectors/python.d.plugin/energid/README.md8
-rw-r--r--collectors/python.d.plugin/example/README.md2
-rw-r--r--collectors/python.d.plugin/exim/README.md2
-rw-r--r--collectors/python.d.plugin/fail2ban/README.md8
-rw-r--r--collectors/python.d.plugin/freeradius/README.md4
-rw-r--r--collectors/python.d.plugin/gearman/README.md6
-rw-r--r--collectors/python.d.plugin/go_expvar/README.md11
-rw-r--r--collectors/python.d.plugin/haproxy/README.md4
-rw-r--r--collectors/python.d.plugin/hddtemp/README.md4
-rw-r--r--collectors/python.d.plugin/hpssa/README.md27
-rw-r--r--collectors/python.d.plugin/httpcheck/README.md6
-rw-r--r--collectors/python.d.plugin/icecast/README.md6
-rw-r--r--collectors/python.d.plugin/ipfs/README.md4
-rw-r--r--collectors/python.d.plugin/isc_dhcpd/README.md6
-rw-r--r--collectors/python.d.plugin/litespeed/README.md4
-rw-r--r--collectors/python.d.plugin/logind/README.md8
-rw-r--r--collectors/python.d.plugin/megacli/README.md31
-rw-r--r--collectors/python.d.plugin/memcached/README.md5
-rw-r--r--collectors/python.d.plugin/mongodb/README.md6
-rw-r--r--collectors/python.d.plugin/monit/README.md2
-rw-r--r--collectors/python.d.plugin/mysql/README.md6
-rw-r--r--collectors/python.d.plugin/nginx/README.md6
-rw-r--r--collectors/python.d.plugin/nginx_plus/README.md5
-rw-r--r--collectors/python.d.plugin/nsd/README.md6
-rw-r--r--collectors/python.d.plugin/ntpd/README.md6
-rw-r--r--collectors/python.d.plugin/nvidia_smi/README.md5
-rw-r--r--collectors/python.d.plugin/openldap/README.md4
-rw-r--r--collectors/python.d.plugin/oracledb/README.md6
-rw-r--r--collectors/python.d.plugin/ovpn_status_log/README.md6
-rw-r--r--collectors/python.d.plugin/phpfpm/README.md4
-rw-r--r--collectors/python.d.plugin/portcheck/README.md4
-rw-r--r--collectors/python.d.plugin/postfix/README.md6
-rw-r--r--collectors/python.d.plugin/postgres/README.md6
-rw-r--r--collectors/python.d.plugin/powerdns/README.md4
-rw-r--r--collectors/python.d.plugin/proxysql/README.md4
-rw-r--r--collectors/python.d.plugin/puppet/README.md2
-rw-r--r--collectors/python.d.plugin/rabbitmq/README.md5
-rw-r--r--collectors/python.d.plugin/redis/README.md4
-rw-r--r--collectors/python.d.plugin/rethinkdbs/README.md4
-rw-r--r--collectors/python.d.plugin/retroshare/README.md4
-rw-r--r--collectors/python.d.plugin/riakkv/README.md6
-rw-r--r--collectors/python.d.plugin/samba/README.md6
-rw-r--r--collectors/python.d.plugin/sensors/README.md6
-rw-r--r--collectors/python.d.plugin/smartd_log/README.md6
-rw-r--r--collectors/python.d.plugin/spigotmc/README.md4
-rw-r--r--collectors/python.d.plugin/springboot/README.md4
-rw-r--r--collectors/python.d.plugin/squid/README.md4
-rw-r--r--collectors/python.d.plugin/tomcat/README.md4
-rw-r--r--collectors/python.d.plugin/tor/README.md6
-rw-r--r--collectors/python.d.plugin/traefik/README.md4
-rw-r--r--collectors/python.d.plugin/uwsgi/README.md7
-rw-r--r--collectors/python.d.plugin/varnish/README.md5
-rw-r--r--collectors/python.d.plugin/w1sensor/README.md5
-rw-r--r--collectors/python.d.plugin/web_log/README.md10
79 files changed, 234 insertions, 256 deletions
diff --git a/collectors/charts.d.plugin/ap/README.md b/collectors/charts.d.plugin/ap/README.md
index 60c547237f..5f4835b8a6 100644
--- a/collectors/charts.d.plugin/ap/README.md
+++ b/collectors/charts.d.plugin/ap/README.md
@@ -1,4 +1,4 @@
-# Access Point Plugin (ap)
+# Access Point monitoring with Netdata
The `ap` collector visualizes data related to access points.
diff --git a/collectors/charts.d.plugin/apcupsd/README.md b/collectors/charts.d.plugin/apcupsd/README.md
index 2aff8b6e11..522daf874d 100644
--- a/collectors/charts.d.plugin/apcupsd/README.md
+++ b/collectors/charts.d.plugin/apcupsd/README.md
@@ -1,4 +1,6 @@
-# apcupsd
+# APC UPS monitoring with Netdata
+
+Monitors different APC UPS models and retrieves status information using `apcaccess` tool.
## Configuration
diff --git a/collectors/charts.d.plugin/libreswan/README.md b/collectors/charts.d.plugin/libreswan/README.md
index 372866c603..f69b4ee1cb 100644
--- a/collectors/charts.d.plugin/libreswan/README.md
+++ b/collectors/charts.d.plugin/libreswan/README.md
@@ -1,6 +1,6 @@
-# libreswan
+# Libreswan IPSec tunnel monitoring with Netdata
-The plugin will collects bytes-in, bytes-out and uptime for all established libreswan IPSEC tunnels.
+Collects bytes-in, bytes-out and uptime for all established libreswan IPSEC tunnels.
The following charts are created, **per tunnel**:
diff --git a/collectors/charts.d.plugin/nut/README.md b/collectors/charts.d.plugin/nut/README.md
index 04f2694933..001d504849 100644
--- a/collectors/charts.d.plugin/nut/README.md
+++ b/collectors/charts.d.plugin/nut/README.md
@@ -1,6 +1,6 @@
-# nut
+# UPS/PDU monitoring with Netdata
-The plugin will collect UPS data for all UPSes configured in the system.
+Collects UPS data for all power devices configured in the system.
The following charts will be created:
diff --git a/collectors/charts.d.plugin/opensips/README.md b/collectors/charts.d.plugin/opensips/README.md
index 20698f9b82..7b9262732d 100644
--- a/collectors/charts.d.plugin/opensips/README.md
+++ b/collectors/charts.d.plugin/opensips/README.md
@@ -1,4 +1,4 @@
-# OpenSIPS
+# OpenSIPS monitoring with Netdata
## Configuration
diff --git a/collectors/charts.d.plugin/sensors/README.md b/collectors/charts.d.plugin/sensors/README.md
index de7f908548..94d507a1d3 100644
--- a/collectors/charts.d.plugin/sensors/README.md
+++ b/collectors/charts.d.plugin/sensors/README.md
@@ -1,4 +1,4 @@
-# sensors
+# Linux machine sensors monitoring with Netdata
> THIS MODULE IS OBSOLETE.
> USE [THE PYTHON ONE](../../python.d.plugin/sensors) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
diff --git a/collectors/node.d.plugin/fronius/README.md b/collectors/node.d.plugin/fronius/README.md
index f109f79950..56b35d2b47 100644
--- a/collectors/node.d.plugin/fronius/README.md
+++ b/collectors/node.d.plugin/fronius/README.md
@@ -1,6 +1,6 @@
-# fronius
+# Fronius Symo monitoring with Netdata
-This module collects metrics from the configured solar power installation from Fronius Symo.
+Collects metrics from the configured solar power installation from Fronius Symo.
**Requirements**
diff --git a/collectors/node.d.plugin/named/README.md b/collectors/node.d.plugin/named/README.md
index 288292ba83..7969f54ac9 100644
--- a/collectors/node.d.plugin/named/README.md
+++ b/collectors/node.d.plugin/named/README.md
@@ -1,6 +1,6 @@
-# ISC Bind Statistics
+# ISC BIND monitoring with Netdata
-Using this Netdata collector, you can monitor one or more ISC Bind servers.
+Monitor one or more ISC Bind servers.
## Example Netdata charts
diff --git a/collectors/node.d.plugin/sma_webbox/README.md b/collectors/node.d.plugin/sma_webbox/README.md
index 2969756261..b805a58c2a 100644
--- a/collectors/node.d.plugin/sma_webbox/README.md
+++ b/collectors/node.d.plugin/sma_webbox/README.md
@@ -1,4 +1,4 @@
-# SMA Sunny Webbox
+# SMA Sunny WebBox monitoring with Netdata
[SMA Sunny Webbox](http://files.sma.de/dl/4253/WEBBOX-DUS131916W.pdf)
diff --git a/collectors/node.d.plugin/snmp/README.md b/collectors/node.d.plugin/snmp/README.md
index 53ac976c7b..30d686ee5a 100644
--- a/collectors/node.d.plugin/snmp/README.md
+++ b/collectors/node.d.plugin/snmp/README.md
@@ -1,6 +1,6 @@
-# SNMP Data Collector
+# SNMP device monitoring with Netdata
-Using this collector, Netdata can collect data from any SNMP device. This collector uses [net-snmp](https://github.com/markabrahams/node-net-snmp) module.
+Collects data from any SNMP device and uses the [net-snmp](https://github.com/markabrahams/node-net-snmp) module.
It supports:
diff --git a/collectors/node.d.plugin/stiebeleltron/README.md b/collectors/node.d.plugin/stiebeleltron/README.md
index 80adc86b9f..56a9155a91 100644
--- a/collectors/node.d.plugin/stiebeleltron/README.md
+++ b/collectors/node.d.plugin/stiebeleltron/README.md
@@ -1,6 +1,6 @@
-# stiebel eltron
+# Stiebel Eltron ISG monitoring with Netdata
-This module collects metrics from the configured heat pump and hot water installation from Stiebel Eltron ISG web.
+Collects metrics from the configured heat pump and hot water installation from Stiebel Eltron ISG web.
**Requirements**
diff --git a/collectors/python.d.plugin/adaptec_raid/README.md b/collectors/python.d.plugin/adaptec_raid/README.md
index 91663aead4..e687c41a38 100644
--- a/collectors/python.d.plugin/adaptec_raid/README.md
+++ b/collectors/python.d.plugin/adaptec_raid/README.md
@@ -1,12 +1,18 @@
-# adaptec raid
+# Adaptec RAID controller monitoring with Netdata
-Module collects logical and physical devices health metrics.
+Collects logical and physical devices metrics.
-**Requirements:**
+## Requirements
-- `arcconf` program
-- `sudo` program
-- `netdata` user needs to be able to sudo the `arcconf` program without password
+The module uses `arcconf`, which can only be executed by root. It uses
+`sudo` and assumes that it is configured such that the `netdata` user can
+execute `arcconf` as root without password.
+
+Add to `sudoers`:
+
+```
+netdata ALL=(root) NOPASSWD: /path/to/arcconf
+```
To grab stats it executes:
@@ -23,18 +29,6 @@ It produces:
4. **Physical Device Temperature**
-## prerequisite
-
-This module uses `arcconf` which can only be executed by root. It uses
-`sudo` and assumes that it is configured such that the `netdata` user can
-execute `arcconf` as root without password.
-
-Add to `sudoers`:
-
-```
-netdata ALL=(root) NOPASSWD: /path/to/arcconf
-```
-
## Configuration
**adaptec_raid** is disabled by default. Should be explicitly enabled in `python.d.conf`.
@@ -51,7 +45,7 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
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 516f54d932..03259963f3 100644
--- a/collectors/python.d.plugin/am2320/README.md
+++ b/collectors/python.d.plugin/am2320/README.md
@@ -1,7 +1,8 @@
-# AM2320
-This module will display a graph of the temperature and humity from a AM2320 sensor.
+# AM2320 sensor monitoring with netdata
-**Requirements:**
+Displays a graph of the temperature and humity from a AM2320 sensor.
+
+## Requirements
- Adafruit Circuit Python AM2320 library
- Adafruit AM2320 I2C sensor
- Python 3 (Adafruit libraries are not Python 2.x compatible)
@@ -11,7 +12,7 @@ It produces the following charts:
1. **Temperature**
2. **Humidity**
-## configuration
+## 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`.
diff --git a/collectors/python.d.plugin/apache/README.md b/collectors/python.d.plugin/apache/README.md
index 4201bfbe40..5a61965602 100644
--- a/collectors/python.d.plugin/apache/README.md
+++ b/collectors/python.d.plugin/apache/README.md
@@ -1,8 +1,8 @@
-# apache
+# Apache monitoring with Netdata
-This module will monitor one or more Apache servers depending on configuration.
+Monitors one or more Apache servers depending on configuration.
-**Requirements:**
+## Requirements
- apache with enabled `mod_status`
@@ -43,7 +43,7 @@ It produces the following charts:
- size_req
-## configuration
+## 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`.
@@ -55,7 +55,7 @@ sudo ./edit-config python.d/apache.conf
Needs only `url` to server's `server-status?auto`
-Here is an example for 2 servers:
+Example for two servers:
```yaml
update_every : 10
diff --git a/collectors/python.d.plugin/beanstalk/README.md b/collectors/python.d.plugin/beanstalk/README.md
index c294ac0589..820b11c8c2 100644
--- a/collectors/python.d.plugin/beanstalk/README.md
+++ b/collectors/python.d.plugin/beanstalk/README.md
@@ -1,8 +1,8 @@
-# beanstalk
+# Beanstalk monitoring with Netdata
-Module provides server and tube-level statistics:
+Provides server and tube-level statistics.
-**Requirements:**
+## Requirements
- `python-beanstalkc`
@@ -103,7 +103,7 @@ Module provides server and tube-level statistics:
- since
- left
-## configuration
+## 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`.
diff --git a/collectors/python.d.plugin/bind_rndc/README.md b/collectors/python.d.plugin/bind_rndc/README.md
index 7b8badbe94..69ea5499f2 100644
--- a/collectors/python.d.plugin/bind_rndc/README.md
+++ b/collectors/python.d.plugin/bind_rndc/README.md
@@ -1,8 +1,8 @@
-# bind_rndc
+# ISC Bind monitoring with Netdata
-Module parses bind dump file to collect real-time performance metrics
+Collects Name server summary performance statistics using `rndc` tool.
-**Requirements:**
+## Requirements
- Version of bind must be 9.6 +
- Netdata must have permis