summaryrefslogtreecommitdiffstats
path: root/conf.d/python.d/nginx.conf
diff options
context:
space:
mode:
Diffstat (limited to 'conf.d/python.d/nginx.conf')
-rw-r--r--conf.d/python.d/nginx.conf27
1 files changed, 24 insertions, 3 deletions
diff --git a/conf.d/python.d/nginx.conf b/conf.d/python.d/nginx.conf
index 1a27d67c5..645925a55 100644
--- a/conf.d/python.d/nginx.conf
+++ b/conf.d/python.d/nginx.conf
@@ -1,5 +1,17 @@
# netdata python.d.plugin configuration for nginx
#
+# You must have ngx_http_stub_status_module configured on your nginx server for this
+# plugin to work. The following is an example config.
+# It must be located inside a server { } block.
+#
+# location /stub_status {
+# stub_status;
+# # Security: Only allow access from the IP below.
+# allow 192.168.1.200;
+# # Deny anyone else
+# deny all;
+# }
+#
# This file is in YaML format. Generally the format is:
#
# name: value
@@ -47,14 +59,15 @@
# predefined parameters. These are:
#
# job_name:
-# name: myname # the JOB's name as it will appear at the
-# # dashboard (by default is the job_name)
+# name: my_name # the JOB's name as it will appear at the
+# # dashboard. If name: is not supplied the
+# # job_name: will be used (use _ for spaces)
# # JOBs sharing a name are mutually exclusive
# update_every: 1 # the JOB's data collection frequency
# priority: 60000 # the JOB's order on the dashboard
# retries: 5 # the JOB's number of restoration attempts
#
-# Additionally to the above, nginx also supports the following:
+# Additionally to the above, this plugin also supports the following:
#
# url: 'URL' # the URL to fetch nginx's status stats
#
@@ -63,6 +76,14 @@
# user: 'username'
# pass: 'password'
#
+# Example
+#
+# RemoteNginx:
+# name : 'Reverse_Proxy'
+# url : 'http://yourdomain.com/stub_status'
+#
+# "RemoteNginx" will show up in Netdata logs. "Reverse Proxy" will show up in the menu
+# in the nginx section.
# ----------------------------------------------------------------------
# AUTO-DETECTION JOBS