Chapter 13. Monitoring using AMQ Console

AMQ Console is a web console for monitoring the status and performance of AMQ Interconnect router networks.

Prerequisites

13.1. Setting up access to AMQ Console

Before you can access the web console, you must configure a listener to accept HTTP connections for the web console and serve the console files.

Procedure

  1. On the router from which you want to access the web console, open the /etc/qpid-dispatch/qdrouterd.conf configuration file.
  2. Add a listener to serve the console.

    This example creates a listener that clients can use to access the web console:

    listener {
        host: 0.0.0.0
        port: 8672
        role: normal
        http: true
        httpRootDir: /usr/share/qpid-dispatch/console
    }
    host
    The IP address (IPv4 or IPv6) or hostname on which the router will listen.
    port
    The port number or symbolic service name on which the router will listen.
    role
    The role of the connection. Specify normal to indicate that this connection is used for client traffic.
    http
    Set this attribute to true to specify that this listener should accept HTTP connections instead of plain AMQP connections.
    httpRootDir
    Specify the absolute path to the directory that contains the web console HTML files. The default directory is the stand-alone console installation directory, usually /usr/share/qpid-dispatch/console.
  3. If you want to secure access to the console, secure the listener.

    For more information, see Section 9.2, “Securing incoming client connections”. This example adds basic user name and password authentication using SASL PLAIN:

    listener {
        host: 0.0.0.0
        port: 8672
        role: normal
        http: true
        httpRootDir: /usr/share/qpid-dispatch/console
        authenticatePeer: yes
        saslMechanisms: PLAIN
    }
  4. If you want to set up access to the web console from any other router in the router network, repeat this procedure for each router.

13.2. Accessing AMQ Console

You can access the web console from a web browser.

Procedure

  1. In a web browser, navigate to the web console URL.

    The web console URL is the <host>:<port> from the listener that you created to serve the web console. For example: localhost:8672.

    The AMQ Console opens. If you set up user name and password authentication, the Connect tab is displayed.

  2. If necessary, log in to the web console.

    If you set up user name and password authentication, enter your user name and password to access the web console.

    The syntax for the user name is <user>@<domain>. For example: admin@my-domain.

13.3. Monitoring the router network using AMQ Console

The web console provides several sections that you can use to monitor the router network.

This section…​Provides…​

Overview

Aggregated information about the router network. This information includes the following:

  • Dashboard (shows router network statistics)
  • Routers
  • Addresses
  • Links
  • Connections
  • Logs

Visualizations

Graphical view of the router network. You can see the following types of visualizations:

Topology
Topology of the router network, including routers, clients, and brokers. This visualization also shows how messages are flowing through the network.
Message flow
A chord diagram showing the real-time message flow by address.

Details

Detailed configuration information about each AMQP management entity, for each router in the router network. You can view and change the configuration of any of the routers in the network.