diff options
Diffstat (limited to 'collectors/python.d.plugin/riakkv/README.md')
| -rw-r--r-- | collectors/python.d.plugin/riakkv/README.md | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/collectors/python.d.plugin/riakkv/README.md b/collectors/python.d.plugin/riakkv/README.md index 04343dd99..d0ea9a137 100644 --- a/collectors/python.d.plugin/riakkv/README.md +++ b/collectors/python.d.plugin/riakkv/README.md @@ -1,8 +1,14 @@ -# riakkv +<!-- +title: "Riak KV monitoring with Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/riakkv/README.md +sidebar_label: "Riak KV" +--> -Monitors one or more Riak KV servers. +# Riak KV monitoring with Netdata -**Requirements:** +Collects database stats from `/stats` endpoint. + +## Requirements - An accessible `/stats` endpoint. See [the Riak KV configuration reference documentation](https://docs.riak.com/riak/kv/2.2.3/configuring/reference/#client-interfaces) for how to enable this. @@ -94,7 +100,15 @@ listed - bad_entry - extract_fail -## configuration +## Configuration + +Edit the `python.d/riakkv.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/riakkv.conf +``` The module needs to be passed the full URL to Riak's stats endpoint. For example: @@ -110,3 +124,5 @@ With no explicit configuration given, the module will attempt to connect to The default update frequency for the plugin is set to 2 seconds as Riak internally updates the metrics every second. If we were to update the metrics every second, the resulting graph would contain odd jitter. + +[]() |