+ All Categories
Home > Documents > OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀...

OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀...

Date post: 29-Mar-2021
Category:
Upload: others
View: 1 times
Download: 0 times
Share this document with a friend
212
User’s Guide OMEGAMON® XE for WebSphere Integration Brokers Version 120 GC32-9326-00 January 2004 Candle Corporation 100 North Sepulveda Blvd. El Segundo, California 90245
Transcript
Page 1: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

User’s GuideOMEGAMON® XE for

WebSphere Integration Brokers

Version 120

GC32-9326-00

January 2004

Candle Corporation100 North Sepulveda Blvd.

El Segundo, California 90245

Page 2: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

2 OMEGAMON XE for WebSphere Business Integration User’s Guide, Version 120

Registered trademarks and service marks of Candle Corporation: AF/OPERATOR, AF/REMOTE, Availability Command Center, Candle, Candle CIRCUIT, Candle Command Center, Candle Direct logo, Candle Electronic Customer Support, Candle logo, Candle Management Server, Candle Management Workstation, CandleLight, CandleNet, CandleNet Command Center, CandleNet eBusiness Platform, CandleNet Portal, CL/CONFERENCE, CL/SUPERSESSION, CommandWatch, CT, CT/Data Server, CT/DS, DELTAMON, DEXAN, eBA, eBA*ServiceMonitor, eBA*ServiceNetwork, eBusiness at the speed of light, eBusiness Assurance, eBusiness Institute, ELX, EPILOG, ESRA, ETEWatch, IntelliWatch, IntelliWatch Pinnacle, MQSecure, MQView, OMEGACENTER, OMEGAMON, OMEGAMON II, OMEGAMON Monitoring Agent, OMEGAMON Monitoring Agents, OMEGAVIEW, OMEGAVIEW II, PQEdit, Response Time Network, Roma, SitePulse, Solutions for Networked Applications, Solutions for Networked Businesses, TMA2000, Transplex, and Volcano.Trademarks and service marks of Candle Corporation: AF/Advanced Notification, AF/PERFORMER, Alert Adapter, Alert Adapter Plus, Alert Emitter, AMS, Amsys, AutoBridge, AUTOMATED FACILITIES, Availability Management Systems, Business Services Composer, Candle Alert, Candle Business Partner Logo, Candle Command Center/SentinelManager, Candle CommandPro, Candle eDelivery, Candle eSupport, Candle Insight, Candle InterFlow, Candle Managing what matters most, Candle Service Suite, Candle Technologies, CandleNet, CandleNet 2000, CandleNet Conversion, CandleNet eBP, CandleNet eBP Access for S.W.I.F.T., CandleNet eBP Administrator, CandleNet eBP Broker Access for Mercator or MQSI, CandleNet eBP Configuration, CandleNet eBP Connector, CandleNet eBP File Transfer, CandleNet eBP Host Connect, CandleNet eBP Object Access, CandleNet eBP Object Browser, CandleNet eBP Secure Access, CandleNet eBP Service Directory, CandleNet eBP Universal Connector, CandleNet eBP Workflow Access, CandleNet eBusiness Assurance, CandleNet eBusiness Exchange, CandleNet eBusiness Platform Administrator, CandleNet eBusiness Platform Connector, CandleNet eBusiness Platform Connectors, CandleNet eBusiness Platform Powered by Roma Technology, CandleNet eBusiness Platform Service Directory, Candle Vision, CCC, CCP, CCR2, CEBA, CECS, CICAT, CL/ENGINE, CL/GATEWAY, CL/TECHNOLOGY, CMS, CMW, Command & Control, Connect-Notes, Connect-Two, CSA ANALYZER, CT/ALS, CT/Application Logic Services, CT/DCS, CT/Distributed Computing Services, CT/Engine, CT/Implementation Services, CT/IX, CT/Workbench, CT/Workstation Server, CT/WS, !DB Logo, !DB/DASD, !DB/EXPLAIN, !DB/MIGRATOR, !DB/QUICKCHANGE, !DB/QUICKCOMPARE, !DB/SMU, !DB/Tools, !DB/WORKBENCH, Design Network, e2e, eBA*SE, eBAA, eBAAuditor, eBAN, eBANetwork, eBAAPractice, eBP, eBusiness Assurance Network, eBusiness at the speed of light, eBusiness at the speed of light logo, eBusiness Exchange, eBX, End-to-End, eNotification, ENTERPRISE, Enterprise Candle Command Center, Enterprise Candle Management Workstation, Enterprise Reporter Plus, ER+, ERPNet, ETEWatch Customizer, HostBridge, InterFlow, Candle InterFlow, Lava Console, Managing what matters most, MessageMate, Messaging Mastered, Millennium Management Blueprint, MMNA, MQADMIN, MQEdit, MQEXPERT, MQMON, NBX, NC4, NetGlue, NetGlue Extra, NetMirror, NetScheduler, New Times, New Team, New Readiness, OMA, OMC Gateway, OMC Status Manager, OMEGACENTER Bridge, OMEGACENTER Gateway, OMEGACENTER Status Manager, OMEGAMON/e, OMEGAMON Management Center, OSM, PathWAI, PC COMPANION, Performance Pac, Powered by Roma Technology, PowerQ, PQConfiguration, PQScope, Roma Application Manager, Roma Broker, Roma BSP, Roma Connector, Roma Developer, Roma FS/A, Roma FS/Access, RomaNet, Roma Network, Roma Object Access, Roma Secure, Roma WF/Access, Roma Workflow Access, RTA, RTN, SentinelManager, Somerset, Somerset Systems, Status Monitor, The Millennium Alliance, The Millennium Alliance logo, The Millennium Management Network Alliance, Tracer, Unified Directory Services, WayPoint, and ZCopy.Trademarks and registered trademarks of other companies: AIX, DB2, MQSeries and WebSphere are registered trademarks of International Business Machines Corporation. Citrix, WinFrame, and ICA are registered trademarks of Citrix Systems, Inc. Multi-Win and MetaFrame are trademarks of Citrix Systems, Inc. SAP is a registered trademark and R/3 is a trademark of SAP AG. UNIX is a registered trademark in the U.S. and other countries, licensed exclusively through X/Open Company Ltd. HP-UX is a trademark of Hewlett-Packard Company. SunOS is a trademark of Sun Microsystems, Inc. All other company and product names used herein may be trademarks or registered trademarks of their respective owners.

Copyright © January 2004, Candle Corporation, a California corporation. All rights reserved. International rights secured.

Threaded Environment for AS/400, Patent No. 5,504,898; Data Server with Data Probes Employing Predicate Tests in Rule Statements (Event Driven Sampling), Patent No. 5,615,359; MVS/ESA Message Transport System Using the XCF Coupling Facility, Patent No. 5,754,856; Intelligent Remote Agent for Computer Performance Monitoring, Patent No. 5,781,703; Data Server with Event Driven Sampling, Patent No. 5,809,238; Threaded Environment for Computer Systems Without Native Threading Support, Patent No. 5,835,763; Object Procedure Messaging Facility, Patent No. 5,848,234; End-to-End Response Time Measurement for Computer Programs, Patent No. 5,991,705; Communications on a Network, Patent Pending; Improved Message Queuing Based Network Computing Architecture, Patent Pending; User Interface for System Management Applications, Patent Pending.

NOTICE: This documentation is provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to restrictions set forth in the applicable license agreement and/or the applicable government rights clause.This documentation contains confidential, proprietary information of Candle Corporation that is licensed for your internal use only. Any unauthorized use, duplication, or disclosure is unlawful.

Page 3: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Contents 3

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Adobe Portable Document Format . . . . . . . . . . . . . . . . . . . . . . . . . . 11Candle Customer Service and Satisfaction . . . . . . . . . . . . . . . . . . . . 13

What’s New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 1. Introducing OMEGAMON XE for WebSphere Integration Brokers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21What is OMEGAMON XE for WebSphere Integration Brokers? . . . . . 22Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Using the CandleNet Portal Interface . . . . . . . . . . . . . . . . . . . . . . . . . 29

Chapter 2. Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35About the Parameter File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Setting Agent Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Agent Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Agent Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter 3. Configuring the CandleMonitor Node. . . . . . . . . . . . . . . . . . . . 57About the CandleMonitor Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Integrating the CandleMonitor Node into Broker Environments . . . . 60Making the CandleMonitor Node Available to Message Flows . . . . . . 65CandleMonitor Node Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Positioning the CandleMonitor node . . . . . . . . . . . . . . . . . . . . . . . . . 72Configuring CandleMonitor Node . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Chapter 4. Usage Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Monitoring Application Put and Get Message Performance . . . . . . . . 85Determining Application Delivery Failure of Messages . . . . . . . . . . . . 87

Contents

Page 4: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

4 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Debugging a Message Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Determining When a Message Flow Has Failed . . . . . . . . . . . . . . . . . 90Verifying the Broker/Control Center Configuration . . . . . . . . . . . . . . 91Collecting Requested System Trace Data for a Broker on an Unavailable System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Stopping a Message Flow with a Full Output Queue . . . . . . . . . . . . . 93Automatically Starting a Broker That Is Stopped . . . . . . . . . . . . . . . . 94Performing Broker Capacity Planning . . . . . . . . . . . . . . . . . . . . . . . . 95Ensuring Adequate Message Flow Response Time. . . . . . . . . . . . . . . 97Preventing Inadvertent Use of Trace Active . . . . . . . . . . . . . . . . . . . . 98Starting and Stopping Message Flows at Periodic Intervals . . . . . . . . 99User Not Receiving All Publications to Subscriptions . . . . . . . . . . . . 101User’s Subscription to Topic Fails Security . . . . . . . . . . . . . . . . . . . . 102

Chapter 5. Situations and Take Action Commands. . . . . . . . . . . . . . . . . . 103Predefined Situations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Take Action Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Chapter 6. Workspaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119About Workspaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121ACL Entries Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Agent Status Workspace (Agent-Level Summary) . . . . . . . . . . . . . . 131Archive Message Flow Accounting. . . . . . . . . . . . . . . . . . . . . . . . . . 132Archive Node Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Archive Terminal Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Archive Thread Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Broker Events Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Broker Information Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Broker Statistics Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Broker Status Workspace (broker-level summary) . . . . . . . . . . . . . . 147Broker Summary Workspace (multiple brokers monitored) . . . . . . . 148CandleMonitor Node Statistics Workspace . . . . . . . . . . . . . . . . . . . 149Components Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Execution Group Information Workspace . . . . . . . . . . . . . . . . . . . . 153Execution Group Statistics Workspace. . . . . . . . . . . . . . . . . . . . . . . 154Message Flow Events Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Page 5: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Contents 5

Message Flow Information Workspace. . . . . . . . . . . . . . . . . . . . . . . 158Message Flow Statistics Workspace . . . . . . . . . . . . . . . . . . . . . . . . . 160Message Processing Node Attributes Workspace . . . . . . . . . . . . . . . 162Message Processing Node Information Workspace . . . . . . . . . . . . . 164Message Processing Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Neighbors Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Product Events Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Retained Publications Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . 170Snapshot Message Flow Accounting . . . . . . . . . . . . . . . . . . . . . . . . 171Snapshot Node Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Snapshot Terminal Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Snapshot Thread Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Sub-Flow Statistics Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Subscriptions Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Appendixes

Appendix A. Problem Determination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185CandleMonitor Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Appendix B. Product Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Page 6: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

6 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Page 7: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Figures 7

Figure 1. OMEGAMON XE Agent–Server–Client Architecture . . . . . . . . . . . . . 24Figure 2. CandleNet Portal Application Window . . . . . . . . . . . . . . . . . . . . . . . 30Figure 3. Default kqi.xml File on Windows and UNIX . . . . . . . . . . . . . . . . . . . 38Figure 4. Default KQIXML File on OS/390 and z/OS . . . . . . . . . . . . . . . . . . . . 39Figure 5. Example of a Monitored Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Figure 6. Type I Sub-Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Figure 7. Type II Sub-Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Figures

Page 8: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

8 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Page 9: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Preface 9

Preface

OMEGAMON® XE for WebSphere Integration Brokers is a set of tools that can help you develop, test, manage, and troubleshoot message flows.

This guide describes the features and capabilities of OMEGAMON XE for WebSphere Integration Brokers and provides scenarios that illustrate how it can be used to monitor and manage message flows in development and production environments.

P

Page 10: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About This Book

10 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

About This Book

Who should read this bookThis book is intended for system administrators and message flow developers using WebSphere MQ Integrator and IBM WebSphere® Business Integration broker products, and for developers of WebSphere MQ applications and application integrators who wish to test and monitor response times of application flows. It contains detailed instructions for configuring and using OMEGAMON XE for WebSphere Integration Brokers to help verify and analyze your message broker topologies, and conceptual information that helps you understand the product.

Where to look for more informationFor more information related to this product and other related products, please see the

� technical documentation CD-ROM that came with your product

� technical documentation information available on the Candle Web site at www.candle.com

� online help provided with this and the other related products.

Ordering additional documentationTo order additional product manuals, contact your Candle Customer Support representative.

We would like to hear from youCandle welcomes your comments and suggestions for changes or additions to the documentation set. A user comment form, located at the back of each manual, provides simple instructions for communicating with the Candle Information Development department. You can also send email to [email protected]. Please include "OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120" in the subject line.

Page 11: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Preface 11

Adobe Portable Document Format

Adobe Portable Document Format

Printing this bookCandle supplies documentation in the Adobe Portable Document Format (PDF). The Adobe Acrobat Reader will print PDF documents with the fonts, formatting, and graphics in the original document. To print a Candle document, do the following:

1. Specify the print options for your system. From the Acrobat Reader Menu bar, select File > Page Setup… and make your selections. A setting of 300 dpi is highly recommended as is duplex printing if your printer supports this option.

2. To start printing, select File > Print... on the Acrobat Reader Menu bar.

3. On the Print pop-up, select one of the Print Range options for� All� Current page� Pages from: [ ] to: [ ]

4. (Optional). Select the Shrink to Fit option if you need to fit oversize pages to the paper size currently loaded on your printer.

Printing problems?The print quality of your output is ultimately determined by your printer. Sometimes printing problems can occur. If you experience printing problems, potential areas to check are:� settings for your printer and printer driver. (The dpi settings for both your

driver and printer should be the same. A setting of 300 dpi is recommended.)

� the printer driver you are using. (You may need a different printer driver or the Universal Printer driver from Adobe. This free printer driver is available at www.adobe.com.)

� the halftone/graphics color adjustment for printing color on black and white printers (check the printer properties under Start > Settings > Printer). For more information, see the online help for the Acrobat Reader.

� the amount of available memory in your printer. (Insufficient memory can cause a document or graphics to fail to print.)

For additional information on printing problems, refer to the documentation for your printer or contact your printer manufacturer.

Page 12: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Adobe Portable Document Format

12 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Contacting AdobeIf additional information is needed about Adobe Acrobat Reader or printing problems, see the Readme.pdf file that ships with Adobe Acrobat Reader or contact Adobe at www.adobe.com.

Adding annotations to PDF filesIf you have purchased the Adobe Acrobat application, you can add annotations to Candle documentation in .PDF format. See the Adobe product for instructions on using the Acrobat annotations tool and its features.

Page 13: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Preface 13

Candle Customer Service and Satisfaction

Candle Customer Service and Satisfaction

BackgroundTo assist you in making effective use of our products, Candle offers a variety of easy-to-use online support resources. The Candle Web site provides direct links to a variety of support tools that include these services:

eSupport allows you to create and update service requests opened with Customer Service and Satisfaction (CSS).

eDelivery allows you to download products, documentation, and maintenance 24 hours a day, 7 days a week.

eNotification notifies you of product updates and new releases.

In addition, you can find information about training, maintenance plans, consulting and services, and other useful support resources. Refer to the Candle Web site at www.candle.com for detailed customer service information.

Candle Customer Service and Satisfaction contactsYou will find the most current information about how to contact Candle CSS by telephone or email on the Candle Web site. Go to the www.candle.com support section, and choose the link to Support Contacts to locate your regional support center.

Page 14: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Candle Customer Service and Satisfaction

14 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Page 15: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

What’s New 15

What’s New

Version 120 includes a product name change, support for the latest versions of IBM’s broker products as well as expanded support for earlier versions, and several functional enhancements that make OMEGAMON XE for WebSphere Integration Brokers an even more valuable tool for developing, testing, and troubleshooting message flows.

This product has a new nameThis product (formerly OMEGAMON® XE for WebSphere MQ Integrator) has been renamed to OMEGAMON® XE for WebSphere Integration Brokers. This change reflects the renaming of the monitored IBM products in their latest release. You will see the new name in the product help and documentation.

Support for IBM’s most recent releasesWith version 120, OMEGAMON XE for WebSphere Integration Brokers now supports all of the following IBM broker products:

– WebSphere® MQ Integrator v2.1– WebSphere® MQ Integrator Broker v2.1– WebSphere® MQ Event Broker v2.1– IBM® WebSphere® Business Integration Event Broker v5– IBM® WebSphere® Business Integration Message Broker v5– IBM® WebSphere® Business Integration Message Broker with Rules

and Formatter Extension v5

W

Page 16: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

16 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

New workspaces and attributes have been added to display the message flow accounting and statistical data provided by the WebSphere Business Integration V5 products. This data provides some of the same data as the CandleMonitor node, but can be viewed without deploying the CandleMonitor node. Monitoring without CandleMonitor nodes, however, does not provide the Message Flow events produced by configured CandleMonitor nodes, which can be used for situations and reflex automation.

New Take Action commands enable you to turn off and on archive and snapshot data collection by brokers, and a new set of attributes allow you to create customized views and queries and define monitoring situations for accounting data.

CandleNet Portal’s historical logging of archive data means you do not have to purchase or write a utility to save archive data.

Note: The new Message Flow Accounting feature does not apply to V2.1 brokers.

Support for HP-UX and LinuxOMEGAMON XE for WebSphere Integration Brokers now supports monitoring agents on both HP-UX and Linux.

Statistical data for sub-flowsOMEGAMON XE for WebSphere Integration Brokers now lets you monitor embedded and nested flows or any section of a message flow you designate as a sub-flow for purposes of monitoring.

A new workspace for viewing reported data, a new set of attributes for situation monitoring and customized reporting, and new “type” attribute settings for the CandleMonitor node have been added to support sub-flow monitoring.

User statistics Controlled by three Take Action commands, a new “user statistics” feature allows on-demand sampling of statistics associated with a particular CandleNet Portal log-on ID. This feature allows you complete control over the period of time (sample interval) represented by the “current” statistics in

Page 17: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

What’s New 17

statistics workspaces, which lets you get rapid feedback on performance as you develop message flows.

Note: If you are upgrading from a previous installation and you have modified the statistics workspaces, you must revert to the original Candle-provided workspaces to see the links to user statistics workspaces. Refer to “Upgrading workspaces” on page 125 for instructions.

CandleMonitor node deactivationThis feature enables you to activate or deactivate some or all of the CandleMonitor nodes in a message flow. This means that you can move from development to production without having to remove CandleMonitor nodes. You can turn off nodes entirely, activate them only for message flow events, activate only nodes that provide overall statistics (input and output nodes), or activate only nodes that provide message flow events and overall statistics.

Tmp directory alternative option (UNIX and z/OS)OMEGAMON XE for WebSphere Integration Brokers now lets you specify an alternative directory to use for storing CandleMonitor data picked up by the monitoring agent. This lets you avoid the problems that can occur when the /tmp directory, used by default, fills quickly because of multiple uses.

New workspaces� Sub-Flow Statistics workspace

This workspace provides statistics for any defined sub-flows. If selected from the CandleNet Portal Navigator pane, all sub-flows for a given broker are shown with respect to the execution group and message flow in which they reside. If linked to from the Message Flow Statistics workspace for a particular message flow, just the sub-flows associated with that message flow are shown. A short-term history workspace has also been provided for sub-flow data collected historically.

A link is available to the CandleMonitor Node Statistics workspace so that the associated nodes and base statistical data can be viewed for each node that is part of the sub-flow.

Page 18: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

18 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Sub-Flow Name columns have been added to the CandleMonitor Node Statistics workspace and attribute group to enable linking between the workspaces.

� Accounting workspaces

24 new workspaces have been added to allow you to monitor the accounting data collected by WebSphere Business Integration brokers. Separate workspaces present “archive” and “snapshot” data for message flow accounting, node accounting, thread accounting, and terminal accounting statistics. Each type of data is available for current interval, recent intervals, and historical intervals.

� Sample Date/Time and Current Statistic Interval columns

All Statistics workspaces now include Sample Date and Time and Current Statistic Interval columns which give the date and time of the sample for the statistic data display and the interval time in seconds for the statistics labeled “Current …” in the row.

New attributesThe following new attribute groups allow you to create customized views and queries for the new workspaces and to define monitoring situations for sub-flow and accounting data:

� Sub-Flow Statistics

� Message Flow Accounting

� Node Accounting

� Thread Accounting

� Terminal Accounting

New Take Action commands� QI Create User Statistics

This command creates user statistics associated with the CandleNet Portal logon ID that issues the command. When the command is issued, you specify the amount of time in minutes that the statistics created by this command are held by the agent without being sampled or queried for display. If no time is specified, the data is stored until the Destroy User Statistics command is issued.

Page 19: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

What’s New 19

� QI Sample User Statistics

This command causes the agent to take a sample of CandleMonitor statistics for the CandleNet Portal logon ID that issues it. A “QI Create User Statistics” command must have previously been issued for the logon ID for this command to be valid. This command allows you complete control over the period of time (sample interval) represented by the “current” statistics in statistics workspaces.

� QI Destroy User Statistics

This command cleans up all user statistics data associated with the CandleNet Portal logon ID that issues the command and ensures that the agent no longer holds this storage.

� QI Reset Statistics

This command gives you the ability to start over at zero, which is especially useful for the “overall” statistics when they are being used to do controlled timings, for example of particular sub-flows. It resets the statistics collected by the CandleMonitor node to zeroes. It resets all statistics for all nodes in the broker. Without this command, the statistics are reset automatically during a deployment of the broker or when overflow is detected.

� QI Change Flow Stats

This command issues the mqsichangeflowstats command to activate or inactivate the broker’s Message Flow Accounting and Statistics feature from CandleNet Portal.

� QI Change Broker

This command enables you to change the archive interval for the broker from CandleNet Portal. Several other broker properties may also be modified using this command.

New agent configuration parametersThe following parameters allow you to control how much data is stored for use in CandleNet Portal workspaces for Archive and Snapshot samples:

– defaultHistoricalAccountingType– defaultRetainRecentSnapshotSamples– defaultRetainRecent ArchiveSamples– holdForQueryTime

Page 20: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

20 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

The following parameters allow you to control how much data is stored for a given broker:

– historicalAccounting type– retainRecentSnapshotSamples– retainRecentArchiveSamples

New CandleMonitor node attributes� activateNode—Controls activation/deactivation of the node.

� subFlowName—Provides an identifying name for the sub-flow.

� Two values have been added to the type attribute to identify CandleMonitor nodes associated with sub-flows:

– subFlowInput—Identifies the node as being a sub-flow input node

– subFlowOutput—Identifies the node as being a sub-flow output node

Print to Disk featureA CandleNet Portal “Print to disk…” command is available for statistics workspaces. When selected, this command brings up a file dialog in which you can specify the file to which the data is to be written. The command places the column values in the rows in the current report as comma separated lists in the output file in the same order as displayed in the report. The output file can then be used externally, for example to populate a spreadsheet.

Note: The “Print to disk” command is functional in the CandleNet Portal Desktop client only.

If you are upgrading from a previous installation and you have modified the statistics workspaces, you must revert to the original Candle-provided workspaces to see the “Print to disk” feature. Refer to “Upgrading workspaces” on page 125 for instructions.

Page 21: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Introducing OMEGAMON XE for WebSphere Integration Brokers 21

Introducing OMEGAMON XE forWebSphere Integration Brokers

IntroductionThis chapter provides an overview of OMEGAMON XE for WebSphere Integration Brokers. It explains what OMEGAMON XE for WebSphere Integration Brokers is and how it can help you monitor and manage message brokers and message flows. It also provides a high-level introduction to the CandleNet Portal graphical user interface.

Chapter contentsWhat is OMEGAMON XE for WebSphere Integration Brokers? . . . . . . . . 22Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Using the CandleNet Portal Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1

Page 22: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

What is OMEGAMON XE for WebSphere Integration Brokers?

22 OMEGAMON XE for WebSphere Integration Brokers, Version 120

What is OMEGAMON XE for WebSphere Integration Brokers?

OverviewOMEGAMON XE for WebSphere Integration Brokers is a monitoring and management tool that provides you with the means to verify, analyze, and tune message broker topologies associated with:

– WebSphere® MQ Integrator v2.1– WebSphere® MQ Integrator Broker v2.1– WebSphere® MQ Event Broker v2.1– IBM® WebSphere® Business Integration Event Broker V5– IBM® WebSphere® Business Integration Message Broker V5– IBM® WebSphere® Business Integration Message Broker with Rules and

Formatter Extension V5

Note: In this manual, these IBM products are referred to jointly as WebSphere Business Integration brokers or IBM broker products. V2.1 and V5 are used to distinguish the two suites of products as necessary.

What does OMEGAMON XE for WebSphere Integration Brokers do?OMEGAMON XE for WebSphere Integration Brokers helps ensure the reliability and performance of your broker environment by detecting and correcting broker and message flow problems before they have an impact upon availability and service levels. OMEGAMON XE for WebSphere Integration Brokers also reduces the amount of time involved in the deployment of broker applications by helping you debug message flows and providing statistics you can use to tune your environment.

Using OMEGAMON XE for WebSphere Integration Brokers you can:

� Monitor the status of your IBM broker product and its components.

� View information and performance statistics for broker topologies at broker, execution group, message flow, node, terminal, and thread level in tabular and chart views.

Page 23: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Introducing OMEGAMON XE for WebSphere Integration Brokers 23

What is OMEGAMON XE for WebSphere Integration Brokers?

� Issue WebSphere Business Integration brokers commands from the OMEGAMON XE for WebSphere Integration Brokers interface to directly manage your environment, or use the commands to create automatic responses to events.

� Receive alerts when performance thresholds are exceeded or when message flow events occur.

� Retain data samples in history files and roll them off to an historical database for reporting and analysis.

How does OMEGAMON XE for WebSphere Integration Brokers work?OMEGAMON XE for WebSphere Integration Brokers is one of a family of products which share a common agent–client–server architecture (see Figure 1 on page 24). Intelligent remote agents (IRAs) on monitored, or managed, systems collect system or application data at set intervals or on request from the server. In the case of OMEGAMON XE for WebSphere Integration Brokers, IRAs monitor WebSphere Business Integration brokers and their message flows. IRAs can also test the current values of monitored properties against thresholds and trigger alerts, and accept and execute requested actions relayed by the server.

The CandleNet Management Server (CMS) gathers data from the IRAs and acts as a collection and control point for alerts received from the agents. It accepts requests for information or action from clients and distributes them to the agents. The CMS sends the data to a Java-based client called CandleNet Portal, where it is displayed in tabular or graphic form in a set of predefined or custom workspaces. Depending on how it was installed, CandleNet Portal can be used as a desktop or browser-based application. CandleNet Portal has its own server that performs common CandleNet Portal functions and serves to lighten the CandleNet Portal client.

In addition, OMEGAMON XE for WebSphere Integration Brokers provides a CandleMonitor node. Inserted into message flows, the CandleMonitor node collects statistics on message flow and sub-flow performance. It also provides a mechanism for generating user-defined events within a message flow.

Page 24: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

What is OMEGAMON XE for WebSphere Integration Brokers?

24 OMEGAMON XE for WebSphere Integration Brokers, Version 120

Figure 1. OMEGAMON XE Agent–Server–Client Architecture

What is OMEGAMON DE?The OMEGAMON DE feature package for CandleNet Portal offers a dashboard view of your enterprise. This feature provides a single point of control from which you can manage the resources your business-critical applications rely on, including a range of operating systems, servers, databases, mainframes, and Web components, as well as the applications themselves. It enables you to pull together the data from multiple Candle monitoring solutions, including OMEGAMON XE for WebSphere Integration Brokers—and even from third party monitors, if you are using an alert manager.

OMEGAMON DE extends the capabilities of OMEGAMON XE to include:

� Viewing data from different types of monitoring agents in one workspace

In a single workspace, you can build a table or chart with data from one type of monitoring agent, and another table or chart with data from a different agent. Within that workspace, you can show views from as many different agent types as are included on that branch of the Navigator.

Managed Systems Agents

CandleNet Portal Server

CandleNet Portal Clients

CandleNet Management Server

Page 25: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Introducing OMEGAMON XE for WebSphere Integration Brokers 25

What is OMEGAMON XE for WebSphere Integration Brokers?

� Linking application workspaces

You can define a link from a workspace associated with one type of monitoring agent to a workspace associated with another type of agent.

� Enterprise-specific Navigator views

The Navigator physical view shows the hierarchy of your managed enterprise by operating platform and type of Candle agent. The Navigator business view shows the hierarchy of any managed objects defined through the CMW. You can also define Navigator views for any logical grouping, such as a departmental or site hierarchy.

Detailed information on using OMEGAMON DE features is provided in the CandleNet Portal online Help.

Packages which include this productThis product is included in the following product packages:

� PathWAI™ Tuning Workbench for WebSphere Business Integration

� PathWAI™ Dashboard for WebSphere Business Integration

� PathWAI™ Monitor for WebSphere MQ

� PathWAI™ Dashboard for WebSphere MQ

Where to find more informationInformation about using OMEGAMON XE for WebSphere Integration Brokers and CandleNet Portal is available through online helps provided with the product.

This guide provides information specific to OMEGAMON XE for WebSphere Integration Brokers. In several cases, instructions for user actions are specific to the user interface, and thus reside in the CandleNet Portal online Help or Administering OMEGAMON Products: CandleNet Portal guide. You will be referred to the applicable documentation whenever appropriate.

Page 26: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Features

26 OMEGAMON XE for WebSphere Integration Brokers, Version 120

Features

Predefined workspaces and viewsWorkspaces are the heart of OMEGAMON XE for WebSphere Integration Brokers. They provide you with status, definition, and statistical information in a tabular and graphical views.

The predefined OMEGAMON XE for WebSphere Integration Brokers workspaces provide:

� status of brokers, components, and agents

� information about brokers, execution groups, message flows, message processing nodes

� information about product, broker, and message flow events

� information about publish/subscribe configuration

� performance statistics by broker, execution group, message flow and subflow

� accounting statistics by message flow, thread, node, and terminal

You can use the information provided by these workspaces to trace the causes leading up to alerts or peformance problems. You can customize these workspaces and the views they contain, or create your own workspaces and views.

For information about individual OMEGAMON XE for WebSphere Integration Brokers predefined workspaces, see “Workspaces” on page 119. For information about creating and customizing views and workspaces, see the CandleNet Portal online Help or Using OMEGAMON Products: CandleNet Portal.

Predefined monitoring situationsSituations are descriptions of conditions to which you want to be alerted. When situations are distributed to monitored systems they can, for example, alert you to a broker that has not been started, or to a message flow event. Situations can also be used to automate responses to problems, such as restarting a component or stopping a message flow that is consuming too much CPU.

Page 27: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Introducing OMEGAMON XE for WebSphere Integration Brokers 27

Features

OMEGAMON XE for WebSphere Integration Brokers provides a set of predefined situations designed to enable you to monitor critical activity and to serve as templates for creating customized situations of your own.

For information on the OMEGAMON XE for WebSphere Integration Brokers predefined situations, see “Predefined Situations” on page 104. For information on creating and editing situations, see the CandleNet Portal online Help and Using OMEGAMON Products: CandleNet Portal.

AttributesAttributes are characteristics or properties of the objects monitored by OMEGAMON XE for Websphere Integration Brokers—for example, the status of brokers, execution groups, and message flows, or the average amount of time it takes a message flow to process a message. Attributes are used in the definition of the queries used to collect the information presented in workspace views and to specify the conditions, or situations, that trigger alerts and automated actions.

OMEGAMON XE for Websphere Integration Brokers monitors 22 groups of attributes. You can use these attributes to customize the predefined views or to create your own views and workspaces. You can use them to define situations that target specific threshholds, events, or performance problems you want to monitor.

For more information about these attributes, see the online Help for OMEGAMON XE for WebSphere Integration Brokers attributes.

Take Action commandsUsing CandleNet Portal, you can interact directly with your brokers and message flows through the Take Action feature. Take Action lets you enter your own commands, or choose from a list of predefined commands.

You can add a Take Action command to a monitoring situation to execute when the situation becomes true. If you have OMEGAMON DE, you can create automation policies using Take Action commands.

The Take Action commands provided with OMEGAMON XE for WebSphere Integration Brokers enable you to issue WebSphere Business Integration brokers commands from CandleNet Portal. For example, you can start or stop WebSphere Business Integration brokers and their queue managers, and start and stop message flows, or change their trace characteristics. You can even

Page 28: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Features

28 OMEGAMON XE for WebSphere Integration Brokers, Version 120

change the type of Accounting statistics collected or the interval at which they are collected.

For information on the commands provided with OMEGAMON XE for WebSphere Integration Brokers, see “Take Action Commands” on page 108.

Historical data collectionYou can use the facilities of CandleNet Portal’s historical data collection function to store and save the data being collected by OMEGAMON XE for WebSphere Integration Brokers. The historical data collection function permits you to specify

� the interval at which data is to be collected

� the interval at which data is to be warehoused (if you choose to do so)

� the location (either at the agent or at the CMS) at which the collected data is to be stored

Information about using the Historical Data Collection function can be found in the CandleNet Portal online help and in the Historical Data Collection Guide for OMEGAMON XE and CandleNet Command Center.

To ensure that data samplings are saved to populate your predefined historical workspaces, you must first configure and start historical data collection. This requirement does not apply to workspaces using attributes groups that are historical in nature and show all their entries without you having to start data collection. See the Historical Data Collection Guide for OMEGAMON XE and CandleNet Command Center for more information.

Page 29: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Introducing OMEGAMON XE for WebSphere Integration Brokers 29

Using the CandleNet Portal Interface

Using the CandleNet Portal Interface

Where to find the detailsThis section provides a high-level summary of CandleNet Portal’s operation. You can find detailed instructions for using CandleNet Portal in

� the CandleNet Portal online Help

� Using OMEGAMON Products: CandleNet Portal

� Administering OMEGAMON Products: CandleNet Portal

� Historical Data Collection Guide for OMEGAMON XE and CandleNet Command Center

Application window

The CandleNet Portal application window displays information about your enterprise. On the left is the Navigator, which shows the arrangement of your monitored network and any alerts associated with systems and applications on the network. On the right is a workspace. As you select each item in the Navigator, the workspace changes to show views for that item.

Page 30: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Using the CandleNet Portal Interface

30 OMEGAMON XE for WebSphere Integration Brokers, Version 120

Figure 2. CandleNet Portal Application Window

NavigatorThe Navigator physical view shows the hierarchy of your monitored enterprise, from the top level ( ENTERPRISE) down to individual groupings of information collected by Candle monitoring agents. Every item in the Navigator is associated with at least one workspace. When you click an item in the Navigator, its default workspace displays in the application window.

The Navigator provides a physical view of your monitored network, organized by operating system platform, system type, Candle monitoring agents, and the attribute groups from which the agents can collect information.

Sometimes a small colored icon overlays a Navigator icon. This is an alert, or event indicator, which appears when a situation becomes true. As you move

Page 31: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Introducing OMEGAMON XE for WebSphere Integration Brokers 31

Using the CandleNet Portal Interface

up the Navigator hierarchy, multiple events are consolidated to show only the indicator with the highest severity: critical, followed by warning, then informational.

WorkspacesCandleNet Portal displays information in workspaces. A workspace is the working area of the CandleNet Portal application window and is made up of one or more views. A view is a pane in the workspace, typically a chart or table showing data collected from a Candle monitoring agent, such as the process detail running on the UNIX operating system.

A workspace may be linked to other workspaces. A link may be context-sensitive, whereby you right-click a row in a table or a data series in a chart to link to more detailed information about one of the attributes in the row or data series.

As you select items in the Navigator, the workspace presents views pertinent to your selection. Every workspace has at least one view, and every workspace has a set of properties associated with it. You can customize the workspace by working in the Properties editor to change the style and content of each view. Another way to customize the workspace is to change the type of view or to add views to the workspace.

AttributesOMEGAMON XE for WebSphere Integration Brokers gathers data on the brokers and message flows on your network and stores the data as system elements called attributes. You can use these attributes to

� build situations to monitor the performance of the managed systems you are concerned with

� create queries and use the resulting data to build custom views

Related attributes are grouped into attribute groups, or attribute tables. A given table view contains information provided by a single attribute group.

To use attributes effectively, you must first understand their structure.

� An attribute group associates attributes that refer to some unique characteristic of the data being stored.

� An attribute item stores data for a single property of an attribute group.

Page 32: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Using the CandleNet Portal Interface

32 OMEGAMON XE for WebSphere Integration Brokers, Version 120

� The name of each attribute is composed of the attribute’s group name, then a period, then the name of the attribute item.

For example, in the attribute

Broker_Statistics.Current_Interval

Current_Interval is an attribute item that stores a value representing the the length of time in seconds of the latest collection interval that the displayed statistics labeled Current … reflect. The attribute Current_Interval is a member of the Broker_Statistics group.

SituationsYou use attributes to create situations that monitor the state of your brokers or message flows. A situation describes a condition you want to test. When you start a situation, CandleNet Portal compares the values you have assigned for the situation’s attributes with the values collected by OMEGAMON XE for WebSphere Integration Brokers and registers an event if the condition is met. You are alerted to events by indicator icons that appear in the Navigator.

You manage situations from CandleNet Portal using the Situation editor. Using the Situation editor, you can

� create, edit, or delete a situation

� create another situation identical to the first

� display a situation

� associate a situation with the current Navigator item

� start and stop a situation

� open the event workspace for a situation to investigate the condition that caused the event

For detailed information about situations and about using the Situation editor, see Using OMEGAMON Products: CandleNet Portal or the online Help provided with CandleNet Portal.

QueriesChart and table views use queries to specify which attribute values to request from a Candle monitoring agent. You can use the Query editor to create a

Page 33: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Introducing OMEGAMON XE for WebSphere Integration Brokers 33

Using the CandleNet Portal Interface

new query, modify an existing one, or apply filters and set styles to define the content and appearance of a view based on an existing query.

Take Action featureThe Take Action feature lets you issue a command to any system in your network where one or more Candle monitoring agents are installed. You can implement commands from a workspace, from a situation, in an ad hoc mode, or by recalling a saved command.

For detailed information about creating and using Take Action commands, see Using OMEGAMON Products: CandleNet Portal or the online Help provided with CandleNet Portal.

Investigating an Event When the conditions of a situation have been met, the situation evaluates to True, causing an event indicator to appear in the Navigator. You can investigate the cause of an event by opening its workspace.

The event workspace shows two table views, one with the values of the attributes when the situation evaluated True, and the other with the attributes’ current values.

The event workspace can also display a view with any expert advice written by the situation's author. The advice will display as Web text and any links you have defined will be active, or, if the expert advice consisted only of a link to a specific Web page of advice, that Web page is displayed. The Take Action view also displays in the event workspace so you can send a command to the application started on that system.

Here is an example Navigator with raised event indicators: red indicators for critical conditions and yellow indicators for warnings. If both a warning and a critical condition occur for the same workspace, the indicator always shows the highest level alert.

Page 34: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Using the CandleNet Portal Interface

34 OMEGAMON XE for WebSphere Integration Brokers, Version 120

When you see an alert icon overlaying a Navigator icon, open the Event workspace and drill down to investigate the cause of the alert.

Looking at this workspace, you can determine the situation that raised the event and the attributes whose values are contributing to the alert. You can also review available advice and take appropriate actions.

When you see an event indicator in the Navigator, you can create an acknowledgment. An acknowledgment notifies other users that you have taken ownership of the problem related to the event and are working on it. When you acknowledge an event, a blue checkmark appears next to the situation in the event flyover list and, if you opened the event workspace, over the situation item in the Navigator. If the situation is still true when the acknowledgment expires, the indicator changes accordingly. You can also cancel the acknowledgment before it has expired. This changes the indicator so that users can see that the acknowledgment has been removed even though the situation remains true.

For instructions on navigating through a monitoring agent’s workspaces, see Using OMEGAMON Products: CandleNet Portal. Subsequent chapters of this manual will provide you with information specific to the use of OMEGAMON XE for WebSphere Integration Brokers.

Page 35: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 35

Configuring OMEGAMON XE forWebSphere Integration Brokers

Monitoring Agents

IntroductionThis chapter describes how to set the configuration parameters for the monitoring agents and discusses some performance considerations that can affect how agents should be configured.

Note: Please see the appropriate Installation Guide for the platform on which you are running the agent for very important information about other agent configuration that is required before starting the agent. For example, there are specific authorization requirements for each platform.

Chapter contentsAbout the Parameter File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Setting Agent Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Agent Parameter Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Agent Performance Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

2

Page 36: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About the Parameter File

36 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

About the Parameter File

OverviewThe parameters that determine the operational and monitoring characteristics of an agent reside in a file in XML format that is created during the installation of OMEGAMON XE for WebSphere Integration Brokers. This file is downloaded along with the OMEGAMON XE for WebSphere Integration Brokers product.

At the end of the installation procedure, you are given an opportunity to view and edit the file that contains the parameter settings for the agent. You can also edit this file whenever you need to change an agent’s configuration parameters. If you choose, you can add optional configuration parameters to the file for your installation.

Names and locations of agent parameter files

On OS/390 and z/OS

The agent parameter file member name is KQIXML.

If you used the installation location defaults, the KQIXML member resides in the following partitioned dataset:

&rhilev.RKANDATV

On UNIX

The agent parameter file is named kqi.xml.

Note that if you specify broker and agentId parameters at agent startup, the name of the agent parameter file is customized. The agent parameter file name for an agent started with optional parameters is of the form:

<hostName>_qi_<brokerName>_##_<agentId>.xml

If you use the installation location defaults, the agent parameter file resides in:

$CANDLEHOME/config

Page 37: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 37

About the Parameter File

On Windows

The agent parameter file is named kqi.xml.

Note that if you use the Create Instance option of Manage Candle Services to replicate the agent, the name of the agent parameter file is customized. The agent parameter file name for a created instance is of the form:

kqi_<taskname>.xml

If you use the installation location defaults, the agent parameter file resides in:

C:\Candle\cma

The default agent parameter fileThe agent parameter file, as shipped with OMEGAMON XE for WebSphere Integration Brokers, contains a base set of parameters that employ the product defaults. However, the values of these parameters can be changed to suit the needs of your site and additional parameters can be set.

On UNIX and Windows

Your initial kqi.xml file resembles the file shown in Figure 3 on page 38:

Note that this default file represents the core parameters that will be used in reporting and monitoring for the agent on UNIX and Windows systems. As no individual brokers or queue managers are specified in the file, running with the parameters shown here results in all brokers being monitored by the agent.

Page 38: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About the Parameter File

38 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Figure 3. Default kqi.xml File on Windows and UNIX

On OS/390 and z/OS

Your initial KQIXML file resembles the file shown Figure 4 on page 39.

On OS/390 and z/OS systems, all brokers to be monitored must be specified in the parameter file using the MonitorBroker tag. Running with the parameters shown in Figure 3 results in broker MQP1BRK being monitored by the agent. To monitor additional brokers, add additional MonitorBroker tag specifications as necessary.

<KqiAgent version="120"

defaultRetainBrokerEvents="10"defaultRetainFlowEvents="10"retainProductEvents="10" discoveryInterval="300"defaultStatisticInterval="60" defaultFlowEventInterval="15"defaultHistoricalAccountingType="Archive" defaultRetainRecentSnapshotSamples="15"defaultRetainRecentArchiveSamples="5"holdTimeForQuery="180"defaultReplyQueueName="KQI.AGENT.REPLY.QUEUE" defaultReplyQueueModel="SYSTEM.BROKER.MODEL.QUEUE"defaultTakeActionAuthUsers="*"

</KqiAgent>

Page 39: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 39

About the Parameter File

Figure 4. Default KQIXML File on OS/390 and z/OS

Syntax of the agent parameter fileThe file contains the top-level tag, <KqiAgent></KqiAgent>. It may also contain one or more instances of two nested tags: <MonitorBroker></MonitorBroker> and <ConnectQueueManager></ConnectQueueManager>. Agent parameters are defined as attributes of these elements.

The parameters within the kqi.xml file (or KQIXML member) are in XML format. As such, XML syntax conventions must be adhered to as shown in the sample files and parameter descriptions. All attribute values must be enclosed in double quotes. However, the actual coding is not column-specific, so the spacing and line separation shown in this chapter are not critical.

<KqiAgent version=”120”

agentId=”A1”defaultRetainBrokerEvents=”10”defaultRetainFlowEvents=”10”retainProductEvents=”10” discoveryInterval=”300”defaultStatisticInterval=”60” defaultFlowEventInterval=”15”defaultHistoricalAccountingType="Archive" defaultRetainRecentSnapshotSamples="15"defaultRetainRecentArchiveSamples="5"holdTimeForQuery="180"defaultReplyQueueName=”KQI.AGENT.REPLY.QUEUE” defaultReplyQueueModel=”SYSTEM.BROKER.MODEL.QUEUE” defaultTakeActionAuthUsers=”*”>

<MonitorBroker name=”MQP1BRK”componentDirectory=”/var/wmqi/MQP1BRK”>

</MonitorBroker></KqiAgent>

Page 40: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Setting Agent Parameters

40 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Setting Agent Parameters

OverviewYou can change the configuration of the agent by changing a default parameter or adding new parameters to the file.

Making changes to an existing parameterTo make changes to a parameter that already appears within the file, substitute the original parameter value with your new value, enclosed within a set of double quotes (““).

For example:

defaultStatisticInterval=“original value”

would become:

defaultStatisticInterval=“new value”

Adding new parameters to the fileTo add new parameters to the agent parameter file, you must first determine if an appropriate XML tag already exists for the parameter.

� If the appropriate XML tag already exists, insert the new parameter string into the tag block.

For example, to add the agentId parameter to the default kqi.xml file:

<KqiAgent version=”120”

defaultRetainBrokerEvents=”10”

defaultRetainFlowEvents=”10”

retainProductEvents=”10”

discoveryInterval=”300”

defaultStatisticInterval=”60”

defaultFlowEventInterval=”15”

defaultHistoricalAccountingType="Archive"

defaultRetainRecentSnapshotSamples="15"

defaultRetainRecentArchiveSamples="5"

Page 41: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 41

Setting Agent Parameters

holdTimeForQuery="180"

defaultReplyQueueName=”KQI.AGENT.REPLY.QUEUE”

defaultReplyQueueModel=”SYSTEM.BROKER.MODEL.QUEUE”

defaultTakeActionAuthUsers=”*”>

</KqiAgent>

would become:

<KqiAgent version=”120”

agentId=”new_value”

defaultRetainBrokerEvents=”10”

defaultRetainFlowEvents=”10”

retainProductEvents=”10”

discoveryInterval=”300”

defaultStatisticInterval=”60”

defaultFlowEventInterval=”15”

defaultHistoricalAccountingType="Archive"

defaultRetainRecentSnapshotSamples="15"

defaultRetainRecentArchiveSamples="5"

holdTimeForQuery="180"

defaultReplyQueueName=”KQI.AGENT.REPLY.QUEUE”

defaultReplyQueueModel=”SYSTEM.BROKER.MODEL.QUEUE”

defaultTakeActionAuthUsers=”*”>

</KqiAgent>

� If the appropriate XML tag does not exist, insert the correct opening and closing XML tags before including the parameter string.

For example, to set MonitorBroker parameters, insert the <MonitorBroker></MonitorBroker> tags and then add the parameters. For example:

<KqiAgent version="120"

agentId="A1"

defaultRetainBrokerEvents="10"

defaultRetainFlowEvents="10"

Page 42: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Setting Agent Parameters

42 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

retainProductEvents="10"

discoveryInterval="300"

defaultStatisticInterval="120"

defaultFlowEventInterval="30"

defaultHistoricalAccountingType="Archive"

defaultRetainRecentSnapshotSamples="15"

defaultRetainRecentArchiveSamples="5"

holdTimeForQuery="180"

defaultReplyQueueName="SOME.NAME"

defaultReplyQueueModel="SYSTEM.BROKER.MODEL.QUEUE"

defaultTakeActionAuthUsers="*" >

<MonitorBroker name="MySpecialBrokerName"

statisticInterval="60"

flowEventInterval="20"

retainBrokerEvents="5"

retainFlowEvents="5"

takeActionAuthUsers="A?B,C*" >

</MonitorBroker>

<MonitorBroker name="AnotherBrokerName">

</MonitorBroker>

<ConnectQueueManager name="MY.BROKER.QMGR"

replyQueueName="SOME.OTHER.NAME"

replyQueueModel="MY.SPECIAL.MODEL.QUEUE">

</ConnectQueueManager>

</KqiAgent>

Note that each tag block encapsulates the parameters specific to that component. This sample file is included in installations on UNIX and Windows. The file is named kqismpl.xml and can be used as a template for making changes to your kqi.xml file.

On UNIX, the kqismpl.xml file can be found in the following directory:

$CANDLEHOME/<Platform>/qi/files

Page 43: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 43

Setting Agent Parameters

where <Platform> is the abbreviation for the operating system architecture as shown in the installation guide (for example, aix433 or sol273).

On Windows, the kqismpl.xml file can be found in the following directory:

C:\Candle\Cma

Page 44: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Agent Parameter Descriptions

44 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Agent Parameter Descriptions

OverviewThe array of parameters that can be used in the kqi.xml file (or KQIXML member), along with their associated XML tags, are described below. The parameters are associated one of three tags: KqiAgent, MonitorBroker, or ConnectQueueManager.

KqiAgentThe KqiAgent tag encapsulates all parameters for the agent. Any attributes following this tag apply to the agent as a whole and provide monitoring and connection defaults that can be overridden at the individual broker or queue manager level. All associated attributes are optional.

version

The version attribute specifies the version of OMEGAMON XE for WebSphere Integration Brokers for which the parameters were set.

The default is “120”. This attribute is reserved for future product use. Do not alter this attribute from its default value unless directed to do so by Candle Support personnel.

agentId

The agentId attribute provides a short identifier (maximum length of four alphanumeric characters) for the OMEGAMON XE for WebSphere Integration Brokers agent.

Note:

– If your site intends to run more than one KqiAgent on the same host, assign each agent a unique agentId.

– If your site intends to run more than one broker with the same name on different hosts, assign each agent that monitors a broker a unique agentId.

The use of unique agentIds in these cases distinguishes the broker managed system names in the Candle Management Server (CMS) so that CandleNet Portal displays them correctly.

Page 45: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 45

Agent Parameter Descriptions

The default is ““ (none). Supply an alphanumeric character string with no blanks. The value will be used to create a unique managed system name.

defaultRetainBrokerEvents

The defaultRetainBrokerEvents attribute determines how many WebSphere MQ Integrator Broker Events to retain per broker for viewing in reports. These events are always reported as pure events for situations (that is, events that are not automatically reset) and if historical situations are active, they can be viewed historically.

The default is 10 events. The value must be greater than 0.

defaultRetainFlowEvents

The defaultRetainFlowEvents attribute determines how many Message Flow Events to retain per broker for viewing in reports. These events are always reported as pure events for situations and if historical situations are active, they can be viewed historically.

The default is 10 events. The value must be greater than 0.

retainProductEvents

The retainProductEvents attribute determines the total number of Product Events to retain for viewing in reports. These events are always reported as pure events for situations and if historical situations are active, they can be viewed historically.

The default is 10 events. The value must be greater than 0.

discoveryInterval

The discoveryInterval attribute determines the period of time in seconds between the agent’s rediscovery of brokers created on the system. This attribute can be set to a high value when you are no longer creating new brokers, unless you have a dynamic environment in which new brokers are created frequently.

The default is 300 seconds. The value must be greater than 0.

defaultStatisticInterval

The defaultStatisticInterval attribute determines the minimum period of time in seconds between the collection of broker statistics, such as message flow statistics.

Page 46: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Agent Parameter Descriptions

46 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

The default is 60 seconds. The value must be greater than 0.

defaultFlowEventInterval

The defaultFlowEventInterval attribute determines the period of time in seconds for the Message Flow Event sampling interval. This interval does not apply to Broker Events or Product Events.

The default is 15 seconds. The value must be greater than 0.

defaultReplyQueueName

The defaultReplyQueueName attribute specifies the name of the queue that will be used for the agent’s receipt of replies and publications for any queue manager to which the agent connects. Note that the queue will be created as a temporary dynamic queue if it does not already exist. If the given name is less than 33 characters long, the actual name of the temporary queue created will be made unique by the queue manager. This value will be used unless a replyQueueName parameter is specifically named for that queue manager.

The default is KQI.AGENT.REPLY.QUEUE.

defaultReplyQueueModel

The defaultReplyQueueModel attribute specifies the name of the queue that will be used as a model for creation of the agent reply queue for any queue manager to which the agent connects. This value will be used unless a replyQueueModel parameter is specifically named for that queue manager.

The default is SYSTEM.BROKER.MODEL.QUEUE.

defaultTakeActionAuthUsers

The defaultTakeActionAuthUsers attribute specifies which CandleNet Portal users are authorized to issue the Take Action commands associated with this agent. Note that there can be multiple entries associated with this attribute, and that each entry can be a “mask” which can include the “*” and “?” wildcard characters. A CandleNet Portal user whose ID matches any mask in this list is authorized to issue the Take Action commands that are handled by the KQIAgent. CandleNet Portal user IDs are defined within the CMS and do not necessarily exist on the node on which the agent is running. This default value applies for any commands that are not associated with a particular broker, and for any broker-related commands for brokers that do

Page 47: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 47

Agent Parameter Descriptions

not have a specific list of users specified by means of the takeActionAuthUsers parameter.

The default is “*” which allows all CandleNet Portal users to issue Take Action commands associated with this agent.

commandTimeoutInterval

The commandTimeoutInterval attribute specifies the period of time in seconds before the agent issues a message indicating that the broker is not responding.

The default is 60 seconds. The value must be greater than 0.

Important:Do not alter this attribute from its default value unless directed to do so by Candle support personnel.

maximumCommandRetryCount

The maximumCommandRetryCount attribute specifies the number of times that the agent will attempt to reissue a command before stopping.

The default is 4 retries. The value must be greater than 0.

Important:Do not alter this attribute from its default value unless directed to do so by Candle support personnel.

maximumAgentCollectionThreads

The maximumAgentCollectionThreads attribute can be used to increase or decrease the number of brokers that the agent can monitor.

The default is 42 threads. The value must be greater than 0. If you will be using one agent to monitor more than ten brokers per system, increase the default thread count by 4 for each additional broker monitored.

Important:Do not alter this attribute from its default value unless necessary. See “Agent Performance Considerations” on page 55.

holdTimeForQuery

The holdTimeForQuery attribute gives the amount of time, in seconds, that the agent should retain data for the ability to go down into a more detailed level in Accounting workspaces and still see the same sample of data that was selected in the higher-level workspace.

Page 48: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Agent Parameter Descriptions

48 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

The default value is 180, which means that, regardless of other parameters which affect data retention, you will still be able to see more details on a selected sample for three minutes after data for that sample is originally displayed.

This parameter must have a value greater than zero. If you do not want the agent to hold on to data, you can specify a value of 1 (1 second).

An example of the effect of this parameter is: If you go to the Snapshot Message Flow Accounting workspace, it displays a list of message flows monitored with their statistics at that level. By default, for the next three minutes you can select a row in the table and link to a more detailed level (either Snapshot Thread Accounting or Snapshot Node Accounting) for the same sample of data. Each time you “touch” a specific sample (all data pertaining to a given message flow), you extend the time you can look at that sample by three minutes. If the sample is not being retained for some other reason (using other retain parameters), after three minutes without a query, the sample is removed from storage. In that case you will be returned data from the most recent applicable sample.

defaultHistoricalAccountingType

The defaultHistoricalAccountingType attribute tells the agent which of the two types of accounting data is to be logged historically if historical logging is configured for the attribute group via the normal means. This means that historical collection for all or any of the four Accounting attribute groups needs to be activated via CandleNet Portal historical configuration before the value of this parameter would have any effect. The value of this parameter can be one of the following possible set of values:

For example, the parameter would be coded as follows in kqi.xml:

<KqiAgent ….

All All accounting data is logged historically if history is turned on.

Snapshot Only Snapshot accounting data is logged historically if history is turned on.

Archive Only Archive accounting data is logged historically if history is turned on. This is the default.

None No accounting data will be logged historically, even if history is turned on.

Page 49: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 49

Agent Parameter Descriptions

…. defaultHistoricalAccountingType="Archive" …. ></KqiAgent>

defaultRetainRecentSnapshotSamples

The defaultRetainRecentSnapshotSamples attribute gives the default value used by the agent for the number of recent snapshot records it keeps for any given message flow. The default provided in the shipped kqi.xml file is 15, which is actually about 5 minutes worth of snapshot data. However, the agent will always ensure that it retains enough historical samples to log the data historically if historical collection is configured.

For example the parameter would be coded as follows in kqi.xml:

<KqiAgent …. …. defaultRetainRecentSnapshotSamples="15" …. ></KqiAgent>

defaultRetainRecentArchiveSamples

The defaultRetainRecentArchiveSamples attribute gives the default value used by the agent for the number of recent archive records kept for any given message flow. The default provided in the shipped kqi.xml file is 5, which will result in about 5 hours of recent archive samples being retained if the your site uses the IBM default archive interval. The agent will always ensure that it retains enough historical samples to log the data historically if historical collection is configured.

For example the parameter would be coded as follows in kqi.xml:

<KqiAgent …. …. defaultRetainRecentArchiveSamples="5" …. ></KqiAgent>

Page 50: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Agent Parameter Descriptions

50 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

MonitorBroker The MonitorBroker tag encapsulates parameters which apply to a single broker to be monitored by the agent. One or more MonitorBroker tags may be specified.

On UNIX and Windows: If no brokers are specified, all brokers running on the same host system as the agent will be monitored, as determined by self-discovery. If any brokers are specified, then any other brokers that you wish to monitor must also be explicitly specified using MonitorBroker tags and attributes. All associated attributes are optional except for the name attribute.

On OS/390 and z/OS: OMEGAMON XE for WebSphere Integration Brokers does not currently support self-discovery of brokers on OS/390 or z/OS systems. Each broker to be monitored must be explicitly specified using MonitorBroker tags and attributes. All associated attributes are optional except for the name and the componentDirectory attributes.

name

The name attribute specifies the name of a WebSphere MQ Integrator Broker that should be monitored by this agent.

The name attribute is required.

statisticInterval

The statisticInterval attribute determines the same information as the defaultStatisticInterval attribute explained above, but overrides that default for this particular broker.

If this attribute is not specified, the defaultStatisticInterval value will be used. If specified, the value must be greater than 0.

flowEventInterval

The flowEventInterval attribute determines the same information as the defaultFlowEventInterval attribute explained above, but overrides that default for this particular broker.

If this attribute is not specified, the defaultFlowEventInterval value is used. If specified, the value must be greater than 0.

Page 51: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 51

Agent Parameter Descriptions

retainBrokerEvents

The retainBrokerEvents attribute determines the same information as the defaultRetainBrokerEvents attribute explained above, but overrides that default for this particular broker.

If this attribute is not specified, the defaultRetainBrokerEvents value is used. If specified, the value must be greater than 0.

retainFlowEvents

The retainFlowEvents attribute determines the same information as the defaultRetainFlowEvents attribute explained above, but overrides that default for this particular broker.

If this attribute is not specified, the defaultRetainFlowEvents value is used. If specified, the value must be greater than 0.

componentDirectory

The componentDirectory attribute specifies the directory path created when the broker to be monitored was customized. This is the same as the component directory name required as input to the mqsicreatebroker command with the “-c” parameter. The component directory is described in the WebSphere MQ Integrator for z/OS Customization and Administration Guide.

This attribute is required on OS/390 and z/OS systems. It is ignored if specified on UNIX or Windows systems.

takeActionAuthUsers

The takeActionAuthUsers attribute indicates which CandleNet Portal users are authorized to issue the Take Action commands associated with this agent, on this particular broker. Note that there can be multiple entries associated with this attribute, and that each entry can be a “mask” which can include the “*” and “?” wildcard characters. A CandleNet Portal user whose ID matches any mask in this list is authorized to issue the Take Action commands that are handled by the KqiAgent and are specific to this monitored broker. CandleNet Portal user IDs are defined within the CMS and do not necessarily exist on the node on which the agent is running. This value applies for any commands that are asssociated with the specified monitored broker only and overrides any defaultTakeActionAuthUsers attribute specification.

If this attribute is not specified, the defaultTakeActionAuthUsers value is used.

Page 52: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Agent Parameter Descriptions

52 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

historicalAccountingType

The historicalAccountingType attribute gives the value used by the agent for the given broker for which of the two types of accounting data is to be logged historically, if historical is configured for any or all of the 4 accounting tables. It has the same basic meaning as, and overrides any value given for, defaultHistoricalAccountingType. This parameter is not provided in the shipped kqi.xml, and the agent level default value given by defaultHistoricalAccountingType is used unless you specifically add this tag.

For example the parameter would be coded as follows in kqi.xml:

<KqiAgent …. …. <MonitorBroker name= …. …. historicalAccountingType="None" ….> </MonitorBroker> ….</KqiAgent>

retainRecentSnapshotSamples

The retainRecentSnapshotSamples attribute gives the value used by the agent for the given broker for the number of recent snapshot records to keep for any given message flow. It has the same basic meaning as, and overrides any value given for, defaultRetainRecentSnapshotSamples. This parameter is not provided in the shipped kqi.xml, and the agent level default value given by defaultRetainRecentSnapshotSamples is used unless you specifically add this tag.

For example the parameter would be coded as follows in kqi.xml:

<KqiAgent …. …. <MonitorBroker name= …. …. retainRecentSnapshotSamples="30" …. > </MonitorBroker> …. ></KqiAgent>

Page 53: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 53

Agent Parameter Descriptions

retainRecentArchiveSamples

The retainRecentArchiveSamples attribute gives the value used by the agent for the given broker for the number of recent archive records to keep for any given message flow. It has the same basic meaning as, and overrides any value given for, defaultRetainRecentArchiveSamples. This parameter is not provided in the shipped kqi.xml, and the agent level default value given by defaultRetainRecentArchiveSamples is used unless you specifically add this attribute.

For example the parameter would be coded as follows in kqi.xml:

<KqiAgent …. …. <MonitorBroker name= …. …. retainRecentArchiveSamples="30" …. > </MonitorBroker> …. ></KqiAgent>

ConnectQueueManagerThe ConnectQueueManager tag encapsulates parameters which apply to a queue manager that the agent will connect to. One or more ConnectQueueManager tags may be specified. The name attribute is required. However, there is no need to specify this tag if only the name attribute will be given. In this case, agent level defaults will be used for the remaining attributes, and the agent will automatically connect to the monitored broker’s associated queue manager. However, if the default reply and model queue names are not sufficient for a broker queue manager, the additional parameters below should be specified:

name

The name attribute specifies the name of the queue manager that the agent will connect to.

replyQueueName

The replyQueueName attribute specifies the name of the queue that will be used for the agent’s receipt of replies and publications for this queue manager. Note that the queue will be created as a temporary dynamic queue if it does

Page 54: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Agent Parameter Descriptions

54 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

not already exist. If the given name is less than 33 characters long, the actual name of the temporary queue created will be made unique by the queue manager.

If this attribute is not specified, the defaultReplyQueueName is used.

replyQueueModel

The replyQueueModel attribute specifies the name of the queue that will be used as a model for creation of the agent reply queue on this queue manager.

If this attribute is not specified, the defaultReplyQueueModel is used.

Page 55: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring OMEGAMON XE for WebSphere Integration Brokers Monitoring Agents 55

Agent Performance Considerations

Agent Performance Considerations

Monitoring a large number of brokersTo minimize performance overhead, Candle recommends running only one KqiAgent per host system. However, if the performance of the agent becomes negatively affected by monitoring a large number of brokers, you can split the monitoring duties among multiple agents. Here are some guidelines.

For most distributed systems, one agent per host system should suffice as the agent is designed to monitor all brokers on such a system, or to monitor a subset of brokers, as specified in the agent parameter file. Busy systems, such as OS/390 and z/OS systems, may need to adjust the agent parameter that limits the number of brokers monitored (see “maximumAgentCollectionThreads” on page 47) and during a testing phase confirm that the agent is not too busy to do a good job, or split the broker monitoring duties among multiple agents (see “agentId” on page 44).

The agent is too busy if the CPU usage is high or if the response time is high for requests made for data from that agent, either for CandleNet Portal workspace reports or situation monitoring. This may take some experimentation to determine. The objective of dividing monitoring duties among two or more agents is to obtain a comfortable level of adequate response time versus CPU usage (by all agents).

Page 56: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Agent Performance Considerations

56 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Page 57: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 57

Configuring theCandleMonitor Node

IntroductionThis chapter introduces the CandleMonitor node and provides instructions for integrating it into the broker environment and and then making it available in Control Center (v2.1) or the Message Brokers Toolkit (v.5) for inclusion in message flows. This chapter also describes how to position the CandleMonitor node to monitor message flow statistics and events, how to turn monitoring off and on, and how to configure the CandleMonitor node.

Chapter contentsAbout the CandleMonitor Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Integrating the CandleMonitor Node into Broker Environments . . . . . . . . 60Making the CandleMonitor Node Available to Message Flows . . . . . . . . . 65CandleMonitor Node Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Positioning the CandleMonitor node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Configuring CandleMonitor Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

3

Page 58: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About the CandleMonitor Node

58 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

About the CandleMonitor Node

OverviewThe CandleMonitor node is the OMEGAMON XE for WebSphere Integration Brokers component that collects statistics on message flow performance in a broker. It also provides a mechanism for generating user-defined events within a message flow. These events can be the subject of situations that detect abnormalities in the message flow and can be used, for example, to automatically stop a message flow that has messages flowing down an abnormal path

The CandleMonitor node is a simple pass-through node with one input terminal and one output terminal which is placed in a message flow (see Figure 5). Messages passing through the CandleMonitor node are propagated between its “in” and “out” terminals without change. CandleMonitor node is implemented in kqipnode.lil.

Figure 5. Example of a Monitored Flow

Page 59: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 59

About the CandleMonitor Node

Using the CandleMonitor node enables you to:

� View reports for message flows at broker, execution group, message flow and node levels.

� Detect high input/output rates to message flows.

� Detect high average time spent in message flows.

� Detect high queue times for input to message flows.

� Determine which part of a message flow is taking more time.

� Statistics show current interval and overall values.

� Be alerted to non-normal or low-use paths.

� Detect events and implement automatic responses.

By default, statistics are sampled once per minute and events are sampled once per 15 seconds.

Notes:With V5 brokers, IBM now provides message flow accounting and statistics that partially overlap with the statistics provided by the CandleMonitor node and can be monitored in CandleNet Portal without including the CandleMonitor node in message flows. However, the CandleMonitor node provides additional statistics, as well as the ability to monitor sub-flows and define message flow events.

The CandleMonitor node does not function with WebSphere MQ Event Broker v2.1. Message flows with no CandleMonitor nodes are not represented in statistics data.

Before the CandleMonitor node can be used to monitor message flows, it must be integrated into the broker environments and made available in the Control Center (V2.1) or Message Brokers Toolkit (V5).

Page 60: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Integrating the CandleMonitor Node into Broker Environments

60 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Integrating the CandleMonitor Node into Broker Environments

OverviewBefore the CandleMonitor node can be used to monitor message flows, it must be integrated into broker environments.

Integrating the CandleMonitor node on OS/390 and z/OSOn OS/390 or z/OS, the CandleMonitor node may be integrated either permanently or temporarily.

Note: During installation and configuration with CICAT, the "HFS Candlehome directory" is created with a user-specified name. That directory is identified as “<Candlehome>” in the statements below. The broker's user ID must have read access to all files and subdirectories in the “<Candlehome>/kqi” directory.

Permanent integration

To permanently integrate the CandleMonitor node into a broker environment on OS/390 or z/OS:

1. In the broker’s component directory, find and edit the mqsicompcif file for the broker. Make the following changes:� Change the "LILPATH=" statement to add the Candle path by

appending to the end of the existing statement:

:<Candlehome>/kqi/lil

� Change the environment variable section to add the KQI_CONFIG_FILE_PATH variable by adding the following line after "(ENVIRONMENTBEGIN)" and before "(ENVIRONMENTEND)":

KQI_CONFIG_FILE_PATH=<Candlehome>/kqi/lil

2. Save and exit the mqsicompcif file.

3. From the same broker component directory, issue the mqsicustomize command. Note that none of the changes made to the mqsicompcif file will require that you re-run any other customization job or command.

Page 61: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 61

Integrating the CandleMonitor Node into Broker Environments

4. Issue the following command in USS with a user ID with proper authority. Replace <Candlehome> as indicated at the beginning of this section, and replace <InstallationPath> with the broker's installation path:

ln -sf <Candlehome>/kqi/messages/En_US/CandleMonitorNode.cat <InstallationPath>/messages/En_US/CandleMonitorNode.cat

5. Restart the broker.

Temporary integration

Alternatively, you can perform a temporary installation of a CandleMonitor node. Temporary installation of the CandleMonitor node will modify the broker's environment only until the next time mqsicustomize is run, unless steps are taken to make the change permanent as described above.

To temporarily integrate the CandleMonitor node into a broker environment on OS/390 or z/OS:

1. In the broker’s HFS component directory, find and edit the ENVFILE file for the broker. Add the following statement to the end of the file:

KQI_CONFIG_FILE_PATH=<Candlehome>/kqi/lil

2. Save and exit the ENVFILE.

3. Issue the following command in USS with a user ID with proper authority. Replace <Candlehome> as indicated at the beginning of this section, and replace <InstallationPath> with the broker's installation path: ln -sf <Candlehome>/kqi/messages/En_US/CandleMonitorNode.cat <InstallationPath>/messages/En_US/CandleMonitorNode.cat

4. Issue the following commands, in order, on the z/OS operator console. Note that these commands restart the broker component.

F <STPN>,PC

F <STPN>,CB L='<existing lil path>:<Candlehome>/kqi/lil'

F <STPN>,SC

where:

<STPN> is the broker's started task procedure name

<existing lil path> is the current LILPATH defined in the mqsicompcif file.

Page 62: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Integrating the CandleMonitor Node into Broker Environments

62 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Integrating the CandleMonitor Node on UNIXIntegrating the CandleMonitor node into a broker environment on UNIX involves creating softlinks to the CandleMonitor node files. Creating these links requires a user ID with “root” authority.

Note: This step is required only if the softlinks could not be defined during product installation. The softlinks must be in place prior to using the CandleMonitor node.

From the UNIX command line, create the softlinks using the commands indicated below. (The ln command resides in /usr/bin). In these commands, candlehome is the full path to your $CANDLEHOME directory.

After you have created the softlinks, you must restart the broker.

On AIX:

ln -sf candlehome/aix433/qi/bin/kqipnode.lil /usr/opt/mqsi/lil/kqipnode.lil

ln -sf candlehome/aix433/qi/bin/kqipnode.cfg /usr/opt/mqsi/lil/kqipnode.cfg

ln -sf candlehome/aix433/qi/bin/CandleMonitorNode.cat /usr/opt/mqsi/messages/En_US/CandleMonitorNode.cat

ln -sf candlehome/aix433/qi/bin/CandleMonitorNode.cat /usr/lib/nls/msg/En_US/CandleMonitorNode.cat

On Solaris:

ln -sf candlehome/sol273/qi/bin/kqipnode.lil /opt/mqsi/lil/kqipnode.lil

ln -sf candlehome/sol273/qi/bin/kqipnode.cfg /opt/mqsi/lil/kqipnode.cfg

ln -sf candlehome/sol273/qi/bin/CandleMonitorNode.cat /opt/mqsi/messages/En_US/CandleMonitorNode.cat

ln -sf candlehome/sol273/qi/bin/CandleMonitorNode.cat /usr/lib/locale/C/LC_MESSAGES/CandleMonitorNode.cat

On HP-11:

ln -sf candlehome/hp11/qi/bin/kqipnode.lil /opt/mqsi/lil/kqipnode.lil

Page 63: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 63

Integrating the CandleMonitor Node into Broker Environments

ln -sf candlehome/hp11/qi/bin/kqipnode.cfg /opt/mqsi/lil/kqipnode.cfg

ln -sf candlehome/hp11/qi/bin/CandleMonitorNode.cat /opt/mqsi/messages/En_US/CandleMonitorNode.cat

ln -sf candlehome/hp11/qi/bin/CandleMonitorNode.cat /usr/lib/nls/msg/C/CandleMonitorNode.cat

On Linux Intel:

ln -sf <candlehome>/li6243/qi/bin/kqipnode.lil /opt/mqsi/lil/kqipnode.lil

ln -sf <candlehome>/li6243/qi/bin/kqipnode.cfg /opt/mqsi/lil/kqipnode.cfg

ln -sf <candlehome>/li6243/qi/bin/CandleMonitorNode.cat /opt/mqsi/messages/En_US/CandleMonitorNode.cat

ln -sf <candlehome>/li6243/qi/bin/CandleMonitorNode.cat /usr/share/locale/C/LC_MESSAGES/CandleMonitorNode.cat

On Linux zSeries:

ln -sf <candlehome>/ls3243/qi/bin/kqipnode.lil /opt/mqsi/lil/kqipnode.lil

ln -sf <candlehome>/ls3243/qi/bin/kqipnode.cfg /opt/mqsi/lil/kqipnode.cfg

ln -sf <candlehome>/ls3243/qi/bin/CandleMonitorNode.cat /opt/mqsi/messages/En_US/CandleMonitorNode.cat

ln -sf <candlehome>/ls3243/qi/bin/CandleMonitorNode.cat /usr/share/locale/C/LC_MESSAGES/CandleMonitorNode.cat

Defining the required environment variable for zSeries Linux An environment variable is required to be defined before starting the broker on zSeries Linux when softlinks have been defined for kqipnode.lil (see previous section). If this environment variable has not been defined before starting the broker, the broker will be unable to load the kqipnode.lil file due to "undefined symbol: read__7istreamPcl".

1. Edit the profile used by your service user ID that starts your broker. This is shipped by IBM as the following file, but if you have changed to use a different profile for your service user ID, edit that one.

Page 64: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Integrating the CandleMonitor Node into Broker Environments

64 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

/opt/mqsi/sample/profiles/profile.lnx

2. Include the following lines in the file: MQSI_PRELOAD=/opt/gcc295/lib/libstdc++-libc6.2-2.so.3

export MQSI_PRELOAD

3. Save the file.

4. Run the profile for the service user ID prior to restarting the broker. If you are already logged on to the user ID, enter the following to enact the new settings:

. /opt/mqsi/sample/profiles/profile.lnx

Note: /opt/gcc295/lib/libstdc++-libc6.2-2.so.3 should exist if you followed the instructions in Installing Candle Products on UNIX required for running the WebSphere Integration Brokers monitoring agent on zSeries Linux.

Integrating the CandleMonitor Node on WindowsTo integrate the CandleMonitor node into a broker environment on Windows:

1. Verify that the file kqipnode.lil was copied into the appropriate directory during the installation of the OMEGAMON XE for WebSphere Integration Brokers monitoring agent. If for any reason the file was not able to be installed into the broker’s bin directory, you must manually copy kqipnode.lil from the directory:

candlehome\cma

to the IBM broker bin directory on a system that is running a broker. An example of a typical bin location is:

C:\Program Files\IBM\WebSphere MQ Integrator 2.1\bin

Also verify that the kqipnode.lil file in the broker bin directory exactly matches (in terms of size and date-time) the one that resides in the candlehome\cma directory. A mismatch of the release-level of these files will cause a failure of the product’s statistics and message flow events reporting.

2. Verify that the OMEGAMON XE for WebSphere Integration Brokers monitoring agent has been properly configured as directed within the product installation documentation.

3. Restart your brokers so that the CandleMonitor node can be used.

Page 65: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 65

Making the CandleMonitor Node Available to Message Flows

Making the CandleMonitor Node Available to Message Flows

OverviewBefore the CandleMonitor node can be placed into message flows it must be made available to the Control Center (version 2.1 products) or the Message Brokers Toolkit (version 5 products).

Note: If you are using v2.1 of the IBM broker product and you are upgrading from a previous version of this product, you must first delete the exisiting CandleMonitor node. See “Deleting the CandleMonitor node” below

The CandleMonitor node resides in a file that is created during the installation of OMEGAMON XE for WebSphere Integration Brokers. Several versions of this file are downloaded along with the product during installation of the monitoring agent on Windows. If the installation location defaults were used, the files will reside in the following location:

C:\Candle\cma

� If you are using WebSphere MQ Integrator v2.1 or WebSphere MQ Integrator Broker v2.1, use the CandleMonitor node file named named kqicm210.exe.

� If you are using WebSphere Business Integration Event Broker V5, WebSphere Business Integration Message Broker V5, or WebSphere Business Integration Message Broker with Rules and Formatter Extension V5, use the CandleMonitor node named kqicm500.exe.

Deleting the CandleMonitor node If you are upgrading from a previous version of this product and are using IBM v2.1 brokers, you must delete the existing CandleMonitor node before you can use the new one. Any CandleMonitor nodes placed in message flows prior to this change will continue to operate after the node is replaced following the instructions in “Control Center” on page 66.

To delete the CandleMonitor node:

1. Start the Control Center and select the Message Flows tab.

2. Find the existing CandleMonitor node in the left-hand tree view.

Page 66: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Making the CandleMonitor Node Available to Message Flows

66 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

3. Right-click the CandleMonitor node and select Delete.

Control CenterTo make the CandleMonitor node available to the Control Center:

1. Execute kqicm210.exe on a system where the Control Center is installed and used.

2. Unzip (extract) the files contained in the file into the directory where the broker is installed. An example of a typical installation location would be:

C:\Program Files\IBM\WebSphere MQ Integrator 2.1

3. The majority of the required files are properly placed in Step 2. However, the two files contained in the CandleMonitor directory that was created under the WebSphere MQ Integrator broker directory must be copied to the following location:

C:\Program Files\IBM\WebSphere MQ Integrator 2.1\Tool\repository\private\<hostname>\<ConfigMgr Qmgr Name>\MessageProcessingNodeType

Note: The “MessageProcessingNodeType” directory level may have to be created if it does not already exist. <hostname> is the name of the host system for your configuration manager. <ConfigMgr Qmgr Name> is the name of the queue manager associated with your Configuration Manager. Both of these directory levels should already exist and should not have to be created.

4. Start the Control Center and go to the Message Flows tab.

5. In the left pane, right-click on Message Flows, select Create, then click Message Flow Category.

6. Name the category “Candle” and finish.

7. Right-click on the Candle category, select Add, then click Message Flow.

8. In the list displayed, select “CandleMonitor” and finish.

9. Right-click CandleMonitor, then select Check In.

10. Start using the CandleMonitor node in message flows. Refer to “Positioning the CandleMonitor node” on page 72 for information concerning node placement and attribute settings.

Page 67: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 67

Making the CandleMonitor Node Available to Message Flows

Message Brokers ToolkitTo make the CandleMonitor node available in Message Brokers Toolkit:

1. Exit the Message Brokers Toolkit if you have it active.

2. Execute kqicm500.exe to extract files to the appropriate Eclipse plugin directory to install the CandleMonitor node Eclipse plugin. The zip exe file defaults to the following location for extraction, which is correct if the defaults were accepted during installation:

C:\Program Files\IBM\WebSphere Business Integration Message Brokers\eclipse\plugins

3. This extraction creates the following subdirectory (following IBM naming standards), with all the necessary plugin support files included:

com.candle.monitor_1.2.0

4. Restart the Message Brokers Toolkit. When you are in the Broker Application Development Perspective you should now see the CandleMonitor node in the message flow editor pallette under the category "Candle".

Page 68: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

CandleMonitor Node Attributes

68 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

CandleMonitor Node Attributes

OverviewYou set the properties of the CandleMonitor node when you place it in a message flow. The attribute values you set determine how the node operates.

typeThe type attribute determines the type of statistics gathered. It can be set to:

� input—Identifies the node as being a main message flow input node which records entry of messages into the message flow. For example, specify “input” when placing the CandleMonitor node just following the MQInput node.

� output—Identifies the node as being a main message flow output node which records exit of messages from the message flow. For example, specify “output” when placing the CandleMonitor node just before any MQOutput, MQReply, or Publication node.

� subFlowInput—Identifies the node as being a sub-flow input node

� subFlowOutput—Identifies the node as being a sub-flow output node

� other—Identifies the node as being used for other purposes, such as ad-hoc statistics or message flow event generation. For example, specify “other” when placing the CandleMonitor node wherever necessary to debug your message flows. (This is the default value.)

collectQueueTimeThe collectQueueTime attribute specifies whether the node should collect queue timings. It can be set to:

� no—Queue times will not be collected for these messages.

� yes—Queue times will be collected for these messages. (This is the default value.)

Queue times are calculated using the put date and time of the message in the queue. If the input queue to a message flow will have messages with put date and times that do not reflect accurately when the message was put into the input queue, then collectQueueTime should be set to "no" when

Page 69: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 69

CandleMonitor Node Attributes

configuring the CandleMonitor "input" type node, so that queue times will not be collected for these messages. (See also “Monitoring the input or output of a message flow”.)

eventMessageThe eventMessage attribute is used to produce user-defined message flow events that can be detected via Message Flow Events situations and reports. An event is produced when the node is entered if the value is set to other than ““.

When a node is placed for the purpose of generating events, the type attribute should be "other" and the eventMessage attribute should be set to the message text that you wish to appear in OMEGAMON XE for WebSphere Integration Brokers.

The default value is ““ (no events are produced).

subFlowNameThe subFlowName attribute provides an identifying name for the sub-flow. This attribute is required for nodes of type subFlowInput and subFlowOutput; they will not produce sub-flow statistics properly without it.

The subFlowName also can be provided on other types of nodes. The following table summarizes the effect of providing the subFlowName attribute for each node type.

Value of Type Attribute

subFlowName Attribute

Requirement

Effect

input Optional The input node will be considered a “combination” node; it is taken to mark not only the beginning of a message flow, but also the beginning of a sub-flow within the message flow.

output Optional The output node will be considered a “combination” node; it is taken to mark not only the end of a message flow, but also the end of a sub-flow within the message flow.

Page 70: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

CandleMonitor Node Attributes

70 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

See “Monitoring sub-flows” for more information on placing CandleMonitor nodes and required attribute values.

activateNodeThe activateNode attribute controls the activation of instances of a CandleMonitor node. The possible values for the activateNode attribute are:

� yes—The CandleMonitor node is activated. This setting is appropriate for a test environment. (This is the default.)

� no—The CandleMonitor node is deactivated.

� eventOnly—The CandleMonitor node is activated if an eventMessage attribute assigned. The node does not produce statistics, only message flow events. This setting is useful when you want message flow events, but are not interested in gathering statistics.

other Optional The other node will be considered to be part of the sub-flow. This will have mostly no effect. However, it will cause the CandleMonitor node to be displayed in the list of CandleMonitor nodes for the named sub-flow when one takes a link from the Sub-Flow Statistics workspace to the CandleMonitor Node Statistics workspace.

subFlowInput Required The subFlowInput type node marks the beginning of a monitored sub-flow and requires a name for correlation of statistical data with the sub-flow. There can be multiple inputs to a sub-flow; in this case, use the same subFlowName for each node.

subFlowOutput Required The subFlowOutput type node marks the end of a monitored sub-flow and requires a name for correlation of statistical data with the sub-flow. There can be multiple outputs for a sub-flow; in this case, use the same subFlowName for each node.

Value of Type Attribute

subFlowName Attribute

Requirement

Effect

Page 71: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 71

CandleMonitor Node Attributes

� inputOutputOnly—The CandleMonitor node is activated if the type is input or output. This setting produces statistics (and events if eventMessage is assigned).

� inputOutputAndEventOnly—The CandleMonitor node is activated if the type is input or output, or if the eventMessage attribute is set. Statistics are produced and events too if the eventMessage is assigned. This setting is useful in a production environment where you want message flow statistics and event messages, but no further details provided by other node types.

For WebSphere Business Integration version 5.0 brokers and after, the activateNode attribute is configurable. This means that it can be set during bar file configuration so that it can have a different setting for different bar files, used for instance to deploy for test and production. In addition, version 5.0 allows promoting the attribute setting so that this attribute has the same setting for each instance of the CandleMonitor node in a message flow.

The set of possible values for the attribute supports specification of some general rules for when the node should be active, for example active for all input and output type nodes, but none other. In general, when configuring a CandleMonitor node in a message flow, leave the setting at the default of "yes" to facilitate node usage during testing. Then when deploying to a production broker, configure the bar file setting for "activateNode" to the desired level and promote the attribute to automatically change the setting of all nodes in the flow to that activation level.

For versions prior to 5.0 (and for 5.0 as well if desired), the CandleMonitor node plug-in code accepts specification of a runtime override setting for the activateNode attribute, allowing different activation levels for different brokers (see “KQIActivateNode” on page 80).

Page 72: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Positioning the CandleMonitor node

72 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Positioning the CandleMonitor node

OverviewThe primary use of the CandleMonitor node is to produce the statistics which are displayed in the high-level statistics workspaces of this product (the Broker Statistics, Execution Group Statistics, Message Flow Statistics, and Sub-Flow Statistics workspaces). To ensure that the correct statistics are gathered, it is important that the node be properly placed in message flows.

Care must be taken to give unique label names to CandleMonitor nodes within a message flow. The names should be unique with respect to any other names within the entire message flow, including its sub-flows. If the CandleMonitor node label names are not unique, data for different nodes will be combined in illogical ways. You should not let your CandleMonitor node label names take the default because this will ensure problems. If you are migrating message flows with sub-flows from V2.1 to V5.0, you may have to make changes to CandleMonitor node label names if you did not name them uniquely before.

Some general node applications are discussed below.

Monitoring the input or output of a message flowWhen designing a message flow that is to be monitored by broker, a CandleMonitor node should be placed just following the MQInput node. This permits the CandleMonitor node to gather the information required for input rate calculations. The type attribute of a CandleMonitor node placed in this position should be set to “input”.

If you only wish to place a single CandleMonitor node in a message flow, the “input” position is the best choice, as most statistics are generated from this position.

However, another important location for placing the CandleMonitor node would be just before any MQOutput, MQReply, or Publication node, in order to permit output rate calculations. In this instance, the type attribute of the CandleMonitor node should be set to “output”.

In determining queue time statistics, queue times are calculated using the Put date and time of the message in the queue. This becomes an important consideration if the input queue to a message flow will contain messages with

Page 73: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 73

Positioning the CandleMonitor node

times that do not accurately reflect when the message was Put into the input queue. In this case, for a CandleMonitor node with a type attribute of “input”, the collectQueueTime attribute should be set to “no” so that queue times will not be collected for these messages.

Put date and times are not accurate indicators when origin context is preserved for a message during the Put by an application to the input queue to the message flow. This commonly occurs when an application is a message mover that transfers messages from one queue to another, or when any application passes or sets origin context for a message. In particular, if the input queue to Message Flow B is the output queue of Message Flow A, the broker passes the origin context so that the Put date and time for the message in Message Flow B will not allow accurate calculation of queue time. As such, the collectQueueTime attribute for a CandleMonitor node placed in Message Flow B should be set to “no”.

Monitoring sub-flowsA sub-flow is a section of a message flow that includes one or more message processing nodes. In general terms, a sub-flow can be any section of a message flow that can be separately identified. You might look at the message flow as being like a main routine and a sub-flow as being a subroutine. The subroutine may be explicitly delineated in the Control Center or Message Brokers Toolkit by making a separate message flow which is then embedded in the main flow (referred to here as Type I). Or, the message flow may have sections of nodes that you want to monitor as sub-flows even though they are not explicitly delineated into a separate flow (referred to here as Type II).

When a message flow is deployed to the broker, the broker “sees” the entire message flow as a single entity. There is no obvious delineation in the broker for dividing the flow into separate sub-flows. The name assigned to a Type I sub-flow is not known to the broker (it is a Control Center/Toolkit and configuration manager entity only). Any given message processing node does not “know” about the other message processing nodes around it. Therefore, for the CandleMonitor node to be useful in monitoring both types of sub-flows, the message flow developer must provide the required information by configuring the node.

Note that for correct sub-flow statistics for either type of sub-flow, the subFlowOutput CandleMonitor node is required in the sub-flow and is not optional as is the case with the output node for a main message flow.

Page 74: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Positioning the CandleMonitor node

74 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Monitoring a type I sub-flow

To monitor a Type I sub-flow, a CandleMonitor node should be placed just after the Input Terminal in the flow and another CandleMonitor node just before the Output Terminal or other output of the flow (see Figure 6). All of these nodes should be assigned the same subFlowName attribute value. The type of the node at the input location would be "subFlowInput". The type of node at the output location would be "subFlowOutput" (or "output" if the output is actually a node such as MQOutput and it represents the end of the message flow for a message going down a particular path).

Figure 6. Type I Sub-Flow

Main Message Flow

SubFlow1

subFlowName=SubFlow1 subFlowName=SubFlow1

Page 75: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 75

Positioning the CandleMonitor node

Monitoring a type II sub-flow

To monitor a Type II sub-flow, a CandleMonitor node should be placed at any designated starting place in a message flow, its type set to "subFlowInput," and the subFlowName attribute assigned. Then a CandleMonitor node should be placed at a corresponding ending place in the message flow, its type set to "subFlowOutput", and the same subFlowName attribute assigned (see Figure 7). If the section of message flow that is to be monitored has multiple input connectors or multiple output connectors, multiple CandleMonitor nodes need to be added in the same way with the same subFlowName.

Figure 7. Type II Sub-Flow

Embedded and nested sub-flows

Sub-flows embedded within sub-flows, or nested sub-flows, are supported. However, the subFlowName attribute for any nested sub-flows must be different for different sub-flows. Message flow developers need to be aware of the names assigned to sub-flow monitoring nodes and should not re-use them.

Sub-flow names

For Type I message flows, the subFlowName may most obviously be set to the name given in the Control Center to the message flow that represents the sub-flow. However, for Type II message flows, some other name will need to be chosen that uniquely describes what is being monitored.

subFlowName=SubFlow1 subFlowName=SubFlow1

Page 76: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Positioning the CandleMonitor node

76 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

CandleMonitor Node Statistics (the lowest level, most detailed report) will combine data for all instances of the same node that is part of a sub-flow that has been embedded multiple times in the same message flow.

A subFlowName can be assigned to a type “input” or “output” CandleMonitor node. The combination usage for input and output node types avoids the need to insert two CandleMonitor nodes in a flow at the same position when a sub-flow comes either at a beginning or ending of a message flow. The combination output node will likely be used more, because a Type I sub-flow may have an output that is the end of the line for a message going through the whole message flow as well as through the sub-flow. (For a description of the effects of assigning a subFlowName attribute to a node type other than subFlowInput or SubFlowOutput, see “subFlowName” on page 69.)

Monitoring other aspects of a message flowThe placement of the CandleMonitor node is not limited to the extremities of a message flow. It is possible to place the CandleMonitor node anywhere within a message flow and gather statistics on that particular portion of the message flow.

When placed in this context, the type attribute of the CandleMonitor node should be set to “other”. The results are viewable in this product’s low-level statistics workspace, the CandleMonitor Node Statistics workspace.

Producing event messagesA secondary use of the CandleMonitor node is to produce user-defined message flow events that can be detected in Message Flow Events situations and in the Message Flow Events workspace.

When placing the CandleMonitor node for this purpose, the type attribute should be set to “other”. The eventMessage attribute should be set to display the message text that you wish to appear in the workspace when the CandleMonitor node has been entered.

OMEGAMON XE for WebSphere Integration Brokers will include other information concerning the event in order to help identify which portion of the message flow was affected, as well as to isolate which message was being processed at the time the event occurred.

The placement of the CandleMonitor node for such events is entirely at your discretion. However, it is not recommended that the node be placed in

Page 77: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 77

Positioning the CandleMonitor node

portions of the message flow that are typically associated with normal processing. For example, setting the eventMessage attribute for any “input” or “output” type node would produce an undesirable number of events.

Instead, it is recommended that this feature is best used in paths of a message flow that represent processing failures or other irregular conditions that warrant an alert event notification. Note that in this capacity, the CandleMonitor node only serves as an alert mechanism and cannot perform error recovery as it is a pass-through node only.

Best practices� For production flow statistics, the CandleMonitor node should be placed

just after MQInput (or other input) nodes with type “input”.

� For output rates and counts, the CandleMonitor node should be placed just before MQOutput, MQReply, and Publication nodes with type “output”.

� Any other placement in the flow should not use types “input” or “output” because this will cause inaccurate data.

� Generally, an eventMessage should be set only for “subFlowInput”, “subFlowOutput”, and “other” type nodes.

It should not be set for normal processing part of a flow or with a type attribute of “input” or “output” (unless it is low use and there is a specific reason) because of the risk of too much data and overhead.

� For message flow development, more nodes can be placed with type “other”, for example, for use in determining areas of a flow with bad performance.

� If the broker or the agent is to be taken down for any reason, they should be allowed to go through complete shutdown whenever possible.

Page 78: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring CandleMonitor Node

78 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Configuring CandleMonitor Node

OverviewSome of the behaviors of CandleMonitor nodes are controlled by configuration variables. You can adjust the values of these variables to suit your requirements. After a change to any of the variables, the broker must be restarted for the change to take effect.

On Windows platforms, these configuration variables are available in the registry set up during configuration of the monitoring agent. On UNIX and Linux platforms, the configuration variables are in the file kqipnode.cfg in <Candlehome>/<platform-version>/qi/bin. On OS/390 and z/OS, the configuration variables are available in the file kqipnode.cfg in an HFS directory <Candlehome>/kqi/lil.

Note: All of the kqipnode variable names and values are case sensitive. You must use casing as documented. For example, if you are specifying the no override value for KQIActivateNode, you must specify it with mixed casing, as shown: NoOverride.

Changing variables on WindowsTo change the setting of one of these variable on Windows, use Manage Candle Services:

1. From the Start menu, select:Programs > Candle OMEGAMON XE > Manage Candle Services

2. Right-click the "primary" WebSphere Integration Brokers Monitoring Agent and select Advanced > Edit Variables from the popup menu.

3. Do one of the following:– If you have never modified the variable to be changed, click Add and

select it from the dropdown list for the Variable field.

– If you have previously changed the variable, highlight it on the list and click Edit.

4. Set the Value field for the variable to the desired value and click OK.See “Configuration variables” on page 79 for explanations of the variables and their valid values.

Page 79: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 79

Configuring CandleMonitor Node

5. Click OK again to reconfigure the monitoring agent.A prompt will ask if you want to edit the kqi.xml agent parameters, but you can say No to that prompt.

Changing variables on UNIX and LinuxTo change a parameter, edit the file kqipnode.cfg in <Candlehome>/<platform-version>/qi/bin.

The format is:

variable value

variable value

Changing variables on OS/390 and z/OSOn OS/390 and z/OS, the configuration variables are available in the file

To change a parameter, edit the file kqipnode.cfg in <Candlehome>/kqi/lil. However, if you want your change to be permanent, so that subsequent configuration with CICAT does not overwrite the change (for instance when a PTF is installed), you must edit the member kqipnode in your TKANPAR dataset, or remember to make the change again after any time you run the job to load runtime libraries (this job usually must be run after installing a PTF).

Configuration variables

KQIMemorySize

KQIMemorySize gives the size in bytes of a shared memory segment created by the plug-in. The plug-in actually creates three of these for holding different types of data. The default value is 32768 bytes. Candle recommends that you not modify this variable unless instructed to do so by Candle support.

KQITempDirectory

KQITempDirectory gives a full directory path name to be used for shared memory and mutexes. The broker and the agent must have the ability to create files in, write, and read this directory. The default is /tmp. This variable is not applicable to Windows platforms and is not available for modification on Windows.

Page 80: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring CandleMonitor Node

80 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Note: The only time that it is safe to clear out files with "kqi" in the name in the defined directory is after shutting down all brokers and all monitoring agents on the system.

The setting for KQITempDirectory applies to all brokers and monitoring agents on the system, so they all must be taken down prior to doing any kind of deleting of kqi files. There is normally no need to delete the files anyway because with everything down, the files are no longer present. However, there can be situations in which the files do remain after shutdown of all components, and in that case they can be deleted, but only if all components truly are not active. These files implement shared memory and mutexes, and the product will not behave normally if you delete them while the processes that use the files are active.

KQINodeTrace

KQINodeTrace specifies whether or not kqipnode.lil tracing is turned on. Possible values are Off and On. The default is Off. For tracing to actually occur, the broker's "normal" tracing must be turned on for the applicable broker, execution group, and/or message flow. This value should only be set to On at the instruction of Candle support.

KQIActivateNode

This parameter provides an override capability for the CandleMonitor node activateNode attribute for any broker on the system. If a value other than the default “NoOverride” is specified, that value will override the value set for the attribute for all instances of CandleMonitor node deployed to a broker.

The possible values are:

� NoOverride—The value of the activateNode attribute deployed for each instance of the CandleMonitor node is honored; no override takes place. This is the default setting.

� Yes—Every instance of the CandleMonitor node is activated.

� No—All instances of the CandleMonitor node are deactivated. No statistics or message flow events are generated.

� EventOnly—An instance of CandleMonitor node is activated only if the eventMessage attribute is assigned. No statistics are produced, only message flow events.

Page 81: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring the CandleMonitor Node 81

Configuring CandleMonitor Node

� InputOutputOnly—An instance of the CandleMonitor node is activated only if the type is input or output. Statistics are generated (and events, if the eventMessage attribute is assigned).

� InputOutputAndEventOnly—Instances of CandleMonitor node are activated only if the type is input or output, or if the eventMessage attribute is assigned. Statistics are produced, and message flow events if the eventMessage attribute is assigned.

KQIActivateNodeForBROKERNAME

KQIActivateNodeForBROKERNAME provides the same override capability as KQIActivateNode except that it applies only to the named broker. If this variable is specified, the kqipnode.lil plug-in running in broker BROKER will use this setting rather than the setting given in KQIActivateNode. This variable name does not exist and must be added to kqipnode.cfg (UNIX, OS/390, or z/OS) or typed into the variable field instead of selected from the dropdown list (Windows).

Page 82: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Configuring CandleMonitor Node

82 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Page 83: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 83

Usage Scenarios

IntroductionThis chapter provides scenarios that illustrate how you can use OMEGAMON XE for WebSphere Integration Brokers to meet your site’s monitoring and analytical needs.

Chapter contentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Monitoring Application Put and Get Message Performance. . . . . . . . . . . . 85Determining Application Delivery Failure of Messages . . . . . . . . . . . . . . . 87Debugging a Message Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Determining When a Message Flow Has Failed . . . . . . . . . . . . . . . . . . . . 90Verifying the Broker/Control Center Configuration . . . . . . . . . . . . . . . . . . 91Collecting Requested System Trace Data for a Broker on an Unavailable System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Stopping a Message Flow with a Full Output Queue . . . . . . . . . . . . . . . . . 93Automatically Starting a Broker That Is Stopped. . . . . . . . . . . . . . . . . . . . 94Performing Broker Capacity Planning. . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Ensuring Adequate Message Flow Response Time . . . . . . . . . . . . . . . . . . 97Preventing Inadvertent Use of Trace Active. . . . . . . . . . . . . . . . . . . . . . . . 98Starting and Stopping Message Flows at Periodic Intervals . . . . . . . . . . . . 99User Not Receiving All Publications to Subscriptions. . . . . . . . . . . . . . . . 101

4

Page 84: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Overview

84 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Overview

This chapter provides examples of issues and needs common to many WebSphere MQ Integrator and WebSphere Business Integration broker environments, and shows how OMEGAMON XE for WebSphere Integration Brokers can used in these circumstances.

Each scenario presents a case in which you will need to monitor some aspect or component of your WebSphere MQ Integrator and WebSphere Business Integration broker environment, followed by a discussion of how to set up OMEGAMON XE for WebSphere Integration Brokers to gather pertinent information.

Page 85: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 85

Monitoring Application Put and Get Message Performance

Monitoring Application Put and Get Message Performance

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used in a performance monitoring situation where the put and get message time between applications is excessively long.

CandleMonitor node requirementsTo properly determine the time taken for one application to get the messages that were put by another application, you will need two CandleMonitor nodes within the monitored message flow:

� Place one CandleMonitor node just following the MQInput node so that the entry of the message into the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “input”.

� Place one CandleMonitor node just prior to the MQOutput node so that the exit of the message from the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “output”.

What you will need to doOnce you have placed and set the CandleMonitor nodes as described above, allow OMEGAMON XE for WebSphere Integration Brokers to run so that the product can gather the appropriate statistics, then do the following:

1. Open the Message Flow Statistics workspace and examine the results for the Current Average Queue Time and Current Average Flow Time attributes. For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

2. If you determine that the results reported for the Current Average Queue Time attribute are excessively long, then you should consider incrementing the Additional Instances value for the monitored message flow. Additional Instances specifies the number of additional instances of the message flow that the execution group should run to allow for more multi-processing of messages.

Page 86: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Monitoring Application Put and Get Message Performance

86 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

3. If you determine that the results reported for the Current Average Flow Time are excessively long, then you will need to debug the monitored message flow. To perform this task, you will need to add CandleMonitor nodes before each processing node in the message flow. This will help you determine which node is causing the problem. The “type” attribute for these CandleMonitor nodes must be set to “other”. See “Debugging a Message Flow” on page 89.

Page 87: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 87

Determining Application Delivery Failure of Messages

Determining Application Delivery Failure of Messages

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used in a situation where messages destined for an application are not being received by that application.

CandleMonitor node requirementsTo properly determine the message count for messages sent from one application to another, you will need two CandleMonitor nodes within the monitored message flow:

� Place one CandleMonitor node just following the MQInput node so that the entry of the message into the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “input”.

� Place one CandleMonitor node just prior to the MQOutput node so that the exit of the message from the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “output”.

What you will need to doOnce you have placed and set the CandleMonitor nodes as described above, allow OMEGAMON XE for WebSphere Integration Brokers to run so that the product can gather the appropriate statistics, then do the following:

1. Open the Message Flow Information workspace and examine the results for the Status attribute. The Status column for the monitored message flow should have a value of “Started”.

2. Open the Message Flow Statistics workspace and examine the results for the Current Message Input Count versus the Current Message Output Count attributes. A discrepancy between these values indicates that messages are being lost in the monitored message flow. For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Page 88: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Determining Application Delivery Failure of Messages

88 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

3. Open the Message Flow Events workspace and determine whether there were any possible exceptions caused by a node member of the monitored message flow. For information on the workspace, refer to “Message Flow Events Workspace” on page 156.

Page 89: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 89

Debugging a Message Flow

Debugging a Message Flow

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to debug the operation of a message flow.

CandleMonitor node requirementsTo properly determine which node in the message flow is causing a problem, you will need to place a CandleMonitor node before each processing node within the message flow. The “type” attribute for these CandleMonitor nodes must be set to “other”.

What you will need to doOnce you have placed and set the CandleMonitor nodes as described above, allow OMEGAMON XE for WebSphere Integration Brokers to run so that the product can gather the appropriate statistics, then do the following:

1. Open the CandleMonitor Node Statistics workspace and examine the results for the flow times of the CandleMonitor nodes in the message flow. For more information on the workspace, refer to “CandleMonitor Node Statistics Workspace” on page 149.

2. Compare statistics for nodes that are adjacent in the message flow. The differences in flow times for the CandleMonitor nodes will provide the time spent by a message in any one of the processing nodes in the message flow.

3. Perform a similar comparison for each CandleMonitor node within the message flow until you determine which processing node is producing the undesirable results.

Page 90: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Determining When a Message Flow Has Failed

90 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Determining When a Message Flow Has Failed

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to determine and notify you of a failure within a message flow.

CandleMonitor node requirementsTo determine when a message flow has failed, you will need to place CandleMonitor nodes as needed after failure terminals. The “type” attribute for these CandleMonitor nodes must be set to “other”, and you should input text into the “eventMessage” attribute that describes the failure in a meaningful way.

What you will need to doOnce you have placed and set the CandleMonitor nodes as described above, allow OMEGAMON XE for WebSphere Integration Brokers to run so that the product can gather the appropriate statistics, then do the following:

1. Use CandleNet Portal to define situations for Message Flow Events so that an alert will be raised each time a message flows down a failure path. If necessary, refer to CandleNet Portal online Help or the Administering OMEGAMON Products: CandleNet Portal guide for information on defining a situation.

Page 91: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 91

Verifying the Broker/Control Center Configuration

Verifying the Broker/Control Center Configuration

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to verify that the broker configuration matches your expected configuration as depicted in the Control Center or the Message Brokers Toolkit.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

1. Examine the various Information workspaces, such as Execution Group Information, Message Flow Information, Message Processing Node Information, Neighbors, Subscriptions, Retained Publications, and ACL Entries. These workspaces contain data from the broker perspective as opposed to the Control Center or Message Brokers Toolkit perspective.

2. To determine if the proper configuration was deployed to the broker, compare the data within the workspaces with what you expected.

Page 92: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Collecting Requested System Trace Data for a Broker on an Unavailable System

92 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Collecting Requested System Trace Data for a Broker on an Unavailable System

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to collect IBM’s requested System trace data for a broker that is located upon a system that is not physically available to you.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

1. Open the Take Action panel within CandleNet Portal. If necessary, refer to the CandleNet Portal online Help for information on performing this procedure.

2. Issue the “QI Change Trace Broker” command with the destination set to the appropriate broker. For additional detail about the “QI Change Trace Broker” command, refer to “Take Action Commands” on page 108.

Page 93: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 93

Stopping a Message Flow with a Full Output Queue

Stopping a Message Flow with a Full Output Queue

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to quickly stop a message flow that is failing due to a full output queue. This scenario is intended for users who do not always start Configuration Manager and Control Center so that they may conserve system resources.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

1. Open the Take Action panel within CandleNet Portal. If necessary, refer to the CandleNet Portal online Help for information on performing this procedure.

2. Issue the “QI Stop Message Flow(s)” command with the destination set to the appropriate broker. Set the arguments to the appropriate execution group and message flow names. For additional detail about the “QI Stop Message Flow(s)” command, refer to “Take Action Commands” on page 108.

Page 94: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Automatically Starting a Broker That Is Stopped

94 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Automatically Starting a Broker That Is Stopped

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to automatically restart a broker anytime that it is stopped.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

1. Use CandleNet Portal to define a situation for the Broker Information workspace to check if the Broker Status is “not Started”. If necessary, refer to CandleNet Portal online Help or the Administering OMEGAMON Products: CandleNet Portal guide for information on defining a situation.

1. Set the action for the situation to use the “QI Start Broker” reflex automation/Take Action command to restart the broker. For additional detail about the “QI Start Broker” command, refer to “Take Action Commands” on page 108.

Note: There is a predefined situation for the Components workspace that can be used for the same purpose, but that situation will also start the Configuration Manager or User Name Server if either of these stops.

Page 95: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 95

Performing Broker Capacity Planning

Performing Broker Capacity Planning

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to help you perform capacity planning for your brokers.

CandleMonitor node requirementsTo properly determine the message count for messages sent from one application to another, you will need two CandleMonitor nodes within the monitored message flow:

� Place one CandleMonitor node just following the MQInput node so that the entry of the message into the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “input”.

� Place one CandleMonitor node just prior to the MQOutput node so that the exit of the message from the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “output”.

What you will need to doOnce you have placed and set the CandleMonitor nodes as described above, allow OMEGAMON XE for WebSphere Integration Brokers to run so that the product can gather the appropriate statistics, then do the following:

1. Open the various Statistics workspaces, such as Message Flow Statistics for individual message flows, Execution Group Statistics for summarization over an entire execution group, or Broker Statistics for summarization over an entire broker.

2. Examine the workspace statistics and further link to their historical workspaces as well. If necessary, refer to the CandleNet Portal online Help for information on performing this procedure.

3. If you find that for a particular message flow the Current Message Input Rate is higher than expected, or the Current Average Queue Time is elongated, add more instances to the flow within Control Center or Message Brokers Toolkit.

Page 96: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Performing Broker Capacity Planning

96 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

4. If you find that for a particular execution group the Current Message Input Rate is higher than expected, or the Current Average Queue Time is elongated, add a new execution group and assign instances as appropriate.

5. If you find that for a particular broker the Current Message Input Rate is higher than expected, or the Current Average Queue Time is elongated, consider adding a new broker with a configuration that will offload some processing from the current broker.

Page 97: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 97

Ensuring Adequate Message Flow Response Time

Ensuring Adequate Message Flow Response Time

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to help you ensure that the response times from your message flows are adequate to meet your site’s needs.

CandleMonitor node requirementsTo properly determine the message count for messages sent from one application to another, you will need two CandleMonitor nodes within the monitored message flow:

� Place one CandleMonitor node just following the MQInput node so that the entry of the message into the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “input”.

� Place one CandleMonitor node just prior to the MQOutput node so that the exit of the message from the message flow will be recorded. The “type” attribute for this CandleMonitor node must be set to “output”.

What you will need to doOnce you have placed and set the CandleMonitor nodes as described above, allow OMEGAMON XE for WebSphere Integration Brokers to run so that the product can gather the appropriate statistics, then do the following:

1. Open the Message Flow Statistics workspace for individual message flows. For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

2. Examine the workspace statistics and further link to their historical workspaces as well. If necessary, refer to the CandleNet Portal online Help for information on performing this procedure.

3. If you find that for a particular message flow the Current Average Flow Time is higher than expected, debug the message flow as described in “Debugging a Message Flow” on page 89. Comparing the Average Flow Times for each section of the message flow will help you identify where time is being lost.

Page 98: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Preventing Inadvertent Use of Trace Active

98 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Preventing Inadvertent Use of Trace Active

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used guard against trace active inadvertently being used and affecting broker performance.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

1. Use CandleNet Portal to define a situation for the Broker Information, Execution Group Information, and Message Flow Information workspaces to check that the Trace Level and User Trace Level attributes are not equal to “none”. This will trigger an alert whenever trace is active so that you can determine whether the tracing activity is valid. If necessary, refer to CandleNet Portal online Help or the Administering OMEGAMON Products: CandleNet Portal guide for information on defining a situation.

Page 99: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 99

Starting and Stopping Message Flows at Periodic Intervals

Starting and Stopping Message Flows at Periodic Intervals

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used to automatically start and stop message flows at certain times of the day.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

For individual message flows

1. Use CandleNet Portal to define a situation for the Message Flow Information workspace’s Status attribute with additional matches for the Local Time attribute. This will determine when a message flow should be started or stopped. If necessary, refer to CandleNet Portal online Help or the Administering OMEGAMON Products: CandleNet Portal guide for information on defining a situation.

2. Set the action for the situation to use the “QI Start Message Flow(s)” or “QI Stop Message Flow(s)” reflex automation/Take Action command to start or stop the message flow by specifying both the execution group name argument as well as the message flow name argument.

For all message flows within an execution group

1. Use CandleNet Portal to define a situation for the Execution Group Information workspace’s Started Message Flows attribute with additional matches for the Local Time attribute. This will determine when all message flows within the execution group should be started or stopped. If necessary, refer to CandleNet Portal online Help or the Administering OMEGAMON Products: CandleNet Portal guide for information on defining a situation.

2. Set the action for the situation to use the “QI Start Message Flow(s)” or “QI Stop Message Flow(s)” reflex automation/Take Action command to start or stop all message flows by specifying only the execution group name argument

Page 100: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Starting and Stopping Message Flows at Periodic Intervals

100 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

and no message flow name argument. For additional detail about the “QI Start Message Flow(s)” or “QI Stop Message Flow(s)” commands, refer to “Take Action Commands” on page 108.

Page 101: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Usage Scenarios 101

User Not Receiving All Publications to Subscriptions

User Not Receiving All Publications to Subscriptions

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used by an application user with no access to the Control Center to verify their subscriptions.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

1. Open the Subscriptions workspace for each broker from which the user expects their application to be receiving publications.

2. If the user’s subscription only appears in a single broker, examine the report data to determine if the user has specified the “Local” option for the subscription by viewing the Local Only column for a value of “Yes”. This setting will prevent the subscription from being propagated to neighboring brokers.

Page 102: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

User’s Subscription to Topic Fails Security

102 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

User’s Subscription to Topic Fails Security

IntroductionThis scenario describes how OMEGAMON XE for WebSphere Integration Brokers can be used when a user’s application attempts to subscribe to a topic and fails security.

What you will need to doOnce you have configured OMEGAMON XE for WebSphere Integration Brokers, allow the product to run so that the product can gather the appropriate information, then do the following:

1. Open the ACL Entries workspace to determine if the application’s user ID matches a “Principal” that is allowed “Subscribe” access to the desired topic, or if its user ID is a member of a group that matches a “Principal” which allows “Subscribe” access to the topic.

Page 103: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 103

Situations andTake Action Commands

IntroductionThis chapter describes the predefined situations and Take Action commands provided with OMEGAMON XE for WebSphere Integration Brokers.

Chapter contentsPredefined Situations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Take Action Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

5

Page 104: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Predefined Situations

104 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Predefined Situations

IntroductionOMEGAMON XE for WebSphere Integration Brokers provides predefined situations. Most predefined situations are designed to enable you to monitor critical activity and serve as templates for creating customized situations for your own use.

The predefined situations for this product have names which begin with the letters “QI”.

Predefined situations are activated when they are distributed to the node that you wish to monitor. Once they have been configured correctly, the situation alerts provided with OMEGAMON XE for WebSphere Integration Brokers will trigger event notification.

For information on creating or modifying situations, refer to CandleNet Portal online Help or the Administering OMEGAMON Products: CandleNet Portal guide.

Note: Candle suggests that if you choose to modify a predefined situation, you make a copy and modify it, preserving the original to ensure fallback if necessary.

AlertsThe following situations issue alerts based on critical status criteria. Except where noted, these situations apply to broker managed systems. Alerts will be raised if:

� The Broker Information.Broker Status value is found to be not started. (QI_Broker_Not_Started)

� The Broker Information.Queue Manager Status value is found to be not connected.(QI_Broker_QMgr_Not_Connected)

� A Broker Events row occurs for a Status Stop event. (QI_Status_Stop_Event)

� A Message Flow Events row occurs.(QI_Message_Flow_Events)

Page 105: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 105

Predefined Situations

� A Product Events row occurs. This situation applies to agent managed systems.(QI_Product_Events)

� A Broker Events row occurs for a Publication Expiration event type. (QI_Publication_Expiry_Event)

� A Broker Events row occurs for a Subscription Expiration event type. (QI_Subscription_Expiry_Event)

� The Message Flow Statistics.Average Flow Seconds value is found to exceed a threshold.(QI_Average_Flow_Time High)

� The Components.Component Status value is found to be not started. This situation demonstrates reflex automation: if the situation becomes true, the proper command is issued to start the component. This situation applies to agent managed systems.(QI_Automation_Start_Component)

Historical situationsThe following situations are provided to track table data historically. Except where noted, these situations apply to broker managed systems. Historical data is available by specifying time-spans in a workspace for a report.

The following historical situations are active upon product installation:

� A Broker Information log entry is added every 15 minutes (one row per broker).

� If a Broker Events row occurs, an entry is added to the historical log.

� If a Message Flow Events row occurs, an entry is added to the historical log.

� If a Product Events row occurs, an entry is added to the historical log. This situation applies to agent managed systems.

� A Broker Statistics log entry is added every 15 minutes (one row per broker).

� An Execution Group Statistics log entry is added every 15 minutes (one row per execution group).

� A Message Flow Statistics log entry is added every 15 minutes (one row per message flow per execution group).

Page 106: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Predefined Situations

106 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

� A Sub-Flow Statistics log entry is added every 15 minutes (one row per monitored sub-flow per message flow containing the sub-flow).

� A CandleMonitor Node Statistics log entry is added every 15 minutes (one row per node per CandleMonitor node).

� A Message Flow Accounting log entry is added for each IBM Message Flow Accounting and Statistics record produced.

� A Thread Accounting log entry is added for each IBM Message Flow Accounting and Statistics record produced.

� A Node Accounting log entry is added for each IBM Message Flow Accounting and Statistics record produced.

� A Terminal Accounting log entry is added for each IBM Message Flow Accounting and Statistics record produced.

Note:The preceding four historical situations gather data only if IBM produces it. Also, by default, the agent collects historical data only for Archive data, not Snapshot. See “defaultHistoricalAccountingType” on page 48 and “historicalAccountingType” on page 52 for more information.

� A Components log entry is added every 15 minutes (one row per WebSphere Business Integration component created on your system). This situation applies to agent managed systems.

The following historical situations are inactive upon product installation. To activate them, you must activate historical data collection for the indicated product attribute group. Note each attribute group corresponds to a product workspace. Information about using the Historical Data Collection function can be found in the CandleNet Portal online Help and in the Historical Data Collection Guide for OMEGAMON XE and CandleNet Command Center.

� An Execution Group Information log entry is added every 15 minutes (one row per execution group).

� A Message Flow Information log entry is added every 15 minutes (one row per message flow).

� A Message Processing Node Information log entry is added every 15 minutes (one row per message processing node).

� A Neighbors log entry is added every 15 minutes (one row per neighbor connection).

Page 107: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 107

Predefined Situations

� An ACL Entries log entry is added every 15 minutes (one row ACL entry per topic).

� A Subscriptions log entry is added every 15 minutes (one row per subscription).

� A Retained Publications log entry is added every 15 minutes (one row per retained publication).

Page 108: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Take Action Commands

108 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Take Action Commands

IntroductionTake Action commands allow you to quickly initiate commands from within OMEGAMON XE for WebSphere Integration Brokers. These commands would otherwise have to be entered either from a command prompt, or from the WebSphere Business Integration Control Center.

You can invoke the commands presented here from the Take Action view, from a situation (when it becomes true), from the Navigator, or from a row in a table view. For more information on how to send a command, refer to the CandleNet Portal online Help.

The Take Action commands for this product (commands sent to this product’s agent) have names which begin with the characters “QI:”.

Who can issue Take Action commands?You can configure OMEGAMON XE for WebSphere Integration Brokers so that only a designated set of users can successfully issue its Take Action commands. Authorized Take Action users can be specified:

� at the agent level, using the defaultTakeActionAuthUsers parameter.

� at the monitored broker level, using the takeActionAuthUsers parameter.

See “Agent Parameter Descriptions” on page 44 for details.

Command restrictions on OS/390 and z/OSOn OS/390 and z/OS: The Take Action commands for OMEGAMON XE for WebSphere Integration Brokers require the broker name to be the same as the started task procedure name that is started or stopped for the broker.

On OS/390 and z/OS: This product will not start or stop a queue manager.

If you find it necessary to issue a command that is not supported by the agent, you can issue it as a system command (an OS/390 console command) instead. Use the exact syntax of the command as documented by IBM.

Note that the exact command issued by the agent varies based on the host platform on which the agent runs (chiefly for OS/390 and z/OS). Also, although the commands can be issued by the agent on all supported

Page 109: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 109

Take Action Commands

platforms, some differences exist in the supported actions (again, chiefly for OS/390 and z/OS). Differences in actions, if they exist, are noted for each command.

Commands for agent managed systemsThe Take Action commands for OMEGAMON XE for WebSphere Integration Brokers agent managed systems are described below.

Note: The name of the Component in the commands described below can be a broker name, ConfigMgr (on Windows), or UserNameServer unless otherwise noted.

QI Start Component

The “QI Start Component” command starts a WebSphere Business Integration component.

On UNIX and Windows: This command will also start the component's associated queue manager if it is not already active.

On Windows only: This command can also be used to start the configuration manager (component=ConfigMgr).

On OS/390 and z/OS: This product will not start a queue manager, see “Command restrictions on OS/390 and z/OS” on page 108. This command cannot be used to start a user name server (component=UserNameServer).

Identify the component to be started by specifying its name within the Edit Argument pop-up. The destination of this command must be set to the agent managed system.

The syntax of the command sent to the agent is:

QI:mqsiStart ‘ComponentName’

QI Stop Component

The “QI Stop Component” command stops a WebSphere Business Integration component.

On Windows only: This command can also be used to stop the configuration manager (component=ConfigMgr).

On OS/390 and z/OS: This command cannot be used to stop a user name server (component=UserNameServer).

Page 110: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Take Action Commands

110 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Identify the component to be stopped by specifying its name within the Edit Argument pop-up. The destination of this command must be the agent managed system.

The syntax of the command sent to the agent is:

QI:mqsiStop ‘ComponentName’

QI Stop Component and its Queue Manager

On UNIX and Windows: The “QI Stop Component and its Queue Manager” command stops the WebSphere Business Integration component and its associated queue manager.

On Windows only: This command can also be used to stop the configuration manager (component=ConfigMgr).

On OS/390 and z/OS: This product will not stop a queue manager see “Command restrictions on OS/390 and z/OS” on page 108. Therefore the action of the “QI Stop Component and its Queue Manager” command is the same as for the “QI Stop Component” command; it stops a WebSphere Business Integration component.

Identify the component to be stopped by specifying its name within the Edit Argument pop-up. The destination of this command must be the agent managed system.

The syntax of the command sent to the agent is:

QI:mqsiStop-q ‘ComponentName’

QI Change Trace Component

The “QI Change Trace Component” command changes the trace characteristics for WebSphere Business Integration components.

On Windows only: This command can also be used to change trace characteristics for the configuration manager (component=ConfigMgr).

Identify the component by specifying its name within the top field of the Edit Argument pop-up. If the component name contains spaces, the entire string must be enclosed within two sets of double quotes (for example, ““aaaaaa bbbb cc””). Specify the new trace parameters within the lower field of the Edit Argument pop-up. The format of the argument should use the same format as used by IBM's ‘mqsichangetrace’ command, using two sets of double quotes for any double quotes used. For change trace commands targeted to z/OS

Page 111: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 111

Take Action Commands

brokers, follow the IBM Customization and Administration Guide precisely for the ‘changetrace’ command parameters, except use two sets of double quotes instead of single quotes. Remember that on z/OS any lowercase label names must be in quotes, and commas must separate parameters. For example, on OS/390 and z/OS, supply this argument to turn on normal trace for the default execution group:

u=yes,e=""default"",l=normal

On another broker platform, the following argument has the same result:

-u -e default -l normal

The destination of this command must be the agent managed system.

The syntax of the command sent to the agent is:

QI:mqsiChangeTrace ‘ComponentName’ ‘Parms’

Commands for broker managed systemsThe Take Action commands for OMEGAMON XE for WebSphere Integration Brokers broker managed systems are described below.

QI Start Broker

The “QI Start Broker” command starts a WebSphere Business Integration broker.

On OS/390 and z/OS: The product does not currently support the “f broker,startcomponent” command form of starting the broker. The “s broker” command form is used.

Specify the name of the broker to be started within the Edit Argument pop-up. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:mqsiStart ‘BrokerName’

QI Stop Broker

The “QI Stop Broker” command stops a WebSphere Business Integration broker.

On OS/390 and z/OS: The product does not currently support the “f broker,stopcomponent” command form of stopping the broker. The “p broker” command form is used.

Page 112: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Take Action Commands

112 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Specify the name of the broker to be stopped within the Edit Argument pop-up. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:mqsiStop ‘BrokerName’

QI Stop Broker and its Queue Manager

On UNIX and Windows: The “QI Stop Broker and its Queue Manager” command stops the WebSphere Business Integration broker and its associated queue manager.

On OS/390 and z/OS: This product will not stop a queue manager see “Command restrictions on OS/390 and z/OS” on page 108. Therefore the action of the “QI Stop Broker and its Queue Manager” command is the same as for the “QI Stop Broker” command; it stops a WebSphere Business Integration broker.

Specify the name of the broker to be stopped within the Edit Argument pop-up. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:mqsiStop-q ‘BrokerName’

QI Change Trace Broker

The “QI Change Trace Broker” command changes the trace characteristics for WebSphere Business Integration brokers.

Identify the broker by specifying its name within the top field of the Edit Argument pop-up. If the broker name contains spaces, the entire string must be enclosed within two sets of double quotes (for example, ““aaaaaa bbbb cc””). Specify the new trace parameters within the lower field of the Edit Argument pop-up. The format of the argument should use the same format as used by IBM's ‘mqsichangetrace’ command, using two sets of double quotes for any double quotes used. For change trace commands targeted to z/OS brokers, follow the IBM Customization and Administration Guide precisely for the ‘changetrace’ command parameters, except use two sets of double quotes instead of single quotes. Remember that on z/OS any lowercase label names must be in quotes, and commas must separate parameters. For example, on OS/390 and z/OS, supply this argument to turn on normal trace for the default execution group:

u=yes,e=""default"",l=normal

Page 113: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 113

Take Action Commands

On another broker platform, the following argument has the same result:

-u -e default -l normal

The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:mqsiChangeTrace ‘BrokerName’ ‘Parms’

QI Change Broker

The “QI Change Broker” command enables you to change the archive interval for the broker from CandleNet Portal. Several other broker properties may also be modified using this command.

Identify the broker by specifying its name within the top field of the Edit Argument pop-up. If the broker name contains spaces, the entire string must be enclosed within two sets of double quotes (for example, ““aaaaaa bbbb cc””). Specify the new trace parameters within the lower field of the Edit Argument pop-up. The format of the argument should use the same format as used by IBM's mqsichangebroker command, using two sets of double quotes for any double quotes used. For change broker commands targeted to z/OS brokers, follow the IBM Customization and Administration Guide precisely for the changebroker command parameters, except use two sets of double quotes instead of single quotes. Remember that on z/OS any lowercase label names must be in quotes, and commas must separate parameters.

The syntax of the command agent is sent to the agent is:

QI:mqsiChangeBroker" ‘BrokerName’ ‘Parms’

The BrokerName gives the name of the broker that is being targeted. The Parms give the rest of the desired parameters (minus the broker name) that are required or optional for the mqsichangebroker (changebroker on z/OS) command as documented by IBM. Note that CandleNet Portal does not parse or verify the parameters.

QI Change Flow Stats

The “QI Change Flow Stats” command enables you to activate or inactivate Message Flow Accounting and Statistics from CandleNet Portal.

Identify the broker by specifying its name within the top field of the Edit Argument pop-up. If the broker name contains spaces, the entire string must be enclosed within two sets of double quotes (for example, ““aaaaaa bbbb

Page 114: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Take Action Commands

114 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

cc””). Specify the new trace parameters within the lower field of the Edit Argument pop-up. The format of the argument should use the same format as used by IBM's mqsichangeflowstats command, using two sets of double quotes for any double quotes used. For change trace commands targeted to z/OS brokers, follow the IBM Customization and Administration Guide precisely for the changeflowstats command parameters, except use two sets of double quotes instead of single quotes. Remember that on z/OS any lowercase label names must be in quotes, and commas must separate parameters.

The syntax of the command sent to the agent is:

QI:mqsiChangeFlowStats ‘BrokerName’ ‘Parms’

The BrokerName gives the name of the broker that is being targeted. The Parms give the rest of the desired parameters (minus the broker name) that are required or optional for the mqsichangeflowstats (changeflowstats on z/OS) command as documented by IBM. Note that CandleNet Portal does not parse or verify the parameters. If you want data in the accounting workspaces, you must specify “xml” as the output (-o xml).

QI Start Message Flow(s)

The “QI Start Message Flow(s)” command starts one or all of the message flows associated with an execution group. Identify the execution group to which the message flow belongs within the top field of the Edit Argument pop-up. Specify the message flow to be started within the lower field of the Edit Argument pop-up. Leaving the lower field blank will cause the command to start all message flows within the execution group. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:mflowStart ‘ExecutionGroup’ ‘MessageFlow’

QI Stop Message Flow(s)

The “QI Stop Message Flow(s)” command stops one or all of the message flows associated with an execution group. Identify the execution group to which the message flow belongs within the top field of the Edit Argument pop-up. Specify the message flow to be stopped within the lower field of the Edit Argument pop-up. Leaving the lower field blank will cause the command to stop all message flows within the execution group. The destination of this command must be a broker managed system.

Page 115: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 115

Take Action Commands

The syntax of the command sent to the agent is:

QI:mflowStop ‘ExecutionGroup’ ‘MessageFlow’

QI Delete Retained Publication

The “QI Delete Retained Publication” command deletes a retained publication for the given topic and subscription point. Identify the topic of the publication to be deleted within the top field of the Edit Argument pop-up. Identify the subscription point of the publication to be deleted within the lower field of the Edit Argument pop-up. If no subscription point is specified, the publication for the default subscription point will be deleted. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:retainedPubDelete ‘Topic’ ‘SubscriptionPoint’

QI Create User Statistics

The “QI Create User Statistics” command creates user statistics associated with the CandleNet Portal logon ID that issues the command.

The logon ID used to create the statistics must be used to view them. In the Edit Argument pop-up, specify the amount of time in minutes that the user statistics created by this command will be allowed to stay in the agent without being sampled or queried for display. If no time is specified, the data will be stored until the Destroy User Statistics command is issued. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:createUserStatistics ‘MaxInactivityTime’

QI Sample User Statistics

The “QI Sample User Statistics” command causes the agent to take a sample of CandleMonitor statistics for the CandleNet Portal logon ID that issues the command. A “QI Create User Statistics” command must have previously been issued for the logon ID for this command to be valid. This command allows you complete control over the period of time (sample interval) represented by the “current” statistics in statistics workspaces. Candle suggests that one “QI Sample User Statistics” command be issued at the beginning of an ad-hoc sample interval and another “QI Sample User Statistics” command at the end of the period. The destination of this command must be a broker managed system.

Page 116: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Take Action Commands

116 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

The syntax of the command sent to the agent is:

QI:sampleUserStatistics

QI Destroy User Statistics

The “QI Destroy User Statistics” command cleans up all user statistics data associated with the CandleNet Portal logon ID that issues the command and ensures that the agent no longer holds this storage. It is important for the storage to be released when it is no longer required. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:destroyUserStatistics

QI Reset Statistics

The “QI Reset Statistics” command resets the statistics collected by the CandleMonitor node to zeroes. It resets all statistics for all nodes in the broker. It updates the shared area so that all uses of these statistics (regular or user) are affected. Without this command, the statistics are reset automatically during a deployment of the broker or when overflow is detected. This command gives you the ability to start over at zero especially for the “overall” statistics when they are being used to do controlled timings, for example of particular sub-flows. Note that it is not possible to reset statistics for only part of a broker because this will cause inconsistent data in Broker Statistics reports and in all historical data reports.

Candle recommends that you issue this command during a period of broker inactivity. Otherwise, the results may not be as expected, in that some statistics may not appear to have been reset because of current activity. The destination of this command must be a broker managed system.

The syntax of the command sent to the agent is:

QI:resetStatistics

Using Take Action commands in situationsYou can use the commands described in this section in situations that you write. This feature of situations is built-in to OMEGAMON products and is documented in CandleNet Portal online Help and in the Administering OMEGAMON Products: CandleNet Portal guide. The term “reflex automation” refers to a situation that issues a command.

Page 117: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Situations and Take Action Commands 117

Take Action Commands

To issue one of this agent’s commands from a situation, enter the “QI:” syntax form of the command on the Action tab of the Situations Editor. Shown below is an example of the “QI Start Component” command used in a situation.

This example is from predefined situation QI_Automation_Start_Component, which substitutes an attribute from this product’s Components workspace. The Attribute Subsitution button was used to choose the attribute (this prevents misspellings and inserts the ampersand character which is needed for attribute substitution). Note that the single quotes enclosing the command parameter are required. In all cases we recommend that you create a working, manual version of a Take Action command before attempting to automate its use by adding it to a situation.

Page 118: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Take Action Commands

118 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Page 119: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 119

Workspaces

IntroductionThis chapter introduces the workspaces provided in the OMEGAMON XE for WebSphere Integration Brokers user interface.

Chapter contentsAbout Workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121ACL Entries Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Agent Status Workspace (Agent-Level Summary) . . . . . . . . . . . . . . . . . . 131Archive Message Flow Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Archive Node Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Archive Terminal Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Archive Thread Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Broker Events Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Broker Information Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Broker Statistics Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Broker Status Workspace (broker-level summary) . . . . . . . . . . . . . . . . . . 147Broker Summary Workspace (multiple brokers monitored) . . . . . . . . . . . 148CandleMonitor Node Statistics Workspace . . . . . . . . . . . . . . . . . . . . . . . 149Components Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Execution Group Information Workspace . . . . . . . . . . . . . . . . . . . . . . . . 153Execution Group Statistics Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . 154Message Flow Events Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Message Flow Information Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . 158

6

Page 120: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

120 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Message Flow Statistics Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Message Processing Node Attributes Workspace . . . . . . . . . . . . . . . . . . . 162Message Processing Node Information Workspace . . . . . . . . . . . . . . . . . 164Message Processing Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Neighbors Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Product Events Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Retained Publications Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Snapshot Message Flow Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Snapshot Node Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Snapshot Terminal Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Snapshot Thread Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Sub-Flow Statistics Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Subscriptions Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Page 121: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 121

About Workspaces

About Workspaces

OverviewOMEGAMON XE for WebSphere Integration Brokers is installed with default views that are displayed in workspaces. Where applicable, links have been provided within the workspace to link from a parent view to a more detailed view about a selected row, or to a related workspace (for example, a workspace containing historical information).

The format and appearance of the views within a workspace may be customized to suit your preferences.

Note: Candle recommends that you customize a copy of the workspace and not the product-provided one. Use the Save as . . . command to copy the workspace with a new name and make the changes to the copy. You can set the workspace created in this manner to be the default workspace for a given Navigator item. If you do not replace the product-provided workspaces, you will be able to see new features that may become available in later versions of the product without having to revert to the original workspace.For information on customizing workspaces and views, refer to the CandleNet Portal online Help.

The following sections provide information about various groups of workspaces. For detailed descriptions of individual attributes within a workspace, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

PrerequisitesThe availability of some data and statistics depends on prior conditions. If these conditions are not met, no information will be available in the workspace. For example, you may need to configure historical data collection in order to view workspaces containing historical information (see the CandleNet Portal online Help and the Historical Data Collection Guide for OMEGAMON XE and CandleNet Command Center). In particular:

� For archive or snapshot accounting data to be available, brokers must be configured to collect it and the destination of the statistics output (-o) must be "xml".

Page 122: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About Workspaces

122 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

You can use the QI Change Flow Stats Take Action Command to configure broker collection of archive or snapshot accounting statistics from CandleNet Portal.

� For user statistics to be available, the QI Create User Statistics Take Action command must have been issued for the user's logon ID.

� For message flow and sub-flow statistics and events to be available, CandleMonitor nodes must be included in the message flow (see “Configuring the CandleMonitor Node” on page 57).

� For accounting origin information to be available in accounting workspaces, participating message flows must be configured to provide the appropriate origin identifier. As described in the IBM documentation, this involves coding an ESQL statement in a Compute, Database, or Filter node that sets the desired value. In addition, the mqsichangeflowstats command used to start data collection must be issued with the parameter “-b basic".

If you do not specify a value, the Accounting Origin column in the Accounting workspaces will display the value “Anonymous”.

User statisticsIn a development environment, sampling for statistics at a set interval may not afford the flexibility required. The user statistics feature, implemented by three Take Action commands, allows for user-controlled sampling of statistics associated associated with a particular CandleNet Portal logon ID. These user statistics are displayed in the statistics workspaces from which they are derived and can be linked to from related statistics workspaces, as shown in the following table.

Workspace User Statistics Links

Broker StatisticsUser Broker Statistics

User Execution Group Statistics

Execution Group StatisticsUser Execution Group Statistics

User Message Flow Statistics

Page 123: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 123

About Workspaces

A QI Create User Statistics Take Action command for the user’s logon ID must be issued before the user statistics workspaces can be accessed. If a link is taken before the command been issued for the logon ID, no data will be available in the linked-to workspace.

Note that user statistics are not collected historically.

Snapshot and archive accounting statistics With Version 5 of its WebSphere Business Integration brokers, IBM provides two types of accounting and statistics data for message flows: snapshot and archive. Either or both types of collection can be turned on for all message flows in a broker, all message flows in an execution group, or individual message flows within an execution group. The actual data produced for both types is equivalent; however, the user has some control over how much detail is provided.

The snapshot type of data is collected over 20 second intervals (producing data every 20 seconds). This type of data collection is not done for prolonged periods of time due to the assumed expense of putting out data every 20 seconds. The second type, archive, puts out data over a configurable interval that defaults to 60 minutes on Windows. This data is for use in more long-term accounting and statistics collection.

OMEGAMON XE for WebSphere Integration Brokers displays IBM’s accounting and statistics data in a set of workspaces. You can view data for the current collection interval, the most recent intervals, or for historical collection intervals.

Message Flow Statistics

User Message Flow Statistics

User Sub-Flow Statistics

User CandleMonitor Node Statistics

Sub-Flow StatisticsUser Sub-Flow Statistics

User CandleMonitor Node Statistics

CandleMonitor Node Statistics User CandleMonitor Node Statistics

Workspace User Statistics Links

Page 124: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About Workspaces

124 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

While there is considerable overlap between the accounting statistics provided by WebSphere Business Integration brokers and the statistics provided by the CandeMonitor node, the CandeMonitor node statistics provide a high-level view (by broker and execution group), while the accounting statistics provide a more fine-grained view (by terminal and thread). User statistics, sub-flow statistics, queue times, and message flow events are available only if you are collecting statistics using CandeMonitor node. CPU time is available only with accounting statistics.

Note that OMEGAMON XE for WebSphere Integration Brokers historical data collection allows you to track the archive statistics without purchasing or developing a second application.

Important

Brokers must be set properly to collect the data provided by the accounting workspaces. If you have not set the brokers to collect the level of detail given in a certain workspace, no data is displayed. In addition, you must set the output destination for the accounting and statistics data to “xml”. See “QI Change Flow Stats” on page 113 and the details of the IBM mqsichangeflowstats command in IBM manuals to determine how to set the broker to collect the desired statistics.

If you intend to use the accounting origin support to organize your data, you must configure participating message flows to provide the appropriate origin identifier. As described in the IBM documentation, this involves coding an ESQL statement in either a Compute,Database, or Filter node that sets the desired value. In addition, the mqsichangeflowstats command used to start data collection must be issued with the parameter “-b basic".

Reset of statisticsCumulative statistics with “Overall” attribute names are maintained internally at the CandleMonitor node level. These statistics are simultaneously reset to 0 for all CandleMonitor nodes when a deploy operation to a broker involves any message flow containing a CandleMonitor node, when any CandleMonitor node detects an overflow condition for statistics, or when the Reset Statististics Take Action command has been issued.

A reset of statistics includes all statistics maintained for the broker in order to preserve the integrity of summarized statistics. The CandleMonitor node produces an Event Log message when a reset occurs due to a numerical

Page 125: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 125

About Workspaces

overflow condition, and the monitoring agent logs a message when a reset is detected.

At the time of a reset of statistics, workspaces will show that the “Overall” statistics have started over from zero.

Historical workspaces will show data prior to the reset combined with data following the reset for the interval in which the reset occurred. This ensures that no historical data is lost. In subsequent intervals, the historical workspaces will show the “Overall” values as having started over from zero.

Print to disk featureA CandleNet Portal “Print to disk…” command is available for statistics and accounting workspaces. When selected, this command brings up a file dialog in which you can specify the file in which the data is to be written. The command places the column values in the rows in the current report as comma separated lists in the output file in the same order as displayed in the report. The output file can then be used externally, for example to populate a spreadsheet.

To use print to disk, in the statistics workspaces only, right click on a row in the table display and select Print to disk from the popup menu. You will be prompted to give the location and name of the file. If you select an existing file, you will be asked whether you want to append, overwrite, or abort. Note that even though a single row is selected to invoke Print to disk, all rows shown in the table display are printed. When there are no rows in the table display, or if more than one row is selected, the command does not appear as an option.

Note: The “Print to disk” command is available only in the CandleNet Portal Desktop client.

Upgrading workspacesIf you have upgraded an existing installation and you previously modified and saved Candle-provided Statistics workspaces, you will not see the new features such as the links to users statistics workspaces and the Print to Disk option. To pick up the new features you should revert to the Candle-provided workspace by following these steps:

1. In the Navigator pane, select the particular Statistics workspace that was changed that it is the workspace showing on your screen.

Page 126: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About Workspaces

126 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

2. On the File menu select Restore Original Workspace.

3. Refresh the workspace. You should now be able to use the new features.

Workspace summary

Agent and application status workspaces� The Agent Status workspace summarizes event and WebSphere

Business Integration brokers component information at the agent level.

See “Agent Status Workspace (Agent-Level Summary)” on page 131.

� The Components workspace displays a list of WebSphere Business Integration brokers components and their state at the agent level.

See “Components Workspace” on page 151.

� The Broker Summary workspace summarizes broker status and definition data when multiple brokers are monitored by the same agent.

See “Broker Summary Workspace (multiple brokers monitored)” on page 148.

� The Broker Status workspace summarizes event and definition information at the broker level.

See “Broker Status Workspace (broker-level summary)” on page 147

Broker and message flow Information workspaces� The Broker Information workspace displays the activity status of the

broker, names the broker’s associated queue manager, and indicates whether or not the agent can connect to the broker’s queue manager. See “Broker Information Workspace” on page 143.

� The Execution Group Information workspace displays execution groups defined for the broker as well as definition information for each execution group. See “Execution Group Information Workspace” on page 153.

� The Message Flow Information workspace displays defined message flows by execution group as well as definition information for each. See “Message Flow Information Workspace” on page 158.

Page 127: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 127

About Workspaces

� The Message Processing Node Information workspace displays defined message processing nodes by their execution group and message flow. See “Message Processing Node Information Workspace” on page 164.

– The Message Processing Nodes workspace lists all message processing nodes in the enterprise that have the same queue name (when you link from a row in the Message Processing Node Information workspace). See “Message Processing Nodes” on page 166.

– The Message Processing Node Attributes workspace displays all attribute values for a message processing node (when you link from a row in the Message Processing Node Information workspace). See “Message Processing Node Attributes Workspace” on page 162.

Events workspaces� The Product Events workspace displays product events generated by

the agent when a problem occurs that affects the agent's ability to collect WebSphere Business Integration brokers data.

See “Product Events Workspace” on page 168.

� The Broker Events workspace lists events generated by the WebSphere Business Integration brokers broker as they occur.

See “Broker Events Workspace” on page 141.

� The Message Flow Events workspace lists events generated by the CandleMonitor node as they occur.

See “Message Flow Events Workspace” on page 156.

Statistics workspaces� The Broker Statistics workspace provides message flow statistics

summarized at the broker level.

See “Broker Statistics Workspace” on page 145.

� The CandleMonitor Node Statistics workspace provides message flow statistics at the individual node level at which they are collected.

See “CandleMonitor Node Statistics Workspace” on page 149.

Page 128: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

About Workspaces

128 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

� The Execution Group Statistics workspace provides message flow statistics summarized at the execution group level.

See “Execution Group Statistics Workspace” on page 154.

� The Message Flow Statistics workspace provides message flow statistics summarized at the message flow level.

See “Message Flow Statistics Workspace” on page 160.

� The Sub-Flow Statistics workspace provides statistics summarized at the sub-flow level.

See “Sub-Flow Statistics Workspace” on page 180.

Accounting workspaces

Accounting workspaces provide WebSphere Business Integration brokers statistics at message flow, node, thread, and terminal level. The data in the workspaces is sampled at a snapshot (short term) or archive (long term) intervals. Top level snapshot and archive workspaces present current accounting data for that interval. Each workspace links to workspaces showing the same data for the most recent collection intervals and for historical collected data, if configured.

The Snapshot Message Flow Accounting and Archive Message Flow Accounting workspaces provide statistics at the message flow level.

See “Snapshot Message Flow Accounting” on page 171 and “Archive Message Flow Accounting” on page 132.

The Snapshot Node Accounting and Archive Node Accounting workspaces provide statistics at the processing node level.

See “Snapshot Node Accounting” on page 174 and “Archive Node Accounting” on page 135.

The Snapshot Terminal Accounting and Archive Terminal Accounting workspaces provide statistics at the terminal level.

See “Snapshot Terminal Accounting” on page 176 and “Archive Terminal Accounting” on page 137.

The Snapshot Thread Accounting and Archive Thread Accounting workspaces provide statistics at the thread level.

Page 129: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 129

About Workspaces

See “Snapshot Thread Accounting” on page 178 and “Archive Thread Accounting” on page 139.

Publish/Subscribe workspaces� The ACL Entries workspace displays ACL entries per topic, which define

access to topics for publish and subscribe.

See “ACL Entries Workspace” on page 130.

� The Neighbors workspace displays a list of neighbors to the broker in the publish and subscribe topology, as well as their connection attributes.

See “Neighbors Workspace” on page 167.

� The Retained Publications workspace displays a list of topic and subscription points that have a retained publication.

See “Retained Publications Workspace” on page 170.

� The Subscriptions workspace displays a list of subscriptions to topics.

See “Subscriptions Workspace” on page 182.

Page 130: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

ACL Entries Workspace

130 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

ACL Entries Workspace

DescriptionThe ACL Entries workspace is selectable for the broker managed system. It displays Access Control List entries per topic, which define access to topics for publish and subscribe.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� ACL Entries shows, as a table, all ACL Entries for the broker.

Information presented in the ACL Entries table viewThe ACL Entries table view displays data provided by the ACL Entries attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

� Broker� Origin Node� Persistent� Principal

� Publish� Subscribe� Topic

Page 131: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 131

Agent Status Workspace (Agent-Level Summary)

Agent Status Workspace (Agent-Level Summary)

DescriptionThe Agent Status workspace is selectable for the agent managed system. It summarizes event and WebSphere Business Integration brokers component information at the agent level.

Default viewsThis workspace contains the following default views:

� Product Events shows, as a table, the most recent retained product events.

� Components shows, as a table, all created components on the system that the agent is monitoring.

Accessing this workspaceTo access this workspace, in the Navigator physical view select the QI Agent folder icon.

Page 132: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Archive Message Flow Accounting

132 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Archive Message Flow Accounting

DescriptionThis workspace provides statistics pertaining to entire message flows, for the current archive collection interval. In this top-level view, there is one row per monitored message flow, giving the data for the message flow for the current collection interval. The interval at which data is collected is configured at the broker.

If the broker has not been set to collect this type of data, no data will be displayed. The data shown in this view is available for situations by default.

Default viewsThis workspace contains the following default views:

� Message Flow Elapsed Time shows, as a bar chart, the minimum, maximum, and average time, in microseconds, spent processing messages during the current archive interval.

� Message Flow CPU Time shows, as a bar chart, the minimum, maximum, and average CPU time, in microseconds, spent processing messages during the current archive interval.

� Archive Message Flow Accounting shows, in a table view, accounting statistics by message flow.

Information presented in the Archive Message Flow Accounting table view

The Archive Message Flow Accounting table view displays data provided by the Message Flow Accounting attributes, which are shown on the next page.

Page 133: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 133

Archive Message Flow Accounting

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

� Accounting Origin� Average CPU Microseconds� Average CPU Time� Average Elapsed Microseconds� Average Elapsed Time� Average Input Message Size� Average Input Message Size String � Broker� Broker UUID� End Date� End Date and Time� End Time� Execution Group� Execution Group UUID� Input Message Rate� Input Message Wait CPU

Microseconds� Input Message Wait CPU Time � Input Message Wait Elapsed

Microseconds� Input Message Wait Elapsed Time� Maximum CPU Microseconds� Maximum CPU Time� Maximum Elapsed Microseconds� Maximum Elapsed Time� Maximum Input Message Size� Maximum Input Message Size String� Message Flow � Minimum CPU Microseconds � Minimum CPU Time� Minimum Elapsed Microseconds� Minimum Elapsed Time

� Minimum Input Message Size� Minimum Input Message Size String� Node Statistics Count� Number of Threads in Pool� Origin Node� Query Type� Record Code� Record Type� Sample Handle� Start Date� Start Date and Time� Start Time� Thread Statistics Count� Times Maximum Number of Threads

Reached� Total CPU Microseconds� Total CPU Time� Total Elapsed Microseconds� Total Elapsed Time� Total Input Message Size� Total Input Message Size String � Total Input Messages� Total Number of Aggregate Reply

Wait Timeouts � Total Number of Backouts� Total Number of Commits� Total Number of Errors Processing

Messages� Total Number of Messages with

Errors� Total Number of MQ Errors

Page 134: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Archive Message Flow Accounting

134 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Predefined links

This workspace contains links to the Archive Thread Accounting and Archive Node Accounting workspaces.

It also contains links to Recent Archive Message Flow Accounting and Historical Archive Message Flow Accounting workspaces for the selected message flow. The number of rows of data displayed in the Recent Archive Message Flow workspace depends on the value assigned to the defaultRetainRecentArchiveSamples (or retainRecentArchiveSamples) parameter, which indicates how many recent archive records to keep as a minimum, but the number retained and available for viewing may be greater, depending on requirements for retaining data for historical recording.

Page 135: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 135

Archive Node Accounting

Archive Node Accounting

DescriptionThis workspace displays rows of statistics for nodes used by message flows for the current archive interval. There is one row per node per message flow. Typically, this workspace will be linked to for a specific message flow, so all nodes shown will pertain to that message flow.

The data shown in this view is available for situations by default.

Default viewsThis workspace contains the following default views:

� Archive Node Accounting shows, as a table, archive statistics for nodes used by message flows.

� Node Elapsed Time shows, as a bar chart, the minumum, maximum, and average time the node spent processing an input message.

� Node CPU Time shows, as a bar chart, the minimum, maximum and average CPU time spend processing an input message

Information presented in the Archive Node Accounting table viewThe Archive Node Flow Accounting table view displays data provided by the Node Accounting attributes, as shown on the next page. For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Page 136: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Archive Node Accounting

136 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Predefined linksThis workspace contains a link to the Archive Terminal Accounting workspace. It also contain links to Recent Archive Node Accounting and Historical Archive Node Accounting workspaces for the selected message flow. The number of rows of data displayed in the Recent Archive Message Flow workspace depends on the value assigned to the defaultRetainRecentArchiveSamples (or retainRecentArchiveSamples) parameter, which indicates how many recent archive records to keep as a minimum, but the number retained and available for viewing may be greater, depending on requirements for retaining data for historical recording.

� Accounting Origin� Average Elapsed Time� Average Elapsed Microseconds� Average CPU Time� Average CPU Microseconds� Broker� Count of Invocations� End Date and Time� Execution Group� Invocation Rate� Maximum CPU Microseconds� Maximum CPU Time� Maximum Elapsed Microseconds� Maximum Elapsed Time� Message Flow � Minimum CPU Microseconds

� Minimum CPU Time� Minimum Elapsed Microseconds� Minimum Elapsed Time� Number of Input Terminals� Number of Output Terminals� Origin Node� Processing Node Label� Processing Node Type� Query Type� Record Code� Record Type� Sample Handle� Start Date and Time� Total CPU Microseconds� Total CPU Time� Total Elapsed Microseconds

Page 137: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 137

Archive Terminal Accounting

Archive Terminal Accounting

DescriptionThis workspace displays statistics for terminals on nodes used by message flows for the current archive interval. There is one row per terminal per node per message flow. Typically, this workspace will be linked to for a specific message flow and node, so that all terminals for which data is displayed will belong to that message flow and node.

The data shown in this view will be available for situations by default.

Default viewsThis workspace contains the following default views:

� Archive Terminal Accounting shows, as a table, archive statistics for terminals on nodes used by message flows, for the current collection interval.

� Terminal Invocation Rate shows, as a bar chart, the rate at which terminals were invoked during the current interval.

Information presented in the Archive Terminal Accounting table viewThe Archive Terminal Flow Accounting table view displays data provided by the Terminal Accounting attributes, as shown below. For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

� Accounting Origin� Broker� Count of Invocations� End Date and Time� Execution Group� Invocation Rate� Message Flow � Origin Node� Processing Node Label

� Query Type� Record Code� Record Type� Sample Handle� Start Date and Time� Terminal Label� Terminal Type� Total Elapsed Time

Page 138: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Archive Terminal Accounting

138 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Predefined linksThis workspace contains links to Recent Archive Terminal Accounting and Historical Archive Terminal Accounting workspaces for the message flow and node given by a selected row in this workspace.

Page 139: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 139

Archive Thread Accounting

Archive Thread Accounting

DescriptionThis workspace displays archive statistics pertaining to threads used by message flows. There is one row of data per thread per message flow for the current archive interval. Typically, this workspace is linked to for a specific message flow, so all threads shown relate to a single message flow.

The data shown in this view is available for situations by default.

Default viewsThis workspace contains the following default views:

� Archive Thread Accounting shows, as a table, archive statistics for threads used by message flows.

� Thread Elapsed Time shows, as a bar chart, the minimum, maxiumum, and average time spent processing input messages for the current interval.

� Thread CPU Time shows, as a bar chart, the minimum, maxiumum, and average CPU time spent processing input messages during the current interval.

Information presented in the Archive Thread Accounting table viewThe Archive Thread Flow Accounting table view displays data provided by the Thread Accounting attributes, as shown on the next page.

Page 140: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Archive Thread Accounting

140 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Predefined linksThis workspace contains links to Recent Archive Thread Accounting and Historical Archive Thread Accounting workspaces for the message flow given by a selected row in this workspace. The number of rows of data displayed in the Recent Archive Message Flow workspace depends on the value assigned to the defaultRetainRecentArchiveSamples (or retainRecentArchiveSamples) parameter which indicates how many recent archive records to keep as a minimum, but the number retained and available for viewing may be greater, depending on requirements for retaining data for historical recording.

� Accounting Origin� Average CPU Microseconds� Average CPU Time� Average Elapsed Microseconds� Average Elapsed Time� Average Input Message Size� Average Input Message Size String � Broker� End Date and Time� Execution Group� Input Message Rate� Input Message Wait CPU

Microseconds � Input Message Wait CPU Time � Input Message Wait Elapsed

Microseconds� Input Message Wait Elapsed Time� Maximum Input Message Size

� Maximum Input Message Size String� Message Flow � Minimum Input Message Size � Minimum Input Message Size String� Origin Node� Query Type� Record Code� Record Type� Sample Handle� Start Date and Time� Thread Number� Total CPU Microseconds� Total CPU Time� Total Elapsed Microseconds� Total Elapsed Time� Total Input Message Size � Total Input Message Size String� Total Input Messages

Page 141: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 141

Broker Events Workspace

Broker Events Workspace

DescriptionThe Broker Events workspace is selectable for the broker managed system. This workspace lists events generated by the brokers as they occur. The number of events shown depends on the number retained by the agent as set within the agent parameter file.

The agent receives broker events data by means of a subscription to WebSphere Business Integration brokers broker events publications. If a particular event is not published by WebSphere Business Integration brokers then it is not available for display in this workspace. Note Broker Events attributes are not recommended as a situation mechanism for detecting the status of a broker. Instead, use the Broker_Information.Broker_Status attribute for this purpose, as demonstrated in the product-provided situations.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Broker Events shows, as a table, the most recent retained broker events.

Information presented in the Broker Events table viewThe Broker Events table view displays data provided by the Broker Events attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

� Broker� Event� Event Date and Time� Event Qualifier 1� Event Qualifier 2

� Event5 Type� Origin Node� Qualifier Description 1� Qualifier Description 2

Page 142: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Broker Events Workspace

142 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Note the Broker Events attributes also provide data for the Broker Events History workspace.

Predefined links

By default, you can link from this Broker Events table view to Broker Events History. (Broker Events short term history collection is active by default. If the event occurs, an entry is added to the historical log.)

Page 143: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 143

Broker Information Workspace

Broker Information Workspace

DescriptionThe Broker Information workspace is selectable for the broker managed system. This workspace displays the status of the broker, its process ID, information about the platform on which it runs, its job on OS/390 and z/OS systems, its associated configuration manager queue manager, its associated queue manager, and whether or not the agent can connect to the broker’s queue manager.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Broker Information shows, as a table, broker status and definition data.

Information presented in the Broker Information table viewThe Broker Information table view displays data provided by the Broker Information attributes, which are:

� Address Space Identifier� Broker� Broker Status� Component Type� Configuration Manager Queue

Manager� Data Source Name� Execution Groups� Jobname Taskname� Migration Needed� Origin Node� Platform

� Platform Version� Process Identifier� Queue Manager� Queue Manager Connection Status� Release� Start Date and Time� Statistics Archive Interval� System Name� Trace Level� Trusted Queue Manager� User Name Server Queue Manager� UUID

Page 144: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Broker Information Workspace

144 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Broker Information attributes also provide data for the Broker Information History workspace and the Neighbor Broker Information workspace.

Predefined links

By default, you can link from this Broker Information table view to Broker Statistics and Broker Information History. (Broker Information short term history collection is active, by default, with a collection interval of 15 minutes.)

Page 145: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 145

Broker Statistics Workspace

Broker Statistics Workspace

DescriptionThe Broker Statistics workspace is selectable for the broker managed system.

This high-level statistics workspace provides message flow statistics summarized at the broker level.

To obtain data for this workspace, the broker must have at least one deployed CandleMonitor node with a type attribute of input or output.

Default viewsThis workspace contains the following default views:

� Current Message Rates shows, as a bar chart, the message input rate and message output rate for the broker.

� Current Average Message Time shows, as a bar chart, average queue and flow times for the broker.

� Broker Statistics shows, as a table, statistical data summarized for the broker.

Note: Move the cursor over different areas of a chart to display flyover details about the items in the chart.

Information presented in the Broker Statistics table viewThe Broker Statistics table view displays data provided by the Broker Statistics attributes, which are listed on the following page:

Page 146: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Broker Statistics Workspace

146 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Broker Statistics attributes also provide data for the Broker Statistics History workspace.

Predefined links

By default, you can link from the Broker Statistics table view to Broker Information and Broker Statistics History. (Broker Statistics short term history collection is active, by default, with a collection interval of 15 minutes.) You can also link to User Broker Statistics and User Execution Group Statistics.

� Address Space Identifier� Broker� Current Average Flow Time� Current Average Message Size� Current Average Message Time� Current Average Queue Time� Current Interval� Current Message Input Count� Current Message Input Rate� Current Message Output Count� Current Message Output Rate� First Message Date and Time� Jobname Taskname� Last Message Date and Time� Monitored Execution Groups� Monitored Message Flows� Origin Node� Overall Average Flow Time� Overall Average Message Size� Overall Average Message Time

� Overall Average Queue Time� Overall Maximum Flow Time� Overall Maximum Message Size� Overall Maximum Queue Time� Overall Message Input Count� Overall Message Input Rate� Overall Message Output Count� Overall Message Output Rate� Overall Minimum Flow Time� Overall Minimum Message Size� Overall Minimum Queue Time� Platform� Platform Version� Process Identifier� Sample Date and Time� Start Date and Time� Started Message Flows� Status� System Name

Page 147: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 147

Broker Status Workspace (broker-level summary)

Broker Status Workspace (broker-level summary)

DescriptionThe Broker Status workspace is selectable for the broker managed system. It summarizes event, status, and definition information for the broker.

Default viewsThis workspace contains the following default views:

� Broker Events shows, as a table, the most recent retained broker events.

� Message Flow Events shows, as a table, the most recent retained message flow events.

� Broker Information shows, as a table, broker status and definition data.

Accessing this workspaceTo access this workspace, in the Navigator physical view select one of the broker managed system folder icons.

If only one broker is monitored, the broker managed system folder icon is merged with the QI Broker folder icon.

Page 148: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Broker Summary Workspace (multiple brokers monitored)

148 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Broker Summary Workspace (multiple brokers monitored)

DescriptionThe Broker Summary workspace is selectable for the QI Broker folder node when multiple brokers are monitored by the same agent. It lists information about each broker monitored.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Broker Information shows, as a table, the broker status and definition data for each broker monitored by the agent.

Accessing this workspaceTo access this workspace, in the Navigator physical view select the QI Broker folder icon.

Page 149: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 149

CandleMonitor Node Statistics Workspace

CandleMonitor Node Statistics Workspace

DescriptionThe CandleMonitor Node Statistics workspace is selectable for the broker managed system.

This low-level statistics workspace provides message flow statistics at the individual node level at which they are collected (by CandleMonitor nodes).

To obtain data for this workspace, the broker must have at least one deployed CandleMonitor node with a type attribute of input, output, or other.

Default viewsThis workspace contains the following default views:

� Current Message Rate shows, as a bar chart, the message rate by message processing node.

� Current Average Message Time shows, as a bar chart, average queue and flow times by message processing node.

� CandleMonitor Node Statistics shows, as a table, statistical data by CandleMonitor node.

Note: Move the cursor over different areas of a chart to display flyover details about the items in the chart.

Information presented in the CandleMonitor Node Statistics table view

The CandleMonitor Node Statistics table view displays data provided by the CandleMonitor Node Statistics attributes, which are listed on the following page:

Page 150: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

CandleMonitor Node Statistics Workspace

150 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the CandleMonitor Node Statistics attributes also provide data for the CandleMonitor Node Statistics History workspace.

Predefined links

By default, you can link from the CandleMonitor Node Statistics table view to Message Processing Node Information (filtered by Execution Group and Message Flow), and CandleMonitor Node Statistics History. (CandleMonitor Node Statistics short term history collection is active, by default, with a collection interval of 15 minutes.) You can also link to User CandleMonitor Node Statistics.

� Broker� Current Average Flow Time� Current Average Message Size� Current Average Message Time� Current Average Queue Time� Current Interval� Current Message Count� Current Message Rate� Execution Group� First Message Date and Time� Last Message Date and Time� Message Flow� Monitor Type� Origin Node� Overall Average Flow Time

� Overall Average Message Size� Overall Average Message Time� Overall Average Queue Time� Overall Maximum Flow Time� Overall Maximum Message Size� Overall Maximum Queue Time� Overall Message Count� Overall Message Rate� Overall Minimum Flow Time� Overall Minimum Message Size� Overall Minimum Queue Time� Processing Node Label� Sample Date and Time� Sub-Flow Name

Page 151: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 151

Components Workspace

Components Workspace

DescriptionThe Components workspace is selectable for the agent managed system. It displays a list of WebSphere Business Integration brokers components and their state at the agent level.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Components shows, as a table, all created components on the system that the agent is monitoring.

Information presented in the Components table viewThe Components table view displays data provided by the Components attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Components attributes also provide data for the Components History workspace.

� Address Space Identifier� Component� Component Type� Jobname Taskname� Origin Node� Platform� Platform Version

� Process Identifier� Queue Manager� Release� Start Date and Time� Status� System Name� User Name Server Queue Manager

Page 152: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Components Workspace

152 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Predefined links

By default, you can link from this Components table view to Components History. (Components short term history collection is active, by default, with a collection interval of 15 minutes.)

Page 153: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 153

Execution Group Information Workspace

Execution Group Information Workspace

DescriptionThe Execution Group Information workspace is selectable for the broker managed system. It displays execution groups defined for the broker as well as definition information for each execution group.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Execution Group Information shows, as a table, Execution Group Information.

Information presented in the Execution Group Information table viewThe Execution Group Information table view displays data provided by the Execution Group Information attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Predefined links

By default, you can link from the Execution Group Information table view to Execution Group Statistics (filtered by Execution Group) and Message Flow Information (filtered by Execution Group). You can also link to User Execution Group Statistics and User Message Flow Statistics.

� Broker� Event Log File Mode� Event Log File Size� Execution Group� Origin Node� Started Message Flows� Total Message Flows� Trace Filter

� Trace Level� Trace Log File Mode� Trace Log File Size� User Trace Filter� User Trace Level� User Trace Log File Mode� User Trace Log File Size� UUID

Page 154: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Execution Group Statistics Workspace

154 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Execution Group Statistics Workspace

DescriptionThe Execution Group Statistics workspace is selectable for the broker managed system.

This high-level statistics workspace provides message flow statistics summarized at the execution group level.

To obtain data for this workspace, the broker must have at least one deployed CandleMonitor node with a type attribute of input or output.

Default viewsThis workspace contains the following default views:

� Current Message Rates shows, as a bar chart, the message input rate and message output rate by execution group.

� Current Average Message Time shows, as a bar chart, average queue and flow times by execution group.

� Execution Group Statistics shows, as a table, state and statistical data by execution group.

Note: Move the cursor over different areas of a chart to display flyover details about the items in the chart.

Information presented in the Execution Group Statistics table viewThe Execution Group Statistics table view displays data provided by the Execution Group Statistics attributes, which are listed on the following page:

Page 155: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 155

Execution Group Statistics Workspace

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Execution Group Statistics attributes also provide data for the Execution Group Statistics History workspace.

Predefined links

By default, you can link from the Execution Group Statistics table view to Message Flow Statistics (filtered by Execution Group), Execution Group Information (filtered by Execution Group), and Execution Group Statistics History. (Execution Group Statistics short term history collection is active, by default, with a collection interval of 15 minutes.)

� Address Space Identifier� Broker� Current Average Flow Time� Current Average Message Size� Current Average Message Time� Current Average Queue Time� Current Interval� Current Message Input Count� Current Message Input Rate� Current Message Output Count� Current Message Output Rate� Execution Group� First Message Date and Time� Jobname Taskname� Last Message Date and Time� Monitored Message Flows� Origin Node� Overall Average Flow Time� Overall Average Message Size� Overall Average Message Time

� Overall Average Queue Time� Overall Maximum Flow Time� Overall Maximum Message Size� Overall Maximum Queue Time� Overall Message Input Count� Overall Message Input Rate� Overall Message Output Count� Overall Message Output Rate� Overall Minimum Flow Time� Overall Minimum Message Size� Overall Minimum Queue Time� Platform� Platform Version� Process Identifier� Sample Date and Time� Start Date and Time� Started Message Flows� Status� System Name

Page 156: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Message Flow Events Workspace

156 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Message Flow Events Workspace

DescriptionThe Message Flow Events workspace is selectable for the broker managed system. This workspace lists events generated by the CandleMonitor node as they occur. The number of events shown depends on the number retained by the agent as set within the agent parameter file.

To obtain data for this workspace, the broker must have at least one deployed CandleMonitor node with a type attribute of “other” (recommended) and message text specified in the eventMessage attribute.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Message Flow Events shows, as a table, the most recent retained Message Flow Events.

Information presented in the Message Flow Events table viewThe Message Flow Events table view displays data provided by the Message Flow Events attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Message Flow Events attributes also provide data for the Message Flow Events History workspace.

� Broker� Correlation Identifier� Event Date and Time� Event Message� Execution Group� Message Flow� Message Identifier

� Monitor Type� Origin Node� Processing Node Label� Put Application Name� Put Application Type� Put Date and Time� Thread Identifier

Page 157: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 157

Message Flow Events Workspace

Predefined links

By default, you can link from this Message Flow Events table view to the Message Processing Node Information workspace (filtered by Execution Group and Message Flow) and Message Flow Events History. (Message Flow Events short term history collection is active by default. If the event occurs, an entry is added to the historical log.)

Page 158: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Message Flow Information Workspace

158 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Message Flow Information Workspace

DescriptionThe Message Flow Information workspace is selectable for the broker managed system. It displays defined message flows by execution group as well as definition information for each.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Message Flow Information shows, as a table, Message Flow Information.

Information presented in the Message Flow Information table viewThe Message Flow Information table view displays data provided by the Message Flow Information attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Predefined links

By default, you can link from the Message Flow Information table view to Message Flow Statistics (filtered by Execution Group and Message Flow) and

� Additional Instances� Broker� Commit Count� Commit Interval� Coordinated Transaction� Execution Group� Message Flow� Message Flow Type

� Origin Node� Processing Nodes� Status� Trace Filter� Trace Level� User Trace Filter� User Trace Level� UUID

Page 159: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 159

Message Flow Information Workspace

Message Processing Node Information (filtered by Execution Group and Message Flow).

Page 160: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Message Flow Statistics Workspace

160 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Message Flow Statistics Workspace

DescriptionThe Message Flow Statistics workspace is selectable for the broker managed system.

This high-level statistics workspace provides message flow statistics summarized at the message flow level.

To obtain data for this workspace, the broker must have at least one deployed CandleMonitor node with a type attribute of input or output.

Default viewsThis workspace contains the following default views:

� Current Message Rates shows, as a bar chart, the message input rate and message output rate by message flow.

� Current Average Message Time shows, as a bar chart, average queue and flow times by message flow.

� Message Flow Statistics shows, as a table, state and statistical data by message flow.

Note: Move the cursor over different areas of a chart to display flyover details about the items in the chart.

Information presented in the Message Flow Statistics table viewThe Message Flow Statistics table view displays data provided by the Message Flow Statistics attributes, which are listed on the following page:

Page 161: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 161

Message Flow Statistics Workspace

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Message Flow Statistics attributes also provide data for the Message Flow Statistics History workspace.

Predefined links

By default, you can link from the Message Flow Statistics table view to CandleMonitor Node Statistics (filtered by Execution Group and Message Flow), Message Flow Information (filtered by Execution Group and Message Flow), and Message Flow Statistics History. (Message Flow Statistics short term history collection is active, by default, with a collection interval of 15 minutes.) You can also link to Sub-Flow Statistics, User Message Flow Statistics, User Sub-Flow Statistics, and User CandleMonitor Node Statistics.

� Broker� Current Average Flow Time� Current Average Message Size� Current Average Message Time� Current Average Queue Time� Execution Group� Current Message Input Count� Current Message Input Rate� Current Message Output Count� Current Message Output Rate� Current Inteval� First Message Date and Time� Last Message Date and Time� Message Flow� Monitor Nodes� Origin Node

� Overall Average Flow Time� Overall Average Message Size� Overall Average Message Time� Overall Average Queue Time� Overall Maximum Flow Time� Overall Maximum Message Size� Overall Maximum Queue Time� Overall Message Input Count� Overall Message Input Rate� Overall Message Output Count� Overall Message Output Rate� Overall Minimum Flow Time� Overall Minimum Message Size� Overall Minimum Queue Time� Sample Data and Time� Status

Page 162: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Message Processing Node Attributes Workspace

162 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Message Processing Node Attributes Workspace

DescriptionThe Message Processing Node Attributes workspace lists all attribute values for the selected message processing node (within a message flow).

Message processing node attributes are defined in the WebSphere Business Integration brokers Control Center while configuring a node within a message flow. Each node has its own distinct attributes that allow user customization of node functionality.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Message Processing Node Attributes shows, as a detail table, a list of each attribute and its value for the selected processing node.

Accessing this workspaceTo access this workspace, select a row in the Message Processing Node Information table view then right-click and select Message Processing Node Attributes.

Information presented in the Message Processing Node Attributes table view

The Message Processing Node Attributes table view displays data provided by the Message Processing Node Attributes group of attributes, which are:

� Attribute Name� Attribute Value � Broker� Execution Group

� Message Flow� Origin Node� Processing Node Label� Processing Node Name

Page 163: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 163

Message Processing Node Attributes Workspace

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Page 164: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Message Processing Node Information Workspace

164 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Message Processing Node Information Workspace

DescriptionThe Message Processing Node Information workspace is selectable for the broker managed system. It displays defined Message Processing Nodes by their execution group and message flow.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Message Processing Node Information shows, as a table, Message Processing Node Information.

Information presented in the Message Processing Node Information table view

The Message Processing Node Information table view displays data provided by the Message Processing Node Information attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Message Processing Node Information attributes also provide data for the Message Processing Nodes workspace.

� Attribute 1� Attribute 2� Attribute 1 Description� Attribute 2 Description� Broker� Execution Group

� Message Flow� Message Flow Type� Origin Node� Processing Node Label� Processing Node Name� UUID

Page 165: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 165

Message Processing Node Information Workspace

Predefined links

By default, you can link from the Message Processing Node Information table view to CandleMonitor Node Statistics (filtered by Execution Group and Message Flow), Message Processing Node Attributes (filtered by Execution Group, Message Flow, and Processing Node Label), and Message Processing Nodes (filtered by Attribute 1 when it is a queue name).

Page 166: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Message Processing Nodes

166 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Message Processing Nodes

DescriptionThe Message Processing Nodes workspace lists all message processing nodes in the enterprise that have the same queue name.

You can also use Message Processing Nodes as the target workspace of a link from a workspace associated with the Candle Command Center for MQSeries monitoring agent (if you are using the OMEGAMON DE feature package for CandleNet Portal). To define such a link, study the example link provided from the Message Processing Node Information table view to this workspace, and refer to the CandleNet Portal online Help for information on customizing a workspace link.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Message Processing Nodes with <queue name> shows, as a table, message processing node information for nodes throughout your enterprise for which the queue name attribute matches the queue name used in the link.

Accessing this workspaceTo access this workspace, select a row in the Message Processing Node Information table view that has a queue name attribute in the Attribute 1 column, then right-click and select Message Processing Nodes.

Information Presented in the Message Processing Nodes with <queue name> table view

The Message Processing Nodes with <queue name> table view displays data provided by the Message Processing Node Information attributes described in “Message Processing Node Information Workspace” on page 164.

Page 167: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 167

Neighbors Workspace

Neighbors Workspace

DescriptionThe Neighbors workspace is selectable for the broker managed system. It displays a list of neighbors to the broker in the publish/subscribe topology, as well as their connection attributes.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Neighbors shows, as a table, neighbor information for all neighbors to the broker.

Information presented in the Neighbors table viewThe Neighbors table view displays data provided by the Neighbors attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Predefined links

By default, you can link from the Neighbors table view to Neighbor Broker Information (which provides details about the neighbor broker, such as the neighbor broker’s name). Note the Neighbor Broker Information workspace uses the Broker Information attributes described in “Broker Information Workspace” on page 143.

� Broker� Collective UUID� Connection Queue

� Connection Queue Manager� Neighbor UUID� Origin Node

Page 168: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Product Events Workspace

168 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Product Events Workspace

DescriptionThe Product Events workspace is selectable for the agent managed system. This workspace displays product events generated by the agent when a problem occurs that affects the agent's ability to collect WebSphere Business Integration brokers data. The number of events shown depends on the number retained by the agent, as set in the agent parameter file (see “retainProductEvents” on page 45).

For explanations of the agent generated product events and how they can be used in problem determination, see “Product Events” on page 197.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Product Events shows, as a table, the most recent retained product events.

Information presented in the Product Events table viewThe Product Events table view displays data provided by the Product Events attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Product Events attributes also provide data for the Product Events History workspace.

Note: Situations based on Product Events attributes are not recommended as a mechanism for detecting the status of a broker. Instead, the

� Event� Event Date and Time� Event Qualifier 1

� Event Qualifier 2� Origin Node� Reason

Page 169: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 169

Product Events Workspace

Broker_Information.Broker_Status attribute should be used for this purpose, as demonstrated in the product-provided situations.

Predefined links

By default, you can link from this Product Events table view to Product Events History. (Product Events short term history collection is active by default. If the event occurs, an entry is added to the historical log.)

Page 170: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Retained Publications Workspace

170 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Retained Publications Workspace

DescriptionThe Retained Publications workspace is selectable for the broker managed system. It displays a list of topic and subscription points that have a retained publication.

Note: The data in this workspace is not updated more frequently than the length of the cycle indicated by the agent parameter defaultStatisticInterval (or if specified for a specific broker, statisticInterval). The default for this interval is one minute. So if the parameter setting has not been modified, a change to retained publication data will take up to 1 minute to be reflected in the workspace.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Retained Publications shows, as a table, all retained publications for the broker.

Information presented in the Retained Publications table viewThe Retained Publications table view displays data provided by the Retained Publications attributes, which are:� Broker� Origin Node� Subscription Point� Topic

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Page 171: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 171

Snapshot Message Flow Accounting

Snapshot Message Flow Accounting

DescriptionThis workspace gives rows of snapshot statistics pertaining to entire message flows, for the current snapshot collection interval. In this top-level view, there is one row per monitored message flow, giving the data for for the message flow for the current collection interval. The interval at which data is collected is configured at the broker.

If the broker has not been set to collect this type of data, no data will be displayed. The data shown in this view is available for situations by default.

Default viewsThis workspace contains the following default views:

� Message Flow Elapsed Time shows, as a bar chart, the minimum, maximum, and average time, in microseconds, spent processing messages during the current snapshot interval.

� Message Flow CPU Time shows, as a bar chart, the minimum, maximum, and average CPU time, in microseconds, spent processing messages during the current snapshot interval.

� Snapshot Message Flow Accounting shows, in a table view, accounting statistics by message flow, for the current snapshot interval.

Information presented in the Snapshot Message Flow Accounting table view

The Snapshot Message Flow Accounting table view displays data provided by the Message Flow Accounting attributes, which are shown on the next page.

Page 172: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Snapshot Message Flow Accounting

172 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

� Accounting Origin� Average CPU Microseconds� Average CPU Time� Average Elapsed Microseconds� Average Elapsed Time� Average Input Message Size� Average Input Message Size String � Broker� Broker UUID� End Date� End Date and Time� End Time� Execution Group� Execution Group UUID� Input Message Rate� Input Message Wait CPU

Microseconds� Input Message Wait CPU Time � Input Message Wait Elapsed

Microseconds� Input Message Wait Elapsed Time� Maximum CPU Microseconds� Maximum CPU Time� Maximum Elapsed Microseconds� Maximum Elapsed Time� Maximum Input Message Size� Maximum Input Message Size String� Message Flow � Minimum CPU Microseconds � Minimum CPU Time� Minimum Elapsed Microseconds� Minimum Elapsed Time

� Minimum Input Message Size� Minimum Input Message Size String� Node Statistics Count� Number of Threads in Pool� Origin Node� Query Type� Record Code� Record Type� Sample Handle� Start Date� Start Date and Time� Start Time� Thread Statistics Count� Times Maximum Number of Threads

Reached� Total CPU Microseconds� Total CPU Time� Total Elapsed Microseconds� Total Elapsed Time� Total Input Message Size� Total Input Message Size String � Total Input Messages� Total Number of Aggregate Reply

Wait Timeouts � Total Number of Backouts� Total Number of Commits� Total Number of Errors Processing

Messages� Total Number of Messages with

Errors� Total Number of MQ Errors

Page 173: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 173

Snapshot Message Flow Accounting

Predefined links

This workspace contains links to the Snapshot Thread Accounting and Snapshot Node Accounting workspaces. It also contains links to Recent Snapshot Message Flow Accounting and Historical Snapshot Message Flow Accounting workspaces for the selected message flow. The number of rows of data displayed in the Recent Snapshot Message Flow workspace depends on the value assigned to the defaultRetainRecentSnapshotSamples (or retainRecentSnapshotSamples) parameter which indicates how many recent snapshot records to keep as a minimum, but the number retained and available for viewing may be greater, depending on requirements for retaining data for historical recording.

Page 174: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Snapshot Node Accounting

174 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Snapshot Node Accounting

DescriptionThis workspace displays rows of statistics for nodes used by message flows for the current snapshot interval. There is one row per node per message flow. Typically, this workspace will be linked to for a specific message flow, so that all nodes shown will pertain to that message flow.

The data shown in this view is available for situations by default.

Default viewsThis workspace contains the following default views:

� Snapshot Node Accounting shows, as a table, snapshot statistics for nodes used by message flows.

� Node Elapsed Time shows, as a bar chart, the minimum, maximum, and average time nodes spent processing input messages.

� Node CPU Time shows, as a bar chart, the minimum, maximum, and average amount of CPU time nodes used to process input messages.

Information presented in the Snapshot Node Accounting table viewThe Snapshot Node Flow Accounting table view displays data provided by the Node Accounting attributes, as shown on the next page. For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Page 175: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 175

Snapshot Node Accounting

Predefined linksThis workspace contains a link to the Snapshot Terminal Accounting workspace. It also contain links to Recent Snapshot Node Accounting and Historical Snapshot Node Accounting workspaces for the selected message flow. The number of rows of data displayed in the Recent Snapshot Message Flow workspace depends on the value assigned to the defaultRetainRecentSnapshotSamples (or retainRecentSnapshotSamples) parameter which indicates how many recent snapshot records to keep as a minimum, but the number retained and available for viewing may be greater, depending on requirements for retaining data for historical recording.

� Accounting Origin� Average Elapsed Time� Average Elapsed Microseconds� Average CPU Time� Average CPU Microseconds� Broker� Count of Invocations� End Date and Time� Execution Group� Invocation Rate� Maximum CPU Microseconds� Maximum CPU Time� Maximum Elapsed Microseconds� Maximum Elapsed Time� Message Flow � Minimum CPU Microseconds� Minimum CPU Time

� Minimum Elapsed Microseconds� Minimum Elapsed Time� Number of Input Terminals� Number of Output Terminals� Origin Node� Processing Node Label� Processing Node Type� Query Type� Record Code� Record Type� Sample Handle� Start Date and Time� Total CPU Microseconds� Total CPU Time� Total Elapsed Microseconds � Total Elapsed Time

Page 176: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Snapshot Terminal Accounting

176 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Snapshot Terminal Accounting

DescriptionThis workspace displays statistics for terminals on nodes used by message flows for the current snapshot interval. There is one row per terminal per node per message flow. Typically, this workspace will be linked to for a specific message flow and node, so that all terminals for which data is displayed will belong to that message flow and node.

The data shown in this view will be available for situations by default.

Default viewsThis workspace contains the following default views:

� Snapshot Terminal Accounting shows, as a table, snapshot statistics for terminals on nodes used by message flows.

� Terminal Invocation Rate shows, as a bar chart, the rate at which terminals are invoked.

Information presented in the Snapshot Terminal Accounting table view

The Snapshot Terminal Flow Accounting table view displays data provided by the Terminal Accounting attributes, as shown below. For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

� Accounting Origin� Attribute Name� Broker� Count of Invocations� End Date and Time� Execution Group� Invocation Rate� Message Flow � Origin Node

� Processing Node Label� Query Type� Record Code� Record Type� Sample Handle� Start Date and Time� Terminal Label� Terminal Type� Total Elapsed Time

Page 177: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 177

Snapshot Terminal Accounting

Predefined linksThis workspace contains links to Recent Snapshot Terminal Accounting and Historical Snapshot Terminal Accounting workspaces for the message flow and node given by a selected row in this workspace.

Page 178: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Snapshot Thread Accounting

178 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Snapshot Thread Accounting

DescriptionThis workspace displays snapshot statistics pertaining to threads used by message flows. There is one row of data per thread per message flow for the current snapshot interval. Typically, this workspace is linked to for a specific message flow, so all threads shown relate to a single message flow.

The data shown in this view is available for situations by default.

Default viewsThis workspace contains the following default views:

� Snapshot Thread Accounting shows, as a table, snapshot statistics for threads used by message flows.

� Thread Elapsed Time shows, as a bar chart, the minimum, maximum, and average amount of time threads spent processing input messages during the collection interval.

� Thread CPU Time shows, as a bar chart, the minimum, maximum, and average amount of CPU time threads used processing input messages during the collection interval.

Information presented in the Snapshot Thread Accounting table viewThe Snapshot Thread Flow Accounting table view displays data provided by the Thread Accounting attributes, as shown on the next page.

Page 179: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 179

Snapshot Thread Accounting

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Predefined linksThis workspace contains links to Recent Snapshot Thread Accounting and Historical Snapshot Thread Accounting workspaces for the message flow given by a selected row in this workspace. The number of rows of data displayed in the Recent Snapshot Message Flow workspace depends on the value assigned to the defaultRetainRecentSnapshotSamples (or retainRecentSnapshotSamples) parameter which indicates how many recent snapshot records to keep as a minimum, but the number retained and available for viewing may be greater, depending on requirements for retaining data for historical recording.

� Accounting Origin� Average CPU Microseconds� Average CPU Time� Average Elapsed Microseconds� Average Elapsed Time� Average Input Message Size� Average Input Message Size String � Broker� End Date and Time� Execution Group� Input Message Rate� Input Message Wait CPU

Microseconds � Input Message Wait CPU Time � Input Message Wait Elapsed

Microseconds� Input Message Wait Elapsed Time� Maximum Input Message Size � Maximum Input Message Size String

� Message Flow � Minimum Input Message Size � Minimum Input Message Size String� Origin Node� Query Type� Record Code� Record Type� Sample Handle� Start Date and Time� Thread Number� Total CPU Microseconds� Total CPU Time� Total Elapsed Microseconds� Total Elapsed Time� Total Input Message Size � Total Input Message Size String� Total Input Messages

Page 180: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Sub-Flow Statistics Workspace

180 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Sub-Flow Statistics Workspace

DescriptionThe Sub-Flow Statistics workspace provides statistics for any defined sub-flows.

If selected from the Navigator pane, all sub-flows for the given broker are shown with respect to the execution group and message flow in which they reside. If a link is taken from the Message Flow Statistics workspace for a given message flow, just the sub-flows associated with that message flow are shown.

Default viewsThis workspace contains the following three views:

� Current Message Rates bar chart shows the message input rate and the message output rate by sub-flow.

� Current Average Message Time bar chart shows average queue and flow times by sub-flow.

� Sub-Flow Statistics table view shows state and statistical data by sub-flow.

Information presented in the Sub-Flow Statistics table viewThe Sub-Flow Statistics table view displays data provided by the Sub-Flow Statistics attributes, which are listed on the following page.

Page 181: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Workspaces 181

Sub-Flow Statistics Workspace

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

Note the Sub-Flow Statistics attributes also provide data for the Sub-Flow Statistics History workspace.

Predefined links

By default, you can link from the Sub-Flow Statistics table view to Sub-Flow Statistics History workspace. Links are also available to the CandleMonitor Node Statistics workspace, so that the associated nodes and base statistical data can be viewed for each node that is part of the sub-flow, and to User Sub-Flow Statistics and User CandleMonitor Node Statistics workspaces.

� Broker� Current Average Flow Time� Current Average Message Size� Current Average Message Time� Current Average Queue Time� Current Interval� Current Message Input Count� Current Message Input Rate� Current Message Output Count� Current Message Output Rate� Execution Group� First Message Date and Time� Last Message Date and Time� Message Flow� Monitor Nodes� Origin Node

� Overall Average Flow Time� Overall Average Message Size� Overall Average Message Time� Overall Average Queue Time� Overall Maximum Flow Time� Overall Maximum Message Size� Overall Maximum Queue Time� Overall Message Input Count� Overall Message Input Rate� Overall Message Output Count� Overall Message Output Rate� Overall Minimum Flow Time� Overall Minimum Message Size� Overall Minimum Queue Time� Sample Date and Time� Sub-Flow Name

Page 182: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Subscriptions Workspace

182 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Subscriptions Workspace

DescriptionThe Subscriptions workspace is selectable for the broker managed system. It displays a list of subscriptions to topics.

Default viewsThis workspace contains the following default views:

� Enterprise Event Log shows, as a table, all situations raised for the enterprise.

� Subscriptions shows, as a table, all subscription information for the broker.

Information presented in the Subscriptions table viewThe Subscriptions table view displays data provided by the Subscriptions attributes, which are:

For a detailed description of these attributes and their values, refer to the Help for OMEGAMON XE for WebSphere Integration Brokers.

� Broker� Client Identitiy� Create Date and Time� Expiration Date and Time� Filter� Inform If Retained� Local Only

� Origin Node� Persistent� Publish On Request Only� Subscription Point� Topic� User Identifier

Page 183: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Appendixes 183

Appendixes

Page 184: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

184 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Page 185: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Problem Determination 185

Problem Determination

OverviewThis appendix discusses information that it is useful to gather when a problem is encountered and provides information that should be useful in analyzing that information to help determine what caused the problem. First, however, the paragraphs below provide some background about product specific components.

This section discusses some common issues with the product along with available work-around procedures if applicable.

Starting and stopping componentsIf WebSphere broker product components and the Candle monitoring agent are not started and stopped properly, other issues such as Broker Not Responding (see later) can occur. This section covers proper starting and starting of components.

Starting components

Components should be started in the following order:

1. Queue Managers and channels between them2. User Name Server (if defined)3. Configuration Manager4. Broker(s) in the configurationThe monitoring agent can be started any time. It usually can be left up indefinitely regardless of restarts and deploys (except in the case that a broker is not responding and needs to be reset). Note that maintenance levels of

A

Page 186: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

186 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

kqipnode.lil and the agent must match for the agent to work properly. Therefore, if you do maintenance to the agent that also affects the kqipnode.lil file, you should recycle the broker at the same time as the agent.

Stopping components

Try to stop the broker without canceling it or forcing it down.

� On OS/390 and z/OS, use “P <BrkrSTPN>” .

� On Windows, UNIX, and Linux, use mqsistop.

If the broker is brought down badly the following may occur:

� Locks and so forth may not be cleaned up properly.

� The broker database may be affected.

� The CandleMonitor node plug-in may not get to do clean up of mutexes and shared memory.

� Broker not responding may result.

Try to stop the agent without canceling or forcing it down or using immediate shutdown.

� On OS/390 and z/OS, use F <agntSTPN>,SHUTDOWN. Enter it one time only.

� On Windows, UNIX, and Linux use Manage Candle Services (GUI) or CandleAgent stop (command line).

It takes up to 5 minutes for a normal shutdown of the agent.

� Clean-up must be allowed to take place for shared memory, mutexes, and broker event subscription.

� On OS/390 and z/OS, look for message KQIA900I and other termination messages after it to verify that shutdown is in progress.

Also, on OS/390 and z/OS, try to avoid having a system IPL occur on a running broker. This can have the same affect as cancel/force. If it happens you may have to reset your broker (see below). It is best to implement production procedures for starting and stopping WebSphere Business Integration product components and monitoring agents properly around planned system IPLs.

Page 187: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Problem Determination 187

Broker Not RespondingBroker not responding occurs when the agent makes a request to the broker for data but does not get a reply. It is an IBM problem, but since the Candle monitoring agent usually detects it before anything else, it can look like a OMEGAMON XE for WebSphere Integration Brokers problem. Eventually, other broker applications will fail. For example, a subscription for data may not be properly registered with the broker, or a broker may not respond to a deploy request from the Control Center or Message Brokers Toolkit.

A broker may not respond to agent requests for several reasons, such as:

� It cannot communicate with its User Name Server.

� It cannot communicate with its Configuration Manager.

� There is a subtle problem with its database.

Symptoms of this problem are:

� The Broker_Not_Responding product event occurs in the Product Events workspace.

� The agent logs messages KQIA107W and KQIA041W repeatedly over several collection cycles.

� Much data is missing from CandleNet Portal Information workspaces.

� Broker system log messages may occur, such as BIP2080E and BIP2066E.

What to try first for this problem:

� Stop all WebSphere Business Integration Broker components and the monitoring agent.

� Restart all components in proper order and then start the agent and see if the broker responds.

What to try next depends on the platform.

Broker reset on OS/390 and z/OS

On the OS/390 and z/OS platforms a more formal reset procedure is available that usually works.

Follow these steps to reset a broker:

1. Stop the broker and monitoring agent.

Page 188: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

188 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

2. Run component PDS jobs in this order with condition code 0 for all steps: BIPJRSTC, BIP#DB01, BIP$DB01, BIP$DB02, BIP$DB03, BIP$DB04, BIP$DB05

3. Start the broker (it will not have execution groups).

4. Start channels between queue managers for the broker, User Name Server, and Configuration Mgr.

5. Deploy the complete configuration (all types) from the Control Center (Message Brokers Toolkit). Make sure it worked by viewing messages in the Control Center (Message Brokers Toolkit) log and system log.

6. Start the monitoring agent.

Broker reset on distributed platforms

On distributed platforms, there is not a formal way to “reset” the broker, but there is still a procedure that works many times.

Follow these steps to reset a broker:

1. Stop the agent and stop the broker using the –i (immediate) option.

2. Empty all SYSTEM.BROKER.* queues in the broker’s queue manager.

3. Start channels between queue managers for the broker, User Name Server, and Configuration Mgr.

4. Restart the components in the proper order.

5. Deploy the complete configuration (all types) from the Control Center (Message Brokers Toolkit). Make sure it worked by messages in the Control Center (Message Brokers Toolkit) log and system log. Use the force deploy if necessary.

6. Start the monitoring agent.

Mutex and Shared Memory CleanupOn UNIX, Linux, OS/390, and z/OS platforms, improper stopping of the broker or agent coupled with an element of unfortunate timing may lead to a need to clean up manually mutexes and shared memory used in the communication of data between the CandleMonitor node and agent.

Symptoms of this problem are:

� When restarted, the agent does not fully initialize.

Page 189: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Problem Determination 189

� Subsequent attempts to shutdown the agent hang.

� Data is missing: Information data is missing without a Broker_Not_Responding event. Statistics data is missing with at least one CandleMonitor node deployed.

Follow these steps to clean up mutexes and shared memory:

1. Stop agent and broker(s) monitored by agent.

2. On UNIX, Linux, or USS (on OS/390 or Z/OS):A. Issue the command: ipcs -a B. In the generated output, find all message queues with the brokers’

user IDs and agents’ user ID, and note the IDs and KEY field for each.C. Find all semaphores with a matching KEY field to those noted for

message queues, and note the ID field for each. D. Find all shared memory with the brokers’ user IDs and agent’s user ID

and an NATTCH field of 0, and note the ID field for each.E. Switch to a user ID that can issue the ipcrm command as follows: the

owner user ID (in the ipcs –a output), a user ID in the same group as the owner, or a root user ID.

F. For each message queue noted, issue the command: ipcrm -q <ID>

G. For each semaphore noted, issue the command: ipcrm -s <ID>H. For each shared memory noted, issue the command: ipcrm -m

<ID>

3. Restart the broker(s) and agent.

9000+ return codes in agent messagesThe agent uses return codes in the range 9000 to 9999 to avoid clashing with WebSphere MQ and WebSphere Business Integration return codes. They occur in messages in the log and as a result of automation and Take Action commands. On CandleNet Portal, these return codes after Take Action commands are displayed in character description, enumerated form. However, when they occur in messages, there may be a need to interpret them.

For Take Action and automation a 9000 return code is good; it is like a 0. A “good” return code only indicates that the agent was able to issue the request

Page 190: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

190 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

successfully. The agent does not have a way of knowing the final outcome of the request. Any other RC means that the automation did not work because the request could not even be issued. Note that for automation, in which the return code is noted in a message but not available in character form on CandleNet Portal, one can issue the same command in Take Action to get the character description for the error return code.

The 9000+ codes have the following descriptions. Note that not all of these can be returned from a Take Action or automation command. Some occur in messages related to other parts of the product. Many are actually not return codes, but are data descriptions instead.

Code Description

9000 QI Command Successfully Issued

9011 Insufficient Storage

9075 Invalid Table Column

9077 No Command Entered

9078 No Argument Entered

9079 Command For Broker Only

9080 Invalid Command

9081 Broker XML Element Error

9082 Too Many Arguments Entered

9083 Missing Required Discovery Object

9086 XML Parser Failed

9087 No Matched Message Flow

9088 No Matched Execution Group

9089 No Execution Group UUID

9090 Issue Request Failed For Command

9106 Cannot get Exclusive Lock

9122 CandleMonitor Node Data Connection Failed

Page 191: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Problem Determination 191

9148 UserId Not Authorized For Command

9301 Object Unusable

9302 Thread Create Error

9303 Associated Object Error

9304 Unknown Failure

9305 Storage Depleted

9306 XML Parse Init Failure

9307 XML Parse Error

9308 XML Message Type Error

9309 Object Construction Error

9310 QMgr Connection Thread Unavailable

9311 QMgr Connection Object Missing

9312 QMgr Pipe Communication Error

9313 Task Ending Cannot Process

9314 Task Request Bad

9315 Too Many Get Signal Requests

9316 Task Attach Failed

9317 z/OS Job Information Data Error

9500 Message Flow Definitions

9501 Dynamic Subscription Engine Data

9502 Message Flow Statistics

9503 Broker Events

9504 Message Flow Events

9505 Product Events

9506 Execution Group Information

9507 Message Flow Information

Page 192: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

192 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

9508 Message Processing Node Information

9509 Neighbors

9510 Subscriptions

9511 Retained Publications

9512 ACL Entries

9513 Execution Group Statistics

9514 Message Flow Statistics

9515 CandleMonitor Node Statistics

9516 Collected String Lost

9517 CandleMonitor Data Lost

9518 User Command

9519 Message Processing Node Attributes

9520 Sub-Flow Statistics

9521 User Statistics

9522 Message Flow Accounting

9600 Unknown Timeout

9601 Admin Queue Put Failed

9603 Error Allocating XML Reply

9604 Command Exceeds 126 Char Max

9605 Error Issuing System Command

9606 Unknown Command Failure

9607 Bad Request To Command Processor

9608 User Statistics Already Created

9609 User Statistics Not Found

9610 Broker UUID Not Initialized

9611 Statistics Collector Not Initialized

Page 193: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Problem Determination 193

QI: commands for automationThe QI: is needed for any automated command action that will be handled by the monitoring agent. Actions for situations should follow syntax of the actual commands issued for Take Action. Take Action help has a description of what the commands do. Be careful to use single quotes properly. They are required due to the values that some of the parameters can take. Also, if referring to attributes in the situation data, use the “Attribute Substitution” button to make sure you get the correctly spelled name for an attribute to substitute.

9612 Multiple Components with Same Name

Page 194: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

CandleMonitor Event Log

194 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

CandleMonitor Event Log

OverviewA CandleMonitor node produces error messages in the broker’s event log (usually the system log) only when necessary to communicate loss of function or reset of statistics. Note that even if the node plug-in suffers loss of function, it will still propagate messages and will not disrupt the message flow.

General InformationEvents represent the only "message" facility for the CandleMonitor node. However, the node cannot afford to be verbose in this environment, so no messages are produced to indicate normal operation is proceeding. The lack of events in the system log indicates that the CandleMonitor node has not detected any abnormal conditions within its own processing.

On Windows NT, the broker's Event log is the NT Application Event Log. All CandleMonitor events are identified by a source of "CandleMonitorNode". On UNIX systems the broker’s event log is the system messages file, but the exact file is determined by the installation.

Specific event message informationThis section describes the specific events that may occur.

CandleMonitorNode Event ID 1

Problem found in <BrokerName.ExecutionGroupName>.Unable to allocate new storage in <module>.CandleMonitorNode requires more memory. If problem persists, report the problem to Candle Corporation's Customer Support Center.

This event is issued if processing fails due to a new failure within the CandleMonitor plug-in module while processing data for the given broker and execution group. This failure may indicate the need for more storage in the broker environment, or it may indicate the existence of a memory leak.

CandleMonitorNode Event ID 2

Problem found in <BrokerName.ExecutionGroupName>.Function <FunctionName> failed in <ObjectMethod or CallingFunction>.

Page 195: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Problem Determination 195

CandleMonitor Event Log

<VariableText>Please contact Candle Corporation's Customer Support Center with this information.

The named function failed when called by the given object method or calling function. Variable text gives more information about the error. Since this single event covers many different possible errors, the event information must be used to research the actual problem that occurred. The function may be a function within OMEGAMON XE for WebSphere Integration Brokers code, or it may be a system provided function. The variable information should be used to determine what the exact error is.

The following example of this type of event actually is one that is not a major problem:

Problem found in WMQI.default.

Function RegOpenKeyEx failed in KQI_GetRegistryHandle.

Error 127. The specified procedure could not be found.

Please contact Candle Corporation's Customer Support Center with this information

The value in the registry that was being queried by the CandleMonitor node was missing from the registry. In this case the language in the variable text is misleading, but comes from the Windows NT system. The values that are queried by the node are "KQIMemorySize" and "KQINodeTrace". These are placed in the registry during agent configuration. If the broker is started prior to the first configuration of KQIAgent, this error will occur. However, it is not a problem for the node because defaults are used when the values are missing.

Here is another example of this event that is major in that the shared area cannot be used by the node:

Problem found in WMQI.MYGROUP.

Function CreateFileMapping failed in KQI_Shared_area::init.

Error 5. Access is denied.

Please contact Candle Corporation's Customer Support Center with this information

This instance of the problem arose in an earlier version due to the agent's user ID having different authority than the broker's, and the agent being started first. The current version should not encounter this event for the same reason

Page 196: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

CandleMonitor Event Log

196 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

because the shared area access is open. However, any error in this area will be detrimental to reporting message flow statistics and events.

CandleMonitorNode Event ID 10

Message from <BrokerName.ExecutionGroupName>.The statistics for broker <BrokerName> reached the maximum value allowed. The statistics have been reset. No action required.

This event is issued when a reset of statistics for the broker must occur due to the CandleMonitor node detecting a numeric overflow condition. This is not an error situation. It will cause reports to show "Overall" values restarting at 0. The same reset processing occurs during a deploy of a new configuration to the broker, however no event is logged for that situation because this is considered a completely normal operation. Note that the agent does log message KQIA125I when it detects that any reset of statistics has occurred. If that reset message occurs with no instance of this event in the event log, it implies that a deploy occurred or the Reset Statistics Take Action command has been issued. (Broker Events would also show the activity associated with the deploy.)

Page 197: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Product Events 197

Product Events

OverviewProduct events are produced by KQIAgent for problems encountered during data collection. These events can be viewed from the Product Events workspace in CandleNet Portal. Products events are logged historically by default and these are also available via a workspace that can be linked to from the regular product events workspace for an agent.

The first place to look when a problem occurs is at the Product Events workspace. A product event may explain what is happening right away and may show that there is really no product problem at all. If expected data is not displayed, and there are no corresponding product events, this can be a good indication that the failing component is not KQIAgent (although it would be prudent to verify in the kqi.log message file that there are no error or warning messages that would indicated an agent problem).

The rest of this section gives information about each of the specific product events that can occur.

"Normal" events resulting in no dataThese events report normal occurrences that nonetheless result in no data, but can be explained simply.

No_Brokers_Discovered_By_Agent

This event indicates that the agent did not find any brokers to monitor, or any that matched MonitorBroker parameters. This event occurs if there are no brokers created on the system that the agent is monitoring, or if agent parameters indicate a specifically named broker to monitor. By default, agents

B

Page 198: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

198 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

on Windows and UNIX are configured to monitor all brokers on the managed systems. On OS/390 and z/OS systems, all brokers to be monitored must be specified in the parameter file using the MonitorBroker tag (see “MonitorBroker” on page 50).

Agent_Shutdown

This event indicates that the agent is shutting down. By itself, this is a normal shutdown.

Broker_Product_Not_Installed

This event will be issued just prior to the agent terminating because no WebSphere Business Integration broker product is installed on the system that it is monitoring.

Agent_Userid_Group_Missing

This event will be issued on UNIX and Linux systems when the agent user ID fails the check that ensures that the user ID is in both of the correct security groups “mqm” and “mqbrkrs”. The agent will not continue to initialize when this occurs, because it has not been properly authorized to collect data.

Broker-related events resulting in most data being not availableThese events indicate occurrences that result in almost all data not being available.

Broker_Not_Started

This event indicates that the broker is inactive and data collection cannot occur. If this happens after collection occurred successfully, then previous data collected will remain available.

Broker_Not_Deployed—Data_Unavailable

This event indicates that the broker has never been deployed from the Control Center or Message Brokers Toolkit and has not been assigned a UUID, so data collection is not possible. You will have to deploy to the broker at least once so that the agent can successfully collect data.

Page 199: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Product Events 199

Broker-related events resulting in incomplete dataThese events indicate occurrences that result in various parts of data missing or not being updated when it should.

Broker_Not_Responding

This event indicates that the broker is not responding to data requests of the given type; this data will be missing or will retain previous values when it should have changed. A broker that is not responding indicates aWebSphere Business Integration brokers problem. There are usually broker events in the system log that indicate that the broker is failing internally, although they may seem totally unrelated, or may have occurred quite a while before the broker is unable to respond to the agent.

See “Broker Not Responding” on page 187 for more information.

Agent_Broker_Data_Requests_Failed

This event indicates that the broker is returning a failure response to a request for data of the given type, so that the data will not be available. This is common when an execution group is not responding to the broker. In this case, this event will occur after several Broker_Not_Responding events and signifies that the agent is giving up on trying to get data from the broker. It will only retry again if the broker is re-deployed. If this event occurs without any preceeding Broker_Not_Responding events, kqi.log messages should be checked for earlier messages indicating specific failures.

Broker_Events_Subscription_Failed

This event indicates that the agent was not able to subscribe to broker events because of a failure given in the reason with the event. This reason may indicate an authority problem, in which case the agent user ID is probably not part of the "mqbrkrs" security group. When broker events are not available to the agent, not only will it not report the events in Broker Events, it also will not detect changes such as a new deploy or status change, and reports will not show updated data.

ConfigMgr_Qmgr_Name_Missing

This event occurs when the Configuration Manager queue manager name that is supposed to be in broker information could not be determined. This name is determined by analyzing broker subscription data. If that analysis does not turn up the name, this event occurs. The reason that the analysis

Page 200: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

200 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

does not find the name almost always is that the Configuration Manager has not successfully subscribed to broker data as it is supposed to. The Configuration Manager issues the subscription to the broker during the first deploy procedure to the broker. A failure in this procedure can cause the subscription to not go through. This problem has occurred even when the deploy was successful. Also, if the broker has been reset, the Configuration Manager may not re-issue the subscription for broker data (it does not “know” that the broker has been reset). The reset deletes the broker’s copy of the subscription which is what the agent is trying to find.

Queue Manager-related events resulting in missing dataThese events indicate occurrences that result in possible unavailability of data in information reports and Broker Events.

Queue_Manager_Connection_Failed

This event indicates that connection to the given queue manager is not possible for the given reason. In this case, none of the data that is retrieved via request/reply or subscription will be available. This includes all information type reports and Broker Events.

Required_Queue_Unavailable

This event indicates that the given queue could not be opened for the given reason. If the queue is the agent's reply queue (which defaults to KQI.AGENT.REPLY.QUEUE), none of the data that is retrieved via request/reply or subscription will be available. If the queue is SYSTEM.BROKER.ADMIN.QUEUE, information type reports will not have data. If the queue is SYSTEM.BROKER.CONTROL.QUEUE, Broker Events will not be available and this will be just as bad as if the subscription failed (see Broker_Events_Subscription_Failed). If the problem is with authority, you must allow KQIAgent access to these queues.

Broker_Request_Message_Put_Failed

This event indicates that a request message could not be put to the given queue for the given reason.

If this event occurs a lot for the same queue, the effect will be the same as if the queue were unavailable (see Required_Queue_Unavailable event). If a single message could not be put to the SYSTEM.BROKER.ADMIN.QUEUE, only some data will be missing. Since KQIAgent only puts one subscription

Page 201: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Product Events 201

request to SYSTEM.BROKER.CONTROL.QUEUE, any put failure for this queue will be quite detrimental (see Required_Queue_Unavailable event).

Reply_Queue_Message_Get_Failed

This event indicates that a get failed for a reply or publication from the given queue for the given reason. If this message occurs a lot for the reply queue, the effect will be the same as if the queue were unavailable (see Required_Queue_Unavailable event). If a single get failed for a message, only some data will be missing.

CandleMonitor node-related eventsThese events result in missing message flow statistics and/or missing message flow events.

CandleMonitor_Data_Retrieval_Failed

This event indicates that there is a critical problem with retrieving data from shared memory. The reason/status is given. This failure will cause message flow statistics and events to be unavailable.

CandleMonitor_Node_Not_Deployed

This event indicates that the agent could not detect that a message flow that includes a CandleMonitor node has been deployed to the broker. This event may also occur if broker database errors are occurring. After agent or broker startup, or broker deploy, the agent gives execution groups five minutes to come up and initialize message flows prior to reporting this event. If, after that period, there is no indication in shared memory that a CandleMonitor node has been deployed, the event will be produced, and the agent will wait for a broker restart or redeploy to attempt detection again. Note if you chose not to use the node, this event is not a problem. Message flow statistics and events will not be available when this event is reported. Because of the five minute delay in reporting the event, the symptom of no statistics and events may precede the event by this amount of time.

Critical problem events that "should not happen"These events indicate critical problems that require more research via messages file and so forth, and result in missing data, because data collection is no longer taking place.

Page 202: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

202 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

Collector_Initialization_Failed

This event indicates that the broker collector failed to initialize for the given broker. The collector will not become active. KQIAgent may terminate depending on what led up to the failure.

Collector_Cycle_Processing_Failed

This event indicates that the broker collector failed during collection cycle for the given broker. The collector will not remain active. Previously collected data may stay available about the broker if the agent does not terminate.

Out of storage eventsThese events indicate out-of-storage occurrences. Some result in partial data loss; others result in agent termination. Any of these events show the need for you to supply more memory to the agent.

No_Storage—Message_Not_Processed

This event indicates that reply message data could not be captured due to lack of storage. By itself this event only indicates a partial loss of data. Requesting code will eventually report that the broker is not responding to its request.

No_Storage—Events_Not_Retained

This event indicates that the type of event (broker, message flow, or product) indicated by the reason cannot be retained for workspace views. Note that if this happens to be product events, hopefully this event will still make it to the historical log. By itself, this event just indicates that the given event report will not show data. If no other out-of-storage conditions impede processing, historical event logging will still take place, and broker events will be processed to update collected data as appropriate.

No_Storage—User_Data_Request_Affected

This event indicates that a data request could not be filled due to lack of storage. This will appear as missing data of the given type. The data is in its collected state, but just cannot be transformed to table rows to be passed to CandleNet Portal due to the storage shortage.

No_Storage—Collected_Data_Lost

This event indicates that data collected via request/reply is lost due to lack of storage. The type of data lost is given in the event. In this case, the data

Page 203: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Product Events 203

cannot be retained by the agent in its collected state, so it will not be available for report requests either.

No_Storage—Agent_Must_Shutdown

This event indicates that an out-of-storage condition arose for a critical part of the agent, and it must shut down. This is probably the eventual fate of an agent that is suffering from some of the other out-of-storage conditions covered by other events in which the agent can remain active.

Other Miscellaneous Events

Agent_Environment_Data_Missing

This event occurs when a call to get the platform, platform version, or host name has failed. This means that these columns in the workspaces that they are in will be missing. This is something that Candle should look into if it occurs.

Table_Query_Missing_Input_Data

This event occurs if a query to the Message Processing Node Attributes table does not have the required data of execution group name, message flow name, and message processing node label. These columns are required as index columns on queries for this data because the table agent does not support returning all rows for all entities in the broker (it would be too much data). The CandleNet Portal queries should have this correctly coded. However, at the time of this writing, there is a CandleNet Portal problem which is causing Message Processing Node Attributes to be a selectable workspace, for example on the View pull-down menu, in some cases. If you select the workspace from there, without linking to it from a specific row in the Message Processing Node Information workspace, the query will fail and this product event will occur.

This event will also occur if the Message Processing Node Attributes table is queried in a situation without providing all the required attribute matches that identify a single node within a message flow and execution group.

Userid_Not_Authorized_For_Command

This event occurs when a Take Action or automation command has been issued to the agent, and the issuing CandleNet Portal user ID is not authorized. The agent determines who is authorized by agent XML

Page 204: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

204 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

parameters “defaultTakeActionAuthUsers” and its override at the broker level “takeActionAuthUsers”. See “Agent Parameter Descriptions” on page 44 for more information.

Page 205: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Index 205

Index

AACL Entries workspace 130activateNode attribute 70Adobe portable document format 11agent parameter descriptions 44–54

see individual parameter namesagent parameter file

location of 36setting parameters in 40–43syntax of statements 39

agent parameter file sample 42Agent Status workspace 131Agent_Broker_Data_Requests_Failed 199Agent_Environment_Data_Missing 203Agent_Shutdown 198Agent_Userid_Group_Missing 198agentId attribute

of KqiAgent 44alerts 104archive accounting statistics

collection interval 123Archive Message Flow Accounting

workspace 132Archive Node Accounting workspace 135Archive Terminal Accounting

workspace 137Archive Thread Accounting workspace 139attributes

definition 31groups 31items 31structure 31

attributes within a workspace are desribed in online Help 121

Bbroker

starting automatically 94broker capacity planning 95Broker Events History workspace 142, 181Broker Events workspace 141Broker Information History workspace 144Broker Information workspace 143broker performance

preventing use of trace active 98Broker Statistics History workspace 146Broker Statistics workspace 145Broker Status workspace 147Broker Summary workspace 148broker/control center configuration

verifying 91Broker_Events_Subscription_Failed 199Broker_Not_Deployed—

Data_Unavailable 198Broker_Not_Responding 199Broker_Not_Started 198Broker_Product_Not_Installed 198Broker_Request_Message_Put_Failed 200

CCandle Customer Service and

Satisfaction 13Candle Web site 13CandleMonitor node

activating 65and input statistics 72and message flow events 76and sub-flows 73–76attributes 68–71configuration file 79creating softlinks on UNIX 62deleting 65integrating with broker 60overview of 58

Page 206: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

D

206 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

positioning 72–77reconfiguring 78–81

CandleMonitor node configuration file 79CandleMonitor node configuration

variables 79–81KQIActivateNode 80KQIActivateNodeForBROKERNAME 81KQIMemorySize 79KQINodeTrace 80KQITempDirectory 79

CandleMonitor Node Statistics History workspace 150

CandleMonitor Node Statistics workspace 149

CandleMonitor_Data_Retrieval_Failed 201CandleMonitor_Node_Not_Deployed 201capacity planning for brokers 95Collector_Cycle_Processing_Failed 202Collector_Initialization_Failed 202collectQueueTime attribute 68commands

see Take Action commandsTake Action 33

commandTimeoutInterval attributeof KqiAgent 47

componentDirectory attributeof MonitorBroker 51

Components History workspace 151Components workspace 151ConfigMgr_Qmgr_Name_Missing 199ConnectQueueManager parameter 53ConnectQueueManager tag 53ConnectQueueManager tag attributes

name 53replyQueueModel 54replyQueueName 53

Control Center 65customer support 13

Ddebugging a message flow 89defaultFlowEventInterval attribute

of KqiAgent 46defaultHistoricalAccountingType attribute

of KqiAgent 48defaultReplyQueueModel attribute

of KqiAgent 46defaultReplyQueueName attribute

of KqiAgent 46defaultRetainBrokerEvents attribute

of KqiAgent 45defaultRetainFlowEvents attribute

of KqiAgent 45defaultRetainRecentArchiveSamples

attributeof KqiAgent 49

defaultRetainRecentSnapshotSamples attribute

of KqiAgent 49defaultStatisticInterval attribute

of KqiAgent 45defaultTakeActionAuthUsers attribute

of KqiAgent 46deleting the CandleMonitor node 65determining when a message flow has

failed 90discoveryInterval attribute

of KqiAgent 45

EeventMessage attribute 69events 33

definition 32indicator 33workspaces 33

Execution Group Information workspace 153

Execution Group Statistics History workspace 155

Execution Group Statistics workspace 154

Ffiles

kqicm210.exe 65

Page 207: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Index 207

H

kqipnode.lil 64flowEventInterval attribute

of MonitorBroker 50

HHistorical Archive Node Accounting

workspace 136Historical Archive Terminal Accounting

workspace 138Historical Archive Thread Accounting

workspace 140historical data collection 28historical predefined situations

active upon product installation 105inactive upon product installation 106

Historical Snapshot Message Flow Accounting workspace 173

Historical Snapshot Node Accounting workspace 175

Historical Snapshot Terminal Accounting workspace 177

Historical Snapshot Thread Accounting workspace 179

historicalAccountingType attributeof MonitorBroker 52

holdTimeForQuery attributeof KqiAgent 47

Iintegrating the CandleMonitor node on

UNIX 62

Kkqi.log message file 197kqi.xml file 36kqi.xml file (or KQIXML member)

adding parameters 40changing parameters 39default contents 37

KQIActivateNode 80KQIActivateNodeForBROKERNAME 81KqiAgent attributes

defaultFlowEventInterval 46defaultRetainRecentSnapshotSamples 49

KqiAgent parameter 44KqiAgent tag 44KqiAgent tag attributes

agentId 44commandTimeoutInterval 47defaultHistoricalAccountingType 48defaultReplyQueueModel 46defaultReplyQueueName 46defaultRetainBrokerEvents 45defaultRetainFlowEvents 45defaultRetainRecentArchiveSamples 49defaultStatisticInterval 45defaultTakeActionAuthUsers 46discoveryInterval 45holdTimeForQuery 47maximumAgentCollectionThreads 47maximumCommandRetryCount 47retainProductEvents 45version 44

kqicm210.exe file 65kqicm500.exe 65KQIMemorySize 79KQINodeTrace 80kqipnode.lil file 64kqismpl.xml sample agent parameter file 42KQITempDirectory 79KQIXML 36KQIXML member 36

LLinux Intel/zSeries links 63

MmaximumAgentCollectionThreads attribute

of KqiAgent 47maximumCommandRetryCount attribute

of KqiAgent 47Message Brokers Toolkit 65

activating the CandleMonitor node 65

Page 208: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

N

208 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

message delivery failuredetermining 87

message flowdebugging 89determining when failed 90ensuring adequate response time 97starting/stopping at periodic intervals 99stopping when ouput queue is full 93

message flow events 76Message Flow Events History

workspace 156Message Flow Events workspace 156Message Flow Information workspace 158Message Flow Statistics History

workspace 161Message Flow Statistics workspace 160Message Processing Node Attributes

workspace 162Message Processing Node Information

workspace 164Message Processing Nodes workspace 166Monitor Broker tag attributes

takeActionAuthUsers 51MonitorBroker parameter 50MonitorBroker tag 50MonitorBroker tag attributes

componentDirectory 51flowEventInterval 50historicalAccountingType 52name 50retainBrokerEvents 51retainFlowEvents 51retainRecentArchiveSamples 53retainRecentSnapshotSamples 52statisticInterval 50

monitoring input statistics 72monitoring sub-flows 73–76

Nname attribute

of ConnectQueueManager 53of MonitorBroker 50

names, for sub-flows 75Navigator

physical view 30Neighbor Broker Information

workspace 167Neighbors workspace 167No_Brokers_Discovered_By_Agent 197No_Storage—Agent_Must_Shutdown 203No_Storage—Collected_Data_Lost 202No_Storage—Events_Not_Retained 202No_Storage—Message_Not_Processed 202No_Storage—

User_Data_Request_Affected 202

Pparameter descriptions 44–54

see individual parameter namesparameter file, agent

location of 36syntax of statements 39

parametersConnectQueueManager 53KqiAgent 44MonitorBroker 50

PDF files, adding annotations 12performance considerations 55physical view 30predefined situations 104

historical 105that raise alerts 104

Print to disk feature 125printing problems 11product events 197–204

Agent_Broker_Data_Requests_Failed 199Agent_Environment_Data_Missing 203Agent_Shutdown 198Agent_Userid_Group_Missing 198Broker_Events_Subscription_Failed 199Broker_Not_Deployed—

Data_Unavailable 198Broker_Not_Responding 199Broker_Not_Started 198

Page 209: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Index 209

Q

Broker_Product_Not_Installed 198Broker_Request_Message_Put_Failed 200CandleMonitor_Data_Retrieval_Failed 20

1CandleMonitor_Node_Not_Deployed 20

1Collector_Cycle_Processing_Failed 202Collector_Initialization_Failed 202ConfigMgr_Qmgr_Name_Missing 199No_Brokers_Discovered_By_Agent 197No_Storage—

Agent_Must_Shutdown 203No_Storage—Collected_Data_Lost 202No_Storage—Events_Not_Retained 202Queue_Manager_Connection_Failed 200Reply_Queue_Message_Get_Failed 201Required_Queue_Unavailable 200Table_Query_Missing_Input_Data 203Userid_Not_Authorized_For_Command 2

03Product Events History workspace 168Product Events workspace 168Properties editor 31Put/Get Message performance

usage scenario for monitoring 85

QQI Change Broker 113QI Change Flow Stats 113QI Change Trace Broker command 112QI Change Trace Component

command 110QI Create User Statistics 18, 115QI Delete Retained Publication

command 115QI Destroy User Statistics 19, 116QI Reset Statistics 19, 116QI Sample User Statistics

Take Action commandsQI Sample User Statistics 19, 115

QI Start Broker command 111QI Start Component command 109

QI Start Message Flow(s) comand 114QI Stop Broker and its Queue Manager

command 112QI Stop Broker command 111QI Stop Component and its Queue Manager

command 110QI Stop Component command 109QI Stop Message Flow(s) comand 114queries 32queue time statistics, how calculated 72Queue_Manager_Connection_Failed 200

RRecent Archive Node Accounting

workspace 136Recent Archive Terminal Accounting

workspace 138Recent Archive Thread Accounting

workspace 140Recent Snapshot Message Flow Accounting

workspace 173Recent Snapshot Node Accounting

workspace 175Recent Snapshot Terminal Accounting

workspace 177Recent Snapshot Thread Accounting

workspace 179Reply_Queue_Message_Get_Failed 201replyQueueModel attribute

of ConnectQueueManager 54replyQueueName attribute

of ConnectQueueManager 53Required_Queue_Unavailable 200retainBrokerEvents attribute

of MonitorBroker 51Retained Publications workspace 170retainFlowEvents attribute

of MonitorBroker 51retainProductEvents attribute

of KqiAgent 45retainRecentArchiveSamples attribute

of MonitorBroker 53retainRecentSnapshotSamples attribute

Page 210: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

S

210 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120

of MonitorBroker 52

Sscenarios for usage 83–102security failure on a subscription,

handling 102Situation editor 32situations

predefined 104snapshot accounting statistics

collection interval 123Snapshot Message Flow Accounting

workspace 171Snapshot Node Accounting workspace 174Snapshot Terminal Accounting

workspace 176Snapshot Thread Accounting

workspace 178starting a broker automatically 94statisticInterval attribute

of MonitorBroker 50stopping a message flow with a full output

queue 93sub-flow names 75Sub-Flow Statistics History workspace 181Sub-Flow Statistics Workspace 180subFlowName attribute 69sub-flows 73–76

definition 73names 75

subscription security failure, handling 102subscriptions

verifying 101Subscriptions workspace 182

TTable_Query_Missing_Input_Data 203tag

see parameterTake Action commands 108

QI Change Broker 113QI Change Flow Stats 113

QI Change Trace Broker 112QI Change Trace Component 110QI Create User Statistics 18, 115QI Delete Retained Publication 115QI Destroy User Statistics 19, 116QI Reset Statistics 19, 116QI Start Broker 111QI Start Component 109QI Start Message Flow(s) 114QI Stop Broker 111QI Stop Broker and its Queue

Manager 112QI Stop Component 109QI Stop Component and its Queue

Manager 110QI Stop Message Flow(s) 114using in situations 116

Take Action feature 33takeActionAuthUsers attribute

of MonitorBroker 51trace active

effect on broker performance 98trace data

collecting for a broker on unavailable system 92

type attribute 68Type I sub-flows 73Type II sub-flows 73

UUNIX softlinks 62usage scenarios 83–102user statistics workspaces 122Userid_Not_Authorized_For_Command 20

3

Vverifying the broker/Control Center

configuration 91version attribute

of KqiAgent 44views

Page 211: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

Index 211

W

definition 31physical 30

WWeb site, Candle 13workspaces

ACL entries 130Agent Status 131Archive Message Flow Accounting 132Archive Node Accounting 135Archive Terminal Accounting 137Archive Thread Accounting 139Broker Events 141Broker Events History 142, 181Broker Information 143Broker Information History 144Broker Statistics 145Broker Statistics History 146Broker Status 147Broker Summary 148CandleMonitor Node Statistics 149CandleMonitor Node Statistics

History 150Components 151Components History 151definition 31event 33Execution Group Information 153Execution Group Statistics 154Execution Group Statistics History 155Historical Archive Node Accounting 136Historical Archive Terminal

Accounting 138Historical Snapshot Message Flow

Accounting 173Historical Snapshot Node Accounting 175Historical Snapshot Terminal

Accounting 177Historical Snapshot Thread

Accounting 179Historical Thread Accounting 140Message Flow Events 156

Message Flow Events History 156Message Flow Information 158Message Flow Statistics 160Message Flow Statistics History 161Message Processing Node Attributes 162Message Processing Node

Information 164Message Processing Nodes 166Neighbor Broker Information 167Neighbors 167overview of 26, 121Product Events 168Product Events History 168Recent Archive Node Accounting 136Recent Archive Terminal Accounting 138Recent Archive Thread Accounting 140Recent Snapshot Message Flow

Accounting 173Recent Snapshot Node Accounting 175Recent Snapshot Terminal

Accounting 177Recent Snapshot Thread Accounting 179Retained Publications 170Snapshot Message Flow Accounting 171Snapshot Node Accounting 174Snapshot Terminal Accounting 176Snapshot Thread Accounting 178Sub-Flow Statistics 180Sub-Flow Statistics History 181Subscriptions 182user statistics 122

Page 212: OMEGAMON XE for WebSphere Integratiഀ漀渀 䈀爀漀欀攀爀猀 唀 …publib.boulder.ibm.com/tividd/td/ITOMEGAXEfWIB/GC32-9326... · 2004. 8. 28. · 1. Specify the print options

212 OMEGAMON XE for WebSphere Integration Brokers User’s Guide, Version 120


Recommended