Monitoring using IBM MQ Adapter

Describes how to monitor IBM MQ applications and track the health status of IBM MQ objects.

Leave Feedback

Introduction

IBM Websphere MQ is a queue-based message-oriented middleware that enables similar or dissimilar applications to communicate securely.

Monitoring activities include:

  • Monitoring IBM MQ applications in the managed environment.
  • Tracking the health status of IBM MQ objects such as queues and queue managers.

For example, you can monitor the state of the queue manager using QMGR.STATE and receive alerts in the alerts browser in the event of any issue.

The IBM MQ key elements include:

  • Queue
  • Queue Manager

Monitoring using IBM MQ adapter

IBM MQ monitoring includes:

  1. Creating metrics
  2. Creating monitors
  3. Creating templates
  4. Assigning credentials
  5. Assigning templates

Step 1: Create IBM MQ metrics

To create IBM MQ metrics:

  1. From All Clients, select a client.
  2. Select Setup > Monitoring > Metrics.
  3. From the METRICS screen, click + Add.
  4. From CREATE METRICS, provide the following parameters:
    • Collector Type: Select Application.
    • Application Type: Select IBM MQ.
    • Name: Provide a Name for the metric.
    • Tag: Refers to the user-defined tags for better filtering.
    • Display Name: Refers to the display Name provided for the metric.
    • Description: Refers to the purpose of the metric.
    • Data Point type: Select the required data point.
    • Units: Select the required values for Units, Unit Multiplication Factor, and Datapoint value conversion lists.
    • Unit Multiplication Factor: Refers to the value chosen to multiply a value based on the chosen unit.
    • Data Point Conversion: Refers to one of the following options:
      • Value
      • Enumerated Map
    • Metric Processing: Refers to one of the following values for processing the Metric:
      • Notification
      • Graph
      • Graph and Notification. To configure values for Graph and Notification, provide details for the following parameters:
        • Warning if value: Refers to the warning threshold value.
        • Critical if value: Refers to the critical threshold value.
        • Subject: Refers to the subject for the metric.
        • Description: Refers to the description for the metric.
  5. Click Save.

The METRICS screen displays the new metric.

Step 2: Create IBM MQ monitor

To create IBM MQ monitor:

  1. From the left pane, click Monitoring > Monitors. The MONITORS screen appears.
  2. From the MONITORS screen, click + Add.
  3. From CREATE A MONITOR, provide the following parameters:
    • Monitor Scope: Refers to the Partner Monitor or Client-Specific Monitor. For Client-Specific Monitor, the client must also be selected.
    • Adaptor Type: Refers to the monitor type. Select Application.
    • Application Type: Refers to the type of resource. Select IBM MQ.
    • Name: Provide a unique name for the monitor.
    • Description: Refers to the details of the added monitors.
    • Metrics: To add metrics, perform the following steps:
      1. From Metrics, click Add Metrics.
        • The Metrics screen appears with the list of available IBM MQ metrics.
        • Note: 20 metric (maximum) is recommended. Adding more number of metrics in a monitor can run into performance issues.
      2. Search the desired metric and click Add Metrics. The Metrics section displays the selected metric.
      3. After adding the metrics, navigate to Configuration Parameters.
    • Configuration Parameters: Refers to the parameters required to monitor IBM MQ.
      To add configuration parameters, perform the following:
      1. Provide Default Value for all the configuration parameters.
      2. Select Configurable checkbox and click + Add.
      3. From the Configuration Parameters screen, provide configuration parameters depending on the managed environment or resources and click Add.
        For example: application.component.name.
      4. From the Configuration Parameters section, provide the default value for the added name. For example: queue.
      5. After providing the configuration parameters, navigate to Instance Filter.
    • Instance Filter: Refers to the following methods chosen to filter the instances:
      • All: Refers to all instances for the configured component.
      • Expression: Refers to the rule that is set to filter the instances depending on the component.
      • To add a rule:
        1. Click +Add.
        2. Select Property and Operator.
        3. Provide a value to filter.
    • Manual Selection: Refers to the physical selection of the instances.
  4. Click Save.

The MONITOR screen displays the IBM MQ monitor.

Step 3: Create IBM MQ template

To create a template:

  1. Go to Setup > Monitoring >Templates.
  2. From the TEMPLATES screen, click + Add.
  3. From MONITOR TEMPLATE, provide the following parameters:
    • Select Template Scope: Refers to the template type.
    • Collector Type: Select Gateway.
    • Monitor Type: Select Monitors for G2 Templates.
    • Applicable for: Select Device.
    • Template Name: Refers to the name of the template.
    • Description: Refers to the summary of the template.
    • Generation: Refers to the generation that the template belongs to.
    • Tags: Refers to the user-defined tags for better filtering.
    • Prerequisites: Refers to the essential things that must be considered while monitoring using the template. For example, SQL services must be checked while monitoring the SQL parameters using the Windows templates.
    • Status: Refers to the active or end-of-life templates.
    • Notes: Refers to the additional information to add to the template.
    • Template Family Name: Refers to the category that applies to the application. For example, Windows server, storage server, and network server.
    • Deployment Type: Refers to one of the following methods to apply the template to the resources:
      • Custom
      • Optional
      • Standard
    • After providing the template details, MONITOR TEMPLATE displays the Monitors section.

      Note: The user interface for the Monitors section varies with the option selected in the collector type.
    • Monitor: To add details in the Monitors section, perform the following:
      1. From the Monitors section, click Add and provide the following in the monitor screen:
        • Frequency: Refer to the frequency to execute the template.
        • Monitor Definition: Refers to the monitor type. For example, select IBM MQ queue monitor.
        • When to Alert: Select Breach of a Threshold.
      2. Select Availability and Alert check-box to initiate monitoring for the desired metrics.
  4. Click Save.

The TEMPLATES section displays the configured details.

Step 4: Assign credentials

Prerequisite: Read-only permission to access the target device.

To assign credentials:

  1. From All Clients, select a client.
  2. Go to Infrastructure > Resources.
  3. From the list of devices, select a device.
  4. Navigate to the device information page and from the center pane, click Credentials.
  5. From the Credentials screen, click +Add.
  6. From Create new credential, provide the following parameters:
    • Name: Refers to the name of the credential.
    • Description: Refers to the description of the new credential.
    • Type: Refers to the application type. Select HTTP.
    • Username: Refers to the username for the credential set.
    • Password: Refers to the password that you set for the credential set.
    • Confirm Password: Provide the same password.
    • Port: Refers to the port used to connect to the application.
    • Connection Time Out (ms): Refers to the time taken for the resource to connect to the application.
  7. Click Save.

The Credentials screen displays the new credentials.

Step 5: Assign template

After creating a template and assigning credentials, assign the template to the resource.

To assign a template to a resource:

  1. From All Clients, select a client.
  2. Go to Infrastructure > Resources.
  3. From Resources, click the desired resource name > resource Details > Monitors > Template.
  4. From the Templates screen, click +Assign Templates.
  5. From Apply Templates > Select Templates > Available templates, select the desired templates.
  6. Click Assign.

The Templates screen displays the selected templates.

Validation

The gateway monitors the application using the assigned templates and displays the results in a graphical format.

To confirm the monitoring of IBM MQ device, review the following:

  • The graph plotted for each and every metric in the template.
  • Alerts generated for metrics in the template by giving thresholds.
Validation

Validation

Global metrics and templates

Global metrics and templates are used to monitor the IBM MQ applications.

Global metrics

Global Metrics - IBM MQ
Metric NameDisplay NameDescriptionUnitDataPoint Type
ibm.mq.admin-api.qmgr.stateQueue manager StateThe queue manager state of the queue managers to retrieve.The state description for running is zero.-Gauge
ibm.mq.admin-api.qmgr.channel-initiator-stateQueue manager channel initiator stateChannel initiator state for the queue manager. The various state descriptions are as follows:
  • 0: Stopped
  • 1: Starting
  • 2: Running
  • 3: Stopping
-Gauge
ibm.mq.admin-api.qmgr.connection-countQueue manager connection CountCurrent depth of the queuecountGauge
ibm.mq.admin-api.queue.current-depthQueue Current depthPercent of store limit usedcountGauge
ibm.mq.admin-api.queue.last-getQueue last getQueue last getSeconds (s)Gauge
ibm.mq.admin-api.queue.last-putQueue last putQueue last putSeconds (s)Gauge
ibm.mq.admin-api.queue.oldest-message-ageQueue oldest message ageOldest message age of the queueSeconds (s)Gauge
ibm.mq.admin-api.queue.open-input-countQueue open input countQueue open input countCountGauge
ibm.mq.admin-api.queue.open-output-countQueue open output countQueue open output countCountGauge
ibm.mq.admin-api.queue.uncommitted-messagesQueue uncommitted messagesQueue uncommitted messagesCountGauge

Global templates

You can monitor IBM MQ application using REST API and SNMP.

API-based integration

  • IBM MQ Software - Queue Manager
  • IBM MQ Software - Queue Monitoring

SNMP-based Integration

  • IBM MQ - Performance
  • IBM MQ - Hardware

Best practices

  • Apply credentials to the device before applying the templates to the device.
  • Configure the monitoring frequency to greater than or equal to 5 minutes.