Install and Configure IIB Monitoring Extension

You can install the IIB Monitoring Extension by performing the tasks that are mentioned in this section.
Download the IIB Extension
After you access to
DX SaaS
, perform the following tasks to install and configure the IIB monitoring extension.
Follow these steps:
  1. Log in to
    DX SaaS
    .
  2. Click
    Open
    on the
    DX APM
    box. The
    DX APM
    home page appears.
  3. Click the
    Agents
    icon in the lower section of the navigation pane.
  4. Click the
    Download
    Agent
    button.
  5. In the
    Select Agent to Download
    page, select the tab corresponding to your operating system.
  6. Under the Infrastructure category, select
    IIB Monitor
    as the agent.
  7. (Optional) Configure the agent options according to the needs of your environment.
  8. Click the
    Download and Install
    button.
    DX SaaS
    downloads the package to your computer. The IIB monitoring extension is successfully downloaded.
The downloaded package includes the IIB Monitoring extension, along with the
DX APM
Infrastructure Agent.
Prerequisites to Configure Components for IIB Monitoring
You need to configure one of the following components to fetch the metrics related to IIB:
By default, the option to monitor IIB by using the MQTT component is enabled in the
bundle.properties
file of the IIB agent extension.
Configure MQTT for IIB Monitoring
You can configure MQTT by using the following procedure.
Follow these steps:
  1. By default, the MQTT server is configured to listen to the localhost.
    To enable APMIA to connect with MQTT, need to update the file in the work path,
    <work path>\components\<Integration_Node>\config\<Integration_Node_Name>
    as follows
    bind_address 0.0.0.0
    To find the <work path>, run the following command in your IBM Integration console:
    mqsireportbroker <Integration_Node>
    You can find the <work path> location in the result.
  2. Restart the built-in MQTT server with the commands:
    mqsichangeproperties <Integeration_Node> -b pubsub -o MQTTServer -n enabled -v false mqsichangeproperties <Integeration_Node> -b pubsub -o MQTTServer -n enabled -v true
  3. Restart the Integration Node
Find the MQTT port number to provide in the bundle.properties file as a value for the property,
introscope.agent.iib.profiles.<ProfileName>.broker.port
.
To find the MQTT port number, run the following command from IIB console:
mqsireportproperties <Integration_Node> -b pubsub -o MQTTServer -a
Configure MQ for IIB Monitoring
Before you configure MQ for IIB Monitoring, you need to Download the IIB Extension and Install the IIB Extension.
You can configure MQ by using the following procedure to create all the required JMS queues on WebSphere MQ Queue Manager.
Follow these steps:
  1. Navigate to the
    apmia/Extensions/iib-ia-<xxx>/config
    directory.
  2. Open the file,
    MBMonitorJMSQueues.mqsc.
    The file contains a series of MQSC commands.
  3. Execute the following command on your WebSphere MQ host on one of the Queue Managers, which will be used to collect the IIB Metrics:
    runmqsc <QMGR Name> < MBMonitorJMSQueues.mqsc
Set Security Requirements to Monitor an MQ object
From the MQ Installation folder, execute the following MQ permissions that are required to monitor MQ objects. For example,
<MQ_Installation_Folder>\bin64
.
<QMGR Name>
is the Queue Manager and
<User>
is the name of the user.
The User should be part of the host where MQ is running.
setmqaut -m <QMGR Name> -t qmgr -p <User> +connect setmqaut -m <QMGR Name> -t qmgr -p <User> +all setmqaut -m <QMGR Name> -n SYSTEM.ADMIN.COMMAND.QUEUE -t q -p <User> +browse +put +dsp +inq setmqaut -m <QMGR Name> -n SYSTEM.ADMIN.PERFM.EVENT -t q -p <User> +get +browse +dsp +inq setmqaut -m <QMGR Name> -n SYSTEM.ADMIN.QMGR.EVENT -t q -p <User> +get +browse +dsp +inq setmqaut -m <QMGR Name> -n SYSTEM.ADMIN.CHANNEL.EVENT -t q -p <User> +get +browse +dsp +inq setmqaut -m <QMGR Name> -n SYSTEM.ADMIN.ACTIVITY.QUEUE -t q -p <User> +get +inq +dsp setmqaut -m <QMGR Name> -n SYSTEM.DEAD.LETTER.QUEUE -t q -p <User> +get +inq +dsp +browse setmqaut -m <QMGR Name> -n ** -t channel -p <User> +dsp setmqaut -m <QMGR Name> -n ** -t q -p <User> +dsp +chg setmqaut -m <QMGR Name> -n ** -t namelist -p <User> +dsp setmqaut -m <QMGR Name> -n ** -t clntconn -p <User> +dsp setmqaut -m <QMGR Name> -n ** -t topic -p <User> +dsp +pub +sub setmqaut -m <QMGR Name> -n SYSTEM.DEFAULT.MODEL.QUEUE -t queue -p <User> +all setmqaut -m <QMGR Name> -t qmgr -p <User> +connect +dsp +inq setmqaut -m <QMGR Name> -n SYSTEM.BROKER.ADMIN.QUEUE -t queue -p <User> +allmqi setmqaut -m <QMGR Name> -n SYSTEM.BROKER.ADMIN.REPLYTODM -t queue -p <User> +allmqi setmqaut -m <QMGR Name> -n SYSTEM.BROKER.ADMIN.STREAM -t queue -p <User> +allmqi setmqaut -m <QMGR Name> -n SYSTEM.BROKER.CONTROL.QUEUE -t queue -p <User> +allmqi setmqaut -m <QMGR Name> -n SYSTEM.BROKER.DEPLOY.REPLY -t queue -p <User> +allmqi setmqaut -m <QMGR Name> -n SYSTEM.BROKER.DEPLOY.QUEUE -t queue -p <User> +allmqi setmqaut -m <QMGR Name> -n SYSTEM.BROKER.DEPLOY.QUEUE -t queue -p <User> +allmqi setmqaut -m <QMGR Name> -n SYSTEM.BROKER.DEFAULT.STREAM -t queue -p <User> +allmqi
Turn on Statistics to monitor Message Flows and Resources
From the IIB console, execute the following command to trigger statistics reports for brokers for which the Message Flow statistics must be displayed:
mqsichangeflowstats <Integration_Node> -s -g -j -c active -o xml -n basic
From the IIB console, execute the following command to trigger statistics reports for brokers for which the Resource statistics must be displayed:
mqsichangeresourcestats <Integration_Node> -c active
Install the IIB Extension
  1. Based on the operating system, unpack the downloaded package of the extension. For UNIX, untar the extension file,
    IIB_Monitor-apmia-<DateandTime>_v1.tar
    . For Windows, unzip the extension file,
    IIB_Monitor-apmia-<DateandTime>_v1.zip
    .
  2. Navigate to the
    apmia
    directory.
  3. Based on the operating system, execute one of the following commands to install the
    DX APM
    Infrastructure Agent:
UNIX:
./APMIACtrl.sh install
Windows:
APMIACtrl.bat install
The
DX APM
Infrastructure Agent is successfully installed.
(Optional) Use more Infrastructure Agent-related commands. For more information, see Install the Infrastructure Agent on DX SaaS.
You can verify whether the extension is installed by navigating to the following location:
apmia\extensions\
and opening the
Extensions.profile
file. In the
Extensions.profile
file, ensure that the following property has the property value as
iib-ia-<xxx>
:
introscope.agent.extensions.bundles.boot.load=iib-ia-<xxx>
Configure the IIB Extension in DX APM Infrastructure Agent
Follow these steps:
Configure Properties in the bundle.properties file
Follow these steps:
  1. If you do not configure the properties of the IIB agent extension while downloading the APMIA, configure the following properties in the
    bundle.properties
    file.
  2. Navigate to the
    apmia/Extensions/iib-ia-<xxx>
    directory, and open the
    bundle.properties
    file in a text editor and provide the following property values:
    Property Name
    Mandatory/Optional Property
    Description with Default Values
    introscope.agent.iib.profiles=<ProfileName>
    Mandatory
    Specifies the list of unique identifiers for each broker to be monitored. It need not be the actual broker name.
    Default:
    default
    introscope.agent.iib.profiles.<ProfileName>.broker.host
    Mandatory
    Specifies the Broker hostname.
    introscope.agent.iib.profiles.<ProfileName>.broker.port
    Mandatory
    Specifies the Broker port.
    introscope.agent.iib.profiles.<ProfileName>.mqtt
    Mandatory
    Specifies the MQTT Enable Settings. To get the message statistics metrics by using the MQTT component, set this property to true. Else, to use the MQ component, set this property to false.
    Default:
    true
    introscope.agent.iib.profiles.<ProfileName>.subscriber.host
    Mandatory
    Specifies the hostname of the MQTT server or the Queue Manager.
    introscope.agent.iib.profiles.<ProfileName>.subscriber.port
    Mandatory
    Specifies the port of the MQTT server or the Queue Manager.
    introscope.agent.iib.profiles.<ProfileName>.broker.user
    Optional
    Specifies the user name configuration to access the broker when you have enabled authorization mechanism.
    introscope.agent.iib.profiles.<ProfileName>.broker.password
    Optional
    Specifies the password of the respective user to access the broker.
    introscope.agent.iib.profiles.<ProfileName>.broker.ssl
    Optional
    Specifies if the SSL is enabled, SSL certs need to be configured in the JVM trust store.
    Default:
    false
    introscope.agent.iib.profiles.<ProfileName>.subscriber.channelname
    Optional
    (Optional) Specifies the channel to establish connection with Queue Manager.
    Default:
    SYSTEM.DEF.SVRCONN
    introscope.agent.iib.profiles.statistics.broker.list
    Optional
    Specifies the list of brokers for which the statistics of the 'Message Flow Statistics' data should be collected.
    introscope.agent.iib.profiles.statistics.resource.enabled
    Optional
    Use this property to see the Resource Statistics.
    Default:
    false
    introscope.agent.iib.profiles.static.delaytime
    Optional
    Specifies the delay time interval (in seconds) between each inquiry from the Broker. This property represents the number of seconds waited between Broker inquiries.
    Default:
    15 seconds
    introscope.agent.iib.profiles.<ProfileName>.ssl
    Optional
    Specifies the SSL settings for BrokerJMS connection Switch to turn on SSL property if the queue manager of the broker is SSL enabled.
    Default:
    Disable
    introscope.agent.iib.profiles.jms.connection.ssl.cipherspec
    Optional
    Use this property to specify 'Cipher Spec' name for JMS connection. This is not a default property.
    introscope.agent.iib.profiles.truststore.path
    Optional
    Use this property to specify 'truststore' path of SSL key repository. This 'truststore' is used for both CMP connection and JMS connection.
    introscope.agent.iib.profiles.keystore.password
    Optional
    Keystore path and Keystore password related keys. Provide the password for Keystore.
    introscope.agent.iib.profiles.keystore.path
    Optional
    Represents the Keystore path.
  3. Save and Close the
    bundle.properties
    file.
Copy Jars from IIB Server to DX APM Infrastructure Agent
Follow these steps:
  1. If you use either the MQTT component or the MQ component to fetch the IIB metrics, copy the following jars from the installation location of the IIB Server to
    apmia/extensions/iib-ia-<xxx>/lib/external
    directory:
    • IntegrationAPI.jar
    • websocket-api.jar
    • websocket-client.jar
    • websocket-common.jar
    • jetty-io.jar
    • jetty-util.jar
    • connector.jar
    • dhbcore.jar
    • ibmjsseprovider2.jar
    • j2ee.jar
    • org.eclipse.paho.client.mqttv3-1.0.0.jar
    • jms.jar
  2. If you use the MQ component to fetch the IIB metrics, copy the following jars from the installation location of the MQ Server to
    apmia/extensions/iib-ia-<xxx>/lib/external
    directory:
    • com.ibm.mq.commonservices.jar
    • com.ibm.mq.headers.jar
    • com.ibm.mq.jar
    • com.ibm.mq.jmqi.jar
    • com.ibm.mq.pcf.jar
    • com.ibm.mqjms.jar
Restart DX APM Infrastructure Agent
  1. In
    DX APM
    Infrastructure Agent, navigate to the following folder:
    cd apmia
  2. Based on the operating system, run the appropriate command to restart the
    DX APM
    Infrastructure Agent:
    UNIX:
    ./APMIACtrl.sh restart
    Windows:
    ./APMIACtrl.bat restart
(Optional) Use more Infrastructure Agent-related commands. For more information, see Install the Infrastructure Agent on DX SaaS.
After you configure the IIB monitoring extension, you can view the metrics of the IIB in
DX APM
Metric View. For more information, IIB Monitoring Metrics.