About the Tomcat Cartridge Supported Platforms Installation New in This Release Resolved Issues

Transcription

1 Foglight Cartridge for Tomcat version Foglight version 4.1 August 2006 Copyright Quest Software, Inc All rights reserved. About the Tomcat Cartridge Supported Platforms Installation New in This Release Resolved Issues Known Issues General Information Quest X-Agent Support Policy Global Operation About Quest Software, Inc. About the Tomcat Cartridge Thank you for purchasing or evaluating Foglight for J2EE. This document contains the list of supported platforms, notes on installing Foglight, notes on this version of Foglight, general notes, and a list of known problems. The Foglight Cartridge for Tomcat lets you to continuously monitor your Tomcat Application Servers using any of three Foglight Agents that provide 24x7 monitoring to help you detect and resolve performance problems in your application server infrastructure and the applications running in that infrastructure. The Tomcat Cartridge contains the following agents: The Tomcat Agent collects and monitors runtime metrics from instances of Tomcat Server. The agent collects performance related data from the application server, such as thread usage, request and session metrics. The agent includes standard Foglight graph and table views. In addition, the agent includes a number of rules to notify application and system administrators of performance problems for diagnosis and resolution. The RequestTime Agent provides triage data for service requests on individual Tomcat servers using Quest PerformaSure bytecode instrumentation. The RequestTime Agent provides request response times for service requests organized by request type and J2EE service tier. The RequestTime Agent is compatible with Quest PerformaSure and may be used to record PerformaSure sessions. The J2EEMemory Agent provides memory analysis data on J2EE production environments. This data is particularly useful in helping to assess the potential for memory leaks and Out of Memory failures that can impact system performance. The J2EEMemory Agent for Tomcat uses Quest PerformaSure bytecode instrumentation to provide performance data for individual service requests that run within a single Tomcat Application Server instance. Supported Platforms For information about the supported platforms, please login to Quest SupportLink's Downloads & Updates area using the following link: Then follow these steps: 1 Select Foglight in the Product Family drop-down. 2 Select your Cartridge from the list. 3 Select the version you are looking for. 4 Select the SupportedPlatformsAndServers-PM.pdf document. Please note the following: This version of the Foglight Cartridge for Tomcat is supported on Foglight Management Server v.4.1.1a, 4.1.2, 4.2.1a, and

2 The J2EEMemory Agent is only supported on: Sun JVM v and higher HP JVM 5.0 J2EEMemory Agent makes use of the jvmstat technology to collect additional JVM metrics such as garbage collection information for different generation spaces in the memory heap. The Agent populates the J2EEMemory State table (JMEM_State) with this information. However, the jvmstat technology is only available in the Sun JVM v and higher, and HP JVM 5.0. If you are running a Sun JVM with a version lower than 1.4.2, or a BEA JRockIt JVM, the J2EEMemory Agent will collect generic JVM metrics only, populating only the TotalFree, TotalFreePercent, TotalSize, TotalUsed, and TotalUsedPercent fields in the J2EEMemory State table, and leaving the rest of the fields empty. For more information about the J2EEMemory State table, see the User Guide. The following platforms are no longer supported: AIX Solaris 7 Note This list is subject to changes, and represents only the platforms for which support was discontinued at the release time. For complete information on platforms that are supported by the Foglight Cartridge for Tomcat, please refer to the above URL. Installation For detailed installation and configuration instructions, please refer to the Getting Started Guide. The installer files for this release are: Tomcat_V41_U_060608p.sh for Solaris Tomcat_V41_W_060608p.exe for Windows Note If installing the Cartridge on a Solaris platform, you must set the DISPLAY environment variable to point to a valid display device. This variable is used by the Compare and Update Utility which lets you migrate existing Agent rules and views to the current version. The installation process requires this variable to be set even if you choose not to migrate the Cartridge. For more information about the Compare and Update Utility, see the Getting Started Guide. New in This Release Quest Software continues its commitment to expand support for underlying platforms with the Foglight Cartridge for Tomcat The following enhancements have been made for this release: Enhanced Platform Support HTTPS Support for the Foglight Cartridges Enhanced Platform Support Foglight Cartridge for Tomcat further adds to its extensive platform support. Highlights to the platform updates are: Apache Tomcat 5.5 enhancements: Increased support to Apache Tomcat 5.5.[16-17] For more information on platforms supported in this version, see Supported Platforms on page

3 HTTPS Support for the Foglight Cartridges The Foglight Cartridge for Tomcat is now able to communicate with the Foglight Management Server through HTTPS. This configuration enhances the Foglight s security and compliance capabilities. Resolved Issues PR# CR# Case ID Description Foglight Agents do not support access over HTTPS because the URLs are hard-coded to Solution: A parameter has been added to the Agent's ASPs. For more information, see the Getting Started Guide. Known Issues This section lists known issues in the Foglight Cartridge for Tomcat, version Installation Issues PR / CR If client is in (D)own or (T)imeout state, cartridge install loops indefinitely If a Foglight client cannot be updated during the cartridge update, the Foglight Server logs a similar message until the installation process is stopped, which causes the Foglight Server to loop the installation. This issue has been fixed in the coming release. ================================================================= Clients not yet reported updated with Tomcat_V41_U_051213p" (W)aiting (U)pdating (D)own (T)imeout (H)ost down (F)ailed rd-aix05.sitraka.com(u) rd-rhas21-02(d) l2000-cs.sitraka.com(d) PR / CR sethoststate not updating Windows Clients After installing the cartridge on the Foglight Server, when you run the sethoststate command to update monitored hosts manually, Windows-based clients may not be updated as expected. This issue is being investigated by Quest Software. PR / CR sethoststate not updating monitored hosts In some cases, running the sethoststate command does not update monitored hosts as expected. This issue will be fixed in a future release. PR / CR Windows Client installer reports error In some cases, the Foglight Windows Client installer reports the following error: Open file failed DBVARS - 3 -

4 This causes the installation process to go into an infinite loop, and the installation must be cancelled. This issue is being investigated by Quest Software. PR / CR Foglight Client installer reports an error on RedHat AS v.3.0 The installation of the Foglight Client may fail on RedHat AS v.3.0. This issue is being investigated by Quest Software. PR / CR Foglight Client installer fails on a box running Linux kernel v.2.6 when using SSH The Foglight Client installer may fails when using SSH, and the monitored host is running on a Linux kernel v.2.6. This issue is being investigated by Quest Software. Foglight Issues CR Soft limit data cap entry is not followed, hard limit is then followed If a single entry is left in the data cap list, the data cap setting is ignored. This issue is being investigated by Quest Software. PR / CR Modifying or adding rules does not take effect In some cases, creating or modifying rules on the Foglight Server does not take effect. This issue will be fixed in a future release. PR / CR , CR Column headings and data in Data Browser are swapped When you open a table using the Data Browser, the table columns and data appear to be swapped. This issue will be fixed in a future release. RequestTime Agent Issues PR 44076, PR 45746/CR The RequestTime Agent version number out of date After upgrading the Tomcat Cartridge to the version, when you right-click a host in the IP map of the Foglight Operation Console, choose System Configuration, and open the Cartridges tab, the RequestTime Agent displays an out-of-date version number, , instead of the actual version number, <n>. Workaround: To update the RequestTime Agent version, complete the following steps: 1 On each monitored host, remove the RequestTime.ver file in any of the following ways: Delete the RequestTime.ver file from the <FGLHOME>/World directory. or Run <FGLHOME>/J2EEAgentArchive.<sh bat> and choose Archive obsolete J2CA cartridge files when prompted. 2 On the Foglight Server, run the J2EEAgentArchive.<sh bat> script with the -r option. For example: /foglight J2EEAgentArchive.sh -r For more information about J2EEAgentArchive.<sh bat>, see the Getting Started Guide. J2EEMemory Agent Issues PR 47282, PR Amount of memory used by the J2EEMemory Agent higher than expected J2EEMemory Agent creates an object for each object that it tracks. The number of tracked objects increases with the ratio of tracked requests to sampled requests, which causes a memory overhead. By default, ObjectTracker tracks objects for one out of ten sampled requests that are processed per thread. Workaround: This random request distribution provided by the ObjectTrackerSampleRatio parameter limits the memory overhead that is incurred while monitoring and can be further refined to meet the needs of your monitoring requirements. A higher value will result in fewer tracked objects for sampled requests and decreased system overhead; whereas a lower value will track more, but at the expense of a higher overhead on the application server

5 To change the default number of requests that are sampled per thread, complete the following steps: 1 Open <PERFORMASURE_HOME>/config/client/instrumentation.config file for editing. 2 In the Object Tracking section of instrumentation.config, uncomment the ObjectTrackerSampleRatio parameter. Note that its default value is set to To specify the number of requests that are sampled, set the value of ObjectTrackerSampleRatio to a desired number. 4 Save your changes. If you are using an older Agent, completing the above procedure will have no effect. Instead, choose any the following steps to edit the number of sampled requests: On machines with older Agents, copy instrumentation.config from <PERFORMASURE_HOME>/config/client to <PERFORMASURE_HOME>/ config/client-override. In the Object Tracking section of the <PERFORMASURE_HOME>/config/client-override file, ensure that ObjectTrackerSampleRatio is commented out. On the PerformaSure Nexus machine, in <PERFORMASURE_HOME>/config/client/instrumentation.config, edit the value of the ObjectTrackerSampleRatio parameter as desired. If you make any changes to <PERFORMASURE_HOME>/config/client/instrumentation.config on the Nexus machine that do not involve ObjectTrackerSampleRatio, you will need to add them to <PERFORMASURE_HOME>/config/client-override/ instrumentation.config on machines with older Agents. On machines with newer Agents, copy instrumentation.config from <PERFORMASURE_HOME>/config/client to <PERFORMASURE_HOME>/config/client-override. In the Object Tracking section of the <PERFORMASURE_HOME>/config/client-override file, set ObjectTrackerSampleRatio to a desired value. On the PerformaSure Nexus machine, ensure that the value of ObjectTrackerSampleRatio in <PERFORMASURE_HOME>/config/client/ instrumentation.config is commented out. On the PerformaSure Nexus machine, ensure that the ObjectTrackerSampleRatio value in <PERFORMASURE_HOME>/config/client/ instrumentation.config is commented out. Set the performasure.instrumentation.objecttrackersampleratio system property to a desired value. Note This is a preferred solution because it overrides one setting instead of the entire file. For more information about the Object Tracking section in instrumentation.config, see the Getting Started Guide. Tomcat Agent Issues PR Tomcat Error Count Trend and Average Processing Time Trend Rules do not mention servlet name in event messages When the Tomcat Error Count Trend and Average Processing Time Trend Rules (Tomcat_SltErrCntTrnd and Tomcat_SltPrcTmTrend) generate warning or critical events, the error message does not specify the name of the offending servlet. This issue will be fixed in a future release

6 General Information Database Changes The following table indicates the agents for which the database schema has changed in the releases between v.4.0 and For more information, see the Getting Started Guide. Agent Tomcat Cartridge Release RequestTime J2EEMemory Creating Agent-Specific Debug Log For technical support issues, you may be asked to configure the cartridge to create a debug log. To enable a debug log, do the following on the Foglight Server. Tomcat Agent: 1 Create a file called <agentname>_errvars@<mycomputer> in FGLHOME/World Where <agentname> is the name of the agent and <MyComputer> is the location of the monitored host. For example: Tomcat_ERRVARS@PROD Within the file, create the following entries: FILE=$AbsolutePath\<agentname>log.txt SIZE=10M METHOD=file SEVERITY=fatal,stat,error,warn,info,debug CORE=no Where <agentname> is the name of the agent. 3 Stop the Agent. 4 Restart the Agent. 5 Administer any tests for debugging. 6 Stop the Agent. The debug log appears in the <AbsolutePath> directory. To stop debugging, remove the debug file you created from the FGLHOME/World directory

7 RequestTime and J2EEMemory Agents: Agent-specific error logging is not supported by the RequestTime and J2EEMemory Agents. To gather debug information, you must change the settings in the FGLHOME/World/Errvars file: 1 Make a backup copy of the FGLHOME/World/Errvars file. 2 Edit the original FGLHOME/World/Errvars file. 3 Within the file, set the file variable to a physical path name: FILE=$AbsolutePath\log.txt 4 Set the METHOD variable to FILE: METHOD=file 5 Set the SEVERITY variable: SEVERITY=fatal,stat,error,warn,info,debug 6 Stop the Agent. 7 Restart the Agent. 8 Administer any tests for debugging. 9 Stop the Agent. The debug log appears in the <AbsolutePath> directory. To stop debugging, restore the backup copy of the Errvars file. Configuring HTTPS Support The Tomcat Cartridge includes the support for application servers that use SSL security (the HTTPS protocol). On Unix machines, the HTTPS support is enabled through the use of the OpenSSL ssl library. This library uses a pseudo-random number generator for data encription tasks, and requires random information to feed the generator. To do that, the library reads random data from the following files: /dev/random /dev/urandom /var/run/egd-pool /dev/egd-pool /etc/egd-pool /etc/entropy In addition to the above sources, the library also uses the device pointed to the environment variable $RANDFILE or $HOME/.rnd if either if those variables are set. If none of these sources exist, the generator will not function properly, and the HTTPS support will not be available. This is a known problem on HP-UX 11i machines. To overcome the problem, HP provides the following tools: /dev/random and dev/urandom or libraries/tools. This tool includes a random data device which is installed to /opt/openssl/prngd/prngd. If you choose this option, you should set $RANDFILE to that location. For information on how to configure the HTTPS support, see the Getting Started Guide. Quest X-Agent Support Policy The Quest X-Agent is a customizable agent that can be used to support environments that are not officially supported (a complete list of supported platforms can be found by contacting Quest Technical Support)

8 In the event that part of your Java Enterprise environment is not supported by Quest Technical Support, you can choose to work with Quest Consulting to create a Custom Agent Integration based on the X-Agent that supports your specific application server, JVM and OS combination. The X-Agent is validated for specific JVM/OS combinations only the list of supported platforms can be found by contacting your Quest Sales representative. If you want to use the Quest Application Management Solution for a currently unsupported application server environment you can purchase a Custom Agent Integration for your specific application server provided it is running on a validated JVM/OS combination. The creation of a Custom Agent Integration will involve two phases of work between Quest Consulting and your organization: Scoping Phase: Quest Consulting will determine the exact versions of application server, JVM and OS and see if the application server can take advantage of X-Agent instrumentation. Implementation Phase: Assuming that the X-Agent instrumentation is compatible with your application server Quest Consulting will scope an engagement to complete a Custom Agent Integration. While Quest Technical Support will support the X-Agent instrumentation itself, the Custom Agent Integration will be supported through Quest Consulting. Quest Software, Inc owns any Intellectual Property for the code, templates, documentation or other deliverables used in the creation of the Custom Agent Integration. Global Operation This section contains information about installing and operating this product in non-english or non-ascii configurations, such as those needed by customers outside the USA. This section does not replace the materials about supported platforms and configurations found elsewhere in the product documentation. This product was not enabled for international operation. Only U.S. English configurations of this product and U.S. English datasets are fully supported. Support for non-ascii characters and/or non-english configurations may work appropriately, but these configurations have not been tested and this product should be used with caution in these environments. For specific support information, contact Quest customer support. About Quest Software, Inc. Quest Software, Inc. delivers innovative products that help organizations get more performance and productivity from their applications, databases and Windows infrastructure. Through a deep expertise in IT operations and a continued focus on what works best, Quest helps more than 18,000 customers worldwide meet higher expectations for enterprise IT. Quest Software can be found in offices around the globe and at Contacting Quest Software Phone: (United States and Canada) info@quest.com Mail: Quest Software, Inc. World Headquarters 5 Polaris Way Aliso Viejo, CA USA - 8 -

9 Web site: Please refer to our Web site for regional and international office information. Contacting Customer Support Quest Software s world-class support team is dedicated to ensuring successful product installation and use for all Quest Software solutions. SupportLink: support@quest.com You can use SupportLink to do the following: Create, update, or view support requests Search the knowledge base Access FAQs Download patches Copyright Quest Software, Inc All rights reserved. This document contains proprietary information, which is protected by copyright. The software described in this document is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser's personal use without the written permission of Quest Software, Inc. Warranty The information contained in this document is subject to change without notice. Quest Software makes no warranty of any kind with respect to this information. QUEST SOFTWARE SPECIFICALLY DISCLAIMS THE IMPLIED WARRANTY OF THE MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Quest Software shall not be liable for any direct, indirect, incidental, consequential, or other damage alleged in connection with the furnishing or use of this information. Trademarks Foglight is a registered trademark of Quest Software, Inc. Foglight software includes 1996 Expect software (freeware). Expect and its documentation are copyrights and trademarks of Don Libes, Associates. This product includes software developed by the OpenSSL Project Copyright (c) The OpenSSL Project. All rights reserved. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com). Portions of the code in this package were distributed by Carnegie Mellon University. 1989, 1991, 1992, Carnegie Mellon University. All rights reserved. Portions of this product were obtained from the ucd-snmp package written by Wes Hardaker at the University of California, Davis copyright 1996, Copyright , Networks Associates Technology, Inc. All rights reserved. Portions of this code are also copyright , Cambridge Broadband Ltd. All rights reserved. Portions of this software are derived from the RSA Data Security, Inc. MD5 Message-Digest Algorithm. Foglight software includes Info-ZIP. Info-ZIP is provided "as is" without warranty of any kind, express or implied. In no event shall Info-ZIP or it's contributors be held liable for any direct, indirect, incidental, special or consequential damages arising out of the use of or inability to use this software. All other trademarks and registered trademarks used in this document are property of their respective owners. World Headquarters, 5 Polaris Way, Aliso Viejo, CA info@quest.com U.S. and Canada: Please refer to our Web site for regional and international office information. Foglight Cartridge for Tomcat - Release Notes Release Date - August

10 Cartridge Version Foglight Version