summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/couchdb/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/couchdb/README.md')
-rw-r--r--collectors/python.d.plugin/couchdb/README.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/collectors/python.d.plugin/couchdb/README.md b/collectors/python.d.plugin/couchdb/README.md
index 288970674..896bbdd31 100644
--- a/collectors/python.d.plugin/couchdb/README.md
+++ b/collectors/python.d.plugin/couchdb/README.md
@@ -1,6 +1,12 @@
-# couchdb
+<!--
+title: "Apache CouchDB monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/couchdb/README.md
+sidebar_label: "CouchDB"
+-->
-This module monitors vital statistics of a local Apache CouchDB 2.x server, including:
+# Apache CouchDB monitoring with Netdata
+
+Monitors vital statistics of a local Apache CouchDB 2.x server, including:
- Overall server reads/writes
- HTTP traffic breakdown
@@ -13,6 +19,14 @@ This module monitors vital statistics of a local Apache CouchDB 2.x server, incl
## Configuration
+Edit the `python.d/couchdb.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/couchdb.conf
+```
+
Sample for a local server running on port 5984:
```yaml