In this article we will configure Instana agent to collect metrics from IBM integration software including IBM MQ, IBM Integration Bus and IBM App Connect Enterprise (ACE) and IBM DataPower Gateway.

[01.04.2021] Currently Instana supports only metrics for IBM MQ, ACE and DataPower. Tracing and profiling are not available yet. As this is a rapidly changing area please advise the official documentation as well. For your convenience I inserted relevant links through the article.

I will start with IBM MQ and IBM ACE. In my installation I have them installed on the same host. The queue manager ACEQM and integration node ACENODE are created. IBM DataPower Gateway used in the article is deployed as a container in a Kubernetes cluster.

The content:
1. Configuring Instana agent for IBM MQ
2. Configuring Instana agent for IBM Integration Bus (IBM App Connect Enterprise)
3. Configuring Instana agent for IBM DataPower Gateway

1. Configuring Instana agent for IBM MQ

Official guide: https://www.instana.com/docs/ecosystem/ibmmq/

At the first step we will need to configure agent's connection to an administration channel. Hostname, port, channel name and credentials are required.

vim /opt/instana/agent/etc/instana/configuration.yaml
where /opt/instana/agent - Instana agent install path

Configuring Instana agent for IBM MQ

Despite that in my example I used plaintext to set connection parameters there are other more secure options available. See the following link for details:
https://www.instana.com/docs/setup_and_manage/host_agent/configuration/#integration-with-secret-managers

Next we need to provide an MQ client library. Download supported version of com.ibm.mq.allclient on the link: https://developer.ibm.com/components/ibm-mq/articles/mq-downloads

Put the driver into:
/opt/instana/agent/system/com/ibm/mq/com.ibm.mq.allclient/9.1.5.0/com.ibm.mq.allclient-9.1.5.0.jar.

cd /opt/instana/agent/system/com
mkdir -p ibm/mq/com.ibm.mq.allclient/9.1.5.0/
cd ibm/mq/com.ibm.mq.allclient/9.1.5.0/
mv /root/com.ibm.mq.allclient-9.1.5.0.jar ./
That's it. You can go directly to Instana console to see your IBM MQ queue manager metrics.

Infrastructure map will show your queue managers or MQ clusters.

Instana Infrastructure view for IBM MQ

Collected metrics are described on the link: https://www.instana.com/docs/ecosystem/ibmmq/
It includes:

  • number of connections
  • number of messages (in/out/uncommited)
  • queue data
  • topics data
  • channel information
  • listeners

A few screenshots with IBM MQ metrics from Instana dashboard are below:

IBM MQ messages throughput in Instana
IBM MQ Issue event in Instana
IBM MQ channel metrics in Instana

Instana also provides several built-in MQ events like queue depth approaching, channel status, etc.
https://www.instana.com/docs/events_alerts/built-in-events-ref/#ibm-mq
In addition to built-in events, it is possible to create custom events and alerts for all collected metrics.

2. Configuring Instana agent for IBM Integration Bus (IBM App Connect Enterprise)

Official guide: https://www.instana.com/docs/ecosystem/ace/

Add the connection configuration for IBM App Connect Enterprise Instana's sensor.
vim /opt/instana/agent/etc/instana/configuration.yaml

Configuring Instana agent to monitor IBM ACE (IIB)

That's it. No restart needed. After that you can find your App Connect Enterprise on the Infrastructure dashboard:

IBM ACE in Instana

Full list of collected metrics can be found on the link: https://www.instana.com/docs/ecosystem/ace

A few screenshots with IBM App Connect Enterprise metrics from Instana dashboard are below:

IBM App Connect Enterprise Integration server metrics in Instana
IBM App Connect Enterprise flows metrics in Instana
IBM App Connect Enterprise flow nodes in Instana
IBM App Connect Enterprise Compute node metrics in Instana

3. Configuring Instana agent for IBM DataPower Gateway

Official guide: https://www.instana.com/docs/ecosystem/datapower

Add the connection configuration for IBM DataPower Gateway Instana's sensor.
vim /opt/instana/agent/etc/instana/configuration.yaml

The sensor uses DataPower's REST management interface to get the metrics. Thus, the REST management port must be enabled on DataPower. In my case I have a virtual DataPower Gateway deployed in a Kubernetes cluster and 31967 is a REST management port of my DataPower.
The Instana agent can be installed on any host.

Configuring Instana agent to collect metrics from IBM DataPower Gateway

After that you can find your IBM DataPower Gateway on the Infrastructure dashboard:

IBM DataPower Gateway in Instana

Full list of collected metrics can be found on the link: https://www.instana.com/docs/ecosystem/datapower

A few screenshots with IBM App Connect Enterprise metrics from Instana dashboard are below:

IBM DataPower Gateway metrics in Instana
IBM DataPower Gateway interfaces and domains in Instana
IBM DataPower Gateway domain metrics in Instana