Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article guides you through the process of creating a Diagnostic Archive for your HiveMQ cluster.

The Diagnostic Archive feature is available starting from functionality becomes accessible with the introduction of HiveMQ broker version 4.12.0.

\uD83D\uDCD8 Instructions

There are 3 ways three methods to create generate a Diagnostic Archive:

  1. Control Center WebUI:From

    - Support - Diagnostic Archive - CreateFrom the REST API
    • WebUI.

    • Select "Admin" and then "Support" in the left navigation links.

    • Click on "Diagnostic Archive" and subsequently hit the "Create Archive" button.

  2. REST API:

    • Utilize the REST API, accessible at https://

    www/docs4.12, that
    • : The REST API is an Enterprise feature).

    By creating
  3. Manual File Creation:

    • Generate an empty file named "TRIGGER_DIAGNOSTIC" in the $HIVEMQ_HOME

    (a.k.a.
    • directory (also known as the HiveMQ broker root directory).

\uD83D\uDCD8 Instructions

  1. Create a file

    Code Block
    1. Code Block
      languagebash
      # Create a file named "TRIGGER_DIAGNOSTIC"
      touch $HIVEMQ_HOME/TRIGGER_DIAGNOSTIC
    2. Upon triggering the Diagnostic Archive, you will observe the following log entries in the log file:

      Code Block
      languagebash
      INFO  - Creating diagnostic archive ...
      INFO  - Created diagnostic zip '/opt/hivemq/log/diagnostic/diagnostic-20231120-095328-SEQPg.zip' successfully.
    3. Diagnostic archive files are located in the $HIVEMQ_HOME/log folder

To facilitate further investigation, copy the generated zip file and upload it to the associated support ticket. This Diagnostic Archive provides valuable insights for diagnosing and addressing issues within the HiveMQ environment.

...