VerneMQ
Plugin: go.d.plugin Module: vernemq
Overview
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.
Default Behavior
Auto-Detection
This integration doesn't support auto-detection.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
You can configure the vernemq collector in two ways:
| Method | Best for | How to |
|---|---|---|
| UI | Fast setup without editing files | Go to Nodes → Configure this node → Collectors → Jobs, search for vernemq, then click + to add a job. |
| File | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit go.d/vernemq.conf and add a job. |
important
UI configuration requires paid Netdata Cloud plan.
Prerequisites
No action required.
Configuration
Options
The following options can be defined globally: update_every, autodetection_retry.
Config options
| Group | Option | Description | Default | Required |
|---|---|---|---|---|
| Collection | update_every | Data collection interval (seconds). | 1 | no |
| autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no | |
| Target | url | Target endpoint URL. | http://127.0.0.1:8888/metrics | yes |
| timeout | HTTP request timeout (seconds). | 1 | no | |
| HTTP Auth | username | Username for Basic HTTP authentication. | no | |
| password | Password for Basic HTTP authentication. | no | ||
| bearer_token_file | Path to a file containing a bearer token (used for Authorization: Bearer). | no | ||
| TLS | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
| tls_ca | Path to CA bundle used to validate the server certificate. | no | ||
| tls_cert | Path to client TLS certificate (for mTLS). | no | ||
| tls_key | Path to client TLS private key (for mTLS). | no | ||
| Proxy | proxy_url | HTTP proxy URL. | no | |
| proxy_username | Username for proxy Basic HTTP authentication. | no | ||
| proxy_password | Password for proxy Basic HTTP authentication. | no | ||
| Request | method | HTTP method to use. | GET | no |
| body | Request body (e.g., for POST/PUT). | no | ||
| headers | Additional HTTP headers (one per line as key: value). | no | ||
| not_follow_redirects | Do not follow HTTP redirects. | no | no | |
| force_http2 | Force HTTP/2 (including h2c over TCP). | no | no | |
| Virtual Node | vnode | Associates this data collection job with a Virtual Node. | no |
via UI
Configure the vernemq collector from the Netdata web interface:
- Go to Nodes.
- Select the node where you want the vernemq data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
- The Collectors → Jobs view opens by default.
- In the Search box, type vernemq (or scroll the list) to locate the vernemq collector.
- Click the + next to the vernemq collector to add a new job.
- Fill in the job fields, then click Test to verify the configuration and Submit to save.
- Test runs the job with the provided settings and shows whether data can be collected.
- If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
via File
The configuration file name for this integration is go.d/vernemq.conf.
The file format is YAML. Generally, the structure is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/vernemq.conf
Examples
Basic
An example configuration.
Config
jobs:
- name: local
url: http://127.0.0.1:8888/metrics
HTTP authentication
Local instance with basic HTTP authentication.
Config
jobs:
- name: local
url: http://127.0.0.1:8888/metrics
username: username
password: password
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Local and remote instances.
Config
jobs:
- name: local
url: http://127.0.0.1:8888/metrics
- name: remote
url: http://203.0.113.10:8888/metrics
Alerts
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| vernemq_socket_errors | vernemq.node_socket_errors | Node ${label:node} socket errors in the last minute |
| vernemq_queue_message_drop | vernemq.node_queue_undelivered_messages | Node ${label:node} dropped messages due to full queues in the last minute |
| vernemq_queue_message_expired | vernemq.node_queue_undelivered_messages | Node ${label:node} expired before delivery messages in the last minute |
| vernemq_queue_message_unhandled | vernemq.node_queue_undelivered_messages | Node ${label:node} unhandled messages in the last minute |
| vernemq_average_scheduler_utilization | vernemq.node_average_scheduler_utilization | Node ${label:node} scheduler utilization over the last 10 minutes |
| vernemq_cluster_dropped | vernemq.node_cluster_dropped | Node ${label:node} traffic dropped during communication with the cluster nodes in the last minute |
| vernemq_netsplits | vernemq.node_netsplits | Node ${label:node} detected netsplits (split brain) in the last minute |
| vernemq_mqtt_connack_sent_reason_unsuccessful | vernemq.node_mqtt_connack_sent_by_reason_code | Node ${label:node} unsuccessful sent v5 CONNACK packets in the last minute |
| vernemq_mqtt_disconnect_received_reason_not_normal | vernemq.node_mqtt_disconnect_received_by_reason_code | Node ${label:node} received not normal v5 DISCONNECT packets in the last minute |
| vernemq_mqtt_disconnect_sent_reason_not_normal | vernemq.node_mqtt_disconnect_sent_by_reason_code | Node ${label:node} sent not normal v5 DISCONNECT packets in the last minute |
| vernemq_mqtt_subscribe_error | vernemq.node_mqtt_subscribe_error | Node ${label:node} mqtt v${label:mqtt_version} failed SUBSCRIBE operations in the last minute |
| vernemq_mqtt_subscribe_auth_error | vernemq.node_mqtt_subscribe_auth_error | Node ${label:node} mqtt v${label:mqtt_version} unauthorized SUBSCRIBE attempts in the last minute |
| vernemq_mqtt_unsubscribe_error | vernemq.node_mqtt_unsubscribe_error | Node ${label:node} mqtt v${label:mqtt_version} failed UNSUBSCRIBE operations in the last minute |
| vernemq_mqtt_publish_errors | vernemq.node_mqtt_publish_errors | Node ${label:node} mqtt v${label:mqtt_version} failed PUBLISH operations in the last minute |
| vernemq_mqtt_publish_auth_errors | vernemq.node_mqtt_publish_auth_errors | Node ${label:node} mqtt v${label:mqtt_version} unauthorized PUBLISH attempts in the last minute |
| vernemq_mqtt_puback_received_reason_unsuccessful | vernemq.node_mqtt_puback_received_by_reason_code | Node ${label:node} mqtt v5 received unsuccessful PUBACK packets in the last minute |
| vernemq_mqtt_puback_sent_reason_unsuccessful | vernemq.node_mqtt_puback_sent_by_reason_code | Node ${label:node} mqtt v5 unsuccessful sent PUBACK packets in the last minute |
| vernemq_mqtt_puback_unexpected | vernemq.node_mqtt_puback_invalid_error | Node ${label:node} mqtt v${label:mqtt_version} received unexpected PUBACK messages in the last minute |
| vernemq_mqtt_pubrec_received_reason_unsuccessful | vernemq.node_mqtt_pubrec_received_by_reason_code | Node ${label:node} mqtt v5 received unsuccessful PUBREC packets in the last minute |
| vernemq_mqtt_pubrec_sent_reason_unsuccessful | vernemq.node_mqtt_pubrec_sent_by_reason_code | Node ${label:node} mqtt v5 unsuccessful sent PUBREC packets in the last minute |
| vernemq_mqtt_pubrec_invalid_error | vernemq.node_mqtt_pubrec_invalid_error | Node ${label:node} mqtt v${label:mqtt_version} received invalid PUBREC packets in the last minute |
| vernemq_mqtt_pubrel_received_reason_unsuccessful | vernemq.node_mqtt_pubrel_received_by_reason_code | Node ${label:node} mqtt v5 received unsuccessful PUBREL packets in the last minute |
| vernemq_mqtt_pubrel_sent_reason_unsuccessful | vernemq.node_mqtt_pubrel_sent_by_reason_code | Node ${label:node} mqtt v5 unsuccessful sent PUBREL packets in the last minute |
| vernemq_mqtt_pubcomp_received_reason_unsuccessful | vernemq.node_mqtt_pubcomp_received_by_reason_code | Node ${label:node} mqtt v5 received unsuccessful PUBCOMP packets in the last minute |
| vernemq_mqtt_pubcomp_sent_reason_unsuccessful | vernemq.node_mqtt_pubcomp_sent_by_reason_code | Node ${label:node} mqtt v5 unsuccessful sent PUBCOMP packets in the last minute |
| vernemq_mqtt_pubcomp_unexpected | vernemq.node_mqtt_pubcomp_invalid_error | Node ${label:node} mqtt v${label:mqtt_version} received unexpected PUBCOMP packets in the last minute |
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per node
These metrics refer to the VerneMQ node.
Labels:
| Label | Description |
|---|---|
| node | The value of this label is identical to the value of the "node" label exposed by VerneMQ. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| vernemq.node_socket | Open Sockets | open | sockets |
| vernemq.node_socket_operations | Socket Open and Close Events | open, close | sockets/s |
| vernemq.node_client_keepalive_expired | Closed Sockets due to Keepalive Time Expired | closed | sockets/s |
| vernemq.node_socket_close_timeout | Closed Sockets due to no CONNECT Frame On Time | closed | sockets/s |
| vernemq.node_socket_errors | Socket Errors | errors | errors/s |
| vernemq.node_queue_processes | Living Queues in an Online or an Offline State | queue_processes | queue processes |
| vernemq.node_queue_processes_operations | Queue Processes Setup and Teardown Events | setup, teardown | events/s |
| vernemq.node_queue_process_init_from_storage | Queue Processes Initialized from Offline Storage | queue_processes | queue processes/s |
| vernemq.node_queue_messages | Received and Sent PUBLISH Messages | received, sent | messages/s |
| vernemq.node_queued_messages | Queued PUBLISH Messages | queued | messages |
| vernemq.node_queue_undelivered_messages | Undelivered PUBLISH Messages | dropped, expired, unhandled | messages/s |
| vernemq.node_router_subscriptions | Subscriptions in the Routing Table | subscriptions | subscriptions |
| vernemq.node_router_matched_subscriptions | Matched Subscriptions | local, remote | subscriptions/s |
| vernemq.node_router_memory | Routing Table Memory Usage | used | bytes |
| vernemq.node_average_scheduler_utilization | Average Scheduler Utilization | utilization | percentage |
| vernemq.node_system_processes | Erlang Processes | processes | processes |
| vernemq.node_system_reductions | Reductions | reductions | ops/s |
| vernemq.node_system_context_switches | Context Switches | context_switches | ops/s |
| vernemq.node_system_io | Received and Sent Traffic through Ports | received, sent | bytes/s |
| vernemq.node_system_run_queue | Processes that are Ready to Run on All Run-Queues | ready | processes |
| vernemq.node_system_gc_count | GC Count | gc | ops/s |
| vernemq.node_system_gc_words_reclaimed | GC Words Reclaimed | words_reclaimed | ops/s |
| vernemq.node_system_allocated_memory | Memory Allocated by the Erlang Processes and by the Emulator | processes, system | bytes |
| vernemq.node_traffic | Traffic | received, sent | bytes/s |
| vernemq.node_retain_messages | Stored Retained Messages | messages | messages |
| vernemq.node_retain_memory | Stored Retained Messages Memory Usage | used | bytes |
| vernemq.node_cluster_traffic | Communication with Other Cluster Nodes | received, sent | bytes/s |
| vernemq.node_cluster_dropped | Traffic Dropped During Communication with Other Cluster Nodes | dropped | bytes/s |
| vernemq.node_netsplit_unresolved | Unresolved Netsplits | unresolved | netsplits |
| vernemq.node_netsplits | Netsplits | resolved, detected | netsplits/s |
| vernemq.node_uptime | Node Uptime | time | seconds |
Per mqtt
These metrics are specific to the used MQTT protocol version.
Labels:
| Label | Description |
|---|---|
| node | The value of this label is identical to the value of the "node" label exposed by VerneMQ. |
| mqtt_version | MQTT version. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| vernemq.node_mqtt_auth | MQTT AUTH Packets | received, sent | packets/s |
| vernemq.node_mqtt_auth_received_by_reason_code | MQTT AUTH Received by Reason | success, continue_authentication, reauthenticate | packets/s |
| vernemq.node_mqtt_auth_sent_by_reason_code | MQTT AUTH Sent by Reason | success, continue_authentication, reauthenticate | packets/s |
| vernemq.node_mqtt_connect | MQTT CONNECT and CONNACK | connect, connack | packets/s |
| vernemq.node_mqtt_connack_sent_by_return_code | MQTT CONNACK Sent by Return Code | success, unsupported_protocol_version, client_identifier_not_valid, server_unavailable, bad_username_or_password, not_authorized | packets/s |
| vernemq.node_mqtt_connack_sent_by_reason_code | MQTT CONNACK Sent by Reason | success, unspecified_error, malformed_packet, protocol_error, impl_specific_error, unsupported_protocol_version, client_identifier_not_valid, bad_username_or_password, not_authorized, server_unavailable, server_busy, banned, bad_authentication_method, topic_name_invalid, packet_too_large, quota_exceeded, payload_format_invalid, retain_not_supported, qos_not_supported, use_another_server, server_moved, connection_rate_exceeded | packets/s |
| vernemq.node_mqtt_disconnect | MQTT DISCONNECT Packets | received, sent | packets/s |
| vernemq.node_mqtt_disconnect_received_by_reason_code | MQTT DISCONNECT Received by Reason | normal_disconnect, disconnect_with_will_msg, unspecified_error, malformed_packet, protocol_error, impl_specific_error, topic_name_invalid, receive_max_exceeded, topic_alias_invalid, packet_too_large, message_rate_too_high, quota_exceeded, administrative_action, payload_format_invalid | packets/s |
| node_mqtt_disconnect_sent_by_reason_code | MQTT DISCONNECT Sent by Reason | normal_disconnect, unspecified_error, malformed_packet, protocol_error, impl_specific_error, not_authorized, server_busy, server_shutting_down, keep_alive_timeout, session_taken_over, topic_filter_invalid, topic_name_invalid, receive_max_exceeded, topic_alias_invalid, packet_too_large, message_rate_too_high, quota_exceeded, administrative_action, payload_format_invalid, retain_not_supported, qos_not_supported, use_another_server, server_moved, shared_subs_not_supported, connection_rate_exceeded, max_connect_time, subscription_ids_not_supported, wildcard_subs_not_supported | packets/s |
| vernemq.node_mqtt_subscribe | MQTT SUBSCRIBE and SUBACK Packets | subscribe, suback | packets/s |
| vernemq.node_mqtt_subscribe_error | MQTT Failed SUBSCRIBE Operations due to a Netsplit | subscribe | errors/s |
| vernemq.node_mqtt_subscribe_auth_error | MQTT Unauthorized SUBSCRIBE Attempts | subscribe_auth | errors/s |
| vernemq.node_mqtt_unsubscribe | MQTT UNSUBSCRIBE and UNSUBACK Packets | unsubscribe, unsuback | packets/s |
| vernemq.node_mqtt_unsubscribe_error | MQTT Failed UNSUBSCRIBE Operations due to a Netsplit | unsubscribe | errors/s |
| vernemq.node_mqtt_publish | MQTT QoS 0,1,2 PUBLISH | received, sent | packets/s |
| vernemq.node_mqtt_publish_errors | MQTT Failed PUBLISH Operations due to a Netsplit | publish | errors/s |
| vernemq.node_mqtt_publish_auth_errors | MQTT Unauthorized PUBLISH Attempts | publish_auth | errors/s |
| vernemq.node_mqtt_puback | vMQTT QoS 1 PUBACK Packets | received, sent | packets/s |
| vernemq.node_mqtt_puback_received_by_reason_code | MQTT PUBACK QoS 1 Received by Reason | success, no_matching_subscribers, unspecified_error, impl_specific_error, not_authorized, topic_name_invalid, packet_id_in_use, quota_exceeded, payload_format_invalid | packets/s |
| vernemq.node_mqtt_puback_sent_by_reason_code | MQTT PUBACK QoS 1 Sent by Reason | success, no_matching_subscribers, unspecified_error, impl_specific_error, not_authorized, topic_name_invalid, packet_id_in_use, quota_exceeded, payload_format_invalid | packets/s |
| vernemq.node_mqtt_puback_invalid_error | MQTT PUBACK QoS 1 Received Unexpected Messages | unexpected | messages/s |
| vernemq.node_mqtt_pubrec | MQTT PUBREC QoS 2 Packets | received, sent | packets/s |
| vernemq.node_mqtt_pubrec_received_by_reason_code | MQTT PUBREC QoS 2 Received by Reason | success, no_matching_subscribers, unspecified_error, impl_specific_error, not_authorized, topic_name_invalid, packet_id_in_use, quota_exceeded, payload_format_invalid | packets/s |
| vernemq.node_mqtt_pubrec_sent_by_reason_code | MQTT PUBREC QoS 2 Sent by Reason | success, no_matching_subscribers, unspecified_error, impl_specific_error, not_authorized, topic_name_invalid, packet_id_in_use, quota_exceeded, payload_format_invalid | packets/s |
| vernemq.node_mqtt_pubrec_invalid_error | MQTT PUBREC QoS 2 Received Unexpected Messages | unexpected | messages/s |
| vernemq.node_mqtt_pubrel | MQTT PUBREL QoS 2 Packets | received, sent | packets/s |
| vernemq.node_mqtt_pubrel_received_by_reason_code | MQTT PUBREL QoS 2 Received by Reason | success, packet_id_not_found | packets/s |
| vernemq.node_mqtt_pubrel_sent_by_reason_code | MQTT PUBREL QoS 2 Sent by Reason | success, packet_id_not_found | packets/s |
| vernemq.node_mqtt_pubcomp | MQTT PUBCOMP QoS 2 Packets | received, sent | packets/s |
| vernemq.node_mqtt_pubcomp_received_by_reason_code | MQTT PUBCOMP QoS 2 Received by Reason | success, packet_id_not_found | packets/s |
| vernemq.node_mqtt_pubcomp_sent_by_reason_cod | MQTT PUBCOMP QoS 2 Sent by Reason | success, packet_id_not_found | packets/s |
| vernemq.node_mqtt_pubcomp_invalid_error | MQTT PUBCOMP QoS 2 Received Unexpected Messages | unexpected | messages/s |
| vernemq.node_mqtt_ping | MQTT PING Packets | pingreq, pingresp | packets/s |
Troubleshooting
Debug Mode
Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
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.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that's not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m vernemqTo debug a specific job:
./go.d.plugin -d -m vernemq -j jobName
Getting Logs
If you're encountering problems with the vernemq collector, follow these steps to retrieve logs and identify potential issues:
- Run the command specific to your system (systemd, non-systemd, or Docker container).
- Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
System with systemd
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep vernemq
System without systemd
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:
grep vernemq /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
Docker Container
If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
docker logs netdata 2>&1 | grep vernemq
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.