InfluxDB Plugin

Version: 1.0.3
License: Apache v2

Purpose

The InfluxDB Monitoring plugin allows HiveMQ to connect to an instance of InfluxDB for time series monitoring of the internal metrics.

Installation InfluxDB Monitoring Plugin

  1. Copy the jar file hivemq-influxdb-monitoring-plugin-.jar to your [HIVEMQ_HOME]/plugins folder
  2. Copy the conf/influxdb.properties file to your [HIVEMQ_HOME]/conf folder
  3. Modify the influxdb.properties file for your needs
  4. Done

Usage

The InfluxDB Monitoring plugin uses its own configuration file influxdb.properties which must be placed in HiveMQ’s config folder.
Furthermore it is possible to overwrite the configuration with Environment Variables.

This plugin is especially useful when used together with Grafana to create operation dashboards for HiveMQ.

  1. Start InfluxDB
  2. Start HiveMQ

Configuration

Config name Required Environment Variable Description Default

mode

no

HIVEMQ_INFLUX_DB_PLUGIN_MODE

The mode configured for the InfluxDB sender. Possibilities are: http, tcp, udp

http

host

no

HIVEMQ_INFLUX_DB_PLUGIN_HOST

The host name of the InfluxDB instance.

localhost

port

no

HIVEMQ_INFLUX_DB_PLUGIN_PORT

The port number the InfluxDB instance is listening.

8086

protocol

no

HIVEMQ_INFLUX_DB_PLUGIN_PROTOCOL

The protocol the InfluxDB sender uses in http mode.

http

auth

no

HIVEMQ_INFLUX_DB_PLUGIN_AUTH

The authorization string to be used to connect to InfluxDB, of format username:password.

no default

prefix

no

HIVEMQ_INFLUX_DB_PLUGIN_PREFIX

The measurement prefix.

no default

database

no

HIVEMQ_INFLUX_DB_PLUGIN_DATABASE

The database name.

hivemq

reportingInterval

no

HIVEMQ_INFLUX_DB_PLUGIN_REPORTING_INTERVAL

The reporting interval in seconds.

1

connectTimeout

no

HIVEMQ_INFLUX_DB_PLUGIN_CONNECTION_TIMEOUT

 The connect and read timeout in seconds.

5000

tags

no

HIVEMQ_INFLUX_DB_PLUGIN_TAGS

The tags for each metric. Listed as a semicolon ( ; ) separated list.

no default