This documentation is for WSO2 Message Broker version 2.0.1. View documentation for the latest release.

Viewing Cluster Information

When WSO2 Message Broker is running in clustered mode, queues and topic subscriptions are distributed. Although this is transparent to the user, he may still need to know what nodes are there in the cluster and how queue ownership is dynamically decided. This usability aspect is managed by the Cluster management feature, which allows viewing cluster information using the management console of each Message Broker node. 

Following capabilities are provided by Cluster Management:

  • View Zookeeper coordination details.
  • View Cassandra connection details.
  • View how queue ownership has been decided.
  • View individual, node-wise queue information.

To access each capability,

1. log in to the Message Broker management console and select "Cluster information - Node List" in the "Main" menu.

2. The "Cluster Management" window opens. For example,

The following information is provided by the window.

Cassandra Connection Details

WSO2 MB uses Apache Cassandra as the Message Storage. Therefore, during cluster configuration, the MB instance should be pointed to a running Apache Cassandra server. These connection details are shown here.

Zookeeper Connection Details

WSO2 MB should be pointed to a running Apache Zookeeper server during cluster configuration. User can view that configuration through the "Cluster Management" window.

Node ID

Node ID is assigned to each node joined in the cluster, offering a unique way to identify each node. This is useful when troubleshooting. Each node is considered as a peer, and there's no master-slave concept in WSO2 Message Broker. This section shows the node id assigned to the node and if the node is configured to be clustered or running in standalone mode.

For example,

node ID display

View how queue ownership is decided

When clustered, each queue has an owner (handling the actual processing of the queue), which is dynamically decided according to the load distributed among the cluster nodes. User can view what nodes process which queues, through a table in the "Cluster Management" window as follows.


  • Node ID: This table lists all the nodes that are visible to the server accessed by the management console. After setting up the cluster, users can verify using this table that each server can see one another in the cluster.
  • Number of Queue Workers: Shows how many queues are owned by that server node. This is analogous to the workload owned by each node in the cluster for queues defined.

3. Click the number in the "Number of Queue Workers" column to view individual queue information.

View individual, node-wise queue information

4. This shows the names of the queues owned by the node clicked in step 3. The number of messages yet to be delivered is also shown. For example,

Â