1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
|
<!--
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"
-->
# Riak KV monitoring with Netdata
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.
The following charts are included, which are mostly derived from the metrics
listed
[here](https://docs.riak.com/riak/kv/latest/using/reference/statistics-monitoring/index.html#riak-metrics-to-graph).
1. **Throughput** in operations/s
- **KV operations**
- gets
- puts
- **Data type updates**
- counters
- sets
- maps
- **Search queries**
- queries
- **Search documents**
- indexed
- **Strong consistency operations**
- gets
- puts
2. **Latency** in milliseconds
- **KV latency** of the past minute
- get (mean, median, 95th / 99th / 100th percentile)
- put (mean, median, 95th / 99th / 100th percentile)
- **Data type latency** of the past minute
- counter_merge (mean, median, 95th / 99th / 100th percentile)
- set_merge (mean, median, 95th / 99th / 100th percentile)
- map_merge (mean, median, 95th / 99th / 100th percentile)
- **Search latency** of the past minute
- query (median, min, max, 95th / 99th percentile)
- index (median, min, max, 95th / 99th percentile)
- **Strong consistency latency** of the past minute
- get (mean, median, 95th / 99th / 100th percentile)
- put (mean, median, 95th / 99th / 100th percentile)
3. **Erlang VM metrics**
- **System counters**
- processes
- **Memory allocation** in MB
- processes.allocated
- processes.used
4. **General load / health metrics**
- **Siblings encountered in KV operations** during the past minute
- get (mean, median, 95th / 99th / 100th percentile)
- **Object size in KV operations** during the past minute in KB
- get (mean, median, 95th / 99th / 100th percentile)
- **Message queue length** in unprocessed messages
- vnodeq_size (mean, median, 95th / 99th / 100th percentile)
- **Index operations** encountered by Search
- errors
- **Protocol buffer connections**
- active
- **Repair operations coordinated by this node**
- read
- **Active finite state machines by kind**
- get
- put
- secondary_index
- list_keys
- **Rejected finite state machines**
- get
- put
- **Number of writes to Search failed due to bad data format by reason**
- bad_entry
- extract_fail
## 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:
```yaml
myriak:
url: http://myriak.example.com:8098/stats
```
With no explicit configuration given, the module will attempt to connect to
`http://localhost:8098/stats`.
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.
|