1 # netdata python.d.plugin configuration for web log
3 # This file is in YaML format. Generally the format is:
7 # There are 2 sections:
11 # JOBS allow you to collect values from multiple sources.
12 # Each source will have its own set of charts.
14 # JOB parameters have to be indented (using spaces only, example below).
16 # ----------------------------------------------------------------------
18 # These variables set the defaults for all JOBs, however each JOB
19 # may define its own, overriding the defaults.
21 # update_every sets the default data collection frequency.
22 # If unset, the python.d.plugin default is used.
25 # priority controls the order of charts at the netdata dashboard.
26 # Lower numbers move the charts towards the top of the page.
27 # If unset, the default for python.d.plugin is used.
30 # retries sets the number of retries to be made in case of failures.
31 # If unset, the default for python.d.plugin is used.
32 # Attempts to restore the service are made once every update_every
33 # and only if the module has collected values in the past.
36 # ----------------------------------------------------------------------
37 # JOBS (data collection sources)
39 # The default JOBS share the same *name*. JOBS with the same name
40 # are mutually exclusive. Only one of them will be allowed running at
41 # any time. This allows autodetection to try several alternatives and
42 # pick the one that works.
44 # Any number of jobs is supported.
46 # ----------------------------------------------------------------------
47 # PLUGIN CONFIGURATION
49 # All python.d.plugin JOBS (for all its modules) support a set of
50 # predefined parameters. These are:
53 # name: myname # the JOB's name as it will appear at the
54 # # dashboard (by default is the job_name)
55 # # JOBs sharing a name are mutually exclusive
56 # update_every: 1 # the JOB's data collection frequency
57 # priority: 60000 # the JOB's order on the dashboard
58 # retries: 5 # the JOB's number of restoration attempts
60 # Additionally to the above, web_log also supports the following:
62 # path: 'PATH' # the path to web server log file
63 # detailed_response_codes: yes/no # Default: yes. Additional chart where response codes are not grouped
64 # all_time : yes/no # Default: yes. All time unique client IPs chart (50000 addresses ~ 400KB)
65 # categories: # requests per url chart configuration
66 # cacti: 'cacti.*' # name(dimension): REGEX to match
67 # observium: 'observium.*' # name(dimension): REGEX to match
68 # stub_status: 'stub_status' # name(dimension): REGEX to match
70 # ----------------------------------------------------------------------
71 # WEB SERVER CONFIGURATION
73 # Make sure the web server log directory and the web server log files
74 # can be read by user 'netdata'.
76 # To enable the timings chart and the requests size dimension, the
77 # web server needs to log them. This is how to add them:
80 # log_format netdata '$remote_addr - $remote_user [$time_local] '
81 # '"$request" $status $body_bytes_sent '
82 # '$request_length $request_time '
83 # '"$http_referer" "$http_user_agent"';
84 # access_log /var/log/nginx/access.log netdata;
86 # apache (you need mod_logio enabled):
87 # LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" vhost_netdata
88 # LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" netdata
89 # CustomLog "/var/log/apache2/access.log" netdata
91 # ----------------------------------------------------------------------
93 # only one of them per web server will run (when they have the same name)
96 # -------------------------------------------
97 # nginx log on various distros
102 path: '/var/log/nginx/access.log'
107 path: '/var/log/nginx/localhost.access_log'
110 # -------------------------------------------
111 # apache log on various distros
116 path: '/var/log/apache2/access.log'
121 path: '/var/log/apache2/access_log'
126 path: '/var/log/httpd/access_log'
130 name: 'apache_vhosts'
131 path: '/var/log/apache2/other_vhosts_access.log'
134 # -------------------------------------------
135 # gunicorn log on various distros
139 path: '/var/log/gunicorn/access.log'
143 path: '/var/log/gunicorn/gunicorn-access.log'