| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-riakkv |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: riakkv |
| 7 | monitored_instance: |
| 8 | name: Riak KV |
| 9 | link: https://riak.com/products/riak-kv/index.html |
| 10 | categories: |
| 11 | - data-collection.databases |
| 12 | icon_filename: "riak.svg" |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | alternative_monitored_instances: [] |
| 17 | info_provided_to_referring_integrations: |
| 18 | description: "" |
| 19 | keywords: |
| 20 | - database |
| 21 | - nosql |
| 22 | - big data |
| 23 | overview: |
| 24 | data_collection: |
| 25 | metrics_description: | |
| 26 | This collector monitors RiakKV metrics about throughput, latency, resources and more. |
| 27 | method_description: | |
| 28 | It sends HTTP requests to the Riak [/stats](https://docs.riak.com/riak/kv/2.2.3/developing/api/http/status.1.html) endpoint. |
| 29 | default_behavior: |
| 30 | auto_detection: |
| 31 | description: | |
| 32 | By default, it detects Riak instances running on localhost that are listening on port 8098. |
| 33 | On startup, it tries to collect metrics from: |
| 34 | |
| 35 | - http://127.0.0.1:8098/stats |
| 36 | limits: |
| 37 | description: "" |
| 38 | performance_impact: |
| 39 | description: "" |
| 40 | additional_permissions: |
| 41 | description: "" |
| 42 | multi_instance: true |
| 43 | supported_platforms: |
| 44 | include: [] |
| 45 | exclude: [] |
| 46 | setup: |
| 47 | prerequisites: |
| 48 | list: |
| 49 | - title: Enable /stats endpoint |
| 50 | description: | |
| 51 | See the RiakKV [configuration reference](https://docs.riak.com/riak/kv/2.2.3/developing/api/http/status.1.html). |
| 52 | configuration: |
| 53 | file: |
| 54 | name: go.d/riakkv.conf |
| 55 | options: |
| 56 | description: | |
| 57 | The following options can be defined globally: update_every, autodetection_retry. |
| 58 | folding: |
| 59 | title: Config options |
| 60 | enabled: true |
| 61 | list: |
| 62 | - name: update_every |
| 63 | description: Data collection interval (seconds). |
| 64 | default_value: 2 |
| 65 | required: false |
| 66 | group: Collection |
| 67 | - name: autodetection_retry |
| 68 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 69 | default_value: 0 |
| 70 | required: false |
| 71 | group: Collection |
| 72 | |
| 73 | - name: url |
| 74 | description: Target endpoint URL. |
| 75 | default_value: http://127.0.0.1:8098/stats |
| 76 | required: true |
| 77 | group: Target |
| 78 | - name: timeout |
| 79 | description: HTTP request timeout (seconds). |
| 80 | default_value: 1 |
| 81 | required: false |
| 82 | group: Target |
| 83 | |
| 84 | - name: username |
| 85 | description: Username for Basic HTTP authentication. |
| 86 | default_value: "" |
| 87 | required: false |
| 88 | group: HTTP Auth |
| 89 | - name: password |
| 90 | description: Password for Basic HTTP authentication. |
| 91 | default_value: "" |
| 92 | required: false |
| 93 | group: HTTP Auth |
| 94 | - name: bearer_token_file |
| 95 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 96 | default_value: "" |
| 97 | required: false |
| 98 | group: HTTP Auth |
| 99 | |
| 100 | - name: tls_skip_verify |
| 101 | description: Skip TLS certificate and hostname verification (insecure). |
| 102 | default_value: no |
| 103 | required: false |
| 104 | group: TLS |
| 105 | - name: tls_ca |
| 106 | description: Path to CA bundle used to validate the server certificate. |
| 107 | default_value: "" |
| 108 | required: false |
| 109 | group: TLS |
| 110 | - name: tls_cert |
| 111 | description: Path to client TLS certificate (for mTLS). |
| 112 | default_value: "" |
| 113 | required: false |
| 114 | group: TLS |
| 115 | - name: tls_key |
| 116 | description: Path to client TLS private key (for mTLS). |
| 117 | default_value: "" |
| 118 | required: false |
| 119 | group: TLS |
| 120 | |
| 121 | - name: proxy_url |
| 122 | description: HTTP proxy URL. |
| 123 | default_value: "" |
| 124 | required: false |
| 125 | group: Proxy |
| 126 | - name: proxy_username |
| 127 | description: Username for proxy Basic HTTP authentication. |
| 128 | default_value: "" |
| 129 | required: false |
| 130 | group: Proxy |
| 131 | - name: proxy_password |
| 132 | description: Password for proxy Basic HTTP authentication. |
| 133 | default_value: "" |
| 134 | required: false |
| 135 | group: Proxy |
| 136 | |
| 137 | - name: method |
| 138 | description: HTTP method to use. |
| 139 | default_value: "GET" |
| 140 | required: false |
| 141 | group: Request |
| 142 | - name: body |
| 143 | description: Request body (e.g., for POST/PUT). |
| 144 | default_value: "" |
| 145 | required: false |
| 146 | group: Request |
| 147 | - name: headers |
| 148 | description: "Additional HTTP headers (one per line as key: value)." |
| 149 | default_value: "" |
| 150 | required: false |
| 151 | group: Request |
| 152 | - name: not_follow_redirects |
| 153 | description: Do not follow HTTP redirects. |
| 154 | default_value: no |
| 155 | required: false |
| 156 | group: Request |
| 157 | - name: force_http2 |
| 158 | description: Force HTTP/2 (including h2c over TCP). |
| 159 | default_value: no |
| 160 | required: false |
| 161 | group: Request |
| 162 | |
| 163 | - name: vnode |
| 164 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 165 | default_value: "" |
| 166 | required: false |
| 167 | group: Virtual Node |
| 168 | examples: |
| 169 | folding: |
| 170 | title: Config |
| 171 | enabled: true |
| 172 | list: |
| 173 | - name: Basic |
| 174 | description: A basic example configuration. |
| 175 | folding: |
| 176 | enabled: false |
| 177 | config: | |
| 178 | jobs: |
| 179 | - name: local |
| 180 | url: http://127.0.0.1:8098/stats |
| 181 | - name: HTTP authentication |
| 182 | description: Basic HTTP authentication. |
| 183 | config: | |
| 184 | jobs: |
| 185 | - name: local |
| 186 | url: http://127.0.0.1:8098/stats |
| 187 | username: username |
| 188 | password: password |
| 189 | - name: HTTPS with self-signed certificate |
| 190 | description: With enabled HTTPS and self-signed certificate. |
| 191 | config: | |
| 192 | jobs: |
| 193 | - name: local |
| 194 | url: http://127.0.0.1:8098/stats |
| 195 | tls_skip_verify: yes |
| 196 | - name: Multi-instance |
| 197 | description: | |
| 198 | > **Note**: When you define multiple jobs, their names must be unique. |
| 199 | |
| 200 | Collecting metrics from local and remote instances. |
| 201 | config: | |
| 202 | jobs: |
| 203 | - name: local |
| 204 | url: http://127.0.0.1:8098/stats |
| 205 | |
| 206 | - name: remote |
| 207 | url: http://192.0.2.1:8098/stats |
| 208 | troubleshooting: |
| 209 | problems: |
| 210 | list: [] |
| 211 | alerts: [] |
| 212 | metrics: |
| 213 | folding: |
| 214 | title: Metrics |
| 215 | enabled: false |
| 216 | description: "" |
| 217 | availability: [] |
| 218 | scopes: |
| 219 | - name: global |
| 220 | description: These metrics refer to the entire monitored application. |
| 221 | labels: [] |
| 222 | metrics: |
| 223 | - name: riak.kv.throughput |
| 224 | description: Reads & writes coordinated by this node |
| 225 | unit: "operations/s" |
| 226 | chart_type: line |
| 227 | dimensions: |
| 228 | - name: gets |
| 229 | - name: puts |
| 230 | - name: riak.dt.vnode_updates |
| 231 | description: Update operations coordinated by local vnodes by data type |
| 232 | unit: "operations/s" |
| 233 | chart_type: line |
| 234 | dimensions: |
| 235 | - name: counters |
| 236 | - name: sets |
| 237 | - name: maps |
| 238 | - name: riak.search |
| 239 | description: Search queries on the node |
| 240 | unit: "queries/s" |
| 241 | chart_type: line |
| 242 | dimensions: |
| 243 | - name: queries |
| 244 | - name: riak.search.documents |
| 245 | description: Documents indexed by search |
| 246 | unit: "documents/s" |
| 247 | chart_type: line |
| 248 | dimensions: |
| 249 | - name: indexed |
| 250 | - name: riak.consistent.operations |
| 251 | description: Consistent node operations |
| 252 | unit: "operations/s" |
| 253 | chart_type: line |
| 254 | dimensions: |
| 255 | - name: gets |
| 256 | - name: puts |
| 257 | - name: riak.kv.latency.get |
| 258 | description: Time between reception of a client GET request and subsequent response to client |
| 259 | unit: "ms" |
| 260 | chart_type: line |
| 261 | dimensions: |
| 262 | - name: mean |
| 263 | - name: median |
| 264 | - name: "95" |
| 265 | - name: "99" |
| 266 | - name: "100" |
| 267 | - name: riak.kv.latency.put |
| 268 | description: Time between reception of a client PUT request and subsequent response to client |
| 269 | unit: "ms" |
| 270 | chart_type: line |
| 271 | dimensions: |
| 272 | - name: mean |
| 273 | - name: median |
| 274 | - name: "95" |
| 275 | - name: "99" |
| 276 | - name: "100" |
| 277 | - name: riak.dt.latency.counter_merge |
| 278 | description: Time it takes to perform an Update Counter operation |
| 279 | unit: "ms" |
| 280 | chart_type: line |
| 281 | dimensions: |
| 282 | - name: mean |
| 283 | - name: median |
| 284 | - name: "95" |
| 285 | - name: "99" |
| 286 | - name: "100" |
| 287 | - name: riak.dt.latency.set_merge |
| 288 | description: Time it takes to perform an Update Set operation |
| 289 | unit: "ms" |
| 290 | chart_type: line |
| 291 | dimensions: |
| 292 | - name: mean |
| 293 | - name: median |
| 294 | - name: "95" |
| 295 | - name: "99" |
| 296 | - name: "100" |
| 297 | - name: riak.dt.latency.map_merge |
| 298 | description: Time it takes to perform an Update Map operation |
| 299 | unit: "ms" |
| 300 | chart_type: line |
| 301 | dimensions: |
| 302 | - name: mean |
| 303 | - name: median |
| 304 | - name: "95" |
| 305 | - name: "99" |
| 306 | - name: "100" |
| 307 | - name: riak.search.latency.query |
| 308 | description: Search query latency |
| 309 | unit: "ms" |
| 310 | chart_type: line |
| 311 | dimensions: |
| 312 | - name: median |
| 313 | - name: min |
| 314 | - name: "95" |
| 315 | - name: "99" |
| 316 | - name: "999" |
| 317 | - name: max |
| 318 | - name: riak.search.latency.index |
| 319 | description: Time it takes Search to index a new document |
| 320 | unit: "ms" |
| 321 | chart_type: line |
| 322 | dimensions: |
| 323 | - name: median |
| 324 | - name: min |
| 325 | - name: "95" |
| 326 | - name: "99" |
| 327 | - name: "999" |
| 328 | - name: max |
| 329 | - name: riak.consistent.latency.get |
| 330 | description: Strongly consistent read latency |
| 331 | unit: "ms" |
| 332 | chart_type: line |
| 333 | dimensions: |
| 334 | - name: mean |
| 335 | - name: median |
| 336 | - name: "95" |
| 337 | - name: "99" |
| 338 | - name: "100" |
| 339 | - name: riak.consistent.latency.put |
| 340 | description: Strongly consistent write latency |
| 341 | unit: "ms" |
| 342 | chart_type: line |
| 343 | dimensions: |
| 344 | - name: mean |
| 345 | - name: median |
| 346 | - name: "95" |
| 347 | - name: "99" |
| 348 | - name: "100" |
| 349 | - name: riak.vm |
| 350 | description: Total processes running in the Erlang VM |
| 351 | unit: "total" |
| 352 | chart_type: line |
| 353 | dimensions: |
| 354 | - name: processes |
| 355 | - name: riak.vm.memory.processes |
| 356 | description: Memory allocated & used by Erlang processes |
| 357 | unit: "MB" |
| 358 | chart_type: line |
| 359 | dimensions: |
| 360 | - name: allocated |
| 361 | - name: used |
| 362 | - name: riak.kv.siblings_encountered.get |
| 363 | description: Number of siblings encountered during GET operations by this node during the past minute |
| 364 | unit: "siblings" |
| 365 | chart_type: line |
| 366 | dimensions: |
| 367 | - name: mean |
| 368 | - name: median |
| 369 | - name: "95" |
| 370 | - name: "99" |
| 371 | - name: "100" |
| 372 | - name: riak.kv.objsize.get |
| 373 | description: Object size encountered by this node during the past minute |
| 374 | unit: "KB" |
| 375 | chart_type: line |
| 376 | dimensions: |
| 377 | - name: mean |
| 378 | - name: median |
| 379 | - name: "95" |
| 380 | - name: "99" |
| 381 | - name: "100" |
| 382 | - name: riak.search.vnodeq_size |
| 383 | description: Number of unprocessed messages in the vnode message queues of Search on this node in the past minute |
| 384 | unit: "messages" |
| 385 | chart_type: line |
| 386 | dimensions: |
| 387 | - name: mean |
| 388 | - name: median |
| 389 | - name: "95" |
| 390 | - name: "99" |
| 391 | - name: "100" |
| 392 | - name: riak.search.index |
| 393 | description: Errors encountered by Search |
| 394 | unit: "errors" |
| 395 | chart_type: line |
| 396 | dimensions: |
| 397 | - name: index_fail |
| 398 | - name: bad_entry |
| 399 | - name: extract_fail |
| 400 | - name: riak.core.protobuf_connections |
| 401 | description: Protocol buffer connections by status |
| 402 | unit: "connections" |
| 403 | chart_type: line |
| 404 | dimensions: |
| 405 | - name: active |
| 406 | - name: riak.core.repairs |
| 407 | description: Number of repair operations this node has coordinated |
| 408 | unit: "repairs" |
| 409 | chart_type: line |
| 410 | dimensions: |
| 411 | - name: read |
| 412 | - name: riak.core.fsm_active |
| 413 | description: Active finite state machines by kind |
| 414 | unit: "fsms" |
| 415 | chart_type: line |
| 416 | dimensions: |
| 417 | - name: get |
| 418 | - name: put |
| 419 | - name: secondary index |
| 420 | - name: list keys |
| 421 | - name: riak.core.fsm_rejected |
| 422 | description: Finite state machines being rejected by Sidejobs overload protection |
| 423 | unit: "fsms" |
| 424 | chart_type: line |
| 425 | dimensions: |
| 426 | - name: get |
| 427 | - name: put |