It is recommended to install and monitor HiveMQ broker with Prometheus and Grafana. Metrics collected in this fashion can be batch exported with the HiveMQ grafana-metrics-exporter tool.
Prerequisite
Java 11+ running on your machine
Download the Grafana Exporter tool
View file name hivemq-metrics-exporter-2.0.zip
\uD83D\uDCD8 Instructions
...
Find the Grafana Datasource Id.
To export the metrics from a Grafana Datasource first find the Datasource Id. To find the ID for the desired Grafana Datasource, first, log in to Grafana and next go to Menu→Configuration→Data Sources* and click on the desired Datasource, then the ID is part of the URLExample URL: https://my.grafana-url.com:port/datasources/edit/1/.
In the Example URL, the ID for the Datasource is
1.Note: If you cannot reach the Menu→Configuration→Data Sources, it indicates that you do not have necessary access rights to the Grafana. In this case, you need to contact the admin of Grafana and get the necessary access rights.
In case the ID is alphanumeric(e.g. AB123BC), please find the numerical ID via Find Grafana Datasource Id by its Name
Run the exporter. A full command should look like this:the following
In case you are using localhost via port-forwarding
please use
--url "http://localhost:port", where port is the target port of Grafana serviceusername: admin, password: prom-operator
Time is in UTC and ends with letter Z
| Code Block | ||
|---|---|---|
| ||
java -jar hivemq-metrics-exporter.jar \ --url "https://my.grafana-url.com:port/grafana" \ -u "myusername" \ -p "mypassword" \ -ds 1 \ -f "tag1=\"mytagvalue1\",tag2=\"mytagvalue2\"" \ --from "2021-08-01T10:00:00Z" \ --to "2021-08-01T19:00:00Z" \ --step 15s |
...
Note, you can specify any numeric Datasource id with option --direct, as with direct Prometheus export the Datasource id is ignored.
Params
Name | Description | Required | Example |
|---|---|---|---|
| Grafana URL (Without trailing slash) | x |
|
| Grafana Datasource ID | x |
|
| Start timestamp in ISO Format. If it ends with | x |
|
| End timestamp in ISO Format. If it ends with | x |
|
| Grafana Username |
| |
| Grafana Password. Can be passed as param directly |
| |
| Prometheus Filter to only pull HiveMQ metrics with specific tags. Example: If you would get the HiveMQ metrics with the query |
| |
| Step size, the distance between measured points, should be greater or equal to the Prometheus scrape interval. Default: |
| |
| Test Mode stops after the first metric. Good for testing if the params are correct |
| |
| Enable verbose mode, good for debugging. Very verbose! |
|
| Info |
|---|
To get help on all available parameters of the command, run the command with the option
This will output the full list of available options and values. |
...
| Filter by label (Content by label) | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|