https://github.com/hivemq/hivemq-prometheus-extension

HiveMQ extension for transferring monitoring data to Prometheus
https://github.com/hivemq/hivemq-prometheus-extension

dev-ops extension hivemq hivemq-extension metrics metrics-gathering monitoring mqtt operations prometheus time-series-analysis

Last synced: about 2 months ago
JSON representation

HiveMQ extension for transferring monitoring data to Prometheus

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-prometheus-extension
• Owner: hivemq
• License: apache-2.0
• Created: 2018-12-05T11:55:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-14T05:18:16.000Z (4 months ago)
• Last Synced: 2024-09-14T17:25:39.769Z (4 months ago)
• Topics: dev-ops, extension, hivemq, hivemq-extension, metrics, metrics-gathering, monitoring, mqtt, operations, prometheus, time-series-analysis
• Language: Java
• Homepage: https://www.hivemq.com/extension/prometheus-extension/
• Size: 351 KB
• Stars: 18
• Watchers: 18
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
:hivemq-link: https://www.hivemq.com

:hivemq-support: {hivemq-link}/support/

= HiveMQ Prometheus Extension

image:https://img.shields.io/badge/Extension_Type-Monitoring-orange?style=for-the-badge[Extension Type]

image: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]

image:https://img.shields.io/github/license/hivemq/hivemq-prometheus-extension?style=for-the-badge&color=brightgreen[GitHub,link=LICENSE]

image:https://img.shields.io/github/actions/workflow/status/hivemq/hivemq-prometheus-extension/check.yml?branch=master&style=for-the-badge[GitHub Workflow Status,link=https://github.com/hivemq/hivemq-prometheus-extension/actions/workflows/check.yml?query=branch%3Amaster]

== Purpose

The Prometheus Monitoring extension allows HiveMQ to expose metrics to a Prometheus application.

== Installation

. Unzip the file: `hivemq-prometheus-extension--distribution.zip` to the directory: `/extensions`

. A configuration file `prometheusConfiguration.properties` can be found in the `hivemq-prometheus-extension` folder.

The properties are preconfigured with standard settings and can be adapted to your needs (The meaning of the fields is explained below).

. Start HiveMQ.

== Configuration

The extension can be configured with the `prometheusConfiguration.properties` file, which is part of the `hivemq-prometheus-extension` folder.

[cols="1m,1,2" options="header"]

.Configuration Options

|===

|Name

|Default

|Description

|port

|9399

|The port which the servlet will listen to.

|ip

|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.

|===

== First Steps

You can test your configuration by navigating to `:` (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:

----

# 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)

# TYPE com_hivemq_messages_incoming_publish_rate_total counter

com_hivemq_messages_incoming_publish_rate_total 0.0

...

----

== Final Steps

. Load and install Prometheus

. Configure Prometheus to scrape from : as configured in the prometheusConfiguration.properties.

. Look at the website provided by your Prometheus application.

You should be able to find the HiveMQ metrics.

For detailed information please visit:  https://prometheus.io/docs/operating/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:

.prometheus.yml

----

global:

  scrape_interval: 15s

scrape_configs:

  - job_name: 'hivemq'

    scrape_interval: 5s

    metrics_path: '/metrics'

    static_configs:

      - targets: ['localhost:9399']

----

== Need Help?

If you encounter any problems, we are happy to help.

The best place to get in contact is our {hivemq-support}[support].

== Contributing

If you want to contribute to HiveMQ Prometheus Extension, see the link:CONTRIBUTING.md[contribution guidelines].

== License

HiveMQ Prometheus Extension is licensed under the `APACHE LICENSE, VERSION 2.0`.

A copy of the license can be found link:LICENSE[here].