HiveMQ Data Hub Metrics

When enabled, the HiveMQ Data Hub exposes the following metrics:

HiveMQ Enterprise Broker

Table 1. Available Data Hub metrics (Enterprise)
Metric Type Description

com.hivemq.data-hub.behavior-validation.clients.covered.count

Counter

The number of connected clients to which at least one non-terminated behavior is currently applied

com.hivemq.data-hub.behavior-validation.policies.failed.count

Counter

The total number of failed terminations of behaviors

com.hivemq.data-hub.behavior-validation.policies.successful.count

Counter

The total number of successful terminations of behaviors

com.hivemq.data-hub.behavior-policy-persistence.size.total

Gauge

The current number of policy entries in the behavior policy persistence

com.hivemq.data-hub.behavior-validation.schema-deserializations.failed.count

Counter

The total number of failed schema deserializations in behavior policies

com.hivemq.data-hub.behavior-validation.schema-deserializations.successful.count

Counter

The total number of successful schema deserializations in behavior policies

com.hivemq.data-hub.behavior-validation.states.initialized.count

Counter

The total number of behavior states initialized for all clients

com.hivemq.data-hub.behavior-validation.total.time

Timer

The mean execution time of the behavior validation in nanoseconds

com.hivemq.data-hub.behavior-validation.transitions.performed.count

Counter

The total number of state transitions behaviors perform

com.hivemq.data-hub.data-policy-persistence.size.total

Gauge

The current number of data policy entries in the persistence

com.hivemq.data-hub.data-validation.payload-validation.failed.count

Counter

The total number of payloads that failed to validate successfully

com.hivemq.data-hub.data-validation.payload-validation.successful.count

Counter

The total number of payloads that validated successfully

com.hivemq.data-hub.data-validation.policies.failed.count

Counter

The total number of policies that had a failed outcome

com.hivemq.data-hub.data-validation.policies.successful.count

Counter

The total number of policies that had a successful outcome

com.hivemq.data-hub.data-validation.validators.failed.count

Counter

The total number of validators that had a failed outcome

com.hivemq.data-hub.data-validation.validators.successful.count

Counter

The total number of validators that had a successful outcome

com.hivemq.data-hub.data-validation.schema-validations.failed.count

Counter

The total number of failed schema validations

com.hivemq.data-hub.data-validation.schema-validations.successful.count

Counter

The total number of successful schema validations

com.hivemq.data-hub.data-validation.publish-validation.execution.time

Timer

The mean execution time of publish validation in nanoseconds (including all policy engine iterations)

com.hivemq.data-hub.data-validation.branching.success.count

Counter

The number of branch messages that have been successfully published

com.hivemq.data-hub.data-validation.branching.failed.count

Counter

The number of branch messages that were created but failed to be published

com.hivemq.data-hub.license.allowed-policies-number

Gauge

The number of policies the current Data Hub license allows

com.hivemq.data-hub.license.days-till-expire

Gauge

The number of days until the current Data Hub license expires

com.hivemq.data-hub.messages.dropped.policy-prevented.count

Counter

The number of PUBLISH messages that are dropped because a policy prevented onward delivery

com.hivemq.data-hub.schema-persistence.size.total

Gauge

The current amount of schema entries in the persistence

com.hivemq.data-hub.scripting.script-runtime.scripts.count

Counter

The current number of loaded scripts in the script engine

com.hivemq.data-hub.scripting.script-runtime.execution.rate

Meter

Measures the current rate of scripts executed in script engines

com.hivemq.data-hub.scripting.script-runtime.execution.time

Timer

The mean execution time of scripts executed in script engines in nanoseconds

com.hivemq.data-hub.scripting.script-runtime.heap.total.bytes

Gauge

The current number of bytes allocated for the heap per script engine on average

com.hivemq.data-hub.scripting.script-runtime.heap.used.bytes

Gauge

The current number of bytes used for the heap per script engine on average

com.hivemq.data-hub.scripting.script-runtime.heap.limit.bytes

Gauge

The absolute limit in bytes for the heap that a script engine cannot exceed

com.hivemq.data-hub.scripting.script-runtime.engines.active.count

Gauge

The current number of script engines that execute scripts

com.hivemq.data-hub.scripting.script-runtime.engines.idle.count

Gauge

The current number of script engines that do not execute scripts

com.hivemq.data-hub.scripting.script-runtime.engines.released.count

Gauge

The current number of script engines released do to a long idle time

com.hivemq.data-hub.script-persistence.size.total

Gauge

The current number of script entries in the persistence

For more information about HiveMQ metrics, see Available Metrics.

HiveMQ Edge

Table 2. Available Data Hub metrics (Edge)
Metric Type Description

com.hivemq.edge.data-hub.behavior-validation.clients.covered.count

Counter

The number of connected clients to which at least one non-terminated behavior is currently applied

com.hivemq.edge.data-hub.behavior-validation.policies.failed.count

Counter

The total number of failed terminations of behaviors

com.hivemq.edge.data-hub.behavior-validation.policies.successful.count

Counter

The total number of successful terminations of behaviors

com.hivemq.edge.data-hub.behavior-policy-persistence.size.total

Gauge

The current number of policy entries in the behavior policy persistence

com.hivemq.edge.data-hub.behavior-policy-persistence.size.bytes

Gauge

The current number of bytes the behavior policy persistence uses

com.hivemq.edge.data-hub.behavior-validation.schema-deserializations.failed.count

Counter

The total number of failed schema deserializations in behavior policies

com.hivemq.edge.data-hub.behavior-validation.schema-deserializations.successful.count

Counter

The total number of successful schema deserializations in behavior policies

com.hivemq.edge.data-hub.behavior-validation.states.initialized.count

Counter

The total number of behavior states initialized for all clients

com.hivemq.edge.data-hub.behavior-validation.total.time

Timer

The mean execution time of the behavior validation in nanoseconds

com.hivemq.edge.data-hub.behavior-validation.transitions.performed.count

Counter

The total number of state transitions behaviors perform

com.hivemq.edge.data-hub.data-policy-persistence.size.bytes

Gauge

The current number of bytes the data policy persistence uses

com.hivemq.edge.data-hub.data-policy-persistence.size.total

Gauge

The current number of data policy entries in the persistence

com.hivemq.edge.data-hub.data-validation.payload-validation.failed.count

Counter

The total number of payloads that failed to validate successfully

com.hivemq.edge.data-hub.data-validation.payload-validation.successful.count

Counter

The total number of payloads that validated successfully

com.hivemq.edge.data-hub.data-validation.policies.failed.count

Counter

The total number of policies that had a failed outcome

com.hivemq.edge.data-hub.data-validation.policies.successful.count

Counter

The total number of policies that had a successful outcome

com.hivemq.edge.data-hub.data-validation.validators.failed.count

Counter

The total number of validators that had a failed outcome

com.hivemq.edge.data-hub.data-validation.validators.successful.count

Counter

The total number of validators that had a successful outcome

com.hivemq.edge.data-hub.data-validation.schema-validations.failed.count

Counter

The total number of failed schema validations

com.hivemq.edge.data-hub.data-validation.schema-validations.successful.count

Counter

The total number of successful schema validations

com.hivemq.edge.data-hub.data-validation.publish-validation.execution.time

Timer

The mean execution time of publish validation in nanoseconds (including all policy engine iterations)

com.hivemq.edge.data-hub.license.allowed-policies-number

Gauge

The number of policies the current Data Hub license allows

com.hivemq.edge.data-hub.license.days-till-expire

Gauge

The number of days until the current Data Hub license expires

com.hivemq.edge.data-hub.messages.dropped.policy-prevented.count

Counter

The number of PUBLISH messages that are dropped because a policy prevented onward delivery

com.hivemq.edge.data-hub.schema-persistence.size.bytes

Gauge

The current number of bytes schema persistence uses

com.hivemq.edge.data-hub.schema-persistence.size.total

Gauge

The current amount of schema entries in the persistence

com.hivemq.edge.data-hub.scripting.script-runtime.scripts.count

Counter

The current number of loaded scripts in the script engine

com.hivemq.edge.data-hub.scripting.script-runtime.execution.rate

Meter

Measures the current rate of scripts executed in script engines

com.hivemq.edge.data-hub.scripting.script-runtime.execution.time

Timer

The mean execution time of scripts executed in script engines in nanoseconds

com.hivemq.edge.data-hub.scripting.script-runtime.heap.total.bytes

Gauge

The current number of bytes allocated for the heap per script engine on average

com.hivemq.edge.data-hub.scripting.script-runtime.heap.used.bytes

Gauge

The current number of bytes used for the heap per script engine on average

com.hivemq.edge.data-hub.scripting.script-runtime.heap.limit.bytes

Gauge

The absolute limit in bytes for the heap that a script engine cannot exceed

com.hivemq.edge.data-hub.scripting.script-runtime.engines.active.count

Gauge

The current number of script engines that execute scripts

com.hivemq.edge.data-hub.scripting.script-runtime.engines.idle.count

Gauge

The current number of script engines that do not execute scripts

com.hivemq.edge.data-hub.scripting.script-runtime.engines.released.count

Gauge

The current number of script engines released do to a long idle time

com.hivemq.edge.data-hub.script-persistence.size.bytes

Gauge

The current number of bytes script persistence uses

com.hivemq.edge.data-hub.script-persistence.size.total

Gauge

The current number of script entries in the persistence

For more information about HiveMQ metrics, see Available Metrics.