The HiveMQ Heartbeat Extension allows seamless integration of HiveMQ with load balancers and proxies, by creating an HTTP endpoint that can be used for health checks.
Installing the extension for HiveMQ is very easy:
The HiveMQ Heartbeat extension uses its own configuration file extension-config.xml, which needs to be present in the hivemq-heartbeat-extension folder.
General Configuration
Config name | Required | Description | Default |
---|---|---|---|
<port> |
no | The port on which the heartbeat HTTP service should listen. | 9090 |
<bindAddress> |
yes | The bind address of the heartbeat HTTP service. | 0.0.0.0 |
<path> |
no | The Path where the heartbeat HTTP service is located. | /heartbeat |
Example Configuration
|
|
By default the heartbeat is available at http://MY-IP:9090/heartbeat
The extension exposes a custom metric to HiveMQ’s holistic metric registry.
Metric name | Type | Description |
---|---|---|
http-heartbeat-meter | Meter | A meter that shows the frequency of heartbeat requests. |