Connect-The Network View

The Network view on the Connect page shows every HiveMQ Broker or HiveMQ Edge instance that the HiveMQ Platform knows about. The view lists all instances that you connected to the platform. The view also lists instances that the platform detected, but that you have not yet connected. Use the Network view to confirm that your data is ready to deliver insight.

Before You Begin

Before you deploy a Broker or Edge instance using the HiveMQ Platform, the Network view does not appear in the Connect & Manage Network overview. When you first log in to the platform, Connect & Manage Network displays No brokers or edges detected yet and offers three options:

  • Get a broker or edge: Deploy a new HiveMQ broker or edge in the cloud or on-prem. For instructions, see Deploy a Broker.

  • Connect what you already run: Register an existing HiveMQ broker or HiveMQ Edge instance. For instructions, see Connect a HiveMQ Broker to the Platform.

  • Get a license: Purchase a license for a self-managed HiveMQ broker. For instructions, see Get a License.

When an Instance Appears in the Network View

The Network view appears in Connect & Manage Network when the platform detects an instance registered to your account. You do not add an instance to the Network view directly. The platform detects a deployment after you do one of two tasks:

Deployment alone does not add an instance to the view. An instance appears in Network only after it reports to the platform and the platform associates it with your account. If you have a running broker but the Network list is empty, you have not yet connected the broker to the platform. For more information, see Troubleshooting.

Network View Rows

A Broker or Edge instance appears as a row in the Network view when the platform first detects its deployment.

Network View Columns

The Network View presents details for each instance that the platform detects as columns that you can view, filter, and sort.

Table 1. Network View Column Descriptions
Column What it Shows Values

Name

The display name you chose for the instance

Free-text display name

Type

What kind of instance this is

Broker, Edge

Deployment

How the instance is run and licensed

Cloud, Software, License

Data Intelligence

Whether the instance is connected to the Data Intelligence capabilities of the platform

Not ready to connect, Ready to connect, Connected, Offline, Not eligible

Name

The display name you entered when you created the connection string or purchased the license. The platform shows the name with an optional description. The name is a label that helps you recognize the instance. You can choose any name. Names do not need to be unique and do not have to match the hostname or cluster name of the broker.

Type

  • Broker: A HiveMQ Broker (Cloud or Software) instance.

  • Edge: A HiveMQ Edge instance.

Deployment

  • Cloud: A HiveMQ Cloud Broker that HiveMQ manages and operates.

  • Software: A HiveMQ Broker that you deploy and that reports to the platform.

  • License: A license you have purchased but have not yet deployed and connected. After a deployment with that license key completes an online entitlement call successfully, the Deployment changes to Software.

Data Intelligence

The Data Intelligence column shows you the state of the Broker or Edge during the connection process.

State Meaning

Not ready to connect

The deployment is still pending. This state typically applies after you purchase a license but before any deployment reports to the platform.

Ready to connect

The instance is known to the platform, but the connection is still pending. This state appears right after you generate a connection string and before you apply it to the broker.

Connected

The instance is up, running, and connected to Data Intelligence. This state is the goal. Connected means that the platform can act on data for this broker.

Offline

The instance was connected but no longer reaches the platform. For example, the broker was shut down and has stopped reporting to the platform.

Not eligible

The instance cannot use Data Intelligence. This state applies to HiveMQ Cloud Serverless, Starter, and Enterprise subscriptions.

How an Instance Changes Its State

Self-Managed Broker (HiveMQ Broker)

  1. You generate a connection string and the broker appears. Data Intelligence shows Ready to connect.

  2. You apply the connection string and restart the broker. The broker connects. Data Intelligence shows Connected.

Purchased License

  1. You buy a license. The license appears with Deployment License, Data Intelligence shows Not ready to connect.

  2. You deploy a broker, apply the license key, and the broker reports to the platform. Deployment changes to Software and Data Intelligence shows Ready to connect.

  3. You apply the connection string and restart the broker. Data Intelligence shows Connected.

    A purchased license still requires the connection-string step. A license alone does not connect the broker.

HiveMQ-Managed Broker (HiveMQ Cloud)

HiveMQ Cloud Broker instances show a Running status and a Data Intelligence Not eligible state. Data Intelligence is not currently available for HiveMQ Cloud Broker instances.

Suggested Actions

Select any instance shown in the Network view to view more Details for the instance.

The Network view suggests an action for each instance, based on its instance type, deployment type, and current data intelligence state. For example, the first row in the following table shows how a HiveMQ broker appears in the Network view after you connect it to the platform.

Table 2. Suggested Actions by Instance Type, Deployment, and Data Intelligence State
Instance Type Deployment Type Data Intelligence State Suggested Action

Broker

Software

Connected

Discover traffic

Broker, Edge

Software

Ready to connect

Connect. Open the instance Detail view, where you complete the connection (apply the connection string).

Broker, Edge

License

Not ready to connect

Get Broker or Edge

Broker, Edge

Software

Offline

Reconnect

Broker

Cloud (Running)

Not eligible

Configure

For more information about connecting an instance manually, see Connect a HiveMQ Broker to the Platform. To view more details for a HiveMQ Cloud broker, in Broker Details, click Configure.

Next Steps

To learn more about Data Intelligence in the HiveMQ Platform, see Discovery.

Troubleshooting:

"I Deployed a Broker, but It’s Not in Network on Connect"

This behavior is expected. A HiveMQ broker does not register with the platform when you deploy it. To appear in Network on Connect, a Broker instance must report to the platform and associate with your account. HiveMQ Cloud brokers register automatically when you deploy them using the HiveMQ Platform. If you deploy a HiveMQ Enterprise MQTT Broker from HiveMQ software, register the broker manually. For the steps, see Connect a HiveMQ Broker to the Platform. If you completed this procedure, and the instance does not connect, check the path to the configuration file, the connection string, and confirm that the broker restarted.