Available Metrics
The following document provides a comprehensive list of all available metrics for Pro Mosquitto, categorized by their types and descriptions. These metrics are essential for monitoring the performance, behavior, and resource usage of the system, offering insights into client sessions, message processing, MQTT packet activity, and more. Additionally, specific broker process-related metrics are included, which are particularly useful when utilizing the Prometheus exporter for in-depth analysis.
These metrics are available for the Prometheus Exporter and the InfluxDB Metrics exporter.
| label | metric type | description |
|---|---|---|
mosquitto_sessions | Gauge | Current client sessions (includes offline clients) |
mosquitto_clients_offline | Gauge | Current offline client count |
mosquitto_clients_online | Gauge | Current online client count |
mosquitto_clients_expired | Counter | Total clients expired due to keepalive |
mosquitto_subscriptions | Gauge | Current subscription count |
mosquitto_shared_subscriptions | Gauge | Current shared subscription count |
mosquitto_retained_messages | Gauge | Current retained message count |
mosquitto_bytes_received | Counter | Total bytes received |
mosquitto_bytes_sent | Counter | Total bytes sent |
mosquitto_pub_bytes_received | Counter | Total PUBLISH payload bytes received |
mosquitto_pub_bytes_sent | Counter | Total PUBLISH payload bytes sent |
mosquitto_message_store_count | Gauge | Current stored message count |
mosquitto_message_store_bytes | Gauge | Current stored message bytes |
mosquitto_out_packets | Gauge | Current queued outgoing packet count (includes offline clients) |
mosquitto_out_packet_bytes | Gauge | Current queued outgoing packet bytes (includes offline clients) |
mosquitto_socket_connections | Counter | Total incoming connections |
mosquitto_mqtt_packets_received | Counter | Total MQTT packets received |
mosquitto_mqtt_packets_sent | Counter | Total MQTT packets sent |
mosquitto_mqtt_connect_received | Counter | MQTT CONNECT received |
mosquitto_mqtt_connect_sent | Counter | MQTT CONNECT sent |
mosquitto_mqtt_connack_received | Counter | MQTT CONNACK received |
mosquitto_mqtt_connack_sent | Counter | MQTT CONNACK sent |
mosquitto_mqtt_publish_dropped | Counter | MQTT PUBLISH dropped |
mosquitto_mqtt_publish_received | Counter | MQTT PUBLISH received |
mosquitto_mqtt_publish_sent | Counter | MQTT PUBLISH sent |
mosquitto_mqtt_puback_received | Counter | MQTT PUBACK received |
mosquitto_mqtt_puback_sent | Counter | MQTT PUBACK sent |
mosquitto_mqtt_pubrec_received | Counter | MQTT PUBREC received |
mosquitto_mqtt_pubrec_sent | Counter | MQTT PUBREC sent |
mosquitto_mqtt_pubrel_received | Counter | MQTT PUBREL received |
mosquitto_mqtt_pubrel_sent | Counter | MQTT PUBREL sent |
mosquitto_mqtt_pubcomp_received | Counter | MQTT PUBCOMP received |
mosquitto_mqtt_pubcomp_sent | Counter | MQTT PUBCOMP sent |
mosquitto_mqtt_subscribe_received | Counter | MQTT SUBSCRIBE received |
mosquitto_mqtt_subscribe_sent | Counter | MQTT SUBSCRIBE sent |
mosquitto_mqtt_suback_received | Counter | MQTT SUBACK received |
mosquitto_mqtt_suback_sent | Counter | MQTT SUBACK sent |
mosquitto_mqtt_unsubscribe_received | Counter | MQTT UNSUBSCRIBE received |
mosquitto_mqtt_unsubscribe_sent | Counter | MQTT UNSUBSCRIBE sent |
mosquitto_mqtt_unsuback_received | Counter | MQTT UNSUBACK received |
mosquitto_mqtt_unsuback_sent | Counter | MQTT UNSUBACK sent |
mosquitto_mqtt_pingreq_received | Counter | MQTT PINGREQ received |
mosquitto_mqtt_pingreq_sent | Counter | MQTT PINGREQ sent |
mosquitto_mqtt_pingresp_received | Counter | MQTT PINGRESP received |
mosquitto_mqtt_pingresp_sent | Counter | MQTT PINGRESP sent |
mosquitto_mqtt_disconnect_received | Counter | MQTT DISCONNECT received |
mosquitto_mqtt_disconnect_sent | Counter | MQTT DISCONNECT sent |
mosquitto_mqtt_auth_received | Counter | MQTT AUTH received |
mosquitto_mqtt_auth_sent | Counter | MQTT AUTH sent |
mosquitto_basic_auth_success | Counter | Successful username/password authentication attempts |
mosquitto_basic_auth_fail | Counter | Failed username/password authentication attempts |
mosquitto_basic_auth_error | Counter | Errored username/password authentication attempts |
mosquitto_extended_auth_success | Counter | Successful extended authentication attempts |
mosquitto_extended_auth_fail | Counter | Failed extended authentication attempts |
mosquitto_extended_auth_error | Counter | Errored extended authentication attempts |
mosquitto_paged_client_messages | Gauge | Number of pending client messages paged to disk (since 2.9.1) |
Additional broker process related metrics
The broker process related metrics are exported by the Prometheus exporter only.
| label | metric type | description |
|---|---|---|
process_max_fds | Gauge | Maximum number of allowed open file descriptors (including network sockets). |
process_virtual_memory_max_bytes | Gauge | Maximum amount of virtual memory available in bytes |
process_cpu_seconds_total | Gauge | Total user and system CPU time spent in seconds. |
process_virtual_memory_bytes | Gauge | Virtual memory size in bytes. |
process_resident_memory_bytes | Gauge | Resident memory size in bytes. |
process_start_time_seconds | Gauge | Start time of the process since unix epoch in seconds. |
process_open_fds | Gauge | Number of open file descriptors (including network sockets). |