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