Connect Your Existing HiveMQ Broker or Edge Instance

To expose the data flowing between your HiveMQ broker and its clients to the platform, you must connect your existing broker deployment to the platform. Only after connecting can the platform contextualize, analyze, and act on that data.

Connecting your brokers to the platform also allows you to manage licensing and entitlements centrally.

If you want to deploy a new broker from the HiveMQ Platform, see Deploy a Broker.

Data Intelligence requires HiveMQ 4.55 (LTS) or later. These steps cover a single-node broker. For a clustered deployment, see Log-based Cluster Transport.

Network Requirements for Connection to the HiveMQ Platform

Your HiveMQ broker initiates every connection to the HiveMQ Platform. The HiveMQ Platform never opens a connection into your network, so you need no inbound firewall rules.

Your firewall must allow the following outbound connection from the host that runs HiveMQ:

Host	Port	Protocol	Purpose
The endpoint in your connection string.	443	TCP with TLS (gRPC over HTTP/2)	Information model synchronization, agent registration, and governance metrics

Host

Port

Protocol

Purpose

The endpoint in your connection string.

443

TCP with TLS (gRPC over HTTP/2)

Information model synchronization, agent registration, and governance metrics

Before You Begin

Before you connect an existing HiveMQ broker or Edge instance, make sure you have:

A running HiveMQ broker or HiveMQ Edge deployment.
Access to the environment where the broker runs.
A valid license key, if your setup requires one.

Connect an existing HiveMQ broker

On Connect, click Get Broker or Edge.
On the How do you want to get started? page, select Connect what you already run.
Select HiveMQ Broker, then click Continue.
Enter a name and an optional description for the broker, then click Generate connection string to continue.
Follow the guided steps in the UI to set the provided environment variable on your broker and add the generated connection string.
Restart the broker.
Return to the platform and confirm that the broker status changes to Connected in the Network view.

Connect an existing HiveMQ Edge instance:

On Connect, click Get Broker or Edge.
On the How do you want to get started? page, select Connect what you already run.
Select HiveMQ Edge, then click Continue.
Enter a name and an optional description for the Edge instance, then click Generate connection string to continue.
Use the copy icon to copy the provided connection string.
Open the HiveMQ Edge Web Console.
On the Home page of the console, select Connect with HiveMQ Platform under Connect to HiveMQ Platform.
Paste the connection string that you copied into the Connection String field and click Submit.
Return to the platform and confirm that the Edge instance status changes to Connected in the Network view.

Confirm Your Connection

When the broker or Edge instance successfully reaches the platform, it appears in the Network view on Connect with a connected status.

If the broker or Edge instance does not connect:

Verify that the license or configuration values are correct.
Confirm that the broker restarted successfully.
Make sure the deployment can reach the platform.

Next Steps

To test that your broker communicates successfully with a client, see Test Client-Broker Communication.
To see more context about the data that streams through your connected broker, see Discovery.
To add or manage broker licensing, see Get a License.

For More Information

To learn more about connection states in the Network view, see Connect - The Network View.