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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
|
# -*- coding: utf-8 -*-
# Description: riak netdata python.d module
#
# See also:
# https://docs.riak.com/riak/kv/latest/using/reference/statistics-monitoring/index.html
from json import loads
from bases.FrameworkServices.UrlService import UrlService
# Riak updates the metrics at the /stats endpoint every 1 second.
# If we use `update_every = 1` here, that means we might get weird jitter in the graph,
# so the default is set to 2 seconds to prevent it.
update_every = 2
# charts order (can be overridden if you want less charts, or different order)
ORDER = [
# Throughput metrics
# https://docs.riak.com/riak/kv/latest/using/reference/statistics-monitoring/index.html#throughput-metrics
# Collected in totals.
"kv.node_operations", # K/V node operations.
"dt.vnode_updates", # Data type vnode updates.
"search.queries", # Search queries on the node.
"search.documents", # Documents indexed by Search.
"consistent.operations", # Consistent node operations.
# Latency metrics
# https://docs.riak.com/riak/kv/latest/using/reference/statistics-monitoring/index.html#throughput-metrics
# Collected for the past minute in milliseconds,
# returned from riak in microseconds.
"kv.latency.get", # K/V GET FSM traversal latency.
"kv.latency.put", # K/V PUT FSM traversal latency.
"dt.latency.counter", # Update Counter Data type latency.
"dt.latency.set", # Update Set Data type latency.
"dt.latency.map", # Update Map Data type latency.
"search.latency.query", # Search query latency.
"search.latency.index", # Time it takes for search to index a new document.
"consistent.latency.get", # Strong consistent read latency.
"consistent.latency.put", # Strong consistent write latency.
# Erlang resource usage metrics
# https://docs.riak.com/riak/kv/latest/using/reference/statistics-monitoring/index.html#erlang-resource-usage-metrics
# Processes collected as a gauge,
# memory collected as Megabytes, returned as bytes from Riak.
"vm.processes", # Number of processes currently running in the Erlang VM.
"vm.memory.processes", # Total amount of memory allocated & used for Erlang processes.
# General Riak Load / Health metrics
# https://docs.riak.com/riak/kv/latest/using/reference/statistics-monitoring/index.html#general-riak-load-health-metrics
# The following are collected by Riak over the past minute:
"kv.siblings_encountered.get", # Siblings encountered during GET operations by this node.
"kv.objsize.get", # Object size encountered by this node.
"search.vnodeq_size", # Number of unprocessed messages in the vnode message queues (Search).
# The following are calculated in total, or as gauges:
"search.index_errors", # Errors of the search subsystem while indexing documents.
"core.pbc", # Number of currently active protocol buffer connections.
"core.repairs", # Total read repair operations coordinated by this node.
"core.fsm_active", # Active finite state machines by kind.
"core.fsm_rejected", # Rejected finite state machines by kind.
# General Riak Search Load / Health metrics
# https://docs.riak.com/riak/kv/latest/using/reference/statistics-monitoring/index.html#general-riak-search-load-health-metrics
# Reported as counters.
"search.errors", # Write and read errors of the Search subsystem.
]
CHARTS = {
# Throughput metrics
"kv.node_operations": {
"options": [None, "Reads & writes coordinated by this node", "operations/s", "throughput", "riak.kv.throughput",
"line"],
"lines": [
["node_gets_total", "gets", "incremental"],
["node_puts_total", "puts", "incremental"]
]
},
"dt.vnode_updates": {
"options": [None, "Update operations coordinated by local vnodes by data type", "operations/s", "throughput",
"riak.dt.vnode_updates", "line"],
"lines": [
["vnode_counter_update_total", "counters", "incremental"],
["vnode_set_update_total", "sets", "incremental"],
["vnode_map_update_total", "maps", "incremental"],
]
},
"search.queries": {
"options": [None, "Search queries on the node", "queries/s", "throughput", "riak.search", "line"],
"lines": [
["search_query_throughput_count", "queries", "incremental"]
]
},
"search.documents": {
"options": [None, "Documents indexed by search", "documents/s", "throughput", "riak.search.documents", "line"],
"lines": [
["search_index_throughput_count", "indexed", "incremental"]
]
},
"consistent.operations": {
"options": [None, "Consistent node operations", "operations/s", "throughput", "riak.consistent.operations",
"line"],
"lines": [
["consistent_gets_total", "gets", "incremental"],
["consistent_puts_total", "puts", "incremental"],
]
},
# Latency metrics
"kv.latency.get": {
"options": [None, "Time between reception of a client GET request and subsequent response to client", "ms",
"latency", "riak.kv.latency.get", "line"],
"lines": [
["node_get_fsm_time_mean", "mean", "absolute", 1, 1000],
["node_get_fsm_time_median", "median", "absolute", 1, 1000],
["node_get_fsm_time_95", "95", "absolute", 1, 1000],
["node_get_fsm_time_99", "99", "absolute", 1, 1000],
["node_get_fsm_time_100", "100", "absolute", 1, 1000],
]
},
"kv.latency.put": {
"options": [None, "Time between reception of a client PUT request and subsequent response to client", "ms",
"latency", "riak.kv.latency.put", "line"],
"lines": [
["node_put_fsm_time_mean", "mean", "absolute", 1, 1000],
["node_put_fsm_time_median", "median", "absolute", 1, 1000],
["node_put_fsm_time_95", "95", "absolute", 1, 1000],
["node_put_fsm_time_99", "99", "absolute", 1, 1000],
["node_put_fsm_time_100", "100", "absolute", 1, 1000],
]
},
"dt.latency.counter": {
"options": [None, "Time it takes to perform an Update Counter operation", "ms", "latency",
"riak.dt.latency.counter_merge", "line"],
"lines": [
["object_counter_merge_time_mean", "mean", "absolute", 1, 1000],
["object_counter_merge_time_median", "median", "absolute", 1, 1000],
["object_counter_merge_time_95", "95", "absolute", 1, 1000],
["object_counter_merge_time_99", "99", "absolute", 1, 1000],
["object_counter_merge_time_100", "100", "absolute", 1, 1000],
]
},
"dt.latency.set": {
"options": [None, "Time it takes to perform an Update Set operation", "ms", "latency",
"riak.dt.latency.set_merge", "line"],
"lines": [
["object_set_merge_time_mean", "mean", "absolute", 1, 1000],
["object_set_merge_time_median", "median", "absolute", 1, 1000],
["object_set_merge_time_95", "95", "absolute", 1, 1000],
["object_set_merge_time_99", "99", "absolute", 1, 1000],
["object_set_merge_time_100", "100", "absolute", 1, 1000],
]
},
"dt.latency.map": {
"options": [None, "Time it takes to perform an Update Map operation", "ms", "latency",
"riak.dt.latency.map_merge", "line"],
"lines": [
["object_map_merge_time_mean", "mean", "absolute", 1, 1000],
["object_map_merge_time_median", "median", "absolute", 1, 1000],
["object_map_merge_time_95", "95", "absolute", 1, 1000],
["object_map_merge_time_99", "99", "absolute", 1, 1000],
["object_map_merge_time_100", "100", "absolute", 1, 1000],
]
},
"search.latency.query": {
"options": [None, "Search query latency", "ms", "latency", "riak.search.latency.query", "line"],
"lines": [
["search_query_latency_median", "median", "absolute", 1, 1000],
["search_query_latency_min", "min", "absolute", 1, 1000],
["search_query_latency_95", "95", "absolute", 1, 1000],
["search_query_latency_99", "99", "absolute", 1, 1000],
["search_query_latency_999", "999", "absolute", 1, 1000],
["search_query_latency_max", "max", "absolute", 1, 1000],
]
},
"search.latency.index": {
"options": [None, "Time it takes Search to index a new document", "ms", "latency", "riak.search.latency.index",
"line"],
"lines": [
["search_index_latency_median", "median", "absolute", 1, 1000],
["search_index_latency_min", "min", "absolute", 1, 1000],
["search_index_latency_95", "95", "absolute", 1, 1000],
["search_index_latency_99", "99", "absolute", 1, 1000],
["search_index_latency_999", "999", "absolute", 1, 1000],
["search_index_latency_max", "max", "absolute", 1, 1000],
]
},
# Riak Strong Consistency metrics
"consistent.latency.get": {
"options": [None, "Strongly consistent read latency", "ms", "latency", "riak.consistent.latency.get", "line"],
"lines": [
["consistent_get_time_mean", "mean", "absolute", 1, 1000],
["consistent_get_time_median", "median", "absolute", 1, 1000],
["consistent_get_time_95", "95", "absolute", 1, 1000],
["consistent_get_time_99", "99", "absolute", 1, 1000],
["consistent_get_time_100", "100", "absolute", 1, 1000],
]
},
"consistent.latency.put": {
"options": [None, "Strongly consistent write latency", "ms", "latency", "riak.consistent.latency.put", "line"],
"lines": [
["consistent_put_time_mean", "mean", "absolute", 1, 1000],
["consistent_put_time_median", "median", "absolute", 1, 1000],
["consistent_put_time_95", "95", "absolute", 1, 1000],
["consistent_put_time_99", "99", "absolute", 1, 1000],
["consistent_put_time_100", "100", "absolute", 1, 1000],
]
},
# BEAM metrics
"vm.processes": {
"options": [None, "Total processes running in the Erlang VM", "total", "vm", "riak.vm", "line"],
"lines": [
["sys_process_count", "processes", "absolute"],
]
},
"vm.memory.processes": {
"options": [None, "Memory allocated & used by Erlang processes", "MB", "vm", "riak.vm.memory.processes",
"line"],
"lines": [
["memory_processes", "allocated", "absolute", 1, 1024 * 1024],
["memory_processes_used", "used", "absolute", 1, 1024 * 1024]
]
},
# General Riak Load/Health metrics
"kv.siblings_encountered.get": {
"options": [None, "Number of siblings encountered during GET operations by this node during the past minute",
"siblings", "load", "riak.kv.siblings_encountered.get", "line"],
"lines": [
["node_get_fsm_siblings_mean", "mean", "absolute"],
["node_get_fsm_siblings_median", "median", "absolute"],
["node_get_fsm_siblings_95", "95", "absolute"],
["node_get_fsm_siblings_99", "99", "absolute"],
["node_get_fsm_siblings_100", "100", "absolute"],
]
},
"kv.objsize.get": {
"options": [None, "Object size encountered by this node during the past minute", "KB", "load",
"riak.kv.objsize.get", "line"],
"lines": [
["node_get_fsm_objsize_mean", "mean", "absolute", 1, 1024],
["node_get_fsm_objsize_median", "median", "absolute", 1, 1024],
["node_get_fsm_objsize_95", "95", "absolute", 1, 1024],
["node_get_fsm_objsize_99", "99", "absolute", 1, 1024],
["node_get_fsm_objsize_100", "100", "absolute", 1, 1024],
]
},
"search.vnodeq_size": {
"options": [None,
"Number of unprocessed messages in the vnode message queues of Search on this node in the past minute",
"messages", "load", "riak.search.vnodeq_size", "line"],
"lines": [
["riak_search_vnodeq_mean", "mean", "absolute"],
["riak_search_vnodeq_median", "median", "absolute"],
["riak_search_vnodeq_95", "95", "absolute"],
["riak_search_vnodeq_99", "99", "absolute"],
["riak_search_vnodeq_100", "100", "absolute"],
]
},
"search.index_errors": {
"options": [None, "Number of document index errors encountered by Search", "errors", "load",
"riak.search.index", "line"],
"lines": [
["search_index_fail_count", "errors", "absolute"]
]
},
"core.pbc": {
"options": [None, "Protocol buffer connections by status", "connections", "load",
"riak.core.protobuf_connections", "line"],
"lines": [
["pbc_active", "active", "absolute"],
# ["pbc_connects", "established_pastmin", "absolute"]
]
},
"core.repairs": {
"options": [None, "Number of repair operations this node has coordinated", "repairs", "load",
"riak.core.repairs", "line"],
"lines": [
["read_repairs", "read", "absolute"]
]
},
"core.fsm_active": {
"options": [None, "Active finite state machines by kind", "fsms", "load", "riak.core.fsm_active", "line"],
"lines": [
["node_get_fsm_active", "get", "absolute"],
["node_put_fsm_active", "put", "absolute"],
["index_fsm_active", "secondary index", "absolute"],
["list_fsm_active", "list keys", "absolute"]
]
},
"core.fsm_rejected": {
# Writing "Sidejob's" here seems to cause some weird issues: it results in this chart being rendered in
# its own context and additionally, moves the entire Riak graph all the way up to the top of the Netdata
# dashboard for some reason.
"options": [None, "Finite state machines being rejected by Sidejobs overload protection", "fsms", "load",
"riak.core.fsm_rejected", "line"],
"lines": [
["node_get_fsm_rejected", "get", "absolute"],
["node_put_fsm_rejected", "put", "absolute"]
]
},
# General Riak Search Load / Health metrics
"search.errors": {
"options": [None, "Number of writes to Search failed due to bad data format by reason", "writes", "load",
"riak.search.index", "line"],
"lines": [
["search_index_bad_entry_count", "bad_entry", "absolute"],
["search_index_extract_fail_count", "extract_fail", "absolute"],
]
}
}
class Service(UrlService):
def __init__(self, configuration=None, name=None):
UrlService.__init__(self, configuration=configuration, name=name)
self.order = ORDER
self.definitions = CHARTS
def _get_data(self):
"""
Format data received from http request
:return: dict
"""
raw = self._get_raw_data()
if not raw:
return None
try:
return loads(raw)
except (TypeError, ValueError) as err:
self.error(err)
return None
|
