apm_9.5--apm for ibm websphere mq guide

for IBM WebSphere MQ Guide Release 9.5

CA Application Performance Management

This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation) is for your informational purposes only and is subject to change or withdrawal by CA at any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA.

Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.

The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice.

The manufacturer of this Documentation is CA.

Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

Copyright 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

CA Technologies Product References

This document references the following CA Technologies products and features:

CA Application Performance Management (CA APM)

CA Application Performance Management ChangeDetector (CA APM ChangeDetector)

CA Application Performance Management ErrorDetector (CA APM ErrorDetector)

CA Application Performance Management for CA Database Performance (CA APM for CA Database Performance)

CA Application Performance Management for CA SiteMinder (CA APM for CA SiteMinder)

CA Application Performance Management for CA SiteMinder Application Server Agents (CA APM for CA SiteMinder ASA)

CA Application Performance Management for IBM CICS Transaction Gateway (CA APM for IBM CICS Transaction Gateway)

CA Application Performance Management for IBM WebSphere Application Server (CA APM for IBM WebSphere Application Server)

CA Application Performance Management for IBM WebSphere Distributed Environments (CA APM for IBM WebSphere Distributed Environments)

CA Application Performance Management for IBM WebSphere MQ (CA APM for IBM WebSphere MQ)

CA Application Performance Management for IBM WebSphere Portal (CA APM for IBM WebSphere Portal)

CA Application Performance Management for IBM WebSphere Process Server (CA APM for IBM WebSphere Process Server)

CA Application Performance Management for IBM z/OS (CA APM for IBM z/OS)

CA Application Performance Management for Microsoft SharePoint (CA APM for Microsoft SharePoint)

CA Application Performance Management for Oracle Databases (CA APM for Oracle Databases)

CA Application Performance Management for Oracle Service Bus (CA APM for Oracle Service Bus)

CA Application Performance Management for Oracle WebLogic Portal (CA APM for Oracle WebLogic Portal)

CA Application Performance Management for Oracle WebLogic Server (CA APM for Oracle WebLogic Server)

CA Application Performance Management for SOA (CA APM for SOA)

CA Application Performance Management for TIBCO BusinessWorks (CA APM for TIBCO BusinessWorks)

CA Application Performance Management for TIBCO Enterprise Message Service (CA APM for TIBCO Enterprise Message Service)

CA Application Performance Management for Web Servers (CA APM for Web Servers)

CA Application Performance Management for webMethods Broker (CA APM for webMethods Broker)

CA Application Performance Management for webMethods Integration Server (CA APM for webMethods Integration Server)

CA Application Performance Management Integration for CA CMDB (CA APM Integration for CA CMDB)

CA Application Performance Management Integration for CA NSM (CA APM Integration for CA NSM)

CA Application Performance Management LeakHunter (CA APM LeakHunter)

CA Application Performance Management Transaction Generator (CA APM TG)

CA Cross-Enterprise Application Performance Management

CA Customer Experience Manager (CA CEM)

CA Embedded Entitlements Manager (CA EEM)

CA eHealth Performance Manager (CA eHealth)

CA Insight Database Performance Monitor for DB2 for z/OS

CA Introscope

CA SiteMinder

CA Spectrum Infrastructure Manager (CA Spectrum)

CA SYSVIEW Performance Management (CA SYSVIEW)

Contact CA Technologies

Contact CA Support

For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following resources:

Online and telephone contact information for technical assistance and customer services

Information about user communities and forums

Product and documentation downloads

CA Support policies and guidelines

Other helpful resources appropriate for your product

Providing Feedback About Product Documentation

If you have comments or questions about CA Technologies product documentation, you can send a message to [email protected].

To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at http://ca.com/docs.

Contents 7

Contents

Chapter 1: IBM WebSphere MQ Monitoring 15

About the Extension for WebSphere MQ .................................................................................................................. 15

Extension for WebSphere MQ Components .............................................................................................................. 16

Chapter 2: Preparing to install 17

Verify System and Version Requirements .................................................................................................................. 17

Verify Server Connection and Access ......................................................................................................................... 17

Obtain Third-Party Libraries ....................................................................................................................................... 17

PCF JAR File ......................................................................................................................................................... 17

ConfigManagerProxy.jar ..................................................................................................................................... 18

j2ee.jar ................................................................................................................................................................ 18

Additional JAR Files ............................................................................................................................................. 18

Chapter 3: Installation 21

Install Enterprise Manager components on a new Enterprise Manager ................................................................... 21

Install Enterprise Manager components on an Existing Enterprise Manager ............................................................ 22

Install MQ Java Connector agent as a new installation .............................................................................................. 23

Install MQ Java Connector agent on an existing agent .............................................................................................. 24

Install MQMonitor agent ............................................................................................................................................ 24

Chapter 4: Configuration 27

Configure MQ Java Connector agent ......................................................................................................................... 27

Configure the MQMonitor to monitor WebSphere MQ Queue Managers ................................................................ 28

Configure the MQMonitor Agent for Third-Party Libraries ................................................................................ 28

Configure the MQMonitor Agent Properties ...................................................................................................... 30

Run the MQMonitor Agent ................................................................................................................................. 30

Configure the MQMonitor to monitor WebSphere Message Brokers ....................................................................... 30

Configure the MBMonitor.properties File for WebSphere MB 6.x ..................................................................... 31

Configure the MBMonitor_7.properties File for WebSphere MB 7.0 or 8.0 ...................................................... 31

Create JMS queues .............................................................................................................................................. 33

Set Security Requirements to Monitor an MQ object ................................................................................................ 34

Set Security Requirements for MB 6.x ....................................................................................................................... 35

Set Security Requirements to Monitor a Remote WebSphere MB 7.0 or 8.0 ............................................................ 36

Configure WebSphere MQ for Trace .......................................................................................................................... 37

Configure Tracing Automatically ......................................................................................................................... 37

8 for IBM WebSphere MQ Guide

Configure Tracing Manually ................................................................................................................................ 39

Set the MCA User ID ............................................................................................................................................ 41

Configure handshake for Cross Process Transaction Tracing .............................................................................. 43

Configure WebSphere MQ to Publish Events ............................................................................................................. 44

Chapter 5: Additional Information 45

Turn On Queue Monitoring ........................................................................................................................................ 45

Configure Application Server When Java 2 Security is Enabled ................................................................................. 45

Share the wily Folder Across MQ Java Connector agents .......................................................................................... 46

Configure JCA Connection Pool .................................................................................................................................. 47

Configure SSL .............................................................................................................................................................. 48

How to Set Up Client-Server Communication Over SSL ...................................................................................... 49

Configure the Server ........................................................................................................................................... 49

Configure the Client ............................................................................................................................................ 50

Generate Personal Certificates ........................................................................................................................... 54

Configure CA APM ErrorDetector ............................................................................................................................... 54

Install the MQMonitor Agent as a Windows Service ................................................................................................. 56

Upgrade CA APM for IBM WebSphere MQ ................................................................................................................ 57

Configure MQ applications for SOA Dependency Map .............................................................................................. 58

Auto-discover Queue Managers ................................................................................................................................ 60

Set Auto Discovery Properties ............................................................................................................................ 60

View the Auto Discovered Queue Managers in the What's Interesting section ................................................. 63

Installation and Configuration in an EM Clustered Environment ............................................................................... 63

Chapter 6: Transaction Tracing 65

Cross-Process Transaction Tracing ............................................................................................................................. 65

Verify the Transaction Trace Configuration ............................................................................................................... 66

WebSphereMQ Cross Process Transaction Trace Health & Availability Dashboard .................................................. 66

Configure the Enterprise Manager for Trace ............................................................................................................. 69

Identifying a Slow Transaction ................................................................................................................................... 69

Transaction Trace with Trace Holding Duration Set to 0ms ................................................................................ 70

Transaction Trace with Holding Duration Set to a Value Other than 0ms .......................................................... 70

Enable or Disable MQ Traces ..................................................................................................................................... 71

Filter Queues for Transaction Trace ........................................................................................................................... 72

Trace Data Properties ................................................................................................................................................. 72

Chapter 7: Viewing Data Using the WebSphere MQ Extension 75

View Data ................................................................................................................................................................... 75

Console Dashboards ................................................................................................................................................... 75

MQ Dashboards in the Console .......................................................................................................................... 75

Contents 9

View Dashboards and Data ........................................................................................................................................ 76

Understanding the Metrics Tree ......................................................................................................................... 76

Show Investigator Dashboards and Data Displays .............................................................................................. 80

Aggregated Metrics ............................................................................................................................................. 81

WebSphereMQ Sample Report Templates ................................................................................................................ 84

Chapter 8: Dashboards 85

Management Modules ............................................................................................................................................... 85

WebSphere MQ Client and Server Dashboards ......................................................................................................... 85

WebSphere MQ Client and Server Overview Dashboard.................................................................................... 86

WebSphere MQ Client and Server Overview - Details Dashboard ..................................................................... 86

WebSphere MQ - Client Connections Dashboard ............................................................................................... 88

WebSphere MQ - Client Operations Dashboard ................................................................................................. 88

WebSphere MQ - Server Dashboard ................................................................................................................... 88

WebSphere Message Broker Dashboards .................................................................................................................. 88

WebSphere Message Broker Overview Dashboard ............................................................................................ 89

Other Message Broker Dashboards .................................................................................................................... 90

Message Broker Alerts ........................................................................................................................................ 91

Appendix A: MQAgent.properties File 93

mqmonitor.mqagent.id.list ........................................................................................................................................ 93

handshake.mqagent.id ............................................................................................................................................... 94

handshake.qm.host .................................................................................................................................................... 94

handshake.qm.port .................................................................................................................................................... 94

handshake.qm.channelname ..................................................................................................................................... 94

handshake.qm.character.set ...................................................................................................................................... 94

handshake.qm.ssl ....................................................................................................................................................... 95

handshake.qm.channel.ssl.cipherspec ....................................................................................................................... 95

handshake.queue ....................................................................................................................................................... 95

truststore.path ........................................................................................................................................................... 95

keystore.path ............................................................................................................................................................. 95

keystore.password ..................................................................................................................................................... 96

mqtracing.exclude.queues.regex ............................................................................................................................... 96

mq.autodiscovery.enabled ......................................................................................................................................... 96

mq.autodiscovery.queue ........................................................................................................................................... 97

Appendix B: MQMonitor.properties File 99

Specific MQ Data Section ........................................................................................................................................... 99

mq.monitor.list ................................................................................................................................................. 100

@.host ..................................................................................................................... 100


@.port ..................................................................................................................... 100

@.channelname ...................................................................................................... 100

@.character.set ....................................................................................................... 101

@.delaytime ............................................................................................................ 101

@.report.static.freq ................................................................................................. 101

@.ssl ........................................................................................................................ 101

@.channel.ssl.cipherspec ........................................................................................ 102

truststore.path .................................................................................................................................................. 102

keystore.path .................................................................................................................................................... 102

keystore.password ............................................................................................................................................ 102

MQ Events Section ................................................................................................................................................... 102

@.qmgr.event.queue .............................................................................................. 103

@.event.destructive.get .......................................................................................... 103

@.performance.event.queue .................................................................................. 104

@.channel.event.queue .......................................................................................... 104

Special Settings Section ............................................................................................................................................ 105

Advanced Settings Section ....................................................................................................................................... 106

MQ Trace Related Properties Section ...................................................................................................................... 106

trace.dlq.activity.enabled ................................................................................................................................. 107

trace.polling.enabled ........................................................................................................................................ 107

trace.polling.interval ......................................................................................................................................... 108

trace.polling.retry.count ................................................................................................................................... 108

trace.dlq.flag.time ............................................................................................................................................. 108

handshake.mqagent.id ...................................................................................................................................... 108

handshake.qm.host ........................................................................................................................................... 109

handshake.qm.port ........................................................................................................................................... 109

handshake.qm.channelname ............................................................................................................................ 109

handshake.qm.character.set............................................................................................................................. 109

handshake.qm.ssl .............................................................................................................................................. 109

handshake.qm.channel.ssl.cipherspec .............................................................................................................. 110

handshake.queue .............................................................................................................................................. 110

trace.hold.maxduration .................................................................................................................................... 110

MQ Auto Discovery Related Properties Section ....................................................................................................... 110

mq.monitor.agent.id ......................................................................................................................................... 111

mq.autodiscovery.enabled ............................................................................................................................... 111

mq.autodiscovery.queue .................................................................................................................................. 111

mq.autodiscovery.properties.update ............................................................................................................... 111

Filters Section ........................................................................................................................................................... 111

@.filter.exclude.static ............................................................................................. 112

@.queue.filter.exclude.system ................................................................................ 112

@.queue.filter.exclude.dynamic ............................................................................. 112

@.queue.filter.includeonly.regex ............................................................................ 113

Contents 11

@.channel.filter.includeonly.regex ......................................................................... 113

@.pagesets.filter.includeonly.regex ........................................................................ 113

@.log.filter.includeonly.regex ................................................................................. 113

Appendix C: MBMonitor.properties File 115

CMP Connection Section .......................................................................................................................................... 115

configuration.manager.host ............................................................................................................................. 115

configuration.manager.queue.manager ........................................................................................................... 115

configuration.manager.port .............................................................................................................................. 116

MQ Connection Section ........................................................................................................................................... 116

Statistics Section ...................................................................................................................................................... 116

Broker (JMS) Connection Section ............................................................................................................................. 117

jms.broker.host ................................................................................................................................................. 117

jms.broker.queue.manager............................................................................................................................... 117

jms.broker.port ................................................................................................................................................. 117

Execution Group Section .......................................................................................................................................... 118

Node Statistics Section ............................................................................................................................................. 118

Delay Times Section ................................................................................................................................................. 118

Monitoring Level Settings Section ............................................................................................................................ 119

.messageflow.statistics.............................................................................................................. 119

.broker.statistics ........................................................................................................................ 120


recommended.metrics.messageflow.statistics ................................................................................................. 120

recommended.metrics.broker.statistics ........................................................................................................... 120

SSL Configuration Section......................................................................................................................................... 121

cmp.ssl .............................................................................................................................................................. 121

jms.ssl ................................................................................................................................................................ 121

cmp.connection.ssl.cipherspec ......................................................................................................................... 121

jms.connection.ssl.cipherspec .......................................................................................................................... 121

truststore.path .................................................................................................................................................. 121

keystore.path .................................................................................................................................................... 122


Appendix D: MBMonitor_7.properties File 123

CMP Connection Section .......................................................................................................................................... 123

mq.broker.monitor.list ...................................................................................................................................... 123

a.host ................................................................................................................................................................ 123

a.queue.manager .............................................................................................................................................. 124

a.port ................................................................................................................................................................. 124

MQ Connection Section ........................................................................................................................................... 124

Statistics Section ...................................................................................................................................................... 125


Execution Group Section .......................................................................................................................................... 125

Node Statistics Section ............................................................................................................................................. 126

Delay Times Section ................................................................................................................................................. 126

Monitoring Level Settings Section ............................................................................................................................ 127

.messageflow.statistics.............................................................................................................. 127


recommended.metrics.messageflow.statistics ................................................................................................. 128

SSL Configuration Section......................................................................................................................................... 128

.ssl ..................................................................................................................................................................... 128

broker.connection.ssl.cipherspec ..................................................................................................................... 128

jms.connection.ssl.cipherspec .......................................................................................................................... 128

truststore.path .................................................................................................................................................. 128

keystore.path .................................................................................................................................................... 129


Appendix E: Metrics Reference 131

General Metric Characteristics ................................................................................................................................. 131

Metric Display Sets ............................................................................................................................................ 132

Queue Manager Cluster Metrics .............................................................................................................................. 132

Aggregate Clusters Status Metrics .................................................................................................................... 133

Top Level Repository Trees ............................................................................................................................... 133

Workload Balance Metrics ................................................................................................................................ 147

Queue Manager Metrics .......................................................................................................................................... 153

Top Level Queue Manager Aggregated Metrics ............................................................................................... 153

Channel Metrics ................................................................................................................................................ 155

Configuration Properties Metrics ...................................................................................................................... 159

Transmission Queue Metrics ............................................................................................................................ 169

Last Check Metrics ............................................................................................................................................ 169

Queue Metrics................................................................................................................................................... 170

Channel Initiator Metrics .................................................................................................................................. 178

Log Metrics ........................................................................................................................................................ 179

Usage Metrics ................................................................................................................................................... 182

Queue Manager Status Metrics ........................................................................................................................ 184

Message Broker Metrics........................................................................................................................................... 186

Configuration Manager Aggregate Totals ......................................................................................................... 186

Broker Properties and Aggregate Totals ........................................................................................................... 187

Execution Groups Metrics ................................................................................................................................. 187

Find MQ Java Connector Metrics ............................................................................................................................. 199

Operational Groups ........................................................................................................................................... 199

Backend Metrics ................................................................................................................................................ 199

Instance Counts Metrics .................................................................................................................................... 200

Contents 13

JCA Node Metrics .............................................................................................................................................. 200

WebSphereMQ Node Metrics ........................................................................................................................... 201

ErrorDetector Metrics ....................................................................................................................................... 203

Appendix F: JCA/JMS Operational Groups 205

JCA Operational Groups ........................................................................................................................................... 205

JCA Queue Manager Operations ....................................................................................................................... 206

JCA Queue Operational Groups ........................................................................................................................ 209

JMS Operational Groups .......................................................................................................................................... 209

JMS Queue Manager Operational Groups ........................................................................................................ 210

JMS Queue/Topic Operational Groups ............................................................................................................. 213

Appendix G: Performance and Sizing 215

MQMonitor Agent Background ................................................................................................................................ 215

WebSphere MQ Sizing .............................................................................................................................................. 215

Sizing Your Enterprise Manager ........................................................................................................................ 216

Sizing Your MQMonitor Agent .......................................................................................................................... 216

Sample MQMonitor Agent Sizing Table ............................................................................................................ 216

WebSphere MB Sizing .............................................................................................................................................. 220

Sizing Your MQMonitor Agent for WebSphere MB .......................................................................................... 221

Sample MQMonitor Agent Sizing Table for WebSphere MB ............................................................................ 221

Appendix H: Frequently Asked Questions 225

Alerts and Dashboards ............................................................................................................................................. 225

Unexpected Increase in Queue Depth ..................................................................................................................... 226

Installation ................................................................................................................................................................ 227

Metrics ..................................................................................................................................................................... 228

Queues ..................................................................................................................................................................... 229

Transaction Tracing .................................................................................................................................................. 230

Appendix I: Troubleshooting 233

Errors and Troubleshooting Steps ............................................................................................................................ 233

Appendix J: Support for IPv6 Environment 243

Connect to the Enterprise Manager in an IPv6 Environment .................................................................................. 243

Configure the MQMonitor Agent ...................................................................................................................... 243

MQ Java Connectors ......................................................................................................................................... 244

Support for WebSphere MQ and WebSphere MB in an IPv6 Environment ............................................................. 244


Index 245

Chapter 1: IBM WebSphere MQ Monitoring 15

Chapter 1: IBM WebSphere MQ Monitoring

The extension for IBM WebSphere MQ Connectors and Messaging System allows administrators to monitor the health and performance of IBM WebSphere Message Queue (WebSphere MQ) and IBM WebSphere Message Broker (WebSphere MB).

This section contains the following topics:

About the Extension for WebSphere MQ (see page 15) Extension for WebSphere MQ Components (see page 16)

About the Extension for WebSphere MQ

An extension of CA Introscope, the flagship web application management solution, CA APM for IBM WebSphere MQ lets you monitor the performance of WebSphere MQ and WebSphere MB. CA APM for IBM WebSphere MQ provides metrics that you can use to monitor the health and availability of WebSphere MQ-connected web applications. The metrics also help you quickly isolate the source of WebSphere MQ-related and WebSphere MB-related performance problems.

CA APM for IBM WebSphere MQ lets you perform the following actions:

Monitor the performance of the WebSphere MQ infrastructure.

Monitor the performance of WebSphere MB.

Monitor the performance of WebSphere MQ Java Connectors.

Correlate WebSphere MQ-to-application activity.

Verify the use of WebSphere MQ capacity and use of MB capacity by web applications.

Verify if WebSphere MQ and WebSphere MB meet the Service Level Agreements of web applications.

CA APM for IBM WebSphere MQ provides Management Modules with preconfigured dashboards and performance-triggered alerts to monitor:

Critical messages and queues for WebSphere MQ

Health and availability of various WebSphere MB components

CA APM for IBM WebSphere MQ ensures high availability of all WebSphere MQ-connected Java web applications.

Extension for WebSphere MQ Components


Extension for WebSphere MQ Components

CA APM for IBM WebSphere MQ consists of the following components:

MQMonitor agent

The MQMonitor agent reports data on the performance of WebSphere MQ resources, such as queues and channels to CA Introscope. CA Introscope then displays the data as metrics under the following nodes in the Investigator metrics tree:

Queue ManagersThe Queue Managers directory lists metric data for Queues, Channels, Logs (z/OS only), Usage (z/OS only), Channel Initiators (z/OS only), and Queue Manager objects.

Queue Manager ClustersThe Investigator displays Cluster Queue Managers with their associated queues and channels so that you can monitor cluster performance. Multi-instanced cluster queues appear under the Workload Balance directory.

MQ Java Connectors

The MQ Java Connectors monitor the WebSphere MQ classes (both Connector and JMS) used for communicating with WebSphere MQ from a web application that is deployed on an application server. The web applications can use either JMS or Connector classes (or a combination of both) to communicate with WebSphere MQ. The data is displayed as metrics in the Investigator tree under the WebSphereMQ node.

Management Modules and Enterprise Manager extensions

The Management Modules contain preconfigured dashboards and alerts that CA Introscope uses to display WebSphere MQ and WebSphere MB metrics in graphical form. The component also includes dashboards for the Investigator and JavaScript calculators and Enterprise Manager extensions which aggregate metric data for display in the Investigator. You can configure the dashboards and alerts to notify operations and application-support personnel and WebSphere MQ administrators. Such alerts can be used to address potential WebSphere MQ and WebSphere MB issues before they become application performance bottlenecks.


Chapter 2: Preparing to install

This chapter contains the prerequisites that must be satisfied before you begin the installation of the CA APM for IBM WebSphere MQ.


Verify System and Version Requirements (see page 17) Verify Server Connection and Access (see page 17) Obtain Third-Party Libraries (see page 17)

Verify System and Version Requirements

Ensure your version of CA APM for IBM WebSphere MQ is listed in the APM Compatibility Guide.

Verify Server Connection and Access

To ensure proper server connection, verify the following:

A WebSphere MQ command server that is defined and running on the Queue Manager.

A Server Connection channel that is defined on the Queue Manager.

Note: Contact your WebSphere MQ specialist for details about configuring the Queue Manager.

Network access through firewalls, for the MQ Monitor Agent.

Obtain Third-Party Libraries

To run the MQMonitor agent, obtain third-party JAR files and configure the MQMonitor agent.

PCF JAR File

Download the PCF jar file from the www.ibm.com support and downloads section.



ConfigManagerProxy.jar

The ConfigManagerProxy.jar is in the IBM Message Brokers directory that is installed on the computer that has the MQMonitor agent installation: The directory structure is as follows:

For IBM Message Brokers :

//classes

j2ee.jar

Valid for IBM Message Broker Toolkit 6.x:

After installing the IBM Message Broker Toolkit on the same computer as the MQMonitor agent, you can obtain the j2ee.jar file from the following directory of the IBM Message Broker Toolkit installation:

For IBM Message Broker Toolkit 6.0:

/runtimes/base_v6_stub/lib

For IBM Message Broker Toolkit 6.1:

/runtimes/wsdk/j2ee14

Alternatively, you can find the j2ee.jar file in the /lib directory of the J2EE SDK installation. You can also download J2EE SDK from http://www.oracle.com, subject to the accompanying license terms.

Additional JAR Files

The following files are required for WebSphere MQ 6.x:

Copy the following JAR files from /java/lib to the ./MQMonitor/lib directory:

com.ibm.mq.jar

com.ibm.mqjms.jar

connector.jar

dhbcore.jar



The following files are required for WebSphere MQ 7.0 and 7.1:

Copy the following JAR files from /java/lib to the ./MQMonitor/lib directory:

com.ibm.mq.jar

com.ibm.mqjms.jar

connector.jar

dhbcore.jar

com.ibm.mq.commonservices.jar

com.ibm.mq.headers.jar

com.ibm.mq.jmqi.jar

Note: If you are monitoring the Queue Managers of both 6.x and 7.0 or 7.1, then use the WebSphere MQ 7.0 or 7.1 library files.

Alternatively, to obtain the files install the MQ client software from www.ibm.com.

Note: Install the WebSphere MQ client on the same computer as the MQMonitor agent.


Chapter 3: Installation

You can install the Enterprise Manager components of the Java Connectors by using the Enterprise Manager installer. You can install the agent for Application Server by using the agent installer. You can install the Standalone MQMonitor agent by using the Standalone agent installer.

Note: To view the MQ components in the SOA Dependency Map, install CA APM for SOA.


Install Enterprise Manager components on a new Enterprise Manager (see page 21) Install Enterprise Manager components on an Existing Enterprise Manager (see page 22) Install MQ Java Connector agent as a new installation (see page 23) Install MQ Java Connector agent on an existing agent (see page 24) Install MQMonitor agent (see page 24)

Install Enterprise Manager components on a new Enterprise Manager

You can install the Enterprise Manager components by using the Enterprise Manager installer.

Follow these steps:

1. Run the Enterprise Manager installer.

2. In the Select Monitoring Options screen, select CA APM for IBM WebSphere MQ and IBM WebSphere Message Broker.

3. Verify that the following files are present:

In /product/enterprisemanager/plugins:

com.wily.powerpack.wmq.ddtv.typeview.jar

com.wily.powerpack.wmq.em.extension.jar

In /config/modules:

WebSphereMQ_Client_And_Server.jar

WebsphereMQ_CPT_Health_And_Availability.jar

WMBManagementModule.jar

Install Enterprise Manager components on an Existing Enterprise Manager


In /scripts:

Broker-Agent-MQConnectionStatus.js

Cluster-Agent-MQConnectionStatus.js

Clusters-ChannelInstanceCounts.js

Clusters-Channels.js

Clusters-QueueManager.js

Clusters-Queues.js

Clusters-SingleClusterAggregation.js

Clusters-TopLevelAggregation.js

MBMQ-ChannelIndoubtAggregation.js

MBMQ-ChannelInstanceCountsAggregation.js

MBMQ-PagesetStatusAggregation.js

MBMQ-QueueManagerAggregation.js

MBMQ-QueuesAggregation.js

MQ-ChannelIndoubtAggregation.js

MQ-ChannelInstancesCountsAggregation.js

MQ-ConnectionStatusAggregation.js

MQ-HostNameAggregation.js

MQ-PagesetStatusAggregation.js

MQ-QueueManagerAggregation.js

MQ-QueuesAggregation.js

MQ-TopLevelAggregation.js

Enterprise Manager components have been installed on a new Enterprise Manager.

Install Enterprise Manager components on an Existing Enterprise Manager

If you are using the same Enterprise Manager for different agents, the Enterprise Manager components of all the extensions are already installed in the /examples folder when you run the installer for the first time.

You can install the enterprise manager components of the extension on an existing Enterprise Manager.

Install MQ Java Connector agent as a new installation


Follow these steps:

1. Copy the contents of /examples/MQMonitorForWebsphereMQ to the installation directory.

2. Restart the Enterprise Manager.

Enterprise Manager components have been installed on an existing Enterprise Manager.

Install MQ Java Connector agent as a new installation

The agent installer lets you install the MQ Java Connector Agent for Application Server.

Follow these steps:

1. Run the agent installer specific to your application server.

2. Select CA APM for IBM WebSphere MQ and IBM WebSphere Message Broker during the installation.


In /wily/common:

MQAgent.properties

MQAppSupport.jar

In /wily/core/config:

webspheremq.pbl

webspheremq.pbd

webspheremq_errors.pbd

webspheremq_instancecounts.pbd

webspheremq-extra.pbd

In /wily/core/ext/:

MQNameFormatter.jar

MQ Java Connector agent has been installed as a new installation.

Install MQ Java Connector agent on an existing agent


Install MQ Java Connector agent on an existing agent

You can install MQ Java connector agent on an existing agent.

Follow these steps:

1. Copy the webspheremq.pbl and its associated pbds from /wily/examples/PowerpackforWebsphereMQ/config to the /wily/core/config directory

2. Open the IntroscopeAgent.profile file that is located in the /wily/core/config directory.

3. Go to the introscope.autoprobe.directivesFile property.

4. Add the webspheremq.pbl as follows:

introscope.autoprobe.directivesFile=websphere-typical.pbl,hotdeploy,websphere

mq.pbl

5. Open the webspheremq.pbl and uncomment any additional pbds that you require for further instrumentation. For example, webspheremq_errors.pbd.

6. Copy the MQNameFormatter.jar from /wily/examples/PowerpackforWebsphereMQ/ext to /wily/core/ext.

7. Restart the Application Server.

MQ Java Connector agent has been installed on an existing agent.

Install MQMonitor agent

You can install the agent for MQMonitor by using the Standalone agent installer.

Follow these steps:

1. Run the Standalone agent installer and select CA APM for IBM WebSphere MQ Connectors and Messaging Systems during the installation.

2. Specify as the installation directory.

3. Specify the Enterprise Manager host and port.

All the agent files are copied to the directory.

Install MQMonitor agent



In /lib:

Agent.jar

jline-0.9.94.jar

In /tools:

mqConfigurationSetup.bat (Windows) or mqConfigurationSetup.sh (UNIX)

In /ext:

Supportability-Agent.jar

In /properties:

MBMonitorJMSQueues.mqsc

IntroscopeAgent.profile

MBMonitor.properties

MBMonitor.properties.template

MQMonitor.properties

MQMonitor.properties.template

MBMonitor_7.properties

In :

MQMonitor.jar

mqPwdEncryptor.bat (Windows) or mqPwdEncryptor.sh (UNIX)

startMQDiscovery.bat (Windows) or startMQDiscovery.sh (UNIX)

startMQMonitor.bat (Windows) or startMQMonitor.sh (UNIX) and stopMQMonitor.sh (UNIX)

WILYRACF.JCL

MQMonitor agent has been installed.


Chapter 4: Configuration


Configure MQ Java Connector agent (see page 27) Configure the MQMonitor to monitor WebSphere MQ Queue Managers (see page 28) Configure the MQMonitor to monitor WebSphere Message Brokers (see page 30) Set Security Requirements to Monitor an MQ object (see page 34) Set Security Requirements for MB 6.x (see page 35) Set Security Requirements to Monitor a Remote WebSphere MB 7.0 or 8.0 (see page 36) Configure WebSphere MQ for Trace (see page 37) Configure WebSphere MQ to Publish Events (see page 44)

Configure MQ Java Connector agent

MQ Java Connector monitors various Connectors, JMS classes, and methods that communicate with WebSphere MQ.

Follow these steps:

1. If you have installed and enabled the extension, verify that the PBL file is added to the introscope.autoprobe.directivesFile property in the IntroscopeAgent.profile file that is located in the /wily/core/config directory as follows:

introscope.autoprobe.directivesFile=websphere-typical.pbl,hotdeploy,websphere

mq.pbl

Note: This example is in the case of a WebSphere Application Server where the WebSphere MQ pbl is appended to the websphere-typical.pbl.

Configure the MQMonitor to monitor WebSphere MQ Queue Managers


2. Open the webspheremq.pbl and uncomment any additional pbds that you require for further instrumentation. For example, webspheremq_errors.pbd.

3. Specify the connection properties for the Enterprise Manager to which you want to send the metrics reported by the MQMonitor agent. Use the IntroscopeAgent.profile file to configure the following properties:

introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT

Specifies the Enterprise Manager host name or IP address.

Default: localhost

introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT

Specifies the Enterprise Manager port.

Default: 5001

MQ Java Connector agent has been configured.

Note: For information about metric aging properties, see the CA APM Java Agent Implementation Guide.


The MQMonitor agent provides information that is related to WebSphere MQ resources such as Queue Managers, Queues, and Channels, and WebSphere MB resources such as Brokers and Message Flows. This capability lets you monitor various dynamic WebSphere MQ or WebSphere MB properties to trigger alerts, view utilization measurements of components, and view resource properties.

Note: The MQMonitor agent is supported only on Windows or UNIX.

To configure the MQMonitor agent, perform the following steps:

1. Configure the MQMonitor agent for third-party libraries (see page 28).

2. Configure the MQMonitor agent properties (see page 30).

3. Run the MQMonitor agent (see page 30).

Configure the MQMonitor Agent for Third-Party Libraries

To run the MQMonitor agent, you edit the start script with the location of third-party JAR files (see page 17) on the MQMonitor agent host. Edit the start script, startMQMonitor.bat (Windows) or startMQMonitor.sh (UNIX), to modify the classpath with the actual path of the files.



To monitor WebSphere MQ 6.0:

com.ibm.mq.jar

connector.jar

PCF JAR file (see page 17)

To monitor WebSphere MQ 7.0:

com.ibm.mq.jar

connector.jar

com.ibm.mq.commonservices.jar

com.ibm.mq.headers.jar

com.ibm.mq.jmqi.jar


com.ibm.mq.pcf.jar obtained from the WebSphere MQ v7.0 installation path /java/lib.

Note: To monitor the WebSphere MQ v7.0 Queue Managers, you need the two PCF JAR files mentioned. Provide the path to these two JAR files in the MQMonitor agent start script.

To monitor WebSphere MB 6.0 to 6.1 or MB 7.0:

com.ibm.mq.jar

com.ibm.mqjms.jar


dhbcore.jar

ConfigManagerProxy.jar

j2ee.jar

connector.jar

Configure the MQMonitor to monitor WebSphere Message Brokers


Configure the MQMonitor Agent Properties

Locate the MQMonitor.properties file in the /MQMonitor/properties directory, and configure the properties to meet your requirements.

Follow these steps:

1. List all the queue managers you want to monitor.

mq.monitor.list=,,

2. Provide the following information for all the queue managers listed:

.host

.port

MQMonitor.properties file has been configured.

Note: Depending on what you want to monitor, configure other properties in the MQMonitor.properties File (see page 99) files. For example, edit the MQMonitor.properties file to identify the queues whose MQ Events you want to monitor.

Run the MQMonitor Agent

To complete the configuration of the MQMonitor agent, run it.

Follow these steps:

1. Verify that your JAVA_HOME variable is set in system properties.

2. In the /MQMonitor directory, execute the startMQMonitor.bat (Windows) or startMQMonitor.sh (UNIX) file.

The WebSphere MQ tree, the WebSphere MB tree, or both appear in the Workstation tree under the node WebSphere MQ and Message Broker Agent.


Configure CA APM for IBM WebSphere MQ to monitor message brokers and to obtain the broker and message flow statistics for the message brokers.



Configure the MBMonitor.properties File for WebSphere MB 6.x

You can configure the CA APM for IBM WebSphere MQ to monitor MB 6.x.

Follow these steps:

1. Go to the /MQMonitor/properties directory and open the MBMonitor.properties file with a text editor.

2. Configure the following properties:

configuration.manager.host

Specifies the Configuration Manager Proxy (CMP) machine name or IP address.

Example: configuration.manager.host=localhost

configuration.manager.queue.manager

Specifies the CMP Queue Manager name.

Example: configuration.manager.queue.manager=WBRK6_DEFAULT_QUEUE_MANAGER

configuration.manager.port

Specifies the CMP Queue Manager port.

Example: configuration.manager.port=2414

MBMonitor.properties file has been configured.

Note: Depending on what you want to monitor, configure other properties in the MBMonitor.properties File (see page 115).

Important! If you configure the MBMonitor.properties file for WebSphere MB 6.0 to 6.1, you cannot configure the CA APM for IBM WebSphere MQ to monitor message brokers for WebSphere MB 7.0 or MB 8.0. Enabling both configuration files causes WebSphere MB monitoring failure.

Configure the MBMonitor_7.properties File for WebSphere MB 7.0 or 8.0

You can configure CA APM for IBM WebSphere MQ to monitor MB 7.0 and 8.0.



Follow these steps:

1. Go to the /MQMonitor/properties directory and open the MBMonitor_7.properties file with a text editor.

2. Provide a comma-separated list of unique identifiers for each broker you want to monitor. Set this property to start broker monitoring.

For example:

mq.broker.monitor.list=a,b

3. For each of the broker that is listed specify the following properties:

a.host

Specifies the broker machine name or IP address

a.queue.manager

Specifies the broker queue manager name.

a.port

Specifies the broker queue manager port.

MBMonitor_7.properties file has been configured.

Note: Depending on what you want to monitor, configure other properties in the MBMonitor_7.properties File (see page 123).



Create JMS queues

After configuring the MBMonitor.properties file or the MBMonitor_7.properties file, create JMS queues that use the JMS protocol.

Follow these steps:

1. Identify the Queue Manager where you have to define JMS queues.

If the Configuration Manager shares its Queue Manager with one of its brokers, this Queue Manager is the Queue Manager of the Configuration Manager.

If a Queue Manager is not shared between the Configuration Manager and its broker, you can create the JMS queue on any of the brokers in a publish/subscribe collective.

2. Find the file MBMonitorJMSQueues.mqsc in the /MQMonitor/properties directory. The file contains a series of MQSC commands.

3. Execute the following command on your Message Broker host, where queueMgr_name is the name of the Queue Manager you identified in an earlier step.

runmqsc queueMgr_name < MBMonitorJMSQueues.mqsc

All the commands in the MBMonitorJMSQueues.mqsc file are executed.

Set Security Requirements to Monitor an MQ object


Set Security Requirements to Monitor an MQ object

The following MQ permissions are required to monitor MQ objects from a remote computer. The user need not be part of the mqm group.

Note: is the Queue Manager and mqgroup is the usergroup name.

setmqaut -m -t qmgr -g mqgroup +connect +dsp +inq +crt

setmqaut -m -n SYSTEM.DEFAULT.MODEL.QUEUE -t q -g mqgroup +get +browse

+dsp

setmqaut -m -n SYSTEM.ADMIN.COMMAND.QUEUE -t q -g mqgroup +get +browse

+put +dsp +inq

setmqaut -m -n SYSTEM.ADMIN.PERFM.EVENT -t q -g mqgroup +get +browse +dsp

+inq

setmqaut -m -n SYSTEM.ADMIN.QMGR.EVENT -t q -g mqgroup +get +browse +dsp

+inq

setmqaut -m -n SYSTEM.ADMIN.CHANNEL.EVENT -t q -g mqgroup +get +browse

+dsp +inq

setmqaut -m -n SYSTEM.ADMIN.ACTIVITY.QUEUE -t q -g mqgroup +get +inq +dsp

setmqaut -m -n SYSTEM.DEAD.LETTER.QUEUE -t q -g mqgroup +get +inq +dsp

+browse

setmqaut -m -n '**' -t channel -g mqgroup +dsp

setmqaut -m -n '**' -t q -g mqgroup +dsp

setmqaut -m -n '**' -t namelist -g mqgroup +dsp

setmqaut -m -n '**' -t clntconn -g mqgroup +dsp

Set Security Requirements for MB 6.x


Set Security Requirements for MB 6.x

The following sections describe the minimum security settings that are needed for the MQMonitor agent for CMP, JMS, and PCF connections.

To set the minimum security that is needed for CMP Connection for the MQMonitor agent:

Apply the allmqi permission on the Queue Manager of the Configuration Manager as follows:

setmqaut -m -t qmgr -p @ +allmqi

Note: The allmqi permission sets the inq, set, connect, altusr, setid, setall permissions on the CMP Queue Manager:

Apply the put permission on the SYSTEM.BROKER.CONFIG.QUEUE queue of the CMP Queue Manager as follows:

setmqaut -m -t q -n SYSTEM.BROKER.CONFIG.QUEUE -p @ +put

Apply the get permission on the SYSTEM.BROKER.CONFIG.REPLY queue of the CMP Queue Manager as follows:

setmqaut -m -t q -n SYSTEM.BROKER.CONFIG.REPLY -p @ +get

Create an ACL entry on Configuration Manager by using following command.

mqsicreateaclentry -u -m / -x

V -p

In the following example, we allow user_x on machine_y to connect to the configuration manager ConfigMgr.

mqsicreateaclentry ConfigMgr -u user_x m machine_y -x V -p

Command component: -x V

Explanation: Gives view authority over Configuration Manager to the user.

Command component: -p

Explanation: Adds access to the Configuration Manager Proxy, also known as "all resources" access control entry.

Note: Either restart the Queue Manager or do a "refresh security" using the runmqsc command. Then restart the Configuration Manager after applying the security settings.

To set the minimum security that is needed for JMS Connection for the MQMonitor agent:

Apply allmqi permission on the JMS Queue Manager.

Apply allmqi permission to all JMS pub sub queues (#10) defined in the JMS Queue Manager.

Note: Either restart the Queue Manager or do a "refresh security" using the runmqsc command after applying the security settings as explained in the preceding section.

Set Security Requirements to Monitor a Remote WebSphere MB 7.0 or 8.0


Set Security Requirements to Monitor a Remote WebSphere MB 7.0 or 8.0

If you configure your environment to report WebSphere MB 7.0 or 8.0, set the following minimum security requirements.

Follow these steps:

1. Execute the following command on the queue manager of the broker.

setmqaut -m -t qmgr -p +all

2. Set allmqi permission for the following Queues that are part of the Broker Queue Manager:

SYSTEM.BROKER.ADMIN.QUEUE

SYSTEM.BROKER.ADMIN.REPLYTODM

SYSTEM.BROKER.ADMIN.STREAM

SYSTEM.BROKER.CONTROL.QUEUE

SYSTEM.BROKER.DEPLOY.REPLY

SYSTEM.BROKER.DEPLOY.QUEUE

SYSTEM.BROKER.DEPLOY.QUEUE

SYSTEM.BROKER.DEFAULT.STREAM

SYSTEM.ADMIN.COMMAND.QUEUE

SYSTEM.ADMIN.PERFM.EVENT

SYSTEM.ADMIN.QMGR.EVENT

SYSTEM.ADMIN.CHANNEL.EVENT

SYSTEM.ADMIN.ACTIVITY.QUEUE

Use the following command:

setmqaut -m -n -p +allmqi

3. Set allmqi permission to the following JMS pub sub queues that are defined for the Broker Queue Manager during installation:

SYSTEM.JMS.ADMIN.QUEUE

SYSTEM.JMS.PS.STATUS.QUEUE

SYSTEM.JMS.REPORT.QUEUE

SYSTEM.JMS.MODEL.QUEUE

SYSTEM.JMS.ND.SUBSCRIBER.QUEUE

SYSTEM.JMS.ND.CC.SUBSCRIBER.QUEUE

SYSTEM.JMS.D.SUBSCRIBER.QUEUE

Configure WebSphere MQ for Trace


SYSTEM.JMS.D.CC.SUBSCRIBER.QUEUE

SYSTEM.JMS.ND.SUBSCRIBER.WILY.MBMSGFLOW

SYSTEM.JMS.ND.SUBSCRIBER.WILY.MBBROKER

Use the following command:

runmqsc MB7QMGR < C:/MQMonitor/properties/MBMonitorJMSQueues.mqsc

4. Set allmqi permission to SYSTEM.BROKER.MB.TOPIC in the Broker Queue Manager using the following command:

setmqaut -m -n SYSTEM.BROKER.MB.TOPIC -t top -p +allmqi

5. (optional) Restart the broker and queue manager.


You can use the mqConfigurationSetup tool to configure the WebSphere MQ system for trace. You can also configure the WebSphere MQ system for trace manually.

Configure Tracing Automatically

You can use the mqConfigurationSetup tool to automate the configuration for cross-process transaction tracing. The tool contains a batch file named mqConfigurationSetup.bat (Windows) or mqConfigurationSetup.sh (UNIX). The file is available in the /tools directory of the MQMonitor agent.

Follow these steps:

1. Configure the MQMonitor.properties to monitor Queue Managers.

2. Edit the mqConfigurationSetup.bat file for the following settings.

Set the JAVA_HOME variable to a valid JRE.

Set the MQ_JAR variable to the location of com.ibm.mq.jar file.

Set the PCF_JAR variable to the location of com.ibm.mq.pcf-6.1.jar file.

Set the J2EE_JAR variable to the location of j2ee.jar file.



3. Run the mqConfigurationSetup.bat file. The command is as follows:

mqConfigurationSetup.bat [-i on/off] [-p ../properties/]

Note: Set the parameter -i for interactive or noninteractive mode. The default value of the parameter is on. If you set the parameter to on, then the tool prompts you for confirmation before changing the properties of the WebSphere MQ objects. If you set the parameter to off, then the tool changes all the properties without prompting you for confirmation.

Note: Set the parameter -p to indicate the location of the MQMonitor.properties file. The default value of this parameter is ../properties/.

The configuration tool updates the following properties on all the monitored Queue Managers and queues:

Sets the Activity recording property to Queue for each Queue Manager.

Creates the SYSTEM.ADMIN.ACTIVITY.QUEUE, Dead Letter Queue(DLQ), and Handshake queue if any of these queues do not exist in the Queue Manager.

Configures the SYSTEM.ADMIN.ACTIVITY.QUEUE, Dead Letter Queue, and Handshake queue as follows:

Sets the Max queue depth property to the maximum permitted value (999999999).

Sets the Put messages and Get messages properties to Allowed.

Sets the Shareability property to Shareable.

Sets the Default Input Open Option property to Input Shared.

The tool generates a report containing information about all the properties that were modified in the Queue Managers and queues. The tool saves the report to a file named changehistory.txt in the /tools directory of the MQMonitor agent.

Important! To apply the changes, perform one of the following operations:

Restart all active channels on the monitored Queue Managers

Restart all the monitored Queue Managers. (except for z/OS)

For z/OS, restart CHINIT only, as restarting the Queue Manager may change the value of the Activity Recording property of some Queue Managers to "Message" instead of "Queue".

More information:

Configure the MQMonitor Agent Properties (see page 30)



Configure Tracing Manually

You can manually configure the WebSphere MQ system for trace.

Follow these steps:

1. Configure the Queue Managers as follows:

a. Set the Activity recording property (see page 39).

b. Configure SYSTEM.ADMIN.ACTIVITY.QUEUE (see page 40).

2. Set the handshake queue (see page 41).

Set the Activity Recording Property

For all the Queue Managers in WebSphere MQ that the MQMonitor agent monitors, set the value of the Activity recording property to Queue. This setting enables the Queue Managers to generate activity reports. All the activity reports are generated in SYSTEM.ADMIN.ACTIVITY.QUEUE of the same Queue Manager.

You can use the MQSC commands to set and display the Activity recording property.

To set the Activity recording property, enter the command:

runmqsc

To view the value of the Activity recording property, enter the command:

display QMGR ACTIVREC

The Activity recording property values appear in the Command Prompt window under the following columns:

QMNAME(SOURCE)

ACTIVREC(MSG)

To set the ACTIVREC property value to QUEUE, enter the command:

alter QMGR ACTIVREC(QUEUE)



To verify the Activity recording property, enter the command:

display QMGR ACTIVREC

The Activity recording property values appear in the Command Prompt window under the following two columns:

QMNAME(SOURCE)

ACTIVREC(QUEUE)

Note: For more details about activity recording, see the IBM documentation.

Important! Restart the Queue Manager MCAs after configuring the SYSTEM.ADMIN.ACTIVITY.QUEUE.

Configure SYSTEM.ADMIN.ACTIVITY.QUEUE

You can configure SYSTEM.ADMIN.ACTIVITY.QUEUE using the MQ Explorer.

Follow these steps:

1. Open SYSTEM.ADMIN.ACTIVITY.QUEUE in the MQ Explorer.

2. Right-click SYSTEM.ADMIN.ACTIVITY.QUEUE and click Properties.

The SYSTEM.ADMIN.ACTIVITY.QUEUE properties window opens.

3. Select Extended and set the Max queue depth property to 999999999. Set Shareability as Shareable. Set the Default Input Open Option property to Input Shared.

4. Select General, and set the Put messages and Get messages properties to Allowed.

The SYSTEM.ADMIN.ACTIVITY.QUEUE has been configured.

Alternatively, you can configure SYSTEM.ADMIN.ACTIVITY.QUEUE using the MQSC commands.

Follow these steps:

1. To define SYSTEM.ADMIN.ACTIVITY.QUEUE (if not already defined), enter the following command:

define QLOCAL(SYSTEM.ADMIN.ACTIVITY.QUEUE) USAGE (normal) DESCR('For Introscope

Use')

2. To configure the SYSTEM.ADMIN.ACTIVITY.QUEUE, enter the following command:

alter QLOCAL (SYSTEM.ADMIN.ACTIVITY.QUEUE) PUT (enabled) GET (enabled) DEFPSIST

(no) SHARE DEFSOPT (SHARED) MAXDEPTH (999999999)

3. To verify the SYSTEM.ADMIN.ACTIVITY.QUEUE, enter the following command:

display QLOCAL(SYSTEM.ADMIN.ACTIVITY.QUEUE)

The SYSTEM.ADMIN.ACTIVITY.QUEUE has been configured.



Set the Handshake Queue

Handshake refers to the communication between the MQMonitor agents and MQ Java Connector agents. You can perform the handshake by creating a queue (handshake queue) on an existing Queue Manager. You can also perform the handshake on a new Queue Manager that is accessible from all application servers and MQMonitor agents.

To define a local queue, for example, CA_WILY_HANDSHAKE, enter the MQSC command:

define QLOCAL(CA_WILY_HANDSHAKE) USAGE(NORMAL) PUT(ENABLED) GET(ENABLED)

DEFPSIST(NO) SHARE DEFSOPT (SHARED) DESCR('For Introscope Use')

The MQSC command defines the CA_WILY_HANDSHAKE queue with the put and get properties enabled, not persistent, and shareable.

To verify the queue, enter the command:

display QLOCAL(CA_WILY_HANDSHAKE)

Set the MCA User ID

MCA User ID indicates to the server who the client is connecting as (at program runtime). The clients connect to the server using sockets, which are listening for connections. When the connection is established, the server validates the authentication of the clients. If you do not specify the MCA User ID at connect time, the server uses the client user ID.

By defining the MCA User ID in the channel definition you can override the privileges of the client user ID.

To ensure that the trace data does not reach the Dead Letter Queue, and for the transaction trace to occur, set the MCA user ID. The following procedure describes how to set the MCA user ID.

Note: The procedure is applicable for WebSphere MQ infrastructure that consists of Queue Managers of various WebSphere MQ platforms. The MQ traces for Queue Managers can be of different types.



The Java application may use WebSphere MQ, JMS, or MQ Java Connectors to interact with the WebSphere MQ infrastructure. Depending on the setting of the Java application, use one of the following procedures to set the MCA user ID:

If the Java application sets the user ID of the WebSphere MQ message, then perform the following steps to add a user:

1. Identify the user that set by the Java application on the MQMessage.

2. Create the user on all WebSphere MQ machines.

3. Add the user to the group created by the WebSphere MQ installation on all platforms.

4. Restart the channels.

If the Java application does not set the user ID of the WebSphere MQ Message, then perform the following steps to add a common user:

1. Create a common user for all WebSphere MQ machines.

2. Add the common user to the group created by the WebSphere MQ installation on all platforms.

3. Set the common user in the Server-connection channels attribute MCA user ID using the WebSphere MQ Explorer on all Server-connection channels on all Queue Managers. The corresponding MQSC command is:

alter channel () CHLTYPE (SVRCONN) MCAUSER()

4. Restart the channels.



Configure handshake for Cross Process Transaction Tracing

Configure the handshake feature for Cross Process Transaction Tracing. Handshake requires a common Queue Manager that is used for communication between the MQ Java agent and MQMonitor agent.

1. Configure the following properties in the MQAgent.properties file:

mq.crossprocesstracing.enabled = true

mqmonitor.mqagent.id.list =

handshake.mqagent.id =

handshake.qm.host =

handshake.qm.port =

handshake.queue=

2. Configure the following handshake properties in the MQMonitor.properties file:

handshake.mqagent.id =

handshake.qm.host =

handshake.qm.port =

handshake.queue=

The properties have been configured for cross process transaction tracing.

For more information about the properties, see the respective properties files.

Note: The mqmonitor.mqagent.id.list and the handshake.mqagent.id in MQMonitor.properties file have the same ID. The values for handshake.qm.host, handshake.qm.port, and handshake.queue must be the same in all properties files because they refer to a common queue manager.

Important! Cross Process Transaction Tracing can also be configured without Handshake. In the MQMonitor.properties file, disable the handshake properties. Also, set the following properties in the MQAgent.properties file:

mq.crossprocesstracing.enabled property must be true

mqmonitor.mqagent.id.list property must be blank

Configure WebSphere MQ to Publish Events


Configure WebSphere MQ to Publish Events

You can configure WebSphere MQ to publish events that you can view in CA Introscope.

Follow these steps:

1. Edit the MQMonitor.properties file to identify the queues whose MQ Events you want to monitor.

2. You can configure the following events on the MQ Server:

For Queue Manager events, enable monitoring of Authority, Inhibit, Local, Remote, Start, and Stop.

For Channel Events, enable monitoring of Channel, SSL, and Channel auto-definition.

For Performance Events, enable monitoring of Performance.You can also enable queue depth events and service interval events in the Queue properties dialog.

Note: If more than one application is monitoring the MQ Event Queues, then MQMonitor agent throws an error. To avoid this error, go to the queue properties if default properties are used. The queues are SYSTEM.ADMIN.PERFM.EVENT, SYSTEM.ADMIN.QMGR.EVENT, and SYSTEM.ADMIN.CHANNEL.EVENT. Click the Extended tab, and set the Shareability property to Shareable and the Default Input Open Option property to Input shared.

3. Start the MQMonitor agent.

Note: You can also use MQSC commands to enable monitoring of the MQ events. For more information, see the IBM WebSphere MQ documentation.

To view MQ Events in the Investigator, select *SuperDomain*,, WebSphere MQ and Message Broker, WebSphere MQ and Message Broker Agent (*SuperDomain*) node. The MQ Events display in the Whats Interesting column.

Chapter 5: Additional Information 45

Chapter 5: Additional Information

You can perform additional tasks such as configuring SSL, upgrading CA APM for IBM WebSphere MQ, and creating JMS queues.


Turn On Queue Monitoring (see page 45) Configure Application Server When Java 2 Security is Enabled (see page 45) Share the wily Folder Across MQ Java Connector agents (see page 46) Configure JCA Conn

apm_9.5--apm for ibm websphere mq guide

Documents

ca software

ca database performance

ca copyright notices

proprietary information

applicable license agreement

software products

available copies

internal use