https://github.com/hivemq/hivemq-sys-topic-plugin

This HiveMQ plugin enables MQTT $SYS topics in HiveMQ. It can be easily removed or switched by any of your favorite monitoring interfaces.
https://github.com/hivemq/hivemq-sys-topic-plugin

Last synced: 5 days ago
JSON representation

This HiveMQ plugin enables MQTT $SYS topics in HiveMQ. It can be easily removed or switched by any of your favorite monitoring interfaces.

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-sys-topic-plugin
• Owner: hivemq
• License: apache-2.0
• Created: 2015-09-19T13:52:20.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-08-29T11:08:02.000Z (about 1 year ago)
• Last Synced: 2024-04-17T19:14:18.083Z (7 months ago)
• Language: Java
• Size: 52.7 KB
• Stars: 5
• Watchers: 15
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
:hivemq-sys-topics: https://www.hivemq.com/docs/3.4/hivemq/monitoring.html#sys-topic

= HiveMQ SYS Topic Plugin

== Description

The SYS-Topic plugin is a plugin for HiveMQ to make it possible to subscribe to SYS-Topics.

For a detailed list of sys-topics check our {hivemq-sys-topics}[documentation].

== How to use the plugin with sample configuration

. Copy the jar file to your +/plugins+ folder

. Copy configuration files

..  +sample-configuration/systopic-plugin.properites+ into your +/conf+ folder

. Run HiveMQ

. Done!

NOTE: This sample installation sets metrics publish interval to 60 seconds.

== Configuration Options

The plugin can be configured with the +systopic-plugin.properites+ file, which needs to be placed in the plugin folder next to the jar file.

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

.Configuration Options

|===

|Name

|Default

|Description

|publishInterval

|60

|This property specifies the interval of metrics getting published

|===

= Contributing

If you want to contribute to HiveMQ SYS Topic Plugin, see the link:CONTRIBUTING.md[contribution guidelines].

= License

HiveMQ SYS Topic Plugin is licensed under the `APACHE LICENSE, VERSION 2.0`. A copy of the license can be found link:LICENSE.txt[here].