Installing the WebSphere Message Broker monitoring extension

This section describes how to install the WebSphere Message Broker monitoring extension on various platforms, and includes:

Before you begin

Verify in the Supported middleware monitoring technologies for performance and availability section that the intended monitored technology is supported and that all footnote prerequisites are satisfied.

Installing the WebSphere Message Broker monitoring extension on Windows

To prepare the environment

Make sure you have Windows Administrator privileges when installing and running the WMB monitoring extension as a Windows System Service and make sure you have the proper privileges to adjust the extension's runtime environment (see the following sections for further information).

• The qpwmb Monitoring Extension uses the agent JRE. It references that JRE using a relative path. As a result, ensure that the common JRE is installed as a subdirectory under the <AGENT_INSTALL> directory.
• If you are running IIB version 10 or higher in a non-MQ configuration, you can skip the following WebSphere MQ related steps.
  • To monitor message flow and resource statistics, the extension uses the WebSphere MQ Java API in 32-bit bindings mode on 32-bit brokers and 64-bit bindings mode on 64-bit brokers. This requires the WebSphere MQ environment to be set up properly at runtime. The IBM WebSphere MQ product documentation contains detailed information about how to configure the environment for applications using WebSphere MQ Java in bindings mode.
  • Ensure that the WebSphere MQ 64-bit libraries occur prior to the WebSphere MQ 32-bit libraries in the System Path Environment Variable. It is also necessary to set the correct ordering in the wrapper.conf file (see Configuration Property files). Note that failure to do this results in an MQRC 2495 error in the qpwmb.log and failure of the extension.
  • Make sure WebSphere MQ is installed on the system running the extension and that its version matches the requirements and recommendations for the installed version of WebSphere Message Broker. See the IBM product documentation for further information.
    • Make sure you have the permission to inquire and administer the queue managers and WMQ resources involved. The extension must have the permission to connect to and to inquire the broker's queue manager.
    • The extension must have the permission to put messages to the SYSTEM.BROKER.CONTROL.QUEUE to successfully subscribe to statistics messages published by the broker.
    • Set the queue manager's pub/sub mode (PSMODE) to enabled for every broker that is monitored.
    • Create a model queue on each broker's queue manager for the extension to receive statistics messages published by the broker. By default the extension assumes a model queue named QPWMB.SUBSCRIBER.MODEL.QUEUE exists. This queue must be have deftype=TEMPDYN.
    • Make sure that the following MQ environment variables are set before running the install.bat file: MQ_JAVA_INSTALL_PATH and MQ_JAVA_LIB_PATH
    • These environment variables might already be set if you have a Primary Installation of WebSphere MQ. If they are not set, you can set them by running the setmqenv command from bin directory of the queue manager used by the broker. For example:
      
      C:\Program Files\IBM\WebSphere MQ\bin\setmqenv –n MyMQInstallationName
      
      See the related IBM WebSphere Message Broker documentation for more details on the WebSphere MQ setup.

• If you are monitoring IIB10 or above and your Integration node is not using WebSphere MQ, make sure that the environment variables below are not set before running install.bat. Because these are not set, QPWMB communicates with your Integration node using MQ Telemetry Transport (MQTT).
  • MQ_JAVA_INSTALL_PATH
  • MQ_JAVA_LIB_PATH

To prepare the WebSphere MQ environment

• For monitoring the status and configuration of a broker and its components, the extension uses the IBM Integration API (aka Configuration Manager Proxy or CMP API). The extension needs to gather these Java libraries as part of its installation process and tries detecting all the resources required from the environment.
• Make sure that the account used to run the extension has the authority to access the broker through the WebSphere Message Broker CMP API, and has read access to the monitored brokers' registries.
• Make sure you run WMB commands with the proper environment. Usually this means you are working from within a WMB command console or have mqsiprofile applied to your environment.
• If you prefer to not run the mqsiprofile command, the environment variables can be set manually using command line options.
• The install script specifically uses the following environment variables:
  • MQSI_FILEPATH
  • MQSI_JREPATH
  • MQSI_REGISTRY
  • MQSI_VERSION
• In order to monitor message flow statistics or execution group statistics, statistics collection and publishing must be turned on for every broker or broker component monitored. This can be done in two ways:
  • Run the mqsichangeflowstats command to enable statistics for all broker components you want to monitor.
    • Examples:
    • To enable message flow statistics to be published for all message flows and all execution groups on a broker, run:
      
      mqsichangeflowstats <brokername> -s -g -j -c active -t none -n basic -o xml
    • To enable message flow statistics to be published for a specific message flow and a specific execution group on a broker, run:
      
      mqsichangeflowstats <brokername> -s -e <execution_group_name> -f <message_flow_name> -c active -t none -n basic -o xml
    • To disable message flow statistics, run the appropriate command from the three options above and replace -c active with -c inactive. The following command would turn off statistics for all message flows in all execution groups on a broker:
      
      mqsichangeflowstats <brokername> -s -g -j -c inactive
  • Set the MessageFlowStatistics extension preference. Note that if you are upgrading from TrueSight Middleware and Transaction Monitor version 8.0.00 and you have set the com.bmc.mmpa.wmb.monitor.MessageFlowStatistics property in the com.bmc.mmpa.wmb.monitor property file, this is automatically migrated to this extension preference.
    • Examples:
    • To enable message flow statistics to be published for all message flows and all execution groups on a broker, run:
      
      agentpref --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> MessageFlowStatistics 1
    • To disable message flow statistics, run the appropriate command from the three options above and replace -c active with -c inactive. The following command would turn off statistics for all message flows in all execution groups on a broker:
      
      agentpref –-remove-agent "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> MessageFlowStatistics

• In order to monitor resource statistics, statistics collection and publishing must be turned on for every component monitored. This can be done in two ways:
  • Run the mqsichangeresourcestats command to enable statistics for all the broker components you want to monitor.
    • Examples:
    • To enable resource statistics to be published for all execution groups on a broker, run:
      
      mqsichangeresourcestats <brokername> -c active
    • To enable resource statistics to be published for a specific execution group on a broker, run:
      
      mqsichangeresourcestats <brokername> –e <execution_group_name> -c active
    • To disable resource statistics, run the appropriate command from the options above and replace -c active with -c inactive. The following command turns off statistics for all execution groups on a broker:
      
      mqsichangeresourcestats <brokername> -c inactive
  • Set the MessageResourceStatistics extension preference. Note that if you are upgrading from TrueSight Middleware and Transaction Monitor version 8.0.00 and you have set the com.bmc.mmpa.wmb.monitor.MessageResourceStatistics property in the com.bmc.mmpa.wmb.monitor property file, this is automatically migrated to this extension preference.
    • Examples:
    • To enable resource statistics to be published for all execution groups on a broker, run:
      
      agentpref --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> ResourceStatistics true
    • To disable resource statistics, run:
      
      agentpref --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> ResourceStatistics false
• See the IBM WebSphere Message Broker documentation for more information.

To install the WebSphere Message Broker monitoring extension on Windows

1. Obtain the pkg_windows_qpwmb.zip file either from the AGENT_DIST directory on the TMTM Server (see Organization of the AGENT_DIST directory on the server machine) or through the Package Distribution mechanism, as described in Distributing the Agent and extensions via the launch page.
2. Extract the files from pkg_windows_qpwmb.zip into a sub-directory of the <AGENT_INSTALL> directory. The following steps assume a directory named "qpwmb" is being used.
3. Open a command window with the privileges to install a Windows System Service and the proper WebSphere MQ and WebSphere Message Broker environment set up to install the extension (see related sections above on how to prepare the WMQ and WMB environment).
4. If you are running IIB version 10 or higher in an MQ configuration, make sure the broker's queue manager is running and available to the extension.
5. Change directories to the qpwmb directory from Step 2.
6. To install with the defaults determined automatically from your environment run:
   
   bin\install.bat
   
   If you prefer to provide environment information manually, run:
   
   bin\install.bat -mqjavaversion MQJAVAVERSION -mqjavainstallpath MQJAVAINSTALLPATH -wmbfilepath MQSIFILEPATH –wmbjrepath MQSIJREPATH –wmbregistrypath MQSIREGISTRYPATH –wmbversion MQSIVERSION
   
   Note the following:
   • MQJAVAVERSION is the WebSphere MQ version number (e.g., 7.0.1.2). This option should not be specified on Integration Nodes that are configured to use the MQTT transport.
   • MQJAVAINSTALLPATH is the path to the WebSphere MQ Java installation. This option should not be specified on Integration Nodes that are configured to use the MQTT transport.
7. To install qpwmb as a Windows system service run:
   
   bin\qpwmb.bat --install

8. Continue to the Configure the monitoring extension section.

   After upgrading WebSphere MQ or WebSphere Message Broker, you must rerun the install.bat command, as described in the following steps.
9. Stop the WMB Monitoring Extension if it is running.
10. Open a command window with the proper WebSphere MQ and WebSphere Message Broker environment setup (see related sections above on how to prepare your environment).
11. Change to the qpwmb directory where the monitoring extension was installed.
12. Run: bin\install.bat
13. Start the extension. 

Where to go from here

• To control and configure the extension, see Running the WebSphere Message Broker monitoring extension.

• To upgrade the extension, see Upgrading the agent and extensions.
• To define an alternative JRE, see Defining alternative JREs for Java extensions.
• To view uninstall instructions, see Uninstalling the WebSphere Message Broker monitoring extension.

Installing the WebSphere Message Broker monitoring extension on UNIX

To prepare the environment

Make sure you have the proper privileges to adjust the extension's runtime environment (see the following sections for further information).

• The qpwmb monitoring extension uses the agent JRE. It references that JRE using a relative path. As a result, ensure that the common JRE is installed as a subdirectory under the <AGENT_INSTALL> directory.
• If you are running IIB version 10 or higher in non-MQ configuration, you can skip the following WebSphere MQ related steps.
  • To monitor message flow and resource statistics, the extension uses the WebSphere MQ Java API 64-bit bindings mode on 64-bit brokers. This requires the WebSphere MQ environment to be set up properly at runtime. The IBM WebSphere MQ product documentation contains detailed information about configuring the environment for applications using WebSphere MQ Java in bindings mode.
  • Ensure that the WebSphere MQ 64-bit libraries occur prior to the WebSphere MQ 32-bit libraries in the System Path Environment Variable. It might also be necessary to set the correct ordering in the wrapper.conf file (see Configuration Property files). Note that failure to do this results in an MQRC 2495 error in the qpwmb.log and failure of the extension.
  • Make sure WebSphere MQ is installed on the system running the extension and that its version matches the requirements and recommendations for the installed version of WebSphere Message Broker. See the IBM product documentation for further information.
    • Make sure you have the permission to inquire and administer the queue managers and WMQ resources involved. The extension must have the permission to connect to and to inquire the broker's queue manager.
    • The extension must have the permission to put messages to the SYSTEM.BROKER.CONTROL.QUEUE to successfully subscribe to statistics messages published by the broker.
    • Set the queue manager's pub/sub mode (PSMODE) to enabled for every broker that is monitored.
    • Create a model queue on each broker's queue manager for the extension to receive statistics messages published by the broker. By default the extension assumes a model queue named QPWMB.SUBSCRIBER.MODEL.QUEUE exists. This queue must be have deftype=TEMPDYN.
    • Make sure that the following MQ environment variables are set before running the install.sh file: MQ_JAVA_INSTALL_PATH and MQ_JAVA_LIB_PATH
      
      These environment variables might already be set if you have a Primary Installation of WebSphere MQ. If they are not set, you can set them by running the setmqenv command from thr bin directory of the queue manager used by the broker. For example:
      
      . /opt/mqm/bin/setmqenv –n MyMQInstallationName
      
      (Note that the .<space>/ is important for this command to run correctly)
      
      See the related IBM WebSphere Message Broker documentation for more details on the WebSphere MQ setup.

• If you are monitoring IIB10 or above and your Integration node is not using WebSphere MQ, make sure that the environment variables below are not set before running install.sh. Because these are not set, QPWMB communicates with your Integration node using MQ Telemetry Transport (MQTT).
  • MQ_JAVA_INSTALL_PATH
  • MQ_JAVA_LIB_PATH

To prepare the WebSphere Message Broker environment

For monitoring the status and configuration of a broker and its components, the extension uses the IBM Integration API (aka Configuration Manager Proxy or CMP API). The extension needs to gather these Java libraries as part of its installation process and tries detecting all the resources required from the environment.

• Make sure that the account used to run the extension has the authority to access the broker through the WebSphere Message Broker CMP API, and has read access to the monitored brokers' registries.
• Make sure you run WMB commands with the proper environment. Usually this means you are working from within a WMB command console or have mqsiprofile applied to your environment.
• If you prefer to not run the mqsiprofile command, the environment variables can be set manually using command line options as described later in this document.
• The install script specifically uses the following environment variables:
  • MQSI_FILEPATH
  • MQSI_JREPATH
  • MQSI_REGISTRY
  • MQSI_VERSION
• In order to monitor message flow statistics or execution group statistics, statistics collection and publishing must be turned on for every broker or broker component monitored. This can be done in two ways:
  • Run the mqsichangeflowstats command to enable statistics for all broker components you want to monitor.
    • Examples:
    • To enable message flow statistics to be published for all message flows and all execution groups on a broker, run:
      
      mqsichangeflowstats <brokername> -s -g -j -c active -t none -n basic -o xml
    • To enable message flow statistics to be published for a specific message flow and a specific execution group on a broker, run:
      
      mqsichangeflowstats <brokername> -s -e <execution_group_name> -f <message_flow_name> -c active -t none -n basic -o xml
    • To disable message flow statistics, run the appropriate command from the three options above and replace -c active with -c inactive. The following command would turn off statistics for all message flows in all execution groups on a broker:
      
      mqsichangeflowstats <brokername> -s -g -j -c inactive
  • Set the MessageFlowStatistics extension preference. Note that if you are upgrading from TrueSight Middleware and Transaction Monitor version 8.0.00 and you have set the com.bmc.mmpa.wmb.monitor.MessageFlowStatistics property in the com.bmc.mmpa.wmb.monitor property file, this is automatically migrated to this extension preference.
    • Examples:
    • To enable message flow statistics to be published for all message flows and all execution groups on a broker, run:
      
      ./agentpref.sh --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> MessageFlowStatistics 1
    • To disable message flow statistics, run the appropriate command from the three options above and replace -c active with -c inactive. The following command would turn off statistics for all message flows in all execution groups on a broker:
      
      ./agentpref.sh –-remove-agent "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> MessageFlowStatistics
• In order to monitor resource statistics, statistics collection and publishing must be turned on for every component monitored. This can be done in two ways:
  • Run the mqsichangeresourcestats command to enable statistics for all broker components you want to monitor.
    • Examples:
    • To enable resource statistics to be published for all execution groups on a broker, run:
      
      mqsichangeresourcestats <brokername> -c active
    • To enable resource statistics to be published for a specific execution group on a broker, run:
      
      mqsichangeresourcestats <brokername> –e <execution_group_name> -c active
    • To disable resource statistics, run the appropriate command from the options above and replace -c active with -c inactive. The following command turns off statistics for all execution groups on a broker:
      
      mqsichangeresourcestats <brokername> -c inactive
  • Set the MessageResourceStatistics extension preference. Note that if you are upgrading from TrueSight Middleware and Transaction Monitor version 8.0.00 and you have set the com.bmc.mmpa.wmb.monitor.MessageResourceStatistics property in the com.bmc.mmpa.wmb.monitor property file, this is automatically migrated to this extension preference.
    • Examples:
    • To enable resource statistics to be published for all execution groups on a broker, run:
      
      ./agentpref.sh --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> ResourceStatistics true
    • To disable resource statistics, run:
      
      ./agentpref.sh --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> ResourceStatistics false

See the IBM WebSphere Message Broker documentation for more information.

To install the WebSphere Message Broker monitoring extension on UNIX

1. Obtain the pkg_unix_qpwmb.zip file either from the AGENT_DIST directory on the TMTM Server (see Organization of the AGENT_DIST directory on the server machine) or through the Package Distribution mechanism, as described in Distributing the Agent and extensions via the launch page.
2. Extract the files from pkg_unix_qpwmb.zip into a sub-directory of the <AGENT_INSTALL> directory. The following steps assume a directory named "qpwmb" is being used.
3. Open a command shell the proper WebSphere MQ and WebSphere Message Broker environment set up to install the extension (see related sections above on how to prepare the WMQ and WMB environment).
4. If you are running IIB version 10 or higher in an MQ configuration, make sure the broker's queue manager is running and available to the extension.
5. Change directories to the qpwmb directory from Step 2.
6. Change permissions on install.sh and qpwmb.sh. From the bin directory:
   
   chmod +x install.sh qpwmb.sh
7. To install with the defaults determined automatically from your environment run:
   
   ./bin/install.sh
   
   If you prefer to provide environment information manually, run:
   
   ./bin/install.sh -mqjavaversion MQJAVAVERSION -mqjavainstallpath MQJAVAINSTALLPATH -wmbfilepath MQSIFILEPATH –wmbjrepath MQSIJREPATH –wmbregistrypath MQSIREGISTRYPATH –wmbversion MQSIVERSION
   
   Note the following:
   • MQJAVAVERSION is the WebSphere MQ version number (e.g., 7.0.1.2). This option should not be specified on Integration Nodes that are configured to use the MQTT transport.
   • MQJAVAINSTALLPATH is the path to the WebSphere MQ Java installation. This option should not be specified on Integration Nodes that are configured to use the MQTT transport.

8. Continue to the Configure the monitoring extension section.

   After upgrading WebSphere MQ or WebSphere Message Broker, you must rerun the install.sh command, as described in the following steps.
9. Stop the WMB Monitoring Extension if it is running.
10. Open a command window with the proper WebSphere MQ and WebSphere Message Broker environment setup (see related sections above on how to prepare your environment).
11. Change to the qpwmb directory where the monitoring extension was installed.
12. Run: ./bin/install.sh
13. Start the extension. 

Where to go from here

• To control and configure the extension, see Running the WebSphere Message Broker monitoring extension.

• To upgrade the extension, see Upgrading the agent and extensions.
• To define an alternative JRE, see Defining alternative JREs for Java extensions.
• To view uninstall instructions, see Uninstalling the WebSphere Message Broker monitoring extension.

Installing the WebSphere Message Broker monitoring extension on z/OS

On z/OS, the agent and extension runs in UNIX System Services (USS).

To prepare the environment

Make sure you have the proper privileges to adjust the extension's runtime environment (see the following sections for further information).

• If you are running IIB version 10 or higher in non-MQ configuration, you can skip the following WebSphere MQ related steps.
  • To monitor message flow and resource statistics, the extension uses the WebSphere MQ Java API 64-bit bindings mode on 64-bit brokers. This requires the WebSphere MQ environment to be set up properly at runtime. The IBM WebSphere MQ product documentation contains detailed information about configuring the environment for applications using WebSphere MQ Java in bindings mode.
  • On z/OS to install the extension with WebSphere MQ no other specific adjustments to the environment are required. Instead you must provide the WebSphere MQ version and the path to the WebSphere MQ Java resources manually with the install command using the options -mqjavaversion and -mqjavainstallpath. See below for further information about the install command and its options.
    
    Generally the following is sufficient to run the extension with WebSphere MQ:
    • Make sure the environment variable addressing the library path on your system (i.e. LIBPATH) is pointing at runtime to the directory containing the proper version of the WebSphere MQ native Java bindings library (e.g. in /usr/lpp/mqm/v701/java /lib).
    • Make sure the STEPLIB environment variable point to the WebSphere MQ language environment libraries SCSQAUTH and SCSQANLE. For example: STEPLIB=CSQ600.SCSQAUTH:CSQ600.SCSQANLE
    • Make sure the WMB CMP API Java libraries are available from your local WMB installation (usually this includes ConfigManagerProxy.jar and ibmjsseprovider2.jar).
    • Make sure you have information about the WMB version used and the WMB installation directory available to provide it manually with the install command using the options -wmbversion and -wmbfilepath. See below for further information about the install command and its options.
  • Make sure WebSphere MQ is installed on the system running the extension and that its version matches the requirements and recommendations for the installed version of WebSphere Message Broker. See the IBM product documentation for further information.
    • Make sure you have the permission to inquire and administer the queue managers and WMQ resources involved. The extension must have the permission to connect to and to inquire the broker's queue manager.
    • The extension must have the permission to put messages to the SYSTEM.BROKER.CONTROL.QUEUE to successfully subscribe to statistics messages published by the broker.
    • Set the queue manager's pub/sub mode (PSMODE) to enabled for every broker that is monitored.
    • Create a model queue on each broker's queue manager for the extension to receive statistics messages published by the broker. By default the extension assumes a model queue named QPWMB.SUBSCRIBER.MODEL.QUEUE exists. This queue must be have deftype=TEMPDYN.

See the related IBM WebSphere Message Broker documentation for more details on the WebSphere MQ setup.

To prepare the WebSphere Message Broker environment

For monitoring the status and configuration of a broker and its components, the extension uses the IBM Integration API (aka Configuration Manager Proxy or CMP API). The extension needs to gather these Java libraries as part of its installation process and tries detecting all the resources required from the environment.

• Make sure that the account used to run the extension has the authority to access the broker through the WebSphere Message Broker CMP API, and has read access to the monitored brokers' registries.
• Make sure you run WMB commands with the proper environment. Usually this means you are working from within a WMB command console or have mqsiprofile applied to your environment.
  • If you prefer to not run the mqsiprofile command, the environment variables can be set manually using command line options, as described later in this document.
  • The install script specifically uses the following environment variables:
    • MQSI_FILEPATH
    • MQSI_JREPATH
    • MQSI_REGISTRY
    • MQSI_VERSION
• In order to monitor message flow statistics or execution group statistics, statistics collection and publishing must be turned on for every broker or broker component monitored. This can be done in two ways:
  • Run the mqsichangeflowstats command to enable statistics for all broker components you want to monitor.
    • Examples:
    • To enable message flow statistics to be published for all message flows and all execution groups on a broker, run:
      
      mqsichangeflowstats <brokername> -s -g -j -c active -t none -n basic -o xml
    • To enable message flow statistics to be published for a specific message flow and a specific execution group on a broker, run:
      
      mqsichangeflowstats <brokername> -s -e <execution_group_name> -f <message_flow_name> -c active -t none -n basic -o xml
    • To disable message flow statistics, run the appropriate command from the three options above and replace -c active with -c inactive. The following command would turn off statistics for all message flows in all execution groups on a broker:
      
      mqsichangeflowstats <brokername> -s -g -j -c inactive
  • Set the MessageFlowStatistics extension preference. Note that if you are upgrading from TrueSight Middleware and Transaction Monitor version 8.0.00 and you have set the com.bmc.mmpa.wmb.monitor.MessageFlowStatistics property in the com.bmc.mmpa.wmb.monitor property file, this is automatically migrated to this extension preference.
    • Examples:
    • To enable message flow statistics to be published for all message flows and all execution groups on a broker, run:
      
      ./agentpref.sh --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> MessageFlowStatistics 1
    • To disable message flow statistics, run the appropriate command from the three options above and replace -c active with -c inactive. The following command would turn off statistics for all message flows in all execution groups on a broker:
      
      ./agentpref.sh –-remove-agent "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> MessageFlowStatistics
• In order to monitor resource statistics, statistics collection and publishing must be turned on for every component monitored. This can be done in two ways:
  • Run the mqsichangeresourcestats command to enable statistics for all broker components you want to monitor.
    • Examples:
    • To enable resource statistics to be published for all execution groups on a broker, run:
      
      mqsichangeresourcestats <brokername> -c active
    • To enable resource statistics to be published for a specific execution group on a broker, run:
      
      mqsichangeresourcestats <brokername> –e <execution_group_name> -c active
    • To disable resource statistics, run the appropriate command from the options above and replace -c active with -c inactive. The following command turns off statistics for all execution groups on a broker:
      
      mqsichangeresourcestats <brokername> -c inactive
  • Set the MessageResourceStatistics extension preference. Note that if you are upgrading from TrueSight Middleware and Transaction Monitor version 8.0.00 and you have set the com.bmc.mmpa.wmb.monitor.MessageResourceStatistics property in the com.bmc.mmpa.wmb.monitor property file, this is automatically migrated to this extension preference.
    • Examples:
    • To enable resource statistics to be published for all execution groups on a broker, run:
      
      ./agentpref.sh --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> ResourceStatistics true
    • To disable resource statistics, run:
      
      ./agentpref.sh --set "com.bmc.mmpa.wmb.monitor" --pref_path ComMQSoftwareWebSphereMBBroker <brokername> WMQQMgrName <qmgrname> ResourceStatistics false

See the IBM WebSphere Message Broker documentation for more information.

To install the WebSphere Message Broker monitoring extension on z/OS

Obtain the pkg_os390_qpwmb.zip file either from the AGENT_DIST directory on the TMTM Server (see Organization of the AGENT_DIST directory on the server machine) or through the Package Distribution mechanism, as described in Distributing the Agent and extensions via the launch page.

1. Extract the files from pkg_os390_qpwmb.zip into a sub-directory of the <AGENT_INSTALL> directory. The following steps assume a directory named "qpwmb" is being used.
2. Open a USS command shell the proper WebSphere MQ and WebSphere Message Broker environment set up to install the extension (see related sections above on how to prepare the WMQ and WMB environment).
3. Configure the LIBPATH environment variable to include the path to the directory containing the WebSphere MQ Java binding libraries. For example:
   
   export LIBPATH=/WebSphereMQInstallDir/java/lib/
4. Edit the STEPLIB environment variable to point to the WebSphere MQ language environment libraries SCSQAUTH and SCSQANLE. For example:
   
   STEPLIB=CSQ600.SCSQAUTH:CSQ600.SCSQANLE
5. If you are running IIB version 10 or higher in an MQ configuration, make sure the broker's queue manager is running and available to the extension.
6. Change directories to the qpwmb directory from Step 2.
7. Change permissions on install.sh and qpwmb.sh. From the bin directory:
   
   chmod +x install.sh qpwmb.sh
8. Install by providing environment information manually, run:
   
   ./bin/install.sh -mqjavaversion MQJAVAVERSION -mqjavainstallpath MQJAVAINSTALLPATH -wmbfilepath MQSIFILEPATH –wmbjrepath MQSIJREPATH –wmbregistrypath MQSIREGISTRYPATH –wmbversion MQSIVERSION
   
   Note the following:
   • MQJAVAVERSION is the WebSphere MQ version number (e.g., 7.0.1.2). This option should not be specified on Integration Nodes that are configured to use the MQTT transport.
   • MQJAVAINSTALLPATH is the path to the WebSphere MQ Java installation. This option should not be specified on Integration Nodes that are configured to use the MQTT transport.

9. Continue to the Configure the monitoring extension section.

   After upgrading WebSphere MQ or WebSphere Message Broker, you must rerun the install.bat command, as described in the following steps.
10. Stop the WMB Monitoring Extension if it is running.
11. Open a USS command window with the proper WebSphere MQ and WebSphere Message Broker environment setup (see related sections above on how to prepare your environment).
12. Change to the qpwmb directory where the monitoring extension was installed.
13. Install by providing environment information manually, run:
    
    ./bin/install.sh -mqjavaversion MQJAVAVERSION -mqjavainstallpath MQJAVAINSTALLPATH -wmbfilepath MQSIFILEPATH –wmbjrepath MQSIJREPATH –wmbregistrypath MQSIREGISTRYPATH –wmbversion MQSIVERSION
    
    Note the following:
    • MQJAVAVERSION is the WebSphere MQ version number (e.g., 7.0.1.2). This option should not be specified on Integration Nodes that are configured to use the MQTT transport.
    • MQJAVAINSTALLPATH is the path to the WebSphere MQ Java installation. This option should not be specified on Integration Nodes that are configured to use the MQTT transport.
14. Start the extension.

Where to go from here

• To control and configure the extension, see Running the WebSphere Message Broker monitoring extension.

• To upgrade the extension, see Upgrading the agent and extensions.
• To define an alternative JRE, see Defining alternative JREs for Java extensions.
• To view uninstall instructions, see Uninstalling the WebSphere Message Broker monitoring extension.