Monitoring

metrics

The HiveMQ metrics and statistics. A list of all available metrics is available here.

java.nio

Statistics and metrics about used native memory.

java.lang

All information about the Java Virtual Machine can be monitored here.

actions

Actions that can be started via JMX.

subscription cleanup

Clean up outdated subscriptions that were added during network splits.

Gauge

A gauge returns a simple value at the point of time the metric was requested.

Counter

A counter is a simple incrementing and decrementing number.

Histogram

A histogram measures the distribution of values in a stream of data. They allow to measure min, mean, max, standard deviation of values and quantiles.

Meter

A meter measures the rate at which a set of events occur. Meters measure mean, 1-, 5-, and 15-minute moving averages of events.

Timer

A timer is basically a histogram of the duration of a type of event and a meter of the rate of its occurrence. It captures rate and duration information.

Cache statistic capturing the average load penalty of the payload persistence cache

Cache statistic capturing the eviction count of the payload persistence cache

Cache statistic capturing the hit count of the payload persistence cache

Cache statistic capturing the hit rate of the payload persistence cache

Cache statistic capturing the load count of the payload persistence cache

Cache statistic capturing the load exception count of the payload persistence cache

Cache statistic capturing the load exception rate of the payload persistence cache

Cache statistic capturing the load success count of the payload persistence cache

Cache statistic capturing the miss count of the payload persistence cache

Cache statistic capturing the miss rate of the payload persistence cache

Cache statistic capturing the request count of the payload persistence cache

Cache statistic capturing the total load time of the payload persistence cache

Cache statistic capturing the average load penalty of the shared subscription cache

Cache statistic capturing the eviction count of the shared subscription cache

Cache statistic capturing the hit count of the shared subscription cache

Cache statistic capturing the hit rate of the shared subscription cache

Cache statistic capturing the load count of the shared subscription cache

Cache statistic capturing the load exception count of the shared subscription cache

Cache statistic capturing the load exception rate of the shared subscription cache

Cache statistic capturing the load success count of the shared subscription cache

Cache statistic capturing the miss count of the shared subscription cache

Cache statistic capturing the miss rate of the shared subscription cache

Cache statistic capturing the request count of the shared subscription cache

Cache statistic capturing the total load time of the shared subscription cache

The number of retry attempts that are processed to resolve the name of a node

Captures the current number of nodes in the cluster

Measures the time spent waiting for cluster topology changes

Measures the rate of inconsequential exceptions thrown during the socket life cycle

Counts every closed connection that was closed because the client missed sending PINGREQ message during the keep-alive interval

Measures the rate of logging statements of all levels

Measures the rate of logging statements in DEBUG level

Measures the rate of logging statements in ERROR level

Measures the rate of logging statements in INFO level

Measures the rate of logging statements in TRACE level

Measures the rate of logging statements in WARN level

Counts every dropped message.

Measures the current rate of dropped messages.

Counts PUBLISH messages that have been dropped, because the message queue for a disconnected persistent session client was full.

Counts PUBLISH messages that are dropped because the message queue for a shared subscription is full.

Counts PUBLISH messages that have been dropped, because the message queue for a consumer topic was full.

Counts PUBLISH messages that have been dropped, because a Publish Inbound Interceptor prevented onward delivery.

Counts MQTT messages (except PUBLISH) that have been dropped, because the message size was too large for the client.

Counts PUBLISH messages that have been dropped, because the socket for the client was not writable (only QoS 0).

Counts PUBLISH messages that have been dropped, because the global memory limit for QoS 0 messages has been exceeded.

Counts PUBLISH messages that have been dropped, because of an internal error.

Counts every dropped message

Measures the current rate of dropped messages

Counts PUBLISH messages that have been dropped, because the message queue for a disconnected persistent session client was full

Counts PUBLISH messages that have been dropped, because the message size was too large for the client

Counts PUBLISH messages that have been dropped, because a Publish Inbound Interceptor prevented onward delivery

Counts MQTT messages (except PUBLISH) that have been dropped, because the message size was too large for the client

Counts PUBLISH messages that have been dropped, because the socket for the client was not writable (only QoS 0)

Counts PUBLISH messages that have been dropped, because the global memory limit for QoS 0 messages has been exceeded

Counts PUBLISH messages that have been dropped, because of an internal error

Counts every incoming MQTT CONNECT message

Counts every incoming MQTT 3 CONNECT message

Counts every incoming MQTT 5 CONNECT message

Measures the current rate of incoming MQTT CONNECT messages

Counts every incoming MQTT PINGREQ message

Measures the current rate of incoming MQTT PINGREQ messages

Counts every incoming MQTT PUBACK message

Measures the current rate of incoming MQTT PUBACK messages

Counts every incoming MQTT PUBCOMP message

Measures the current rate of incoming MQTT PUBCOMP messages

Measures the distribution of incoming MQTT message size (including MQTT packet headers)

Counts every incoming MQTT PUBLISH message

Measures the current rate of incoming MQTT PUBLISH messages

Counts every incoming MQTT PUBREC message

Measures the current rate of incoming MQTT PUBREC messages

Counts every incoming MQTT PUBREL message

Measures the current rate of incoming MQTT PUBREL messages

Counts every incoming MQTT SUBSCRIBE message

Measures the current rate of incoming MQTT SUBSCRIBE messages

Measures the size distribution of incoming MQTT messages (including MQTT packet headers)

Counts every incoming MQTT message

Measures the current rate of incoming MQTT messages

Counts every incoming MQTT UNSUBSCRIBE message

Measures the current rate of incoming MQTT UNSUBSCRIBE messages

Counts every incoming MQTT DISCONNECT message

Measures the current rate of incoming MQTT DISCONNECT messages

Counts every incoming MQTT AUTH message

Measures the current rate of incoming MQTT AUTH messages

Counts every outgoing MQTT CONNACK message

Measures the current rate of outgoing MQTT CONNACK messages

Counts every outgoing MQTT PINGRESP message

Measures the current rate of outgoing MQTT PINGRESP messages

Counts every outgoing MQTT PUBACK message

Measures the current rate of outgoing MQTT PUBACK messages

Counts every outgoing MQTT PUBCOMP message

Measures the current rate of outgoing MQTT PUBCOMP messages

Measures the size distribution of outgoing MQTT messages (including MQTT packet headers)

Counts every outgoing MQTT PUBLISH message

Measures the current rate of outgoing MQTT PUBLISH messages

Counts every outgoing MQTT PUBREC message

Measures the current rate of outgoing MQTT PUBREC messages

Counts every outgoing MQTT PUBREL message

Measures the current rate of outgoing MQTT PUBREL messages

Counts every outgoing MQTT SUBACK message

Measures the current rate of outgoing MQTT SUBACK messages

Measures the size distribution of outgoing MQTT messages (including MQTT packet headers)

Counts every outgoing MQTT message

Measures the current rate of outgoing MQTT messages

Counts every outgoing MQTT UNSUBACK message

Measures the current rate of outgoing MQTT UNSUBACK messages

Counts every outgoing MQTT DISCONNECT message

Measures the current rate of outgoing MQTT DISCONNECT messages

Counts every outgoing MQTT AUTH message

Measures the current rate of outgoing MQTT AUTH messages

The current number of queued messages

The current number of pending qos 0 messages

The current number of pending messages total

The current number of queued retained messages

The current number of pending retained messages total

Measures the current rate of resent PUBLISH messages (QoS > 0)

Measures the current rate of resent PUBREL messages (OoS = 2)

The current amount of retained messages

Metrics about the mean payload-size of retained messages in bytes

The current rate of newly retained messages

Counts every expired message

The current number of queued messages for client sessions

The current number of pending QoS 0 messages for client sessions

The total number of pending messages for client sessions

The current number of queued messages for shared subscriptions

The current number of pending QoS 0 messages for shared subscriptions

The total number of pending messages for shared subscriptions

The current (last 5 seconds) amount of read bytes

The total amount of read bytes

The current (last 5 seconds) amount of written bytes

Total amount of written bytes

The current total number of active MQTT connections

The mean total number of active MQTT connections

Counts clients which disconnected after sending a DISCONNECT Message

Counts clients which disconnected without sending a DISCONNECT Message

Counts all clients which disconnected from HiveMQ (= graceful + ungraceful)

Measure the rate of completed tasks submitted to the scheduler in charge of the cleanup of the persistence payload

Captures metrics about the job durations for jobs submitted to the scheduler in charge of the cleanup of the persistence payload

Counts tasks that are currently running in the scheduler in charge of the cleanup of the persistence payload

Measures about the tasks that have been scheduled to run only once in the scheduler in charge of the cleanup of the persistence payload

Counts the periodic tasks which ran longer then their time frame allowed in the scheduler in charge of the cleanup of the persistence payload

Metrics about how much percent of their allowed time frame periodic tasks used while running the cleanup of the persistence payload

Measures about the tasks that have been scheduled to run repetitively in the scheduler in charge of the cleanup of the persistence payload

Measures about the tasks that have been submitted to the scheduler in charge of the cleanup of the persistence payload

Measure the rate of completed tasks submitted to the persistence executor

Captures metrics about the job durations for jobs submitted to the persistence executor

Counts tasks that are currently running in the persistence executor

Measures about the tasks that have been submitted to the scheduler responsible for persistence

Measure the rate of completed tasks submitted to the scheduler responsible for persistence

Captures metrics about the job durations for jobs submitted to the scheduler responsible for persistence

Counts tasks that are currently running in the scheduler responsible for persistence

Measures about the tasks that have been scheduled to run once in the scheduler responsible for persistence

Counts the periodic tasks which ran longer then their time frame allowed in the scheduler responsible for persistence

Metrics about how much percent of their allowed time frame periodic tasks used in the scheduler responsible for persistence

Measures about the tasks that have been scheduled to run repetitively in the scheduler responsible for persistence

Measures about the tasks that have been submitted to the scheduler responsible for persistence

Current amount of disk I/O tasks that are enqueued by the client session persistence

Measures the mean execution time (in nanoseconds) of client session disk I/O tasks

Current amount of single writer task queues that are not empty

Current amount of disk I/O tasks that are enqueued by the outgoing message flow persistence

Measures the mean execution time (in nanoseconds) of outgoing message flow disk I/O tasks

Current count of loops that all single writer threads have done without executing a task

Current amount of disk I/O tasks that are enqueued by the queued messages persistence

Measures the mean execution time (in nanoseconds) of queued messages disk I/O tasks

Current amount of tasks that are enqueued by the request event bus

Measures the mean execution time (in nanoseconds) of request event bus tasks

Current amount of disk I/O tasks that are enqueued by the retained message persistence

Measures the mean execution time (in nanoseconds) of retained message disk I/O tasks

Current amount of threads that are executing disk I/O tasks

Current amount of disk I/O tasks that are enqueued by the subscription persistence

Measures the mean execution time (in nanoseconds) of subscription disk I/O tasks

Current amount of disk I/O tasks that are enqueued by all persistence executors

Holds the current amount of payloads stored in the payload persistence

Holds the current amount of payloads stored in the payload persistence, that can be removed by the cleanup

Measures the current count of stored sessions. These sessions include all sessions, including online and offline clients

Measures the current count of active persistent sessions (= Online MQTT clients which are connected with cleanSession=false).

Measure the rate of completed tasks submitted to the single-writer executor

Measure the rate of completed tasks submitted to the scheduler responsible for single-writer

Counts tasks that are currently running in the scheduler responsible for single-writer

Measures about the tasks that have been submitted to the scheduler responsible for single-writer

Measures the current count of subscriptions on the broker

Measures the current rate of submitted jobs to the ManagedExtensionExecutor

Measures the current count of running jobs in the ManagedExtensionExecutor

Measures the current rate of completed jobs in the ManagedExtensionExecutor

Measures the duration of time spent on submitted jobs to the ManagedExtensionExecutor

Measures the current rate of scheduled jobs in the ManagedExtensionExecutor that run once

Measures the current rate of scheduled jobs in the ManagedExtensionExecutor that run repetitively

Measures the current count of jobs in the ManagedExtensionExecutor that are overrun

Measures how many percent of the scheduled period the ManagedExtensionExecutorService jobs lasted

Counts the amount of times that the extension service rate limit was exceeded.

Counts the amount of publish messages sent by the publish service.

Counts the amount of publish messages sent by the publish service to a specific client.

Holds the current amount of bytes QoS 0 messages use in memory

Holds the maximum amount of bytes QoS 0 messages may use in memory

Holds the current amount of clients that exceeded their QoS 0 message memory

Holds the current amount of cpu cores used

Holds the maximum amount of cpu cores allowed by license

Counts the amount of publish messages received, without any matching subscribers

Holds the current amount of bytes topic aliases use in memory

Holds the current amount of topic aliases

Holds the current level of overload protection

Holds the current amount of credits a client receives per tick

Holds the average amount of available credits between all clients

Holds the current amount of clients having less than the full amount of credits

Holds the current amount of clients for which backpressure is applied by overload protection

Maximum allowed amount of file descriptors as seen by the JVM

Amount of open file descriptors as seen by the JVM

Current amount of free physical memory in bytes

Total amount of physical memory (bytes) available

Current CPU usage for the JVM process (0.0 idle – 1.0 full CPU usage)

Total amount of CPU time the JVM process has used to this point(in nanoseconds)

Current amount of free swap space in bytes

Total amount of swap space available in bytes

Current CPU usage for the whole system (0.0 idle – 1.0 full CPU usage)

OS Uptime in seconds

The amount of actual physical memory, in bytes

The amount of physical memory currently available, in bytes

The current memory committed to the paging/swap file(s), in bytes

The current size of the paging/swap file(s), in bytes

Amount of currently open file descriptors

Maximum allowed amount of file descriptors

Percentage of time that the CPU or CPUs were idle and the system did not have an outstanding disk I/O request

Percentage of time that the CPU or CPUs were idle during which the system had an outstanding disk I/O request

Percentage of time that the CPU used to service hardware IRQs

Percentage of CPU utilization that occurred while executing at the user level with nice priority

Percentage of time that the CPU used to service soft IRQs

Percentage of time which the hypervisor dedicated for other guests in the system.

Percentage of CPU utilization that occurred while executing at the system level (kernel)

Percentage of CPU utilization that occurred while executing at the user level (application)

Percentage of total CPU utilization for convenience (not idle, calculated as sum of usage values)

Number of threads of the HiveMQ process as seen by the OS

Amount of milliseconds the the HiveMQ process has executed in user mode as seen by the OS

Amount of milliseconds the HiveMQ process has executed in kernel/system mode as seen by the OS

Virtual Memory Size (VSZ) in bytes. It includes all memory that the HiveMQ process can access, including memory that is swapped out and memory that is from shared libraries

Resident Set Size (RSS) in bytes. It is used to show how much memory is allocated to the HiveMQ process and is in RAM. It does not include memory that is swapped out. It does include memory from shared libraries as long as the pages from those libraries are actually in memory. It does include all stack and heap memory

Number of bytes the HiveMQ process has written to disk

Number of bytes the HiveMQ process has read from disk

Bytes received by the network interface <if-name>

Bytes sent by the network interface <if-name>

Packets sent by the network interface <if-name>

Packets received by the network interface <if-name>

Input errors for the network interface <if-name>

Output errors for the network interface <if-name>

Total size of disk with name <disk-name> in bytes

Amount of read operations for disk with name <disk-name>

Amount of read operations for disk with name <disk-name>

Amount of bytes read from disk with name <disk-name>

Amount of bytes written from disk with name <disk-name>

com.hivemq.jvm.buffer-pool.direct.capacity

Gauge

The JVMs capacity of direct buffers.

com.hivemq.jvm.buffer-pool.direct.count

Gauge

The count of direct buffers in the JVM.

com.hivemq.jvm.buffer-pool.direct.used

Gauge

The amount of used direct buffers in the JVM.

com.hivemq.jvm.buffer-pool.mapped.capacity

Gauge

The JVMs capacity of mapped buffers.

com.hivemq.jvm.buffer-pool.mapped.count

Gauge

The count of mapped buffers in the JVM.

com.hivemq.jvm.buffer-pool.mapped.used

Gauge

The amount of used mapped buffers in the JVM.

com.hivemq.jvm.class-loader.loaded

Gauge

The total number of classes that have been loaded since the JVM has started execution.

com.hivemq.jvm.class-loader.unloaded

Gauge

The total number of classes unloaded since the JVM has started execution.

com.hivemq.jvm.file-descriptor.ratio

Gauge

Amount of file descriptors as seen by the JVM

com.hivemq.jvm.garbage-collector.G1-Old-Generation.count

Gauge

The total amount of collections that occurred.

com.hivemq.jvm.garbage-collector.G1-Old-Generation.time

Gauge

The approximate accumulated collection elapsed time.

com.hivemq.jvm.garbage-collector.G1-Young-Generation.count

Gauge

The total amount of collections that occurred.

com.hivemq.jvm.garbage-collector.G1-Young-Generation.time

Gauge

The approximate accumulated collection elapsed time.

com.hivemq.jvm.memory.heap.committed

Gauge

The amount of memory in bytes that is committed for the JVM to use.

com.hivemq.jvm.memory.heap.init

Gauge

The amount of memory in bytes that the JVM initially requests from the operating system for memory management.

com.hivemq.jvm.memory.heap.max

Gauge

The maximum amount of memory in bytes that can be used for memory management.

com.hivemq.jvm.memory.heap.usage

Gauge

The ratio of used memory and unused memory.

com.hivemq.jvm.memory.heap.used

Gauge

The amount of used memory in bytes.

com.hivemq.jvm.memory.non-heap.committed

Gauge

The amount of memory in bytes that is committed for the Java virtual machine to use.

com.hivemq.jvm.memory.non-heap.init

Gauge

The amount of memory in bytes that the JVM initially requests from the operating system for memory management.

com.hivemq.jvm.memory.non-heap.max

Gauge

The maximum amount of memory in bytes that can be used for memory management.

com.hivemq.jvm.memory.non-heap.usage

Gauge

The ratio of used memory and unused memory.

com.hivemq.jvm.memory.non-heap.used

Gauge

The amount of used memory in bytes.

com.hivemq.jvm.memory.pools.<Memory-Pool-Name>.committed

Gauge

The amount of memory in bytes that is committed for the JVM to use in this memory pool.

com.hivemq.jvm.memory.pools.<Memory-Pool-Name>.init

Gauge

The amount of memory in bytes that the JVM initially requests from the operating system for memory pool.

com.hivemq.jvm.memory.pools.<Memory-Pool-Name>.max

Gauge

The maximum amount of memory in bytes that can be used for this memory pool.

com.hivemq.jvm.memory.pools.<Memory-Pool-Name>.usage

Gauge

An estimate of the memory usage of this memory pool.

com.hivemq.jvm.memory.pools.<Memory-Pool-Name>.used

Gauge

The amount of used memory in this memory pool in bytes.

com.hivemq.jvm.memory.pools.<Memory-Pool-Name>.used-after-gc

Gauge

The amount of memory usage int this memory pool after the last garbage collection.

com.hivemq.jvm.memory.total.committed

Gauge

The amount of memory in bytes that is committed for the Java virtual machine to use.

com.hivemq.jvm.memory.total.init

Gauge

The amount of memory in bytes that the JVM initially requests from the operating system for memory management.

com.hivemq.jvm.memory.total.max

Gauge

The maximum amount of memory in bytes that can be used for memory management.

com.hivemq.jvm.memory.total.used

Gauge

The amount of used memory in bytes.

com.hivemq.jvm.threads.blocked.count

Gauge

The amount of blocked threads in this JVM.

com.hivemq.jvm.threads.count

Gauge

The total amount of threads in this JVM.

com.hivemq.jvm.threads.daemon.count

Gauge

The amount of deamon threads in this JVM.

com.hivemq.jvm.threads.deadlock.count

Gauge

The amount of detected deadlocks in this JVM.

com.hivemq.jvm.threads.deadlocks

Gauge

The amount of detected deadlocks in this JVM.

com.hivemq.jvm.threads.new.count

Gauge

The amount of new threads in this JVM.

com.hivemq.jvm.threads.runnable.count

Gauge

The amount of runnable threads in this JVM.

com.hivemq.jvm.threads.terminated.count

Gauge

The amount of terminated threads in this JVM.

com.hivemq.jvm.threads.timed_waiting.count

Gauge

The amount of timed-waiting threads in this JVM.

com.hivemq.jvm.threads.waiting.count

Gauge

The amount of waiting threads in this JVM.

com.hivemq.cluster.sent.*

Meter

Provides measures for every class that made once a SEND request (every class get its own metric)