PathWAI Web Response Monitor User’sഀ 䜀甀椀搀攀Ⰰ 嘀⸀⸀publib.boulder.ibm.com/tividd/td/ITPathWRMon/GC32... · 12 PathWAI Web Response Monitor User’s Guide, V1.1.2

User’s Guide PathWAITM Web Response Monitor

Version 1.1.2

GC32-9346-00

April 2004

Candle Corporation100 North Sepulveda Boulevard

El Segundo, California 90245

2 PathWAI Web Response Monitor User’s Guide, V1.1.2

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 eDelivery, 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 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 © April 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.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

Contents 3

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

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

What’s New in Version 1.1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 1. Introducing PathWAI Web Response Monitor . . . . . . . . . . . . . . 19PathWAI Web Response Monitor Overview . . . . . . . . . . . . . . . . . . . . 20PathWAI Web Response Monitor Components . . . . . . . . . . . . . . . . . 29

Chapter 2. Installing PathWAI Web Response Monitor . . . . . . . . . . . . . . . . 31Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Windows Installation Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38UNIX Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Starting and Stopping PathWAI Web Response Monitor . . . . . . . . . . 70Uninstalling Web Response Monitor . . . . . . . . . . . . . . . . . . . . . . . . . 73

Chapter 3. Managing Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Web Response Monitor Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Sysadmin: First Logon Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Admin Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Chapter 4. Monitoring Web Applications . . . . . . . . . . . . . . . . . . . . . . . . . . 83Getting Started with the Browser Interface . . . . . . . . . . . . . . . . . . . . 84Sending and Subscribing to Reports . . . . . . . . . . . . . . . . . . . . . . . . . 87

Contents


Chapter 5. Configuring Data Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Configuring the Analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Appliance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Configuring the Collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Data Collection Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106URL History Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108IIS Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Chapter 6. Consolidating Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Manager Client as a Windows Service . . . . . . . . . . . . . . . . . . . . . . . 120Configuring the Manager Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Manager Client Settings Notebook . . . . . . . . . . . . . . . . . . . . . . . . . 124Manager Client Initialization Parameters . . . . . . . . . . . . . . . . . . . . . 130Receiving Settings from Manager Server . . . . . . . . . . . . . . . . . . . . . 132Sending Data to Manager Server. . . . . . . . . . . . . . . . . . . . . . . . . . . 133Viewing Manager Client Status Messages. . . . . . . . . . . . . . . . . . . . . 135Manager Server as a Windows Service . . . . . . . . . . . . . . . . . . . . . . 136Running Manager Server under UNIX. . . . . . . . . . . . . . . . . . . . . . . 138Configuring the Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Manager Server Settings Notebook . . . . . . . . . . . . . . . . . . . . . . . . . 141Manager Server Initialization Parameters . . . . . . . . . . . . . . . . . . . . . 152Setting up Manager Clients from Manager Server . . . . . . . . . . . . . . 154Exception Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Email Transmission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Updating Manager Clients from Manager Server . . . . . . . . . . . . . . . 158Sending Data to Other Manager Servers . . . . . . . . . . . . . . . . . . . . . 164Storing Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Customizing Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174About Maintenance Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Appendix A. Data Record Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Web Page and Object Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Audio and Video Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Contents 5

Appendix B. Installing and Uninstalling the IIS Filters . . . . . . . . . . . . . . . . . 193Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Installing the IIS Filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Uninstalling the IIS Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201


Tables 7

Table 1. PathWAI Web Response Monitor Time Measurements. . . . . . . . . . . . 24Table 2. Windows Platform Support for Web Response Monitor Components 33Table 3. UNIX Platform Support for Web Response Monitor Components . . . 34Table 4. System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Table 5. Analyzer Configuration Options in File kfcmenv . . . . . . . . . . . . . . . . 93Table 6. Collector Configuration Options in File kflmenv . . . . . . . . . . . . . . . 104Table 7. Manager Client Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . 158Table 8. Data Types in Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Table 9. Schema Files and Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Table 10. HTTP Page and HTTP Object Record Fields . . . . . . . . . . . . . . . . . . 183Table 11. Audio/Video Data Record Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Tables


Figures 9

Figure 1. Example of an Analysis Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Figure 2. Time Calculation for Web Pages and Objects. . . . . . . . . . . . . . . . . . . 27Figure 3. Browser Interface Navigation Methods . . . . . . . . . . . . . . . . . . . . . . . 85

Figures


Preface 11

Preface

This guide gives instructions for installing, configuring, and using PathWAITM Web Response Monitor.

PathWAI Web Response Monitor is a Candle® Corporation product that uses non-invasive technology to measure the performance of Web-based applications. It provides response time, navigation path, and usage behavior information.

P

About This Book


About This Book

Who should read this bookThis User’s Guide is intended for

� eBusiness and Information Technology managers

� Operations managers

� Web site administrators

Where to look for more informationPathWAI Web Response Monitor includes online help for each product component. To access online help, select Help from the menu bar or click the Help button provided on settings pages and in dialog boxes.

We would like to hear from youCandle welcomes your comments and suggestions for changes or additions to this User’s Guide. A comment form located at the back of the book provides simple instructions for communicating with the Candle Information Development department.

You can also send email to [email protected]. Please include PathWAI Web Response Monitor User’s Guide, V1.1.2 in the subject line.

Preface 13

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.



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.

http://www.adobe.com

Preface 15

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.

http://www.candle.com

http://www.candle.com



What’s New in Version 1.1.2 17

What’s New in Version 1.1.2

New featuresThis version of PathWAI Web Response Monitor provides a number of changes and enhancements. These are the most important.

Web browser user interface

The new Presenter component of Web Response Monitor provides several types of Web browser-based reports:

� Real-time reports summarize Web application performance.

� Response time reports provide more detailed, segmented response time and throughput data.

� Analysis reports organize the response time and throughput data statistically.

To support report creation, Manager Server and an ODBC or JDBC database must be installed with the product. To support report presentation, Jakarta Tomcat Server is installed with Presenter.

Email reports and subscriptions

You can send Web Response Monitor reports to your own email account, forward them to other email accounts, and subscribe to daily reports. When you subscribe to a report, the report is sent to your email account every day at a specified time.

W


HTTPS filters

You can install filters to enable monitoring of HTTPS transactions on IIS, iPlanet Web Server, and iPlanet Web Proxy Server.

Changes to Analyzer configuration options

A number of new configuration options have been provided for the Analyzer component. See “Configuring Data Collection” on page 89 for details.

URL frame merge history files

If enabled, a dynamic URL history file keeps a record of the way URLs are merged; that is, which URLs are embedded as frames in each parent URL. When Web Response Monitor encounters those URLs again, it merges them in the same manner as recorded in the history file. By basing current URL merges on the URL history, Web Response Monitor can provide more meaningful, consistent response time and other statistics.

Web Response Monitor also provides a permanent URL history file, which you can edit to override the dynamic history file’s frame merge specifications.

For detailed information, see “URL History Files” on page 108.

Additional fields in data records

Two fields have been added to the HTTP page and HTTP object data records:

� Page Title: contains the title specified in the HTML code for the page.

� Method: HTTP method used (GET, POST, etc.)

For further information about the data records, see “Data Record Formats” on page 179.

To accommodate the new data record formats, the latest version of Manager Server must be installed. This is the version provided on the product CD.

Introducing PathWAI Web Response Monitor 19

IntroducingPathWAI Web Response Monitor

IntroductionThis chapter introduces the features and components of PathWAI Web Response Monitor.

Chapter ContentsPathWAI Web Response Monitor Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

What PathWAI Web Response Monitor does . . . . . . . . . . . . . . . . . . . . . . . . . 20PathWAI Web Response Monitor reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20How PathWAI Web Response Monitor works . . . . . . . . . . . . . . . . . . . . . . . . . 21Network protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Application protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22HTTP transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22HTTPS transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Video and audio streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Information gathered . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24How Web Response Monitor calculates Web page response time . . . . . . . . . . 26How you can use Web Response Monitor data. . . . . . . . . . . . . . . . . . . . . . . . 28

PathWAI Web Response Monitor Components . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Product components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Data collection components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Data presentation components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1

PathWAI Web Response Monitor Overview



What PathWAI Web Response Monitor doesPathWAI Web Response Monitor is a Candle Corporation product that uses non-invasive technology to measure the performance of Web-based applications. It provides response time and other performance data, and tracks navigation paths and usage behavior for:

� Web pages and their embedded objects (for example, graphics files)

� video and audio streams

� HTTP header requests

The Web Response Monitor performance metrics help you determine the quality of service of your Web-based applications, as actually experienced by your customers and other requestors. Those requestors can be:

� end users visiting Web sites

� machines performing application-to-application or business-to-business processes

In real time, Web Response Monitor analyzes response time data and other performance statistics, isolates fault domains and performance bottlenecks, and sends email notification of any problems discovered. Problem alerts can be sent to desktop or mobile email addresses.

PathWAI Web Response Monitor reportsPathWAI Web Response Monitor offers three types of reports in its Web browser user interface:

� Real-time reports summarize Web application performance.

� Response time reports provide more detailed, segmented response time and throughput data.

� Analysis reports organize the response time and throughput data statistically.



Figure 1. Example of an Analysis Report

How PathWAI Web Response Monitor worksPathWAI Web Response Monitor runs as a separate application on the Web server machine. No code runs on users’ workstations, and no Web server configuration changes are required. The product does not interfere with network data flow, affect network performance, or alter transmitted data; and it does not identify individual users.

From its position on the Web server machine, Web Response Monitor examines network transmission data and measures transaction response time based on network and application protocols.

Network protocolsPathWAI Web Response Monitor can calculate response time for Web transactions that use the TCP/IP protocol. Network protocol response time is the elapsed time of the data exchange between a network addressable source and a network addressable destination. Web Response Monitor interprets specific protocol details and determines whether each request and its subsequent data replies have been delivered and acknowledged. By



monitoring this data exchange cycle, Web Response Monitor calculates network protocol response time and collects other important information.

Application protocolsNetwork protocol response time is only part of the picture. Each Web application transaction—such as downloading a file, retrieving a Web page, playing a video clip, or performing a database inquiry—represents a unit of work, with tangible business value to your customers. Therefore, Web Response Monitor further processes and consolidates response time measurements, based on specific application protocols. The resulting application response time takes into consideration the possibility of parallel and concurrent network transaction activities. For example, the response time for a Web page is not the total of the response time for the page itself and the response times of all the objects (such as graphics) embedded in the page, because the page and its embedded objects are retrieved in parallel fashion. Web Response Monitor arrives at an accurate figure for total response time for the page, and its figures for the response time of each embedded object tell you which objects are causing page download delays.

HTTP transactionsWeb Response Monitor can monitor HTTP transactions without any modification of the Web server configuration. The daily data log created by the Collector component of the product contains separate records for each Web page and for each object embedded in that Web page. The Collector generates a Web object record only if the object is served by the monitored Web server. Even if a Web page comes from the monitored Web server, some of its embedded objects might come from other servers. In that case, the Collector would create log records for the Web page and for the objects served by the monitored server, but not for the objects served by the other servers.

Even if an embedded object comes from a monitored Web server, the Collector might not create an object record for it if the object takes a long time to retrieve. In that case, the object is excluded from the total response time calculation for the page. Later, when the browser retrieves the object, the Collector generates a Web page record for it, rather than an object record.



HTTPS transactions

Windows

To monitor HTTPS (secure HTTP) transactions on Windows machines, Web Response Monitor requires installation of a global IIS filter (see page 40 for instructions).

UNIX

Web Response Monitor can monitor HTTPS transactions on iPlanet (also known as Sun One and Netscape iPlanet) Web servers and on iPlanet Web Proxy servers, but not on Apache Web servers. To monitor HTTPS transactions, Web Response Monitor requires installation of an HTTPS filter (see page 60 for instructions).

The HTTPS filter works on Solaris 2.7 and 2.8, with these server versions:

� iPlanet Web Server version 4.x or 6.x

� iPlanet Web Proxy Server version 3.6

Video and audio streamsWeb Response Monitor can monitor these video streams:

� Microsoft Windows Media

� QuickTime

� RealSystem

and these audio streams:

� Microsoft Windows Media

� RealSystem

Note: Web Response Monitor can monitor Real Time Streaming Protocol (RTSP) conducted on Transmission Control Protocol (TCP) transport, but not on User Datagram Protocol (UDP) transport.



Information gatheredPathWAI Web Response Monitor captures and logs these time measurements.

Table 1. PathWAI Web Response Monitor Time Measurements

Transaction type

Time measurement Definition

HTTP pages Total response time Time between the user’s request and the Web browser’s completion of the Web page transaction.

Response time for the page includes response time for all embedded objects and frames, unless the Analyzer is configured otherwise. See “Analyzer configuration file kfcmenv” on page 92, particularly the descriptions of these configuration options:� KFC_HTTP_GROUP_PAGE_OBJECTS� KFC_HTTP_MERGE_FRAMES� KFC_HTTP_MERGE_REDIRECT� KFC_HTTP_MERGE_SESSION_DATA

Load time Time elapsed between the user’s request and completion of the Web page download.

Resolve time Time elapsed between completion of the Web page download and full rendering of the page at the browser.

Server time Time the Web server takes to process the transaction.

Network time Time spent transmitting all required data through the network.



For more information about logged data, see “Data Record Formats” on page 179.

HTTP objects

Total response time Time between the user’s request and the Web browser’s completion of the Web object download and rendering.

Note: In an Intranet, total response time for an object may be the same as load time.

Load time Time elapsed between the user’s request and completion of the Web object download.

Resolve time Time elapsed between completion of the Web object download and full rendering of the object at the browser.

Server time Time the Web server takes to process the transaction.


Audio Total response time Time between the user’s request and completion of the audio stream.

Play time Length of audio play, minus any gaps for pausing or fast-forwarding.


Video Total response time Time between the user’s request and completion of the audio and image streams.

Play time Length of audio and image play, minus any gaps for pausing or fast-forwarding.


Table 1. PathWAI Web Response Monitor Time Measurements (continued)

Transaction type

Time measurement Definition



How Web Response Monitor calculates Web page response timeEach HTTP transaction has several basic steps:

1. The browser sends an HTTP page request to a Web server.2. The Web server sends back an HTTP response, which contains the page.3. The browser parses the page and renders it. When the browser encounters

an embedded object such as a .gif file, it sends another request back to the Web server.

4. The Web server sends back a response, which contains the requested object.

In the example shown at right, the user at a Web browser has requested a page with three embedded .gif objects. Unless configured otherwise, PathWAI Web Response Monitor generates

� an HTTP page data record for the total response time of the page, including the response time of the three embedded objects

� three HTTP object data records, one for each .gif object

To determine the object type, Web Response Monitor examines the object Multipurpose Internet Mail Extensions (MIME) type delivered by the server. If the MIME type specification is not present in the data stream, Web Response Monitor uses the filename extension (for example, .gif, .jpg, or .js) as a guide for setting the object type. See “KFC_HTTP_CUSTOM_OBJECTS” on page 95 for a list of the default object types and for instructions on adding object types to the list.

Figure 2 on page 27 shows the way response time is measured for HTTP pages and embedded objects. Web Response Monitor takes a timestamp at each point in the transaction, and calculates response time based on the timestamps.� Load time for the page is determined by adding the response time for the page

without its embedded objects (timestamp 5 minus timestamp 2 in Figure 1) to the session connect time (timestamp 2 minus timestamp 1).

.gif object 1

2

3



� Resolve time for the page is determined by subtracting the timestamp at the first embedded object request (point 4) from the timestamp at completion of the last embedded object request (point 7).

� The gap (positive number) or overlap (negative number) of Load time and Resolve time is the difference between the timestamp at the first embedded object request (point 4) and the timestamp when the Web server sends the last packet of the page HTML (point 5).

� Total response time is the greater of these two calculations:– completion of the last embedded object request (point 7) minus the

page request timestamp (point 1)– Load time plus Resolve time, plus gap or overlap

Figure 2. Time Calculation for Web Pages and Objects

1 Browser sends a page request to the Web server.

2 Server receives the request.

Total Response Time

Server Time

Network Time

Load Time

Resolve Time

Overlap

1 2 3 4 5 6 7



How you can use Web Response Monitor dataWeb Response Monitor provides the information your business needs for understanding and improving the quality of service of your Web-based applications. The product’s capabilities enable you to understand users’ experience of navigating your Web site: where they go, how long they spend, and how long they wait for each Web page to download. This information tells you whether your Web applications are providing efficient service for your customers.

Armed with time and usage information, you can make your Web applications more responsive and easier to use, thereby improving customer loyalty and retention. Research shows that online customers are most loyal to sites that are fast and easy to navigate. Web Response Monitor data provide insights that allow for improvements in these critical areas.

3 Server sends the first packet.

4 Browser requests the first embedded object.

5 Server sends the last packet of the page HTML.

6 Server sends the last packet of the last embedded object.

7 Browser receives the last packet of the last embedded object.


PathWAI Web Response Monitor Components


Product componentsPathWAI Web Response Monitor has two types of components.

� Data collection components reside on the Web server machine, where they examine network traffic and calculate and log response time and other Web application performance data.

� Data presentation components insert the data into a predefined database and display reports in an Internet Explorer browser window.

Data collection componentsThe data collection components are installed together on the Web server machine.

Analyzer

The Analyzer detects and tracks network transactions between your Web server and end users or other machines, and calculates response time for each transaction. The Analyzer can be set to operate in appliance mode if it cannot be installed on the desired machine. (See “Appliance Mode” on page 102.)

Collector

The Collector writes log files that identify the type of each transaction (HTTP page, HTTP object, video, or audio) and provide its performance and usage statistics.

Manager Client

Manager Client sends the data at preset intervals to the Manager Server for insertion into the Web Response Monitor database.

Manager Client features include:

� using TCP/IP or email to transmit data to the Manager Server

� compressing all data sent by TCP/IP before the data enter the network

� monitoring for exceptions and transmitting exception data in real time



Data presentation componentsThe data presentation components can be installed together on the same machine or separately on different machines.

Manager Server

Manager Server receives the response time data collected and processed at various Web servers, and writes the data to database tables for report presentation and data warehousing. The Manager Server can reside on any machine in the network, provided that the operating system is supported by the product. (See “Platform support” on page 33.)

Manager Servers can be linked together in a hierarchical fashion to provide further scope. All data passed between Manager Client and Manager Server or between Manager Servers are compressed.

Any database software that supports Open DataBase Connectivity (ODBC) or Java DataBase Connectivity (JDBC) drivers can be used by Manager Server. For example, you can use Microsoft Access, Oracle, Microsoft SQL Server, or Informix database products, so long as the necessary drivers are installed and configured on the same machine as the Manager Server and the driver data source name is defined in the Manager Server settings.

Presenter

Presenter builds reports from the database tables, and displays them in an Internet Explorer browser window. Presenter also sends alerts by email. These reports and alerts help you identify performance problems, analyze service levels, and manage your Web applications.

Presenter runs on any of the supported Windows platforms (see “Platform support” on page 33). Jakarta Tomcat server is installed with Presenter, to support report creation and display. Tomcat server can be installed in either of two ways: standalone, or integrated with IIS. If Tomcat server is integrated with IIS, browser requests to the Presenter use the default HTTP port and then are redirected from IIS to Tomcat.

Installing PathWAI Web Response Monitor 31

InstallingPathWAI Web Response Monitor

IntroductionThis chapter gives instructions for installing PathWAI Web Response Monitor.

Tip: For last-minute updates to the installation requirements and procedures, see the Readme file that accompanies the product.

Chapter ContentsPrerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Platform support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Refer to the Readme file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Ready to install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Windows Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Required authority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Network Monitor requirement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Possible uninstallation requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Microsoft Installer version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Installation steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Step 1. Install the data collection components . . . . . . . . . . . . . . . . . . . . . . . . 40Step 2. Install the data presentation components . . . . . . . . . . . . . . . . . . . . . . 44Step 3. Set up a Web Response Monitor database . . . . . . . . . . . . . . . . . . . . . 47Step 4. Install Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Step 5. Verify data collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Step 6. Verify communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51What’s next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

UNIX Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Required permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

2


Prerequisite for HP-UX 11.0 machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Installation steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Step 1. Install data collection components . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Step 2. (Optional) Install the Web Response Monitor HTTPS filter . . . . . . . . . 60Step 3. Install Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Step 4. Verify data collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Step 5. Verify communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67What’s next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Starting and Stopping PathWAI Web Response Monitor . . . . . . . . . . . . . . . . . . . . 70Order is important . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70(Windows) Starting Web Response Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . 70(Windows) Stopping Web Response Monitor . . . . . . . . . . . . . . . . . . . . . . . . . 71(UNIX) Starting PathWAI Web Response Monitor . . . . . . . . . . . . . . . . . . . . . . 71(UNIX) Stopping Web Response Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Uninstalling Web Response Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73


Prerequisites

Prerequisites

Platform supportThe Presenter component (including Jakarta Tomcat Server, which supports the Web browser user interface) runs on Windows platforms only. All other Web Response Monitor components run on either Windows or UNIX, and some components require Java. This section lists the supported operating systems and required version of Java for each component.

Note: The required version of Java for each component is installed along with the component.

Windows

Table 2. Windows Platform Support for Web Response Monitor Components

Components Operating System Java

Data collection components, installed on one Web server machine:� Analyzer� Collector� Manager Client

Any of these:� Windows NT 4.0, Service Pack 6a� Windows 2000, Service Pack 3� Windows XP, Service Pack 1� Windows 2003

JRE 1.3.1 for Manager Client (no Java requirement for Analyzer and Collector)

Presenter(including Jakarta Tomcat Server)

Any of these:� Windows NT 4.0� Windows 2000� Windows XP� Windows 2003

JRE 1.3.1

Manager Server Any of these:� Windows NT 4.0� Windows 2000� Windows XP� Windows 2003

JRE 1.2.2

Prerequisites


UNIX

Table 3. UNIX Platform Support for Web Response Monitor Components

Components Operating System Java

Data collection components, installed on one Web server machine:� Analyzer� Collector� Manager Client

Any of these:� AIX 4.3� HP-UX 11.0� Solaris 2.7 or 2.8� Linux kernel 2.2.16 or higher, Intel

architecture

� JRE 1.1.8 for Manager Client on all UNIX platforms except Linux

� JRE 1.3.1 for Manager Client on Linux

No Java requirement for Analyzer and Collector

Manager Server Any of these:� AIX 4.3� HP-UX 11.0� Solaris 2.7 or 2.8� Linux kernel 2.2.16 or higher, Intel

architecture

� JRE 1.1.8 on all UNIX platforms except Linux

� JRE 1.3.1 on Linux


Prerequisites

RequirementsThis table lists the prerequisites for installing and running the product.

Table 4. System Requirements

Component Disk Space Other Requirements

All See component totals, below

� Pentium II or higher.� Processor speed of at least 400 MHz.� At least 128 MB memory.

Data collection components, installed on one Web server machine:� Analyzer� Collector� Manager

Client

Product:32 MB

Runtime 32 MB

� Additional disk space for data logging and diagnostic tracing. Log file size varies by amount of product use and by settings for automatic deletion of older logs. Make sure the directory you choose for the log files contains adequate space, is archived and purged regularly, and is not being used for other log files.

� TCP/IP or email for data transmission.� (Windows only) Network Packet Protocol (NPP) tools.

– 2000, XP, and 2003: NPP tools are included in the Network Monitor, which is bundled with the system drivers and must be installed separately. For instructions, see “Network Monitor requirement” on page 38.

– NT: If SMS 2.0 Network Monitor has not already been installed, you can install it from Microsoft Back Office Disk 6, in the SMS20\Nmext\i386 subdirectory.

Presenter (including Tomcat Server)

Product:40 MB

Runtime 40 MB

� Internet Explorer.� Graphics card displaying at least 256 colors.� At least 24-bit monitor.� Email for transmission of alerts.

Manager Server

Product:2 MB

Runtime Windows:24 MB

UNIX:8 MB

� ODBC or JDBC driver.� TCP/IP or email for data transmission.� Additional disk space for data logging and diagnostic

tracing. Log file or database table size varies by amount of product use and by settings for automatic deletion of older logs.

Prerequisites


UNIX note for online help: On UNIX platforms, Web Response Monitor is set up to invoke Netscape Navigator for display of the online help. If you are running some other frame-compatible browser (such as Mosaic) or if Netscape Navigator is not in the bin path, you can edit these files after PathWAI Web Response Monitor installation to point to the correct browser:

� Manager Server:<Candle_Home>/mgmt/manager/server/help.sh

� Manager Client:<Candle_Home>/mgmt/manager/client/help.sh

Java Runtime Environment (JRE) or Java Development Kit (JDK)

JRE1.3.1:23 MB

JRE 1.2.2:22 MB

JRE 1.1.8:6 MB

� (Windows) JRE 1.3.1 is installed automatically with the Manager Client and with the Presenter. JRE 1.2.2 is installed automatically with the Manager Server.

� (Linuz) JRE 1.3.1 is installed automatically during product installation.

� (Other UNIX platforms) JRE 1.1.8 is installed automatically during product installation.

Tip: Under Solaris, X Window System Version 11 (X11) support is required for JRE to function. If X11 support has not been installed, you need to add these two modules to your configuration:� LIBX11.SO.4 � LIBXEXT.SO.4

User’s Guide 3.0 MB Acrobat Reader 3.0 or above, to display and print this User’s Guide. Acrobat Reader for Windows is included on the PathWAI Web Response Monitor CD. Acrobat Reader for UNIX platforms can be downloaded from www.adobe.com.

Online help for each product component

Included in component total

Java-enabled Web browser.

Table 4. System Requirements (continued)

Component Disk Space Other Requirements


Prerequisites

Refer to the Readme fileBefore you begin to install, review the readme.txt file on the product CD for any installation issues that may have come up after this guide went into production.

Ready to installYou are now ready to begin installing PathWAI Web Response Monitor.

� Windows: See “Windows Installation Procedure” on page 38.� UNIX: See “UNIX Installation Procedure” on page 55.

Windows Installation Procedure



Required authorityBefore you install Web Response Monitor, make sure you are logged onto Windows as an administrator, so that entries can be built automatically and components can be run as Windows services. The product components are started and stopped from the Services panel.

Network Monitor requirementOn Windows platforms, PathWAI Web Response Monitor requires the Network Packet Protocol (NPP) tools, which are included in Network Monitor.

� 2000, XP, and 2003: Network Monitor is bundled with the system drivers and must be installed separately. To install it, you must be logged onto Windows as an administrator.

To install the Network Monitor Driver:

1.Select Start > Settings > Control Panel > Network and Dial-up Connections.

2.Double-click Local Area Connection.

3.In the Local Area Connection Status dialog, click Properties.4.On the General tab of the Local Area Connection Properties dialog,

look for Network Monitor Driver in the list of items. If you find it there, it is already installed, and you can cancel the dialog and skip the rest of the Network Monitor installation instructions.If you do not find Network Monitor Driver on the list, click Install.

5.In the Select Network Component Type dialog, select Protocol and click Add.

6.In the Select Network Protocol dialog, select Network Monitor Driver and click OK.

7.If prompted for additional files, insert your Windows CD-ROM, or type a path to the network location of the files.



8.If you have not already done so, install Service Pack 1 on Windows XP or Service Pack 3 on Windows 2000. These Service Packs include an NPP fix that enables Web Response Monitor to report the correct byte count for each transaction. You can download Service Pack 3 from http://v4.windowsupdate.microsoft.com/en/default.asp.

� NT: If SMS 2.0 Network Monitor has not already been installed, you can install it from Microsoft Back Office Disk 6, in the SMS20\Nmext\i386 subdirectory. Be sure to install Service Pack 6a, which includes an NPP fix that enables Web Response Monitor to report the correct byte count for each transaction. You can download Service Pack 6a from http://v4.windowsupdate.microsoft.com/en/default.asp.

Note: The version of Network Monitor that is bundled with Windows NT Server and Advanced Server does not satisfy this requirement. The required version is SMS 2.0 Network Monitor, which you can install as described directly above.

Possible uninstallation requirementIf PathWAI Web Availability Monitor, PathWAI Web Segment Analyzer, or another release of PathWAI Web Response Monitor has ever been installed on the machine where you plan to install PathWAI Web Availability Monitor, then you must uninstall that product before you begin installation. Follow the uninstallation instructions in the User’s Guide that accompanies the product release you want to uninstall.

Microsoft Installer versionIf the version of Microsoft Installer on your machine is lower than 2.0, the installer will be upgraded automatically before installation of Web Response Monitor begins. When the upgrade is complete, you may be prompted to reboot.

If you are installing Web Response Monitor from a network drive and you are prompted to reboot, the network drive must be connected when your machine is rebooted, or the Web Response Monitor installation may fail to launch.

http://v4.windowsupdate.microsoft.com/en/default.asp

http://v4.windowsupdate.microsoft.com/en/default.asp



Installation stepsTo install PathWAI Web Response Monitor, follow these procedures.

1. Install the data collection components (page 40).

2. Install the data presentation components (page 44 ).

3. Set up an Web Response Monitor database (page 47 ).

4. Install Manager Server (page 48).

5. Verify data collection (page 50).

6. Verify communications (page 51).

Step 1. Install the data collection components

1. Insert the product CD into the CD-ROM drive of the Web server machine where you want to install the PathWAI Web Response Monitor data collection components (Analyzer, Collector, Manager Client, and IIS Candle filter).The installation main menu should launch automatically. Otherwise, double-click launch.exe at the root level of the CD.

2. Select Install Products from the installation main menu.If the machine is running a version of Microsoft Installer earlier than 2.0, the Installer is automatically upgraded at this point, and you are prompted to reboot. Do so and continue.

3. Select Web Performance Manager from the Install Products menu.

4. Click Next on the Welcome dialog of the InstallShield Wizard.

5. Read the license agreement and click Yes to accept it.The Select Installable Features dialog lists products and components that can be installed.

6. Check the boxes for: � Web Response Monitor - Collection to install the Analyzer, Collector, and

Manager Client components.

� IIS Candle Filter to install the global IIS filter that enables HTTPS monitoring. Web Response Monitor can monitor HTTP transactions without any modification of the IIS configuration. However, if you also want to monitor HTTPS (secure HTTP) transactions, you need to install the IIS Candle filter on the monitored Web server machine.



Note: These instructions assume that you are installing the data collection components and the IIS Candle filter on the same Web server machine, and that you will install the data presentation components on a different machine.

7. Click Next to proceed.The Setup Type dialog is displayed.

8. Select Custom and click Next.The Choose Destination Location dialog is displayed. The default program location is C:\Program Files\Candle\PathWAI

9. To accept this location, click Next on the Choose Destination Location dialog. To change the location, click Browse and select another folder; then click Next.

10. Specify how many days you want the Collector data log files to be kept before deletion, and click Next. The default is 7 days. If you do not want the log files to be deleted automatically, specify 0. You will be able to change this and other Collector settings after installation. See “Configuring Data Collection” on page 89.

11. Select the types of data you want the Collector to log for HTTP transactions, and click Next.� Log HTTP Main to log response time data for each Web page URL.

� Log HTTP Objects to log response time data for each object (for example, .gif or .jpg files) contained in every Web page.

The default is HTTP Main (Web page data) but not HTTP Objects (Web object data). Logging data for every Web object greatly increases the size of the log files.

12. Select the types of data you want the Collector to log for Microsoft Windows Media transactions, and click Next.� Audio to log response time data for audio transmissions.

� Video to log response time data for video transmissions.

By default, neither audio nor video is selected.

13. Select the types of data you want the Collector to log for RealPlayer Media transactions, and click Next.� Audio to log response time data for audio transmissions.



� Video to log response time data for video transmissions.

By default, neither audio nor video is selected.

14. If you want the Collector to log QuickTime transactions, check the QuickTime box. By default, QuickTime transactions are not logged.

15. On the Database Options dialog, specify the database you are planning to use.

A. (ODBC database only) Check ODBC and enter in the Data Source field the data source name (for example, WRM_DB) you want to use for the Web Response Monitor database.The data source name (DSN) is used to identify the database. It is not the database filename.

Important: Make a note of the data source name you specify. For Web Response Monitor to connect to the database, the DSN specified here must be identical to the DSN you will specify when you set up the database. The DSN is case-sensitive.

B. (JDBC database only) Check JDBC, and specify the JDBC driver in the Driver field and the database name in the Data Source field.Tip: For Oracle JDBC drivers, oracle.jdbc.driver.OracleDriver is the Driver Name. Here is an example of a database connection (data source) name:

jdbc:oracle:thin:@hermes:1521:OS25 where hermes is the hostname, 1521 is the port number that connects to the Oracle database, and OS25 is the Oracle database instance

C. If needed, specify the user ID and password for the database.D. Click Next to proceed.

16. On the Manager Client Parameters dialog:A. In the Hostname field, enter the full network name or dotted decimal

IP address of the machine where Manager Server will be installed. If the Manager Server and Manager Client will be installed on the same machine, enter localhost.If you enter the correct server name and either specify valid port numbers or accept the default numbers during the next steps, the Manager Client will be configured to communicate with the Manager Server.



Note: If Manager Client is installed on a system with more than one network interface, you may need to direct TCP/IP traffic through a specified network interface. See the chapter titled Consolidating Data.

B. In the Receive field, enter the port number on which Manager Server will receive data. The Manager Client will use this port number to transmit data to the Manager Server. The default is 8192. You can use this port number unless it is already in use.

C. In the Send Port field, enter the port number Manager Server will use for sending requests. The Manager Client will use this port number for receiving requests from the Manager Server. The default is 9200. You can use this port number unless it is already in use.Tip: If you specify port numbers other than the defaults, write them down. You will need to specify the same numbers during Manager Server installation.

D. Click Next to proceed to the Manager Client Operating Mode dialog.

17. Select the Manager Client’s operating mode:� Hidden: No Manager Client user interface is provided.

� Normal: The Manager Client user interface displays console messages but does not include controls and settings.

� Admin: The full Manager Client user interface is provided, including console, settings, and other controls.

� Batch: Manager Client sends data on startup and then shuts down.

18. Click Next to proceed, then click Next again to accept the program folder for the product icons.

19. Check the boxes for the components to be started automatically whenever Windows is rebooted.The components listed are installed as Windows services. Web Response Monitor does not require that a user be logged onto the system for these components to run.

Note: Some of the components listed are common components of several PathWAI products. All are necessary for proper operation of Web Response Monitor.

20. Click Next to proceed, then click Next again to begin copying files.



Web Response Monitor Setup copies the component files to the machine. If the Candle IIS filter was selected, Setup automatically:

A. stops IIS services.B. installs a global filter.C. restarts IIS services.

If any errors occur during automatic installation of the IIS filter, you will see an error message, and you will need to install the filter from the Internet Services Manager console.

See “Installing and Uninstalling the IIS Filters” on page 193.

21. When the installation is complete, click Finish to exit the InstallShield wizard. Go on to Step 2.

Step 2. Install the data presentation components

1. Insert the product CD into the CD-ROM drive of the Windows machine where you want to install the Web Response Monitor data presentation components (Presenter and Jakarta Tomcat Server).The installation main menu should launch automatically. Otherwise, double-click launch.exe at the root level of the CD.

2. Select Install Products from the installation main menu.If the machine is running a version of Microsoft Installer earlier than 2.0, the Installer is automatically upgraded at this point, and you are prompted to reboot. Do so and continue.

3. Select Web Performance Manager from the Install Products menu.


5. Read the license agreement and click Yes to accept it.The Select Installable Features dialog lists products and components that can be installed.

6. Select Web Response Monitor - Presentation and click Next.A pop-up dialog asks whether you want Jakarta Tomcat servlet server to use IIS or to run standalone.



� Tomcat with IIS is recommended if IIS 4.0 or higher is already installed on the machine, and if you want to implement Web Response Monitor security by using the Secure Sockets Layer (SSL) protocol with IIS. When Tomcat runs with IIS, browser requests for report presentation are redirected from IIS to Tomcat.

� Tomcat Standalone is recommended if IIS is not installed on the machine, or if you prefer to display reports without using IIS.

7. Click Yes for Tomcat with IIS, or No for Tomcat standalone.The Setup Type dialog is displayed.

8. Select Custom and click Next.The Choose Destination Location dialog is displayed. The default program location is C:\Program Files\Candle\PathWAI

9. To accept this location, click Next on the Choose Destination Location dialog. To change the location, click Browse and select another folder; then click Next.

10. Read the Tomcat license agreement and click Yes to accept it.

11. Web browser presentation of Web Response Monitor reports requires an ODBC or JDBC database. On the Database Options dialog, specify the database you are planning to use.

A. (ODBC database only) Check ODBC and enter in the Data Source field the data source name (for example, WRM_DB) you want to use for the Web Response Monitor database.The data source name (DSN) is used to identify the database. It is not the database filename.

Important: Make a note of the data source name you specify. For Web Response Monitor to connect to the database, the DSN specified here must be identical to the DSN you will specify when you set up the database. The DSN is case-sensitive.

B. (JDBC database only) Check JDBC, and specify the JDBC driver in the Driver field and the database name in the Data Source field.Tip: For Oracle JDBC drivers, oracle.jdbc.driver.OracleDriver is the Driver Name. Here is an example of a database connection (data source) name:

jdbc:oracle:thin:@hermes:1521:OS25



where hermes is the hostname, 1521 is the port number that connects to the Oracle database, and OS25 is the Oracle database instance

C. If needed, specify the user ID and password for the database.D. Click Next to proceed.

12. On the Specify Mail Options dialog:A. In the Hostname field, enter the name of the mail server used at your

site. (Example: mailserver.domain.com)B. In the From ID field, enter the email address you want Web Response

Monitor to use when sending out email reports. C. In the Interval field, enter the number of minutes Web Response

Monitor should wait before checking for reports to email to subscribed users.

13. Click Next to proceed, then click Next again to accept the program folder for the product icons.

14. Check the boxes for the components to be started automatically whenever Windows is rebooted.The components listed are installed as Windows services. Web Response Monitor does not require that a user be logged onto the system for these components to run.

Note: Some of the components listed are common components of several PathWAI products. All are necessary for proper operation of Web Response Monitor.

15. Click Next to proceed, then click Next again to begin copying files.Web Response Monitor Setup copies the component files to the machine. If Tomcat with IIS was selected, Setup automatically:

A. stops IIS services.B. installs a global filter that will redirect from IIS to Tomcat any browser

requests addressed to Presenter.C. restarts IIS services.

If any errors occur during automatic installation of the IIS filter, you will see an error message, and you will need to install the filter from the Internet Services Manager console.

See “Installing and Uninstalling the IIS Filters” on page 193.



16. When the installation is complete, click Finish to exit the InstallShield wizard. Go on to Step 3.

Step 3. Set up a Web Response Monitor databasePathWAI Web Response Monitor presents response time, throughput, and other data in Web browser-based reports. These reports require that an ODBC or JDBC database be set up before the Web Response Monitor Web browser interface is started.

� To set up an Oracle JDBC database, go to “Setting up an Oracle JDBC database” on page 48.

� To set up an ODBC database, follow the instructions immediately below.

Setting up an ODBC database

1. Select:� (Windows NT) Start > Settings > Control Panel > ODBC

� (Windows 2000, XP, or 2003) Start > Settings > Control Panel > Administrative Tools > Data Sources (ODBC)

The ODBC Data Source Administrator settings notebook appears.

2. Select the System DSN tab.

Note: Be sure to select the System DSN tab and not the User DSN tab. If there is no System DSN tab, your ODBC driver needs to be updated.

3. On the System DSN page, click Add to add a new data source.

4. Select an ODBC driver (which must already be installed), and click Finish.The setup dialog for the selected driver appears.

5. Enter the same data source name (DSN) you specified during installation of the data presentation components.Important: For Web Response Monitor to connect to the database, the DSN specified here must be identical to the DSN you specified during installation of the data presentation components. The DSN is case-sensitive.

6. Enter a description for the database (for example, Web Response Monitor ODBC Database).

7. Complete the rest of the dialog for the selected driver.



The configuration options vary by driver. For instructions, click Help in the dialog box, or see the documentation that accompanies your database driver.

8. Click OK or Create.

9. Select the drive, directory, and filename for the database, and click OK to create the database.The database is created and ready for use by Web Response Monitor. Go on to the next section.

Note: Manager Server is required for insertion of data into the Web Response Monitor database and for report generation. Be sure to install Manager Server before you start the other components.

Setting up an Oracle JDBC database

1. If you have not already done so, download and install an Oracle JDBC driver for Java 1.2x for your level of Oracle database from

http://otn.oracle.com/software/tech/java/sqlj_jdbc/software_index.htm

The driver is supplied as a zip file called classes12.zip.

2. Copy classes12.zip to <Candle_Home>\Tomcat\lib (where <Candle_Home> is the Web Response Monitor home directory).

3. Use a text editor (such as Notepad) to add this line to the list of wrapper.class_path variables in file wrapper.properties:

wrapper.class_path=$(wrapper.tomcat_home)\lib\classes12.zip

4. Save the file.The Oracle JDBC driver classes are added to Web Response Monitor. Go on to the next section.


Step 4. Install Manager Server To install Manager Server on UNIX, follow the instructions in “Install Manager Server” on page 65.



To install Manager Server on Windows, follw the instructions immediately below.

1. Insert the product CD into the CD-ROM drive of the Windows machine where you want to install Manager Server.

2. Double-click setup.exe at the \Windows\MgrSrvr level of the CD.


4. Read the license agreement, and click Yes to accept it and proceed with installation.The Setup Type dialog appears.

5. Select Custom, and then click Next.If no earlier version of Manager Server is already installed on the machine, you will be prompted to accept the default program location (C:\Program Files\Candle\eBA\) or specify a different location.

If Setup detects an earlier version of Manager Server on the machine, you will see this prompt:

Found an older version of Manager Server in drive:\directory. To use this location, click Next. To change this location, click Cancel, which will abort the installation. After install exits, uninstall the current version. When uninstall is complete, re-install this version.

Do one of the following:

� Click Next if you want to install the new version of the Manager Server in the same location as the previous version and retain the existing configuration settings and log files. Continue with the next step.

� If you do not want to use the same location, you must uninstall the earlier version of Manager Server.

A. Click Cancel to stop the installation.B. At Start > Programs, look for Candle product folders.C. Find and select the Uninstall shortcut for Manager Server.

You will be prompted to uninstall the Manager Server. The Uninstall program removes only the files that were created during the previous installation. It does not remove files created during Manager Server execution.

D. Delete or move any residual files left after uninstallation.



E. Restart the Setup program to install Manager Server.

6. Specify the port numbers for receiving data from and sending data to clients (Manager Clients and other Manager Servers). By default, the Receive Port number is 8192 and the Send Port number is 9200. Use the same port numbers you specified during Manager Client installation.

Note: If Manager Server is installed on a system with more than one network interface, you may need to direct TCP/IP traffic through a specified network interface. See the chapter titled Consolidating Data.

7. Accept the default of No on the Connection Pack for HP/ITO Option dialog, and click Next.

8. Select the Manager Server startup mode: automatic during system startup, or manual.The Manager Server is installed as a Windows service. Web Response Monitor does not require that a user be logged on for Manager Server to run.

9. Click Next on the Program Folder dialog, then click Next again on the Setup Review dialog to complete the installation.

10. Click Finish to exit the Setup program.

Step 5. Verify data collection

1. If the data collection components are not set to start automatically, go to the Windows machine where they are installed and follow these steps to start them.

A. To access the Services window, select:(Windows NT) Start > Settings > Control Panel > Services

(Windows 2000, XP, or 2003) Start > Settings > Control Panel > Administrative Tools > Services

B. Right-click each of these services and select Start::�Candle Manager Client�Candle Media Analyzer�Candle Web Response Monitor - Collection

2. Use a browser to access and browse one or more Web sites hosted on the machine where the data collection components are running.



3. Check for log files in <Candle_Home>\log\. You should find a log file named yyyymmdd.sm3, where yyyymmdd is today’s date. The existence of this log file means that Web site performance data are being collected and logged.

Step 6. Verify communicationsTo verify that Manager Server and Manager Client can transmit data to each other, follow this procedure.

1. If you did not install Manager Server and Manager Client to start automatically, start them now.

A. On the Services window of the machine where the Presentation components are installed, right-click Candle Manager Client and select Start.

B. If Manager Server is installed on:Windows: On the Services window of the machine where Manager Server is installed, right-click Candle eBA Manager Server and select Start.

UNIX: Change the current directory to <Candle_Home>/mgmt/manager/server/, and enter this command:

./server.sh

2. If Manager Client was installed in Admin Mode, look at its console for these messages:

KEGCLI050 Client settings sent to server server_name[8192]KEGCLI049 Sending client settings to server server_name[8192]KEGCLI029 CLIENTINFO sent to server server_name[8192]KEGCLI031 Sending CLIENTINFO to server server_name[8192]

3. To verify successful communication between the Manager Server and Manager Client, look at the Manager Server console for these messages:

KEGSRT001 Connection accepted from client_addressKEGSWD001 Waiting for connection on client_address port 8192KEGSBR001 Starting broadcast thread. Interval : 15 minutesKEGSVR005 Startup completed.KEGSLE005 Loading collector listKEGSLS005 Loading server listKEGSLC011 Client status monitor startedKEGSLC005 Loading client list



If you see the connection messages, you have completed verification of communication.

Resolving communication problems

If you do not see the connection messages, resolve the connectivity problem.

1. From a command prompt, enter a ping command:PING network_name

where network_name is the full network name of the machine where the Manager Server is running.

A series of ping connection messages appear if the connection is successful.

2. If the ping is successful:A. Go to the Manager Client and click the Settings button.

The Manager Client Settings notebook appears.B. Click the TCP/IP tab.C. On the TCP/IP settings page, select the server port and name.D. Click Edit and make sure the network name is spelled correctly.E. Click Ping.

Manager Client sends a heartbeat signal to Manager Server.

F. Click Add to move the server port and name back to the Server Port and Address List.

G. Look at the Manager Client and Manager Server consoles for messages indicating that they are communicating. If you see the connection messages, you have completed verification of communication.

3. If the ping is unsuccessful:A. From a command prompt, enter a ping command:

PING ip_address

where ip_address is the full dotted decimal IP address of the machine where the Manager Server is running.A series of ping connection messages appear if the connection is successful.

B. If the ping is still unsuccessful, make sure the Manager Client and Manager Server are both still running.



If the ping is successful this time, go to the Manager Client and click the Settings button.

C. In the Manager Client Settings notebook, click the TCP/IP tab.D. On the TCP/IP settings page, select the server port and name.E. Click Edit and enter the IP address in place of the server name.F. Click Ping.

The Manager Client sends a heartbeat signal to the Manager Server.G. Click Add to put the new server on the list.H. Look at the Manager Client and Manager Server consoles for

messages indicating that the Client and Server are communicating.I. If the connection is still unsuccessful, make sure that the port number

assigned to the Manager Server is not already in use, and that the same port numbers are specified in the Manager Client and Manager Server Settings notebooks.

If these steps do not produce a successful connection, contact Candle customer service for assistance.

4. You will verify data presentation the first time you log onto the Web Response Monitor Web browser user interface. See “Sysadmin: First Logon Tasks” on page 77.

What’s nextYou have installed and verified all PathWAI Web Response Monitor components. You are ready to configure the components so that they work together efficiently and provide you with useful, meaningful reports and alerts.

1. Set up accounts for viewing and subscribing to Web Response Monitor reports. See “Managing Accounts” on page 75.

2. Use the browser interface to set alert thresholds and view Web application performance reports. See “Monitoring Web Applications” on page 83.

3. Configure data collection for maximum efficiency and accuracy. See “Configuring Data Collection” on page 89.

4. Set up the Manager Clients and Manager Server to receive and transmit the data at desired intervals. See “Consolidating Data” on page 115.




UNIX Installation Procedure


Required permissionsTip: It is recommended that you use the same user ID for all tasks.

The installing user ID must have access to at least:

� 30 MB free temporary space (/usr/tmp) for installation files

� 30 MB free disk space for program files

The Analyzer user ID must have super (root) user authority.

The Collector user ID must have sufficient permissions and disk space to write log files to the PathWAI Web Response Monitor filesystem and to delete old log files.

The Manager Client user ID must have sufficient permissions and disk space to read the log files from the PathWAI Web Response Monitor filesystem.

The Manager Server user ID must have sufficient permissions and disk space to write log files to the PathWAI Web Response Monitor filesystem.

Prerequisite for HP-UX 11.0 machinesBefore installing PathWAI Web Response Monitor on a machine running HP-UX 11.0, you must apply these system patches:

� PHNE_21767

� PHNE_22244

� PHNE_22566

� PHNE_22962

You can download these patches from the Hewlett-Packard Web site at http://www.hp.com.

HP-UX limitation

Only one instance of the Analyzer can run at a time on an HP-UX machine. This limitation does not apply to other UNIX platforms.



Installation stepsTo install PathWAI Web Response Monitor, follow these procedures.

1. Install data collection components (page 56).

2. (Optional) Install the Web Response Monitor HTTPS filter (page 60).

3. Install Manager Server (page 65).

4. Verify data collection (page 66).

5. Verify communications (page 67).

Note: The data presentation components run on Windows machines only. To install them, see “Install the data presentation components” on page 44.

Step 1. Install data collection components� If you are installing PathWAI Web Response Monitor from a non-GUI

terminal, in command mode, skip the instructions immediately below. Follow the instructions in “Non-GUI installation” on page 58.

� If you are installing PathWAI Web Response Monitor from an X Window terminal, follow the GUI installation instructions immediately below.

GUI installation

1. Start the X Window System.

2. Open an X Window terminal session. In the following steps, continue to enter commands in this window.A UNIX prompt appears in the window.

3. Mount the PathWAI Web Response Monitor CD in ISO 9660 format on the Web server machine where you want to install the product.

4. Enter a mount command.

5. Enter the hostname command to verify that you are currently logged onto the host where you want to install PathWAI Web Response Monitor.Tip: If necessary, use an rlogin command to log onto the UNIX host.

6. Use the following command to verify that your DISPLAY variable is set to the host where you initially started the X Window System:

env | grep DISPLAY



The command returns the current value of your DISPLAY variable. For example,

DISPLAY=reliant:0

where reliant is the hostname and 0 is the default display.

Important: When you start the installation GUI under the X Window System, the GUI will appear only if the DISPLAY variable is set to the host where you started X Window. Therefore, if you started an X Window emulator on your PC workstation, the DISPLAY variable must be set to your PC hostname.

7. If necessary, enter an export or setenv command to reset the DISPLAY variable. The command syntax depends on your UNIX shell.Korn Shell:

export DISPLAY=host:display

C Shell:setenv DISPLAY host:display

For example, the following command sets the DISPLAY variable, under the C shell, to the host reliant and the default display:

setenv DISPLAY reliant:0

8. Change the directory to the CD mount point.

9. On the CD, find /unix/WRM/ and issue this command:./setup.sh

The installation GUI appears in the X Window Manager.

10. Click Next on the Welcome dialog.

11. On the Installation Directory dialog, specify the fully qualified path name. Do not use ~ to represent the home directory.

12. When you are prompted for the Manager Server hostname, enter the full network name or dotted decimal IP address of the machine where Manager Server will be installed. If the Manager Server and Manager Client will be installed on the same machine, enter localhost.

13. In the Listen Port field, enter the port number Manager Client will use to transmit data to the Manager Server (that is, the port number on which Manager Server will receive data). The default is 8192. You can use this port number unless it is already in use.



14. In the Request Port field, enter the port number Manager Client will use for receiving requests from the Manager Server (that is, the port number the Manager Server will use for sending requests). The default is 9200. You can use this port number unless it is already in use.Tip: If you specify port numbers other than the defaults, write them down. You will need to specify the same numbers during Manager Server installation.

The Manager Client is installed in Silent (hidden) mode. For full information about Manager Client operating modes, see “Operating modes” on page 158.

Note: If Manager Client is installed on a system with more than one network interface, you may need to direct TCP/IP traffic through a specified network interface. See “Consolidating Data” on page 115.

15. Review the settings on the Summary dialog, and click Next to begin copying files.

16. Wait for the setup program to complete installation and configuration of the data collection components, then go on to Step 2. on page 60.

Non-GUI installation

1. Mount the PathWAI Web Response Monitor CD in ISO 9660 format on the Web server machine where you want to install PathWAI Web Response Monitor.

2. Enter a mount command.

3. Enter the hostname command to verify that you are currently logged onto the host where you want to install PathWAI Web Response Monitor.Tip: If necessary, use an rlogin command to log onto the UNIX host.

4. Change the directory to the CD mount point.

5. On the CD, find /unix/WRM/ and issue the command setup.cmd.

6. At the promptDo you agree with the preceding license agreement? yes/no

enter yes.

7. At the promptEnter install directory name:

enter the fully qualified path name. Do not use ~ to represent the home directory.



8. At the prompt Enter the hostname of Candle Manager Server [isis]:

enter the full network name or dotted decimal IP address of the machine where Manager Server will be installed. If the Manager Server and Manager Client will be installed on the same machine, enter localhost.

If you enter the correct server name and either specify valid port numbers or accept the default numbers during the next steps, the Manager Client will be configured to communicate with the Manager Server.

Tip: The Manager Client is installed in Silent (hidden) mode. For full information about Manager Client operating modes, see “Operating modes” on page 158.

9. At the promptEnter the port number of Candle Manager Server [8192]:

enter the port number on which Manager Server will receive data. The Manager Client will use this port number to transmit data to the Manager Server. The default is 8192. You can use this port number unless it is already in use.

10. At the prompt Enter the port number of Candle Manager Client [9200]:

enter the port number Manager Server will use for sending requests. The Manager Client will use this port number for receiving requests from the Manager Server. The default is 9200. You can use this port number unless it is already in use.

Tip: If you specify port numbers other than the defaults, write them down. You will need to specify the same numbers during Manager Server installation.

11. At the promptIf there is more than one network card, please enter the hostname that Candle Manager Client should bind to [Isis]:

enter the hostname of the network interface to be used for Manager Client’s TCP/IP communications with Manager Server. (For more information about setting properties for multihome systems, see “Manager Client Initialization Parameters” on page 130.)

12. Wait for the setup program to complete installation and configuration of the product components. Then go on to Step 2.



Step 2. (Optional) Install the Web Response Monitor HTTPS filterIf you do not want to monitor HTTPS transactions, skip this step and go to “Install Manager Server” on page 65.

If you want to monitor HTTPS transactions, you need to install an Web Response Monitor HTTPS filter. The filter works on Solaris 2.7 and 2.8, with these server versions:� iPlanet Web Proxy Server version 3.6 (go to “Installing the HTTPS filter

on iPlanet Web Proxy Server” on page 63)� iPlanet Web Server version 4.x or 6.x (follow the instructions immediately

below)

Installing the HTTPS filter on iPlanet Web Server

To install the HTTPS filter on iPlanet Web Server 4.x or 6.x, follow these steps.

Note: If you are upgrading from a previous verson of Web Response Monitor and already have an Web Response Monitor HTTPS filter on the web server, skip to step 4.

1. The filter consist of two shared libraries:� libkfcins.so� libkbb.so

Create symbolic links for these two files from <Candle_Home>/sos58/lib to the lib directory in your iPlanet root directory (for example, /iPlanet/server4/bin/https/lib), where <Candle_Home> is the PathWAI Web Response Monitor home directory.

2. In your virtual server home directory, find a script named start.If your virtual server domain name is hermes.candle.com and your iPlanet root directory is /iPlanet/server4, your virtual server home directory is /iPlanet/server4/https-hermes.candle.com for iPlanet 4.x or /iPlanet/servers/https-hermes.candle.com for iPlanet 6.x.



3. Make a backup copy of your start script, then add the following statements to the script. iPlanet 4.x:

#* The following variables are added for Candle HTTPS Filter **

KFC_ENABLE=Y; export KFC_ENABLE

KBB_RAS1='ERROR >/iPlanet/server4/https-domain_name/logs/kfcins.log'; export KBB_RAS1

where domain_name is your virtual server domain name (for example, hermes.candle.com).

iPlanet 6.x:



KBB_RAS1='ERROR >/iPlanet/servers/https-domain_name/logs/kfcins.log'; export KBB_RAS1

where domain_name is your virtual server domain name (for example, hermes.candle.com).

4. If the port to be monitored is 443, skip this step and go to step 5.If the port to be monitored is other than 443, then do this:

A. Add this statement to your start script:KFC_HTTPS_PORT="<port1>,<port2>…"; export KFC_HTTPS_PORT

where <port1> and <port2> are the port numbers to be monitored.

B. In the <Candle_Home> directory, find file kfcmenv.C. Add the same statement to kfcmenv:

KFC_HTTPS_PORT="<port1>,<port2>…"; export KFC_HTTPS_PORT

For more information about file kfcmenv, see “Configuring the Analyzer” on page 92.

5. Make a backup copy of file obj.conf (iPlanet 4x) or magnus.conf (iPlanet 6.x), then edit it as follows.

A. Add these two statements immediately after the last occurrence of Init fn="load-modules":



iPlanet 4.x:Init fn="load-modules" shlib="/iPlanet/server4/bin/https/lib/libkfcins.so" funcs="KFC_initFilter,KFC_checkRequest,KFC_getRequestVariables"

Init fn="KFC_initFilter"

iPlanet 6.x:Init fn="load-modules" shlib="/iPlanet/servers/bin/https/lib/libkfcins.so" funcs="KFC_initFilter,KFC_checkRequest,KFC_getRequestVariables"


Note: Each statement must be a single line, with no carriage returns or line feeds.

B. Add this statement immediately after the last PathCheck statement in the <Object name=default> section.PathCheck fn="KFC_checkRequest"

C. Add this statement immediately after the last AddLog statement in the <Object name=default> section.AddLog fn="KFC_getRequestVariables"

6. In the <Candle_Home> directory, find file kflmenv (not kfcmenv) and make sure it contains the following line. If not, add the line.

SM3_LOG_HTTPS=Y; export SM3_LOG_HTTPS

For more information about file kflmenv, see “Configuring the Collector” on page 103.

You have installed the HTTPS filter. Go on to “Install Manager Server” on page 65.




Installing the HTTPS filter on iPlanet Web Proxy Server

To install the HTTPS filter on iPlanet Web Proxy Server 3.6, follow these steps.

Note: If you are upgrading from a previous verson of Web Response Monitor and already have an Web Response Monitor HTTPS filter on the web server, skip to step 5.

1. Verify that files libkfcinsp.so and libkbb.so exist in <Candle_Home>/sos58/lib (where <Candle_Home> is the PathWAI Web Response Monitor home directory). If either file is missing, you might not have the correct version of Web Response Monitor.

Note: You will also find a file named libkfcins.so. That file is for the Web server and not the Web proxy server.

2. In your proxy server home directory, find a script named start.If your proxy server hostname is hermes.candle.com and your proxy root directory is /iproxy-3.6-us/suitespot, your proxy server home directory is /iproxy-3.6-us/suitespot/proxy-hermes-proxy.

3. Make a backup copy of your start script, then add the following statements to the script.


LD_LIBRARY_PATH=<Candle_Home>/sos58/lib:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH


where <Candle_Home> is the PathWAI Web Response Monitor home directory.

4. In the <Candle_Home> directory, find file kfcmenv, and add this line to it:KFC_SRI_PIPENAME=DEFAULT; export KFC_SRI_PIPENAME

For more information about file kfcmenv, see “Configuring the Analyzer” on page 92.

5. If the port to be monitored is 443, skip this and go to step 6.If the port to be monitored is other than 443, then do this:

A. Add this statement to your start script:KFC_HTTPS_PORT="<port1>,<port2>…"; export KFC_HTTPS_PORT

where <port1> and <port2> are the port numbers to be monitored.

B. Add this line to <Candle_Home>/kfcmenv:



KFC_HTTPS_PORT="<port1>,<port2>…"; export KFC_HTTPS_PORT

6. Make a backup copy of file obj.conf, then modify it as follows.A. Add these two statements immediately after the last occurrence of

Init fn="load-modules":Init fn="load-modules" shlib="<Candle_Home>/sos58/lib/libkfcinsp.so" funcs="KFC_initFilter,KFC_checkRequest,KFC_getRequestVariables"


Note: Each statement must be a single line, with no carriage returns or line feeds.

B. Add this statement immediately after the last PathCheck statement in the <Object name=default> section.PathCheck fn="KFC_checkRequest"

C. Add this statement immediately after the last AddLog statement in the <Object name=default> section.AddLog fn="KFC_getRequestVariables"

7. In the <Candle_Home> directory, find file kflmenv (not kfcmenv) and make sure it contains the following line. If not, add the line.

SM3_LOG_HTTPS=Y; export SM3_LOG_HTTPS

For more information about file kflmenv, see “Configuring the Collector” on page 103.

You have installed the HTTPS filter. Go on to Step 3.




Step 3. Install Manager Server� If you are installing Manager Server from a non-GUI terminal, in

command mode, skip the instructions immediately below. Follow the instructions in “Non-GUI installation” on page 66.

� If you are installing Web Response Monitor from an X Window terminal, follow the GUI installation instructions immediately below.

GUI installation

1. If you have not already done so, follow steps 1–8 under “Install data collection components” on page 56.

2. If an earlier version of Manager Server is running, shut it down. If the Manager Server is running in Silent mode, issue a UNIX kill command from a Telnet session.

3. On the CD, find /unix/server/ and issue this command:./setup.sh

The installation GUI appears in the X Window Manager.

4. At the prompt for destination directory, specify the fully qualified path for Manager Server installation.

5. Specify the port numbers for receiving data from and sending data to clients (Manager Clients and other Manager Servers). By default, the Receive Port number is 8192 and the Send Port number is 9200. Use the same port numbers you specified during Manager Client installation.


6. Follow the prompts until the GUI completes, then go on to “Verify communications” on page 67.



Non-GUI installation

1. On the CD, find /unix/server/ and issue the command setup.cmd.

2. At the promptDo you agree with the preceding license agreement? yes/no

enter yes.

3. At the promptEnter install directory name:

enter the fully qualified path name. Do not use ~ to represent the home directory.

4. At the appropriate prompts, specify the port numbers for receiving data from and sending data to clients (Manager Clients and other Manager Servers). By default, the Receive Port number is 8192 and the Send Port number is 9200. Use the same port numbers you specified during Manager Client installation.


5. Wait for the setup program to complete installation and configuration of Manager Server, then go on to the next step.

Step 4. Verify data collection

1. Restart the Web server machine where you installed the Analyzer and Collector.

2. To start the Analyzer, change to <Candle_Home> (the directory where you installed Web Response Monitor), and issue this command:

./sm3ctl start analyzer

3. To start the Collector, issue this command from the same location:./sm3ctl start collector

4. Use a browser to access and browse one or more Web sites hosted on the machine where you have installed the Analyzer and Collector.

5. Check for log files in <Candle_Home>/log/. You should find a log file named yyyymmdd.sm3, where yyyymmdd is today’s date. The existence of this log file means that Web site performance data are being collected and logged.



Step 5. Verify communicationsTo verify that Manager Server and Manager Client can transmit data to each other, follow this procedure.

1. To start the Manager Server, change the current directory to <Candle_Home>/mgmt/manager/server/, and enter this command:

./server.sh

2. For verification purposes, start the Manager Client in Admin mode. To do this, change the current directory to <Candle_Home> and enter this command:

./sm3ctl start client -admin

3. Look at the Manager Client console for these messages:KEGCLI050 Client settings sent to server server_name[8192]KEGCLI049 Sending client settings to server server_name[8192]KEGCLI029 CLIENTINFO sent to server server_name[8192]KEGCLI031 Sending CLIENTINFO to server server_name[8192]

4. To verify successful communication between the Manager Server and Manager Client, look at the Manager Server console for these messages:

KEGSRT001 Connection accepted from client_addressKEGSWD001 Waiting for connection on client_address port 8192KEGSBR001 Starting broadcast thread. Interval : 15 minutesKEGSVR005 Startup completed.KEGSLE005 Loading collector listKEGSLS005 Loading server listKEGSLC011 Client status monitor startedKEGSLC005 Loading client list

If you see the connection messages, you have completed verification of communication.

Resolving communication problems

If you do not see the connection messages, resolve the connectivity problem.

1. From a command prompt, enter a ping command:PING network_name

where network_name is the full network name of the machine where the Manager Server is running.

A series of ping connection messages appear if the connection is successful.

2. If the ping is successful:



A. Go to the Manager Client and click the Settings button.The Manager Client Settings notebook appears.

B. Click the TCP/IP tab.C. On the TCP/IP settings page, select the server port and name.D. Click Edit and make sure the network name is spelled correctly.E. Click Ping.

Manager Client sends a heartbeat signal to Manager Server.

F. Click Add to move the server port and name back to the Server Port and Address List.

G. Look at the Manager Client and Manager Server consoles for messages indicating that they are communicating. If you see the connection messages, you have completed verification of communication.

3. If the ping is unsuccessful:A. From a command prompt, enter a ping command:

PING ip_address

where ip_address is the full dotted decimal IP address of the machine where the Manager Server is running.A series of ping connection messages appear if the connection is successful.

B. If the ping is still unsuccessful, make sure the Manager Client and Manager Server are both still running.If the ping is successful this time, go to the Manager Client and click the Settings button.

C. In the Manager Client Settings notebook, click the TCP/IP tab.D. On the TCP/IP settings page, select the server port and name.E. Click Edit and enter the IP address in place of the server name.F. Click Ping.

The Manager Client sends a heartbeat signal to the Manager Server.G. Click Add to put the new server on the list.H. Look at the Manager Client and Manager Server consoles for

messages indicating that the Client and Server are communicating.



I. If the connection is still unsuccessful, make sure that the port number assigned to the Manager Server is not already in use, and that the same port numbers are specified in the Manager Client and Manager Server Settings notebooks.

If these steps do not produce a successful connection, contact Candle customer service for assistance.

Note: You will verify data presentation the first time you log onto the Web Response Monitor Web browser user interface on a Windows machine. See “Sysadmin: First Logon Tasks” on page 77.

What’s nextYou have installed and verified all PathWAI Web Response Monitor components. You are ready to configure the components so that they work together efficiently and provide you with useful, meaningful reports and alerts.

1. Set up accounts for viewing and subscribing to Web Response Monitor reports. See “Managing Accounts” on page 75.

2. Use the browser interface to set alert thresholds and view Web application performance reports. See “Monitoring Web Applications” on page 83.

3. Configure data collection for maximum efficiency and accuracy. See “Configuring Data Collection” on page 89.

4. Set up the Manager Clients and Manager Server to receive and transmit the data at desired intervals. See “Consolidating Data” on page 115.

Starting and Stopping PathWAI Web Response Monitor



Order is importantOn both Windows and UNIX platforms, be sure to start the Analyzer before you start the Collector. For best results, start and stop the components in the order shown here.

(Windows) Starting Web Response MonitorThe Web Response Monitor components are installed as Windows services and are started from the Services window. To access the Services window, select:

� (Windows NT) Start > Settings > Control Panel > Services

� (Windows 2000, XP, or 2003) Start > Settings > Control Panel > Administrative Tools > Services

1. On the Services window of the machine where Manager Server is installed, right-click Candle eBA Manager Server and select Start.

2. On the Services window of the machine where the data collection components are installed, right-click each of these services and select Start:

�Candle Manager Client�Candle Media Analyzer�Candle Web Response Monitor - Collection

3. On the Services window of the machine where the data presentation components are installed, right-click Tomcat 3.3 and select Start.

4. Start the Web browser user interface by selecting Start > Programs > Candle PathWAI > Web Response Monitor - Presentation Login.The PathWAI Web Response Monitor logon screen should appear. If it does not, issue a browser request as explained in “Log on” on page 77. In case of further trouble, refer to the Tomcat server documentation, which you can find at <Candle_Home>\PathWAI\tomcat\doc\index.html



(Windows) Stopping Web Response Monitor

1. On the Services window of the machine where the data presentation components are installed, right-click Tomcat 3.3 and select Stop.

2. On the Services window of the machine where the data collection components are installed, right-click each of these services and select Stop:

�Candle Manager Client�Candle Media Analyzer�Candle Web Response Monitor - Collection

3. On the Services window of the machine where Manager Server is installed, right-click Candle eBA Manager Server and select Stop.

(UNIX) Starting PathWAI Web Response Monitor

1. Start the Manager Server by changing the current directory to <Candle_Home>/mgmt/manager/server/ and entering this command:

./server.sh

2. Start the Analyzer by changing the current directory to <Candle_Home> and issuing this command:

./sm3ctl start analyzer

3. Start the Collector by issuing this command from the same location:./sm3ctl start collector

4. Start the Manager Client by issuing this command from the same location:./sm3ctl start client

Tip: You can start the Analyzer, Collector, and Manager Client with a single command:

./sm3ctl start

(UNIX) Stopping Web Response Monitor

1. Stop the Manager Server by changing the current directory to <Candle_Home>/mgmt/manager/server and issuing this command:

./stopserver.sh

2. Stop the Analyzer by changing the current directory to <Candle_Home> and issuing this command:

./sm3ctl stop analyzer

3. Stop the Collector by issuing this command from the same location:



./sm3ctl stop collector

4. Stop the Manager Client by issuing this command from the same location:./sm3ctl stop client

Tip: You can stop the Manager Client, Collector, and Analyzer with a single command:

./sm3ctl stop


Uninstalling Web Response Monitor


1. On each Windows machine where product components are installed:A. Select Start > Settings > Control Panel > Add/Remove Programs >

Candle PathWAI Web Performance Manager.

B. Click Change/Remove.C. Select Remove, click Next, then click OK to confirm.D. Click Finish.

Web Response Monitor Setup removes all product files and directories from the machine. If any Candle IIS filters are installed (for HTTPS monitoring and/or for redirection of requests to the Presenter from IIS to Tomcat), Setup takes the following additional actions automatically:

A. stops IIS servicesB. uninstalls the Candle filtersC. restarts IIS services

If any errors occur during automatic uninstallation of an IIS filter, you will see an error message, and you will need to uninstall the filter from the Internet Services Manager console. See the appendix titled “Installing and Uninstalling the IIS Filters”.

2. On each UNIX machine where any component is installed, execute this command:

rm -fr <Candle_Home>

where <Candle_Home> is the PathWAI home directory.



Managing Accounts 75

Managing Accounts

IntroductionThis chapter explains how to set up accounts for viewing and subscribing to PathWAI Web Response Monitor reports.

Chapter contents

Web Response Monitor Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Account types and permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Sysadmin: First Logon Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Step 1. Log on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Step 2. Create the sysadmin profile and name the first organization . . . . . . . . 78Step 3. Create an admin account for the first organization . . . . . . . . . . . . . . . 78Step 4. Name other organizations and create their admin accounts . . . . . . . . 79Step 5. Log off as sysadmin and log on as an organization admin . . . . . . . . . 79

Admin Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81What an admin can do . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Creating a user account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Updating an existing account profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Managing account subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

3

Web Response Monitor Accounts


Web Response Monitor Accounts

Account types and permissionsPathWAI Web Response Monitor provides three types of accounts.

Each account has a profile, which specifies the account settings.

sysadmin One sysadmin account is allowed per product installation. The sysadmin, who is the first person to log on after product installation, can� name the organizations (for example, Finance, Support Center,

and Human Resources) whose transactions are being monitored

� set up an admin account for each organizationThe sysadmin cannot view reports, except by creating an admin account and logging on as the admin.

admin Each organization’s admin can� create user accounts for the organization� set alert thresholds� set timespans for reports and alerts� view and subscribe to reports� forward reports by email� delete subscriptions for any user in the organization

user Users without admin authority can � edit their own account settings, including alert thresholds and

report timespans� view and subscribe to reports� forward reports by email� delete their own subscriptions


Sysadmin: First Logon Tasks


OverviewThis section gives instructions for the tasks facing the sysadmin upon first logon to the PathWAI Web Response Monitor Web browser interface:

� naming the organizations

� creating an admin account for each organization

Step 1. Log on

1. If PathWAI Web Response Monitor is not running, start it now. See the previous chapter for instructions.

2. Issue a Web browser request to one of these URLs:

3. To verify Web Response Monitor presentation services, issue a Web browser request to one of these URLs:� If Tomcat server was installed standalone (without IIS):

http://hostname:8080/candlebrowser/kfslogon.html� If Tomcat server was installed with IIS:

http://hostname/candlebrowser/kfslogon.html

where hostname is the name of the machine on which the Web Response Monitor Presenter is installed.

The browser request is case-sensitive. If Tomcat server was installed standalone, port 8080 must be specified in the browser request. If Tomcat server was installed with IIS, browser requests to the Presenter use port 80 (the default, which need not be specified). If there is no Web server on the machine, you can change the Tomcat standalone port number to 80 by modifying the Tomcat server.xml file.

For further information about Tomcat server installed with IIS, see the appendix titled “Installing and Uninstalling the IIS Redirection Filter”. You can find complete documentation for Tomcat server at <Candle_Home>\PathWAI\tomcat\doc\index.html

Note: If you are using the same machine where Tomcat server is installed, you can access the browser interface by selecting Start > Programs > Candle PathWAI > Web Response Monitor - Presentation Logon



The PathWAI Web Response Monitor logon screen should appear. If it does not, check to make sure that the correct URL and port number are specified in the browser request. If the logon screen still does not appear, stop and restart the Tomcat server. See “Starting and Stopping PathWAI Web Response Monitor” in the chapter “Installing PathWAI Web Response Monitor”.

4. Log on as sysadmin, with password sysadmin.The Account Settings dialog appears.

Step 2. Create the sysadmin profile and name the first organization

1. Specify a name for the first organization. Tip: Valid characters for names are uppercase and lowercase letters and the hyphen (-).

2. Type a new password for the sysadmin account in both the Change Password field and the Confirm Password field.

3. Session timeout: Set the number of seconds after which a sysadmin session will end if there has been no activity.

4. Email address: Specify the desktop email address of the sysadmin account.

5. (Optional) Mobile email address: Specify a mobile email address for the sysadmin account.

Step 3. Create an admin account for the first organization

1. While logged on as the sysadmin, select Account Settings and click Add New Account.A longer Account Settings dialog appears. This is the dialog where you can create an admin account for the organization.

2. On the Account Settings dialog, complete the General Settings section:A. Type in admin as the user name for the admin account.B. Type the password for this admin account in both the Change

Password field and the Confirm Password field.C. Session Timeout: Set the number of seconds after which this account’s

Web Response Monitor sessions will end if there has been no activity.D. Report period: Specify the number of hours to be covered by reports.



E. Trim display URL: Select Yes if you want URL addresses to be shown in reports without added character strings (such as parameter strings).

3. Complete the Notification Settings section:A. Email address: Specify a desktop email address for alerts and

subscription reports sent to this account.B. Email format: Select the format (HTML, Text, or PDA) to be used for

email sent to the desktop. If the desktop email client software supports HTML format, select it for the best display. Otherwise, select Text for plain text, or PDA for compact plain text.

C. (Optional) Mobile email address: Specify the email address for mobile alerts.

4. Under Threshold Settings, set Bad (red) and Warning (yellow) thresholds for each of the areas shown.Tip: Your reports will be more meaningful if you set thresholds carefully. However, you can reset them at any time from the Web browser interface. You will probably need to reset them repeatedly to produce the best possible reports for your environment.

For a detailed definition of each response time statistic, see:� the chapter titled Introducing Web Response Monitor.

� the online helps for the Web browser interface (click Help in the menu on the left side of the browser window)

5. Click Save to save the settings for this account.

Step 4. Name other organizations and create their admin accountsIf desired, you can name more organizations and create admin accounts for them now; or you can wait until another time. To create admin accounts, you must be logged on as the sysadmin.

Step 5. Log off as sysadmin and log on as an organization admin

1. In the left column of the Web Response Monitor browser window, click Log Off.The Web Response Monitor logon screen appears.

2. Log in with the account name admin, the admin account password you specified earlier, and the name of the organization.



The Current Performance Summary appears. This report gives a status overview of your Web-based applications, based on the thresholds set for your account. If the status lights in the Current Performance Summary are gray, no data are available. Make sure the Analyzer and Collector are running and collecting data. See “Verify data collection” on page 50 (Windows) or “Verify data collection” on page 66 (UNIX).

For instructions on using the Web browser interface and viewing other reports, see the online help or see “Monitoring Web Applications” on page 83.


Admin Tasks

Admin Tasks

What an admin can doAn admin (any account created by the sysadmin) can:

� create, update, and delete user accounts for the organization� set thresholds and timespans for reports and alerts

� view and subscribe to reports

� forward reports by email

� delete subscriptions for any user in the organization

Creating a user account

1. At the Web Response Monitor logon screen, log on with the account name admin, the admin account password, and the organization name.

2. Under Account Management in the left column of the browser window, select Profiles.

The Account Settings dialog appears.

3. The procedure for creating a user account is the same as the procedure for creating an admin account. Any account created by a sysadmin is an admin account, and any account created by an admin is a basic user account. Follow the instructions in the previous section.

Updating an existing account profile

1. Under Account Management, select Profiles.

2. Use the pull-down menu at the top of the Account Settings dialog to select the account you want to update.

3. Make the desired changes to the account settings.

4. Click Update to save the new settings for this account.

Note: All users can update their own profiles. The sysadmin can also update admin profiles, and admins can update the profiles of other users in their organization.

Admin Tasks


Managing account subscriptionsSubscriptions to reports are set up while you are viewing the reports. For instructions, see

� the next chapter

� the online helps for the Web browser interface.

Deleting subscriptions

From the Account Management section of the interface, you can delete subscriptions from your account or (if you are an admin) from any user account in the organization.

To delete a subscription:

1. Under Account Management, select Subscriptions

2. Use the pull-down menu to select the user whose subscription you want to delete.

3. Add a check to the checkbox of any report you want to remove from the subscription list.

4. Click Remove Subscription.

Monitoring Web Applications 83

Monitoring Web Applications

IntroductionThis chapter gives basic instructions for

� viewing PathWAI Web Response Monitor reports in the Web browser interface

� sending and subscribing to reports

This chapter assumes that Web Response Monitor has been installed and configured as described in “Installing PathWAI Web Response Monitor” on page 31, and that you have created at least one admin account as explained in “Managing Accounts” on page 75.

Chapter contents

Getting Started with the Browser Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Logging on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84About the Web Response Monitor reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Sending and Subscribing to Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Obtaining copies of reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Sending a report to your email address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Forwarding a report to another email address. . . . . . . . . . . . . . . . . . . . . . . . . 87Subscribing to a daily report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

4

Getting Started with the Browser Interface



OverviewThis section describes how to access and navigate the Web Response Monitor Web browser interface; and how to send, forward, and subscribe to specific reports.

Logging onTo log onto the Web Response Monitor browser interface:

1. Issue a Web browser request to one of these URLs:� If Tomcat server was installed standalone (without IIS):

http://hostname:8080/candlebrowser/kfslogon.html� If Tomcat server was installed with IIS:

http://hostname/candlebrowser/kfslogon.html

where hostname is the name of the machine on which the Web Response Monitor Presenter is installed.

The browser request is case-sensitive. If Tomcat server was installed standalone, port 8080 must be specified in the browser request. If Tomcat server was installed with IIS, browser requests to the Presenter use port 80 (the default, which need not be specified). If there is no Web server on the machine, you can change the Tomcat standalone port number to 80 by modifying the Tomcat server.xml file.

For further information about Tomcat server installed with IIS, see the appendix titled “Installing and Uninstalling the IIS Redirection Filter”. You can find complete documentation for Tomcat server at <Candle_Home>\PathWAI\tomcat\doc\index.html

Note: If you are using the same machine where Tomcat server is installed, you can access the browser interface by selecting Start > Programs > Candle PathWAI > Web Response Monitor - Presentation Logon

2. Enter your account, password, and organization, and click the Sign In button.The Current Performance Summary report is displayed, and a navigation menu is displayed in the left margin. This report gives a status overview of your Web-based applications, based on the thresholds set for your account. If the status lights in the Current Performance Summary are gray, no data are



available. Make sure the Analyzer and Collector are running and collecting data. See “Verify data collection” on page 50 (Windows) or “Verify data collection” on page 66 (UNIX).

For instructions on using the Web browser interface and viewing other reports, see the online help or see “Monitoring Web Applications” on page 83.

Navigating the browser interfaceYou can navigate the browser interface by either of these methods:

� clicking on a red, yellow, or green status item (or, in other reports, a URL address or a response time statistic). This method, called drilling down, is a good way to get more information about a problem area.

� using the menu on the left side of the browser window.

Figure 3. Browser Interface Navigation Methods

Drilling down

For more detailed information on a problem area, click the status item. From there you can continue to drill down to get more information on the source of the problem.

Menu Status items



Using the menu

You can navigate to three types of reports from the menu:

� Real-Time Reports summarize Web application performance.

� Response Time Reports provide more detailed, segmented response time data.

� Analysis Reports organize the response time and throughput data statistically.

When you click the name of a report in the menu, the report appears in the browser window. You can drill down to more detailed reports.

From each report except the Current Performance Summary and the Overview report, you can

� send the report to your own email address

� forward the report to another email address

� subscribe your account to the report

If you are an Web Response Monitor administrator, you can also subscribe other users' accounts. See “Sending and Subscribing to Reports” on page 87 for more information.

If you are an Web Response Monitor administrator, you can also remove subscriptions from other users' accounts. See “Managing account subscriptions” on page 82 for more information.

About the Web Response Monitor reportsFor descriptions of the Web browser-based reports and assistance in interpreting them, see the online helps for the Web browser interface. To access the helps, click Help in the menu on the left side of the Web Response Monitor browser window.


Sending and Subscribing to Reports


Obtaining copies of reportsAs you monitor your Web-based applications, you may find that you want to

� track the data

� forward the data to someone who may be able to help you solve a persistent problem

� show someone that you have resolved a problem quickly

Send, Forward, and Subscribe buttons appear on reports so that you can obatin copies of the reports or send the reports to others.

Sending a report to your email addressWhile you are viewing an Web Response Monitor report in the Web browser interface, you can send it to your email address (or the email address defined in your account profile).

Click the Send to your_email_address button at the bottom of the report. The report is sent immediately.

Forwarding a report to another email address

1. Click the Forward button at the bottom of the report you want to send.The Forward Report Request dialog appears.

2. In the Email Address field, enter the email address to which you want to forward the report.

3. In the Format field, use the drop-down list to specify either Plain Text or HTML format for the message.

4. (Optional) If you want Web Response Monitor to insert a subject line for you (after the report name, which automatically appears), use the drop-down list to select a Phrase to be included in subject. By default, the report name appears in the subject line.



5. (Optional) If you want to include additional text or instructions to the recipient, enter it in the space provided under Additional text to be sent.

6. Select the Forward button to send the message.A status message tell you that the report has been forwarded successfully.

Subscribing to a daily reportWhen you subscribe to a report, that report is sent to you every day at the time you specify.

1. Click the Subscribe button at the bottom of the report you want to send.The Subscribe Report Request dialog appears.

2. Use the drop-down lists to specify the format (HTML or Plain Text) and delivery time for the daily report.

3. Click the Subscribe button.If you are logged on as an admin, you can also subscribe other users to the report.

Configuring Data Collection 89

Configuring Data Collection

IntroductionThis chapter gives instructions for:

� configuring PathWAI Web Response Monitor data collection

� improving data collection performance

Chapter ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Stages of data collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Configuration options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Configuring the Analyzer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Analyzer configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Analyzer configuration file kfcmenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Appliance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Configuring the Collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Collector configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Collector configuration file kflmenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Data Collection Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106High-volume environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Load balancers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

URL History Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Two kinds of history files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Dynamic history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Permanent history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

5


Rules for editing the permanent history file . . . . . . . . . . . . . . . . . . . . . . . . . . 110Configuration options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

IIS Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Managing the Candle ISAPI filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Socket timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113ASP buffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113


Overview

Overview

Stages of data collectionWeb Response Monitor data collection takes place in two stages:

1. The Analyzer examines network traffic and calculates response time for each Web transaction.

2. The Collector writes log files that identify the type of each transaction (HTTP page, HTTP object, video, or audio) and provide its performance and usage statistics.

Settings in configuration files control each stage of data collection.

Configuration optionsDuring product installation, your responses to InstallShield prompts establish the values of some data collection configuration options (for example, the path to the Web Response Monitor program and log files). For other options, preset defaults take effect upon installation.

In general, the default values for these options give the best data collection results. If you want to change the values of any configuration options: � First make sure you have completed all steps of product installation.� Edit the configuration files only with the assistance of Candle customer

service.

Configuration filesThese configuration files control data analysis, collection, logging, and debugging:

� kfcmenv controls data analysis and collection for the Analyzer component. Edit it only under the direction of a Candle representative.

� kflmenv controls data logging for the Collector. Edit it only under the direction of a Candle representative.

� (Windows only) kfcienv controls the Candle IIS filter. Do not edit this file.

Configuring the Analyzer



Analyzer configuration settingsThe Setup program automatically configures the Analyzer and places all configuration options and their values in <Candle_Home>\analyzer\kfcmenv.A second copy of the file, containing the default settings, resides in <Candle_Home>\analyzer\cfg\If you need to change any settings, edit the kfcmenv file in <Candle_Home>\analyzer\, not the copy in <Candle_Home>\analyzer\cfg\. Keep that copy as installed, so you can revert to default values if need be.

Important: Do not change the data analysis settings in file kfcmenv except under the direction of a Candle representative. Changing the debug settings can result in a huge quantity of RAS1 log output.

Analyzer configuration file kfcmenvThis is one of the options of file kfcmenv, with its default value.

KFC_DEBUG_STORAGE=N

The Analyzer component is shared by other Candle products, and several options in the product-provided kfcmenv file do not apply to Web Response Monitor. The options that apply to Web Response Monitor are listed and defined in Table 5, “Analyzer Configuration Options in File kfcmenv,” on page 93.

Important: Leave no space between any keyword and its setting. Each statement must be on a single line, with no carriage returns or line feeds.



Table 5. Analyzer Configuration Options in File kfcmenv

Option Description Default

KBB_RAS1 Sets the level of RAS1 tracing and the path to the RAS1 log for the Analyzer. Do not change the level of tracing, or your machine could be overrun with excessive quantities of RAS1 output.

See file kfcmenv

KFC_API_MEDIASERVER_LISTEN_PORT Sets the Analyzer KFC1 API service listen port.

12121

KFC_APPL_SCHEDULE_WINDOW Specifies the frequency (in seconds) with which the Analyzer checks for outstanding activities and calculates response time. A smaller value results in more frequent response time calculations, at the expense of increased CPU use.

See also KFC_HTTP_PROCESS_DELAY_FACTOR

10

KFC_BUFFER_POOL_STAT If set to Y, periodically outputs buffer pool storage usage statistics.

N

KFC_CAPTURE_BUFFER_POOL_SIZE (UNIX only) Sets the number of buffers allocated at startup for the frame-capture data buffer pool. The Analyzer automatically expands this buffer pool if necessary.

8



KFC_CAPTURE_DEVICE_NAME Specifies a network interface to be monitored, to the exclusion of all other interfaces. If the specified device is unknown, inactive, or invalid, the Analyzer does not start.� Windows: Specifies the network

interface host name or IP address.� UNIX: Specifies the network

device name.

Note: By default, the Analyzer monitors all network interfaces. Do not use the KFC_CAPTURE_DEVICE_NAME option unless you want to limit monitoring to one network interface and you are sure that interface can be opened.

All

KFC_DEBUG_API If set to Y, turns on a KFC1 API processing trace.

N

KFC_DEBUG_CAPTURE If set to Y, turns on a detailed trace of the network frame-capture interface.

N

KFC_DEBUG_FILTER If set to Y, turns on a trace of data filtering.

N

KFC_DEBUG_HTTP If set to Y, turns on a detailed trace of HTTP protocol module processing.

N

KFC_DEBUG_t If set to Y, turns on a detailed trace of HTTPS protocol module processing.

N

KFC_DEBUG_PACKET If set to Y, turns on a detailed trace of Analyzer Packet Dispatcher activities.

N

KFC_DEBUG_SRI (Windows only) If set to Y, turns on a trace of the interface between the Analyzer and the IIS security reference filter.

N

KFC_DEBUG_STORAGE If set to Y, turns on a detailed trace of the Analyzer’s use of storage.

N





KFC_DEBUG_STORAGE_STAT If set to Y, turns on periodic reporting of the Analyzer’s use of storage, by executing threads.

N

KFC_DOMAIN_NAME Specifies the Internet domain name. Machine definition

KFC_HOST_NAME Specifies the network interface that the program should use for communication.

Machine definition

KFC_ HTTP_ALLOW_HISTORY_UPDATE If set to Y, allows update of HTTP frame merge history specifications in response to observed page content construction, even if merge specifications are defined in the KFCFPERM file.

If set to N, enforces HTTP frame merge history specifications defined in the KFCFPERM file, so that they cannot be updated, regardless of observed page content construction.

N

KFC_HTTP_COMPARE_IGNORE_CASE If set to Y, Web Response Monitor ignores character case difference when examining or comparing URLs.

If set to N, Web Response Monitor considers character case difference when examining or comparing URLs.

Windows: YUNIX: N

KFC_HTTP_CUSTOM_OBJECTS

Example:

KFC_HTTP_CUSTOM_OBJECTS=obj,OBJ,Obj,JOB,job,Job,news,News,NEWS

Adds customized definitions of embedded object types to the default types defined for data collection. To specify more than one type, use commas to separate the object types.

Note: This setting is case-sensitive, so be sure to specify all possible cases. All likely cases are already specified for the defaults.

gif,jpg, jpeg,wav, map,css,js,swf,swt,img, jar,dll,class, crumb, twhat,vb, vbs,inc, cab,lpk, ico





KFC_HTTP_GROUP_PAGE_OBJECTS If set to Y, embedded objects are included in the total response time calculation for the Web page.

If set to N, response time is calculated and reported separately for the Web page and for each embedded object.

Y

KFC_HTTP_HISTORY_OMIT_HOSTNAME If set to Y, the hostname portion of the URL is excluded from HTTP frame merge specifications. This setting enables the same HTTP frame merge history file to be ported to various application server machines without modification. Example:01 /portal/SM/home.html

If set to N, the hostname portion of the URL is included in HTTP frame merge specifications.Example:01 //net.candle.com/portal/SM/home.html

Y

KFC_HTTP_MERGE_DUPLICATES If set to Y, identical embedded objects (including frames) can be merged into the same Web page.

If set to N, identical embedded objects are not merged into the same Web page.

N





KFC_HTTP_MERGE_FRAMES If set to Y, frames are treated as embedded objects of the parent Web page.

If set to N, frames and the parent Web page are treated as separate pages.

If a load balancer is hiding client browser IP addresses, merging will not work properly, and this option should be set to N.

Note: The default setting of Y can cause a 10– to 20–second delay in response time output, while the embedded objects are merged into their parent frames and the frames are then merged into their parent pages.

N

KFC_HTTP_MERGE_REDIRECT If set to Y, the target URL of a redirect is treated as an embedded object of the original Web page requested.

If set to N, the original and target URLS are treated as separate Web pages.


Y

KFC_HTTP_OUTPUT_UNMERGED_OBJECTS If set to Y, unmerged embedded objects’ data are logged as HTTP page data.

If set to N, unmerged embedded objects’ data are deleted.

N





KFC_HTTP_MERGE_SESSION_DATA If set to Y, embedded objects are included in the total response time calculation of the Web page when the browser uses more than one TCP connection for retrieving these objects concurrently.


Y

KFC_HTTP_PORT Specifies TCP/IP port numbers (in addition to the default) to be monitored for HTTP application data. To specify more than one port number, use commas to separate the numbers.

80

KFC_HTTP_PROCESS_DELAY_FACTOR Sets a multiple of the application schedule window value, to determine the inactivity window of a Web page. The window is extended as long as the page shows activity (for example, the merging of an embedded object, up to the cutoff time specified). Until the window closes, the page is considered outstanding, and no response time is calculated.

See also KFC_APPL_SCHEDULE_WINDOW

7

KFC_KFC1API_DATA If set to Y, response time data are captured for data exchanges between the Analyzer and the Collector.

N





KFC_MAX_APPLICATION_DATA_SIZE Sets the maximum number of bytes of request or reply data that the Analyzer can capture and make available to the KFC2 API caller for examination.

The default value is� 32000

if KFC_HTTP_MERGE_FRAMES is set to Y

� 4000 if KFC_HTTP_MERGE_FRAMES is set to N

See text at left.

KFC_MAX_TCP_IO_PAUSE Sets the maximum number of seconds between TCP request and reply after which the Analyzer considers the session abandoned and generates a response time report.

180

KFC_NETBIOS_DATA If set to Y, the Analyzer includes NETBIOS data packets in its application monitoring.

N

KFC_NFS_DATA (UNIX only) If set to Y, the Analyzer includes Network File System (NFS) data packets in its application monitoring.

N

KFC_OWN_NETWORK_DATA_ONLY If set to Y, only network packets sent and received by the monitoring network interface are captured.

If set to N, all network packets seen by the monitoring network interface are captured. This setting is used for monitoring in appliance mode. For more information, see the “Appliance Mode” section of this chapter.

Y





KFC_RTSP_ALGORITHM If set to Y, the Analyzer uses the Real Time Streaming Protocol (RTSP) response time algorithm for calculating Real video or audio response time.

Y

KFC_SNMP_DATA If set to Y, the Analyzer includes Simple Network Management Protocol (SNMP) inquiry, reply, and trap data packets in its application monitoring.

N

KFC_SRI_HOST (Windows only) Identifies the host name of the HTTPS IIS filter's machine.

Machine definition

KFC_SRI_LISTEN_PORT (Windows only) Identifies the HTTPS IIS filter's listen port number.

7479

KFC_SRI_PIPENAME The pipe name used for communication between the Analyzer and the IIS HTTPS filter module. The default pipe name is

/tmp/KFCfilterFIFO

See at left

KFC_VIDEO_RESPTIME_THRESHOLD Sets the minimum video playtime (in seconds) to qualify the video data for output by the Analyzer. Any video shorter than this threshold is considered aborted and is discarded

5

KFCF_MAX_MERGE_HISTORY_BACKUP Sets the number of URL history backup files created and stored before the oldest one is overwritten. The maximum value is 99.

5

KFCF_MERGE_HISTORY_CUSTOM_FILE_NAME

Specifies the name of your edited URL history file.

KFCFPERM

KFCF_MERGE_HISTORY_EXPIRE_INTERVAL Sets the timespan of existing URL history read from file KFCFHIST at Web Response Monitor startup.

72 hours





KFCF_MERGE_HISTORY_FILE_NAME Specifies the name of the Web Response Monitor URL history file.

KFCFHIST

KFCF_MERGE_HISTORY_NEW_EXPIRE_INTERVAL

Sets the amount of time a dynamic URL history record is kept after the last time the URL was requested by a user in the current run of Web Response Monitor.

8 hours

KFCF_MERGE_HISTORY_RESET If set to Y, the Analyzer ignores existing history when Web Response Monitor is restarted.

N



Appliance Mode


Appliance Mode

The Analyzer component of Web Response Monitor monitors network interfaces for traffic. Depending on the physical network setup, a network interface may see packets other than those traveling to and from its own machine. By default, the Analyzer conserves time and storage by checking the physical network frame address and monitoring only those packets with source or destination addresses that match the physical network address on the interface card. The parameter setting for this default method of monitoring is

KFC_OWN_NETWORK_DATA_ONLY=Y

in file kfcmenv.

However, if the Analyzer cannot run on a particular machine (for example, because of security concerns or because the operating system is not supported by Web Response Monitor), it can run on a separate machine, called the appliance machine. For this configuration, called appliance mode, to work correctly, the Analyzer must be set to monitor all traffic from one port position to another (where the appliance machine is connected). In this way, the appliance machine can see network traffic to and from the machine of interest, and the Analyzer can perform its work. The parameter setting

KFC_OWN_NETWORK_DATA_ONLY=N

in file kfcmenv causes the Analyzer to bypass physical network address verification logic and to monitor all traffic seen by the appliance machine’s network interface.


Configuring the Collector


Collector configuration settingsThe Setup program automatically configures the Collector and places all configuration options and their values in <Candle_Home>\WRM\collector\kflmenvA second copy of the file, containing the default settings, resides in <Candle_Home>\WRM\collector\cfg\If you need to change the settings, edit the kflmenv file in <Candle_Home>\WRM\collector\, not the copy in <Candle_Home>\WRM\collector\cfg\. Keep that copy as installed, so that you can revert to default configuration values if need be.

Important: Do not change the data analysis settings in file kflmenv except under the direction of a Candle representative.

Collector configuration file kflmenvHere are the statements of file kflmenv with their default installed settings.

SM3_COLLECTOR_ID=KFLCOLL1SM3_FIELD_DELIMITER=^SM3_LOG_HTTP=YSM3_LOG_HTTPOBJ=NSM3_LOG_MS_VIDEO=NSM3_LOG_MS_AUDIO=NSM3_LOG_REAL_VIDEO=NSM3_LOG_REAL_AUDIO=NSM3_LOG_QUICKTIME=NSM3_WORK_PATH=<Candle_Home>\WRM\collectorSM3_LOG_KEEPDAYS=7SM3_LOG_DIR=..\..\logSM3_SUB_CHAR=_kbb_ras1=ERROR ^><Candle_Home_>\WRM\collector\kflmcollector.log

Important: Leave no space between any keyword and its setting. Each statement must be on a single line, with no carriage returns or line feeds.



Table 6. Collector Configuration Options in File kflmenv

Option Description

kbb_ras1 Sets the level of RAS1 tracing and the path to the RAS1 log for the Collector. Do not change the level of tracing, or your machine could be overrun with excessive quantities of RAS1 output.

SM3_ COLLECTOR_ID Specifies the Collector ID, which is supplied automatically during product installation and is required for data collection.

SM3_ FIELD_DELIMITER Specifies the character to be used as a field delimiter in data logs. By default, this character is a caret (^).

See alsoSM3_ SUB_CHAR

SM3_ LOG_DIR Specifies the path to the daily response time log files created by the Collector. Do not change this path. The Manager Client looks in this location for the daily log files to be transmitted to the Manager Server.

Make sure that the log directory � contains adequate space� is archived and purged regularly� is not already being used for the log files of another Web

server

SM3_LOG_HTTP Determines whether the Collector logs Web page data (data for the main URL). If the statement is missing from kflmenv, the default setting is N (no logging).

SM3_LOG_HTTPOBJ Determines whether the Collector logs Web object data (data for objects embedded in the Web page). If the statement is missing from kflmenv, the default setting is N (no logging).

SM3_LOG_KEEPDAYS Sets the number of days the log files are retained before deletion. If you do not want the log files to be deleted, change the number to zero (SM3_LOG_KEEPDAYS=0).

If SM3_LOG_KEEPDAYS is set to a number other than zero, the log files are deleted after the specified number of days, even if they have not yet been transmitted to the Manager Server.



SM3_LOG_MS_VIDEO Determines whether the Collector logs Microsoft Windows Media video. If the statement is missing from kflmenv, the default setting is N (no logging).

SM3_LOG_MS_AUDIO Determines whether the Collector logs Microsoft Windows Media audio. If the statement is missing from kflmenv, the default setting is N (no logging).

SM3_LOG_QUICKTIME Determines whether the Collector logs QuickTime video. If the statement is missing from kflmenv, the default setting is N (no logging).

SM3_LOG_REAL_VIDEO Determines whether the Collector logs RealPlayer video. If the statement is missing from kflmenv, the default setting is N (no logging).

SM3_LOG_REAL_AUDIO Determines whether the Collector logs RealPlayer audio. If the statement is missing from kflmenv, the default setting is N (no logging).

SM3_ SUB_CHAR Specifies the character that replaces the default field delimiter in data logs if a monitored URL address contains the default character. By default, this character is an underscore (_).

See alsoSM3_ FIELD_DELIMITER

SM3_W0RK_PATH Specifies the path to the Collector’s working directory. This statement is required and is set during installation.

Table 6. Collector Configuration Options in File kflmenv

Option Description

Data Collection Tips



High-volume environmentsIn a high-volume environment, Candle recommends that you implement PathWAI Web Response Monitor data collection in stages:

� Install and deploy PathWAI Web Response Monitor on one Web server machine at a time.

� Begin by collecting and logging Web page data (SM3_LOG_HTTP=Y) in kflmenv) but not Web object data (SM3_LOG_HTTPOBJ=N). If collection and logging of Web page data proceed without problems, then you can add Web object data.

Example

For an average volume of 100 Web page transaction requests per minute, with 5 graphic images (objects) per page:

When Web page data collection is enabled (SM3_LOG_HTTP=Y), PathWAI Web Response Monitor uses an average of 800 bytes per record, with 1 record per Web page:

100 * 800 = 80 KB/minute = 4.8 MB/hour

When Web object data collection is enabled (SM3_LOG_HTTPOBJ=Y), PathWAI Web Response Monitor uses an average of 500 bytes per record, with 6 records per Web page (5 records for the graphic image objects, plus 1 record for the Web page object):

600 * 500 = 300 KB/minute = 18 MB/hour

Log filesDo not open any of the PathWAI Web Response Monitor log files while the product is running, or you will interrupt current data logging. If you want to examine a log file, make a copy of it and examine the copy.



Load balancersIf a load balancer is hiding client browser IP addresses, the merge options do not work properly, because PathWAI Web Response Monitor has no way of differentiating clients from each other. Therefore, it is recommended that you disable the merge options in such environments. By default, the merge options are enabled. To disable them, set them as follows in file kfcmenv:

KFC_HTTP_MERGE_FRAMES=NKFC_HTTP_MERGE_REDIRECT=NKFC_HTTP_MERGE_SESSION_DATA=N

URL History Files


URL History Files

Two kinds of history filesThere are two kinds of Web Response Monitor URL history files:� a dynamic URL history file named KFCFHIST� a permanent URL history file named KFCFPERM

Dynamic historyIf frame merging is enabled in file kfcmenv (KFC_HTTP_MERGE_FRAMES=Y), PathWAI Web Response Monitor creates and maintains URL history file KFCFHIST. This file is updated every hour and at shutdown, and it is backed up when Web Response Monitor is restarted. The history file keeps a record of the way URLs are merged; that is, which URLs are embedded as frames in each parent URL. When Web Response Monitor encounters those URLs again, it merges them in the same manner as recorded in the history file. By basing current URL merges on the URL history, Web Response Monitor can provide more meaningful, consistent response time and other statistics.

Permanent historyBecause file KFCFHIST is kept open for updates when Web Response Monitor is running, it should not be edited. If you want to modify the URL merge history, you can do so by copying records from KFCFHIST to KFCFPERM and editing them there. File KFCFPERM then overrides KFCFHIST. Web Response Monitor never writes to KFCFPERM.

History record format

The 3 types of records you can edit are01 <url>02 <UTC time><method><referrer>03 <parent URL>

where<url> is the subject URL of the record.<UTC time> can be set to 0, because it does not affect the merge history.<method> is the page retrieval method (for example, GET).<referrer> is one of these:


URL History Files

– the URL from which the user navigated to the subject URL– * if there is no referrer– ? if the referrer is variable<parent URL> is the URL (if any) in which the subject URL is embedded.

A standalone page (one that is not embedded in another page) has no record 03.

When a URL is embedded in a parent URL, the parent and the referrer are identical. Web Response Monitor records the identity of the referrer because in the case of an HTTP redirect (HTTP status code 302), the referrer can be outside the monitored network. In such a case, Web Response Monitor can throw away the record.

Example 1

Let's use http://www.candle.com/index.html and http://www.candle.com/news.html as an example. If news.html is linked from index.html, then they appear in the history file as follows:

01 //www.candle.com/index.html02 0 GET *01 //www.candle.com/news.html02 0 GET //www.candle.com/index.html

The asterisk (*) in the first 02 record means that there is no referrer.

If news.html is actually embedded in index.html, you can do this:

1. Copy the records from KFCFHIST and paste them into KFCFPERM.

2. Modify the records as follows:01 //www.candle.com/index.html02 0 GET *01 //www.candle.com/news.html02 0 GET //www.candle.com/index.html03 //www.candle.com/index.html

The 03 record you have added establishes index.html as the parent URL of news.html.

Conversely, if a 03 record incorrectly names a parent URL for a standalone page, you can delete the 03 record.

URL History Files


Example 2

In this example, the question mark (?) in the first 02 record means that the referrer is variable; that is, the frame can be accessed from more than one Web page, but the same set of frames are associated with this frame, regardless of referrer.

01 /cde/PLWMInbox.asp02 0 GET ?01 /cde/PLWMInBoxIFrame.asp02 0 GET /cde/PLWMInbox.asp03 /cde/PLWMInbox.asp01 /cde/PLWMInBoxIFrame.asp02 0 POST /cde/PLWMInBoxIFrame.asp03 /cde/PLWMInbox.asp

Rules for editing the permanent history file� Both KFCFHIST and KFCFPERM must reside in the Analyzer work

directory (set in kcfmenv option KFC_WORK_PATH).

� To establish the proper merging relationship, the parent URL’s record must appear before any of its embedded URLs’ records.

� The history files cover Web pages and frames, but do not cover embedded objects such as graphics files.

� URLs in the history files must not contain protocol or query strings.

� A line starting with a pound sign (#) is a comment.

# This is a comment line

Configuration optionsSeveral options in file kfcmenv affect the operation of the history files. See Table 5: Analyzer Configuration Options in File kfcmenv on page 93 for descriptions of each of these options.

Names

You can change the names of the dynamic and permanent history files by changing the values of configuration options KFCF_MERGE_HISTORY_FILE_NAME and KFCF_MERGE_HISTORY_CUSTOM_FILE_NAME, respectively.


URL History Files

Backups

Each time Web Response Monitor starts, it renames the current KFCFHIST file to backup file FHIST_nn, where nn is the consecutive number of the backup. By default, 5 backups are maintained, but you can change this number to a maximum of 99 by setting configuration option KFCF_MAX_MERGE_HISTORY_BACKUP.

At run time, Web Response Monitor renames the existing file KFCFHIST to KFCFOLD and creates KFCFHIST containing updated data.

Expiration

Before the merge history is saved to file, the dynamic history records are examined to see whether they have expired. A history record expires if it has not been requested by a user for a period of time (by default, 8 hours). You can change this period of time by setting configuration option KFCF_MERGE_HISTORY_NEW_EXPIRE_INTERVAL.

The expiration interval for existing history (history read from the history file at startup) is 72 hours by default. You can use configuration option KFCF_MERGE_HISTORY_RECORD_EXPIRE_INTERVAL to modify this value. The 72-hour default ensures that no records are deleted over 3-day weekends. If Web Response Monitor detects that the history file was created more than 72 hours ago, it ignores the file’s timestamp and uses the current time instead, to prevent loss of history records if the system is down for a long time.

Permanent history records never expire.

Restarting without history

If you want to restart Web Response Monitor without using existing history files, you can do one of these:

� In file kfcmenv, set KFCF_MERGE_HISTORY_RESET=Y.

� Rename files KFCFHIST and KFCFPERM.

� Delete files KFCFHIST and KFCFPERM.

Note: If you restart Web Response Monitor without using existing history, and a monitored URL has been cached (HTTP status code 304), transactions with that URL are discarded without production of a response time record. This condition continues until the URL is

URL History Files


retrieved (status code 200), causing Web Response Monitor to create a corresponding URL history record.


IIS Tips

IIS Tips

Managing the Candle ISAPI filterIf you have set up a Candle IIS filter, and you then add a Web site to the Web server, you must remove and reinstall the filter so that it will apply to the new Web site as well as to all the existing ones.

Removing a filter

For instructions, see “Uninstalling Web Response Monitor” on page 73. Follow the procedure to remove the Candle filter. You do not need to uninstall the Web Response Monitor Analyzer.

Reinstalling a filter

For instructions, see “Install the data collection components” on page 40.

Verifying data collection

After you make any change to the IIS configuration, such as adding or removing a filter, be sure to verify that Web Response Monitor data collection is proceeding properly. See “Verify data collection” on page 50.

Socket timeoutIIS servers default to a socket timeout of 900 seconds (15 minutes). This value may be reasonable for some applications that use Secure Socket Layers (SSL). However, most public Web sites and enterprise intranets do not need such long timeouts, and performance suffers when sockets linger long after the user has left the page or quit the browser. For most Web sites, we recommend a socket timeout around 300 seconds (5 minutes).

ASP buffering IIS Web servers have the following default settings for ASP buffering.

� IIS 4.0: ASP buffering is turned off.

� IIS 5.0, new installation: ASP buffering is turned on.

� IIS 5.0, upgrade: The previous setting is retained.

IIS Tips


If ASP buffering is turned off, the server emits Chunked Transfer Encoding packets, which are likely to contain only a few bytes each and thus are a highly inefficient way to send ASP-generated data.

With ASP buffering turned on, IIS collects the packets into large chunks and sends each chunk as if it were a static HTML page. File segmentation still occurs between server and client, but the buffers contain more data per transmission. ASP buffering improves the performance of your Web server and of PathWAI Web Response Monitor data collection.

Enabling ASP buffering for an entire Web site

To enable ASP buffering for the entire Web site on an IIS 4.0 server:

1. From the Microsoft Management Console, open the Internet Information Server folder.

2. Select the site and select Properties.

3. In the Master Properties section of the Internet Information Server tab, click Edit.

4. On the Home Directory tab, click Configuration.

5. On the App Options tab, check the ASP Buffering checkbox.

6. Click Apply, then click OK to close each dialog.

7. Follow these steps to enable the configuration changes.A. Select:

(Windows NT) Start > Settings > Control Panel > Services.


B. Stop and restart the WWW service. C. Close the Services dialog and the Control Panel.

Enabling ASP buffering for selected pages

To enable ASP buffering for an individual page, incorporate this as the first line of the ASP code for the page:

Response.Buffer = TRUE

The page will always be buffered, regardless of the server configuration setting.

Consolidating Data 115

Consolidating Data

IntroductionThis chapter explains how to configure and use Manager Client and Manager Server for filtering, transmission, consolidation, and storage of response time data.

Chapter ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Manager Client and Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Version compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Manager Client as a Windows Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Java console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Manager Client console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Screen resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Configuring the Manager Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Configuring Manager Clients from Manager Server . . . . . . . . . . . . . . . . . . . 122Configuring Manager Client from within Manager Client . . . . . . . . . . . . . . . 123

Manager Client Settings Notebook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124General page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Email page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125TCP/IP page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Exception and Average page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Saving the Manager Client settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Manager Client Initialization Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Creating the properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

6


Initialization parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Receiving Settings from Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Client profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Receiving updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Sending Data to Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Scheduled and unscheduled data transmission. . . . . . . . . . . . . . . . . . . . . . . 133(Windows) Sending data at startup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133(UNIX) Sending data at startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Disabling data transmission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Settings profile transmission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Successful and unsuccessful data transmission . . . . . . . . . . . . . . . . . . . . . . . 134

Viewing Manager Client Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Manager Client console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Manager Client message log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Resetting the message log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Purging the message log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Manager Server as a Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Java console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Manager Server console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Screen resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Running Manager Server under UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Two modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Starting Manager Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Stopping Manager Server in Silent mode . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Configuring the Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Specifying settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Manager Server Settings Notebook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141General page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Data page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142TCP/IP page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Email page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147File Transfer page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Confirmation page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Manager Server Initialization Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Creating the properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Initialization parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Setting up Manager Clients from Manager Server . . . . . . . . . . . . . . . . . . . . . . . . 154


Why set up Manager Clients from Manager Server? . . . . . . . . . . . . . . . . . . . 154How to set up Manager Clients from Manager Server . . . . . . . . . . . . . . . . . . 154

Exception Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Manager Client exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155How exception data are handled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Email Transmission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Configuring email transmission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Server hostname specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Hard-coded email settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Mail checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Handling of bad records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Email server filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Buffer trace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Updating Manager Clients from Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . 158Changing Manager Client settings or operating modes . . . . . . . . . . . . . . . . . 158Operating modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158(Windows only) Changing the operating mode of a Manager Client . . . . . . . 159(UNIX only) Changing the operating mode of a Manager Client. . . . . . . . . . 159Updating Manager Clients from Manager Server . . . . . . . . . . . . . . . . . . . . . 160Adding Manager Clients to the list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Deleting Manager Clients from the list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Requesting data from Manager Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Shutting down Manager Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Client status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Changing the heartbeat setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Sending Data to Other Manager Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Mirroring data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Where Manager Server sends data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Storing Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Methods of storing response time data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Storing data in flat log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Storing data in an ODBC/JDBC database . . . . . . . . . . . . . . . . . . . . . . . . . . 167(Windows) Setting up an ODBC database driver . . . . . . . . . . . . . . . . . . . . . 167(Windows) Setting up an Oracle JDBC database driver . . . . . . . . . . . . . . . . 168(Linux) Setting up an Oracle JDBC database driver . . . . . . . . . . . . . . . . . . . 169(Other UNIX platforms) Setting up an Oracle JDBC database driver . . . . . . 170Providing database settings in Manager Server . . . . . . . . . . . . . . . . . . . . . . . 171If a database table experiences a failure condition . . . . . . . . . . . . . . . . . . . . 172If a database cannot be accessed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172If a database remains empty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172


Problem with Microsoft Access and HotSpot JVM. . . . . . . . . . . . . . . . . . . . . 173Customizing Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Customizing the list of tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Customizing database column definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

About Maintenance Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178


Overview

Overview

Manager Client and Manager ServerThe Manager Client and Manager Server components work together to filter, transmit, consolidate, and store response time data.

Manager Client:

� reads the data collected

� filters and averages the data

� sends the data to Manager Server at preset intervals

Manager Server:

� receives data from all Manager Clients and other Manager Servers configured to send data to it

� logs the data for use by the Enterprise Reporter, or stores the data in ODBC/JDBC database tables

Version compatibilityThe version of Manager Server must be the same as or higher than the version of any Manager Client configured to communicate with it. To determine the version of Manager Server, select Help > About Manager Server from the Manager Server console.

To determine the version of Manager Client, select Help > About Manager Client from the Manager Client console.

Manager Client as a Windows Service



Java consoleDuring installation, Manager Client was automatically configured as a Windows service. If you want to run Manager Client with the Java console for debugging purposes, you must first stop Manager Client as a Windows service and then restart it with the Java console, as follows.

1. Select:� (Windows NT) Start > Settings > Control Panel > Services


2. Select Candle Web Response Monitor Manager Client and click Stop.

3. Restart Manager Client by the executing file<Candle_Home>\mgmt\manager\client\clientdebug.bat

where <Candle_Home> is the Web Response Monitor home directory.

Manager Client restarts with the Java console.

Manager Client consoleBy default, Manager Client displays its own console. If you want to turn off display of the Manager Client console under Windows:

1. Select:� (Windows NT) Start > Settings > Control Panel > Services


2. Double-click Candle Web Response Monitor Manager Client.The Services dialog box appears.

3. Uncheck Allow Service to Interact with Desktop.Manager Client will not display its console.



Screen resolutionFor proper display of Manager Client in a GUI window, the screen resolution size must be set at 800 by 600 pixels. If the default screen resolution size (640 by 480 pixels) is used, the top and bottom of the Manager Client console window are forced off the display area.

Configuring the Manager Client



SettingsBoth Manager Server and Manager Client provide a Manager Client Settings notebook, where you can specify how and when Manager Client will transmit data to Manager Server.

� From Manager Server, you can set up all or any Manager Clients connected to Manager Server by TCP/IP, and you can send updates for Manager Client settings.

� From Manager Client, you can set up only the Manager Client running on the local machine, and you can do this only if the Manager Client is running in Admin mode.

Tip: In general, you will probably want to centralize control by configuring Manager Clients from Manager Server.

In addition, some features of Manager Client can be modified by initialization parameters set in a properties file. See “Manager Client Initialization Parameters” on page 130.

Configuring Manager Clients from Manager ServerTo specify Manager Client configuration settings from Manager Server:

1. While Manager Server is running, click the Update Clients button.

2. Select all the Manager Clients you want to configure.

3. Select Profiles > Setup.The Manager Client Settings notebook appears. This settings notebook contains several tabbed pages:

� General page

� Email page

� TCP/IP page

� Exception and Average page

4. Specify all desired Manager Client settings, and click OK.



5. To send the updates immediately to the selected Manager Clients, select Profiles > Send Now.Each selected Manager Client receives and immediately activates the new settings.

6. Click OK to close the Update Clients dialog.

Configuring Manager Client from within Manager ClientTip: To specify configuration settings from Manager Client, the Manager Client must be running in Admin mode.

To specify configuration settings from Manager Client:

1. While Manager Client is running, click the Settings button.The Manager Client Settings notebook appears. This settings notebook contains several tabbed pages:

� General page

� Email page

� TCP/IP page

� Exception and Average page

2. In the notebook, specify all desired Manager Client settings, and click OK.

Manager Client Settings Notebook



General pageUse the General page to set up the basics of data transmission to Manager Server.

1. In the Desktop Nickname field, specify a name to be added to the data records sent to Manager Server.The desktop nickname, in addition to the IP address, identifies the Manager Client. If this field is left blank, it defaults to the local host name.

� Exception data, or alert data, sent whenever an exception is detected. Be sure to select Send Exception Data if you want to send alerts to an OMEGAMON Monitoring Agent® (OMA®) or OMEGAMON® XE. The interval at which Manager Client checks for exceptions is set on the Exception and Average page.

2. Specify an interval for sending data to Manager Server.Web Response Monitor data are considered detail data. If you specify an interval for summary data, the same data will be sent at both the summary data interval and the detail data interval. Therefore, it is recommended that you specify a detail data transmission interval, and select Never for summary data transmission. If you do not want any data at all to be sent to Manager Server, select Never for both Send Summary Data and Send Detail Data.

3. If you want exception data, or alert data, to be sent whenever an exception is detected, select Send Exception Data. Be sure to select Send Exception Data if you want to send alerts to an OMEGAMON Monitoring Agent® (OMA®) or OMEGAMON® XE. The interval at which Manager Client checks for exceptions is set on the Exception and Average page.

4. Use the Send Heartbeat drop-down list to select an interval for transmission of a heartbeat signal (ping) to Manager Server. The default interval is 15 minutes. To suppress heartbeat transmission, select Never. Any change to the heartbeat interval setting results in immediate transmission of a heartbeat, even if the new setting is Never, so that the change can be reported to the Manager Server with a new client profile.

Note: Transmission of the client profile to the Manager Server relies on the heartbeat. If you suppress the heartbeat, any further changes to the Manager Client settings are not sent to Manager Server.



5. In the Transport Settings section, select the desired transmission method:� TCP/IP

� email

� TCP/IP as a first choice and email as a backup method in case of a failure to connect to Manager Server by TCP/IP

6. If you leave the Log Status Messages option unchecked (in the Status Message Logging section), status messages do not display on the console. To ensure an audit of activity, status messages are always logged to file MSG.LOG. Specify whether to reset the message file each time Manager Client is started. (The message file can also be reset as desired through Action > Debug > Reset Console File.)

7. Use the Status Message Purge section to determine whether to delete status messages when file MSG.LOG reaches the maximum specified size. The minimum setting you can use is 1000 KB. If you set it to anything less than 1000 KB, the setting is automatically reset to 1000 KB.

Email pageUse the Email page to configure email transmission of data to Manager Server. If TCP/IP alone was specified on the General page, the options on the Email page are grayed out and cannot be set.

On the Email page, specify the email account name, mail server address, and SMTP port number for email transmissions.

1. If you type a specific host name, you are restricted to using only that particular server to retrieve email messages. Some email messages may not be received if the host names do not match. The host name you use should be the one returned when the command hostname is typed at the UNIX shell or at the DOS command prompt of the receiving host.

Note: In the Manager Server field, if you specify the wildcard character * rather than the name of a specific server, then any server can receive the email.

2. In the Mail From field, specify an authorized user ID for your email system. Use a format that conforms to your system’s conventions; for example,

mary_brown

The default value is ART.



3. (Optional) You can also set a number of retry attempts and a timeout for each attempt. If the email transmission fails after the timeouts and retries have been exhausted, a message to that effect appears on the Manager Client console.

4. (Optional) In the Mail Message Size field, you can specify the maximum number of records for each email message. This option helps prevent email transmission problems. For example, if you set the mail message size at 50 (records) and 100 records need to be sent, then the data would be sent in two email messages: one containing 50 records, and the other containing the remaining 50 records. You need to determine the average size of a message and how you want it to be broken down. Keep in mind that the more a message is broken down, the greater the transmission overhead.

5. (Optional) Check Send Scrambled Data if you want the data to be encoded before transmission.Tip: Even if the Manager Client is configured to send data by email, the Manager Server cannot pick up that mail from the mail server unless configured to do so in the Manager Server Settings notebook.

For more tips and information on email transmission, see “Email Transmission” on page 156.

TCP/IP pageUse the TCP/IP page to configure TCP/IP transmission of data to Manager Server. If email alone was specified on the General page, the options on the TCP/IP page are grayed out and cannot be set.

The TCP/IP page lists the current Manager Servers to which the Manager Client can transmit data. The Manager Client only connects to a single Manager Server at a time. It attempts to send data to the first server listed, and upon failure, tries each successive server in the list.

Note: If Manager Client is installed on a system with more than one network interface, you may need to direct TCP/IP traffic through a specified network interface. See “Manager Client Initialization Parameters” on page 130.

Adding a server



To add a server to the list on the TCP/IP page:

1. In the Central Server Address field, specify the IP address or name of the machine on which a Manager Server is installed. If you want to send data to the Manager Server running on the same machine as the Manager Client, use the name localhost.

2. In the Send Data Port Number field, specify the port number configured as the Data Receive Port Number in the Manager Server Settings notebook. The default number is 8192.

3. (Optional) To test the connection, click Ping. Manager Client attempts to contact the Manager Server you specified, and displays a message indicating whether the connection was successful.

4. Click Add. The port number and address of the server appear on the Server Port and Address List. When it is scheduled to send data, the Manager Client will attempt to send to the first Manager Server listed, and upon failure, will try each successive server in the list.

Changing the order of servers

To set the order of servers in the list:

1. Click a listed server to select it.

2. Use the Up and Down buttons to position the server in the desired order.If you want the server to which Manager Client is connected always to be the first one tried, check Move connected server to the top.

Port settings

The Accept Request Port Number, which indicates the port number to be used for transmissions from Manager Server to Manager Client, corresponds to the Request Data Port Number set in the Manager Server Settings notebook. The default number is 9200.

Exception and Average pageIf Send Exception Data is checked on the General page, you can use the Exception and Average page to define filtering rules that dictate which response time measurements are considered to be exceptions. On this page you can also set intervals for checking for exceptions and for averaging data.



Before you set up any exception filters, watch the Web Response Monitor components run for a while. Then you will know how much response time data your applications are generating and how to apply exception filters judiciously.

Tip: If you are using these exception filters as the basis for CandleNet Portal® situations, each situation must contain the same settings as a Manager Client exception filter.

Adding a filter

To add a filter to the list:

1. Click a Column on which you want to filter, select an Operator, and specify a Compare Value for comparison.

2. Click Build to build the filter. The filter moves down to the Filters section.

Example: ResponseTime>10000 [milliseconds]

3. If you want to add a second predicate to the filter, repeat the preceding steps. The two predicates are joined by AND.

Example: ResponseTime>10000 AND ApplicationExecutable=IEXPLORE.EXE

4. When the filter contains all desired predicates, click Add. The filter moves down to the list of active filters.

In the example, Internet Explorer transactions with a response time greater than 10 seconds are treated as exceptions.

Using wildcards

You can use the wildcard character * at the beginning, middle, or end of your Compare Value specification for a filter.

Examples:

Title=*customer

matches any title that ends with customer.

Title=customer*

matches any title that begins with customer.



Title=customer*system

matches any title that begins with customer and ends with system. Thus, it would match the title Customer Information System but would not match Customer Query Application.

Editing a filter

1. Click the filter to select it.

2. Click Edit. The filter moves up to the filter definition area.

3. Click <=. The filter moves up to the Columns/Operators/Compare Value area for editing.

Tip: To edit one predicate of a filter, double-click or highlight the predicate of interest before clicking <=.

4. Make the desired changes, then click Build and Add to activate the edited filter.

Deleting a filter

To delete a filter, select the filter and click Delete.

Setting the exception checking interval

In the Exception Interval Settings section, specify the Checking Data Interval in minutes. For example, if you specify 3, data will be checked for exceptions once every 3 minutes.

Tip: Checking for exceptions occurs only when the Manager Client is running.

Setting the averaging interval

The Average Interval Settings section does not apply to Web Response Monitor. No data averaging or summarization is performed by Manager Client. Ignore this section.

Saving the Manager Client settingsWhen you have specified all desired settings, click OK to save your settings and to close the notebook.

Manager Client Initialization Parameters



Properties fileYou can modify some features of Manager Client by creating a properties file that sets the value of initialization parameters. The properties file must be named keg.properties and must be located in the Manager Client working directory (usually <Candle_Home>\mgmt\manager\client on Windows, where <Candle_Home> is the Web Response Monitor home directory.). The initialization parameters are loaded during Manager Client startup, so your changes will take effect the next time Manager Client is started.

Creating the properties fileTo specify Manager Client initialization parameters:

1. Use a text editor (for example, Notepad on Windows) to create a plain text file named keg.properties.

2. Enter the parameters you need (see Initialization parameters below).

3. Save file keg.properties to the Manager Client working directory.

Initialization parametersYou can specify these parameters in file keg.properties.

Local host address for multihome systems

keg.localaddr=<local address>

Specifies the local host address to use in multihome systems (those with more than one network interface). By default, all TCP sockets are bound to the primary network interface. In some installations (for example, systems running in a DMZ environment outside the company firewall), you might want to use another, publicly accessible network interface for Manager Client TCP/IP connections.

The local host address you specify can be either the IP address or the hostname of the preferred interface for Manager Client. All TCP/IP socket connections created by the Manager Client are then bound to the specified local address.



Examplekeg.localaddr=10.20.30.40

Data log directory

keg.logpath=<pathname>

Specifies the pathname where Manager Client looks for Collector data logs.

This parameter is useful if you want to log data on a separate drive from the programs, or on a network-mounted file system. Separating the logs from the programs can improve performance by reducing contention for system files (such as the system page file).

The pathname you specify can be either a full pathname or a pathname relative to the Manager Client working directory. The default is <Candle_Home>\log.

Receiving Settings from Manager Server


Receiving Settings from Manager Server

Client profilesIn addition to the settings configured in each Manager Client, settings can be sent from Manager Server to any Manager Client connected to the Manager Server by TCP/IP. Settings sent from Manager Server are called client profiles.

From Manager Server, select one or more Manager Clients on the Update Clients dialog. (See “Updating Manager Clients from Manager Server” on page 158.) The Manager Server presents selected profiles to you one at a time to edit. When you select Profiles > Send Now, the Manager Server sends each profile, one at a time, to the selected Manager Clients. Each Manager Client receives and immediately activates the new settings.

Receiving updatesYou do not need to do anything from the Manager Client end to receive profiles and other updates. The updates are sent as the result of actions taken in Manager Server.

When the Manager Client receives a new profile, you may see many console messages being written quickly.


Sending Data to Manager Server


Scheduled and unscheduled data transmissionManager Client automatically sends detail and exception data at intervals set in the Manager Client Settings notebook, and automatically sends a heartbeat signal (ping) to the Manager Server every 15 minutes (unless the heartbeat setting in the General Page is set to Never).

In addition to these scheduled transmissions, you can send data to Manager Server at any time by clicking the Send Detail Data button. Do not use the Send Summary Data button for transmitting Web Response Monitor data.

When you click the Send Exception Data button, data will be sent only if the Exception and Average page has been filled out.

Tip: If a transaction title contains an apostrophe (‘), Manager Client converts the apostrophe to a quotation mark (“) before sending the data record to Manager Server. This conversion prevents database problems, but causes the apostrophe to display as a quotation mark in the Enterprise Reporter’s Detail view.

(Windows) Sending data at startupTo start Manager Client in Batch Send mode:

1. Select:� (Windows NT) Start > Settings > Control Panel > Services.


2. Select Candle Manager Client.

3. In the Startup Parameters field, type -send.

4. Click Start.Manager Client starts, sends data immediately, and then shuts itself down.

(UNIX) Sending data at startupTo start Manager Client in Batch Send mode:

1. Create a startup script for Manager Client.



2. Add the -send parameter to your Manager Client startup script command.

3. Execute the script.Manager Client starts, sends data immediately, and then shuts itself down.

Disabling data transmissionTo disable transmission of Web Response Monitor data, select Never as both the Send Summary Data interval and the Send Detail Data interval on the General page of the Manager Client Settings notebook.

To disable transmission of exception data, uncheck the Send Exception Data box on the General page of the Manager Client Settings notebook.

Settings profile transmissionIf the Manager Client is running in Admin mode and its settings change, the new settings profile is transmitted with the next heartbeat signal. The new profile is accepted unless Manager Server is already scheduled to send a profile update to the Manager Client. In that case, Manager Server discards the profile transmitted by the Manager Client.

If the hearbeat signal is suppressed (set to Never on the General page of the Manager Client notebook), it can be restarted. You do this by using Update Clients > Setup to change the heartbeat interval setting for the Manager Client.

Successful and unsuccessful data transmissionFor data transmission to succeed, both Manager Client and Manager Server must be running, and the correct TCP/IP or email settings must be provided in their settings notebooks. For tips on email transmission, see “Email Transmission” on page 156.

If the transmission fails, the Manager Client discards exception records, requeues the request, and retries the transmission later. When the retry is successful, stored detail data are sent, but exception records (which have been discarded) are not.


Viewing Manager Client Status Messages

Viewing Manager Client Status Messages

Manager Client consoleWhen Manager Client is running in Normal or Admin mode, status messages appear in its console window. You can clear the console window by selecting Action > Debug > Clear Console.

Manager Client message logIf Log Status Messages is checked on the General page of the Manager Client Settings notebook, status messages are written to <Candle_Home>\mgmt\manager\client\MSG.LOG, where <Candle_Home> is the Web Response Monitor home directory.

Resetting the message logOn the General page of the Manager Client Settings notebook, you can specify whether to reset the message log file each time Manager Client is started.

You can also reset the message log file at any time by selecting Action > Debug > Reset Console File.

Purging the message logIf Purge Message Log File is checked on the General page, status messages are deleted when file MSG.LOG reaches the specified size. The minimum setting you can use is 1000 KB. If you set it to anything less than 1000 KB, the setting is automatically reset to 1000 KB.

Manager Server as a Windows Service



Java consoleDuring installation, Manager Server was automatically configured as a Windows service. If you want to run Manager Server with the Java console for debugging purposes, you must first stop Manager Server as a Windows service and then restart it with the Java console, as follows:



2. Select Candle eBA Manager Server and click Stop.

3. Restart Manager Server by executing file<Candle_Home>\mgmt\manager\server\ServerDebug.bat

where <Candle_Home> is the Web Response Monitor home directory.Manager Server restarts with the Java console.

Manager Server consoleBy default, Manager Server displays its own console. If you want to turn off display of the Manager Server console under Windows:



2. Double-click Candle eBA Manager Server.The Services dialog box appears.

3. Uncheck Allow Service to Interact with Desktop.Manager Server will not display its console.



Screen resolutionFor proper display of Manager Server in a GUI window, the screen resolution size must be set at 800 by 600 pixels. If the default screen resolution size (640 by 480 pixels) is used, the top and bottom of the Manager Server console window are forced off the display area.

Running Manager Server under UNIX



Two modesOn UNIX systems, you can start Manager Server in either of two modes:

� Silent modeManager Server runs hidden, without a user interface.

� Console modeThe Manager Server console runs in an X Window session and provides all user interface, configuration, and control features.

Tip: For proper display of Manager Server in a GUI window, the screen resolution size must be set at 800 by 600 pixels. If the default screen resolution size (640 by 480 pixels) is used, the top and bottom of the Manager Server console window are forced off the display area.

Starting Manager ServerYou can start Manager Server in either Console mode or Silent mode:

� Console mode

To start Manager Server in Console mode, enter this command:

<Candle_Home>/mgmt/manager/server/server.sh


� Silent mode

To start Manager Server in Silent mode, enter this command:

<Candle_Home>/mgmt/manager/server/server.sh -silent


When the Manager Server is running in Silent mode:

– You can use the UNIX ps command to see whether the Manager Server is running (process name jre).

– The msg.log file is updated continually and is the only source of information about the health of the Manager Server.



Stopping Manager Server in Silent modeTo shut down the Manager Server when it is running in Silent mode, enter this command:

<Candle_Home>/mgmt/manager/server/stopserver.sh


Important: Do not use the kill command to stop the Manager Server. The stopserver.sh script ensures that all threads are completed before termination.

Configuring the Manager Server


Configuring the Manager Server

SettingsThe Manager Server settings specify:

� whether and how the Manager Server will mirror data; that is, send data to another Manager Server in the network

� whether the Manager Server will store data in flat log files or in a database, or both

� how Manager Server will handle status messages

� which user actions will require confirmation

In addition, some features of Manager Server can be modified by initialization parameters set in a properties file. See “Manager Server Initialization Parameters” on page 152.

Specifying settingsTo specify settings for the Manager Server:

1. While Manager Server is running, click the Settings button. The Manager Server Settings notebook appears. This settings notebook contains several tabbed pages:

� General page

� Data page

� TCP/IP page

� Email page

� File Transfer page

� Confirmation page

2. In the notebook, specify all desired Manager Server settings, and click OK.


Manager Server Settings Notebook


General pageUse the General page to set up the basics of Manager Server configuration.

1. In the Server Mirror Settings section, specify whether you want data received by the Manager Server to be sent, or mirrored, to another Manager Server in the network. Unless you check the Mirror Data to Additional Server checkbox, the rest of this section is grayed out. If you check the checkbox, you can then select the desired transmission method:

� TCP/IP

� email

� TCP/IP as a first choice and email as a backup method in case of a failure to connect by TCP/IP

� file transfer

Tip: The file transfer method of sending data compresses data before mirroring and generally achieves a compression ratio of around 90%. This method dramatically reduces the file transfer time between servers and is therefore advantageous for bulk data transfer.

2. Select the types of data you want to mirror:� generic (Web Response Monitor data)

� exception (alert)

3. Use the drop-down list to select an interval or a specific time for data transmission to another Manager Server.

4. In the Receive Settings section, select a transmission method for receiving data from Manager Clients and from other Manager Servers.

5. In the Candle Command Center OMA section, check Enable Candle Command Center OMA and provide a valid OMA Port Number if:

� your site has purchased a Candle Command Center® or CandleNet Portal® with an OMEGAMON Monitoring Agent® (OMA®) or OMEGAMON® XE that accepts and reports on Web Response Monitor data.



� you want exceptions found by the Manager Client to trigger alerts on the Candle Management Workstation® or CandleNet Portal workstation.

The OMA Port Number is used to establish communications between the Manager Server and the OMA or OMEGAMON XE. The default is 15000.

Transmission of exception data to each active OMA or OMEGAMON XE uses a different port number, which is assigned dynamically.

If you need to change an existing port number, follow these steps:

A. Shut down the OMA or OMEGAMON XE.B. Change the OMA Port Number setting on the General page of the

Manager Server Settings notebook.C. Shut down and restart the Manager Server.D. Restart the OMA or OMEGAMON XE.

For more information, see the documentation for the OMA or OMEGAMON XE.

6. If you leave the Log Status Messages option unchecked in the Status Message Logging section, status messages do not display on the console. To ensure an audit of activity, status messages are always logged to file MSG.LOG. Specify whether to reset the message file each time Manager Client is started. (The message file can also be reset as desired through Action > Debug > Reset Console File.)

7. Use the Status Message Purge section to determine whether to delete status messages when file MSG.LOG reaches the specified size. The minimum setting you can use is 1000 KB. If you set it to anything less than 1000 KB, the setting is automatically reset to 1000 KB.

8. When you have completed the General settings, you can go on to the other pages or click OK to save your settings and close the settings notebook.

Data pageManager Server can store its data in these formats:

� flat log files, written either in the default locale encoding or in Unicode Transformation Format, 8-bit form (UTF-8 encoding)

� Open DataBase Connectivity (ODBC) or Java DataBase Connectivity (JDBC) database tables



Tip: Writing data in more than one format requires increased data storage space.

For information on data record formats for both flat files and database tables, see the appendix titled “Data Record Formats.”

Flat files

UTF-8 encoding is useful if the Manager Server receives data from Manager Clients and other Manager Servers in disparate locales, with disparate character encoding formats. Otherwise, the default locale encoding is recommended. Some reporting tools can read data written in the default locale encoding, but not in UTF-8 encoding.

Database tables

Manager Server data can be written to tables for any database vendor that supports Open DataBase Connectivity (ODBC) or Java DataBase Connectivity (JDBC) drivers.

If you plan to log Web Response Monitor data to an external JDBC/ODBC database, delete your existing JDBC/ODBC tables before starting Manager Server for the first time. Otherwise, ODBC/JDBC logging is turned off until the existing tables are deleted. Then Manager Server automatically creates database tables with the latest format. If you wish to archive your existing tables, relocate them to another directory.

Tip: Before the Manager Server can write data to an ODBC/JDBC database, the database must be defined and the database driver must be configured. See “Storing Data” on page 165. DBCS strings cannot be written to ODBC tables.

Note: If you have an existing ODBC/JDBC database already defined, Manager Server automatically writes the data to database tables with the latest format. If you don’t have an existing ODBC/JDBC database already defined, you must define a new ODBC/JDBC database. For complete data record format information, see the appendix titled “Data Record Formats.”

Setting up ODBC/JDBC data storage

If you want to store data in an already defined database:

1. On the Data page of the Manager Server Settings notebook, check Write Data to Database.



2. (ODBC database only) Check Use ODBC and enter the data source name in the Data Source Name field.

Note: The data source name (DSN) is a name used to identify the database. It is not the database filename. For Manager Server to connect to the database, the data source name specified in the Manager Server Settings notebook must be identical to the data source name specified when the database is defined. The DSN is case-sensitive. See “Storing Data” on page 165.

3. (JDBC database only) Specify the JDBC driver in the Driver Name field and enter the database name in the Database Connection field.

4. If needed, specify the login name and password for the database.When you save your settings and exit the Manager Server Settings notebook, database settings are saved whether or not a connection to the database is successful. If Manager Server cannot find the database or cannot insert data into the database, it logs an error message to the Manager Server console and to file msg.log, saves incoming data in a reserve file, and attempts to find the database and insert the data every 5 minutes.

Setting up flat log file data storage

If you want to use Manager Server log files in third-party report products, make sure that Write Data to Flat Files is checked and that you have chosen a flat file format (either default locale encoding or UTF-8 encoding). UTF-8 encoding is useful if the Manager Server receives data from Manager Clients and other Manager Servers in disparate locales, with disparate character encoding formats. Otherwise, the default locale encoding is recommended. Some reporting tools cannot read UTF-8 encoded data.

Log file records encoded in UTF-8 format are enclosed within XML tags <EBA> </EBA>. As an example of using the UTF-8 option, data from a Japanese Solaris (EUC_JP) hosted Manager Server can be copied to Windows (S_JIS) for processing.

Note: Before selecting the UTF-8 option, ensure that any programs or reporting tools you intend to use are capable of reading UTF-8 encoded data.


Purging data files



If you want your data files to be purged automatically:

1. Check Purge Data.

2. Select one of the two options.� Select Purge at startup to delete, at each startup, data records older than

the specified number of days.

� Select Purge daily to delete, at midnight Greenwich Mean Time (GMT) each day, data records older than the specified number of days.

Use these settings to limit the size of the log files and the database.

TCP/IP pageUse the TCP/IP page to configure:

� sending data to other Manager Servers (mirroring data) and sending profiles to Manager Clients

� receiving data from Manager Clients and from other Manager Servers

If file transfer or email alone is the transmission method specified on the General page, the options on the TCP/IP page are grayed out and cannot be set.

Note: If Manager Server is installed on a system with more than one network interface, you may need to direct TCP/IP traffic through a specified network interface. See “Manager Server Initialization Parameters” on page 152.

The Send TCP/IP Settings section lists the current Manager Servers to which the Manager Server can transmit data.

Adding a server

To add a server to the list:

1. In the Server Name field, specify the IP address or name of the machine on which a Manager Server is installed.

2. In the Server Port Number field, specify the port number configured as the Data Receive Port Number in the Manager Server Settings notebook of the Server whose name you specified. The default number is 8192.

3. (Optional) To test the connection, click Ping.



Manager Server attempts to contact the Server you specified, and displays a message indicating whether the connection was successful.

4. Click Add. The port number and name of the server appear on the Server List.

Changing the order of servers

To set the order of servers in the list:

1. Click a listed server to select it.

2. Use the Up and Down buttons to position the server in the desired order.

Port numbers

The Receive TCP/IP Settings section specifies port numbers for:

� receiving data from Manager Clients and other Manager Servers. The Data Receive Port Number corresponds to the Send Data Port Number set for the Manager Clients.

� sending queries and updates to Manager Clients. The Request Data Port Number corresponds to the Accept Request Port Number set for the Manager Clients.

Both of these port numbers must also be specified in the settings of Manager Clients that communicate with the Manager Server.

Note: Separate connections, with separate port numbers, are required for sending and receiving data. Thus, firewall configurations require two separate rules: one for sending data and one for receiving data.

Number of Concurrent Clients

This setting controls the maximum number of clients (Manager Clients and other Manager Servers) permitted to send data simultaneously to this Manager Server, and thus prevents the Manager Server from being overrun by data.

A client that is ready to send data to a Manager Server first requests a live connection from the Manager Server. The Manager Server then verifies that a new connection will not exceed the maximum number of concurrent connections permitted. If the new connection does not exceed the limit, the Manager Server allows the client to complete the connection and send the data. Then, the Manager Server disconnects the client. When the maximum



number of concurrent clients are connected, the Manager Server rejects additional connection requests, and schedules the requests for a later time. The delay period depends on the current volume of connection requests.

Email pageUse the Email page to configure email transmission of data to and from the Manager Server. If file transfer or TCP/IP alone is the transmission method specified on the General page, the options on the Email page are grayed out and cannot be set. Even if Manager Clients are configured to send data by email, the Manager Server cannot pick up that mail from the mail server unless configured here to do so.

Tip: Some email servers are configured to filter out unwanted messages. If you are using email transmission of data, make sure that the email server will accept data transmissions from Manager Servers and Clients. For more tips and information on email transmission, see “Email Transmission” on page 156.

Send Mail Settings

In the Send Mail Settings section, specify the settings for sending data to other Manager Servers and profiles to Manager Clients. Type the mail server address, SMTP mail port number, and email account name for sending messages.

1. In the Manager Server Hostname field, if you type a specific host name, you are restricted to using only that particular server to retrieve email messages. Some email messages may not be received if the host names do not match. The host name you use should be the one returned when the command hostname is typed at the UNIX shell or DOS command prompt at the receiving host.

Note: In the Manager Server Hostname field, if you specify the wildcard character * rather than the name of a specific server, then any server can receive the email.

If you want a particular server to accept all mail messages, check the Accept All Mail box at the bottom of the page. The server retrieving the mail will not verify to see if the host name specified matches its own. It will read all messages in the mailbox.

2. In the Mail From field, specify an authorized user ID for your email system. Use a format that conforms to your system’s conventions; for example,



mary_brown

The default value is ART.

3. (Optional) Set a number of retry attempts and a timeout for each attempt. If the email transmission fails after the timeouts and retries have been exhausted, a message to that effect appears on the Manager Server console.

4. (Optional) In the Mail Message Size field, you can specify the maximum number of records for each email message. This option helps prevent truncation of email and loss of data by the email server. For example, if you set the message size at 50 records, and 100 records are to be sent, then the data will be sent in two email messages: one containing 50 records, and the other containing the remaining 50 records. You need to determine the average size of a message and the most efficient message size for transmission. Keep in mind that the more a message is broken down, the greater the transmission overhead.

5. (Optional) Check Scramble Data if you want the data to be encoded before transmission.

Receive Mail Settings

In the Receive Mail Settings section, specify the settings for receiving email from Manager Clients and from other Manager Servers.

1. Enter the mail server address, POP3 mail port number, email account name, and password for receiving messages.

2. If you want Manager Server to check for email at startup, check the Check Mail at Startup box at the bottom of the page. You can also specify, in minutes, how often you want Manager Server to check for email. Tip: Once you have set up Manager Server to receive email, you can check for mail at any time by clicking the Check Mail button. If the Check Mail button is crossed out, you need to set up email in the Manager Server Settings notebook.

3. If you want a particular server to accept all mail messages, check the Accept All Mail box at the bottom of the page. The server retrieving the mail will not verify that the host name specified matches its own. It will read all messages in the mailbox.



File Transfer pageIf Mirror Data to Additional Server is checked on the General page and file transfer is selected as the transmission method, use this page to request that data files be either sent directly to another Manager Server or dropped into a local directory. The File Transfer page provides two more ways to mirror data (in addition to TCP/IP and email).

On this page, you can

� set up the File Transfer Protocol (FTP) method to send data files to a remote Manager Server

� choose to drop files into a particular local directory

� specify where you want data files placed when they are received from Manager Clients or from other Manager Servers

File transfer compresses data before mirroring and generally achieves a compression ratio of around 90%. This method dramatically reduces the file transfer time between servers. We recommend this method for bulk data transfer between servers.

Note: Separate connections, with separate port numbers, are required for sending and receiving data. Thus, firewall configurations require two separate rules: one for sending data and one for receiving data.

File Transfer Settings

In the File Transfer Settings section, select either FTP or Drop File.

FTP

If you selected FTP, enter the following information:

1. In the Remote Server Name field, specify the hostname of the remote Manager Server to which you want to transmit data files.

2. In the User Name field, enter the name required to log onto the remote Manager Server.

3. Type the password associated with the User Name.

4. (Optional) Specify an account name in the Account field.

5. Specify the directory path to the remote Manager Server that will receive the data files.



Tip: Create a directory specifically for Web Response Monitor data files. All files residing in this directory are deleted as new files are dropped in.

6. In the Local Server Unique Identifier field, type the unique identifier of the transmitting Manager Server. You can enter up to five characters in this field.

7. Check the Send Encoded File box if you want the data file to be encoded before transmission.

Drop File

If you selected Drop File, enter this information:

1. In the Directory field, specify the path to the directory within your enterprise (that is, inside your firewall) where you want files dropped when Manager Server sends them.

Note: Create a directory specifically for Web Response Monitor data files. All files residing in this directory are deleted as new files are dropped in.

2. In the Local Server Unique Identifier field, type the unique identifier of the transmitting Manager Server. You can enter up to 5 characters in this field.

3. Check Send Encoded File if you want the data file to be encoded before being dropped.

Receive File Settings

If Receive Data by File Transfer is selected as the transmission method in the Receive Settings section of the General page, you can elect to drop into a specific directory the data files received from Manager Clients or from other Manager Servers.

1. In the Receiving Directory field, specify the directory path to the receiving Manager Server.

2. Specify the File Checking Interval in minutes. For example, if you enter 20, Manager Server will check every 20 minutes to see whether a file has been dropped into the specified directory.

3. Check Check for Received File at Startup if you want Manager Server to verify at startup whether or not a file has been dropped. If this box is not checked, Manager Server waits for the specified file checking interval before checking for the first time.Tip: If Receive Data by File Transfer is the transmission method selected in the Receive Settings section of the General page and the directory path to the



receiving Manager Server is specified on the File Transfer page, you can click the Receive Data button at any time to see whether a data file has been dropped into a local directory.

Confirmation pageUse the Confirmation page to determine which user operations require a confirmation dialog box before execution. When you have finished, click OK to save your settings and to close the settings notebook.

Manager Server Initialization Parameters



Properties fileYou can modify some features of Manager Server by creating a properties file that sets the value of initialization parameters. The properties file must be named keg.properties and must be located in the Manager Server working directory (usually <Candle_Home>\mgmt\manager\server on Windows, where <Candle_Home> is the Web Response Monitor home directory). The initialization parameters are loaded during Manager Server startup, so your changes will take effect the next time Manager Server is started.

Creating the properties fileTo specify Manager Server initialization parameters:

1. Use a text editor (for example, Notepad on Windows) to create a plain text file named keg.properties.

2. Enter the parameters you need (see Initialization parameters below).

3. Save file keg.properties to the Manager Server working directory.

Initialization parametersYou can specify these parameters in file keg.properties.

Data log directory

keg.logpath=<pathname>

Specifies the pathname where Manager Server log files are deposited. This parameter is useful if you want to log data on a separate drive from the programs, or on a network-mounted file system. Separating the logs from the programs can improve performance by reducing contention for system files (such as the system page file).

The pathname you specify can be either a full pathname or a pathname relative to the Manager Server working directory. The default is ./log

Local host address for multihome systems



keg.localaddr=<local address>

Specifies the local host address to use in multihome systems (those with more than one network interface). By default, all TCP sockets are bound to the primary network interface. In some installations (for example, systems running in a DMZ environment outside the company firewall), you might want to use another, publicly accessible network interface for Manager Server TCP/IP connections.

The local host address you specify can be either the IP address or the hostname of the preferred interface for Manager Server. All TCP/IP socket connections created by the Manager Server are then bound to the specified local address.

The keg.localaddr parameter applies to:

� TCP/IP connections between Manager Server and Manager Clients� TCP/IP connections with mirrored Manager Servers� connections with SMTP and POP3 email servers� FTP connections

Examplekeg.localaddr=10.20.30.40

Setting up Manager Clients from Manager Server


Setting up Manager Clients from Manager Server

Why set up Manager Clients from Manager Server?Both Manager Server and Manager Client provide a Manager Client Settings notebook, where you can specify how and when Manager Client will transmit data to Manager Server. From Manager Server, you can set up any or all of the Manager Clients configured to communicate with the Manager Server, and you can send updates for Manager Client settings (also called profiles).

There are several advantages to setting up the Manager Clients from Manager Server, rather than setting up each Manager Client from its own settings notebook.

� You maintain central control of Manager Client settings.

� You can configure many Manager Clients from one machine.

� You can easily provide different settings for different Manager Clients.

� You can set up uniform alert (exception) filters for all Manager Clients.

How to set up Manager Clients from Manager ServerFor instructions, see“Configuring Manager Clients from Manager Server” on page 122.


Exception Data

Exception Data

Manager Client exceptionsOn the Exception and Average page of the Manager Client Settings notebook, you can set up data filters that trap exceptions (alerts). You can also set an interval for checking the data for exceptions. For instructions on setting up Manager Client filters, see “Exception and Average page” on page 127.

How exception data are handledWhen a Manager Client finds an exception in the workstation’s response time data, it immediately sends an exception record to the Manager Server. When Manager Server receives an exception record, it stores it either in an *.alr flat file or a database table, or in both locations.

The exception also triggers an alert on the Candle Management Workstation or CandleNet Portal workstation if:

� your site has purchased a Candle Command Center or CandleNet Portal with an OMEGAMON Monitoring Agent (OMA) or OMEGAMON XE that accepts and reports on Web Response Monitor data.

� Enable Candle Command Center OMA is checked on the General page of the Manager Server Settings notebook, and a valid OMA Port Number is provided. See “Manager Server Settings Notebook” on page 141.

If the OMA or OMEGAMON XE is connected to the Manager Server, Manager Server passes the exception record to the OMA or OMEGAMON XE for display on the Candle Management Workstation or CandleNet Portal workstation.

Email Transmission


Email Transmission

Configuring email transmissionBoth the Manager Client Settings notebook and the Manager Server Settings notebook provide configuration options for transmitting response time data by email. For email data transmission to succeed, Manager Client and Manager Server must both be running, and valid email settings must be provided in both settings notebooks.

Server hostname specificationIn the Manager Server field of the Email page of the Manager Client settings notebook and in the Manager Server Hostname field of the Email page of the Manager Server settings notebook, if you specify the wildcard character * rather than the name of a specific server, then any server can receive the email.

If you type a specific hostname, you are restricted to using that particular server to retrieve email messages. Some email messages may not be received if the hostnames do not match. The hostname you use should be the one returned when the command hostname is typed at the UNIX shell or DOS command prompt at the receiving host.

If you want a particular server to accept all mail messages, check the Accept All Mail box at the bottom of the page. The server retrieving the mail will not verify that the hostname specified matches its own. It will read all messages in the mailbox.

Hard-coded email settingsEmail transmission settings provided by Web Response Monitor include:

� timeout for email server logon and logoff: 4 minutes

� timeout for reading email: 1 minute

� message clearing: every 20 messages

Message clearing prevents rereading of email after an interruption (for example, a network failure or timeout) during a long-running email pickup.


Email Transmission

Mail checkingA mail checking frequency is set on the Email page of the Manager Server Settings notebook. In addition, you can check for email at any time by clicking the Receive Data button on the Manager Server console. To prevent duplication of message transmission, Web Response Monitor ignores a new mail-checking request if one is already active.

Handling of bad recordsManager Server skips bad records in an email message but continues to read the rest of the message. Bad records are deleted when the message containing the records is deleted.

Email server filtersSome email servers are configured to filter out unwanted messages. Make sure that the email server will accept data transmissions from Manager Client, rather than filtering them out as unwanted mail.

Buffer traceManager Server provides a buffer trace facility to help you solve problems with receiving email. This facility generates a large amount of data but is extremely helpful for diagnosing problems.

To turn on the buffer trace from the Manager Server console, select Tools > Debug > Extended Messages.

Updating Manager Clients from Manager Server



Changing Manager Client settings or operating modesFrom Manager Server, you can send Manager Clients a new settings profile or temporarily change their operating mode, a special setting that determines their authority and access.

Operating modesEach Manager Client's mode determines how it runs.

Table 7. Manager Client Operating Modes

Admin mode The full Manager Client user interface is provided, including console, settings, and other controls.

Debug mode The Manager Client logs extended status messages, including date and time, to file msg.log.

Debug mode cannot be set during product installation; it can be set only by the methods described in the sections that follow. Switching from the mode set at installation to Debug mode turns on extended messages but does not change the other features established in the installed mode. For example, if Manager Client was installed in Admin mode and then switched to Debug mode, the full user interface continues to be provided, with all settings and controls.

Silent (hidden) mode

No Manager Client user interface is provided and the user at the workstation has no indication that Manager Client is running. On UNIX, this is the default mode.

Normal mode The Manager Client user interface displays console messages but does not include controls and settings.

Batch mode Manager Client sends data on startup and then shuts down.

Note: This option is not available from the Update Clients dialog. See “Sending Data to Manager Server” on page 133 for details.



(Windows only) Changing the operating mode of a Manager ClientThe operating mode of each Manager Client is specified at installation time. It can be changed temporarily by:

� using the Update Clients dialog from Manager Server

� modifying the startup option in the command that starts the Manager Client

These methods change the operating mode of Manager Client for the duration of the session only. The next time Manager Client starts, it uses the operating mode specified during installation. The only way to change a Manager Client’s operating mode permanently is to reinstall the workstation components.

(UNIX only) Changing the operating mode of a Manager ClientThe default operating mode for the Manager Client on UNIX is -silent. Web Response Monitor provides a command called sm3ctl for starting Manager Client along with the other components. You can control Manager Client independently by issuing these commands from the <Candle_Home> directory.

./sm3ctl start client -admin

starts Manager Client in Admin mode. This method changes the operating mode of Manager Client for the duration of the session only. The next time Manager Client starts, it uses the -silent operating mode.

You can turn on extended messages debugging for Manager Client in either -silent mode or in -admin mode.

./sm3ctl start client - silent -debug

starts the Manager Client in -silent mode with Debug> Extended Messages enabled.

./sm3ctl start client - admin -debug

starts the Manager Client in -admin mode with Debug> Extended Messages enabled.

Silent mode

When the Manager Client is running in Silent mode under UNIX:



� You can use the UNIX ps command to see whether the Manager Client is running (process name jre).

� The msg.log file is updated continually and is the only source of information about the health of the Manager Client.

� The Manager Client shows up on the Manager Server’s client list with -silent mode status. The Manager Server cannot change the Manager Client’s operating mode, but can send other requests from the Update Clients page. See “Updating Manager Clients from Manager Server” on page 160.

Shutting down Manager Client in Silent mode

To shut down a Manager Client when it is running in Silent mode, use one of these methods:

� From the Manager Server console:

A. Select Tools > Update Clients.B. Select the Manager Client you want to shut down.C. Select Clients > Change Mode, then click OK on the dialog box that

appears.D. Select Stop Client, then click OK.

� From the Telnet session, issue a UNIX kill command.

Updating Manager Clients from Manager ServerTo send new Manager Client configuration settings or temporarily change a Manager Client’s operating mode:

1. While Manager Server is running, select Tools > Update Clients. The Update Clients page shows a list of clients connected to the Manager Server. For each Manager Client, the following information is shown:

� hostname� IP address

Tip: If the Manager Client is running on the same machine as the Manager Server (localhost), the value 127.0.0.1 appears as the IP address.

� port number� current status (On-line or --)



� build level� Send status (Yes or No, to indicate whether Manager Server has been set

to send a new profile to the Manager Client)� operation mode

2. Select the Manager Clients you want to update. Tip: If the list is long and you know the name of a Manager Client you want to update, select Select > Find. To select all Manger Clients on the list, select Select > Select All.

3. If you have not yet specified new settings for those Clients, select Profiles > Setup, then use the Manager Client Settings notebook to specify the desired configuration profile.

4. (Windows only) If you want to change the clients' operating mode for the duration of the session, select Clients > Change Mode, then select the desired mode from the dialog box that appears. (For definitions of the operating modes, see “Operating modes” on page 158.)Manager Server immediately sends the new operating mode to the selected Manager Clients. The Manager Server and Manager Client console windows display messages indicating that the Clients' mode has been set. The Manager Server console window also shows the maximum number of clients supported.

Tip: The next time the Manager Client starts, it will use the operating mode specified during installation, not the mode specified from the Manager Server.

5. To send a new profile to the selected Manager Clients, select:� Profiles > Send Now to send the settings immediately.

Each selected Manager Client receives and immediately activates the new settings.

� Profiles > Set Send to send the settings the next time the Manager Client connects to the Manager Server.

Tip: If you change your mind and do not want the settings sent, select Profiles > Reset Send.

6. Click OK to close the Update Clients dialog.



Adding Manager Clients to the listTo add a Manager Client to the list of clients connected to the Manager Server:

1. While Manager Server is running, select Tools > Update Clients.

2. Select Clients > Add.

3. Type the Manager Client's hostname and port number in the Add Client dialog box.

4. Click OK to save the list.

Deleting Manager Clients from the listTo delete a Manager Client from the list of Clients connected to the Manager Server:


2. Select the Manager Client you want to delete.

3. Select Select > Delete, then click OK.

Requesting data from Manager ClientsEach Manager Client automatically sends data to Manager Server on the schedule you set in the Manager Client Settings notebook. In addition, you can use the Update Clients dialog to request immediate data transmission at any time.

To request data:


2. Select the Manager Clients whose data you want to request.Tip: If you want to request data from all Manager Clients on the list, select Select > Select All.

3. Select Clients > Request Data.The selected Manager Clients immediately send data to the Manager Server.

Shutting down Manager ClientsTo shut down a Manager Client connected to the Manager Server:




2. Select the Manager Client you want to shut down.

3. Select Clients > Change Mode, then select Stop Client.

Client statusWhen the Update Clients dialog is invoked, Manager Server checks to see when the last transmission from each Manager Client occurred. If the most recent transmission occurred more than 15 minutes earlier, Manager Server puts a dash (--) in the Status column of the client list. Potential causes include:

� The Manager Client is transmitting data by email but has not done so in the past 15 minutes.

� The Manager Client is no longer active.

� The Manager Client is now configured to communicate with a different Manager Server.

� The heartbeat has been suppressed or the heartbeat interval is longer than 15 minutes.

Changing the heartbeat settingTo change the hearbeat setting for a Manager Client:

1. Select Tools > Update Clients.

2. Select the Manager Client.

3. Select Profiles > Setup.

4. On the General Page of the Client Settings notebook, specify the desired heartbeat interval.

Sending Data to Other Manager Servers


Sending Data to Other Manager Servers

Mirroring dataIf data mirroring is set up in the Manager Server Settings notebook, Manager Server automatically sends data to another Manager Server at the specified interval. You can also send data at any time by clicking the Mirror Data button.

Tip: If the Mirror Data button is crossed out, you need to set up data mirroring on the General page of the Manager Server Settings notebook.

Where Manager Server sends dataManager Server uses these methods to determine where to send the data:

� If TCP/IP alone was specified as the Send Data Method on the General page, the Manager Server attempts to send data to the first server listed on the TCP/IP page. Upon failure, it tries each successive server in the list.

� If TCP/IP then email was specified as the Send Data Method on the General page, the Manager Server attempts to send data by the TCP/IP method. Upon failure, it sends the data to the server specified on the Email page.

� If Email was specified as the Send Data Method on the General page, Manager Server sends the data to the server specified on the Email page.

� If File Transfer was specified as the Send Data Method on the General page, Manager Server sends the data to the server specified on the File Transfer page.

Tip: The file transfer method of sending data compresses data before mirroring and generally achieves a compression ratio of around 90%. This method dramatically reduces the file transfer time between servers and is therefore advantageous for bulk data transfer.


Storing Data

Storing Data

Methods of storing response time dataManager Server can store response time data in these formats:

� flat log files, written either in the default locale encoding or in Unicode Transformation Format, 8-bit form (UTF-8 encoding)

� Open DataBase Connectivity (ODBC) or Java DataBase Connectivity (JDBC) /JDBC database tables


For information on data record formats for both flat files and database tables, see the appendix titled “Data Record Formats.”

Flat files

UTF-8 encoding is useful if the Manager Server receives data from Manager Clients and other Manager Servers in disparate locales, with disparate character encoding formats. Otherwise, the default locale encoding is recommended. Some reporting tools can read data written in the default locale encoding, but not in UTF-8 encoding.

Database tables

Manager Server data can be written to tables for any database vendor that supports Open DataBase Connectivity (ODBC) or Java DataBase Connectivity (JDBC) drivers.

Note: If data from an earlier version of PathWAI Web Response Monitor are stored in a JDBC/ODBC database, you must either delete your existing database tables or move them to a different location before starting Manager Server for the first time. Otherwise, ODBC logging is turned off until the earlier tables are deleted or moved. When the earlier tables are deleted or moved, Manager Server automatically creates new tables with the latest format.

ODBC/JDBC database tables are not required for sending alerts to a Candle monitoring agent (an OMA or OMEGAMON XE). They are required for creating OMA reports or OMEGAMON XE views.

Storing Data


If your data include double byte character strings (DBCS), you must set up Manager Server to write data to flat log files only. DBCS strings cannot be written to ODBC tables.

Storing data in flat log filesIf you want to use Manager Server log files in third-party report products, make sure that Write Data to Flat Files is checked and that you have chosen a flat file format (either default locale encoding or UTF-8 encoding). UTF-8 encoding is useful if the Manager Server receives data from Manager Clients and other Manager Servers in disparate locales, with disparate character encoding formats. Otherwise, the default locale encoding is recommended. Some reporting tools cannot read UTF-8 encoded data.

Log file records encoded in UTF-8 format are enclosed within XML tags <EBA> </EBA>. As an example of using the UTF-8 option, data from a Japanese Solaris (EUC_JP) hosted Manager Server may be copied to Windows (S_JIS) for processing.

Note: Before selecting the UTF-8 option, ensure that any programs or reporting tools you intend to use are capable of reading UTF-8 encoded data.

Tip: Each log file written by Manager Server represents the date of the GMT time of data collection. For example, if Manager Server receives the data at 8 a.m. on June 2 (local time), but the GMT time of data collection was 11 p.m. on June 1, then the data from that transaction go into a server log file named yyyy0601.xxx.


Storing Data

Storing data in an ODBC/JDBC databaseIf you want to store response time data in database tables, you need to:

1. have an ODBC/JDBC database driver installed2. set up an ODBC/JDBC database driver under Windows or a JDBC

database driver under UNIX3. provide settings on the Data page of the Manager Server Settings

notebookTip: If data from an earlier version of Web Response Monitor are stored in a JDBC/ODBC database, and you have deleted or moved the existing database tables, Manager Server automatically writes data to the database in the latest format.

(Windows) Setting up an ODBC database driverTo define an ODBC database and configure its driver under Windows:

1. Select:� (Windows NT) Start > Settings > Control Panel > ODBC

� (Windows 2000, XP, or 2003) Start > Settings > Control Panel > Administrative Tools > Data Sources (ODBC)

The ODBC Data Source Administrator settings notebook appears.

2. Select the System DSN tab.

Note: Be sure to select the System DSN tab and not the User DSN tab. If there is no System DSN tab, your ODBC driver needs to be updated.

3. On the System DSN page, click Add to add a new data source.

4. Select an ODBC driver (which must already be installed), and click Finish.The setup dialog for the selected driver appears.

5. Enter a Data Source Name (for example, ResponseTime_DB).

Note: The data source name (DSN) is a name used to identify the database. It is not the database filename. For Manager Server to connect to the database, the data source name specified here must be identical to the data source name specified on the Data page of the Manager Server Settings notebook. The DSN is case-sensitive. See “Providing database settings in Manager Server” on page 171.

Storing Data


6. Enter a Description (for example, ResponseTime ODBC Database).

7. Complete the rest of the dialog for the selected driver.The configuration options vary by driver. For instructions, click Help in the dialog box, or see the documentation that accompanies your database driver.

8. Click OK or Create.

9. Select the drive, directory, and file name to contain the database, and click OK to create the database.The database is created and ready for use by Manager Server.

10. Go on to “Providing database settings in Manager Server” on page 171.

(Windows) Setting up an Oracle JDBC database driverTo set up an Oracle JDBC database driver under Windows:

1. If you have not already done so, download and install an Oracle JDBC driver for Java 1.2x for your level of Oracle database from



2. Copy classes12.zip to your Manager Server directory <Candle_Home>\mgmt\manager\server, where <Candle_Home> is the Web Response Monitor home directory.

3. Add the JDBC driver to the Manager Server CLASSPATH, as follows.A. Use a text editor (such as Notepad) to edit file kegs_server.control,

found in <Candle_Home>\mgmt\manager\serverB. Modify the line

ClassPath Suffix=..\..\..\jaxp\jaxp-api.jar;..\..\..\jaxp\sax.jar;..\..\..\jaxp\dom.jar;..\..\..\jaxp\xercesImpl.jar

to read ClassPath Suffix=..\..\..\jaxp\jaxp-api.jar;..\..\..\jaxp\sax.jar;..\..\..\jaxp\dom.jar;..\..\..\jaxp\xercesImpl.jar;classes12.zip

C. Save the file.

The Oracle JDBC driver classes are added to the CLASSPATH for Manager Server.


Storing Data


(Linux) Setting up an Oracle JDBC database driverTo set up an Oracle JDBC database driver under Linux:

1. If you have not already installed an Oracle JDBC driver, download and install an Oracle JDBC driver for Java 1.2x for your level of Oracle database from



Note: The Oracle JDBC driver for Java 1.2x also supports Java 1.3.1, the level of Java used by Manager Server on Linux machines.

2. Copy classes12.zip to your Manager Server directory <Candle_Home>/mgmt/manager/server, where <Candle_Home> is the Web Response Monitor home directory.

3. Add the JDBC driver to the Manager Server CLASSPATH as follows.A. Edit file server.sh found in directory

<Candle_Home>/mgmt/manager/serverB. Modify the line

CLASSPATH=.:Server.jar:$JAXHOME/jaxp-api.jar:$JAXHOME/sax.jar:$JAXHOME/xercesImpl.jar::$JAXHOME/dom.jar

to read

CLASSPATH=.:Server.jar:$JAXHOME/jaxp-api.jar:$JAXHOME/sax.jar:$JAXHOME/xercesImpl.jar::$JAXHOME/dom.jar:classes12.zip

C. Save the modified script.The Oracle JDBC driver classes are added to the CLASSPATH for Manager Server.


Storing Data


(Other UNIX platforms) Setting up an Oracle JDBC database driverTo set up an Oracle JDBC database driver on non-Linux UNIX machines:

1. If you have not already installed an Oracle JDBC driver, download and install an Oracle JDBC driver for Java 1.1x for your level of Oracle database from



2. Copy classes111.zip to your Manager Server directory <Candle_Home>/mgmt/manager/server, where <Candle_Home> is the Web Response Monitor home directory.

3. Add the JDBC driver to the Manager Server CLASSPATH as follows.A. Edit file server.sh found in directory

<Candle_Home>/mgmt/manager/serverB. Modify the line

CLASSPATH=.:Server.jar:$JAXHOME/jaxp-api.jar:$JAXHOME/sax.jar:$JAXHOME/xercesImpl.jar::$JAXHOME/dom.jar

to readCLASSPATH=.:Server.jar:$JAXHOME/jaxp-api.jar:$JAXHOME/sax.jar:$JAXHOME/xercesImpl.jar::$JAXHOME/dom.jar:classes111.zip

C. Save the modified script.The Oracle JDBC driver classes are added to the CLASSPATH for Manager Server.



Storing Data

Providing database settings in Manager ServerIf you want to store data in a database and if the database driver is already configured:

1. On the Data page of the Manager Server Settings notebook, check Write Data to Database.

2. (ODBC database only) Check Use ODBC and enter the data source name in the Data Source Name field.

Note: The data source name (DSN) is a name used to identify the database. It is not the database filename. For Manager Server to connect to the database, the data source name specified in the Manager Server Settings notebook must be identical to the data source name specified when the database is defined. The DSN is case-sensitive.

3. (JDBC database only) Specify the JDBC driver in the Driver Name field and enter the database name in the Database Connection field. Do not check Use ODBC.Tip: For Oracle JDBC drivers, oracle.jdbc.driver.OracleDriver is the Driver Name. Here are two examples of database connection (data source) names:

jdbc:oracle:thin:@hermes:1521:OS25

where hermes is the hostname, 1521 is the port number that connects to the Oracle database, and OS25 is the Oracle database instance

jdbc:oracle:thin:@hermes:1521:OHE3

where hermes is the hostname, 1521 is the port number that connects to the Oracle database, and OHE3 is the Oracle database instance

4. If needed, specify the login name and password for the database.When you save your settings and exit the Manager Server Settings notebook, database settings are saved whether or not a connection to the database is successful. If Manager Server cannot find the database or cannot insert data into the database, it

� logs an error message to the Manager Server console and to file msg.log� saves incoming data in a reserve file� attempts to find the database and insert the data every 5 minutes

Storing Data


If a database table experiences a failure conditionIf a database table experiences a failure condition, such as running out of space or being offline for maintenance, Web Response Monitor reserves the data in a backup auxiliary file until the database table can accept data again. Manager Server tries to insert records every 5 minutes. When it successfully opens the database table, the rest of the reserve records are written.

If a database cannot be accessedWhen Manager Server is running as a Windows service, it cannot connect to these two server databases:� Remote Microsoft Access server database

When Manager Server is running as a service, it runs under a system account and therefore cannot connect to a remote Microsoft Access server database. If you want to store data in this type of database, shut down Manager Server, then restart it from a DOS prompt.

� Microsoft SQL server databaseWhen Manager Server is running as a service, it cannot connect to a Microsoft SQL server database using domain name authentication. If you want to store data in this type of database, use a database account created in Microsoft SQL server.

If a database remains emptyIf you have defined an ODBC/JDBC database and provided database settings in the Manager Server, but the database remains empty even when you are running Web Response Monitor:

1. Make sure that the Web Response Monitor components and the monitored application are all running.

2. Make sure that you have deleted or moved to another directory the JDBC/ODBC tables created for an earlier version. ODBC/JDBC logging is turned off until the earlier tables are deleted.

3. Look at the Manager Client and Manager Server console messages. The messages should show evidence of successful communication and data transmission.

4. (Windows) Make sure that the ODBC database is defined on the System DSN tab and that there is no User DSN with the same name.


Storing Data

5. (Windows) Make sure that the data source name provided on the System DSN tab is identical to the data source name specified on the Data page of the Manager Server Settings notebook. The data source name is case-sensitive.

6. If the database is still empty, shut down and restart Manager Server.

7. If the database remains empty, reboot the computer(s) where the Manager Server and the ODBC database reside.

Problem with Microsoft Access and HotSpot JVMCertain versions of the Microsoft Access ODBC driver (for example, Version 4.00.4403.02 odbcjt32.dll) are incompatible with Hotspot Java Virtual Machine (JVM). The symptom is that Hotspot JVM crashes. If you encounter such a problem, you can take one of these actions:

� Install a different version of the Microsoft Access ODBC Driver (for example, Version 4.00.4202.00 odbcjt32.dll).

� Discontinue use of Hotspot JVM.

Customizing Database Tables



Customizing the list of tablesManager Server is installed with a default set of database schemas, representing the products it supports. If you do not want to create all the tables, or if you want to store only certain kinds of data, then you can modify the database properties file jdbc.properties in <Candle_Home>\mgmt\manager\server, where <Candle_Home> is the Web Response Monitor home directory.

By default, jdbc.properties contains the following entries:

alr=KEGS_JdbcAlrdtl=KEGS_JdbcDtlapp=KEGS_JdbcApptra=KEGS_JdbcTravob=KEGS_JdbcVobvdt=KEGS_JdbcVdtava=KEGS_JdbcAvasal=KEGS_JdbcSalsm3=KEGS_JdbcSm3m3a=KEGS_JdbcM3akfbalt=KEGS_JdbcProfilerkfbdtl=KEGS_JdbcProfilerkfbsum=KEGS_JdbcProfilerkfbtrn=KEGS_JdbcProfiler

Each entry represents a Candle product data type and its corresponding database class. This table lists the data types.

Table 8. Data Types in Database Tables

Data Type Product Table

alr ETEWatch alert data

dtl ETEWatch detail data

app ETEWatch application summary data

tra ETEWatch transaction summary data

vob eBA*ServiceMonitor Web object data

vdt eBA*ServiceMonitor Web page data



To prevent a particular product table from being created and populated, you can comment out the lines that represent that table in jdbc.properties. To comment out a line, add a pound sign (#) in the first column of the line.

For example, if you were only interested in Web Response Monitor detail data, your jdbc.properties files would look like this:

#alr=KEGS_JdbcAlr#dtl=KEGS_JdbcDtl#app=KEGS_JdbcApp#tra=KEGS_JdbcTra#vob=KEGS_JdbcVob#vdt=KEGS_JdbcVdt#ava=KEGS_JdbcAva#sal=KEGS_JdbcSalsm3=KEGS_JdbcSm3#m3a=KEGS_JdbcM3a#kfbalt=KEGS_JdbcProfiler#kfbdtl=KEGS_JdbcProfilert#kfbsum=KEGS_JdbcProfiler#kfbtrn=KEGS_JdbcProfiler

Customizing database column definitionsManager Server database support has been tested on several of today's most popular relational database management systems (RDBMS). The default column names, sizes, and data types are acceptable for most users. However,

ava Web Availability Monitor availability data

sal Web Availability Monitor alert data

sm3 Web Response Monitor detail data

m3a Web Response Monitor alert data

kfbalt Web Segment Analyzer alert data

kfbdtl Web Segment Analyzer detail data

kfbsum Web Segment Analyzer sumarized data

kfbtrn Web Segment Analyzer transaction data

Table 8. Data Types in Database Tables

Data Type Product Table



in certain situations you might want to change column definitions in one or more tables. For example, you might want to change the column names to national language names; or you might need to change the name of a column because your RDBMS does not allow particular names or names over a certain length; or you might want to collect response time data from different locales and then store the data in Unicode (if your RDBMS supports this option). In this last example, you could modify the appropriate schema file to use the variable length Unicode SQL data type for Oracle (NVARCHAR2) rather than the default variable length data type (VARCHAR).

The database tables schemas are provided in simple text files with the suffix .schema. The schema files are located in Manager Server directory <Candle_Home>\mgmt\manager\server (where <Candle_Home> is the Web Response Monitor home directory).The column names, sizes, and data types for each table can be modified to suit your needs. However, you must not change the order in which the columns are defined, nor may you add or remove columns. The schema files not only determine the column names, sizes, and types, but they also reflect the order of fields in their internal data format. Also, you cannot change the intrinsic data type (number, text, or time). This table lists the schema files.

Table 9. Schema Files and Data Types

Schema File Data Type

alert.schema ETEWatch and eBA*ServiceMonitor alert data

conscralert.schema Web Availability Monitor consensus alerts for scripts

conurlalert.schema Web Availability Monitor consensus alerts for URLs

detail.schema ETEWatch detail data

ebadetail.schema eBA*ServiceMonitor Web page data

ebaobject.schema eBA*ServiceMonitor Web object data

eteappavg.schema ETEWatch application summary data

etetransavg.schema ETEWatch transaction summary data

kfbalt.schema Web Segment Analyzer alert data

kfbdtl.schema Web Segment Analyzer detail data

kfbsum.schema Web Segment Analyzer summarized data

kfbtrn.schema Web Segment Analyzer transaction data



localert.schema Web Availability Monitor location alerts

scralert.schema Web Availability Monitor script alerts

scrsample.schema Web Availability Monitor script response time data

scrsummary.schema Web Availability Monitor script summary data

sm3audio.schema Web Response Monitor audio data

sm3http.schema Web Response Monitor Web page data

sm3obj.schema Web Response Monitor Web object data

sm3video.schema Web Response Monitor video data

urlalert.schema Web Availability Monitor URL alerts

urlsample.schema Web Availability Monitor URL response time data

urlsummary.schema Web Availability Monitor URL summary data

Table 9. Schema Files and Data Types

Schema File Data Type

About Maintenance Dialog


About Maintenance Dialog

The About Maintenance dialog is accessed from the Help pull-down menu in the Manager Server and the Manager Client. This dialog contains information about maintenance that has been applied to our modules since Version 2.0.0 of Manager Server and of Manager Client.

The dialog lists every module in the component and allows you to confirm whether a specific PTF (associated with a Service Request) is applied to a module. Customer service personnel can use this data when trying to determine the cause of a system problem.

Data Record Formats 179

Data Record Formats

IntroductionThis appendix describes the record formats PathWAI Web Response Monitor uses for logging:

� HTTP data (<hpage>)� HTTP object (<hobj>)� Audio data (<audio>)� Video data (<video>)It also describes the formats used in writing data to ODBC/JDBC database tables and the SQL statements that create the database tables for each type of data.

Appendix ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Log files and data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Database tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Web Page and Object Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Record format for HTTP Web page and HTTP object data. . . . . . . . . . . . . . 182SQL statement to create an HTTP page or HTTP object database table . . . . 187

Audio and Video Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Record format for audio and video data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189SQL statement to create an audio or video database table . . . . . . . . . . . . . . 192

A

Overview


Overview

Log files and data typesPathWAI Web Response Monitor generates log files that are named as follows:

yyyymmdd.sm3

The XML tags within the log files delineate the data types being logged. The Collector and the Manager Server write daily logs that use the same suffix (.sm3) and the same XML tags to differentiate data types; however, the Manager Server daily logs begin with the root tag <SM3>, which enables an XML processor to parse the log.

Log data

These are the 4 types of data you can see in the log files; each data type is delineated by an XML tag that identifies where the data starts and ends:� HTTP (<hpage> </hpage>)

This record represents the Web page, the URL of the HTTP transaction.

� HTTP object (<hobj> </hobj>)This record represents individual objects, such as .gif and .jpg files, contained in a Web page.

� Audio (<audio> </audio>)This record represents audio transmissions (Windows Media and Real.)

� Video (<video> </video>)This record represents video transmissions (Windows Media, Real, and QuickTime).

Database tablesThe data stored in ODBC/JDBC tables can be used for warehousing historical data and generating reports in third-party software. Manager Server automatically issues SQL statements to create the ODBC/JDBC tables. However, some data centers prevent automatic space allocation by CREATE TABLE statements. In that case, you may need to modify Candle’s CREATE TABLE statements to your space allocation specifications and submit them to your database.


Overview

After the format description for each type of data in the following sections, the accompanying CREATE TABLE statement is shown, with its default space allocation parameters.

Web Page and Object Data



Record format for HTTP Web page and HTTP object dataEach Web page can include HTTP objects. For example, a Web page named index.html might contain two image objects named candle.gif and server.gif. PathWAI Web Response Monitor stores the two kinds of data in one log file separated by XML tags to indicate the data types. Web page <hpage> and HTTP object <hobj> records have this format:

Product VersionÂpplication ID^Reserved 1^Collector ID^GUID^ Transaction Time UTC^Transaction Date^Transaction Time^GMT Offset^TimezoneÎP Source AddressÎP Source PortÎP Destination AddressÎP Destination Port^Total Response Time^ Request Packet Count^Request Ack Packet Count^Reply Packet Count^ Reply Ack Packet Count^Total Bytes^ Request Bytes^Reply BytesÛRL^Referrer URL^Browser Description^Server DescriptionÂpplication Protocol^Request Status^Server Time^Resolve Time^Load Time^Total Object Count^Total Object Size^Total Header Requests Count^Total Header Request Resolve Time^Network Time^Reserved 2^Reserved 3^Reserved 4ÛRL Host NameÛRL PathÛRL FileÛRL Query StringÛRL Anchor^Page Title^Method

Example of the Web page portion of the log file:

<hpage>v121^92^0^hermes_SM3^66810246950690hermes_SM3^ 1024695069^06/21/2002^14:31:09^-7^PST_Pacific_Saving_Time^ 10.21.2.128^1768^10.21.2.138^80^2781^12^4^12^0^7672^5312^2360^ http://hermes/^N/A^ Mozilla/4.0_(compatible;_MSIE_6.0;_Windows_NT_5.0;_Q312461)^ Microsoft-IIS/5.0^HTTP/1.1^200^391^2562^219^9^1415^8^0^219^2781^109^2672^hermes^/^N/A^N/A^N/A^Temple of Doom^1</hpage>

Example of the HTTP object portion of the log file.

<hobj>v121^92^0^hermes_SM3^66810246950741hermes_SM3^ 1024695069^06/21/2002^14:31:09^-7^PST_Pacific_Saving_Time^ 10.21.2.128^1768^10.21.2.138^80^78^1^0^1^0^603^422^181^ http://hermes/img/pat_orange.gif^http://hermes/^ Mozilla/4.0_(compatible;_MSIE_6.0;_Windows_NT_5.0;_Q312461)^ Microsoft-IIS/5.0^HTTP/1.1^304^78^0^0^0^141^1^78^78^78^0^0^ hermes^/img/pat_orange.gif^pat_orange.gif^N/A^N/A^Temple of Doom^1</hobj>



Log file records encoded in UTF-8 format are enclosed within the XML tags <EBA> </EBA>.

Since the field types are identical, the following table applies to both Web pages and HTTP objects.

Table 10. HTTP Page and HTTP Object Record Fields

Name of field Data type Description

Product Version Text10 bytes max.

Analyzer and Collector version

Application ID Text2 bytes max.

Application identifier

92 = PathWAI Web Response Monitor

Reserved 1 Text64 bytes max.

Reserved for a future release

Collector ID Text 31 bytes max.

Collector name

Transaction GUID (Globally Unique ID)

Text64 bytes max.

Identifier of the Web transaction

Transaction Time UTC (Universal Time Coordinated)

Number (seconds)

Time elapsed from 00:00:00.000 GMT January 1, 1970, to the GMT time when the transaction started

Transaction Date Text10 bytes max.

Date the transaction occurred, in U.S. format (mm/dd/yyyy)

Transaction Time Text8 bytes max.

Time the transaction started, in U.S. format (hh:mm:ss)

GMT Offset Number. Number of hours (positive or negative) to GMT from the time set on the Web server machine, including any adjustments for Daylight Savings Time

Time Zone Text32 bytes max.

Time zone set on the Web server machine

IP Source Address Text64 bytes max

Client (browser) IP address

IP Source Port Number Client (browser) port number



IP Destination Address

Text64 bytes max

Server IP address

IP Destination Port Number Server port number

Total Response Time

Number (milliseconds)

Time between the user’s request and the Web browser’s completion of the transaction


Request Packet Count

Number Number of packets in each request

Request Ack Packet Count

Number Number of acknowledgment packets in each request

Reply Packet Count Number Number of packets in each reply

Reply Ack Packet Count

Number Number of acknowledgment packets in each reply

Total Bytes Number Total number of bytes transferred

Request Bytes Number Total number of bytes in each request

Reply Bytes Number Total number of bytes in each reply

URL Text254 bytes max.

Web page URL, without parameter lists

Note: If you want URLs displayed in reports to include parameter lists, you can set Trim URL to No in your account profile, accessible from the browser interface.

Referrer URL Text254 bytes max.

� (HTTP pages) Name of the Web page (if served from the monitored Web server) from which the user navigated to the page downloaded in this transaction

� (HTTP objects) URL of the Web page that contains the object

Table 10. HTTP Page and HTTP Object Record Fields (continued)




Browser Description

Text254 bytes max.

Description of the browser being used

Server Description Text254 bytes max.

Description of the Web server

Application Protocol

Text32 bytes max.

Protocol and version number.

Example: HTTP/1.1

Request Status Number HTTP status of the request

Server Time Number (milliseconds)

Time the Web server took to process the transaction

Resolve Time Number (milliseconds)

Time elapsed between completion of the download and full rendering at the browser.

Load Time Number (milliseconds)

Time elapsed between the user’s request and completion of the download


Total Object Count Number � (HTTP pages) Number of objects embedded in the Web page

� (HTTP objects) 0

Total Object Size Number � (HTTP pages) Total size of all objects embedded in the Web page

� (HTTP objects) Size of the object

Total Header Requests Count

Number Number of header requests (requests that return 304 or no content)

Total Header Request Resolve Time


Time to resolve header requests

Network Time Number (milliseconds)

Time spent transmitting all required data through the network

Reserved2 Number Reserved for a future release







URL Host Name Text254 bytes max.

Host name portion of the URL

URL Path Text254 bytes max.

Path portion of the URL

URL File Text254 bytes max.

File name portion of the URL

URL Query String Text254 bytes max.

Query string of the URL

URL Anchor Text126 bytes max.

Page anchor of the URL

Page Title Text254 bytes max.

Title specified in the HTML code for the page.

Method Number HTTP method:

1 = GET2 = POST3 = HEAD4 = PUT5 = OPTIONS6 = DELETE7 = TRACE8 = CONNECT





SQL statement to create an HTTP page or HTTP object database tableThere are two field types: � VARCHAR(254)� INTEGER

If the VARCHAR(254) type is used and more than 254 characters are found, the character string is truncated before insertion into the table.

CREATE TABLE tablename ProductVersion VARCHAR(10),ApplicationID VARCHAR(2),reserved1 VARCHAR(64),CollectorID VARCHAR(31),TransGUID VARCHAR(64),TransUTC INTEGER,TransDate VARCHAR(10),TransTime VARCHAR(8) ,GMTOffset INTEGER,TimeZone VARCHAR(32),IPSrcAddr VARCHAR(64),IPSrcPort INTEGER,IPDstAddr VARCHAR(64),IPDstPort INTEGER,TotalRespTime INTEGER,ReqPacketCt INTEGER,ReqAckPacketCt INTEGER,ReplyPacketCt INTEGER,ReplyActPacketCt INTEGER,TotalBytes INTEGER,RequestBytes INTEGER,ReplyBytes INTEGER,URL VARCHAR(254),ReferURL VARCHAR(254),BrowserDesc VARCHAR(254),ServerDesc VARCHAR(254),AppProtocol VARCHAR(32),ReqStatus INTEGER,ServerTime INTEGER,ResolvedTime INTEGER,LoadTime INTEGER,TotalObjCt INTEGER,TotalObjSize INTEGER,TotalHdrReq INTEGER,TotalHdrResolve INTEGER,



NetworkTime INTEGER,reserved2 INTEGER,reserved3 INTEGER,reserved4 INTEGER,URLHost VARCHAR(254),URLPath VARCHAR(254),URLFile VARCHAR(254),URLQuery VARCHAR(254),URLAncho VARCHAR(126),PageTitle VARCHAR(254),Method INTEGER


Audio and Video Data


OverviewPathWAI Web Response Monitor collects audio and video stream data and stores them in one daily log file, along with the HTTP and HTTP object data. XML tags differentiate the data types from one another.

Record format for audio and video dataFor both audio and video data, each record has this format:

Product VersionÂpplication ID^Reserved 1^Collector ID^GUID^Transaction Time UTC^Transaction Date^Transaction Time^GMT Offset^TimezoneÎP Source AddressÎP Source PortÎP Destination AddressÎP Destination Port^Total Response Time^ Request Packet Count^Request Ack Packet Count^Reply Packet Count^ Reply Ack Packet Count^Total Bytes^Request Bytes^Reply Bytes^ Request Size^Reply Size^Type^Name^Referrer URL^Player Description^Server DescriptionÂpplication Protocol^Request Status^Play Time^ Network Time

Example of a video data record in a log file:

<video>v121^92^0^hermes_SM3^66810246953118hermes_SM3^1024695311^06/21/2002^14:35:11^-7^PST_Pacific_Saving_Time^10.21.2.128^1775^10.21.2.138^1755^156937^14^1490^2974^2^2946797^62648^2884149^5^mmst://hermes/harry_potter_tr_480.asf^N/A^wmplayer.exe^N/A^MMS^0^0^550</video>

Log file records encoded in UTF-8 format are enclosed within the XML tags <EBA> </EBA>.

Table 11. Audio/Video Data Record Fields


Product Version Text10 bytes max.

Analyzer and Collector version

Application ID Text2 bytes max.

Application identifier

92 = PathWAI Web Response Monitor

Reserved 1 Text64 bytes max.

Reserved for a future release



Collector ID Text 31 bytes max.

Collector name

Transaction GUID (Globally Unique ID)

Text64 bytes max.

Identifier of the Web transaction

Transaction Time UTC (Universal Time Coordinated)

Number (seconds)

Time elapsed from 00:00:00.000 GMT January 1, 1970, to the GMT time when the transaction started

Transaction Date Text10 bytes max.

Date the transaction occurred, in U.S. format (mm/dd/yyyy)

Transaction Time Text8 bytes max.

Time the transaction started, in U.S. format (hh:mm:ss)

GMT Offset Number Number of hours (positive or negative) to GMT from the time set on the Web server machine, including any adjustments for Daylight Savings Time

Time Zone Text32 bytes max.

Time zone set on the Web server machine

IP Source Address Text64 bytes max

The client (browser) IP address

IP Source Port Number The client (browser) port number

IP Destination Address

Text64 bytes max

Server IP address

IP Destination Port Number Server port number

Total Response Time


Time between the user’s request and the Web browser’s completion of the transaction

Request Packet Count

Number Number of packets in each request

Request Ack Packet Count

Number Number of acknowledgment packets in each request

Reply Packet Count Number Number of packets in each reply

Table 11. Audio/Video Data Record Fields (continued)




Reply Ack Packet Count

Number Number of acknowledgment packets in each reply

Total Bytes Number Total number of bytes transferred

Request Bytes Number Total number of bytes in each request

Reply Bytes Number Total number of bytes in each reply

Type Number 5 = Windows Media video6 = Real video7 = QuickTime video9 = Windows Media audio10 = Real audio

Name Text254 bytes max.

Name of the audio file

Referrer URL Text254 bytes max.

Name of the Web page (if served from the monitored Web server) from which the user navigated to the audio or video stream

Player Description Text254 bytes max.

Executable of the player. Example:

wmplayer.exe

Server Description Text254 bytes max.

Description of the server

Application Protocol

Text64 bytes max.

Protocol. Example:

MMS

Request Status Number Media protocol status

Play Time Number(milliseconds)

Length of play time

Network Time Number (milliseconds)

Time spent transmitting all required data through the network

Table 11. Audio/Video Data Record Fields (continued)




SQL statement to create an audio or video database tableThere are two field types: � VARCHAR(254)� INTEGER

If the VARCHAR(254) type is used and more than 254 characters are found, the character string is truncated before insertion into the table.

CREATE TABLE tablename ProductVersion VARCHAR(10),ApplicationID VARCHAR(2),reserved1 VARCHAR(64),CollectorID VARCHAR(31),TransGUID VARCHAR(64),TransUTC INTEGER,TransDate VARCHAR(10),TransTime VARCHAR(8) ,GMTOffset INTEGER,TimeZone VARCHAR(32),IPSrcAddr VARCHAR(64),IPSrcPort INTEGER,IPDstAddr VARCHAR(64),IPDstPort INTEGER,TotalRespTime INTEGER,ReqPacketCt INTEGER,ReqAckPacketCt INTEGER,ReplyPacketCt INTEGER,ReplyActPacketCt INTEGER,TotalBytes INTEGER,RequestBytes INTEGER,ReplyBytes INTEGER,Type INTEGER,URL VARCHAR(254),ReferURL VARCHAR(254),BrowserDesc VARCHAR(254),ServerDesc VARCHAR(254),AppProtocol VARCHAR(64),ReqStatus INTEGER,PlayTime INTEGER,NetworkTime INTEGER

Installing and Uninstalling the IIS Filters 193

Installing and Uninstallingthe IIS Filters

IntroductionThis appendix describes the Web Response Monitor IIS filters, and gives instructions for installing and uninstalling them in case the automatic setup fails.

Appendix ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Web Response Monitor IIS filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194In case of trouble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Installing the IIS Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Installing the IIS filter for HTTPS monitoring . . . . . . . . . . . . . . . . . . . . . . . . 195Installing the IIS filter for redirecting Presenter requests . . . . . . . . . . . . . . . . . 196

Uninstalling the IIS Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

B

Overview


Overview

Web Response Monitor IIS filtersWeb Response Monitor installation includes two options that, if selected, result in automatic installation of IIS filters.The two options are IIS Candle Filter and Tomcat with IIS. The Candle filter is a global IIS filter installed on the monitored Web server to enable HTTPS monitoring. Presenter, the component that includes the Jakarta Tomcat servlet server, can be but need not be installed on a Web server machine.

Candle filter for HTTPS transaction monitoring

Web Response Monitor can monitor HTTP transactions without any modification of the IIS configuration. However, if you also want to monitor HTTPS (secure HTTP) transactions, a global IIS filter must be installed on the Web server for that purpose. If you select Candle Filter, the Web Response Monitor setup program automatically installs the filter.

Tomcat with IIS

If you install Presenter on a machine where IIS Version 4.0 or higher is already installed, you can select Tomcat with IIS. That selection results in automatic installation of a global filter that will redirect from IIS to Tomcat any browser requests addressed to Presenter.

In case of troubleIn most cases, automatic installation of the Candle filters proceeds smoothly. If any errors occur, you will receive an error message, and you will need to install the filters yourself. Instructions are provided in the sections that follow.


Installing the IIS Filters


Installing the IIS filter for HTTPS monitoring

1. If you have not already installed the Candle filter on the Web server machine, do so now. See the instructions in the chapter “Installing PathWAI Web Response Monitor”.

2. Select (Windows NT) Start > Programs > Windows Option Pack/Microsoft Internet Information Server > Internet Service Manager

(Windows 2000, XP, or 2003) Start > Settings > Control Panel > Administrative Tools > Internet Services Manager

3. If necessary, double-click the Console Root folder to display the server folders in the left side of the window.

4. Open the Internet Information Server folder.

5. Right-click the computer’s hostname.

6. Click Properties on the pop-up menu.

7. In the Master Properties list, select WWW Service, and click Edit.The host’s Master Properties notebook appears.

8. Click the ISAPI Filters tab, and click Add.

9. Enter KFC Candle Filter in the Filter Name field of the Filter Properties window.

10. For the Executable name, browse to locate kfcCandleFilter.dll in <Candle_Home>\PathWAI\CandleFilter\. The Executable field must contain the entire path to kfcCandleFilter.dll.

11. Click OK to close the Filter Properties window.

12. Click Apply and OK to close the Master Properties notebook, then click OK to close the host’s Properties page.

13. Close the console. When prompted, click Yes to save the new settings.

14. Follow these steps to restart the Web server, enable the configuration changes, and activate PathWAI Web Response Monitor data collection.



Note: Using the Internet Service Manager console to stop and restart the Web server will not start the Candle filter.

A. Select:(Windows NT) Start > Settings > Control Panel > Services



15. From the Internet Service Manager console, go back to the ISAPI Filters tab.

16. Move kfcCandleFilter.dll to the top of the list of low-priority filters.Tip: A green Up arrow to the left of the filter indicates that it has started.


Installing the IIS filter for redirecting Presenter requests

1. If you have not already installed Web Response Monitor - Presentation with the option Tomcat with IIS, do so now. See the instructions in the chapter “Installing PathWAI Web Response Monitor”.

2. Select (Windows NT) Start > Programs > Windows Option Pack/Microsoft Internet Information Server > Internet Service Manager


3. If necessary, double-click the Console Root folder to display the server folders in the left side of the window.

4. Open the Internet Information Server folder.

5. Right-click the computer’s hostname.

6. Click Properties on the pop-up menu.

7. In the Master Properties list, select WWW Service, and click Edit.The host’s Master Properties notebook appears.

8. Click the ISAPI Filters tab, and click Add.



9. Enter Tomcat Redirect Filter in the Filter Name field of the Filter Properties window.

10. For the Executable name, browse to locate isapi_redirect.dll in <Candle_Home>\PathWAI\InstallFilesThe Executable field must contain the entire path to isapi_redirect.dll.

11. Click OK to close the Filter Properties window.


13. Close the console. When prompted, click Yes to save the new settings.

14. Follow these steps to restart IIS and enable the configuration changes.

Note: Using the Internet Service Manager console to stop and restart IIS will not start the Candle filter.

A. Select:(Windows NT) Start > Settings > Control Panel > Services



15. From the Internet Service Manager console, go back to the ISAPI Filters tab.

16. Move isapi_redirect.dll to the position under kfcCandleFilter.dll in the list of low-priority filters.Tip: A green Up arrow to the left of the filter indicates that it has started.

Click Apply and OK to close the Master Properties notebook, then click OK to close the host’s Properties page.

Uninstalling the IIS Filters



When you uninstall Web Response Monitor, all product files and directories are removed from the machine. If any Candle IIS filters are installed, the following additional actions take place automatically during uninstallation:

A. IIS services are stopped.B. Candle IIS filters are uninstalled.C. IIS services are restarted.

If any errors occur during automatic uninstallation of an IIS filter, you will receive an error message, and you will need to uninstall the filter at the Internet Services Manager console. To do so, follow these steps.

1. If the version of Web Response Monitor Presenter that you just uninstalled included Tomcat with IIS, follow this procedure on the machine that hosted Presenter:

A. Select (Windows NT) Start > Programs > Windows Option Pack/Microsoft Internet Information Server > Internet Service Manager


B. Under Default Web Site, delete any entries you find for either of these virtual directories:/candlebrowser

/jakarta

C. Right-click the computer’s hostname.D. Click Properties on the pop-up menu.E. In the Master Properties list of the host’s Properties page, select WWW

Service, and click Edit.F. Click the ISAPI Filters tab of the host’s Master Properties notebook.G. Select Presenter Redirect Filter in the list of filters, and click Remove.H. Click Apply and OK to close the Master Properties notebook, then

click OK to close the host’s Properties page.I. Close the console.J. When prompted to save settings, click Yes.K. Follow these steps to restart IIS and enable the configuration changes.



Note: Using the Internet Service Manager console to stop and restart IIS will not deactivate the redirect filter.

1. Select:(Windows NT) Start > Settings > Control Panel > Services


2. Stop and restart the WWW service. 3. Close the Services dialog and the Control Panel.

2. If a Candle IIS filter was installed on the web server machine to enable HTTPS monitoring, uninstall it now.

A. Select (Windows NT) Start > Programs > Windows Option Pack/Microsoft Internet Information Server > Internet Service Manager


B. If necessary, double-click the Console Root folder to display the server folders in the left side of the window.

C. Open the Internet Information Server folder.D. Right-click the computer’s hostname.E. Click Properties on the pop-up menu.F. In the Master Properties list of the host’s Properties page, select WWW

Service, and click Edit.G. Click the ISAPI Filters tab of the host’s Master Properties notebook.H. Select KFC Candle Filter in the list of filters, and click Remove.I. Click Apply and OK to close the Master Properties notebook, then

click OK to close the host’s Properties page.J. Close the console.K. When prompted to save settings, click Yes.L. Follow these steps to restart the Web server and enable the

configuration changes.

Note: Using the Internet Service Manager console to stop and restart the Web server will not deactivate the Candle filter.

1. Select:



(Windows NT) Start > Settings > Control Panel > Services


2. Stop and restart the WWW service. 3. Close the Services dialog and the Control Panel.

Index 201

Index

Numerics200 status code 112302 status code 109304 status code 111

AAbout Maintenance dialog 178Accept Request Port Number 127Access, Microsoft 172, 173account types

admin 76sysadmin 76user 76

accountsprofiles 76, 78updating 81

Acrobat Reader, version required 36Active Server Pages (ASP) 113admin account

description 76functions 81

admin mode 158, 159Adobe Acrobat Reader, version required 36Adobe portable document format 13AIX, platform support 34alert.schema file 176alerts

data 124, 155Analyzer

appliance mode 102configuration 91, 92interface with IIS 94listen ports 93network interface 102overview 29packet dispatcher 94starting 70, 71

stopping 71storage trace 94, 95

Apache Web servers 23appliance mode 99, 102Application ID field 183, 189Application Protocol field 185, 191application response time 22application schedule window 93ASP buffering 113audio

database table 192log format 189logs 105response time 25, 100SQL statement 192streams 23XML tag for logging 180

Average Interval 129

Bbackup history files 111batch mode 133, 158Browser Description field 185browser, Web

interface 84required for online help 36version required 36

buffer poolsallocation 93expansion 93frame capture 93storage use statistics 93

buffer trace, email 157


Ccache 111Candle filter 23, 40, 194Candle Web site 15case sensitivity 77, 84, 95Central Server Address field 127Checking Data Interval 129Chunked Transfer Encoding 114Client, Manager

communication with Manager Server 51, 67

configuration 122initialization parameters 130overview 119settings 122

collecting data 89, 113Collector

configuration 91, 103logs 180overview 29starting 70, 71stopping 71UNIX installation 56

Collector ID statement 104CollectorID field 183, 190communication, Manager Server and

Client 51, 67components

Analyzer 29Collector 29data collection 29data presentation 30Jakarta Tomcat Server 30Manager Client 29Manager Server 30overview 29Presenter 30starting 70stopping 71Tomcat server 30

configurationAnalyzer 91, 92Collector 91, 103data collection 89, 91, 113data logging 91database 165, 167, 168, 169, 170, 174debug tracing 91high-volume environments 106HTTPS filter 23, 40, 91, 194IIS 23, 40, 194ISAPI filter 23, 40, 194Manager Client 122Manager Server 140options 91parameters 91

Confirmation page 151conscralert.schema file 176console

Java 120, 136Manager Client 120, 132Manager Server 136, 138

Console mode 138conurlalert.schema file 176CREATE TABLE statements 180

Manager Server and 180

Ddata

alerts 124application 99, 124audio 192averaged 124capture 94collection 29, 89, 91, 113configuration 89, 91, 113deleting 145disabling transmission 134exception 124filters 128, 129, 155log directory 131, 152maximum amount 99mirroring 145

Index 203

packets 99, 100presentation 30purging 145record formats 179storage 142, 165, 180stored in log files 144, 166summary 124transaction 124transmission 133video 192Web object 187, 192Web page 187

data collectionappliance mode 102high-volume environments 106tips 106

Data page 142data source name 42, 45, 47, 144, 167,

171database

allocation 180audio 192column definitions 175configuration 142, 165, 167, 168, 169,

170, 174data record formats 179failure 172installation 47Microsoft Access 172Microsoft SQL server 172name 42, 45, 144, 171problems 172remote 172requirement 47schemas 174, 176settings 144, 171SQL statements 180video 192Web object data 187, 192Web page 187Web page data 187

Database Connection field 42, 45, 144, 171

debugconfiguration 91, 94SRI 94

debug mode 158default locale encoding 142, 144, 166delimiter 104, 105Desktop Nickname field 124detail data 124detail.schema file 176devices, data capture interface 94disk space required 35DISPLAY variable 56domain name 95Driver Name field 42, 45, 144, 171driver, database 167, 168, 169, 170Drop File settings 150DSN 42, 45, 47, 144, 171dynamic history file 108

Eebadetail.schema file 176ebaobject.schema file 176email

bad records 157buffer trace 157debugging 157defaults 156filters 157hostname 156mail checking 157timeouts 148, 156transmission 156

Email pageManager Client settings 125Manager Server settings 147

encoding, log files 142, 144, 166enhancements 17eteappavg.schema file 176etetransavg.schema file 176Exception and Average page 127, 129


exception data 124exception filters 155

adding 128deleting 129

exception interval 129

Ffeatures, new 17FHIST file 111Field Delimiter statement 104File Transfer page 149

Drop File settings 150FTP settings 149Receive File settings 150

filesbackups 111dynamic history 108history 100, 108permanent history 108properties, Manager Client 130properties, Manager Server 152schema 176URL history 100

filtersCandle 23, 40, 194debug 94exception 155global 23, 40, 194HTTPS 23, 40, 113, 194IIS redirection 196ISAPI 23, 40, 194Manager Client 155trace 94

filters, exceptionadding 128deleting 129

flat files 142, 144, 166formats, data record 179frames

merged 95, 96, 97FTP settings 149

GGeneral page

Manager Client settings 124Manager Server settings 141

global filter 23, 40, 113, 194GMT Offset field 183, 190

Hheartbeat signal 163help, online

accessing 12browser required 36

Hidden mode 158history files 95, 100, 101, 108

dynamic 108permanent 108

hostname 95, 100hostnameServer 57, 59Hotspot Java Virtual Machine 173HP-UX, platform support 34HTTP

database table 187method 186monitoring 22objects 26, 95pages 26processing trace 94record formats 182–187redirects 109response time 24secure 23, 40, 194SQL statement 187status codes 109, 111, 112XML tag for logging 180

HTTPSfilter 23, 40, 60, 100, 194IIS filter 100processing trace 94protocol 23, 60, 100

Index 205

IIIS

ASP buffering 113Candle filter 113configuration 23, 40, 91, 194HTTPS filter 23, 40, 194interface with Analyzer, debugging 94listen port 100performance 113redirection filter 45, 196socket timeout 113with HTTPS 100with Tomcat 45

improvements 17initialization parameters

data log directory 131, 152local host address 130, 153Manager Client 130Manager Server 152

installationautomatic, of Java 36Collector 56database 47GUI 56, 65HTTPS filter 60, 63Manager Client 40, 56Manager Server 48, 65non-GUI 58, 66operating mode 43permissions 55prerequisites 35readme.txt file 37server name 57, 59UNIX 55Windows 38X Window 56, 65

installer, version 39interfaces, network

Analyzer 102Manager Client 130Manger Server 153

intervalsaverage 129detail data 124exception checking 129exception data 124heartbeat 163summary data 124

IP address 130, 153IP Destination Address field 184, 190IP Destination Port field 184, 190IP Source Address field 183, 190IP Source Port field 183, 190iPlanet

Web Proxy Server 23, 60, 63Web Server 23, 60, 63

ISAPI filter 23, 40, 194

JJakarta Tomcat Server

product component 30standalone 44, 45starting 70stopping 71troubleshooting 70, 78verifying 70, 78with IIS 44, 45

Javaconsole 120, 136requirement 33, 36

JDBC 42, 45, 142, 165, 168, 169, 170, 179, 180

jdbc.properties file 174JRE

console 120, 136version required 36

Kkbb_ras1 statement 93, 104keg.localaddr parameter

Manager Client 130Manager Server 153


keg.logpath parameterManager Client 131Manager Server 152

keg.properties fileManager Client 130Manager Server 152

kegs_server.control file 168kfbalt.schema file 176kfbdtl.schema file 176kfbsum.schema file 176kfbtrn.schema file 176KFC_API_MEDIASERVER_LISTEN_PORT

option 93KFC_APPL_SCHEDULE_WINDOW

option 93KFC_BUFFER_POOL_STAT option 93KFC_CAPTURE_BUFFER_POOL_SIZE 93KFC_CAPTURE_DEVICE_NAME

option 94KFC_DEBUG_API option 94KFC_DEBUG_CAPTURE option 94KFC_DEBUG_FILTER option 94KFC_DEBUG_HTTP option 94KFC_DEBUG_HTTPS option 94KFC_DEBUG_PACKET option 94KFC_DEBUG_SRI option 94KFC_DEBUG_STORAGE option 94KFC_DEBUG_STORAGE_STAT option 95KFC_DOMAIN_NAME option 95KFC_HOST_NAME option 95KFC_HTTP_ALLOW_HISTORY_UPDATE

option 95KFC_HTTP_COMPARE_IGNORE_CASE

option 95KFC_HTTP_CUSTOM_OBJECTS

option 95KFC_HTTP_GROUP_PAGE_OBJECTS

option 96KFC_HTTP_HISTORY_OMIT_HOSTNAME

option 96KFC_HTTP_MERGE_DUPLICATES

option 96

KFC_HTTP_MERGE_FRAMES option 97, 108

KFC_HTTP_MERGE_REDIRECT option 97KFC_HTTP_MERGE_SESSION_DATA

option 98KFC_HTTP_OUTPUT_UNMERGED_OBJE

CTS option 97KFC_HTTP_PORT option 98KFC_KFC1API_DATA option 98KFC_MAX_APPLICATION_DATA_SIZE

option 99KFC_MAX_TCP_IO_PAUSE option 99KFC_NETBIOS_DATA option 99KFC_NFS_DATA option 99KFC_OWN_NETWORK_DATA_ONLY

option 99, 102KFC_RTSP_ALGORITHM option 100KFC_SNMP_DATA option 100KFC_SRI_HOST option 100KFC_SRI_LISTEN_PORT option 100KFC_SRI_PIPENAME option 100KFC_VIDEO_RESPTIME_THRESHOLD

option 100KFC_WORK_PATH option 110KFC1 API 93, 94KFC2 API 99kfcCandleFilter.dll file 195KFCF_MAX_MERGE_HISTORY_BACKUP

option 100KFCF_MERGE_HISTORY_CUSTOM_FILE

_NAME option 100KFCF_MERGE_HISTORY_EXPIRE_INTER

VAL option 100KFCF_MERGE_HISTORY_FILE_NAME

option 101KFCF_MERGE_HISTORY_NEW_EXPIRE_I

NTERVAL option 101KFCF_MERGE_HISTORY_RESET

option 101KFCFHIST file 101, 108KFCFPERM file 95, 100, 108kfcienv file 91kfcmenv file 61, 63, 91, 92

Index 207

kflmenv file 62, 91, 103

Llibkbb.so file 60, 63libkfcins.so file 60libkfcinsp.so file 63Linux

Oracle JDBC database driver 169platform support 34

Linux, platform support 34Listen Port field 57listen ports 93load balancers 107load time 24, 25Load Time field 185local address 130local host address 130, 153localert.schema file 177Log Directory statement 104log files

data record formats 179data storage 144, 166default format 142, 144, 166delimiter 104, 105encoding 142, 144, 166field delimiter 104, 105flat 142, 144, 166format 142, 144, 166Manager Client 131Manager Client status messages 125, 135Manager Server 142, 144, 152, 166Manager Server status messages 142names 180naming format 180path 152RAS1 trace 93tips 106UTF-8 encoding 142, 144, 166

Log HTTP OBJ statement 104Log HTTP statement 104Log Keepdays statement 104Log MS Audio statement 105

Log MS Video statement 105Log Real Audio statement 105Log Real Video statement 105logon 84logs

audio 105configuration 91days to keep 41, 104directory 104RAS1 trace 104tips 106video 105Web objects 104Web pages 104

Mmagnus.conf file 61Manager Client

Accept Request Port Number 127adding a server 127adding data filters 128adding to list 162admin mode 159alerts data 124batch mode 133communication with Manager Server 51,

67compatibility with Manager Server 119configuration 122console 120data requests from Manager Server 162deleting data filters 129deleting from Manager Server list 162detail data 124email 156exception data 124initialization parameters 130local host address 130log directory 131maximum concurrent 146message log 135network interfaces 130


operating mode 158, 159order of servers 127overview 29, 119profile 132, 134Send Data Port Number 127send mode 133settings 122shutting down 162Silent mode 159starting 70, 71status message log 125stopping 71, 72summary data 124TCP/IP socket connections 130Transport Settings 125UNIX installation 56version 119Windows installation 40Windows service 120

Manager Client Settings notebookEmail page 125Exception and Average page 127, 129General page 124TCP/IP page 126

Manager Serveradding to list 127communication with Manager Client 51,

67compatibility with Manager Client 119configuration 140console 136CREATE TABLE statements and 180database settings 144, 171email 156hostname 57, 59, 156initialization parameters 152local host address 153log directory 152log files 180maximum concurrent clients 146message log 142modes 138

network interfaces 153network name 57, 59order 127overview 30, 119requesting data 162settings 140Silent mode 138starting 70, 71, 138status message log 142stopping 71TCP/IP socket connections 153UNIX 138UNIX installation 65updating clients 160version 119Windows installation 48Windows service 136, 172

Manager Server Settings notebookConfirmation page 151Data page 142Email page 147File Transfer page 149General page 141TCP/IP page 145

memory overruns 107merge functions 97merge history 100, 101, 108merge parameters 95, 96, 97, 98, 107message logs


Method field 186Microsoft Access 172, 173Microsoft Installer, version 39Microsoft SQL server 172mirroring data 145mode

appliance 99, 102Console 138debug 158operating 158promiscuous 99

Index 209

Silent 138msg.log 125, 142multihome support 130, 153Multipurpose Internet Mail Extensions

(MIME) type 26

NName field 191NETBIOS data packets 99Netscape Web server 23, 60, 63Network File System (NFS) 99network interfaces 153

Analyzer 102appliance mode 102Manager Client 130Manager Server 153

Network Monitor 35, 38network name 57, 59Network Packet Protocol (NPP) 35, 38network protocol response time 21network time 24, 25Network Time field 185, 191normal mode 158

Oobj.conf file 61, 64objects

frames 95, 96, 97logs 104merged 98response time 25, 26, 96types 26, 95

ODBC 42, 45, 47, 142, 165, 167, 172, 173, 179, 180

odbcjt32.dll file 173online help

accessing 12browser required 36

operating mode 43, 158, 159operating systems 33options, configuration 91

Oracle JDBC database driverLinux 169UNIX 169, 170Windows 168

overlap 27overview

components 20product 20

Ppage logs 104Page Title field 186parameters, configuration 91parameters, initialization

data log directory 131, 152local host address 130, 153Manager Client 130Manager Server 152

passwords 78path

log 104work 105

PDF files, adding annotations 14permanent history file 108permissions 55ping 51, 67, 127, 163pipe name 100platforms 33Play Time field 191Player Description field 191port numbers

Accept Request 127Analyzer 93HTTPS IIS listen port 100iPlanet servers 61, 63Manager Client Send Data 127Manager Server settings 146monitoring 98

prerequisitesdisk space 35installation 35Java 36


permissions 55product components 33system 35UNIX 55

Presenter overview 30printing problems 13product

components 29enhancements 17overview 20

product componentsuninstalling 73

Product Version field 183, 189profile transmission 134profile, account

defined 76sysadmin 78updating 81

profile, client 132promiscuous mode 99properties file


protocolsapplication 22audio 23HTTP 23, 40, 194HTTPS 23, 40, 60, 194network 21TCP/IP 21video 23

proxy servers 23, 60, 63

RRAS1 trace logs 93, 104readme.txt file 37Real Time Streaming Protocol (RTSP) 23,

100record formats 179redirect 97redirects, HTTP 109Referrer URL field 184, 191

relational database management systems (RDBMS) 175

Reply Ack Packet Count field 184, 191Reply Bytes field 184, 191Reply Packet Count field 184, 190report subscriptions 87

creating 88deleting 82removing 82

reportssubscribing 87Web browser interface 84

Request Ack Packet Count field 184, 190Request Bytes field 184, 191Request Packet Count field 184, 190Request Port field 58Request Status field 185, 191requirements

disk space 35permissions 55product components 33system 35UNIX installation 55

Reserved 1 field 183, 189Reserved2 field 185Reserved3 field 185Reserved4 field 186resolve time 24, 25Resolve Time field 185response time

application 22audio 25, 100calculation frequency 93HTTP objects 25HTTP pages 96measurement of 24network protocol 21objects 96overlap 27total 25video 25, 100Web objects 26

Index 211

Web pages 26, 96

Sschema files 176schemas, database 174scralert.schema file 177scripts


scrsample.schema file 177scrsummary.schema file 177secure HTTP 23, 40, 194Secure Sockets Layer (SSL) 113Secure Sockets Layers (SSL) 45security settings

UNIX 55Send Data Port Number field 127Send Summary Data 133Server Description field 185, 191server time 24, 25Server Time field 185Server, Manager

communication with Manager Client 51, 67

configuration 140hostname 57, 59initialization parameters 152network name 57, 59overview 119settings 140

server.bat file 120, 136server.sh script 138service, Windows 120, 136settings

Analyzer 92Collector 103database 144, 171email defaults 156Manager Client 122Manager Server 140

signing on 84Silent mode 138, 158, 159

Simple Network Management Protocol (SNMP) data packets 100

SM3_COLLECTOR_ID statement 104SM3_FIELD_DELIMITER statement 104SM3_LOG_DIR statement 104SM3_LOG_HTTP statement 104SM3_LOG_HTTPOBJ statement 104SM3_LOG_KEEPDAYS statement 104SM3_LOG_MS_AUDIO statement 105SM3_LOG_MS_VIDEO statement 105SM3_LOG_REAL_AUDIO statement 105SM3_LOG_REAL_VIDEO statement 105SM3_SUB_CHAR statement 105SM3_WORK_PATH statement 105sm3audio.schema file 177sm3http.schema file 177sm3obj.schema file 177sm3video.schema file 177SNMP 100socket connections 130, 153socket timeout 113Solaris, platform support 34SQL server database 172SQL statements 187

audio 192Manager Server and 180video 192Web object database table 192Web objects 187Web page 187Web page database table 187

StartClientAdmin.sh script 159StartClientSilent.sh script 159starting and stopping product

on UNIX 71on Windows 70, 71

StartServer.sh script 138status codes, HTTP

200 112302 109304 111

Status Message Logging 125, 142


storage trace 94, 95subscriptions

creating 87deleting 82removing 82

Substitute Character statement 105summary data 124Sun One Web server 23, 60, 63sysadmin account

description 76functions (Web interface) 77–??password 78

system requirements 35

TTCP/IP 21, 98, 99, 130, 153TCP/IP page

Manager Client settings 126Manager Server settings 145

timeapplication 22load 24, 25measurements defined 24network 24, 25network protocol 21resolve 24, 25server 24, 25total 25

timeoutsemail 148, 156

Timezone field 183, 190title, page 186Tomcat server

product component 30standalone 44, 45starting 70stopping 71troubleshooting 70, 78veriifying 70, 78with IIS 44, 45

Total Bytes field 184, 191

Total Header Request Resolve Time field 185

Total Header Requests Count field 185Total Object Count field 185Total Object Size field 185total response time 25

defined 24Total Response Time field 184, 190trace

Analyzer 94Analyzer storage 94, 95data filtering 94frame-capture interface 94HTTP processing 94HTTPS processing 94KFC1 API 94options 91RAS1 93, 94, 104SRI 94

Transaction Date field 183, 190Transaction GUID field 183, 190Transaction Time field 183, 190Transaction Time UTC field 183, 190transmission

disabling 134profile 134scheduled 133

Transmission Control Protocol (TCP) 23transmission method

email 125file transfer 149TCP/IP 125

Transport Settings 125Type field 191

UUnicode Transformation Format 142uninstalling product

UNIX 73Windows 73

Index 213

UNIXGUI installation 56, 65HTTPS transactions and 23JDBC database 169, 170Manager Client scripts 159Manager Server script 138Manager Server scripts 138non-GUI installation 58, 66Oracle JDBC database driver 170permissions 55platform support 33security 55starting and stopping product 71uninstalling product components 73X Window installation 56, 65

unmerged objects 97update 95Update Clients 160URL Anchor field 186URL field 184URL File field 186URL history files 100, 108URL Host Name field 186URL Path field 186URL Query String field 186urlalert.schema file 177urlsample.schema file 177urlsummary.schema file 177user account

creating 81description 76

User Datagram Protocol (UDP) 23user interface 30UTF-8 encoding 142, 144, 166

Vversion requirements

Java 36Manager Client and Manager Server 119Web browser 36

videodatabase table 192log format 189logs 105minimum playtime 100response time 25, 100SQL statement 192streams 23XML tag for logging 180

virtual serverdomain name 61home directory 60

WWeb browser

interface 84required for online help 36version required 36

Web browser interfacelogon 84navigating to reports 85

Web objectsdatabase table 187response time 25, 26SQL statement 187types 26, 95unmerged 97

Web pagesdatabase table 187frames 95, 96, 97response time 24, 26, 96SQL statement 187titles 186

Web server 23, 60, 63Web site, Candle 15Windows

2000 332003 33authority required to install product 38installation of product 38JDBC database 168NT 33


ODBC database 167platform support 33service 120, 136starting and stopping product 70starting product 70stopping product 71uninstalling product 73XP 33

Windows serviceManager Client 120Manager Server 136, 172

work path 110Work Path statement 105

XX Window installation 56, 65XML tags 183, 189

Documents

PathWAI Web Response Monitor User’sഀ 䜀甀椀搀攀Ⰰ 嘀⸀⸀publib.boulder.ibm.com/tividd/td/ITPathWRMon/GC32... · 12 PathWAI Web Response Monitor User’s Guide, V1.1.2