Menu
Grafana Cloud

IBM MQ integration for Grafana Cloud

IBM MQ is a message queue software that can be deployed across a range of different environments. MQ sends and receives messages via message queues to support the exchange of information between applications, systems, and services.

This integration includes useful visualizations for cluster, queue manager, queue, and topic metrics. Metrics such as the number of messages sent and received by queue managers and queues, the number of different queue operations, disk usage, CPU usage, active connections, average queue time, and expired messages.

This integration supports IBM MQ 9.1+

This integration includes 4 useful alerts and 4 pre-built dashboards to help monitor and visualize IBM MQ metrics and logs.

Before you begin

In order for the integration to properly work, you must set up the MQ Prometheus exporter for each queue manager in the cluster.

Set up Prometheus exporter

Each instance of the exporter can be run by running the following setup script.

This file specifies multiple arguments for monitoring your IBM MQ cluster and its objects. Modify this file to ensure that the supplied arguments match your IBM MQ environment.

Key arguments that must be checked include:

  • ibmmq.queueManager=<qmgr>
  • ibmmq.monitoredChannels=<channels>
  • ibmmq.monitoredTopics=<topics>
  • ibmmq.monitoredSubscriptions=<subscriptions>
  • ibmmq.monitoredQueues=<queues>

<qmgr>, <queues>, <channels>, <topics>, <subscriptions> must be replaced with the regular expression that will match the respective object of your instance of the exporter is monitoring.
* ex: Channel Name: LONDON.NEWYORK —-> <channels>: LONDON.*

Windows

See here for additional help on building to run on Windows.

The exporter uses port 9157 by default to expose metrics, however if multiple queue managers are going to be monitored by the Grafana Agent on the same machine, you must change the default port. This can be done using the ibmmq.httpListenPort flag when running the exporter.

For more information on how to configure the exporter for each queue manager, please refer to the documentation for details.

Once deployed, the Grafana Agent should be able to reach the exporter’s exposed metrics endpoint.

Install IBM MQ integration for Grafana Cloud

  1. In your Grafana Cloud stack, click Connections in the left-hand menu.
  2. Find IBM MQ and click its tile to open the integration.
  3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send IBM MQ metrics and logs to your Grafana Cloud instance.
  4. Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your IBM MQ setup.

Post-install configuration for the IBM MQ integration

After enabling the metrics generation, instruct the Grafana Agent to scrape your IBM MQ nodes.

Make sure to change targets in the snippet according to your environment.

You must configure a custom label for this integration:

  • mq_cluster, the value that identifies your IBM MQ cluster

If you want to show logs and metrics signals correlated in your dashboards as a single pane of glass, ensure the following:

  • job must be set to integrations/ibm-mq.
  • mq_cluster should be set to the name of the cluster that includes all of the queue managers the Grafana Agent is monitoring.
  • job and mq_cluster values must match between the metrics scrape and logs scrape configs in your configuration file.
yaml
metrics:
  configs:
    scrape_configs:
      - job_name: integrations/ibm-mq
        static_configs:
        - targets:
          - <exporter-hostname-1>:<exporter-port-1>
          - <exporter-hostname-2>:<exporter-port-2>
          labels: 
            mq_cluster: <your-mq-cluster-name>
logs:
  configs:
    scrape_configs:
    - job_name: integrations/ibm-mq
        static_configs:
            - targets: [localhost] 
            labels:
                job: integrations/ibm-mq
                mq_cluster: <your-mq-cluster-name>
                __path__: /var/mqm/errors/*.LOG
        pipeline_stages:
            - match:
              selector: '{job="integrations/ibm-mq",instance=<exporter-hostname:exporter-port>}'
              stages:
              - regex:
                  source: filename
                  expression: "/var/mqm/qmgrs/(?P<qmgr>.*?)/errors/.*\\.LOG"
              - labels:
                  qmgr:
            - multiline:
                firstline: '^\s*\d{2}\/\d{2}\/\d{2}\s+\d{2}:\d{2}:\d{2}\s*-'

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

yaml
    - job_name: integrations/ibm-mq
      metrics_path: "/metrics"
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
        - replacement: '<your-cluster-name>'
          target_label: mq_cluster
      static_configs:
        - targets:
          - '<exporter-hostname-1>:<exporter-port-1>'
          - '<exporter-hostname-2>:<exporter-port-2>'

Below logs.configs.scrape_configs, insert the following lines according to your environment.

yaml
    - job_name: integrations/ibm-mq
      static_configs:
        - targets: [localhost]
          labels:
            job: integrations/ibm-mq
            instance: '<your-instance-name>'
            mq_cluster: '<your-cluster-name>'
            __path__: /var/mqm/errors/*.LOG
      pipeline_stages:
        - match:
            selector: '{job="integrations/ibm-mq",instance="<your-instance-name>"}'
            stages:
            - regex:
                source: filename
                expression: "/var/mqm/qmgrs/(?P<qmgr>.*?)/errors/.*\\.LOG"
            - labels:
                qmgr:
        - multiline:
            firstline: '^\s*\d{2}\/\d{2}\/\d{2}\s+\d{2}:\d{2}:\d{2}\s*-'

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the IBM MQ integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml
integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/ibm-mq
      static_configs:
        - targets: [localhost]
          labels:
            job: integrations/ibm-mq
            instance: '<your-instance-name>'
            mq_cluster: '<your-cluster-name>'
            __path__: /var/mqm/errors/*.LOG
      pipeline_stages:
        - match:
            selector: '{job="integrations/ibm-mq",instance="<your-instance-name>"}'
            stages:
            - regex:
                source: filename
                expression: "/var/mqm/qmgrs/(?P<qmgr>.*?)/errors/.*\\.LOG"
            - labels:
                qmgr:
        - multiline:
            firstline: '^\s*\d{2}\/\d{2}\/\d{2}\s+\d{2}:\d{2}:\d{2}\s*-'
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/ibm-mq
      metrics_path: "/metrics"
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
        - replacement: '<your-cluster-name>'
          target_label: mq_cluster
      static_configs:
        - targets:
          - '<exporter-hostname-1>:<exporter-port-1>'
          - '<exporter-hostname-2>:<exporter-port-2>'
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The IBM MQ integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

  • IBM MQ cluster overview
  • IBM MQ queue manager overview
  • IBM MQ queue overview
  • IBM MQ topics overview

IBM MQ cluster overview

IBM MQ cluster overview

IBM MQ queue manager overview (performance)

IBM MQ queue manager overview (performance)

IBM MQ queue overview

IBM MQ queue overview

Alerts

The IBM MQ integration includes the following useful alerts:

AlertDescription
IBMMQExpiredMessagesCritical: There are expired messages, which imply that application resilience is failing.
IBMMQStaleMessagesWarning: Stale messages have been detected.
IBMMQLowDiskSpaceCritical: There is limited disk available for a queue manager.
IBMMQHighQueueManagerCpuUsageCritical: There is a high CPU usage estimate for a queue manager.

Metrics

The most important metrics provided by the IBM MQ integration, which are used on the pre-built dashboards and Prometheus alerts, are as follows:

  • ibmmq_channel_xmitq_time_long
  • ibmmq_channel_xmitq_time_short
  • ibmmq_cluster_suspend
  • ibmmq_qmgr_active_listeners
  • ibmmq_qmgr_commit_count
  • ibmmq_qmgr_connection_count
  • ibmmq_qmgr_expired_message_count
  • ibmmq_qmgr_log_in_use_bytes
  • ibmmq_qmgr_log_write_latency_seconds
  • ibmmq_qmgr_published_to_subscribers_bytes
  • ibmmq_qmgr_published_to_subscribers_message_count
  • ibmmq_qmgr_queue_manager_file_system_free_space_percentage
  • ibmmq_qmgr_queue_manager_file_system_in_use_bytes
  • ibmmq_qmgr_ram_total_bytes
  • ibmmq_qmgr_ram_total_estimate_for_queue_manager_bytes
  • ibmmq_qmgr_status
  • ibmmq_qmgr_system_cpu_time_percentage
  • ibmmq_qmgr_uptime
  • ibmmq_qmgr_user_cpu_time_estimate_for_queue_manager_percentage
  • ibmmq_qmgr_user_cpu_time_percentage
  • ibmmq_queue_average_queue_time_seconds
  • ibmmq_queue_depth
  • ibmmq_queue_expired_messages
  • ibmmq_queue_mqclose_count
  • ibmmq_queue_mqget_bytes
  • ibmmq_queue_mqget_count
  • ibmmq_queue_mqinq_count
  • ibmmq_queue_mqopen_count
  • ibmmq_queue_mqput_bytes
  • ibmmq_queue_mqput_mqput1_count
  • ibmmq_queue_mqset_count
  • ibmmq_queue_oldest_message_age
  • ibmmq_subscription_messsages_received
  • ibmmq_subscription_time_since_message_published
  • ibmmq_topic_messages_received
  • ibmmq_topic_publisher_count
  • ibmmq_topic_subscriber_count
  • ibmmq_topic_time_since_msg_received

Changelog

md
# 0.0.3 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.2 - August 2023

* Add regex filter for logs datasource

# 0.0.1 - July 2023

* Initial release

Cost

By connecting your IBM MQ instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.