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 # ----------------------------------------------------------------------
  47 # PLUGIN CONFIGURATION
  48 #
  49 # All python.d.plugin JOBS (for all its modules) support a set of
  50 # predefined parameters. These are:
  51 #
  52 # job_name:
  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
  59 #
  60 # Additionally to the above, web_log also supports the following:
  61 #
  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
  69
  70 # ----------------------------------------------------------------------
  71 # WEB SERVER CONFIGURATION
  72 #
  73 # Make sure the log directory and file can be read by user 'netdata'.
  74 #
  75 # Preferable Log Format. You need to change to this to collect all metrics.
  76 #
  77 # nginx:
  78 #   log_format netdata '$remote_addr - $remote_user [$time_local] '
  79 #                      '"$request" $status $body_bytes_sent '
  80 #                      '$request_length $request_time '
  81 #                      '"$http_referer" "$http_user_agent"';
  82 #   access_log /var/log/nginx/access.log netdata;
  83 #
  84 # apache:
  85 #   LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
  86 #   LogFormat "%h %l %u %t \"%r\" %>s %O %I %D \"%{Referer}i\" \"%{User-Agent}i\"" combined
  87
  88 # ----------------------------------------------------------------------
  89 # AUTO-DETECTION JOBS
  90 # only one of them per web server will run (when they have the same name)
  91
  92
  93 # -------------------------------------------
  94 # nginx log on various distros
  95
  96 # debian, arch
  97 nginx_log:
  98   name: 'nginx'
  99   path: '/var/log/nginx/access.log'
 100
 101 # gentoo
 102 nginx_log2:
 103   name: 'nginx'
 104   path: '/var/log/nginx/localhost.access_log'
 105
 106
 107 # -------------------------------------------
 108 # apache log on various distros
 109
 110 # debian
 111 apache_log:
 112   name: 'apache'
 113   path: '/var/log/apache2/access.log'
 114
 115 # gentoo
 116 apache_log2:
 117   name: 'apache'
 118   path: '/var/log/apache2/access_log'
 119
 120 # arch
 121 apache_log3:
 122   name: 'apache'
 123   path: '/var/log/httpd/access_log'
 124
 125 # debian
 126 apache_vhosts_log:
 127   name: 'apache_vhosts'
 128   path: '/var/log/apache2/other_vhosts_access.log'
 129
 130
 131 # -------------------------------------------
 132 # gunicorn log on various distros
 133
 134 gunicorn_log:
 135   name: 'gunicorn'
 136   path: '/var/log/gunicorn/access.log'
 137
 138 gunicorn_log2:
 139   name: 'gunicorn'
 140   path: '/var/log/gunicorn/gunicorn-access.log'