Project: Netdata (Observability and Analysis / Observability)
File: vernemq.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/vernemq/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/vernemq/metadata.yaml" sidebar_label: "VerneMQ" learn_status: "Published" learnrelpath: "Collecting Metrics/Message Brokers" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/vernemq.svg" width="150"/> Plugin: go.d.plugin Module: vernemq <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors VerneMQ instances. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | vernemq.sockets | open | sockets | | vernemq.socket_operations | open, close | sockets/s | | vernemq.clientkeepaliveexpired | closed | sockets/s | | vernemq.socketclosetimeout | closed | sockets/s | | vernemq.socket_errors | errors | errors/s | | vernemq.queueprocesses | queueprocesses | queue processes | | vernemq.queueprocessesoperations | setup, teardown | events/s | | vernemq.queueprocessinitfromstorage | queue_processes | queue processes/s | | vernemq.queue_messages | received, sent | messages/s | | vernemq.queueundeliveredmessages | dropped, expired, unhandled | messages/s | | vernemq.router_subscriptions | subscriptions | subscriptions | | vernemq.routermatchedsubscriptions | local, remote | subscriptions/s | | vernemq.router_memory | used | KiB | | vernemq.averageschedulerutilization | utilization | percentage | | vernemq.systemutilizationscheduler | a dimension per scheduler | percentage | | vernemq.system_processes | processes | processes | | vernemq.system_reductions | reductions | ops/s | | vernemq.systemcontextswitches | context_switches | ops/s | | vernemq.system_io | received, sent | kilobits/s | | vernemq.systemrunqueue | ready | processes | | vernemq.systemgccount | gc | ops/s | | vernemq.systemgcwordsreclaimed | wordsreclaimed | ops/s | | vernemq.systemallocatedmemory | processes, system | KiB | | vernemq.bandwidth | received, sent | kilobits/s | | vernemq.retain_messages | messages | messages | | vernemq.retain_memory | used | KiB | | vernemq.cluster_bandwidth | received, sent | kilobits/s | | vernemq.cluster_dropped | dropped | kilobits/s | | vernemq.netsplit_unresolved | unresolved | netsplits | | vernemq.netsplits | resolved, detected | netsplits/s | | vernemq.mqtt_auth | received, sent | packets/s | | vernemq.mqttauthreceived_reason | a dimensions per reason | packets/s | | vernemq.mqttauthsent_reason | a dimensions per reason | packets/s | | vernemq.mqtt_connect | connect, connack | packets/s | | vernemq.mqttconnacksent_reason | a dimensions per reason | packets/s | | vernemq.mqtt_disconnect | received, sent | packets/s | | vernemq.mqttdisconnectreceived_reason | a dimensions per reason | packets/s | | vernemq.mqttdisconnectsent_reason | a dimensions per reason | packets/s | | vernemq.mqtt_subscribe | subscribe, suback | packets/s | | vernemq.mqttsubscribeerror | failed | ops/s | | vernemq.mqttsubscribeauth_error | unauth | attempts/s | | vernemq.mqtt_unsubscribe | unsubscribe, unsuback | packets/s | | vernemq.mqttunsubscribeerror | mqttunsubscribeerror | ops/s | | vernemq.mqtt_publish | received, sent | packets/s | |

| failed | ops/s | | vernemq.mqttpublishauth_errors | unauth | attempts/s | | vernemq.mqtt_puback | received, sent | packets/s | | vernemq.mqttpubackreceived_reason | a dimensions per reason | packets/s | | vernemq.mqttpubacksent_reason | a dimensions per reason | packets/s | | vernemq.mqttpubackinvalid_error | unexpected | messages/s | | vernemq.mqtt_pubrec | received, sent | packets/s | | vernemq.mqttpubrecreceived_reason | a dimensions per reason | packets/s | | vernemq.mqttpubrecsent_reason | a dimensions per reason | packets/s | | vernemq.mqttpubrecinvalid_error | unexpected | messages/s | | vernemq.mqtt_pubrel | received, sent | packets/s | | vernemq.mqttpubrelreceived_reason | a dimensions per reason | packets/s | | vernemq.mqttpubrelsent_reason | a dimensions per reason | packets/s | | vernemq.mqtt_pubcom | received, sent | packets/s | | vernemq.mqttpubcompreceived_reason | a dimensions per reason | packets/s | | vernemq.mqttpubcompsent_reason | a dimensions per reason | packets/s | | vernemq.mqttpubcompinvalid_error | unexpected | messages/s | | vernemq.mqtt_ping | pingreq, pingresp | packets/s | | vernemq.node_uptime | time | seconds | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | vernemq.socket_errors | number of socket errors in the last minute | | | vernemq.queueundeliveredmessages | number of dropped messaged due to full queues in the last minute | | | vernemq.queueundeliveredmessages | number of messages which expired before delivery in the last minute | | | vernemq.queueundeliveredmessages | number of unhandled messages (connections with clean session=true) in the last minute | | | vernemq.averageschedulerutilization | average scheduler utilization over the last 10 minutes | | | vernemq.cluster_dropped | amount of traffic dropped during communication with the cluster nodes in the last minute | | | vvernemq.netsplits | number of detected netsplits (split brain situation) in the last minute | | | vernemq.mqttconnacksent_reason | number of sent unsuccessful v3/v5 CONNACK packets in the last minute | | | vernemq.mqttdisconnectreceived_reason | number of received not normal v5 DISCONNECT packets in the last minute | | | vernemq.mqttdisconnectsent_reason | number of sent not normal v5 DISCONNECT packets in the last minute | | | vernemq.mqttsubscribeerror | number of failed v3/v5 SUBSCRIBE operations in the last minute | | | vernemq.mqttsubscribeauth_error | number of unauthorized v3/v5 SUBSCRIBE attempts in the last minute | | | vernemq.mqttunsubscribeerror | number of failed v3/v5 UNSUBSCRIBE operations in the last minute | | | vernemq.mqttpublisherrors | number of failed v3/v5 PUBLISH operations in the last minute | | | vernemq.mqttpublishauth_errors | number of unauthorized v3/v5 PUBLISH attempts in the last minute | | | vernemq.mqttpubackreceived_reason | number of received unsuccessful v5 PUBACK packets in the last minute | | | vernemq.mqttpubacksent_reason | number of sent unsuccessful v5 PUBACK packets in the last minute | | | vernemq.mqttpubackinvalid_error | number of received unexpected v3/v5 PUBACK packets in the last minute | | | vernemq.mqttpubrecreceived_reason | number of received unsuccessful v5 PUBREC packets in the last minute | | | vernemq.mqttpubrecsent_reason | number of sent unsuccessful v5 PUBREC packets in the last minute | | |

| number of received unexpected v3 PUBREC packets in the last minute | | | vernemq.mqttpubrelreceived_reason | number of received unsuccessful v5 PUBREL packets in the last minute | | | vernemq.mqttpubrelsent_reason | number of sent unsuccessful v5 PUBREL packets in the last minute | | | vernemq.mqttpubcompreceived_reason | number of received unsuccessful v5 PUBCOMP packets in the last minute | | | vernemq.mqttpubcompsent_reason | number of sent unsuccessful v5 PUBCOMP packets in the last minute | | | vernemq.mqttpubcompinvalid_error | number of received unexpected v3/v5 PUBCOMP packets in the last minute | No action required. The configuration file name for this integration is `go.d/vernemq.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/vernemq.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | url | Server URL. | http://127.0.0.1:8888/metrics | yes | | timeout | HTTP request timeout. | 1 | no | | username | Username for basic HTTP authentication. | | no | | password | Password for basic HTTP authentication. | | no | | proxy_url | Proxy URL. | | no | | proxy_username | Username for proxy basic HTTP authentication. | | no | | proxy_password | Password for proxy basic HTTP authentication. | | no | | method | HTTP request method. | GET | no | | body | HTTP request body. | | no | | headers | HTTP request headers. | | no | | notfollowredirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | | tlsskipverify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | | tls_cert | Client TLS certificate. | | no | | tls_key | Client TLS key. | | no | </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1:8888/metrics ``` </details> Local instance with basic HTTP authentication. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1:8888/metrics username: username password: password ``` </details> Note: When you define multiple jobs, their names must be unique. Local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1:8888/metrics name: remote url: http://203.0.113.10:8888/metrics ``` </details> To troubleshoot issues with the `vernemq` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m vernemq ```