IBM. Cúram JMX Report Generator Guide

Transcription

1 IBM Cúram Social Program Management Cúram JMX Report Generator Guide Document version 1.0 Andrew Foley is a software engineer with a background in automated web testing and performance testing. Feargal Conneely (Feargal.Conneely@ie.ibm.com) is an automation test engineer with a background in automation test design and execution. William Walsh (wwalsh@us.ibm.com) is a software engineer with a background in server-side development and all aspects of product enablement on z/os. Andrew, Feargal, and William work on the Cúram System Verification Test and Performance Engineering team. IBM

2 Copyright International Business Machines Corporation US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

3 CONTENTS Contents...3 Revision History Introduction Prerequisites Installing the Tool Setting Up the Tool Running the Tool Accessing the Output Reviewing the Output...8

4 REVISION HISTORY Date Version Comments January Initial version

5 Cúram JMX Report Generator 1 Introduction You can use the Cúram JMX Report Generator tool to help you to process Cúram JMX statistics files. The tool helps you to: See important Cúram performance indicators at a glance. Compare multiple sets of statistics. More easily view large data sets with sorting and filtering. 2 Prerequisites This tool requires the following environment: A Windows or UNIX operating system that is supported by Cúram. For more information about supported operating systems, see the IBM Cúram Social Program Management Version 6 Prerequisites. ( A Java 1.7 or higher JRE. Cúram JMX statistics to be configured and operational. For more information about Cúram JMX statistics, see Configuring Cúram JMX in the IBM Knowledge Center. ( 3 Installing the Tool Obtain the JMXReportGenerator.zip file and extract the file on your file system. For example: jar xf JMXReportGenerator.zip. The contents of the zip file include: JMXReportGenerator.jar jmxconfig.conf resources/* run.bat 5

6 Cúram JMX Report Generator 4 Setting Up the Tool Before you run the tool, edit the jmxconfig.conf file to specify the location and details of the JMXStats.xml files you want to process. Each JMXStats.xml file is identified by the header: JmxStats. Following this header are entries that identify the location and details of the JMX statistics to process. The format of entries is space and case sensitive. That is, any additional spaces, missing spaces, or mismatching cases, cause the entry to be ignored. You can specify a maximum of five JmxStats entries in the jmxtohtml.conf file. The following entries identify a JMXStats.xml file: FilePath : <The fully qualified path of a JMXStats.xml file> CuramIdentifier : <Free form text to identify the Curam version/details> This value must be unique for each entry. The information appears in the "Collection Details" table and various headers in the Summary.html file. Jmx Last Reset Time : yyyy-mm-dd HH:mm:ss Must be in the specified format. Appears in the "Collection Details" table to help you when processing multiple files. Jmx Download Time : yyyy-mm-dd HH:mm:ss Similar to "Jmx Last Rest Time", used to help you in managing your JMX Stats data. App Server Details : <Free form text to identify the source application server> This information appears in the "Collection Details" table and various sections in the Summary.html file. A sample entry: JmxStats FilePath : C:\Temp\JMXStats.xml CuramIdentifier : v _int1 Jmx Last Reset Time : :11:00 Jmx Download Time : :12:00 App Server Details : Server1 The JMXStats header is required (maximum of five), entries begin in column one, and # is the comment character. 6

7 Cúram JMX Report Generator 5 Running the Tool You must run the tool from the installation directory. To run the tool, call the jar file by using Java. On UNIX or Linux, enter the following commands: cd /<installation_directory>/jmxreportgenerator java -jar JMXReportGenerator.jar On Windows, enter the following commands: cd C:\<installation_directory>\JMXReportGenerator run.bat 5.1 Accessing the Output The output of the tool is a Summary.html file, which is created in the base folder of the FIRST configured JMX file in the jmxconfig.conf configuration file. For example, if you have a configuration similar to the following where C:\JMXSamples\JMXStats (1)\JMXStats.xml is the first occurring JMXStats file in the configuration: JmxStats FilePath : C:\JMXSamples\JMXStats (1)\JMXStats.xml CuramIdentifier : 800 User JMX1 Jmx Last Reset Time : :00:00 Jmx Download Time : :45:00 App Server Details : AppSrv001 JmxStats FilePath : C:\JMXSamples\JMXStats (2)\JMXStats.xml CuramIdentifier : 800 User JMX2 Jmx Last Reset Time : :00:00 Jmx Download Time : :45:00 App Server Details : AppSrv Based on the preceding control statement the resulting Summary.html file would be created in the C:\JMXSamples\JMXStats (1)\ folder. 7

8 Cúram JMX Report Generator 5.2 Reviewing the Output The Summary.html file contains the following sections: A Collection Details table that summarizes the jmxconfig.conf entry values. A table of important statistics for each JMXStats.xml file. This summary includes high-level SQL performance indicators, the number of business process transactions that are executed, and high-level cache indicators. Some entries have tooltips available to explain them, hover over them to see any additional information. A comparison of the BPO methods that are executed and their average elapsed time for all the JMXStats.xml files processed. A comparison of URLs and their average elapsed time for all the JMXStats.xml files processed. The remaining sections enclose the statistics from each JMXStats.xml file within its own tab in its section. The data in each tab is both paginated and sortable, to make analysis quicker and easier. 8

9 IBM Copyright IBM Corporation 2015 IBM United States of America Produced in the United States of America US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PAPER AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes may be made periodically to the information herein; these changes may be incorporated in subsequent versions of the paper. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this paper at any time without notice. Any references in this document to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation 4205 South Miami Boulevard Research Triangle Park, NC U.S.A. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information is for planning purposes only. The information herein is subject to change before the products described become available. If you are viewing this information softcopy, the photographs and color illustrations may not appear. 9

10 Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( or ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the web at "Copyright and trademark information" at Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other company, product, or service names may be trademarks or service marks of others.