https://github.com/hivemq/mqtt-message-log

The MQTT Message Log plugin for the HiveMQ MQTT broker logs all client actions the standard HiveMQ logger.
https://github.com/hivemq/mqtt-message-log

Last synced: 5 days ago
JSON representation

The MQTT Message Log plugin for the HiveMQ MQTT broker logs all client actions the standard HiveMQ logger.

• Host: GitHub
• URL: https://github.com/hivemq/mqtt-message-log
• Owner: hivemq
• License: apache-2.0
• Created: 2013-10-20T19:15:49.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-08-29T11:05:46.000Z (about 1 year ago)
• Last Synced: 2024-04-17T19:14:18.504Z (7 months ago)
• Language: Java
• Size: 29.3 KB
• Stars: 6
• Watchers: 17
• Forks: 9
• 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-plugin-docs-link: http://www.hivemq.com/docs/plugins/latest/

:hivemq-blog-tools: http://www.hivemq.com/overview-of-mqtt-client-tools/

= MQTT Message Log Plugin

== Description

The MQTT Message Log is a very useful HiveMQ Plugin for debugging and development purposes. It provides the possibility to follow up on any clients communicating with the broker on the terminal.

*The plugin logs the following events:*

* A client connects to HiveMQ

* A client sends a publish message

* A client subscribes to a topic

* A client unsubscribes from a topic

* A client disconnects from HiveMQ

* HiveMQ send a message to a client

== How to use the plugin

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

. Run HiveMQ

. Connect with a {hivemq-blog-tools}[MQTT client] of your choice and publish something.

. You should see logged events in your terminal where you started HiveMQ

== Configuration

It is possible to opt out of specific log event types by adding a

*mqttMessageLog.properties* files to your +/conf+  folder.

This properties file could have the following entries:

* client-connect=false|true

* client-disconnect=false|true

* publish-received=false|true

* publish-send=false|true

* subscribe-received=false|true

* unsubscribe-received=false|true

Missing entries defaults to true.

= Contributing

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

= License

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