Riak is a distributed NoSQL key-value data store that offers high availability, fault tolerance, operational simplicity, and scalability. Riak implements the principles from Amazon’s Dynamo paper with heavy influence from the CAP Theorem. Written in Erlang, Riak has fault tolerant data replication and automatic data distribution across the cluster for performance and resilience.
Prerequisite
For Virtual machines, install the Linux agent.
Configuring the credentials
Configure the credentials in the directory /opt/opsramp/agent/conf/app.d/creds.yaml
riak:
- name: riak
user: <username>
pwd: <Password>
encoding-type: plain
labels:
key1: val1
key2: val2
Configuring the application
Virtual machine
Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-detection.yaml
- name: riak
instance-checks:
service-check:
- riak
process-check:
- riak
port-check:
- 8098
Docker environment
Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-container-detection.yaml
- name: riak
container-checks:
image-check:
- riak
port-check:
- 8098
Kubernetes environment
Configure the application in config.yaml
- name: riak
container-checks:
image-check:
- riak
port-check:
- 8098
Validate
Go to Resources under the Infrastructure tab to check if your resources are onboarded and the metrics are collected.
Metrics
| OpsRamp Metric | Metric Display Name | Unit | Description |
|---|---|---|---|
| riak_memory_atom | Memory Atom | bytes | Total amount of memory currently allocated for atom storage |
| riak_memory_atom_used | Memory Atom Used | bytes | Total amount of memory currently used for atom storage |
| riak_memory_binary | Memory Binary | bytes | Total amount of memory used for binaries |
| riak_memory_code | Memory Code | bytes | Total amount of memory allocated for Erlang code |
| riak_memory_ets | Memory Ets | bytes | Total memory allocated for Erlang Term Storage |
| riak_memory_processes | Memory Processes | bytes | Total amount of memory allocated for Erlang processes |
| riak_memory_processes_used | Memory Processes Used | bytes | Total amount of memory used by Erlang processes |
| riak_memory_total | Memory Total | bytes | Total allocated memory (sum of processes and system) |
| riak_node_get_fsm_active_60s | Node Get Fsm Active 60S | Number of active GET FSMs | |
| riak_node_get_fsm_in_rate | Node Get Fsm In Rate | Average number of GET FSMs enqueued by Sidejob | |
| riak_node_get_fsm_out_rate | Node Get Fsm Out Rate | Average number of GET FSMs dequeued by Sidejob | |
| riak_node_get_fsm_rejected_60s | Node Get Fsm Rejected 60S | Number of GET FSMs actively being rejected by Sidejob's overload protection | |
| riak_node_gets | Node Gets | Operations | Number of GETs coordinated by this node |
| riak_node_put_fsm_active_60s | Node Put Fsm Active 60S | Number of active PUT FSMs | |
| riak_node_put_fsm_in_rate | Node Put Fsm In Rate | Average number of PUT FSMs enqueued by Sidejob | |
| riak_node_put_fsm_out_rate | Node Put Fsm Out Rate | Average number of PUT FSMs dequeued by Sidejob | |
| riak_node_put_fsm_rejected_60s | Node Put Fsm Rejected 60S | Number of PUT FSMs actively being rejected by Sidejob's overload protection | |
| riak_node_puts | Node Puts | Operations | Number of PUTs coordinated by this node |
| riak_pbc_active | Pbc Active | Connections | Number of active protocol buffers connections |
| riak_pbc_connects | Pbc Connects | Connections | Number of protocol buffers connections |
| riak_read_repairs | Read Repairs | Operations | Number of read repair operations this this node has coordinated in the last minute |
| riak_vnode_gets | Vnode Gets | Operations | Number of GET operations coordinated by vnodes on this node |
| riak_vnode_index_deletes | Vnode Index Deletes | Operations | Number of vnode index delete operations |
| riak_vnode_index_reads | Vnode Index Reads | Reads | Number of vnode index read operations |
| riak_vnode_index_writes | Vnode Index Writes | Writes | Number of vnode index write operations |
| riak_vnode_puts | Vnode Puts | Operations | Number of PUT operations coordinated by vnodes on this node |
| riak_node_get_fsm_objsize_mean | Node Get Fsm Objsize Mean | bytes | Object size encountered by this node |
| riak_node_get_fsm_siblings_mean | Node Get Fsm Siblings Mean | Nodes | Number of siblings encountered during all GET operations by this node |
| riak_node_get_fsm_time_mean | Node Get Fsm Time Mean | microseconds | Time between reception of client GET request and subsequent response to client |
| riak_node_put_fsm_time_mean | Node Put Fsm Time Mean | microseconds | Time between reception of client PUT request and subsequent response to client |
| riak_node_get_fsm_objsize_median | Node Get Fsm Objsize Median | bytes | Object size encountered by this node |
| riak_node_get_fsm_siblings_median | Node Get Fsm Siblings Median | Nodes | Number of siblings encountered during all GET operations by this node |
| riak_node_get_fsm_time_median | Node Get Fsm Time Median | microseconds | Time between reception of client GET request and subsequent response to client |
| riak_node_put_fsm_time_median | Node Put Fsm Time Median | microseconds | Time between reception of client PUT request and subsequent response to client |
| riak_node_get_fsm_objsize_95 | Node Get Fsm Objsize 95 | bytes | Object size encountered by this node |
| riak_node_get_fsm_siblings_95 | Node Get Fsm Siblings 95 | Nodes | Number of siblings encountered during all GET operations by this node |
| riak_node_get_fsm_time_95 | Node Get Fsm Time 95 | microseconds | Time between reception of client GET request and subsequent response to client |
| riak_node_put_fsm_time_95 | Node Put Fsm Time 95 | microseconds | Time between reception of client PUT request and subsequent response to client |
| riak_node_get_fsm_objsize_99 | Node Get Fsm Objsize 99 | bytes | Object size encountered by this node |
| riak_node_get_fsm_siblings_99 | Node Get Fsm Siblings 99 | Nodes | Number of siblings encountered during all GET operations by this node |
| riak_node_get_fsm_time_99 | Node Get Fsm Time 99 | microseconds | Time between reception of client GET request and subsequent response to client |
| riak_node_put_fsm_time_99 | Node Put Fsm Time 99 | microseconds | Time between reception of client PUT request and subsequent response to client |
| riak_node_get_fsm_objsize_100 | Node Get Fsm Objsize 100 | bytes | Object size encountered by this node |
| riak_node_get_fsm_siblings_100 | Node Get Fsm Siblings 100 | Nodes | Number of siblings encountered during all GET operations by this node |
| riak_node_get_fsm_time_100 | Node Get Fsm Time 100 | microseconds | Time between reception of client GET request and subsequent response to client |
| riak_node_put_fsm_time_100 | Node Put Fsm Time 100 | microseconds | Time between reception of client PUT request and subsequent response to client |
| riak_search_index_fail_count | Search Index Fail Count | Objects | Total number of documents that have failed to index |
| riak_search_index_fail_one | Search Index Fail One | Objects | Number of documents that have failed to index in the past one minute |
| riak_search_query_fail_count | Search Query Fail Count | Events | Total number of queries that have failed |
| riak_search_query_fail_one | Search Query Fail One | Events | Number of queries that have failed in the last one minute |
| riak_search_index_throughput_count | Search Index Throughput Count | Operations | Total number of documents that have been indexed |
| riak_search_index_throughput_one | Search Index Throughput One | Operations | Number of documents that have been indexed in the last one minute |
| riak_search_query_throughput_count | Search Query Throughput Count | Operations | Total number of queries that have been performed |
| riak_search_query_throughput_one | Search Query Throughput One | Operations | Number of searches that have been performed in the last one minute |
| riak_search_query_latency_95 | Search Query Latency 95 | microseconds | Time between reception of query and response: 95th percentile |
| riak_search_query_latency_99 | Search Query Latency 99 | microseconds | Time between reception of query and response: 99th percentile |
| riak_search_query_latency_999 | Search Query Latency 999 | microseconds | Time between reception of query and response: 99.9th percentile |
| riak_search_query_latency_max | Search Query Latency Max | microseconds | Time between reception of query and response: max |
| riak_search_query_latency_min | Search Query Latency Min | microseconds | Time between reception of query and response: min |
| riak_search_query_latency_mean | Search Query Latency Mean | microseconds | Time between reception of query and response: mean |
| riak_search_query_latency_median | Search Query Latency Median | microseconds | Time between reception of query and response: median |
| riak_search_index_latency_95 | Search Index Latency 95 | microseconds | Time between insertion of document and it being indexed: 95th percentile |
| riak_search_index_latency_99 | Search Index Latency 99 | microseconds | Time between insertion of document and it being indexed: 99th percentile |
| riak_search_index_latency_999 | Search Index Latency 999 | microseconds | Time between insertion of document and it being indexed: 99.9th percentile |
| riak_search_index_latency_max | Search Index Latency Max | microseconds | Time between insertion of document and it being indexed: max |
| riak_search_index_latency_min | Search Index Latency Min | microseconds | Time between insertion of document and it being indexed: min |
| riak_search_index_latency_mean | Search Index Latency Mean | microseconds | Time between insertion of document and it being indexed: mean |
| riak_search_index_latency_median | Search Index Latency Median | microseconds | Time between insertion of document and it being indexed: median |
| riak_vnode_gets_total | Vnode Gets Total | per second | Total number of GETs coordinated by local vnodes |
| riak_node_gets_total | Node Gets Total | per second | Total number of GETs coordinated by this node, including GETs to non-local vnodes |
| riak_node_puts_total | Node Puts Total | per second | Total number of PUTs coordinated by this node, including PUTs to non-local vnodes |
| riak_riak_kv_vnodes_running | Riak Kv Vnodes Running | ||
| riak_ring_num_partitions | Ring Num Partitions | The number of partitions in the ring | |
| riak_precommit_fail | Precommit Fail | per second | Total number of pre-commit hook failures |
| riak_vnode_index_deletes_total | Vnode Index Deletes Total | per second | Total number of local replicas participating in secondary index deletes |
| riak_riak_pipe_vnodes_running | Riak Pipe Vnodes Running | ||
| riak_pipeline_create_count | Pipeline Create Count | per second | The total number of pipelines created since the node was started |
| riak_vnode_puts_total | Vnode Puts Total | per second | Total number of PUTS coordinated by local vnodes |
| riak_read_repairs_total | Read Repairs Total | per second | Total number of Read Repairs this node has coordinated |
| riak_postcommit_fail | Postcommit Fail | per second | Total number of post-commit hook failures |
| riak_pipeline_create_error_count | Pipeline Create Error Count | per second | The total number of pipeline creation errors since the node was started |
| riak_coord_redirs_total | Coord Redirs Total | per second | Total number of requests this node has redirected to other nodes for coordination |
| riak_sys_process_count | Sys Process Count | Number of processes currently running in the Erlang VM | |
| riak_pipeline_active | Pipeline Active | Number of pipelines active in the last 60 seconds | |
| riak_vnode_index_reads_total | Vnode Index Reads Total | per second | Total number of local replicas participating in secondary index reads |
| riak_vnode_index_writes_total | Vnode Index Writes Total | per second | Total number of local replicas participating in secondary index writes |