IBM MQ integration for Grafana Cloud

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 Grafana Alloy 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, Grafana Alloy 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.

Configuration snippets for Grafana Alloy

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your IBM MQ instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

river Copy

discovery.relabel "metrics_integrations_integrations_ibm_mq" {
	targets = concat(
		[{
			__address__ = "<exporter-hostname-1>:<exporter-port-1>",
		}],
		[{
			__address__ = "<exporter-hostname-2>:<exporter-port-2>",
		}],
	)

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}

	rule {
		target_label = "mq_cluster"
		replacement  = "<your-cluster-name>"
	}
}

prometheus.scrape "metrics_integrations_integrations_ibm_mq" {
	targets    = discovery.relabel.metrics_integrations_integrations_ibm_mq.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/ibm-mq"
}

To monitor your IBM MQ instance, you must use a discovery.relabel component to discover your IBM MQ Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within each discovery.relabel component:

• __address__: The address to your IBM MQ Prometheus metrics endpoint.
• instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this IBM MQ instance. Make sure this label value is the same for all telemetry data collected for this instance.
• mq_cluster: The mq_cluster label to group your IBM MQ instances within a cluster. Set the same value for all nodes within your cluster.

If you have multiple IBM MQ servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Advanced logs snippets

linux

river Copy

local.file_match "logs_integrations_integrations_ibm_mq" {
	path_targets = [{
		__address__ = "localhost",
		__path__    = "/var/mqm/errors/*.LOG",
		instance    = constants.hostname,
		job         = "integrations/ibm-mq",
		mq_cluster  = "<your-cluster-name>",
	}]
}

loki.process "logs_integrations_integrations_ibm_mq" {
	forward_to = [loki.write.grafana_cloud_loki.receiver]

	stage.match {
		selector = "{job=\"integrations/ibm-mq\",instance=\"<your-instance-name>\"}"

		stage.regex {
			expression = "/var/mqm/qmgrs/(?P<qmgr>.*?)/errors/.*\\.LOG"
			source     = "filename"
		}

		stage.labels {
			values = {
				qmgr = null,
			}
		}
	}

	stage.multiline {
		firstline     = "^\\s*\\d{2}\\/\\d{2}\\/\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}\\s*-"
		max_lines     = 0
		max_wait_time = "3s"
	}
}

loki.source.file "logs_integrations_integrations_ibm_mq" {
	targets    = local.file_match.logs_integrations_integrations_ibm_mq.targets
	forward_to = [loki.process.logs_integrations_integrations_ibm_mq.receiver]
}

To monitor your IBM MQ instance logs, you will use a combination of the following components:

• local.file_match defines where to find the log file to be scraped. Change the following properties according to your environment:

  • __address__: The IBM MQ instance address
  • __path__: The path to the log file.
  • instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this IBM MQ instance. Make sure this label value is the same for all telemetry data collected for this instance.
  • mq_cluster: The mq_cluster label to group your IBM MQ instances within a cluster. Set the same value for all nodes within your cluster.

• loki.process defines how to process logs before sending it to Loki.

• loki.source.file sends logs to Loki.

windows

river Copy

local.file_match "logs_integrations_integrations_ibm_mq" {
	path_targets = [{
		__address__ = "localhost",
		__path__    = "/var/mqm/errors/*.LOG",
		instance    = constants.hostname,
		job         = "integrations/ibm-mq",
		mq_cluster  = "<your-cluster-name>",
	}]
}

loki.process "logs_integrations_integrations_ibm_mq" {
	forward_to = [loki.write.grafana_cloud_loki.receiver]

	stage.match {
		selector = "{job=\"integrations/ibm-mq\",instance=\"<your-instance-name>\"}"

		stage.regex {
			expression = "/var/mqm/qmgrs/(?P<qmgr>.*?)/errors/.*\\.LOG"
			source     = "filename"
		}

		stage.labels {
			values = {
				qmgr = null,
			}
		}
	}

	stage.multiline {
		firstline     = "^\\s*\\d{2}\\/\\d{2}\\/\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}\\s*-"
		max_lines     = 0
		max_wait_time = "3s"
	}
}

loki.source.file "logs_integrations_integrations_ibm_mq" {
	targets    = local.file_match.logs_integrations_integrations_ibm_mq.targets
	forward_to = [loki.process.logs_integrations_integrations_ibm_mq.receiver]
}

To monitor your IBM MQ instance logs, you will use a combination of the following components:

• local.file_match defines where to find the log file to be scraped. Change the following properties according to your environment:

  • __address__: The IBM MQ instance address
  • __path__: The path to the log file.
  • instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this IBM MQ instance. Make sure this label value is the same for all telemetry data collected for this instance.
  • mq_cluster: The mq_cluster label to group your IBM MQ instances within a cluster. Set the same value for all nodes within your cluster.

• loki.process defines how to process logs before sending it to Loki.

• loki.source.file sends logs to Loki.

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.

Configuration snippets for Grafana Agent

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

yaml Copy

    - 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 Copy

    - 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 Copy

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