dns_query_time plugin: python readme update

[netdata.git] / python.d / README.md

diff --git a/python.d/README.md b/python.d/README.md
index cee2078f2f0c0607dab5aa30e8efe3c0b75307da..e0e5893e2610d2b7a69e8614bc92b299bec4e217 100644 (file)
--- a/python.d/README.md
+++ b/python.d/README.md
@@ -227,6 +227,16 @@ Your kernel needs to have `CONFIG_CPU_IDLE` enabled.
 It produces one stacked chart per CPU, showing the percentage of time spent in
 each state.
 
 It produces one stacked chart per CPU, showing the percentage of time spent in
 each state.
 

+---
+# dns_query_time
+
+This module provides dns query time statistics.
+
+**Requirement:**
+* `python-dnspython` package
+
+It produces one aggregate chart or one chart per dns server, showing the query time.
+

 ---
 
 # dovecot
 ---
 
 # dovecot


@@ -307,12 +317,6 @@ If no configuration is given, module will attempt to connect to dovecot using un
 
 Module monitor elasticsearch performance and health metrics
 
 
 Module monitor elasticsearch performance and health metrics
 

-**Requirements:**
- * python `requests` package.
-
-You need to install it manually. (python-requests or python3-requests depending on the version of python).
-
-

 It produces:
 
 1. **Search performance** charts:
 It produces:
 
 1. **Search performance** charts:


@@ -990,33 +994,6 @@ Without configuration, module attempts to connect to `http://localhost/stub_stat
 
 ---
 
 
 ---
 

-# nginx_log
-
-Module monitors nginx access log and produces only one chart:
-
-1. **nginx status codes** in requests/s
- * 2xx
- * 3xx
- * 4xx
- * 5xx
-
-### configuration
-
-Sample for two vhosts:
-
-```yaml
-site_A:
-  path: '/var/log/nginx/access-A.log'
-
-site_B:
-  name: 'local'
-  path: '/var/log/nginx/access-B.log'
-```
-
-When no configuration file is found, module tries to parse `/var/log/nginx/access.log` file.
-
----
-

 # nsd
 
 Module uses the `nsd-control stats_noreset` command to provide `nsd` statistics.
 # nsd
 
 Module uses the `nsd-control stats_noreset` command to provide `nsd` statistics.


@@ -1162,6 +1139,75 @@ Configuration is not needed.
 
 ---
 
 
 ---
 

+# postgres
+
+Module monitors one or more postgres servers.
+
+**Requirements:**
+
+ * `python-psycopg2` package. You have to install to manually.
+
+Following charts are drawn:
+
+1. **Database size** MB
+ * size
+
+2. **Current Backend Processes** processes
+ * active
+
+3. **Write-Ahead Logging Statistics** files/s
+ * total
+ * ready
+ * done
+
+4. **Checkpoints** writes/s
+ * scheduled
+ * requested
+ 
+5. **Current connections to db** count
+ * connections
+ 
+6. **Tuples returned from db** tuples/s
+ * sequential
+ * bitmap
+
+7. **Tuple reads from db** reads/s
+ * disk
+ * cache
+
+8. **Transactions on db** transactions/s
+ * commited
+ * rolled back
+
+9. **Tuples written to db** writes/s
+ * inserted
+ * updated
+ * deleted
+ * conflicts
+
+10. **Locks on db** count per type
+ * locks
+ 
+### configuration
+
+```yaml
+socket:
+  name         : 'socket'
+  user         : 'postgres'
+  database     : 'postgres'
+
+tcp:
+  name         : 'tcp'
+  user         : 'postgres'
+  database     : 'postgres'
+  host         : 'localhost'
+  port         : 5432
+```
+
+When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:5432`.
+
+---
+

 # redis
 
 Get INFO data from redis instance.
 # redis
 
 Get INFO data from redis instance.


@@ -1256,6 +1302,45 @@ Without any configuration module will try to autodetect where squid presents its
  
 ---
 
  
 ---
 

+# smartd_log
+
+Module monitor `smartd` log files to collect HDD/SSD S.M.A.R.T attributes.
+
+It produces following charts (you can add additional attributes in the module configuration file):
+
+1. **Read Error Rate** attribute 1
+
+2. **Start/Stop Count** attribute 4
+
+3. **Reallocated Sectors Count** attribute 5
+ 
+4. **Seek Error Rate** attribute 7
+
+5. **Power-On Hours Count** attribute 9
+
+6. **Power Cycle Count** attribute 12
+
+7. **Load/Unload Cycles** attribute 193
+
+8. **Temperature** attribute 194
+
+9. **Current Pending Sectors** attribute 197
+ 
+10. **Off-Line Uncorrectable** attribute 198
+
+11. **Write Error Rate** attribute 200
+ 
+### configuration
+
+```yaml
+local:
+  log_path : '/var/log/smartd/'
+```
+
+If no configuration is given, module will attempt to read log files in /var/log/smartd/ directory.
+ 
+---
+

 # tomcat
 
 Present tomcat containers memory utilization.
 # tomcat
 
 Present tomcat containers memory utilization.


@@ -1355,3 +1440,68 @@ It produces:
 No configuration is needed.
 
 ---
 No configuration is needed.
 
 ---

+
+# web_log
+
+Tails the apache/nginx/lighttpd/gunicorn log files to collect real-time web-server statistics.
+
+It produces following charts:
+
+1. **Response by type** requests/s
+ * success (1xx, 2xx, 304)
+ * error (5xx)
+ * redirect (3xx except 304)
+ * bad (4xx)
+ * other (all other responses)
+
+2. **Response by code family** requests/s
+ * 1xx (informational)
+ * 2xx (successful)
+ * 3xx (redirect)
+ * 4xx (bad)
+ * 5xx (internal server errors)
+ * other (non-standart responses)
+ * unmatched (the lines in the log file that are not matched)
+
+3. **Detailed Response Codes** requests/s (number of responses for each response code family individually)
+ 
+4. **Bandwidth** KB/s
+ * received (bandwidth of requests)
+ * send (bandwidth of responses)
+
+5. **Timings** ms (request processing time)
+ * min (bandwidth of requests)
+ * max (bandwidth of responses)
+ * average (bandwidth of responses)
+
+6. **Request per url** requests/s (configured by user)
+
+7. **Http Methods** requests/s (requests per http method)
+
+8. **Http Versions** requests/s (requests per http version)
+
+9. **IP protocols** requests/s (requests per ip protocol version)
+
+10. **Curent Poll Unique Client IPs** unique ips/s (unique client IPs per data collection iteration)
+
+11. **All Time Unique Client IPs** unique ips/s (unique client IPs since the last restart of netdata)
+
+ 
+### configuration
+
+```yaml
+nginx_log:
+  name  : 'nginx_log'
+  path  : '/var/log/nginx/access.log'
+
+apache_log:
+  name  : 'apache_log'
+  path  : '/var/log/apache/other_vhosts_access.log'
+  categories:
+      cacti : 'cacti.*'
+      observium : 'observium'
+```
+
+Module has preconfigured jobs for nginx, apache and gunicorn on various distros.
+
+---