Monitoring Riak

This article will help you get the Riak plugin for sd-agent configured and returning metrics

Installing the riak plugin package

Install the riak plugin on Debian/Ubuntu:

sudo apt-get install sd-agent-riak

Install the riak plugin on RHEL/CentOS:

sudo yum install sd-agent-riak

Read more about agent plugins.

Configuring the agent to monitor Riak

1. Configure /etc/sd-agent/conf.d/riak.yaml

init_config:

instances:
  - url: http://127.0.0.1:8098/stats

2. Restart the agent

sudo /etc/init.d/sd-agent restart

or

sudo systemctl restart sd-agent

Verifying the configuration
Execute info to verify the configuration with the following:

sudo /etc/init.d/sd-agent info 

or

/usr/share/python/sd-agent/agent.py info

If the agent has been configured correctly you'll see an output such as:

riak
-----
  - instance #0 [OK]
  - Collected * metrics

You can also view the metrics returned with the following command:

sudo -u sd-agent /usr/share/python/sd-agent/agent.py check riak

Configuring graphs

Click the name of your server from the Devices list in your Server Density account then go to the Metrics tab. Click the + Graph button on the right then choose the riak metrics to display the graphs. The metrics will also be available to select when building dashboard graphs.

Monitored metrics

Metric	Values
riak.memory_atom	/ Type: float
riak.memory_atom_used	/ Type: float
riak.memory_binary	/ Type: float
riak.memory_code	/ Type: float
riak.memory_ets	/ Type: float
riak.memory_processes	/ Type: float
riak.memory_processes_used	/ Type: float
riak.memory_total	/ Type: float
riak.node_get_fsm_active_60s	/ Type: float
riak.node_get_fsm_in_rate	/ Type: float
riak.node_get_fsm_objsize_100	/ Type: float
riak.node_get_fsm_objsize_95	/ Type: float
riak.node_get_fsm_objsize_99	/ Type: float
riak.node_get_fsm_objsize_mean	/ Type: float
riak.node_get_fsm_objsize_median	/ Type: float
riak.node_get_fsm_out_rate Average number of GET FSMs dequeued by Sidejob	None / None Type: float
riak.node_get_fsm_rejected_60s Number of GET FSMs actively being rejected by Sidejob's overload protection	None / None Type: float
riak.node_get_fsm_siblings_100	/ Type: float
riak.node_get_fsm_siblings_95	/ Type: float
riak.node_get_fsm_siblings_99	/ Type: float
riak.node_get_fsm_siblings_mean	/ Type: float
riak.node_get_fsm_siblings_median	/ Type: float
riak.node_get_fsm_time_100	/ Type: float
riak.node_get_fsm_time_95	/ Type: float
riak.node_get_fsm_time_99	/ Type: float
riak.node_get_fsm_time_mean	/ Type: float
riak.node_get_fsm_time_median	/ Type: float
riak.node_gets	/ Type: float
riak.node_put_fsm_active_60s	/ Type: float
riak.node_put_fsm_in_rate	/ Type: float
riak.node_put_fsm_out_rate	/ Type: float
riak.node_put_fsm_rejected_60s	/ Type: float
riak.node_put_fsm_time_100	/ Type: float
riak.node_put_fsm_time_95	/ Type: float
riak.node_put_fsm_time_99	/ Type: float
riak.node_put_fsm_time_mean	/ Type: float
riak.node_put_fsm_time_median	/ Type: float
riak.node_puts	/ Type: float
riak.pbc_active	/ Type: float
riak.pbc_connects	/ Type: float
riak.read_repairs	/ Type: float
riak.search_index_fail_count Total number of documents that have failed to index	object / None Type: float
riak.search_index_fail_one Number of documents that have failed to index in the past one minute	object / None Type: float
riak.search_index_latency_95 Time between insertion of document and it being indexed: 95th percentile	microsecond / None Type: float
riak.search_index_latency_99 Time between insertion of document and it being indexed: 99th percentile	microsecond / None Type: float
riak.search_index_latency_999 Time between insertion of document and it being indexed: 99.9th percentile	microsecond / None Type: float
riak.search_index_latency_max Time between insertion of document and it being indexed: max	microsecond / None Type: float
riak.search_index_latency_mean Time between insertion of document and it being indexed: mean	microsecond / None Type: float
riak.search_index_latency_median Time between insertion of document and it being indexed: median	microsecond / None Type: float
riak.search_index_latency_min Time between insertion of document and it being indexed: min	microsecond / None Type: float
riak.search_index_throughput_count Total number of documents that have been indexed	operation / None Type: float
riak.search_index_throughput_one Number of documents that have been indexed in the last one minute	operation / None Type: float
riak.search_query_fail_count Total number of queries that have failed	event / None Type: float
riak.search_query_fail_one Number of queries that have failed in the last one minute	event / None Type: float
riak.search_query_latency_95 Time between reception of query and response: 95th percentile	microsecond / None Type: float
riak.search_query_latency_99 Time between reception of query and response: 99th percentile	microsecond / None Type: float
riak.search_query_latency_999 Time between reception of query and response: 99.9th percentile	microsecond / None Type: float
riak.search_query_latency_max Time between reception of query and response: max	microsecond / None Type: float
riak.search_query_latency_mean Time between reception of query and response: mean	microsecond / None Type: float
riak.search_query_latency_median Time between reception of query and response: median	microsecond / None Type: float
riak.search_query_latency_min Time between reception of query and response: min	microsecond / None Type: float
riak.search_query_throughput_count Total number of queries that have been performed	operation / None Type: float
riak.search_query_throughput_one Number of searches that have been performed in the last one minute	operation / None Type: float
riak.vnode_gets	/ Type: float
riak.vnode_index_deletes	/ Type: float
riak.vnode_index_reads	/ Type: float
riak.vnode_index_writes	/ Type: float
riak.vnode_puts	/ Type: float

Metrics Conversion

Please refer to the metrics conversion document to map old metrics names to the new metric names.