Geneos

ActiveMQ Monitoring User Guide

Overview

ActiveMQ monitoring is a Gateway configuration file that enables monitoring of ActiveMQ through a set of samplers with customised JMX plug-in settings.

Track the following key areas when using ActiveMQ monitoring:

Key Area Description
Broker Shows the memory usage of the broker metrics.
Queue Monitors the queue size and provides information on the messages being processed in the queue.
Topic Tracks the number of consumers and topics that are existing within the broker.
   

To view the sample metrics and dataviews, see ActiveMQ Monitoring Technical Reference.

Intended audience

This guide is intended for users who are setting up, configuring, troubleshooting and maintaining this integration. Once the integration is set up, the samplers providing the dataviews become available to that Gateway.

As a user, you should be familiar with Java, Unix, or any other database, and with the administration of the ActiveMQ services.

Prerequisites

The following requirements must be met prior to the installation and setup of the template:

  • A machine running the Netprobe must have access to the host where the ActiveMQ instance is installed and the port ActiveMQ is listening to.
  • Netprobe 4.6 or higher. The Netprobe running the ActiveMQ Monitoring integration must be configured with a Java environment. See Configure the Java environment.
  • Gateway 4.8 or higher.
  • ActiveMQ 5.15.3.

Installation procedure

Ensure that you have read and can follow the system requirements prior to installation and setup of this integration template.

  1. Download the integration package geneos-integration-activemq-<version>.zip from the ITRS Downloads site.
  2. Open Gateway Setup Editor.
  3. In the Navigation panel, click Includes to create a new file.
  4. Enter the location of the file to include in the Location field. In this example, it is the include/ActiveMQMonitoring.xml.
  5. Update the Priority field. This can be any value except 1. If you input a priority of 1, the Gateway Setup Editor returns an error.
  6. Expand the file location in the Include section.
  7. Select Click to load.
  8. Click Yes to load the new ActiveMQ include file.

  9. Click Managed entities in the Navigation panel.
  10. Add the ActiveMQ-Monitoring type to the Managed Entity section that you will use to monitor ActiveMQ.
  11. Click the Validate button to check your configuration and save if everything is correct.

Set up the samplers

These are the pre-configured samplers available to use in ActiveMQMonitoring.xml.

Configure the required fields by referring to the table below:

Samplers
ActiveMQ-Broker
ActiveMQ-Queues
ActiveMQ-Topics
 

Set up the variables

The ActiveMQMonitoring.xml template provides the following variables that are set in the Environments section.

Variable Description
ACTIVEMQ_JMX_HOST IP/Hostname to be accessed using JMX plug-in.
ACTIVEMQ_JMX_PORT Port to be accessed using JMX.
ACTIVEMQ_BROKER Name of the Broker to monitor.
ACTIVEMQ_GROUP Sampler group name.
   

Note: The default values can be changed by providing an environment with the same name with a higher priorty in the set-up file, or by using an environment in the Managed entity where the type is defined.

Set up the rules

The ActiveMQMonitoring-SampleRules.xml template also provides a separate sample rules that you can use to configure the Gateway Setup Editor.

Your configuration rules must be set in the Includes section. In the Navigation panel, click Rules.

The included ActiveMQ-MemoryUsage rule set-up in the configuration file checks the Broker's memory usage.