VerneMQ icon

VerneMQ

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

Prerequisites

No action required.

Configuration

File

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 config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/vernemq.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

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
not_follow_redirects Redirect handling policy. Controls whether the client follows redirects. no no
tls_skip_verify 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

Examples

Basic

An example configuration.

jobs:
  - name: local
    url: http://127.0.0.1:8888/metrics
HTTP authentication

Local instance with basic HTTP authentication.

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.

jobs:
  - name: local
    url: http://127.0.0.1:8888/metrics

  - name: remote
    url: http://203.0.113.10:8888/metrics

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 Dimensions Unit
vernemq.node_socket open sockets
vernemq.node_socket_operations open, close sockets/s
vernemq.node_client_keepalive_expired closed sockets/s
vernemq.node_socket_close_timeout closed sockets/s
vernemq.node_socket_errors errors errors/s
vernemq.node_queue_processes queue_processes queue processes
vernemq.node_queue_processes_operations setup, teardown events/s
vernemq.node_queue_process_init_from_storage queue_processes queue processes/s
vernemq.node_queue_messages received, sent messages/s
vernemq.node_queued_messages queued messages
vernemq.node_queue_undelivered_messages dropped, expired, unhandled messages/s
vernemq.node_router_subscriptions subscriptions subscriptions
vernemq.node_router_matched_subscriptions local, remote subscriptions/s
vernemq.node_router_memory used bytes
vernemq.node_average_scheduler_utilization utilization percentage
vernemq.node_system_processes processes processes
vernemq.node_system_reductions reductions ops/s
vernemq.node_system_context_switches context_switches ops/s
vernemq.node_system_io received, sent bytes/s
vernemq.node_system_run_queue ready processes
vernemq.node_system_gc_count gc ops/s
vernemq.node_system_gc_words_reclaimed words_reclaimed ops/s
vernemq.node_system_allocated_memory processes, system bytes
vernemq.node_traffic received, sent bytes/s
vernemq.node_retain_messages messages messages
vernemq.node_retain_memory used bytes
vernemq.node_cluster_traffic received, sent bytes/s
vernemq.node_cluster_dropped dropped bytes/s
vernemq.node_netsplit_unresolved unresolved netsplits
vernemq.node_netsplits resolved, detected netsplits/s
vernemq.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 Dimensions Unit
vernemq.node_mqtt_auth received, sent packets/s
vernemq.node_mqtt_auth_received_by_reason_code success, continue_authentication, reauthenticate packets/s
vernemq.node_mqtt_auth_sent_by_reason_code success, continue_authentication, reauthenticate packets/s
vernemq.node_mqtt_connect connect, connack packets/s
vernemq.node_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 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 received, sent packets/s
vernemq.node_mqtt_disconnect_received_by_reason_code 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 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 subscribe, suback packets/s
vernemq.node_mqtt_subscribe_error subscribe errors/s
vernemq.node_mqtt_subscribe_auth_error subscribe_auth errors/s
vernemq.node_mqtt_unsubscribe unsubscribe, unsuback packets/s
vernemq.node_mqtt_unsubscribe_error unsubscribe errors/s
vernemq.node_mqtt_publish received, sent packets/s
vernemq.node_mqtt_publish_errors publish errors/s
vernemq.node_mqtt_publish_auth_errors publish_auth errors/s
vernemq.node_mqtt_puback received, sent packets/s
vernemq.node_mqtt_puback_received_by_reason_code 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 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 unexpected messages/s
vernemq.node_mqtt_pubrec received, sent packets/s
vernemq.node_mqtt_pubrec_received_by_reason_code 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 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 unexpected messages/s
vernemq.node_mqtt_pubrel received, sent packets/s
vernemq.node_mqtt_pubrel_received_by_reason_code success, packet_id_not_found packets/s
vernemq.node_mqtt_pubrel_sent_by_reason_code success, packet_id_not_found packets/s
vernemq.node_mqtt_pubcomp received, sent packets/s
vernemq.node_mqtt_pubcomp_received_by_reason_code success, packet_id_not_found packets/s
vernemq.node_mqtt_pubcomp_sent_by_reason_cod success, packet_id_not_found packets/s
vernemq.node_mqtt_pubcomp_invalid_error unexpected messages/s
vernemq.node_mqtt_ping pingreq, pingresp packets/s

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

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.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].

    cd /usr/libexec/netdata/plugins.d/

  • Switch to the netdata user.

    sudo -u netdata -s

  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m vernemq

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

The observability platform companies need to succeed

Sign up for free

Want a personalised demo of Netdata for your use case?

Book a Demo