Monitoring Profile Configurable Service Using IIB

By -

Monitoring Profile in IIB

Before discussing in detail about the monitoring profile, it is necessary to understand a few basic concepts related to monitoring.

Message Flows

A message flow is a sequence of processing steps that run in the integration node when an input message is received.


The node is a processing step in a message flow. It has a fixed number of input and output points that are known as terminals. We can make connections between the terminals to define the routes that a message can take through a message flow.


The Event is an XML document which occurs when something interesting happens. The Event is emitted to support transaction monitoring, transaction auditing, and business process monitoring.

Events Customization

We can customize the events that are produced by a message flow by using monitoring properties or a monitoring profile configurable service.

  • Monitoring properties is used to customize events when we are designing the message flow.
  • Monitoring profile is used to customize events after a message flow is deployed, but without redeploying it.

Monitoring Profile

We can create a monitoring profile directly on the integration node and link it with one or more message flows using various operational commands.

Key Facts about Monitoring Profiles:

  • Use a monitoring profile when we want to configure events for a message flow that is deployed and for which no events are configured.
  • It is used to revoke or set aside the monitoring properties of a message flow that is deployed, as an alternative to redeploying the BAR file. The monitoring profile replaces all monitoring properties.
  • A single monitoring profile can be applied to many message flows if those message flows contain the same event sources.

Understanding Monitoring Profile in IIB

Monitoring profile in IBM Integration Bus (IIB) helps to customize monitoring events without redeploying message flows and enabling monitoring profile even if doesn’t require to restart Integration node (broker) or Integration Server (execution group).

We can apply a monitoring profile to one or more message flows.

In Royal Cyber Integration Banking System we had one such service Biller Enquiry Service and the management wanted to evaluate the performance of this service, but they were very reluctant to redeploy the service on Integration Server. So we used monitoring profile feature to enable monitoring without redeploying the service message flows:

Following is a BillerInquiryService message flow that we were supposed to monitor using monitoring profile.

A monitoring profile is an XML document that specifies the event sources in a message flow that will emit events, and the properties of those events. The monitoring profile XML must follow the XML schema file MonitoringProfile.xsd.

We created a monitoring profile for SOAP Input node that contains a single event source to illustrate the structure:

Following are the steps for creating and enabling Monitoring Profile to BillerInquiryService application:

A. Identify The Nodes To Be Monitored:

We identified the SOAP Input node and the start event source of this node and the following monitoring profile was created where we have specified the monitoring data that we intended to extract:

B. Create A Configurable Service/Profile:

Use the mqsicreateconfigurableservice command to create a configurable service for the monitoring profile on your integration node.

Here IN1 is the name of Integration node (Broker) and BillerEnquiryProfile is the name monitoring profile.

1) mqsicreateconfigurableservice IN1 -c MonitoringProfiles -o BillerEnquiryProfile

  • -c identifies the configurable service type
  • -o identifies the name of the configurable service.

Following are the steps for creating and enabling Monitoring Profile to BillerInquiryService application:

mqsichangeproperties command is used to modify the integration node properties and properties of integration node resources.

Use the mqsichangeproperties command to associate your monitoring profile XML file with the configurable service.

In the following command, IN1 is the name of Integration node (Broker), BillerEnquiryProfile is the name of monitoring profile created in step 1 and

D:\ BillerEnquiry.xml is the location and name of monitoring profile by which we want to override Integration node profile.

2) mqsichangeproperties IN1 -c MonitoringProfiles -o BillerEnquiryProfile -n profileProperties -p “D:\ BillerEnquiry.xml”
When the payload is included in a monitoring message, setting this property to TRUE forces the wmb:applicationData/wmb:complexContent/wmb:elementName attribute to contain the name of the input node parser if present.

3) mqsichangeproperties IN1 -c MonitoringProfiles -o BillerEnquiryProfile -n useParserNameInMonitoringPayload -v TRUE

Use the mqsichangeflowmonitoring command to enable monitoring of message flows, here we have enabled monitoring for flows in BillerInquiryService application

4) mqsichangeflowmonitoring IN1 -e default -k BillerInquiryService -j -m BillerEnquiryProfile
-e default,
name of integration server (execution group)

  • -k BillerInquiryService , name of application
  • -j specifies all the message flows in BillerInquiryService application
  • -m BillerEnquiryProfile name of monitoring profile that you want to enable on these flows

5) mqsichangeflowmonitoring IN1 -e default -k BillerInquiryService -j -c active- c active , activates the monitoring on flows , -c deactive will deactivate the monitoring on flows