added information on the dashboard for web_log plugin

[netdata.git] / conf.d / python.d / web_log.conf

diff --git a/conf.d/python.d/web_log.conf b/conf.d/python.d/web_log.conf
index a6d48b8464f688dffd05a758a892a731d3750a02..ff993dc991176fdeafe2231032680eaf6375cad8 100644 (file)
--- a/conf.d/python.d/web_log.conf
+++ b/conf.d/python.d/web_log.conf
@@ -42,6 +42,9 @@
 # pick the one that works.
 #
 # Any number of jobs is supported.
+
+# ----------------------------------------------------------------------
+# PLUGIN CONFIGURATION
 #
 # All python.d.plugin JOBS (for all its modules) support a set of
 # predefined parameters. These are:
@@ -63,22 +66,34 @@
 #          cacti: 'cacti.*'               # name(dimension): REGEX to match
 #          observium: 'observium.*'       # name(dimension): REGEX to match
 #          stub_status: 'stub_status'     # name(dimension): REGEX to match
+
+# ----------------------------------------------------------------------
+# WEB SERVER CONFIGURATION
+#
+# Make sure the log directory and file can be read by user 'netdata'.
 #
 # Preferable Log Format. You need to change to this to collect all metrics.
-# Nginx: 
-#        log_format netdata '$remote_addr - $remote_user [$time_local] '
-#                           '"$request" $status $body_bytes_sent '
-#                           '$request_length $request_time '
-#                           '"$http_referer" "$http_user_agent"';
-#        access_log /var/log/nginx/access.log netdata;
-# Apache:
-#        LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
-#        LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" combined
+#
+# nginx:
+#   log_format netdata '$remote_addr - $remote_user [$time_local] '
+#                      '"$request" $status $body_bytes_sent '
+#                      '$request_length $request_time '
+#                      '"$http_referer" "$http_user_agent"';
+#   access_log /var/log/nginx/access.log netdata;
+#
+# apache:
+#   LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
+#   LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" combined
+
 # ----------------------------------------------------------------------
 # AUTO-DETECTION JOBS
-# only one of them will run (if they have the same name)
+# only one of them per web server will run (when they have the same name)
 
-# debian
+
+# -------------------------------------------
+# nginx log on various distros
+
+# debian, arch
 nginx_log:
   name: 'nginx'
   path: '/var/log/nginx/access.log'
@@ -88,6 +103,10 @@ nginx_log2:
   name: 'nginx'
   path: '/var/log/nginx/localhost.access_log'
 
+
+# -------------------------------------------
+# apache log on various distros
+
 # debian
 apache_log:
   name: 'apache'
@@ -103,10 +122,15 @@ apache_log3:
   name: 'apache'
   path: '/var/log/httpd/access_log'
 
+# debian
 apache_vhosts_log:
   name: 'apache_vhosts'
   path: '/var/log/apache2/other_vhosts_access.log'
 
+
+# -------------------------------------------
+# gunicorn log on various distros
+
 gunicorn_log:
   name: 'gunicorn'
   path: '/var/log/gunicorn/access.log'