The Prometheus Monitoring extension allows HiveMQ to expose metrics to a Prometheus application.
- Unzip the file:
hivemq-prometheus-extension-<version>-distribution.zipto the directory:
- A configuration file
prometheusConfiguration.propertiescan be found in the
- The properties are preconfigured with standard settings and can be adapted to your needs (The meaning of the fields is explained below).
- Start HiveMQ.
The extension can be configured with the
prometheusConfiguration.properties file, which is part of the
|port||9399||The port which the servlet will listen to.|
|host||0.0.0.0||The bind-address which the servlet will listen to.|
|metric_path||/metrics||The path for the service which gets called by Prometheus. It must start with a slash.|
You can test your configuration by navigating to
<ip>:<port><metric_path> (as configured in
prometheusConfiguration.properties) in your browser.
For example the address would be http://localhost:9399/metrics with default values.
You should see data provided by the extension:
- Load and install Prometheus
- Configure Prometheus to scrape from
: as configured in the
- Look at the website provided by your Prometheus application. You should be able to find the HiveMQ metrics.
For detailed information please visit: Prometheus Configuration
To enable Prometheus to gather metrics from HiveMQ, you need to add a scrape configuration to your Prometheus configuration. The following is a minimal example using the default values of the extension:
If you encounter any problems, we are happy to help. The best place to get in contact is our support.
Back to marketplace