ActiveMQ Monitoring USER GUIDE

General information

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 provies information on the messages being processed in the queue.
Topic Tracks the number of consumers and topics that are existing within the broker.
   

This guide discusses the steps to set up the ActiveMQ integration on a Gateway. Once the integration is set up, the samplers providing the dataviews become available to that Gateway.

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

User requirements

This monitoring template is a Gateway configuration setup that can be included in the Gateway Setup Editor.

To use this template, your configuration must meet the following requirements:

  • A machine running the Netprobe must have access to the HTTP address and port published by the ActiveMQ.
  • An Active Console 2 that is connected to the Gateway.
  • A JMX-enabled ActiveMQ broker instance.
  • ActiveMQ configuration files extracted to their Gateway set-up.

System requirements

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

  • Template package: geneos-integration-activemq-<version>.zip.
  • Managed entities utilising the samplers defined in include/ActiveMQMonitoring.xml.
  • Netprobe version 4.5 or higher.

Note: This template is verified to be working with ActiveMQ version 5.15.3.

 

Audience

This document is a reference guide to introduce templates and scripts built using the Geneos development toolkit plug-ins.

The template allows you to integrate specific applications and services to collect metrics without having to create a new plug-in.

 

Install and set up

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

  1. Download the config file (geneos-integration-activemq-<version>.zip) from the ITRS Downloads site.
  2. Open Active Console 2.
  3. Extract the ActiveMQ monitoring configuration file into the Gateway Setup directory.
  4. Click Includes to create a new file in the Navigation panel.
  5. Enter the location of the file to include in the Location field. In this example, use the include/ActiveMQMonitoring.xml.
  6. Note: The priority controls the importance of a file when merging. Sections in a higher priority file will take precedence over sections in a lower priority file. This priority setting affects the priority of configuration in the main setup file.

  7. Expand the file location in the Includes section.
  8. Select Click to load...
  9. Click Yes to load the new ActiveMQ include file.
  10. Click Managed entities in the Navigation panel.
  11. Add the ActiveMQ-Monitoring type to the Managed Entity section that you will use to monitor ActiveMQ.
  12. Click the Validate button to check your configuration.

The Validate button allows you to check if there are any errors or warnings in your configuration set-up.

Once the Gateway configuration appears in the Includes section, you can add the samplers and other variables.

 

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.
   

After checking and saving the changes, the samplers you have set in the Gateway configuration display in Active Console 2.

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.

  1. Enter the location of the file to include in the Location field. In this example, use the include/ActiveMQMonitoring-SampleRules.xml:
  2. Note: The priority controls the importance of a file when merging. Sections in a higher priority file will take precedence over sections in a lower priority file. This priority setting affects the priority of configuration in the main setup file.

  3. Expand the file location in the Includes section.
  4. Select Click to load...
  5. Click Yes to load the new ActiveMQ include rules file.
  6. Click Rules in the Navigation panel to create new rules.

The table below shows the included rule set-up in the configuration file:

Rules Description
ActiveMQ-MemoryUsage Checks the Broker's memory usage.
   

Once the Gateway for rules configuration appears in the SampleRules Includes section, you can set the rules and alerts.