Diagnostic Mode

HiveMQ comes with a Diagnostic Mode that can collect data about the system HiveMQ is installed to. This provides valuable information for our support team for resolving issues on the concrete HiveMQ installation.

The diagnostic mode is disabled by default and should only be enabled in case you are facing an issue with your installation. Performance will decrease and HiveMQ will write lots of information to disk, so this mode is not meant to be used in production.

Enabling Diagnostic Mode

In order to enable the diagnostic mode, modify the run.sh file for Linux systems or the run.bat file for Windows systems and uncomment the following line(s):

Enabling diagnostic mode for Linux
# Uncomment for enabling Diagnostic Mode
JAVA_OPTS="$JAVA_OPTS -DdiagnosticMode=true"
Enabling diagnostic mode for Windows
rem Uncomment for enabling diagnostic mode
set "JAVA_OPTS=-DdiagnosticMode=true %JAVA_OPTS%"

When configured correctly, HiveMQ logs a statement similar to this:

2018-07-01 12:59:25,669 INFO  - Starting with Diagnostic mode

Sending diagnostics file to the HiveMQ support team

After starting in diagnostic mode, HiveMQ creates a folder called diagnostics that stores all diagnostic information.

The following files are created:

File Name Description


Diagnostic information about HiveMQ and the system HiveMQ is running on


A trace log of HiveMQ

Run the diagnostic mode as long as you need to reproduce the issue you want to have solved. After that, stop HiveMQ. Review the created files if you’re comfortable with the information included, edit if you feel something is too sensible for our support team. Now send all files in the diagnostics folder to support@hivemq.com and describe your problem as specific as possible.

If you run diagnostic mode for an extended period of time, the log file becomes very large. We strongly recommend to only run in diagnostic mode for as long as you need to demonstrate a particular issue that you are experiencing.