Diagnostic Archive

In the event that your HiveMQ cluster experiences problems that require immediate attention, quick access to all pertinent information helps ensure the shortest possible MTTR (mean time to recovery). To simplify the information collection process, your HiveMQ Control Center provides a fully automated Diagnostic Archive function. The Diagnostic Archive feature makes it easy for control center administrators to collect all the information that a support engineer needs to identify root causes and propose solutions.

Create a Diagnostic Archive

To create a diagnostic archive, select Support in the Administration section of the HiveMQ Control Center main navigation.
On the Diagnostic Archive page that opens, select Generate Diagnostic Archive.

Create diagnostic archive

When you generate a diagnostic archive, HiveMQ automatically collects all relevant information about the current state of your HiveMQ cluster. The collected information includes your HiveMQ config.xml file, operating system and hardware information, Java thread dump records, metrics, and more.

Here at HiveMQ, we take your privacy seriously. Diagnostic archives remove or anonymize all secret information such as credentials, passwords, or topic names in your config.xml file.

Once the Control Center has generated the diagnostic archive, each node in your HiveMQ cluster lists a separate ZIP file that you can share with your internal support team for upload to the HiveMQ support portal for further inspection. The Diagnostic Archive helps support engineers identify the root cause of the problem and suggest appropriate action quickly.

Only administrators who have permission to access the file system of the HiveMQ broker can access the diagnostic archive that is generated.