|
Note
|
HiveMQ 4 uses a new extension system. This HiveMQ 3 plugin is not compatible with HiveMQ 4. The new version can be found here. |
-
Copy the jar file
plugins/hivemq-influxdb-monitoring-plugin-<version>.jarto your[HIVEMQ_HOME]/pluginsfolder -
Copy the
conf/influxdb.propertiesfile to your[HIVEMQ_HOME]/conffolder -
Modify the
influxdb.propertiesfile for your needs -
Done
-
Download and install Docker for your platform
-
Download and install Kitematic
-
Go to github.com/tutumcloud/influxdb and follow the setup instructions
-
Start Kitematic and create an InfluxDB container (under
My Imagestab) -
Rebind the ports to match your
influxdb.properties -
Done
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.
| 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. |
|
prefix |
no |
HIVEMQ_INFLUX_DB_PLUGIN_PREFIX |
The measurement prefix. |
|
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 ( |
|
mode:http
host:localhost
port:8086
protocol:http
auth:
prefix:
database:hivemq
reportingInterval:1
connectTimeout:5000
tags:host=hivemq1If you encounter any problems, we are happy to help. The best place to get in contact is our support.
If you want to contribute to HiveMQ InfluxDB Monitoring Plugin, see the contribution guidelines.
HiveMQ InfluxDB Monitoring Plugin is licensed under the APACHE LICENSE, VERSION 2.0. A copy of the license can be found here.