github.com/netdata/go.d.plugin@v0.58.1/modules/vernemq/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-vernemq 5 plugin_name: go.d.plugin 6 module_name: vernemq 7 monitored_instance: 8 name: VerneMQ 9 link: https://vernemq.com 10 icon_filename: vernemq.svg 11 categories: 12 - data-collection.message-brokers 13 keywords: 14 - vernemq 15 - message brokers 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: false 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors VerneMQ instances. 26 method_description: "" 27 supported_platforms: 28 include: [] 29 exclude: [] 30 multi_instance: true 31 additional_permissions: 32 description: "" 33 default_behavior: 34 auto_detection: 35 description: "" 36 limits: 37 description: "" 38 performance_impact: 39 description: "" 40 setup: 41 prerequisites: 42 list: [] 43 configuration: 44 file: 45 name: go.d/vernemq.conf 46 options: 47 description: | 48 The following options can be defined globally: update_every, autodetection_retry. 49 folding: 50 title: Config options 51 enabled: true 52 list: 53 - name: update_every 54 description: Data collection frequency. 55 default_value: 1 56 required: false 57 - name: autodetection_retry 58 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 59 default_value: 0 60 required: false 61 - name: url 62 description: Server URL. 63 default_value: http://127.0.0.1:8888/metrics 64 required: true 65 - name: timeout 66 description: HTTP request timeout. 67 default_value: 1 68 required: false 69 - name: username 70 description: Username for basic HTTP authentication. 71 default_value: "" 72 required: false 73 - name: password 74 description: Password for basic HTTP authentication. 75 default_value: "" 76 required: false 77 - name: proxy_url 78 description: Proxy URL. 79 default_value: "" 80 required: false 81 - name: proxy_username 82 description: Username for proxy basic HTTP authentication. 83 default_value: "" 84 required: false 85 - name: proxy_password 86 description: Password for proxy basic HTTP authentication. 87 default_value: "" 88 required: false 89 - name: method 90 description: HTTP request method. 91 default_value: GET 92 required: false 93 - name: body 94 description: HTTP request body. 95 default_value: "" 96 required: false 97 - name: headers 98 description: HTTP request headers. 99 default_value: "" 100 required: false 101 - name: not_follow_redirects 102 description: Redirect handling policy. Controls whether the client follows redirects. 103 default_value: false 104 required: false 105 - name: tls_skip_verify 106 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 107 default_value: false 108 required: false 109 - name: tls_ca 110 description: Certification authority that the client uses when verifying the server's certificates. 111 default_value: "" 112 required: false 113 - name: tls_cert 114 description: Client TLS certificate. 115 default_value: "" 116 required: false 117 - name: tls_key 118 description: Client TLS key. 119 default_value: "" 120 required: false 121 examples: 122 folding: 123 title: Config 124 enabled: true 125 list: 126 - name: Basic 127 description: An example configuration. 128 config: | 129 jobs: 130 - name: local 131 url: http://127.0.0.1:8888/metrics 132 - name: HTTP authentication 133 description: Local instance with basic HTTP authentication. 134 config: | 135 jobs: 136 - name: local 137 url: http://127.0.0.1:8888/metrics 138 username: username 139 password: password 140 - name: Multi-instance 141 description: | 142 > **Note**: When you define multiple jobs, their names must be unique. 143 144 Local and remote instances. 145 config: | 146 jobs: 147 - name: local 148 url: http://127.0.0.1:8888/metrics 149 150 - name: remote 151 url: http://203.0.113.10:8888/metrics 152 troubleshooting: 153 problems: 154 list: [] 155 alerts: 156 - name: vernemq_socket_errors 157 metric: vernemq.socket_errors 158 info: number of socket errors in the last minute 159 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 160 - name: vernemq_queue_message_drop 161 metric: vernemq.queue_undelivered_messages 162 info: number of dropped messaged due to full queues in the last minute 163 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 164 - name: vernemq_queue_message_expired 165 metric: vernemq.queue_undelivered_messages 166 info: number of messages which expired before delivery in the last minute 167 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 168 - name: vernemq_queue_message_unhandled 169 metric: vernemq.queue_undelivered_messages 170 info: "number of unhandled messages (connections with clean session=true) in the last minute" 171 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 172 - name: vernemq_average_scheduler_utilization 173 metric: vernemq.average_scheduler_utilization 174 info: average scheduler utilization over the last 10 minutes 175 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 176 - name: vernemq_cluster_dropped 177 metric: vernemq.cluster_dropped 178 info: amount of traffic dropped during communication with the cluster nodes in the last minute 179 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 180 - name: vernemq_netsplits 181 metric: vvernemq.netsplits 182 info: "number of detected netsplits (split brain situation) in the last minute" 183 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 184 - name: vernemq_mqtt_connack_sent_reason_unsuccessful 185 metric: vernemq.mqtt_connack_sent_reason 186 info: number of sent unsuccessful v3/v5 CONNACK packets in the last minute 187 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 188 - name: vernemq_mqtt_disconnect_received_reason_not_normal 189 metric: vernemq.mqtt_disconnect_received_reason 190 info: number of received not normal v5 DISCONNECT packets in the last minute 191 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 192 - name: vernemq_mqtt_disconnect_sent_reason_not_normal 193 metric: vernemq.mqtt_disconnect_sent_reason 194 info: number of sent not normal v5 DISCONNECT packets in the last minute 195 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 196 - name: vernemq_mqtt_subscribe_error 197 metric: vernemq.mqtt_subscribe_error 198 info: number of failed v3/v5 SUBSCRIBE operations in the last minute 199 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 200 - name: vernemq_mqtt_subscribe_auth_error 201 metric: vernemq.mqtt_subscribe_auth_error 202 info: number of unauthorized v3/v5 SUBSCRIBE attempts in the last minute 203 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 204 - name: vernemq_mqtt_unsubscribe_error 205 metric: vernemq.mqtt_unsubscribe_error 206 info: number of failed v3/v5 UNSUBSCRIBE operations in the last minute 207 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 208 - name: vernemq_mqtt_publish_errors 209 metric: vernemq.mqtt_publish_errors 210 info: number of failed v3/v5 PUBLISH operations in the last minute 211 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 212 - name: vernemq_mqtt_publish_auth_errors 213 metric: vernemq.mqtt_publish_auth_errors 214 info: number of unauthorized v3/v5 PUBLISH attempts in the last minute 215 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 216 - name: vernemq_mqtt_puback_received_reason_unsuccessful 217 metric: vernemq.mqtt_puback_received_reason 218 info: number of received unsuccessful v5 PUBACK packets in the last minute 219 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 220 - name: vernemq_mqtt_puback_sent_reason_unsuccessful 221 metric: vernemq.mqtt_puback_sent_reason 222 info: number of sent unsuccessful v5 PUBACK packets in the last minute 223 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 224 - name: vernemq_mqtt_puback_unexpected 225 metric: vernemq.mqtt_puback_invalid_error 226 info: number of received unexpected v3/v5 PUBACK packets in the last minute 227 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 228 - name: vernemq_mqtt_pubrec_received_reason_unsuccessful 229 metric: vernemq.mqtt_pubrec_received_reason 230 info: number of received unsuccessful v5 PUBREC packets in the last minute 231 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 232 - name: vernemq_mqtt_pubrec_sent_reason_unsuccessful 233 metric: vernemq.mqtt_pubrec_sent_reason 234 info: number of sent unsuccessful v5 PUBREC packets in the last minute 235 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 236 - name: vernemq_mqtt_pubrec_invalid_error 237 metric: vernemq.mqtt_pubrec_invalid_error 238 info: number of received unexpected v3 PUBREC packets in the last minute 239 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 240 - name: vernemq_mqtt_pubrel_received_reason_unsuccessful 241 metric: vernemq.mqtt_pubrel_received_reason 242 info: number of received unsuccessful v5 PUBREL packets in the last minute 243 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 244 - name: vernemq_mqtt_pubrel_sent_reason_unsuccessful 245 metric: vernemq.mqtt_pubrel_sent_reason 246 info: number of sent unsuccessful v5 PUBREL packets in the last minute 247 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 248 - name: vernemq_mqtt_pubcomp_received_reason_unsuccessful 249 metric: vernemq.mqtt_pubcomp_received_reason 250 info: number of received unsuccessful v5 PUBCOMP packets in the last minute 251 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 252 - name: vernemq_mqtt_pubcomp_sent_reason_unsuccessful 253 metric: vernemq.mqtt_pubcomp_sent_reason 254 info: number of sent unsuccessful v5 PUBCOMP packets in the last minute 255 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 256 - name: vernemq_mqtt_pubcomp_unexpected 257 metric: vernemq.mqtt_pubcomp_invalid_error 258 info: number of received unexpected v3/v5 PUBCOMP packets in the last minute 259 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf 260 metrics: 261 folding: 262 title: Metrics 263 enabled: false 264 description: "" 265 availability: [] 266 scopes: 267 - name: global 268 description: These metrics refer to the entire monitored application. 269 labels: [] 270 metrics: 271 - name: vernemq.sockets 272 description: Open Sockets 273 unit: sockets 274 chart_type: line 275 dimensions: 276 - name: open 277 - name: vernemq.socket_operations 278 description: Socket Open and Close Events 279 unit: sockets/s 280 chart_type: line 281 dimensions: 282 - name: open 283 - name: close 284 - name: vernemq.client_keepalive_expired 285 description: Closed Sockets due to Keepalive Time Expired 286 unit: sockets/s 287 chart_type: line 288 dimensions: 289 - name: closed 290 - name: vernemq.socket_close_timeout 291 description: Closed Sockets due to no CONNECT Frame On Time 292 unit: sockets/s 293 chart_type: line 294 dimensions: 295 - name: closed 296 - name: vernemq.socket_errors 297 description: Socket Errors 298 unit: errors/s 299 chart_type: line 300 dimensions: 301 - name: errors 302 - name: vernemq.queue_processes 303 description: Living Queues in an Online or an Offline State 304 unit: queue processes 305 chart_type: line 306 dimensions: 307 - name: queue_processes 308 - name: vernemq.queue_processes_operations 309 description: Queue Processes Setup and Teardown Events 310 unit: events/s 311 chart_type: line 312 dimensions: 313 - name: setup 314 - name: teardown 315 - name: vernemq.queue_process_init_from_storage 316 description: Queue Processes Initialized from Offline Storage 317 unit: queue processes/s 318 chart_type: line 319 dimensions: 320 - name: queue_processes 321 - name: vernemq.queue_messages 322 description: Received and Sent PUBLISH Messages 323 unit: messages/s 324 chart_type: area 325 dimensions: 326 - name: received 327 - name: sent 328 - name: vernemq.queue_undelivered_messages 329 description: Undelivered PUBLISH Messages 330 unit: messages/s 331 chart_type: stacked 332 dimensions: 333 - name: dropped 334 - name: expired 335 - name: unhandled 336 - name: vernemq.router_subscriptions 337 description: Subscriptions in the Routing Table 338 unit: subscriptions 339 chart_type: line 340 dimensions: 341 - name: subscriptions 342 - name: vernemq.router_matched_subscriptions 343 description: Matched Subscriptions 344 unit: subscriptions/s 345 chart_type: line 346 dimensions: 347 - name: local 348 - name: remote 349 - name: vernemq.router_memory 350 description: Routing Table Memory Usage 351 unit: KiB 352 chart_type: area 353 dimensions: 354 - name: used 355 - name: vernemq.average_scheduler_utilization 356 description: Average Scheduler Utilization 357 unit: percentage 358 chart_type: area 359 dimensions: 360 - name: utilization 361 - name: vernemq.system_utilization_scheduler 362 description: Scheduler Utilization 363 unit: percentage 364 chart_type: stacked 365 dimensions: 366 - name: a dimension per scheduler 367 - name: vernemq.system_processes 368 description: Erlang Processes 369 unit: processes 370 chart_type: line 371 dimensions: 372 - name: processes 373 - name: vernemq.system_reductions 374 description: Reductions 375 unit: ops/s 376 chart_type: line 377 dimensions: 378 - name: reductions 379 - name: vernemq.system_context_switches 380 description: Context Switches 381 unit: ops/s 382 chart_type: line 383 dimensions: 384 - name: context_switches 385 - name: vernemq.system_io 386 description: Received and Sent Traffic through Ports 387 unit: kilobits/s 388 chart_type: area 389 dimensions: 390 - name: received 391 - name: sent 392 - name: vernemq.system_run_queue 393 description: Processes that are Ready to Run on All Run-Queues 394 unit: processes 395 chart_type: line 396 dimensions: 397 - name: ready 398 - name: vernemq.system_gc_count 399 description: GC Count 400 unit: ops/s 401 chart_type: line 402 dimensions: 403 - name: gc 404 - name: vernemq.system_gc_words_reclaimed 405 description: GC Words Reclaimed 406 unit: ops/s 407 chart_type: line 408 dimensions: 409 - name: words_reclaimed 410 - name: vernemq.system_allocated_memory 411 description: Memory Allocated by the Erlang Processes and by the Emulator 412 unit: KiB 413 chart_type: stacked 414 dimensions: 415 - name: processes 416 - name: system 417 - name: vernemq.bandwidth 418 description: Bandwidth 419 unit: kilobits/s 420 chart_type: area 421 dimensions: 422 - name: received 423 - name: sent 424 - name: vernemq.retain_messages 425 description: Stored Retained Messages 426 unit: messages 427 chart_type: line 428 dimensions: 429 - name: messages 430 - name: vernemq.retain_memory 431 description: Stored Retained Messages Memory Usage 432 unit: KiB 433 chart_type: area 434 dimensions: 435 - name: used 436 - name: vernemq.cluster_bandwidth 437 description: Communication with Other Cluster Nodes 438 unit: kilobits/s 439 chart_type: area 440 dimensions: 441 - name: received 442 - name: sent 443 - name: vernemq.cluster_dropped 444 description: Traffic Dropped During Communication with Other Cluster Nodes 445 unit: kilobits/s 446 chart_type: area 447 dimensions: 448 - name: dropped 449 - name: vernemq.netsplit_unresolved 450 description: Unresolved Netsplits 451 unit: netsplits 452 chart_type: line 453 dimensions: 454 - name: unresolved 455 - name: vernemq.netsplits 456 description: Netsplits 457 unit: netsplits/s 458 chart_type: stacked 459 dimensions: 460 - name: resolved 461 - name: detected 462 - name: vernemq.mqtt_auth 463 description: v5 AUTH 464 unit: packets/s 465 chart_type: line 466 dimensions: 467 - name: received 468 - name: sent 469 - name: vernemq.mqtt_auth_received_reason 470 description: v5 AUTH Received by Reason 471 unit: packets/s 472 chart_type: stacked 473 dimensions: 474 - name: a dimensions per reason 475 - name: vernemq.mqtt_auth_sent_reason 476 description: v5 AUTH Sent by Reason 477 unit: packets/s 478 chart_type: stacked 479 dimensions: 480 - name: a dimensions per reason 481 - name: vernemq.mqtt_connect 482 description: v3/v5 CONNECT and CONNACK 483 unit: packets/s 484 chart_type: line 485 dimensions: 486 - name: connect 487 - name: connack 488 - name: vernemq.mqtt_connack_sent_reason 489 description: v3/v5 CONNACK Sent by Reason 490 unit: packets/s 491 chart_type: stacked 492 dimensions: 493 - name: a dimensions per reason 494 - name: vernemq.mqtt_disconnect 495 description: v3/v5 DISCONNECT 496 unit: packets/s 497 chart_type: line 498 dimensions: 499 - name: received 500 - name: sent 501 - name: vernemq.mqtt_disconnect_received_reason 502 description: v5 DISCONNECT Received by Reason 503 unit: packets/s 504 chart_type: stacked 505 dimensions: 506 - name: a dimensions per reason 507 - name: vernemq.mqtt_disconnect_sent_reason 508 description: v5 DISCONNECT Sent by Reason 509 unit: packets/s 510 chart_type: stacked 511 dimensions: 512 - name: a dimensions per reason 513 - name: vernemq.mqtt_subscribe 514 description: v3/v5 SUBSCRIBE and SUBACK 515 unit: packets/s 516 chart_type: line 517 dimensions: 518 - name: subscribe 519 - name: suback 520 - name: vernemq.mqtt_subscribe_error 521 description: v3/v5 Failed SUBSCRIBE Operations due to a Netsplit 522 unit: ops/s 523 chart_type: line 524 dimensions: 525 - name: failed 526 - name: vernemq.mqtt_subscribe_auth_error 527 description: v3/v5 Unauthorized SUBSCRIBE Attempts 528 unit: attempts/s 529 chart_type: line 530 dimensions: 531 - name: unauth 532 - name: vernemq.mqtt_unsubscribe 533 description: v3/v5 UNSUBSCRIBE and UNSUBACK 534 unit: packets/s 535 chart_type: line 536 dimensions: 537 - name: unsubscribe 538 - name: unsuback 539 - name: vernemq.mqtt_unsubscribe 540 description: v3/v5 Failed UNSUBSCRIBE Operations due to a Netsplit 541 unit: ops/s 542 chart_type: line 543 dimensions: 544 - name: mqtt_unsubscribe_error 545 - name: vernemq.mqtt_publish 546 description: v3/v5 QoS 0,1,2 PUBLISH 547 unit: packets/s 548 chart_type: line 549 dimensions: 550 - name: received 551 - name: sent 552 - name: vernemq.mqtt_publish_errors 553 description: v3/v5 Failed PUBLISH Operations due to a Netsplit 554 unit: ops/s 555 chart_type: line 556 dimensions: 557 - name: failed 558 - name: vernemq.mqtt_publish_auth_errors 559 description: v3/v5 Unauthorized PUBLISH Attempts 560 unit: attempts/s 561 chart_type: area 562 dimensions: 563 - name: unauth 564 - name: vernemq.mqtt_puback 565 description: v3/v5 QoS 1 PUBACK 566 unit: packets/s 567 chart_type: line 568 dimensions: 569 - name: received 570 - name: sent 571 - name: vernemq.mqtt_puback_received_reason 572 description: v5 PUBACK QoS 1 Received by Reason 573 unit: packets/s 574 chart_type: stacked 575 dimensions: 576 - name: a dimensions per reason 577 - name: vernemq.mqtt_puback_sent_reason 578 description: v5 PUBACK QoS 1 Sent by Reason 579 unit: packets/s 580 chart_type: stacked 581 dimensions: 582 - name: a dimensions per reason 583 - name: vernemq.mqtt_puback_invalid_error 584 description: v3/v5 PUBACK QoS 1 Received Unexpected Messages 585 unit: messages/s 586 chart_type: line 587 dimensions: 588 - name: unexpected 589 - name: vernemq.mqtt_pubrec 590 description: v3/v5 PUBREC QoS 2 591 unit: packets/s 592 chart_type: line 593 dimensions: 594 - name: received 595 - name: sent 596 - name: vernemq.mqtt_pubrec_received_reason 597 description: v5 PUBREC QoS 2 Received by Reason 598 unit: packets/s 599 chart_type: stacked 600 dimensions: 601 - name: a dimensions per reason 602 - name: vernemq.mqtt_pubrec_sent_reason 603 description: v5 PUBREC QoS 2 Sent by Reason 604 unit: packets/s 605 chart_type: stacked 606 dimensions: 607 - name: a dimensions per reason 608 - name: vernemq.mqtt_pubrec_invalid_error 609 description: v3 PUBREC QoS 2 Received Unexpected Messages 610 unit: messages/s 611 chart_type: line 612 dimensions: 613 - name: unexpected 614 - name: vernemq.mqtt_pubrel 615 description: v3/v5 PUBREL QoS 2 616 unit: packets/s 617 chart_type: line 618 dimensions: 619 - name: received 620 - name: sent 621 - name: vernemq.mqtt_pubrel_received_reason 622 description: v5 PUBREL QoS 2 Received by Reason 623 unit: packets/s 624 chart_type: stacked 625 dimensions: 626 - name: a dimensions per reason 627 - name: vernemq.mqtt_pubrel_sent_reason 628 description: v5 PUBREL QoS 2 Sent by Reason 629 unit: packets/s 630 chart_type: stacked 631 dimensions: 632 - name: a dimensions per reason 633 - name: vernemq.mqtt_pubcom 634 description: v3/v5 PUBCOMP QoS 2 635 unit: packets/s 636 chart_type: line 637 dimensions: 638 - name: received 639 - name: sent 640 - name: vernemq.mqtt_pubcomp_received_reason 641 description: v5 PUBCOMP QoS 2 Received by Reason 642 unit: packets/s 643 chart_type: stacked 644 dimensions: 645 - name: a dimensions per reason 646 - name: vernemq.mqtt_pubcomp_sent_reason 647 description: v5 PUBCOMP QoS 2 Sent by Reason 648 unit: packets/s 649 chart_type: stacked 650 dimensions: 651 - name: a dimensions per reason 652 - name: vernemq.mqtt_pubcomp_invalid_error 653 description: v3/v5 PUBCOMP QoS 2 Received Unexpected Messages 654 unit: messages/s 655 chart_type: line 656 dimensions: 657 - name: unexpected 658 - name: vernemq.mqtt_ping 659 description: v3/v5 PING 660 unit: packets/s 661 chart_type: line 662 dimensions: 663 - name: pingreq 664 - name: pingresp 665 - name: vernemq.node_uptime 666 description: Node Uptime 667 unit: seconds 668 chart_type: line 669 dimensions: 670 - name: time