]> arthur.barton.de Git - netdata.git/blob - conf.d/python.d/web_log.conf
web_log plugin: configuration file update
[netdata.git] / conf.d / python.d / web_log.conf
1 # netdata python.d.plugin configuration for web log
2 #
3 # This file is in YaML format. Generally the format is:
4 #
5 # name: value
6 #
7 # There are 2 sections:
8 #  - global variables
9 #  - one or more JOBS
10 #
11 # JOBS allow you to collect values from multiple sources.
12 # Each source will have its own set of charts.
13 #
14 # JOB parameters have to be indented (using spaces only, example below).
15
16 # ----------------------------------------------------------------------
17 # Global Variables
18 # These variables set the defaults for all JOBs, however each JOB
19 # may define its own, overriding the defaults.
20
21 # update_every sets the default data collection frequency.
22 # If unset, the python.d.plugin default is used.
23 # update_every: 1
24
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.
28 # priority: 60000
29
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.
34 # retries: 5
35
36 # ----------------------------------------------------------------------
37 # JOBS (data collection sources)
38 #
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.
43 #
44 # Any number of jobs is supported.
45 #
46 # All python.d.plugin JOBS (for all its modules) support a set of
47 # predefined parameters. These are:
48 #
49 # job_name:
50 #     name: myname     # the JOB's name as it will appear at the
51 #                      # dashboard (by default is the job_name)
52 #                      # JOBs sharing a name are mutually exclusive
53 #     update_every: 1  # the JOB's data collection frequency
54 #     priority: 60000  # the JOB's order on the dashboard
55 #     retries: 5       # the JOB's number of restoration attempts
56 #
57 # Additionally to the above, web_log also supports the following:
58 #
59 #     path: 'PATH'                        # the path to web server log file
60 #     detailed_response_codes: yes/no     # Default: yes. Additional chart where response codes are not grouped
61 #     all_time : yes/no                   # Default: yes. All time unique client IPs chart (50000 addresses ~ 400KB)
62 #     categories:                         # requests per url chart configuration
63 #          cacti: 'cacti.*'               # name(dimension): REGEX to match
64 #          observium: 'observium.*'       # name(dimension): REGEX to match
65 #          stub_status: 'stub_status'     # name(dimension): REGEX to match
66 #
67 # Preferable Log Format. You need to change to this to collect all metrics.
68 # Nginx: 
69 #        log_format netdata '$remote_addr - $remote_user [$time_local] '
70 #                           '"$request" $status $body_bytes_sent '
71 #                           '$request_length $request_time '
72 #                           '"$http_referer" "$http_user_agent"';
73 #        access_log /var/log/nginx/access.log netdata;
74 # Apache:
75 #        LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
76 #        LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" combined
77 # ----------------------------------------------------------------------
78 # AUTO-DETECTION JOBS
79 # only one of them will run (if they have the same name)
80
81 # debian
82 nginx_log:
83   name: 'nginx'
84   path: '/var/log/nginx/access.log'
85
86 # gentoo
87 nginx_log2:
88   name: 'nginx'
89   path: '/var/log/nginx/localhost.access_log'
90
91 # debian
92 apache_log:
93   name: 'apache'
94   path: '/var/log/apache2/access.log'
95
96 # gentoo
97 apache_log2:
98   name: 'apache'
99   path: '/var/log/apache2/access_log'
100
101 # arch
102 apache_log3:
103   name: 'apache'
104   path: '/var/log/httpd/access_log'
105
106 apache_vhosts_log:
107   name: 'apache_vhosts'
108   path: '/var/log/apache2/other_vhosts_access.log'
109
110 gunicorn_log:
111   name: 'gunicorn'
112   path: '/var/log/gunicorn/access.log'
113
114 gunicorn_log2:
115   name: 'gunicorn'
116   path: '/var/log/gunicorn/gunicorn-access.log'