{"id":18966338,"url":"https://github.com/hivemq/hivemq-prometheus-extension","last_synced_at":"2026-02-05T13:14:40.690Z","repository":{"id":46123071,"uuid":"160511234","full_name":"hivemq/hivemq-prometheus-extension","owner":"hivemq","description":"HiveMQ extension for transferring monitoring data to Prometheus","archived":false,"fork":false,"pushed_at":"2025-04-12T07:06:16.000Z","size":422,"stargazers_count":20,"open_issues_count":1,"forks_count":5,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-12T08:22:44.389Z","etag":null,"topics":["dev-ops","extension","hivemq","hivemq-extension","metrics","metrics-gathering","monitoring","mqtt","operations","prometheus","time-series-analysis"],"latest_commit_sha":null,"homepage":"https://www.hivemq.com/extension/prometheus-extension/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hivemq.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-05T11:55:29.000Z","updated_at":"2025-04-12T07:06:19.000Z","dependencies_parsed_at":"2024-02-01T18:57:09.657Z","dependency_job_id":"120eb1b4-ebdd-47b4-acfc-789f2a80545c","html_url":"https://github.com/hivemq/hivemq-prometheus-extension","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivemq%2Fhivemq-prometheus-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivemq%2Fhivemq-prometheus-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivemq%2Fhivemq-prometheus-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hivemq%2Fhivemq-prometheus-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hivemq","download_url":"https://codeload.github.com/hivemq/hivemq-prometheus-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249213734,"owners_count":21231096,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dev-ops","extension","hivemq","hivemq-extension","metrics","metrics-gathering","monitoring","mqtt","operations","prometheus","time-series-analysis"],"created_at":"2024-11-08T14:36:41.774Z","updated_at":"2026-02-05T13:14:40.684Z","avatar_url":"https://github.com/hivemq.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":":hivemq-link: https://www.hivemq.com\n:hivemq-support: {hivemq-link}/support/\n\n= HiveMQ Prometheus Extension\n\nimage:https://img.shields.io/badge/Extension_Type-Monitoring-orange?style=for-the-badge[Extension Type]\nimage:https://img.shields.io/github/v/release/hivemq/hivemq-prometheus-extension?style=for-the-badge[GitHub release (latest by date),link=https://github.com/hivemq/hivemq-prometheus-extension/releases/latest]\nimage:https://img.shields.io/github/license/hivemq/hivemq-prometheus-extension?style=for-the-badge\u0026color=brightgreen[GitHub,link=LICENSE]\nimage:https://img.shields.io/github/actions/workflow/status/hivemq/hivemq-prometheus-extension/check.yml?branch=master\u0026style=for-the-badge[GitHub Workflow Status,link=https://github.com/hivemq/hivemq-prometheus-extension/actions/workflows/check.yml?query=branch%3Amaster]\n\n== Purpose\n\nThe Prometheus Monitoring extension allows HiveMQ to expose metrics to a Prometheus application.\n\n== Installation\n\n. Unzip the file: `hivemq-prometheus-extension-\u003cversion\u003e-distribution.zip` to the directory: `\u003cHIVEMQ_HOME\u003e/extensions`\n. A configuration file `conf/config.properties` can be found in the `hivemq-prometheus-extension` folder.\nThe properties are preconfigured with standard settings and can be adapted to your needs (The meaning of the fields is explained below).\n. Start HiveMQ.\n\n== Configuration\n\nThe extension can be configured with the `conf/config.properties` file, which is part of the `hivemq-prometheus-extension` folder.\n\n[cols=\"1m,1,2\" options=\"header\"]\n.Configuration Options\n|===\n|Name\n|Default\n|Description\n\n|port\n|9399\n|The port which the HTTP server will listen to.\n\n|ip\n|0.0.0.0\n|The bind-address which the HTTP server will listen to.\n\n|metric_path\n|/metrics\n|The path for the service which gets called by Prometheus.\nIt must start with a slash.\n\n|===\n\n== First Steps\n\nYou can test your configuration by navigating to `\u003cip\u003e:\u003cport\u003e\u003cmetric_path\u003e` (as configured in `conf/config.properties`) in your browser.\nFor example the address would be http://localhost:9399/metrics with default values.\n\nYou should see data provided by the extension:\n\n----\n# HELP com_hivemq_messages_incoming_publish_rate_total Generated from Dropwizard metric import (metric=com.hivemq.messages.incoming.publish.rate, type=com.codahale.metrics.Meter)\n# TYPE com_hivemq_messages_incoming_publish_rate_total counter\ncom_hivemq_messages_incoming_publish_rate_total 0.0\n...\n----\n\n== Final Steps\n\n. Load and install Prometheus\n. Configure Prometheus to scrape from \u003cip\u003e:\u003cport\u003e\u003cmetricPath\u003e as configured in the `conf/config.properties`.\n. Look at the website provided by your Prometheus application.\nYou should be able to find the HiveMQ metrics.\n\nFor detailed information please visit:  https://prometheus.io/docs/operating/configuration/\n\nTo enable Prometheus to gather metrics from HiveMQ, you need to add a scrape configuration to your Prometheus configuration.\nThe following is a minimal example using the default values of the extension:\n\n.prometheus.yml\n----\nglobal:\n  scrape_interval: 15s\nscrape_configs:\n  - job_name: 'hivemq'\n    scrape_interval: 5s\n    metrics_path: '/metrics'\n    static_configs:\n      - targets: ['localhost:9399']\n----\n\n== Need Help?\n\nIf you encounter any problems, we are happy to help.\nThe best place to get in contact is our {hivemq-support}[support].\n\n== Contributing\n\nIf you want to contribute to HiveMQ Prometheus Extension, see the link:CONTRIBUTING.md[contribution guidelines].\n\n== License\n\nHiveMQ Prometheus Extension is licensed under the `APACHE LICENSE, VERSION 2.0`.\nA copy of the license can be found link:LICENSE[here].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhivemq%2Fhivemq-prometheus-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhivemq%2Fhivemq-prometheus-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhivemq%2Fhivemq-prometheus-extension/lists"}