HiveMQ 4.46.x to 4.47.x Migration Guide

This is a minor HiveMQ upgrade. HiveMQ 4.47 is a drop in replacement for HiveMQ 4.46.x.

You can learn more about all the new features HiveMQ 4.47 introduces in our release blogpost.

HiveMQ is prepackaged with all HiveMQ Enterprise Extensions (disabled), HiveMQ Data Hub, the open-source MQTT CLI tool, and the HiveMQ Swarm load-testing tool (MQTT CLI and HiveMQ Swarm are located in the tools folder of your HiveMQ installation).

HiveMQ 4.28 is the current HiveMQ LTS release. If you have not already done so, we recommend upgrading to HiveMQ version 4.28 or above.
To upgrade from the previous 4.9 LTS to HiveMQ 4.29 and above, you must first upgrade to the new 4.28 LTS version.
For more information, see the HiveMQ 4.9 to 4.28 Migration Guide, HiveMQ Rolling Upgrade Policy^, and our Managing HiveMQ Releases and Support blog post.
When you migrate from one HiveMQ version to another, we recommend that you review the upgrade information for each version between your current HiveMQ version and the target HiveMQ version.
Note changes that are relevant to your use case and adjust your configuration as needed.

Known Issues

There are no known issues for the 4.47 release.

Anonymous Usage Statistics Change

Starting with HiveMQ 4.47, anonymous usage tracking is enabled by default. This data helps us understand how the product is used and guides future improvements to the HiveMQ platform.

If you prefer not to send anonymous usage data, you can explicitly disable the feature in your config.xml file:

...
<anonymous-usage-statistics>
    <enabled>false</enabled>
</anonymous-usage-statistics>
...

If you previously removed this configuration to disable statistics, you must add the configuration with <enabled>false</enabled> to maintain the disabled status after upgrading to HiveMQ 4.47 or later.

If no configuration is present, statistics are automatically enabled when you upgrade to version 4.47 or higher.

For complete configuration details and a list of all data collected, see Anonymous Usage Statistics.

ESE Helper Tool Changes

HiveMQ 4.47 introduces changes to the location and bundled-content of the ESE Helper command-line tool for the HiveMQ Enterprise Security Extension:

New position of the ESE Helper in the extension folder
hivemq-enterprise-security-extension$ tree -L 1
.
├── README.html
├── README.txt
├── drivers
├── lib
├── conf
├── hivemq-enterprise-security-extension-1.0.0.jar
├── helper (1)
│   ├── hivemq-ese-helper (2)
│   └── hivemq-ese-helper.jar (3)
├── hivemq-extension.xml
├── third-party-licenses
└── scripts
1 The ESE Helper folder
2 The Bash wrapper script
3 The JAR file (requires at least Java 11)

If you reference the previous path in any scripts or automated workflows, you must update paths accordingly to ensure continued compatibility.

Additionally, the following binaries have been removed from the helper folder:

  • The binary executable for Darwin (Mac OS X)

  • The binary executable for GNU/Linux

For complete configuration details, see ESE Helper Tool.

Upgrade a HiveMQ Cluster

Rolling upgrades are supported, and it is possible to run HiveMQ version 4.46 and version 4.47 simultaneously in the same cluster. By default, the HiveMQ cluster enables all new cluster features when all nodes are upgraded to the new version. No manual intervention is required.

Please follow the instructions in our user guide to ensure a seamless and successful rolling upgrade.

Upgrade a Single-node HiveMQ Instance

  • Create a backup of the entire HiveMQ 4.46.x installation folder from which you want to migrate.

  • Install HiveMQ 4.47 as described in the HiveMQ Installation Guide.

  • Migrate the content of the config.xml and license files from your old HiveMQ 4.46.x installation.

  • To migrate your persistent data, copy everything from the data folder of your backup to the data folder of the new HiveMQ 4.47 installation.

HiveMQ Configuration File Changes

HiveMQ prevents the startup if your configuration file contains invalid values. For more information, see Configuration Validation.

HiveMQ Persistent Data Migration

When you migrate, HiveMQ automatically updates the file storage formats of all the data that you copied into your new data folder.

To migrate the persistent data, you must copy everything in the data folder of the previous HiveMQ 4.46.x installation to the data folder of your new HiveMQ 4.47 installation.

Linux example
cp -r /opt/hivemq-4.46.0/data/* /opt/hivemq-4.47.0/data/

The first time you start HiveMQ 4.47, the file storage formats of the persistent data from your previous installation are automatically updated in the new persistent storage.