Monitoring using IBM MQ Adapter

Provides the steps to monitor your IBM MQ application.

Leave Feedback

Introduction

IBM Websphere MQ is a queue-based message-oriented middleware that enables similar or dissimilar applications to communicate securely. The key elements of IBM MQ are:

  • Message
  • Queue
  • Queue Manager

Using OpsRamp, with administrative rights, you can monitor the IBM MQ applications in your environment and track the health status of IBM MQ objects such as queues, topics, channels, listeners, 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.

Monitoring using IBM MQ adapter

Perform the following steps to initiate the IBM MQ monitoring:

  1. Create Metrics
  2. Create Monitors
  3. Create Templates
  4. Assign Templates

Step 1: Create IBM MQ metrics

To create IBM MQ metric:

  1. From All Clients, select a client.
  2. Select Setup > Monitoring > Metrics.
  3. From the METRICS screen, click + Add.
    CREATE METRIC screen appears.
  4. From CREATE METRICS, provide the following details for the following parameters and click Save:
    • 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.

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 MONITORS screen, click + Add.
    CREATE A MONITOR screen appears.
  3. From CREATE A MONITOR, provide the details for the following parameters and click Save:
    • Monitor Scope: Refers to the Partner Monitor or Client Specific Monitor. For Client-Specific Monitor, you need to select the Client also.
    • 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:
      a. From Metrics, click Add Metrics. Metrics screen appears with the list of available IBM MQ metrics.
      Note: OpsRamp recommends a maximum of 20 metrics. Adding more number of metrics in a monitor can run into performance issues.

      b. Search the desired metric and click Add Metrics. Metrics section displays the selected metric.
      c. 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 steps:
      a. Provide Default Value for all the configuration parameters.
      b. Select Configurable checkbox.
      c. Click + Add. Configuration Parameters screen appears.
      d. Provide Configuration Parameters depending on your environment or devices and click Add. For example, you can select application.component.name from the list.
      e. From the Configuration Parameters section, provide the default value for the added name. For example, queue.
      f. 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 you set to filter the instances depending on the component. To add a rule, perform the following steps:
        a. Click +Add.
        b. Select Property and Operator.
        c. Provide a value to filter.
    • Manual Selection: Refers to the physical selection of the instances.
      MONITOR screen displays the IBM MQ monitor.

Step 3: Create IBM MQ template

To create a template:

  1. From the left pane in Setup, click Monitoring >Templates.
    TEMPLATES screen appears.
  2. Click + Add. MONITOR TEMPLATE screen appears.
  3. From MONITOR TEMPLATE, provide the details for the following parameters and click Save.
    • 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 you must consider while monitoring using the template. For example, you must check the SQL services 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 that you want 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 Monitors, perform the following steps:
      a. From Monitors section, click Add. The monitor screen appears.

      • 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.

      b. Select Availability and Alert check-box to initiate monitoring for the desired metrics.
      TEMPLATES section displays the configured details.

Step 4: Assign template

After creating a template, you can assign the templates to the resources.

Prerequisite

Create credentials to assign a template to a device.

Assigning credentials

To assign credentials:

  1. From All Clients, select a client.
  2. Go to Infrastructure > Resources.
  3. From the list of devices, select a device.
    Navigates to the device information page.
  4. From the center pane, click Credentials. Credentials screen appears.
  5. Click +Add.
    Create new credential screen appears.
  6. From Create new credential, provide details for the following parameters and click Save:
    • Name: Refers to the name of the credential.
    • Description: Refers to the description of the new credential.
    • Type: Refers to the application type. Select JMX.
    • 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.
      Credentials screen displays the new credentials

Assigning templates

To assign a template to a device:

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

Validation

OpsRamp Gateway monitors the application using the assigned templates and displays the results in a graphical format. You can consider the following points to confirm the monitoring of IBM MQ device:

  • 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, monitors, and templates

OpsRamp offers the following Global Metrics, Monitors, Templates that you can use to monitor the IBM MQ applications.

Global metrics

Global Metrics - IBM MQ
NameDisplay NameDescriptionUnitDataPoint Type
ibm.mq.admin-api.qmgr.state
The queue manager state of the queue managers to retrieve.-Gauge
ibm.mq.admin-api.qmgr.channel-initiator-stateQueue manager channel initiator state
-Gauge
ibm.mq.admin-api.qmgr.connection-countQueue manager connection Count
countGauge
ibm.mq.admin-api.queue.current-depth
Percent 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-count
CountGauge
ibm.mq.admin-api.queue.uncommitted-messagesQueue uncommitted messagesQueue uncommitted messagesCountGauge

Global monitors

  • IBM MQ Queue Manager Monitor
  • IBM MQ Queue Monitor

Global templates

  • IBM MQ Queue Manager Template
  • IBM MQ Queue Template

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.