conf.d/python.d/nginx.conf

   1 # netdata python.d.plugin configuration for nginx
   2 #
   3 # You must have ngx_http_stub_status_module configured on your nginx server for this
   4 # plugin to work. The following is an example config.
   5 # It must be located inside a server { } block.
   6 #
   7 # location /stub_status {
   8 #   stub_status;
   9 #   # Security: Only allow access from the IP below.
  10 #   allow 192.168.1.200;
  11 #   # Deny anyone else
  12 #   deny all;
  13 #  }
  14 #
  15 # This file is in YaML format. Generally the format is:
  16 #
  17 # name: value
  18 #
  19 # There are 2 sections:
  20 #  - global variables
  21 #  - one or more JOBS
  22 #
  23 # JOBS allow you to collect values from multiple sources.
  24 # Each source will have its own set of charts.
  25 #
  26 # JOB parameters have to be indented (using spaces only, example below).
  27
  28 # ----------------------------------------------------------------------
  29 # Global Variables
  30 # These variables set the defaults for all JOBs, however each JOB
  31 # may define its own, overriding the defaults.
  32
  33 # update_every sets the default data collection frequency.
  34 # If unset, the python.d.plugin default is used.
  35 # update_every: 1
  36
  37 # priority controls the order of charts at the netdata dashboard.
  38 # Lower numbers move the charts towards the top of the page.
  39 # If unset, the default for python.d.plugin is used.
  40 # priority: 60000
  41
  42 # retries sets the number of retries to be made in case of failures.
  43 # If unset, the default for python.d.plugin is used.
  44 # Attempts to restore the service are made once every update_every
  45 # and only if the module has collected values in the past.
  46 # retries: 5
  47
  48 # ----------------------------------------------------------------------
  49 # JOBS (data collection sources)
  50 #
  51 # The default JOBS share the same *name*. JOBS with the same name
  52 # are mutually exclusive. Only one of them will be allowed running at
  53 # any time. This allows autodetection to try several alternatives and
  54 # pick the one that works.
  55 #
  56 # Any number of jobs is supported.
  57 #
  58 # All python.d.plugin JOBS (for all its modules) support a set of
  59 # predefined parameters. These are:
  60 #
  61 # job_name:
  62 #     name: my_name    # the JOB's name as it will appear at the
  63 #                      # dashboard. If name: is not supplied the
  64 #                      # job_name: will be used (use _ for spaces)
  65 #                      # JOBs sharing a name are mutually exclusive
  66 #     update_every: 1  # the JOB's data collection frequency
  67 #     priority: 60000  # the JOB's order on the dashboard
  68 #     retries: 5       # the JOB's number of restoration attempts
  69 #
  70 # Additionally to the above, this plugin also supports the following:
  71 #
  72 #     url: 'URL'       # the URL to fetch nginx's status stats
  73 #
  74 # if the URL is password protected, the following are supported:
  75 #
  76 #     user: 'username'
  77 #     pass: 'password'
  78 #
  79 # Example
  80 #
  81 # RemoteNginx:
  82 #     name : 'Reverse_Proxy'
  83 #     url  : 'http://yourdomain.com/stub_status'
  84 #
  85 # "RemoteNginx" will show up in Netdata logs. "Reverse Proxy" will show up in the menu
  86 # in the nginx section.
  87
  88 # ----------------------------------------------------------------------
  89 # AUTO-DETECTION JOBS
  90 # only one of them will run (they have the same name)
  91
  92 localhost:
  93   name : 'local'
  94   url  : 'http://localhost/stub_status'
  95
  96 localipv4:
  97   name : 'local'
  98   url  : 'http://127.0.0.1/stub_status'
  99
 100 localipv6:
 101   name : 'local'
 102   url  : 'http://::1/stub_status'
 103