5.3. Monitoring the Message Brokers in a Container


Abstract

The broker details page allows you to monitor all of the brokers deployed into a container.
The broker details page for a container allows you to monitor the brokers that are deployed into a container. The information about the brokers is broken down into five discreet pages:
  • the broker summary page
  • the network connector details page
  • the queue details page
  • the topic details page
  • the subscription details page
The broker summary page is the main page for monitoring the brokers. The details pages are available when a broker is selected from the list. The pages that become available depend on the broker's configuration.

5.3.1. Viewing a Summary of the Brokers

Abstract

The broker summary page list all of the brokers deployed into a container and an overview of its health.

Overview

The broker details page for a container is the main page for monitoring the brokers. It lists all of the message brokers deployed in the container. In addition it will show basic information about a selected broker instance. From this page you can drill down into pages that provide more detailed information about any of the brokers.

The broker list

The list of brokers shows the following details:
  • the name of the broker
  • the number of producers connected to the broker
  • the number of messages posted to destinations on the broker
  • the number of consumers connected to the broker
  • the number of messages consumed by clients connected the broker

Individual broker information

Selecting one of the brokers from the list shows additional details about the selected broker including:
  • the version of message broker
  • the URL clients can use to connect to the broker
  • the amount of system memory allocated to the broker
  • the percentage of the allocated system memory used by the broker
  • the space allocated for the persistence store
  • the percentage of the allocated space used by the persistence store
  • the location of the broker's data directory

Drilling down

When a broker is selected from the list, any of the following buttons may appear:
  • Network Connectors—opens a new page containing details about the network connectors configured on the broker
  • Queues—opens a new page containing details about the queues managed by the broker
  • Topics—opens a new page containing details about the topics managed by the broker
  • Active/Inactive Subscriptions—opens a new page containing details about the subscriptions being managed by the broker

Related topics

Section 5.3.2, “Monitoring a Message Broker's Queues”
Section 5.3.3, “Monitoring a Message Broker's Topics”

5.3.2. Monitoring a Message Broker's Queues

Abstract

The queue details page provides statistics about the health of the message queues being managed by a broker.

Overview

A broker's queue details page lists all of the queues managed by a broker. For each broker in the list it will also display detailed metrics for the queue.

Queue list

The left hand list shows all of the queues managed by the broker. In addition to the queue's name, the list displays the following information:
  • the number of producers attached to the queue
  • the number of messages sent to the queue
  • the number of consumers attached to the queue
  • the number of messages consumed from the queue

Queue details

Selecting one of the queues from the list will display additional details on the right side of the page. These details include:
  • the amount of memory allocated for the queue
  • the percentage of the allocated memory in use
  • the maximum amount of time, in milliseconds, a message stayed on the queue
  • the minimum amount of time, in milliseconds, a message stayed on the queue
  • the average amount of time, in milliseconds, a message stayed on the queue
  • the number of messages in the queue that have been consumed, but not acknowledged
  • the number of messages that have been dispatched to, but not acknowledged, by consumers
  • the amount of memory allocated to the queue's cursor
  • the percentage of the allocated memory in use by the cursor
  • the status of the cursor
  • the number of messages in the cursor
  • if message are being buffered
  • if message cashing is enabled
  • if producer flow control is active

5.3.3. Monitoring a Message Broker's Topics

Abstract

The topic details page provides statistics about the health of the message topics being managed by a broker.

Overview

A broker's queue details page lists all of the queues managed by a broker. For each broker in the list it will also display detailed metrics for the queue.

Topic list

The left hand list shows all of the topics managed by the broker.

Topic details

Selecting one of the topics from the list will display additional details on the right of the page. These details include:
  • the amount of memory allocated for the topic
  • the percentage of the allocated memory in use
  • the maximum amount of time, in milliseconds, a message stayed on the topic
  • the minimum amount of time, in milliseconds, a message stayed on the topic
  • the average amount of time, in milliseconds, a message stayed on the topic
  • the number of messages published to the topic
  • the number of messages consumed from the topic
  • the number of messages in the topic that have been consumed, but not acknowledged
  • the number of messages that have been dispatched to, but not acknowledged, by consumers
  • the maximum number of messages that can be paged
  • if message caching enabled
  • if producer flow control is active

5.3.4. Monitoring a Message Broker's Subscriptions

Abstract

The subscription details page provides statistics about the health of the message topics being managed by a broker.

Overview

The subscription details for a broker are broken up according to if the subscription is currently active. The broker details page will have separate buttons for active subscriptions and inactive subscriptions.
A broker's subscription details page lists all of the subscriptions managed by a broker. For each broker in the list it will also display detailed metrics for the subscription.

Topic list

The left hand list shows subscriptions managed by the broker.

Topic details

Selecting one of the subscriptions from the list will display additional details on the right of the page. These details include:
  • the client ID used when the subscription was created
  • the connection ID
  • the subscription's ID
  • the session ID of the consumer if it is active
  • the number of messages that have been consumed
  • the number of messages currently being actively pushed to the consumer
  • the number of messages waiting in the pending queue to be consumed
  • the number of messages waiting in the dispatch queue to be consumed
  • the number of messages that have been dispatched to, but not acknowledged, by the consumer
  • the total number of messages that have been dispatched to the consumer
  • the amount of memory allocated to the queue's cursor
  • the percentage of the allocated memory in use by the cursor
  • the status of the cursor
  • the number of messages in the cursor
  • if the consumer will try to recover all of the messages it missed due to a broker failure
  • if the consumer is considered slow by the broker
  • if locally set messages are filtered out
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.