@cryptotaxi247 / netdata-1 / commits / a7eb8b255

updates for issue 8006 (#8074)

* updates for issue 8006 * removed unbound from python.d.plugin * incorporated suggested changes * incorporated more suggestions

Patti Short committed Feb 13, 2020 at 11:25 UTC a7eb8b2555a345641a11eb6511e2ceeea18c1538
79 files changed +234 -256
collectors/charts.d.plugin/ap/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# Access Point Plugin (ap)
1 +# Access Point monitoring with Netdata
2
3 The `ap` collector visualizes data related to access points.
4
collectors/charts.d.plugin/apcupsd/README.md
+3 -1
@@ -1,4 +1,6 @@
1 -# apcupsd
1 +# APC UPS monitoring with Netdata
2 +
3 +Monitors different APC UPS models and retrieves status information using `apcaccess` tool.
4
5 ## Configuration
6
collectors/charts.d.plugin/libreswan/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# libreswan
1 +# Libreswan IPSec tunnel monitoring with Netdata
2
3 -The plugin will collects bytes-in, bytes-out and uptime for all established libreswan IPSEC tunnels.
3 +Collects bytes-in, bytes-out and uptime for all established libreswan IPSEC tunnels.
4
5 The following charts are created, **per tunnel**:
6
collectors/charts.d.plugin/nut/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# nut
1 +# UPS/PDU monitoring with Netdata
2
3 -The plugin will collect UPS data for all UPSes configured in the system.
3 +Collects UPS data for all power devices configured in the system.
4
5 The following charts will be created:
6
collectors/charts.d.plugin/opensips/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# OpenSIPS
1 +# OpenSIPS monitoring with Netdata
2
3 ## Configuration
4
collectors/charts.d.plugin/sensors/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# sensors
1 +# Linux machine sensors monitoring with Netdata
2
3 > THIS MODULE IS OBSOLETE.
4 > USE [THE PYTHON ONE](../../python.d.plugin/sensors) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
collectors/node.d.plugin/fronius/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# fronius
1 +# Fronius Symo monitoring with Netdata
2
3 -This module collects metrics from the configured solar power installation from Fronius Symo.
3 +Collects metrics from the configured solar power installation from Fronius Symo.
4
5 **Requirements**
6
collectors/node.d.plugin/named/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# ISC Bind Statistics
1 +# ISC BIND monitoring with Netdata
2
3 -Using this Netdata collector, you can monitor one or more ISC Bind servers.
3 +Monitor one or more ISC Bind servers.
4
5 ## Example Netdata charts
6
collectors/node.d.plugin/sma_webbox/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# SMA Sunny Webbox
1 +# SMA Sunny WebBox monitoring with Netdata
2
3 [SMA Sunny Webbox](http://files.sma.de/dl/4253/WEBBOX-DUS131916W.pdf)
4
collectors/node.d.plugin/snmp/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# SNMP Data Collector
1 +# SNMP device monitoring with Netdata
2
3 -Using this collector, Netdata can collect data from any SNMP device. This collector uses [net-snmp](https://github.com/markabrahams/node-net-snmp) module.
3 +Collects data from any SNMP device and uses the [net-snmp](https://github.com/markabrahams/node-net-snmp) module.
4
5 It supports:
6
collectors/node.d.plugin/stiebeleltron/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# stiebel eltron
1 +# Stiebel Eltron ISG monitoring with Netdata
2
3 -This module collects metrics from the configured heat pump and hot water installation from Stiebel Eltron ISG web.
3 +Collects metrics from the configured heat pump and hot water installation from Stiebel Eltron ISG web.
4
5 **Requirements**
6
collectors/python.d.plugin/adaptec_raid/README.md
+13 -19
@@ -1,12 +1,18 @@
1 -# adaptec raid
1 +# Adaptec RAID controller monitoring with Netdata
2
3 -Module collects logical and physical devices health metrics.
3 +Collects logical and physical devices metrics.
4
5 -**Requirements:**
5 +## Requirements
6
7 -- `arcconf` program
8 -- `sudo` program
9 -- `netdata` user needs to be able to sudo the `arcconf` program without password
7 +The module uses `arcconf`, which can only be executed by root. It uses
8 +`sudo` and assumes that it is configured such that the `netdata` user can
9 +execute `arcconf` as root without password.
10 +
11 +Add to `sudoers`:
12 +
13 +```
14 +netdata ALL=(root) NOPASSWD: /path/to/arcconf
15 +```
16
17 To grab stats it executes:
18
@@ -23,18 +29,6 @@ It produces:
29
30 4. **Physical Device Temperature**
31
26 -## prerequisite
27 -
28 -This module uses `arcconf` which can only be executed by root. It uses
29 -`sudo` and assumes that it is configured such that the `netdata` user can
30 -execute `arcconf` as root without password.
31 -
32 -Add to `sudoers`:
33 -
34 -```
35 -netdata ALL=(root) NOPASSWD: /path/to/arcconf
36 -```
37 -
32 ## Configuration
33
34 **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
45 sudo ./edit-config python.d/adaptec_raid.conf
46 ```
47
54 -### Screenshot:
48 +
49
50 ![image](https://user-images.githubusercontent.com/22274335/47278133-6d306680-d601-11e8-87c2-cc9c0f42d686.png)
51
collectors/python.d.plugin/am2320/README.md
+5 -4
@@ -1,7 +1,8 @@
1 -# AM2320
2 -This module will display a graph of the temperature and humity from a AM2320 sensor.
1 +# AM2320 sensor monitoring with netdata
2
4 -**Requirements:**
3 +Displays a graph of the temperature and humity from a AM2320 sensor.
4 +
5 +## Requirements
6 - Adafruit Circuit Python AM2320 library
7 - Adafruit AM2320 I2C sensor
8 - Python 3 (Adafruit libraries are not Python 2.x compatible)
@@ -11,7 +12,7 @@ It produces the following charts:
12 1. **Temperature**
13 2. **Humidity**
14
14 -## configuration
15 +## Configuration
16
17 Edit the `python.d/am2320.conf` configuration file using `edit-config` from the your agent's [config
18 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/apache/README.md
+5 -5
@@ -1,8 +1,8 @@
1 -# apache
1 +# Apache monitoring with Netdata
2
3 -This module will monitor one or more Apache servers depending on configuration.
3 +Monitors one or more Apache servers depending on configuration.
4
5 -**Requirements:**
5 +## Requirements
6
7 - apache with enabled `mod_status`
8
@@ -43,7 +43,7 @@ It produces the following charts:
43
44 - size_req
45
46 -## configuration
46 +## Configuration
47
48 Edit the `python.d/apache.conf` configuration file using `edit-config` from the your agent's [config
49 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
55
56 Needs only `url` to server's `server-status?auto`
57
58 -Here is an example for 2 servers:
58 +Example for two servers:
59
60 ```yaml
61 update_every : 10
collectors/python.d.plugin/beanstalk/README.md
+4 -4
@@ -1,8 +1,8 @@
1 -# beanstalk
1 +# Beanstalk monitoring with Netdata
2
3 -Module provides server and tube-level statistics:
3 +Provides server and tube-level statistics.
4
5 -**Requirements:**
5 +## Requirements
6
7 - `python-beanstalkc`
8
@@ -103,7 +103,7 @@ Module provides server and tube-level statistics:
103 - since
104 - left
105
106 -## configuration
106 +## Configuration
107
108 Edit the `python.d/beanstalk.conf` configuration file using `edit-config` from the your agent's [config
109 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/bind_rndc/README.md
+4 -4
@@ -1,8 +1,8 @@
1 -# bind_rndc
1 +# ISC Bind monitoring with Netdata
2
3 -Module parses bind dump file to collect real-time performance metrics
3 +Collects Name server summary performance statistics using `rndc` tool.
4
5 -**Requirements:**
5 +## Requirements
6
7 - Version of bind must be 9.6 +
8 - Netdata must have permissions to run `rndc stats`
@@ -49,7 +49,7 @@ It produces:
49
50 - Same as Incoming queries
51
52 -## configuration
52 +## Configuration
53
54 Edit the `python.d/bind_rndc.conf` configuration file using `edit-config` from the your agent's [config
55 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/boinc/README.md
+4 -7
@@ -1,13 +1,10 @@
1 -# boinc
1 +# BOINC monitoring with Netdata
2
3 -This module monitors task counts for the Berkely Open Infrastructure
4 -Networking Computing (BOINC) distributed computing client using the same
5 -RPC interface that the BOINC monitoring GUI does.
3 +Monitors task counts for the Berkely Open Infrastructure Networking Computing (BOINC) distributed computing client using the same RPC interface that the BOINC monitoring GUI does.
4
7 -It provides charts tracking the total number of tasks and active tasks,
8 -as well as ones tracking each of the possible states for tasks.
5 +It provides charts tracking the total number of tasks and active tasks, as well as ones tracking each of the possible states for tasks.
6
10 -## configuration
7 +## Configuration
8
9 Edit the `python.d/boinc.conf` configuration file using `edit-config` from the your agent's [config
10 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/ceph/README.md
+3 -5
@@ -1,8 +1,6 @@
1 -# ceph
1 +# CEPH monitoring with Netdata
2
3 -This module monitors the ceph cluster usage and consumption data of a server.
4 -
5 -It produces:
3 +Monitors the ceph cluster usage and consumption data of a server, and produces:
4
5 - Cluster statistics (usage, available, latency, objects, read/write rate)
6 - OSD usage
@@ -12,7 +10,7 @@ It produces:
10 - Pool read/write rate
11 - number of objects per pool
12
15 -**Requirements:**
13 +## Requirements
14
15 - `rados` python module
16 - Granting read permissions to ceph group from keyring file
collectors/python.d.plugin/chrony/README.md
+3 -5
@@ -1,8 +1,6 @@
1 -# chrony
1 +# Chrony monitoring with Netdata
2
3 -This module monitors the precision and statistics of a local chronyd server.
4 -
5 -It produces:
3 +Monitors the precision and statistics of a local chronyd server, and produces:
4
5 - frequency
6 - last offset
@@ -13,7 +11,7 @@ It produces:
11 - skew
12 - system time
13
16 -**Requirements:**
14 +## Requirements
15 Verify that user Netdata can execute `chronyc tracking`. If necessary, update `/etc/chrony.conf`, `cmdallow`.
16
17 ## Configuration
collectors/python.d.plugin/couchdb/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# couchdb
1 +# Apache CouchDB monitoring with Netdata
2
3 -This module monitors vital statistics of a local Apache CouchDB 2.x server, including:
3 +Monitors vital statistics of a local Apache CouchDB 2.x server, including:
4
5 - Overall server reads/writes
6 - HTTP traffic breakdown
collectors/python.d.plugin/dns_query_time/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# dns_query_time
1 +# DNS query RTT monitoring with Netdata
2
3 -This module provides DNS query time statistics.
3 +Measures DNS query round trip time.
4
5 **Requirement:**
6
collectors/python.d.plugin/dnsdist/README.md
+2 -4
@@ -1,8 +1,6 @@
1 -# dnsdist
1 +# PowerDNS dnsdist monitoring with Netdata
2
3 -This module monitors dnsdist performance and health metrics.
4 -
5 -The module draws the following charts:
3 +Collects load-balancer performance and health metrics, and draws the following charts:
4
5 1. **Response latency**
6
collectors/python.d.plugin/dockerd/README.md
+3 -3
@@ -1,6 +1,6 @@
1 -# dockerd
1 +# Docker engine monitoring with Netdata
2
3 -Module monitor docker health metrics.
3 +Collects docker container health metrics.
4
5 **Requirement:**
6
@@ -20,7 +20,7 @@ Following charts are drawn:
20
21 - count
22
23 -## configuration
23 +## Configuration
24
25 Edit the `python.d/dockerd.conf` configuration file using `edit-config` from the your agent's [config
26 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/dovecot/README.md
+3 -3
@@ -1,6 +1,6 @@
1 -# dovecot
1 +# Dovecot monitoring with Netdata
2
3 -This module provides statistics information from Dovecot server.
3 +Provides statistics information from Dovecot server.
4
5 Statistics are taken from dovecot socket by executing `EXPORT global` command.
6 More information about dovecot stats can be found on [project wiki page.](http://wiki2.dovecot.org/Statistics)
@@ -69,7 +69,7 @@ Module gives information with following charts:
69 - hit
70 - miss
71
72 -## configuration
72 +## Configuration
73
74 Edit the `python.d/dovecot.conf` configuration file using `edit-config` from the your agent's [config
75 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/elasticsearch/README.md
+3 -3
@@ -1,6 +1,6 @@
1 -# elasticsearch
1 +# Elasticsearch monitoring with Netdata
2
3 -This module monitors [Elasticsearch](https://www.elastic.co/products/elasticsearch) performance and health metrics.
3 +Monitors [Elasticsearch](https://www.elastic.co/products/elasticsearch) performance and health metrics.
4
5 It produces:
6
@@ -58,7 +58,7 @@ It produces:
58 - Num of replicas
59 - Health status
60
61 -## configuration
61 +## Configuration
62
63 Edit the `python.d/elasticsearch.conf` configuration file using `edit-config` from the your agent's [config
64 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/energid/README.md
+4 -4
@@ -1,9 +1,9 @@
1 -# energid
1 +# Energi Core node monitoring with Netdata
2
3 -A collector for [Energi Core](https://github.com/energicryptocurrency/energi)
4 -node instance monitoring.
3 +Monitors blockchain, memory, network and unspent transactions statistics.
4
6 -As Energi Core Gen 1 & 2 are based on the original Bitcoin code and
5 +
6 +As [Energi Core](https://github.com/energicryptocurrency/energi) Gen 1 & 2 are based on the original Bitcoin code and
7 supports very similar JSON RPC, there is quite high chance the module works
8 with many others forks including bitcoind itself.
9
collectors/python.d.plugin/example/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# example
1 +# Example
2
3 An example python data collection module.
4 You can use this example to help you [write a new Python module](../#how-to-write-a-new-module).
collectors/python.d.plugin/exim/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# exim
1 +# Exim monitoring with Netdata
2
3 Simple module executing `exim -bpc` to grab exim queue.
4 This command can take a lot of time to finish its execution thus it is not recommended to run it every second.
collectors/python.d.plugin/fail2ban/README.md
+4 -4
@@ -1,14 +1,14 @@
1 -# fail2ban
1 +# Fail2ban monitoring with Netdata
2
3 -Module monitor fail2ban log file to show all bans for all active jails
3 +Monitors the fail2ban log file to show all bans for all active jails.
4
5 -**Requirements:**
5 +## Requirements
6
7 - fail2ban.log file MUST BE readable by Netdata (A good idea is to add **create 0640 root netdata** to fail2ban conf at logrotate.d)
8
9 It produces one chart with multiple lines (one line per jail)
10
11 -## configuration
11 +## Configuration
12
13 Edit the `python.d/fail2ban.conf` configuration file using `edit-config` from the your agent's [config
14 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/freeradius/README.md
+2 -2
@@ -1,4 +1,4 @@
1 -# freeradius
1 +# FreeRADIUS monitoring with Netdata
2
3 Uses the `radclient` command to provide freeradius statistics. It is not recommended to run it every second.
4
@@ -44,7 +44,7 @@ It produces:
44 - proxy-acct-malformed-requests
45 - proxy-acct-unknown-typesa
46
47 -## configuration
47 +## Configuration
48
49 Edit the `python.d/freeradius.conf` configuration file using `edit-config` from the your agent's [config
50 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/gearman/README.md
+2 -4
@@ -1,8 +1,6 @@
1 -# Gearman
1 +# Gearman monitoring with Netdata
2
3 -Module monitors Gearman worker statistics. A chart
4 -is shown for each job as well as one showing a summary
5 -of all workers.
3 +Monitors Gearman worker statistics. A chart is shown for each job as well as one showing a summary of all workers.
4
5 Note: Charts may show as a line graph rather than an area
6 graph if you load Netdata with no jobs running. To change
collectors/python.d.plugin/go_expvar/README.md
+4 -7
@@ -1,11 +1,8 @@
1 -# go_expvar
1 +# Go application monitoring with Netdata
2
3 -The `go_expvar` module can monitor any Go application that exposes its metrics with the use of
4 -`expvar` package from the Go standard library.
3 +Monitors Go application that exposes its metrics with the use of `expvar` package from the Go standard library. The package produces charts for Go runtime memory statistics and optionally any number of custom charts.
4
6 -`go_expvar` produces charts for Go runtime memory statistics and optionally any number of custom charts.
7 -
8 -For the memory statistics, it produces the following charts:
5 +The `go_expvar` module produces the following charts:
6
7 1. **Heap allocations** in kB
8
@@ -36,7 +33,7 @@ For the memory statistics, it produces the following charts:
33
34 - avg: average duration of all GC stop-the-world pauses
35
39 -## Monitoring Go Applications
36 +## Monitoring Go applications
37
38 Netdata can be used to monitor running Go applications that expose their metrics with
39 the use of the [expvar package](https://golang.org/pkg/expvar/) included in Go standard library.
collectors/python.d.plugin/haproxy/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# haproxy
1 +# HAProxy monitoring with Netdata
2
3 -Module monitors frontend and backend metrics such as bytes in, bytes out, sessions current, sessions in queue current.
3 +Monitors frontend and backend metrics such as bytes in, bytes out, sessions current, sessions in queue current.
4 And health metrics such as backend servers status (server check should be used).
5
6 Plugin can obtain data from url **OR** unix socket.
collectors/python.d.plugin/hddtemp/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# hddtemp
1 +# Hard drive temperature monitoring with Netdata
2
3 -Module monitors disk temperatures from one or more hddtemp daemons.
3 +Monitors disk temperatures from one or more `hddtemp` daemons.
4
5 **Requirement:**
6 Running `hddtemp` in daemonized mode with access on tcp port
collectors/python.d.plugin/hpssa/README.md
+11 -16
@@ -1,12 +1,18 @@
1 -# hpssa
1 +# HP Smart Storage Arrays monitoring with Netdata
2
3 -This module collects controller, logical, and physical device health metrics from HP Smart Storage Arrays.
3 +Monitors controller, cache module, logical and physical drive state and temperature using `ssacli` tool.
4
5 ## Requirements:
6
7 -- `ssacli` program
8 -- `sudo` program
9 -- `netdata` user needs to be able to sudo the `ssacli` program without password
7 +This module uses `ssacli`, which can only be executed by root. It uses
8 +`sudo` and assumes that it is configured such that the `netdata` user can
9 +execute `ssacli` as root without password.
10 +
11 +Add to `sudoers`:
12 +
13 +```
14 +netdata ALL=(root) NOPASSWD: /path/to/ssacli
15 +```
16
17 To collect metrics, the module executes: `sudo -n ssacli ctrl all show config detail`
18
@@ -17,17 +23,6 @@ This module produces:
23 3. Logical drive state
24 4. Physical drive state and temperature
25
20 -## Prerequisite
21 -
22 -This module uses `ssacli`, which can only be executed by root. It uses
23 -`sudo` and assumes that it is configured such that the `netdata` user can
24 -execute `ssacli` as root without password.
25 -
26 -Add to `sudoers`:
27 -
28 -```
29 -netdata ALL=(root) NOPASSWD: /path/to/ssacli
30 -```
26
27 ## Configuration
28
collectors/python.d.plugin/httpcheck/README.md
+3 -3
@@ -1,6 +1,6 @@
1 -# httpcheck
1 +# HTTP endpoint monitoring with Netdata
2
3 -Module monitors remote http server for availability and response time.
3 +Monitors remote http server for availability and response time.
4
5 Following charts are drawn per job:
6
@@ -40,7 +40,7 @@ server:
40 redirect: yes # optional
41 ```
42
43 -### notes
43 +### Notes
44
45 - The status chart is primarily intended for alarms, badges or for access via API.
46 - A system/service/firewall might block Netdata's access if a portscan or
collectors/python.d.plugin/icecast/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# icecast
1 +# Icecast monitoring with Netdata
2
3 -This module will monitor number of listeners for active sources.
3 +Monitors the number of listeners for active sources.
4
5 -**Requirements:**
5 +## Requirements
6
7 - icecast version >= 2.4.0
8
collectors/python.d.plugin/ipfs/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# ipfs
1 +# IPFS monitoring with Netdata
2
3 -Module monitors [IPFS](https://ipfs.io) basic information.
3 +Collects [IPFS](https://ipfs.io) basic information like file system bandwidth, peers and repo metrics.
4
5 1. **Bandwidth** in kbits/s
6
collectors/python.d.plugin/isc_dhcpd/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# isc_dhcpd
1 +# ISC DHCP monitoring with Netdata
2
3 -Module monitor leases database to show all active leases for given pools.
3 +Monitors the leases database to show all active leases for given pools.
4
5 -**Requirements:**
5 +## Requirements
6
7 - dhcpd leases file MUST BE readable by Netdata
8 - pools MUST BE in CIDR format
collectors/python.d.plugin/litespeed/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# litespeed
1 +# LiteSpeed monitoring with Netdata
2
3 -Module monitor litespeed web server performance metrics.
3 +Collects web server performance metrics for network, connection, requests, and cache.
4
5 It produces:
6
collectors/python.d.plugin/logind/README.md
+4 -4
@@ -1,6 +1,6 @@
1 -# logind
1 +# Systemd-Logind monitoring with Netdata
2
3 -This module monitors active sessions, users, and seats tracked by systemd-logind or elogind.
3 +Monitors active sessions, users, and seats tracked by `systemd-logind` or `elogind`.
4
5 It provides the following charts:
6
@@ -20,7 +20,7 @@ It provides the following charts:
20
21 - Seats
22
23 -## configuration
23 +## Configuration
24
25 This module needs no configuration. Just make sure the `netdata` user
26 can run the `loginctl` command and get a session list without having to
@@ -43,7 +43,7 @@ cd /etc/netdata # Replace this path with your Netdata config directory, if dif
43 sudo ./edit-config python.d/logind.conf
44 ```
45
46 -## notes
46 +## Notes
47
48 - This module's ability to track logins is dependent on what PAM services
49 are configured to register sessions with logind. In particular, for
collectors/python.d.plugin/megacli/README.md
+14 -17
@@ -1,12 +1,19 @@
1 -# megacli
1 +# MegaRAID controller monitoring with Netdata
2
3 -Module collects adapter, physical drives and battery stats.
3 +Collects adapter, physical drives and battery stats.
4
5 -**Requirements:**
5 +## Requirements
6 +
7 +Uses the `megacli` program, which can only be executed by root. It uses
8 +`sudo` and assumes that it is configured such that the `netdata` user can
9 +execute `megacli` as root without password.
10 +
11 +Add to `sudoers`:
12 +
13 +```
14 +netdata ALL=(root) NOPASSWD: /path/to/megacli
15 +```
16
7 -- `megacli` program
8 -- `sudo` program
9 -- `netdata` user needs to be able to be able to sudo the `megacli` program without password
17
18 To grab stats it executes:
19
@@ -25,19 +32,9 @@ It produces:
32
33 5. **Battery Cycle Count**
34
28 -## prerequisite
35
30 -This module uses `megacli` which can only be executed by root. It uses
31 -`sudo` and assumes that it is configured such that the `netdata` user can
32 -execute `megacli` as root without password.
33 -
34 -Add to `sudoers`:
35 -
36 -```
37 -netdata ALL=(root) NOPASSWD: /path/to/megacli
38 -```
36
40 -### Configuration
37 +## Configuration
38
39 **megacli** is disabled by default. Should be explicitly enabled in `python.d.conf`.
40
collectors/python.d.plugin/memcached/README.md
+3 -2
@@ -1,6 +1,7 @@
1 -# memcached
1 +# Memcached monitoring with Netdata
2 +
3 +Collects memory-caching system performance metrics. It reads server response to stats command ([stats interface](https://github.com/memcached/memcached/wiki/Commands#stats)).
4
3 -Memcached monitoring module. Data grabbed from [stats interface](https://github.com/memcached/memcached/wiki/Commands#stats).
5
6 1. **Network** in kilobytes/s
7
collectors/python.d.plugin/mongodb/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# mongodb
1 +# MongoDB monitoring with Netdata
2
3 -Module monitor mongodb performance and health metrics
3 +Monitors performance and health metrics of MongoDB.
4
5 -**Requirements:**
5 +## Requirements
6
7 - `python-pymongo` package v2.4+.
8
collectors/python.d.plugin/monit/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# monit
1 +# Monit monitoring with Netdata
2
3 Monit monitoring module. Data is grabbed from stats XML interface (exists for a long time, but not mentioned in official documentation). Mostly this plugin shows statuses of monit targets, i.e. [statuses of specified checks](https://mmonit.com/monit/documentation/monit.html#Service-checks).
4
collectors/python.d.plugin/mysql/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# mysql
1 +# MySQL monitoring with Netdata
2
3 -Module monitors one or more mysql servers
3 +Monitors one or more MySQL servers.
4
5 -**Requirements:**
5 +## Requirements
6
7 - python library [MySQLdb](https://github.com/PyMySQL/mysqlclient-python) (faster) or [PyMySQL](https://github.com/PyMySQL/PyMySQL) (slower)
8 - `netdata` local user to connect to the MySQL server.
collectors/python.d.plugin/nginx/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# nginx
1 +# NGINX monitoring with Netdata
2
3 -This module will monitor one or more nginx servers depending on configuration. Servers can be either local or remote.
3 +Monitors one or more NGINX servers depending on configuration. Servers can be either local or remote.
4
5 -**Requirements:**
5 +## Requirements
6
7 - nginx with configured 'ngx_http_stub_status_module'
8 - 'location /stub_status'
collectors/python.d.plugin/nginx_plus/README.md
+2 -3
@@ -1,7 +1,6 @@
1 -# nginx_plus
1 +# NGINX Plus monitoring with Netdata
2
3 -This module will monitor one or more nginx_plus servers depending on configuration.
4 -Servers can be either local or remote.
3 +Monitors one or more NGINX Plus servers depending on configuration. Servers can be either local or remote.
4
5 Example nginx_plus configuration can be found in 'python.d/nginx_plus.conf'
6
collectors/python.d.plugin/nsd/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# nsd
1 +# NSD monitoring with Netdata
2
3 -Module uses the `nsd-control stats_noreset` command to provide `nsd` statistics.
3 +Uses the `nsd-control stats_noreset` command to provide `nsd` statistics.
4
5 -**Requirements:**
5 +## Requirements
6
7 - Version of `nsd` must be 4.0+
8 - Netdata must have permissions to run `nsd-control stats_noreset`
collectors/python.d.plugin/ntpd/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# ntpd
1 +# NTP daemon monitoring with Netdata
2
3 -Module monitors the system variables of the local `ntpd` daemon (optional incl. variables of the polled peers) using the NTP Control Message Protocol via UDP socket, similar to `ntpq`, the [standard NTP query program](http://doc.ntp.org/current-stable/ntpq.html).
3 +Monitors the system variables of the local `ntpd` daemon (optional incl. variables of the polled peers) using the NTP Control Message Protocol via UDP socket, similar to `ntpq`, the [standard NTP query program](http://doc.ntp.org/current-stable/ntpq.html).
4
5 -**Requirements:**
5 +## Requirements
6
7 - Version: `NTPv4`
8 - Local interrogation allowed in `/etc/ntp.conf` (default):
collectors/python.d.plugin/nvidia_smi/README.md
+3 -2
@@ -1,6 +1,7 @@
1 -# nvidia_smi
1 +# NVIDIA GPU monitoring with Netdata
2 +
3 +Monitors performance metrics (memory usage, fan speed, pcie bandwidth utilization, temperature, etc.) using `nvidia-smi` cli tool.
4
3 -This module monitors the `nvidia-smi` cli tool.
5
6 **Requirements and Notes:**
7
collectors/python.d.plugin/openldap/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# openldap
1 +# OpenLDAP monitoring with Netdata
2
3 -This module provides statistics information from openldap (slapd) server.
3 +Provides statistics information from openldap (slapd) server.
4 Statistics are taken from LDAP monitoring interface. Manual page, slapd-monitor(5) is available.
5
6 **Requirement:**
collectors/python.d.plugin/oracledb/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# oracledb
1 +# OracleDB monitoring with Netdata
2
3 -Module monitor oracledb performance and health metrics.
3 +Monitors the performance and health metrics of the Oracle database.
4
5 -**Requirements:**
5 +## Requirements
6
7 - `cx_Oracle` package.
8 - Oracle Client (using `cx_Oracle` requires Oracle Client libraries to be installed).
collectors/python.d.plugin/ovpn_status_log/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# ovpn_status_log
1 +# OpenVPN monitoring with Netdata
2
3 -Module monitor openvpn-status log file.
3 +Parses server log files and provides summary (client, traffic) metrics.
4
5 -**Requirements:**
5 +## Requirements
6
7 - If you are running multiple OpenVPN instances out of the same directory, MAKE SURE TO EDIT DIRECTIVES which create output files
8 so that multiple instances do not overwrite each other's output files.
collectors/python.d.plugin/phpfpm/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# phpfpm
1 +# PHP-FPM monitoring with Netdata
2
3 -This module will monitor one or more [`PHP-FPM`](https://php-fpm.org/) instances, depending on your configuration.
3 +Monitors one or more PHP-FPM instances depending on configuration.
4
5 ## Requirements
6
collectors/python.d.plugin/portcheck/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# portcheck
1 +# TCP endpoint monitoring with Netdata
2
3 -Module monitors a remote TCP service.
3 +Monitors TCP endpoint availability and response time.
4
5 Following charts are drawn per host:
6
collectors/python.d.plugin/postfix/README.md
+4 -2
@@ -1,6 +1,8 @@
1 -# postfix
1 +# Postfix monitoring with Netdata
2
3 -Simple module executing `postfix -p` to grab postfix queue.
3 +Monitors MTA email queue statistics using postqueue tool.
4 +
5 +Execute `postfix -p` to grab postfix queue.
6
7 It produces only two charts:
8
collectors/python.d.plugin/postgres/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# postgres
1 +# PostgreSQL monitoring with Netdata
2
3 -Module monitors one or more postgres servers.
3 +Collects database health and performance metrics.
4
5 -**Requirements:**
5 +## Requirements
6
7 - `python-psycopg2` package. You have to install it manually.
8
collectors/python.d.plugin/powerdns/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# powerdns
1 +# PowerDNS monitoring with Netdata
2
3 -Module monitor powerdns performance and health metrics.
3 +Monitors authoritative server and recursor statistics.
4
5 Powerdns charts:
6
collectors/python.d.plugin/proxysql/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# proxysql
1 +# ProxySQL monitoring with Netdata
2
3 -This module monitors proxysql backend and frontend performance metrics.
3 +Monitors database backend and frontend performance metrics.
4
5 It produces:
6
collectors/python.d.plugin/puppet/README.md
+1 -1
@@ -1,4 +1,4 @@
1 -# puppet
1 +# Puppet monitoring with Netdata
2
3 Monitor status of Puppet Server and Puppet DB.
4
collectors/python.d.plugin/rabbitmq/README.md
+3 -2
@@ -1,6 +1,7 @@
1 -# rabbitmq
1 +# RabbitMQ monitoring with Netdata
2 +
3 +Collects message broker global and per virtual host metrics.
4
3 -This module monitors [RabbitMQ](https://www.rabbitmq.com/) performance and health metrics.
5
6 Following charts are drawn:
7
collectors/python.d.plugin/redis/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# redis
1 +# Redis monitoring with Netdata
2
3 -Get INFO data from redis instance.
3 +Monitors database status. It reads server response to `INFO` command.
4
5 Following charts are drawn:
6
collectors/python.d.plugin/rethinkdbs/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# rethinkdbs
1 +# RethinkDB monitoring with Netdata
2
3 -Module monitor rethinkdb health metrics.
3 +Collects database server and cluster statistics.
4
5 Following charts are drawn:
6
collectors/python.d.plugin/retroshare/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# retroshare
1 +# RetroShare monitoring with Netdata
2
3 -[RetroShare](https://retroshare.cc/) is a free and open-source peer-to-peer communication and file sharing app based on a friend-to-friend network.
3 +Monitors application bandwidth, peers and DHT metrics.
4
5 This module will monitor one or more `RetroShare` applications, depending on your configuration.
6
collectors/python.d.plugin/riakkv/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# riakkv
1 +# RiakKV monitoring with Netdata
2
3 -Monitors one or more Riak KV servers.
3 +Collects database stats from `/stats` endpoint.
4
5 -**Requirements:**
5 +## Requirements
6
7 - An accessible `/stats` endpoint. See [the Riak KV configuration reference documentation](https://docs.riak.com/riak/kv/2.2.3/configuring/reference/#client-interfaces)
8 for how to enable this.
collectors/python.d.plugin/samba/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# samba
1 +# Samba monitoring with Netdata
2
3 -Performance metrics of Samba file sharing.
3 +Monitors the performance metrics of Samba file sharing.
4
5 -**Requirements:**
5 +## Requirements
6
7 - `smbstatus` program
8 - `sudo` program
collectors/python.d.plugin/sensors/README.md
+3 -3
@@ -1,10 +1,10 @@
1 -# sensors
1 +# Linux machines sensors monitoring with Netdata
2
3 -System sensors information.
3 +Reads system sensors information (temperature, voltage, electric current, power, etc.).
4
5 Charts are created dynamically.
6
7 -## configuration
7 +## Configuration
8
9 Edit the `python.d/sensors.conf` configuration file using `edit-config` from the your agent's [config
10 directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
collectors/python.d.plugin/smartd_log/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# smartd_log
1 +# Storage devices monitoring with Netdata
2
3 -Module monitor `smartd` log files to collect HDD/SSD S.M.A.R.T attributes.
3 +Monitors `smartd` log files to collect HDD/SSD S.M.A.R.T attributes.
4
5 -**Requirements:**
5 +## Requirements
6
7 - `smartmontools`
8
collectors/python.d.plugin/spigotmc/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# spigotmc
1 +# SpigotMC monitoring with Netdata
2
3 -This module does some really basic monitoring for Spigot Minecraft servers.
3 +Performs basic monitoring for Spigot Minecraft servers.
4
5 It provides two charts, one tracking server-side ticks-per-second in
6 1, 5 and 15 minute averages, and one tracking the number of currently
collectors/python.d.plugin/springboot/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# springboot
1 +# Spring Boot2 monitoring with Netdata
2
3 -This module will monitor one or more Java Spring-boot applications depending on configuration.
3 +Monitors one or more Java Spring-boot applications depending on configuration.
4 Netdata can be used to monitor running Java [Spring Boot](https://spring.io/) applications that expose their metrics with the use of the **Spring Boot Actuator** included in Spring Boot library.
5
6 ## Configuration
collectors/python.d.plugin/squid/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# squid
1 +# Squid monitoring with Netdata
2
3 -This module will monitor one or more squid instances depending on configuration.
3 +Monitors one or more squid instances depending on configuration.
4
5 It produces following charts:
6
collectors/python.d.plugin/tomcat/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# tomcat
1 +# Apache Tomcat monitoring with Netdata
2
3 -Present tomcat containers memory utilization.
3 +Presents memory utilization of tomcat containers.
4
5 Charts:
6
collectors/python.d.plugin/tor/README.md
+3 -3
@@ -1,8 +1,8 @@
1 -# tor
1 +# Tor monitoring with Netdata
2
3 -Module connects to tor control port to collect traffic statistics.
3 +Connects to the Tor control port to collect traffic statistics.
4
5 -**Requirements:**
5 +## Requirements
6
7 - `tor` program
8 - `stem` python package
collectors/python.d.plugin/traefik/README.md
+2 -2
@@ -1,6 +1,6 @@
1 -# traefik
1 +# Traefik monitoring with Netdata
2
3 -Module uses the `health` API to provide statistics.
3 +Uses the `health` API to provide statistics.
4
5 It produces:
6
collectors/python.d.plugin/uwsgi/README.md
+2 -5
@@ -1,10 +1,7 @@
1 -# uwsgi
1 +# uWSGI monitoring with Netdata
2
3 -Module monitor uwsgi performance metrics.
3 +Monitors performance metrics exposed by [`Stats Server`](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html).
4
5 -<https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html>
6 -
7 -lines are creates dynamically based on how many workers are there
5
6 Following charts are drawn:
7
collectors/python.d.plugin/varnish/README.md
+2 -3
@@ -1,8 +1,7 @@
1 -# varnish
1 +# Varnish Cache monitoring with Netdata
2
3 -This module will monitor [`Varnish Cache`](https://varnish-cache.org/) performance metrics.
3 +Provides HTTP accelerator global, backends (VBE) and disks (SMF) statistics using `varnishstat` tool.
4
5 -It uses the `varnishstat` command to provide Varnish Cache statistics.
5
6 ## Requirements
7
collectors/python.d.plugin/w1sensor/README.md
+3 -2
@@ -1,6 +1,7 @@
1 -# w1sensor
1 +# 1-Wire Sensors monitoring with Netdata
2 +
3 +Monitors sensor temperature.
4
3 -Data from 1-Wire sensors.
5 On Linux these are supported by the wire, w1_gpio, and w1_therm modules.
6 Currently temperature sensors are supported and automatically detected.
7
collectors/python.d.plugin/web_log/README.md
+6 -4
@@ -1,4 +1,6 @@
1 -# web_log
1 +# Apache/NGINX/Squid monitoring with Netdata
2 +
3 +Tails access log file and Collects web server/caching proxy metrics.
4
5 ## Motivation
6
@@ -59,7 +61,7 @@ You can add one such section for each of your web server log files.
61
62 Once you have all log files configured and [**netdata**](https://my-netdata.io/) restarted, **for each log file** you will get a section at the [**netdata**](https://my-netdata.io/) dashboard, with the following charts.
63
62 -### responses by status
64 +### Responses by status
65
66 In this chart we tried to provide a meaningful status for all responses. So:
67
@@ -106,7 +108,7 @@ Here we show all the response codes in detail.
108
109 Number of responses for each response code family individually (requests/s)
110
109 -### bandwidth
111 +### Bandwidth
112
113 This is a nice view of the traffic the web server is receiving and is sending.
114
@@ -123,7 +125,7 @@ As the legend on the chart suggests, you can use FireQoS to setup QoS on the web
125
126 > **Important**<br/>Most web servers do not log the request size by default.<br/>So, [unless you have configured your web server to log the size of requests](https://github.com/netdata/netdata/blob/419cd0a237275e5eeef3f92dcded84e735ee6c58/conf.d/python.d/web_log.conf#L76-L89), the `received` dimension will be always zero.
127
126 -### timings
128 +### Timings
129
130 [**netdata**](https://my-netdata.io/) will also render the `minimum`, `average` and `maximum` time the web server needed to respond to requests.
131