summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/nginx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/nginx/README.md')
-rw-r--r--collectors/python.d.plugin/nginx/README.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/collectors/python.d.plugin/nginx/README.md b/collectors/python.d.plugin/nginx/README.md
index ebbdb0f25..b55b01e7c 100644
--- a/collectors/python.d.plugin/nginx/README.md
+++ b/collectors/python.d.plugin/nginx/README.md
@@ -1,8 +1,14 @@
-# nginx
+<!--
+title: "NGINX monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nginx/README.md
+sidebar_label: "NGINX"
+-->
-This module will monitor one or more nginx servers depending on configuration. Servers can be either local or remote.
+# NGINX monitoring with Netdata
-**Requirements:**
+Monitors one or more NGINX servers depending on configuration. Servers can be either local or remote.
+
+## Requirements
- nginx with configured 'ngx_http_stub_status_module'
- 'location /stub_status'
@@ -30,9 +36,17 @@ It produces following charts:
- accepts
- handled
-## configuration
+## Configuration
+
+Edit the `python.d/nginx.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/nginx.conf
+```
-Needs only `url` to server's `stub_status`
+Needs only `url` to server's `stub_status`.
Here is an example for local server: