summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/rethinkdbs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/rethinkdbs/README.md')
-rw-r--r--collectors/python.d.plugin/rethinkdbs/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/rethinkdbs/README.md b/collectors/python.d.plugin/rethinkdbs/README.md
new file mode 100644
index 0000000..d3fa355
--- /dev/null
+++ b/collectors/python.d.plugin/rethinkdbs/README.md
@@ -0,0 +1,53 @@
+<!--
+title: "RethinkDB monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rethinkdbs/README.md
+sidebar_label: "RethinkDB"
+-->
+
+# RethinkDB monitoring with Netdata
+
+Collects database server and cluster statistics.
+
+Following charts are drawn:
+
+1. **Connected Servers**
+
+ - connected
+ - missing
+
+2. **Active Clients**
+
+ - active
+
+3. **Queries** per second
+
+ - queries
+
+4. **Documents** per second
+
+ - documents
+
+## Configuration
+
+Edit the `python.d/rethinkdbs.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/rethinkdbs.conf
+```
+
+```yaml
+localhost:
+ name : 'local'
+ host : '127.0.0.1'
+ port : 28015
+ user : "user"
+ password : "pass"
+```
+
+When no configuration file is found, module tries to connect to `127.0.0.1:28015`.
+
+---
+
+