Chapter 4. Using the Red Hat AMQ Console

You can use the Red Hat AMQ Console to perform tasks such as creating and deleting an address space, creating an address, and viewing message and connection statistics.

4.1. Red Hat AMQ Console user permissions

Red Hat AMQ Console uses the OpenShift RBAC permissions model.

To use Red Hat AMQ Console, the OpenShift user requires a role that grants access to addressspace and address resources. For example, for edit access, create, update and delete permissions need be to given to the associated role object, and for view-only access, list permissions need to be granted.

For more information about the AMQ Online example roles, see AMQ Online example roles.

4.2. Accessing the Red Hat AMQ Console

Prerequisites

  • On OpenShift Container Platform 3.x, obtain the host name for the Red Hat AMQ Console by running the following command:

    oc get routes console -o jsonpath={.spec.host}
  • On OpenShift Container Platform 4.x, obtain the host name for the Red Hat AMQ Console by running the following command:

    oc get consolelink -l app=enmasse -o jsonpath={.spec.href}

Procedure

  1. In a web browser, navigate to https://console-host-name where console-host-name is the Red Hat AMQ Console host name.
  2. Log in with your OpenShift user credentials. The Red Hat AMQ Console opens and lists all the address spaces that you can administer. For information on creating an address space, see Creating an address space using the Red Hat AMQ Console.
Red Hat AMQ Console

4.3. Viewing message and application connection statistics using the Red Hat AMQ Console

Prerequisites

  • You must be logged into the Red Hat AMQ Console.
Red Hat AMQ Console

Table 4.1. Message statistics reference table

To view…​On the Addresses page…​

Address type

See the first icon in the second column, Type/plan

Address plan

See the string that follows the icon in the second column, Type/plan

Address status

See the third column, Status

Messages received per second (computed over the last 5 minutes)

See Messages In/sec

Messages sent per second (computed over the last 5 minutes)

See Messages Out/sec

Queue and topic address types only: Number of stored messages on the broker or brokers

Stored Messages

Number of senders attached

See Senders

Number of receivers attached

See Receivers

Standard address space only: Message deliveries per second

Click the desired address, which then shows the links page for that address; see the Delivery Rate column.

Red Hat AMQ Console

Table 4.2. Application connection statistics reference table

To view…​On the Connections page…​

Messages received per second (computed over the last 5 minutes)

See Messages In/sec

Standard address space only: Messages sent per second (computed over the last 5 minutes)

See Messages Out/sec

Total number of messages delivered

Click the desired host name to show the list of senders and receivers; see the Deliveries column.

Note

For the brokered address space only, on the Connections page, the number of senders is either 0 or 1. As soon as one or more senders exist, 1 is displayed rather than reflecting the actual number of senders.

4.4. Viewing endpoint information using the Red Hat AMQ Console

You can use the Red Hat AMQ Console to view information about the endpoints configured for a given address space. You need this information to connect your messaging application to AMQ Online.

Prerequisites

Red Hat AMQ Console

Table 4.3. Messaging endpoint information reference table

ColumnDescription

Name

Displays the name of the endpoint.

Type

Displays the type of endpoint. Valid values include:

cluster
An endpoint accessible on the OpenShift cluster through a cluster IP address.
route
An OpenShift route available outside the cluster.
loadbalancer
A LoadBalancer service integrating with an external load balancer.

For more information, see the following OpenShift documentation:

Host

Displays the host name of the endpoint.

Ports

Displays the port protocol name and port number of the endpoint. Valid port names include:

AMQP
Advance Messaging Queuing Protocol
AMQPS
Advance Messaging Queuing Protocol over TLS
AMQP-WS
AMQP-WebSocket protocol
AMQP-WSS
AMQP-WebSocket protocol over TLS

4.5. Purging queues and subscriptions

You can purge—​that is, clear all messages from—​a queue or subscription address type of its stored messages by using the Red Hat AMQ Console.

Prerequisites

  • You must have a queue or subscription that contains stored messages.

Procedure

  1. Log in to the Red Hat AMQ Console. For more information, see Accessing the Red Hat AMQ Console.
  2. Navigate to the Addresses page.
  3. Select the check box next to the queue or subscription that you want to purge.
  4. At the top of the page, right-click the vertical ellipsis icon and select Purge. The queue or subscription is purged, and the Stored message count drops to zero for the selected queue or subscription.

4.6. Closing connections using the Red Hat AMQ Console

If an application has unexpectedly stopped processing messages, you can force the application’s messaging connections to close using the Red Hat AMQ Console. This may be a useful way to return the application to service.

Be aware that closing a connection closes the application’s connection to AMQ Online. If the application is configured to do so, the application should reconnect automatically.

Procedure

  1. Log in to the Red Hat AMQ Console. For more information, see Accessing the Red Hat AMQ Console.
  2. Navigate to the Connections page.
  3. To close a single connection:

    1. Locate the connection that you want to close.
    2. In the far right column, click the vertical ellipsis icon and select Close.
    3. When prompted, click Confirm to confirm that you want to close the connection. The connection is closed.
  4. To close multiple connections in a single operation:

    1. Select the check box next to the connections that you want to close.
    2. At the top of the page, right-click the vertical ellipsis icon and select Close Selected.
    3. When prompted, click Confirm to confirm that you want to close the connections. The connections are closed.