summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/httpcheck/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/httpcheck/README.md')
-rw-r--r--collectors/python.d.plugin/httpcheck/README.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/collectors/python.d.plugin/httpcheck/README.md b/collectors/python.d.plugin/httpcheck/README.md
index 99b28cfeb..55aad52f0 100644
--- a/collectors/python.d.plugin/httpcheck/README.md
+++ b/collectors/python.d.plugin/httpcheck/README.md
@@ -1,6 +1,12 @@
-# httpcheck
+<!--
+title: "HTTP endpoint monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/httpcheck/README.md
+sidebar_label: "HTTP endpoints"
+-->
-Module monitors remote http server for availability and response time.
+# HTTP endpoint monitoring with Netdata
+
+Monitors remote http server for availability and response time.
Following charts are drawn per job:
@@ -17,7 +23,15 @@ Following charts are drawn per job:
- Connection failed: port not listening or blocked
- Connection timed out: host or port unreachable
-## configuration
+## Configuration
+
+Edit the `python.d/httpcheck.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/httpcheck.conf
+```
Sample configuration and their default values.
@@ -32,7 +46,7 @@ server:
redirect: yes # optional
```
-### notes
+### Notes
- The status chart is primarily intended for alarms, badges or for access via API.
- A system/service/firewall might block Netdata's access if a portscan or