Configuring the IBM Integration Bus agent

Edit online

You must assign an instance name to the IBM® Integration Bus agent and configure the agent before it can start monitoring your IBM Integration Bus environment.

Before you begin

Make sure that the user ID that is used to start and stop the agent belongs to the mqm and mqbrkrs user groups.
If IBM MQ (WebSphere® MQ) is installed on the Windows system, add the IBM MQ (WebSphere MQ) library path to the PATH environment variable. So that the IBM Integration Bus agent can load the required IBM MQ (WebSphere MQ) libraries to start.
1. Add the IBM MQ (WebSphere MQ) library path to the beginning of the PATH environment variable.
  For example, if the installation path of IBM MQ (WebSphere MQ) is C:\IBM\WMQ75, add C:\IBM\WMQ75\bin to the beginning of the PATH environment variable of your Windows system.
2. Restart the Windows system for the changes to take effect.
You might need to provide the following information according to your environment during the agent configuration. If you do not know the appropriate configuration value to specify, gather the information from the administrator of IBM MQ (WebSphere MQ) and IBM Integration Bus.
- If IBM MQ (WebSphere MQ) is installed on the same system with the IBM Integration Bus agent, you must provide the 64-bit library path of IBM MQ (WebSphere MQ).
- If the IBM Integration Bus agent is configured to monitor the integration nodes of IBM Integration Bus V10 or IBM App Connect Enterprise V11, you must provide the installation directory for IBM Integration Bus V10 or IBM App Connect Enterprise V11.
- If you want the IBM Integration Bus agent to monitor some specific integration nodes (brokers) instead of all on the same system, you must provide the name and installation path of each integration node (broker).

About this task

The IBM Integration Bus agent is a multiple instance agent; you must create the first instance and start the agent manually.

You can choose to configure the agent with or without interactions on UNIX or Linux® systems. On Windows systems, you can configure the agent without interactions only.

To configure the agent with interaction, run the configuration script and respond to prompts. See Interactive configuration.
To configure the agent without interaction, edit the silent response file and then run the configuration script. See Silent configuration.

Important: If you also installed ITCAM Agent for WebSphere Message Broker, which is delivered as one of the ITCAM for Applications product, on the same system as the IBM Integration Bus agent, which is delivered in Cloud APM, do not use them to monitor the same integration node (broker) on the system.

Interactive configuration

Edit online

Procedure

To configure the agent by running the script and responding to prompts, complete the following steps:

Enter the following command:
```
install_dir/bin/iib-agent.sh config instance_name
```
where instance_name is the name that you want to give to the agent instance.
Important: Interactive configuration is not supported on Windows systems.
After you confirm that you want to configure IBM Integration Bus agent, specify the configuration values for general agent settings.
1. When prompted for the Agent Id parameter, specify a unique alphanumeric string with a maximum length of 8 characters.
  
  The managed system name includes the agent ID that you specify, for example, monitoredbrokername:agentID:KQIB, where monitoredbrokername is the name of the monitored integration node (broker).
2. When prompted for the IIB version 10 or ACE version 11 Install Directory parameter, if you want to monitor integration nodes of IBM Integration Bus V10, or IBM App Connect Enterprise V11, specify the installation directory of IBM Integration Bus V10 or IBM App Connect Enterprise V11. For example, /opt/ibm/mqsi/ace-11.0.0.3. If you do not want to monitor IBM Integration Bus V10 and IBM App Connect Enterprise V11, press Enter to accept the default.
  
  Remember: You can specify only one installation directory for the IIB version 10 or ACE version 11 Install Directory parameter. If you installed IBM Integration Bus V10 or IBM App Connect Enterprise V11 in different directories and you want to monitor them all, create multiple agent instances and specify one installation directory of IBM Integration Bus V10 or IBM App Connect Enterprise V11 for each agent instance.
Optional: Use the Monitored Broker Settings section to specify whether you want to use this agent to monitor only some specific integration nodes (brokers).
By default, all integration nodes (brokers) that are running on the same host system as the IBM Integration Bus agent are monitored, as determined by self-discovery. If you want the agent to monitor some specific integration nodes (brokers), specify the name of the integration node (broker) that you want to monitor and set the Collect Node Data setting to No, which is the default value, in the Monitored Broker Settings section. There can be multiple Monitored Broker Settings sections. Each section controls the monitoring settings for one integration node (broker).
Tip: You can specify more than one Monitored Broker Settings section. When you edit the Monitored Broker Settings section, the following options are available:
- Add: Create a Monitored Broker Settings section to configure for another integration node (broker).
- Edit: Modify the settings of current Monitored Broker Settings section.
- Del: Delete the current Monitored Broker Settings section.
- Next: Move to the next Monitored Broker Settings section.
- Exit: Exit the Monitored Broker Settings configuration.
If you confirm that IBM MQ (WebSphere MQ) is installed on the same system, you are prompted for the WebSphere MQ 64-bit library path parameter. Press Enter to accept the default value, which is the 64-bit library path of IBM MQ (WebSphere MQ) automatically discovered by the agent. If no default value is displayed, you must provide the 64-bit library path of IBM MQ (WebSphere MQ) before you proceed to the next step. For example, /opt/mqm8/lib64.

Remember: If your integration nodes (brokers) use different versions of queue managers, specify the latest version of the IBM MQ (WebSphere MQ) 64-bit library path for this parameter.
After the configuration completes, enter the following command to start the agent:
```
install_dir/bin/iib-agent.sh start instance_name
```

Silent configuration

Edit online

Procedure

To configure the agent by editing the silent response file and running the script with no interaction, complete the following steps:

Open the following agent silent response file in a text editor.
- install_dir/samples/iib_silent_config.txt
- install_dir\tmaitm6_x64\samples\qi_silent_config.txt
where install_dir is the installation directory of the IBM Integration Bus agent. The default installation directory is as follows:
- /opt/ibm/apm/agent
- C:\IBM\APM
For the agentId parameter, specify a unique alphanumeric string with a maximum length of 8 characters as a short identifier for the agent.

The managed system name includes the agent ID that you specify, for example, monitoredbrokername:agentID:KQIB, where monitoredbrokername is the name of the monitored integration node (broker).
If you want to monitor the integration nodes of IBM Integration Bus V10 or IBM App Connect Enterprise V11, specify the installation directory for IBM Integration Bus V10 or IBM App Connect Enterprise V11 for the defaultWMBInstallDirectory parameter. For example, C:\Program Files\IBM\ACE\11.0.0.3\ for a Windows system, or /opt/ibm/mqsi/ace-11.0.0.3 for a Linux system. If you do not want to monitor IBM Integration Bus V10 and IBM App Connect Enterprise V11, this parameter is not required because the IBM Integration Bus agent can discover the integration nodes (brokers) from earlier versions automatically.

Remember: You can specify only one installation directory for the defaultWMBInstallDirectory parameter. If you installed IBM Integration Bus V10 or IBM App Connect Enterprise V11 in different directories and you want to monitor them all, create multiple agent instances and specify one installation directory of IBM Integration Bus V10 or IBM App Connect Enterprise V11 for each agent instance.
Optional: Specify whether you want to use this agent to monitor only some specific integration nodes (brokers).

By default, all integration nodes (brokers) that are running on the same host system as the IBM Integration Bus agent are monitored, as determined by self-discovery. To monitor specific integration nodes (brokers), set the collectNodeData and WMBInstallDirectory parameters for each integration node (broker) that you want to monitor.

collectNodeData

Specifies whether node definition data is collected for the monitored integration node (broker). The syntax is collectNodeData.brkr_name=NO|YES, where brkr_name is the name of the integration node (broker).

The default value is NO. It is recommended to use the default value because node definition data is not supported in the Cloud APM console.

WMBInstallDirectory

The installation directory of the integration node (broker) to be monitored. The syntax is WMBInstallDirectory.brkr_name=broker_install_dir, where broker_install_dir is the installation directory of the integration node (broker) to be monitored.

Remember: For a version 10 integration node, the WMBInstallDirectory parameter can override the defaultWMBInstallDirectory parameter that you set in the previous step.
For example, to monitor only two integration nodes (brokers) that are named BK1 and BK2, set the parameters as follows:
```
collectNodeData.BK1=NO
collectNodeData.BK2=NO
WMBInstallDirectory.BK1=BK1_install_dir
WMBInstallDirectory.BK2=BK2_install_dir
```
To monitor brokers that are earlier than IBM Integration Bus V10, specify the 64-bit library path of IBM MQ (WebSphere MQ) for the WMQLIBPATH parameter. For example, C:\Program Files\IBM\WebSphere MQ\bin64 for a Windows system, or /opt/mqm8/lib64 for a Linux system.

Remember: If your integration nodes (brokers) use different versions of queue managers, specify the latest version of the IBM MQ (WebSphere MQ) 64-bit library path for this parameter.
Save and close the agent silent response file, and then enter the following command:
- install_dir/bin/iib-agent.sh config instance_name path_to_responsefile
- install_dir\BIN\iib-agent.bat config "instance_name path_to_responsefile"
where instance_name is the name of the instance that you configure, and path_to_responsefile is the full path of the silent response file.
Warning: On Windows systems, do not include double quotation marks ("") that enclose the full path to the silent response file, as this will cause a configuration error.

After the configuration completes, enter the following command to start the agent:

install_dir/bin/iib-agent.sh start instance_name

install_dir\bin\iib-agent.bat start instance_name

Results

Now, you can log in to the Cloud APM console and use the Applications editor to add the IBM Integration Bus agent instance to the Application Performance Dashboard. For instructions on how to start the Cloud APM console, see Starting the Cloud APM console. For information about using the Applications editor, see Managing applications.

Remember: Whenever you update or migrate a monitored integration node (broker), you must restart the IBM Integration Bus agent after the integration node (broker) upgrade or migration.

What to do next

The next step is to configure IBM Integration Bus for data enablement. The following data is available on the Application Performance Dashboard only after you enable them in IBM Integration Bus:

Archive accounting and statistics
JVM resource statistics
Transaction tracking

For instructions, see Configuring IBM Integration Bus for data enablement.