uCosminexus Application Server

Maintenance and Migration Guide

3020-3-Y11-10(E)

Contents

Notices

Summary of amendments

Preface

1. Application Server Functionality

1.1 Classifications of functionality

1.1.1 Functionality as an application execution platform

1.1.2 Functionality for operating and maintaining the application execution platform

1.1.3 Functionality and corresponding manuals

1.2 Functionality corresponding to the purpose of the system

1.2.1 Functionality for system maintenance

1.2.2 JavaVM functionality of the product

1.2.3 Functionality for migrating from products of earlier versions

1.3 Description of the functionality described in this manual

1.3.1 Meaning of classifications

1.3.2 Example of tables describing classifications

1.4 Main functionality changes in Application Server 09-50

2. Troubleshooting

2.1 Organization of this chapter

2.2 Overview of troubleshooting

2.2.1 Overview of Troubleshooting

2.2.2 Flow of data acquisition when a trouble occurs

2.3 Acquiring the Data

2.3.1 Data That Can Be Acquired Automatically When a Problem Occurs

2.3.2 Collecting the Material Using Commands during Error Detection

2.3.3 Collecting the Snapshot Log

2.3.4 Location to store the acquired information

2.4 Types of Required Data

2.4.1 Trouble types and the required data

2.4.2 List of Required Data to Be Acquired

2.4.3 Correspondence Between Acquisition Methods and Investigation Methods

2.5 Troubleshooting and Recovery

2.5.1 If the Configuration Software Process (Logical Server) Terminates Abnormally

2.5.2 When an attempt to forcefully terminate a J2EE application fails

2.5.3 If a Problem Occurs When Using the Database Session Failover Function

2.5.4 When an error occurs in the EADs session failover functionality

2.5.5 If a problem occurs when using the Memory Session Failover Function

2.5.6 If a problem occurs in the JPA Application

2.5.7 If JavaVM Terminates abnormally

2.5.8 If Administration Agent is terminated forcibly when OutOfMemoryError occurs

2.5.9 If a Problem Occurs in the System Linked with JP1

2.5.10 If a problem occurs in 1-to-1 node switching system

2.5.11 If problems occurs in N-to-1 recovery systems

2.5.12 If a problem occurs in the node switching system for the host unit management model

2.5.13 If a Problem Occurs in the EJB Client

2.6 Precautions Related to Troubleshooting

2.6.1 Precautions Related to the System Log of an EJB Client Application

2.6.2 Precautions When Using CTM

2.6.3 Precautions when using PRF

2.6.4 JavaVM data-related considerations

3. Preparing for Troubleshooting

3.1 Organization of this chapter

3.2 Overview of data acquisition settings

3.2.1 Specifiable contents

3.2.2 Overview of data acquisition settings (Systems that execute J2EE applications)

3.2.3 Overview of data acquisition settings (Systems executing batch applications)

3.3 Execution environment settings

3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications)

3.3.2 Data acquisition settings using failure detection time commands (Systems for executing batch applications)

3.3.3 Settings for collecting snapshot logs (Systems for executing J2EE applications)

3.3.4 Settings for collecting snapshot log (Systems for executing batch applications)

3.3.5 Settings for acquiring the Management Server log

3.3.6 Settings for Acquiring the J2EE Server Log

3.3.7 Settings for Acquiring the Batch Server Log

3.3.8 Settings for Acquiring the SFO Server Log

3.3.9 Settings for Acquiring the Web Server Log

3.3.10 Settings for Acquiring the Redirector Log

3.3.11 Settings for acquiring the in-process HTTP server log

3.3.12 Settings for Acquiring the Cosminexus Manager Log

3.3.13 Settings for Acquiring the Resource Adapter Logs

3.3.14 Settings for Acquiring the Cosminexus TPBroker Log

3.3.15 Settings for collecting Cosminexus JMS Provider logs

3.3.16 Settings for Collecting the OS Statistical Information

3.3.17 Settings for Collecting a User Dump

3.3.18 Settings for Acquiring a Core Dump

3.3.19 Settings for Acquiring the JavaVM Material

4. Output Destinations and Output Methods of Data Required for Troubleshooting

4.1 Organization of this chapter

4.2 Types of data used for troubleshooting (When snapshot log is not used)

4.3 Application Server log (Systems for executing J2EE applications)

4.3.1 Acquiring the Cosminexus Component Container Logs

4.3.2 Acquiring the Cosminexus Performance Tracer Log

4.3.3 Acquiring the Cosminexus Component Transaction Monitor Log

4.3.4 Acquiring the log output in audit log

4.3.5 Acquiring the Application User Log

4.4 Application Server log (Systems for executing batch applications)

4.4.1 Acquiring the Cosminexus Component Container Logs (systems executing batch applications)

4.4.2 Acquiring the Application User Log (systems executing batch applications)

4.5 EJB Client Application System Log

4.5.1 Types of EJB Client Application System Logs

4.5.2 Output Destination of the EJB Client Application System Log

4.6 Trace based performance analysis

4.7 JavaVM thread dump

4.7.1 When using the management command

4.7.2 When using separate commands

4.7.3 When using JavaVM commands

4.7.4 Precautions to be taken when class-wise statistical information is output in the thread dump

4.8 JavaVM Garbage Collection Log

4.9 Memory Dump

4.9.1 Acquiring a User Dump (In Windows)

4.9.2 Acquiring J2EE Server Memory Dump

4.9.3 Acquiring the CORBA Naming Service Memory Dump

4.9.4 Notes on obtaining the memory dump

4.10 JavaVM log (JavaVM log file)

4.11 JavaVM Output Message Logs (Standard Output or Error Report File)

4.11.1 In Windows

4.11.2 In UNIX

4.12 OS Status Information and OS Logs

4.12.1 Acquiring the OS Status Information

4.12.2 Acquiring OS Logs

4.13 OS Statistical Information

4.13.1 In Windows

4.13.2 In UNIX

4.14 Application Server definition information

4.15 Contents of J2EE server or batch server working directory

4.16 Application Server Resource Setting Information

4.17 Web Server Logs

4.18 JavaVM stack trace information

4.19 Event log of the Explicit Heap Memory Management functionality

4.20 Information on the execution of the Component Container Administrator setup command (In UNIX)

5. Problem Analysis

5.1 Organization of this chapter

5.2 Application Server Log

5.2.1 Output Format and Output Items of the Hitachi Trace Common Library Format Log

5.2.2 Precautions to Be Taken When Referencing the Hitachi Trace Common Library Format Log

5.2.3 Output format and output items of access log of In-process HTTP Server

5.2.4 Output Format and Output Items of the Event Log (In Windows)

5.2.5 Output Format and Output Items of syslog (In UNIX)

5.3 EJB Client Application Log

5.4 Trace based performance analysis

5.5 JavaVM Thread Dump

5.6 JavaVM Garbage Collection Log

5.7 JavaVM log (JavaVM log file)

5.7.1 Options to output the JavaVM log file

5.7.2 Acquiring the extended verbosegc information

5.7.3 Contents of the code cache area-related log

5.8 Message log output by JavaVM (Standard output and error report file)

5.8.1 When a Signal Occurs

5.8.2 When C Heap Is Insufficient

5.8.3 When an Internal Error Occurs

5.8.4 When Thread Creation Fails

5.9 OS status information and OS log

5.10 JavaVM stack trace information

5.10.1 When the -XX:+HitachiLocalsInThrowable Option Is Specified

5.10.2 When the -XX:+HitachiLocalsInStackTrace Option Is Specified

5.11 Event log of Explicit Memory Management functionality

5.11.1 Output trigger of event log of the Explicit Heap Memory Management functionality

5.11.2 Confirmation method of event log of Explicit Heap Memory Management functionality

5.11.3 Contents output when output level is normal

5.11.4 Contents output when output level is verbose

5.11.5 Contents Output when Output Level is Debug

6. Troubleshooting Procedure

6.1 Organization of this chapter

6.2 List of main problems

6.3 Processes that output logs

6.4 Troubleshooting during setup

6.5 Troubleshooting during operations

6.6 Troubleshooting the server management commands

6.7 Examples of troubleshooting during operations

6.7.1 Troubleshooting when a process is down

6.7.2 Troubleshooting when a response is delayed

7. Performance Analysis by Using Trace based Performance Analysis

7.1 Organization of this chapter

7.2 Overview of the trace based performance analysis

7.2.1 Overview of the trace based performance analysis of Application Server

7.2.2 Overview of the trace based performance analysis of applications

7.3 Collecting the trace based performance analysis file by using Management Server

7.3.1 How to collect a trace based performance analysis file

7.3.2 Output Destination and Output Information of a trace based performance analysis file

7.3.3 Output information of the trace based performance analysis file (for the trace based performance analysis)

7.3.4 Output information of the trace based performance analysis file (for the user-extended trace based performance analysis)

7.4 Implementation for collection of root application information of trace based performance analysis

7.5 Settings of execution environment

7.5.1 Settings for using the trace based performance analysis

7.5.2 Settings for using the user-extended trace based performance analysis

7.5.3 Settings for the methods to be traced by the user-extended trace based performance analysis

7.6 Logs output when the user-extended trace based performance analysis is executed

7.7 Analysis operation of the processing performance by using the trace based performance analysis file

7.7.1 Overview of the Operation for Analyzing the Processing Performance

7.7.2 Analyzing the Response Time of a Web Server

7.7.3 Investigating the Processing Status of a Request in an Application Server

7.7.4 Investigating the Life Cycle of a Session

7.7.5 Identifying the Transaction in Which a Timeout Occurred

7.7.6 Identifying the Request for Which Timeout Occurred

7.7.7 Investigating the Log Using the Root Application Information

7.7.8 Identifying the Connection in Which an Error Occurred

7.7.9 Investigation about the location of the problem associated to the trace based performance analysis file and thread dump

7.8 Notes on using the user-extended trace based performance analysis

8. Trace Collection Points and PRF Trace Collection Levels of the Trace Based Performance Analysis

8.1 Organization of this chapter

8.2 Trace Get Point of trace based performance analysis and the PRF Trace Get Level

8.3 Trace collection points of a CTM

8.3.1 Trace collection points and PRF trace collection levels

8.3.2 Trace information that can be collected

8.4 Trace collection points of a redirector

8.4.1 Trace collection points and PRF trace collection levels

8.4.2 Trace information that can be collected

8.5 Trace collection points of a Web container (trace of request processing)

8.5.1 Trace Get Point and the PRF Trace Get Level

8.5.2 Trace information that can be collected

8.5.3 Trace collection points and PRF trace collection levels (when an in-process HTTP server is used)

8.5.4 Trace information that can be collected

8.6 Trace collection points of a Web container (session trace)

8.6.1 Trace Get Point and the PRF Trace Get Level (Session Trace)

8.6.2 Trace information that can be collected

8.7 Trace collection points of a Web container (filter trace)

8.7.1 Trace collection points of a Web container when the processing terminates normally (filter trace)

8.7.2 Trace collection points of a Web container when an exception occurs (filter trace)

8.8 Trace collection points of a Web container (trace of the database session failover functionality)

8.8.1 Trace collection points and trace information that can be collected during request processing for creating an HTTP session (Trace of the database session failover functionality)

8.8.2 Trace collection points and trace information that can be collected during request processing for updating an HTTP session (Trace of database session failover functionality)

8.8.3 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session (Trace of database session failover functionality)

8.8.4 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session through valid period monitoring (Trace of database session failover functionality)

8.9 Trace collection points of a Web container (Trace of the EADs session failover functionality)

8.9.1 Trace collection points and trace information that can be collected during request processing for creating an HTTP session (Trace of the EADs session failover functionality)

8.9.2 Trace collection points and trace information that can be collected during request processing for updating an HTTP session (Trace of the EADs session failover functionality)

8.9.3 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session (Trace of the EADs session failover functionality)

8.9.4 Trace collection points and trace information that can be collected when an EADs client is invoked (Trace of the EADs session failover functionality)

8.10 Trace collection points of a Web container (trace of the memory session failover functionality)

8.10.1 Trace collection points and PRF trace collection levels

8.10.2 Trace information that can be collected

8.11 Trace collection points of an EJB container

8.11.1 In the case of a Session Bean or Entity Bean

8.11.2 In the Case of Message-driven Bean (EJB2.0)

8.11.3 In the case of a Message-driven Bean (EJB2.1 and later)

8.11.4 For Timer Service

8.11.5 When the Session Bean is invoked asynchronously

8.11.6 When method cancellation occurs

8.12 Trace collection points of a JNDI

8.12.1 Trace Get Point and the PRF Trace Get Level

8.12.2 Trace information that can be collected

8.13 Trace collection points of a JTA

8.13.1 When a CMT and TransactionManager are used

8.13.2 When UserTransaction is used

8.13.3 In the case of a transaction timeout

8.13.4 When using the asynchronous concurrent processing for threads

8.14 Trace collection points of a DB Connector and JCA container

8.14.1 Connection-related trace collection points and trace information that can be collected

8.14.2 Trace collection points and trace information that can be collected when a local transaction is used

8.14.3 Trace collection points and trace information that can be collected when a connection association is used

8.14.4 Trace collection points and trace information that can be collected when the automatic connection close functionality is used

8.14.5 Trace collection points and trace information that can be collected in the case of linkage with the DB Connector for Cosminexus RM

8.14.6 Trace collection points and trace information that can be collected when work management is used

8.15 Trace collection points of an RMI

8.15.1 Trace get point and the PRF trace get level

8.15.2 Trace information that can be collected

8.16 Trace collection points of an OTS

8.16.1 Trace Get Point and the PRF Trace Get Level

8.16.2 Trace information that can be collected

8.17 Trace collection points of standard output, standard error output, and user log

8.17.1 Trace collection points of standard output or standard error output

8.17.2 Trace collection points of the user log

8.18 Trace collection points of a DI

8.18.1 Trace Get Point and the PRF Trace Get Level

8.18.2 Trace information that can be collected

8.19 Trace collection points of the batch application execution functionality

8.19.1 Trace Get Point and the PRF Trace Get Level

8.19.2 Trace information that can be collected

8.20 Trace collection points in a JPA

8.20.1 Trace collection points and trace information that can be collected when the persistent context of application management is used

8.20.2 Trace collection points and trace information that can be collected when the persistent context of container management is used

8.21 Trace collection points of the Cosminexus JPA provider

8.21.1 Trace collection points and trace information that can be collected during the acquisition or release processing of EntityManagerFactory

8.21.2 Trace collection points and trace information that can be collected during the acquisition processing of EntityManager

8.21.3 Trace collection points and trace information that can be collected during the operation of EntityManager

8.21.4 Trace collection points and trace information that can be collected during the release processing of EntityManager

8.21.5 Trace collection points and trace information that can be collected during the operation of Query

8.21.6 Trace collection points and trace information that can be collected during the operation of EntityTransaction

8.21.7 Trace collection points and trace information that can be collected in the case of callback method to the user

8.21.8 Trace collection points and trace information that can be collected during binary conversion of the entity class

8.21.9 Trace collection points and trace information that can be collected during transaction linkage with the transaction manager

8.21.10 Trace collection points and trace information that can be collected during the connection operation of the DB Connector

8.22 Trace collection points of the TP1 inbound integrated function

8.22.1 Trace collection points and PRF trace collection levels

8.22.2 Trace information that can be collected

8.23 Trace collection points of Cosminexus JMS Provider

8.23.1 Trace collection points of the JMS ConnectionFactory interface and the trace information that can be collected

8.23.2 Trace collection points of the JMS Connection interface and the trace information that can be collected

8.23.3 Trace collection points of the JMS session interface and the trace information that can be collected

8.23.4 Trace collection points of the JMS messages, producer, consumer, and queue browser and the trace information that can be collected

8.23.5 Trace collection points of CJMSP Broker when connecting to the CJMSP resource adapter and the trace information that can be collected

8.23.6 Trace collection points of the transaction management in the CJMSP resource adapter and trace information that can be collected

8.23.7 Trace collection points when Message-driven Bean is deployed from the CJMSP resource adapter and the trace information that can be collected

8.24 Trace collection points of JavaMail

8.24.1 Trace collection points of JavaMail transmission and the trace information that you can collect

8.24.2 Trace collection points on JavaMail receipt and the trace information that you can collect

8.25 Trace collection points of JSF

8.25.1 Trace collection points in the processing between JSF and Web container and the trace information that can be collected

8.25.2 Trace collection points in the processing between JSF and user applications

8.26 Trace collection points of CDI

8.26.1 Trace collection points of CDI and the trace information that can be collected

8.27 Trace collection points when a J2EE server is started or terminated

8.27.1 Trace Get Point and the PRF Trace Get Level

8.27.2 Trace information that can be collected

8.28 Trace collection points of an application

8.28.1 Trace collection points and PRF trace collection levels

8.28.2 Trace information that can be collected

9. Product JavaVM Functionality

9.1 Organization of this chapter

9.2 Overview of the product JavaVM functionality

9.3 Class-wise statistical functionality

9.3.1 Overview of the class-wise statistical functionality

9.3.2 Functionality that requires the class-wise statistical functionality

9.3.3 Outputting Statistic Information for Each Class

9.3.4 Precautions to output the class-wise statistical information

9.4 Instance statistical functionality

9.4.1 Overview of the instance statistical functionality

9.4.2 Class-wise statistical information output by the instance statistical functionality

9.5 STATIC member statistical functionality

9.5.1 Overview of the STATIC member statistical functionality

9.5.2 Class-wise statistical information output by the STATIC member statistical functionality

9.6 Reference-related information output functionality

9.6.1 Overview of the reference-related information output functionality

9.6.2 Class-wise statistical information output by the reference-related information output functionality

9.6.3 Class-wise statistical information output by the static field-based reference relationship output functionality

9.6.4 Notes for the output of the static field-based reference relationships

9.7 Pre-statistical garbage collection selection functionality

9.7.1 Overview of the pre-statistical garbage collection selection functionality

9.7.2 Guidelines for selecting the garbage collection

9.8 Unused objects statistical functionality in the Tenured area

9.8.1 Overview of the unused objects statistical functionality in the Tenured area

9.8.2 Class-wise statistical information output by the unused objects statistical functionality in the Tenured area

9.8.3 Notes for executing the unused objects statistical functionality in the Tenured area

9.9 Base object list output functionality for Tenured augmentation factors

9.9.1 Overview of the base object list output functionality for Tenured augmentation factors

9.9.2 Class-wise statistical information output by the base object list output functionality for Tenured augmentation factors

9.10 Class-wise statistical information analysis functionality

9.10.1 Overview of the class-wise statistical information analysis functionality

9.10.2 Output example of the class-wise statistical information analysis functionality

9.10.3 Notes for the class-wise statistical information analysis functionality

9.11 Tenuring distribution information output functionality of the Survivor area

9.11.1 Overview of the tenuring distribution information output functionality of the Survivor area

9.11.2 Output format and output example of the tenuring distribution information of the Survivor area

9.11.3 Settings for execution environment

9.11.4 Precautions when using tenuring distribution information output functionality of the Survivor area

9.12 hndlwrap functionality

9.12.1 Overview of the hndlwrap functionality

9.12.2 Notes for using the hndlwrap functionality

9.13 Functionality to set the upper limit of allocation size of C heap during JIT compilation

9.14 Functionality to set the upper limit of the number of threads

9.15 Notes on using the product JavaVM functionality (in UNIX)

10. Migrating from Application Server of Earlier Versions (In the J2EE Server Mode) (INTENTIONALLY DELETED)

10.1 (INTENTIONALLY DELETED)

11. Migrating to the Recommended Functionality

11.1 Migration from Microsoft IIS to Cosminexus HTTP Server

11.2 Migration to In-process Transaction Service

11.2.1 Migration flow

11.2.2 Migration of the operation

11.2.3 Migration of the acquisition method of the troubleshoot information

11.2.4 Program source code migration

11.3 Notes on migration to a database connection using HiRDB Type4 JDBC Driver

11.4 Migration to a database connection using Oracle JDBC Thin Driver from DABroker Library

Appendixes

A. List of Snapshot Logs to Be Collected

A.1 Overview of the list of the snapshot log to be collected

A.2 Cosminexus Component Container

A.3 Cosminexus Component Transaction Monitor

A.4 Cosminexus DABroker Library

A.5 Cosminexus Developer's Kit for Java

A.6 Cosminexus Performance Tracer

A.7 Cosminexus Web Services - Security

A.8 Cosminexus HTTP Server

A.9 Microsoft Internet Information Service

A.10 HCSC server

A.11 HCSC server (FTP receipt)

A.12 HCSC server (TP1 adapter)

A.13 HCSC server (File adapter)

A.14 HCSC server (Object Access adapter)

A.15 HCSC server (Message Queue adapter)

A.16 HCSC server (FTP adapter)

A.17 HCSC server (file operation adapter)

A.18 HCSC server (FTP inbound adapter)

A.19 HCSC server (mail adapter)

A.20 HCSC server (HTTP adapter)

A.21 Audit log

A.22 Other information

B. Identifying the Connection in which an Error Has Occurred When Connecting to a Database

B.1 Cosminexus Component Container

B.2 Cosminexus DABroker Library

B.3 HiRDB Client

B.4 HiRDB Server

B.5 Oracle Client

B.6 Oracle Server

C. Log Information Output for Each Functionality

C.1 Cosminexus JPA Provider operation log

D. Recovering Tables for a CMR When an Error Occurs

E. Main Functionality Changes in Each Version

E.1 Main functionality changes in 09-00

E.2 Main functionality changes in 08-70

E.3 Main functionality changes in 08-53

E.4 Main functionality changes in 08-50

E.5 Main functionality changes in 08-00

F. Glossary

Index

[Trademarks]

All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.

Notices

Relevant program products

See the manual uCosminexus Application Server Overview.

Export restrictions

If you export this product, please check all restrictions (for example, Japan's Foreign Exchange and Foreign Trade Law, and USA export control laws and regulations), and carry out all required procedures.
If you require more information or clarification, please contact your Hitachi sales representative.

Trademarks

Active Directory is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
AIX is a trademark of International Business Machines Corporation in the United States, other countries, or both.
AMD is a trademark of Advanced Micro Devices, Inc.
AX2000 is a product name of A10 Networks, Inc.
F5, F5 Networks, BIG-IP and iControl are trademarks or registered trademarks of F5 Networks, Inc. in the U.S. and certain other countries.
BSAFE is a registered trademark or a trademark of EMC Corporation in the United States and/or other countries.
CORBA is a registered trademark of Object Management Group, Inc. in the United States.
HP-UX is a product name of Hewlett-Packard Development Company, L.P. in the U.S. and other countries.
Intel is a trademark of Intel Corporation in the U.S. and/or other countries.
Internet Explorer is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
JBoss and Hibernate are the registered trademarks of Red Hat, Inc.
Linux(R) is the registered trademark of Linus Torvalds in the U.S. and other countries.
Microsoft is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
Microsoft Office and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Mozilla is a trademark of the Mozilla Foundation in the U.S and other countries.
OMG, CORBA, IIOP, UML, Unified Modeling Language, MDA, Model Driven Architecture are either registered trademarks or trademarks of Object Management Group, Inc. in the United States and/or other countries.
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Red Hat is a trademark or a registered trademark of Red Hat Inc. in the United States and/or other countries.
RSA is a registered trademark or a trademark of EMC Corporation in the United States and/or other countries.
SOAP is an XML-based protocol for sending messages and making remote procedure calls in a distributed environment.
SQL Server is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
UNIX is a registered trademark of The Open Group in the United States and other countries.
VMware and vCenter Server are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions.
Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Windows NT is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
X/Open is a registered trademark of The Open Group in the U.K. and other countries.
Eclipse is an open development platform for tools integration provided by Eclipse Foundation, Inc., an open source community for development tool providers.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
The other company names and product names are either trademarks or registered trademarks of the respective companies. Throughout this document Hitachi has attempted to distinguish trademarks from descriptive terms by writing the name with the capitalization used by the manufacturer, or by writing the name with initial capital letters. Hitachi cannot attest to the accuracy of this information. Use of a trademark in this document should not be regarded as affecting the validity of the trademark.

Microsoft product screen shots

Microsoft product screen shot(s) reprinted with permission from Microsoft Corporation.

Microsoft product name abbreviations

This manual uses the following abbreviations for Microsoft product names.

Abbreviation | Full name or meaning
Active Directory | Microsoft(R) Active Directory(R)
Excel | Microsoft(R) Excel
Microsoft(R) Office Excel
Internet Explorer | Microsoft(R) Internet Explorer(R)
Windows(R) Internet Explorer(R)
Microsoft IIS | Microsoft IIS 7.0 | Microsoft(R) Internet Information Services 7.0
Microsoft IIS 7.5 | Microsoft(R) Internet Information Services 7.5
SQL Server | SQL Server 2005 | Microsoft(R) SQL Server 2005
SQL Server 2008 | Microsoft(R) SQL Server 2008
Microsoft(R) SQL Server 2008 R2
SQL Server 2012 | Microsoft(R) SQL Server 2012
JDBC driver for SQL Server | SQL Server JDBC Driver | Microsoft(R) SQL Server JDBC Driver 3.0
Microsoft(R) JDBC Driver 4.0 for SQL Server
Windows | Windows Server 2008 | Windows Server 2008 x86 | Microsoft(R) Windows Server(R) 2008 Standard 32-bit
Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit
Windows Server 2008 x64 | Microsoft(R) Windows Server(R) 2008 Standard
Microsoft(R) Windows Server(R) 2008 Enterprise
Windows Server 2008 R2 | Microsoft(R) Windows Server(R) 2008 R2 Standard
Microsoft(R) Windows Server(R) 2008 R2 Enterprise
Microsoft(R) Windows Server(R) 2008 R2 Datacenter
Windows Server 2012 | Windows Server 2012 Standard | Microsoft(R) Windows Server(R) 2012 Standard
Windows Server 2012 Datacenter | Microsoft(R) Windows Server(R) 2012 Datacenter
Windows XP | Microsoft(R) Windows(R) XP Professional Operating System
Windows Vista | Windows Vista Business | Microsoft(R) Windows Vista(R) Business (32-bit)
Windows Vista Enterprise | Microsoft(R) Windows Vista(R) Enterprise (32-bit)
Windows Vista Ultimate | Microsoft(R) Windows Vista(R) Ultimate (32-bit)
Windows 7 | Windows 7 x86 | Microsoft(R) Windows(R) 7 Professional (32-bit)
Microsoft(R) Windows(R) 7 Enterprise (32-bit)
Microsoft(R) Windows(R) 7 Ultimate (32-bit)
Windows 7 x64 | Microsoft(R) Windows(R) 7 Professional (64-bit)
Microsoft(R) Windows(R) 7 Enterprise (64-bit)
Microsoft(R) Windows(R) 7 Ultimate (64-bit)
Windows 8 | Windows 8 x86 | Windows(R) 8 Pro (32-bit)
Windows(R) 8 Enterprise (32-bit)
Windows 8 x64 | Windows(R) 8 Pro (64-bit)
| Windows(R) 8 Enterprise (64-bit)
Windows Server Failover Cluster | Windows Server(R) Failover Cluster

Note that Windows 32 bit and Windows 64 bit are sometimes respectively referred to as Windows x86 and Windows x64.

Restrictions

Information in this document is subject to change without notice and does not represent a commitment on the part of Hitachi. The software described in this manual is furnished according to a license agreement with Hitachi. The license agreement contains all of the terms and conditions governing your use of the software and documentation, including all warranty rights, limitations of liability, and disclaimers of warranty.
Material contained in this document may describe Hitachi products not available or features not available in your country.
No part of this material may be reproduced in any form or by any means without permission in writing from the publisher.
Printed in Japan.

Issued

Aug. 2013: 3020-3-Y11-10(E)

Copyright

All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.

Summary of amendments

The following table lists changes in the manual 3020-3-Y11-10(E) for uCosminexus Application Server 09-50, uCosminexus Application Server(64) 09-50, uCosminexus Client 09-50, uCosminexus Developer 09-50, uCosminexus Service Architect 09-50, uCosminexus Service Platform 09-50, uCosminexus Service Platform(64) 09-50 and product changes related to the manual:

Changes
Location

The functionality has been added for collecting the definition sending data in the snapshotlog (snapshot log collection) command.
2.3, 2.3.3, 2.3.4, 2.4, 2.4.2, Appendix A

A description has been added for the output destination of the trace based performance analysis file.
2.3.2

A description has been added for the action to be taken when an error occurs using the EADs session failover functionality.
2.5.4

The description has been changed for the action to be taken when JavaVM terminates abnormally.
2.5.7

An example has been added for executing the cjdumpsv command to obtain the J2EE server thread dump when an error occurs in a Web server.
3.3.1(3)

A description has been added for the functionality for obtaining the user dump when the logical server is terminated forcefully in an environment set up with Management Server in Windows.
3.3.17

A description has been added for the execution information of the Component Container Administrator setup command (in UNIX).
4.20

An option (-XX:+JITCompilerContinuation) has been added as an option that can be specified for obtaining the JavaVM log, using the JIT compiler continuation functionality.
3.3.19, 4.10, 5.7.1

A description has been added for the Explicit memory block release ratio information to be output to the extended thread dump.
4.7.3, 5.5

A description has been added for the code cache area information to be output to JavaVM log files.
5.7.2, 5.7.3

A description has been added for the following items output to the event log of the Explicit Memory Management functionality:

User CPU time (User: <USERCPU> secs)

System CPU time (Sys: <SYSCPU> secs)

5.11.3

The following items has been added as the events triggering the output of the event log of the Explicit Memory Management functionality, and a description has been added for the content that is output:

Error in opening the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality

Error in the configuration file path of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality

5.11.1, 5.11.3

The following functionality have been added in the user-extended trace based performance analysis:

The trace target specification method can now be specified for packages or classes in addition to the usual trace target specification method for methods.

The range of available event IDs is expanded.

The restrictions on the number of lines that can be specified in the user-extended trace based performance analysis configuration file are relaxed.

The trace collection level can now be specified in the user-extended trace based performance analysis configuration file.

7.5.2, 7.5.3, 7.8, 8.28.1

The trace collection points of the EADs session failover functionality have been added to the trace collection points of the Web container that can be obtained with the trace based performance analysis.
8.9

The trace collection points when JavaMail is sent have been changed and added as follows:

The point immediately before the start of the issuing of the \r\n. command has been changed to the point immediately before the start of the issuing of the notification for the end of mail text transmission.

The point immediately after the starting of the issue of the STARTTLS command has been added.

8.24.1

The following points have been added to the trace collection points when JavaMail is received:

Immediately before the issuing of the CAPA command is started

Immediately after a response is received from the CAPA command

8.24.2

The reference relationship output functionality based on the static field has been added to the extended thread dump containing the class-wise statistical information.
9.6

A description has been added for the migration from DABroker Library to a database connection using Oracle JDBC Thin Driver.
11.4

The following files and directories have been added as the targets for snapshot log collection. Note that the text in the parentheses indicates the related targets and classification.

Configuration file for the CTM regulators (Component Transaction Monitor)

Configuration file for the OTM gateway (Component Transaction Monitor)

Directory to output the temporary PRF trace file (Component Container/Manager)

Explicit Memory Management functionality exclusion configuration file (Developer's Kit for Java)

Explicit Memory Management functionality non-exclusion configuration file (Developer's Kit for Java)

Directory to output the EADs client log for the EADs session failover functionality

EADs client message log for the EADs session failover functionality (Component Container)

EADs client communication trace for the EADs session failover functionality (Component Container)

EADs client maintenance log for the EADs session failover functionality (Component Container)

EADs client message dump for the EADs session failover functionality (Component Container)

Catalog files (Component Container/JAX-WS functionality of this product)

Operation log of the cjenvsetup command# (Component Container/Change CC Administrator command)

File configuration information before the cjenvsetup command is executed# (Component Container/Change CC Administrator command)

File configuration information after the cjenvsetup command is executed# (Component Container/Change CC Administrator command)

FTP adapter maintenance log (HCSC server/ FTP adapter)

#: Only in UNIX.
Appendix A.1, Appendix A.2, Appendix A.3, Appendix A.5, Appendix A.16

The information for the following files and directories for which the snapshot log was collected has been deleted. Note that the text in the parentheses indicates the related targets and classification.

All the Service Coordinator information (Component Container/Service Coordinator)

Redirector action definition file for IIS# (Component Container/Redirector (Web server))

Mapping definition file# (Component Container/Redirector (Web server))

#: Only in UNIX.
Appendix A.2

The information for the following files and directories for which the snapshot log was collected has been changed. Note that the text in the parentheses indicates the related targets and classification.

Process-wise action definition file (Component Container/JAX-WS functionality of this product)

web.xml (Component Container/ JAX-WS functionality of this product)

cosminexus-jaxws.xml (Component Container/JAX-WS functionality of this product)

Handler chain configuration file (Component Container/JAX-WS functionality of this product)

WSDL (Component Container/JAX-WS functionality of this product)

All the trace (HCSC server/file adapter)

FTP adapter protocol trace (HCSC server/FTP adapter)

Message log of the operating commands of the FTP adapter (HCSC server/FTP adapter)

Appendix A.2, Appendix A.13, Appendix A.16

Collection targets have been added for the snapshot log related to the information on the following HCSC servers:

HCSC server

HCSC server (FTP receiving)

HCSC server (File operation adapter)

HCSC server (FTP inbound adapter)

HCSC server (Mail adapter)

HCSC server (HTTP adapter)

Appendix A.10, Appendix A.11, Appendix A.17, Appendix A.18, Appendix A.19, Appendix A.20

The description of notes has been moved from Release Notes.
2.3, 2.3.2, 2.6.4, 3.3.5, 3.3.13, 3.3.17, 3.3.18, 4.3.1, 4.4.1, 4.7, 4.9.1, 4.9.4, 5.1, 5.2.5, 5.5, 7.3.3, 7.5.1, 8.23.4, 9.15, 10.3, 10.4.1, 10.4.2, 10.4.3, 10.4.5, 10.6, 10.9, 10.9.2

In addition to the above changes, minor editorial corrections have been made.

Preface

For details on the prerequisites before reading this manual, see the manual uCosminexus Application Server Overview.

Non-supported functionality

Some functionality described in this manual is not supported. Non-supported functionality includes:

Audit log functionality

Compatibility functionality

Cosminexus Component Transaction Monitor

Cosminexus DABroker Library

Cosminexus Reliable Messaging

Cosminexus TPBroker and VisiBroker

Cosminexus Web Service - Security

Cosminexus XML Security - Core functionality

JP1 linkage functionality

Management portal functionality

Migration functionality

SOAP applications complying with specifications other than JAX-WS 2.1

uCosminexus OpenTP1 linkage functionality

Virtualized system functionality

XML Processor high-speed parse support functionality

Non-supported compatibility functionality

"Compatibility functionality" in the above list refers to the following functionality:

Basic mode

Check of JSP source compliance (cjjsp2java) with JSP1.1 and JSP1.2 specifications

Database connection using Cosminexus DABroker Library

EJB client application log subdirectory exclusive mode

J2EE application test functionality

Memory session failover functionality

Servlet engine mode

Simple Web server functionality

Switching multiple existing execution environments

Using EJB 2.1 and Servlet 2.4 annotation

1. Application Server Functionality

This chapter describes classifications and purpose of the functionality of Application Server and manuals corresponding to the functionality. This chapter also describes the functionality that is changed in this version.

Organization of this chapter

1.1 Classifications of functionality

1.2 Functionality corresponding to the purpose of the system

1.3 Description of the functionality described in this manual

1.4 Main functionality changes in Application Server 09-50

1.1 Classifications of functionality

An Application Server is a product used for building an environment for executing applications mainly on a J2EE server compliant with Java EE 6 and for developing the applications that run in the execution environment. You can use a variety of functionality, such as functionality compliant with the Java EE standard specifications and functionality independently extended on Application Server. By selecting and using the functionality according to the purpose and intended use, you can build and operate a highly reliable system having an excellent processing performance.

The following are the broad classifications of Application Server functionality:

Functionality that serves as an execution platform for the applications

Functionality that is used for operating and maintaining the execution platform for the applications

The above-mentioned functionality can be further classified according to the positioning and the intended use of the functionality. Application Server manuals are provided according to the classification of the functionality.

The following figure shows the classification of the Application Server functionality and the set of manuals corresponding to the functionality.

Figure 1-1 Classificationof the Application Server functionality and the set of manuals corresponding to each functionality

#1

uCosminexus Application Server has been omitted from the manual names mentioned in the Manuals column.

#2

You can execute SOAP Web Services and RESTful Web Services with Application Server. Depending on the purpose, see the following manuals other than the uCosminexus Application Server Web Service Development Guide.

To develop and execute SOAP applications

uCosminexus Application Server SOAP Application Development Guide

To ensure security for SOAP Web Services and SOAP applications

uCosminexus Application Server XML Security - Core User Guide

uCosminexus Application Server Web Service Security Users Guide

To learn about XML processing in detail

uCosminexus Application Server XML Processor User Guide

The following subsections describe the classifications of functionality and the manuals corresponding to the functionality.

Organization of this section

1.1.1 Functionality as an application execution platform

1.1.2 Functionality for operating and maintaining the application execution platform

1.1.3 Functionality and corresponding manuals

1.1.1 Functionality as an application execution platform

This functionality works as a platform for executing online businesses and batch businesses implemented as the applications. You choose functionality that you want to use according to the intended use of a system and your requirements.

You must determine whether you want to use functionality that serves as the execution platform for the applications, even before you perform the system building or application development.

The following are the classification-wise descriptions of functionality that serve as the application execution platform:

Organization of this subsection

(1) Basic functionality to operate applications (basic development functions)

(2) Functionality for developing Web Services

(3) Application Server independent functionality extended for improving reliability and performance (expansion functionality)

(4) Functionality for ensuring the security of a system (security management functionality)

(1) Basic functionality to operate applications (basic development functions)

This functionality includes the basic functionality for operating applications (J2EE applications). This functionality is mainly the J2EE server functionality.

Application Server provides a Java EE 6-compliant J2EE server. The J2EE server provides functionality that is compliant with the standard specifications and is independent of Application Server.

The basic development functionality can be further classified into three types according to the types of the J2EE applications for which you use functionality. The manuals for Application Server function guide have been separated according to this classification.

The following is an overview of each classification:

Functionality for executing the Web applications (Web containers)
This classification includes the Web container functionality that serves as the execution platform for Web applications and functionality executed by linking the Web containers and the Web servers.

Functionality for executing the Enterprise Bean (EJB containers)
This classification includes the EJB container functionality that serves as a platform for executing Enterprise Beans. This classification also includes the EJB client functionality for invoking the Enterprise Beans.

Functions used in both Web applications and Enterprise Beans (Container common function)
This classification includes functionality that can be used in the Web applications and the Enterprise Beans running on the Web containers and the EJB containers respectively.

(2) Functionality for developing Web Services

This includes the functionality for the execution and development environment of Web Services.

The following engines are provided with Application Server:

JAX-WS engine that binds the SOAP messages in accordance with the JAX-WS specifications

JAX-RS engine that binds the RESTful HTTP messages in accordance with the JAX-RS specifications

(3) Application Server independent functionality extended for improving reliability and performance (expansion functionality)

This includes the functionality extended independently on Application Server. This also includes the functionality implemented by using non-J2EE server processes such as batch server, CTM, and database.

On Application Server, various functionality are extended to improve reliability of the system and to implement stable operations. Furthermore, functionality is also extended to operate applications other than J2EE applications (batch applications) in the Java environment.

(4) Functionality for ensuring the security of a system (security management functionality)

This is the functionality used for ensuring the security of an Application Server-based system. This includes functionality such as the authentication functionality used for preventing unauthorized access and the encryption functionality used for preventing information leakage from communication channels.

1.1.2 Functionality for operating and maintaining the application execution platform

This functionality is used for effectively operating and maintaining the application execution platform. You use this functionality, after starting the system operations, as and when required. However, depending on the functionality, you must implement the settings and applications in advance.

The following are the classification-wise descriptions of functionality used for operating and maintaining the application execution platform:

Organization of this subsection

(1) Functionality used for daily operations, such as starting and stopping the systems (operation functionality)

(2) Functionality for monitoring system usage (watch functionality)

(3) Functionality for operating the systems by linking with other products (linkage functionality)

(4) Functionality for troubleshooting (maintenance functionality)

(5) Functionality for migrating from products of earlier versions (migration functionality)

(6) Functionality for compatibility with products of earlier versions (compatibility functionality)

(1) Functionality used for daily operations, such as starting and stopping the systems (operation functionality)

This classification includes the functionality used in daily operations, such as starting or stopping systems, starting or stopping applications, and replacing the applications.

(2) Functionality for monitoring system usage (watch functionality)

This classification includes the functionality used for monitoring the system usage and resource depletion. This classification also includes functionality to output the information used in monitoring the system operation history.

(3) Functionality for operating the systems by linking with other products (linkage functionality)

This classification includes the functionality to be linked and implemented with other products, such as JP1 and cluster software.

(4) Functionality for troubleshooting (maintenance functionality)

This classification includes the functionality used for troubleshooting. This functionality also includes the functionality used to output the information that will be referenced during the troubleshooting.

(5) Functionality for migrating from products of earlier versions (migration functionality)

This classification includes the functionality used for migrating from an older Application Server to a new Application Server.

(6) Functionality for compatibility with products of earlier versions (compatibility functionality)

This classification includes the functionality used for compatibility with earlier versions of Application Server. For the compatibility functionality, we recommend the migration with the corresponding recommended functionality.

1.1.3 Functionality and corresponding manuals

The function guides for Application Server have been separated according to the classifications of functionality.

The following table describes the classifications of functionality and the manuals corresponding to the functionality.

Table 1-1 Classifications of functionality and corresponding manuals describing the functionality

Category | Functionality | Reference manual#1
Basic and Development functionality | Web container | Web Container Functionality Guide
Using JSF and JSTL
Web server linkage
In-process HTTP server
Servlet and JSP implementation
EJB container | EJB Container Functionality Guide
EJB client
Precautions during Enterprise Bean implementation
Naming management | Common Container Functionality Guide
Managing resource connection and transactions
Invoking Application Server from OpenTP1 (TP1 inbound integrated function)
Using JPA in Application Server
Cosminexus JPA Provider
Cosminexus JMS Provider
Using Java Mail
Using CDI with Application Server
Using Bean Validation with Application Server
Managing application attributes
Using annotations
Formatting and deploying J2EE applications
Container extension library
Extended functionality | Executing applications using the batch server | Expansion Guide
Scheduling and load balancing requests using CTM
Scheduling the batch applications
Inheriting the session information between the J2EE servers (Session failover functionality)
Database session failover functionality
EADs session failover functionality
Controlling full garbage collection using the explicit heap functionality
Output of the application user log
Asynchronous parallel processing of threads
Security management functionality | Authentication using integrated user management | Security Management Guide
Authentication using application settings
Using TLSv 1.2 for SSL/TLS communication
Controlling with the management functionality of load balancers that use API-based direct connections
Operation functionality | Starting and stopping the system | Operation, Monitoring, and Linkage Guide
Managing J2EE applications
Watch functionality | Monitoring statistics information (statistics collection functionality)
Monitoring resource depletion
Database audit trail linkage function
Output of statistical information by operation management command
Notification of management event and auto execution of process by management action
Statistics collection of CTM
Output of console log
Linkage functionality | Operation of systems linked with JP1
Centralized monitoring of system (Integrating with JP1/IM)
Automatic operations of systems by using jobs (integrating with JP1/AJS)
Collecting and consolidating the audit log (Integrating with JP1/Audit Management - Manager)
Linking with cluster software
1-to-1 node switching system (linking with cluster software)
Mutual node switching system (linking with cluster software)
Node switching system (integrating with cluster software) for host unit management model.
Maintenance functionality | Troubleshooting related functions | Maintenance and Migration Guide#2
Performance analysis using the trace based performance analysis
JavaVM functionality of the product (hereafter abbreviated as JavaVM)
Migration functionality | Migrating from an older version of Application Server
Migration to recommended functions
Compatibility functionality | Basic mode | Compatibility Guide
Servlet engine mode
Functionality for compatibility with the basic development functionality
Functionality for compatibility with the extended functionality

#1

uCosminexus Application Server has been omitted from the manual names.

#2

This manual.

1.2 Functionality corresponding to the purpose of the system

On Application Server, you must choose the applicable functionality according to the purpose of the system to be built and operated.

This section describes the cases in which the following functionality, described in this manual, can be used. The functionality is independently extended on Application Server:

Functionality for system maintenance

Functionality of JavaVM

Functionality for migrating from old version products

The functionality-wise support for the following items are described here:

Performance
This functionality is best used with a system that adds value to performance.
This functionality used for performance tuning of the system is included.

Operation and maintenance
This functionality is best used when efficient operation and maintenance is to be performed.

Others
This functionality is used for complying with other individual purposes.

Organization of this section

1.2.1 Functionality for system maintenance

1.2.2 JavaVM functionality of the product

1.2.3 Functionality for migrating from products of earlier versions

1.2.1 Functionality for system maintenance

The following table lists the functionality for system maintenance. Select the functionality according to the system purpose. For details on the functionality, see the Reference column in the following table.

Table 1-2 Functionality for system maintenance

Functionality | Purpose of the system | Reference
Performance | Operation and maintenance | Others
Troubleshooting | -- | Y | -- | 2, 3, 4, 5, 6
Performance analysis by using trace based performance analysis | Y | Y | -- | 7, 8

Legend:

Y: Applicable

--: Not applicable

1.2.2 JavaVM functionality of the product

The following table lists the JavaVM functionality of the product. Select the functionality according to the system purpose. For details on the functionality, see the Reference column in the following table.

Table 1-3 JavaVM functionality of the product

Functionality | Purpose of the system | Reference
Performance | Operation and maintenance | Others
Class-wise statistical functionality | Y | Y | -- | 9.3
Instance statistical functionality | Y | Y | -- | 9.4
STATIC member statistical functionality | Y | Y | -- | 9.5
Reference-related information output functionality | Y | Y | -- | 9.6
Pre-statistical garbage collection selection functionality | Y | Y | -- | 9.7
Unused objects statistical functionality for the Tenured area | Y | Y | -- | 9.8
Base object list output functionality for increase in the Tenured area | Y | Y | -- | 9.9
Class-wise statistical information analysis functionality | Y | Y | -- | 9.10
Tenuring distribution information output functionality of the Survivor area | Y | Y | -- | 9.11
hndlwrap functionality | -- | Y | -- | 9.12
Functionality to set the upper limit of the allocation size of C heap during JIT compilation | -- | Y | -- | 9.13
Functionality to set the upper limit of the number of threads | -- | Y | -- | 9.14

Legend:

Y: Applicable

--: Not applicable

1.2.3 Functionality for migrating from products of earlier versions

The following table lists the functionality for migrating from the products of earlier versions. Select the functionality according to the system purpose. For details on the functionality, see the Reference column in the following table.

Table 1-4 Functionality for migrating from products of earlier versions

Functionality | Purpose of the system | Reference
Performance | Operation and maintenance | Others
Migrating from Application Server of earlier versions | -- | -- | Y | 10
Migration from Microsoft IIS to Cosminexus HTTP Server | -- | -- | Y | 11.1
Migration to in-process transaction service | -- | -- | Y | 11.2

Legend:

Y: Applicable

--: Not applicable

1.3 Description of the functionality described in this manual

This section describes the meaning of the classifications used when describing the functionality in this manual, and also provides an example of the tables used for describing each classification.

Organization of this section

1.3.1 Meaning of classifications

1.3.2 Example of tables describing classifications

1.3.1 Meaning of classifications

The description of functionality in this manual is classified into the following five categories. You can select and read the required location depending on the purpose for referencing this manual.

Description
This is the description about the functionality. This section describes the purpose, features, and mechanism of the functionality. Read this section when you want an overview of the functionality.

Implementation
This section describes the methods such as the coding method and the DD writing method. Read this section when developing applications.

Settings
This section describes the required property settings for building systems. Read this section when building a system.

Operations
This section describes the operation method. This section describes the operating procedures and the execution examples of commands to be used. Read this section when operating a system.

Notes
This section describes the general precautions for using the functionality. Make sure that you read the notes.

1.3.2 Example of tables describing classifications

Tables are used to describe the classifications of the description of functionality. The title of each table is either "Organization of this chapter" or "Organization of this section".

The following is an example table describing the classification for the description of functionality.

Example of table describing the classification of functionality description

Table X-1 Organization of this chapter (XX functionality)

Category | Title | Reference
Description | What is the XX functionality | X.1
Execution | Execution of applications | X.2
Definitions in DD and cosminexus.xml# | X.3
Settings | Settings in the execution environment | X.4
Operations | Operations using the XX functionality | X.5
Notes | Precautions when using the XX functionality | X.6

#

For cosminexus.xml, see 11. Managing Application Attributes in the uCosminexus Application Server Common Container Functionality Guide.

Hint

Property settings for applications that do not contain cosminexus.xml

In applications that do not contain cosminexus.xml, you set or change the properties after importing the properties into the execution environment. You can also change the set properties in the execution environment.

You specify the application settings in the execution environment using the server management commands and the property files. For application settings using the server management commands and the property files, see 3.5.2 Procedure for setting J2EE application properties in the uCosminexus Application Server Application Setup Guide.

The tags specified in the property file correspond to the DD or cosminexus.xml. For details on the DD or cosminexus.xml and the property file tags, see 3. Property Files Used for Setting J2EE Applications in the uCosminexus Application Server Application and Resource Definition Reference Guide.

Note that the properties specified in each property file can also be specified in the HITACHI Application Integrated Property File.

1.4 Main functionality changes in Application Server 09-50

This section describes the main changes in the functionality of Application Server 09-50 and the purpose of each change.

The contents described in this section are as follows:

This section gives an overview and describes the main changes in the functionality of Application Server 09-50. For details on the functionality, see the description in the section column of the reference. The description of a particular functionality is mentioned in the section column or that reference.

uCosminexus Application Server is omitted from the manual names mentioned in the Reference location column.

Organization of this section

(1) Improving development productivity

(2) Simplifying implementation and setup

(3) Supporting standard and existing functionality

(4) Maintaining and improving reliability

(5) Maintaining and improving operability

(6) Other purposes

(1) Improving development productivity

The following table describes the items that are changed to improve development productivity.

Table 1-5 Changes made for improving development productivity

Item | Overview of changes | Reference manual | Reference location
Simplification of Eclipse setup | The GUI can now be used to set up the Eclipse environment. | Application Development Guide | 1.1.5, 2.4
Supporting debug using the user-extended trace based performance analysis | The user-extended trace based performance analysis configuration file can now be created in the development environment. | Application Development Guide | 1.1.3, 6.5

(2) Simplifying implementation and setup

The following table describes the items that are changed to simplify installation and setup.

Table 1-6 Changes made for simplifying implementation and setup

Item
Overview of changes
Reference manual
Reference

Expanding the system configuration patterns in a virtual environment
More tier types are now available in the virtual environment (http-tier, j2ee-tier, and ctm-tier). Due to this, the following system configuration patterns can now be set up:

Pattern of allocating the Web server and J2EE server on different hosts

Pattern of allocating the front end (servlets or JSPs) and back end (EJBs) separately

Pattern of using the CTM

Virtual System Setup and Operation Guide
1.1.2

(3) Supporting standard and existing functionality

The following table describes the items that are changed to support the standard and existing functionality.

Table 1-7 Changes made for supporting the standard and existing functionality

Item | Overview of changes | Reference manual | Reference
Supporting the JDBC 4.0 specifications | HiRDB Type4 JDBC Driver and SQL Server JDBC driver complying with the JDBC 4.0 specifications are now supported with DB Connector. | Common Container Functionality Guide | 3.6.3
Relaxation of the naming rules for the Portable Global JNDI names | The characters that can be used in the Portable Global JNDI names are added. | Common Container Functionality Guide | 2.4.3
Supporting the Servlet 3.0 specifications | The changes in the HTTP Cookie name and URL path parameter name in Servlet 3.0 can now also be used in Servlet 2.5 or earlier. | Web Container Functionality Guide | 2.7
Extended use of applications that can be integrated with Bean Validation | Bean Validation can now be used for validation in the CDI and user applications as well. | Common Container Functionality Guide | Chapter 10
Supporting JavaMail | The mail sending and receiving functionality using the JavaMail 1.4-compliant APIs is now available. | Common Container Functionality Guide | Chapter 8
Extended use of the OSs that can use the javacore command | The javacore command can now be used to obtain the Windows thread dump. | Command Reference Guide | javacore (Obtaining the thread dump/ in Windows)

(4) Maintaining and improving reliability

The following table describes the items that are changed for maintaining and improving reliability.

Table 1-8 Changes made for maintaining and improving reliability

Item
Overview of changes
Reference manual
Reference

Avoiding the depletion of the code cache area
The size of the code cache area used in the system can now be checked, and before the area is depleted, the threshold value can be changed to avoid the depletion of the area.
System Design Guide
7.1.2

This manual
5.7.2, 5.7.3

Definition Reference Guide
16.1, 16.2, 16.4

Supporting the efficient application of the Explicit Memory Management functionality
The functionality that can control the objects transferred to the Explicit heap is added as the functionality for reducing the automatic release processing time and applying the Explicit Memory Management functionality efficiently.

Functionality for controlling the transfer of objects to the Explicit memory block

Functionality for specifying the classes to be excluded from the Explicit Memory Management functionality

Output of the object release rate information in the Explicit heap information

System Design Guide
7.13.6

Expansion Guide
8.2.2, 8.6.5, 8.10, 8.13.1, 8.13.3

This manual
5.5

Expanding the range of the class-wise statistical information that is output
The static field-based reference relationships can now be output in the extended thread dump containing the class-wise statistical information.
This manual
9.6

(5) Maintaining and improving operability

The following table describes the items that are changed with the purpose of maintaining and improving operability.

Table 1-9 Changes made for maintaining and improving operability

Item | Overview of changes | Reference manual | Reference
Supporting the EADs session failover functionality | The EADs session failover functionality that implements the session failover functionality by integrating with the EADs is now supported. | Expansion Guide | Chapter 5, Chapter 7
Operations using WAR files | The WAR applications configured only with WAR files can now be deployed on the J2EE servers. | Web Container Functionality Guide | 2.2.1
Common Container Functionality Guide | 13.9
Command Reference Guide | cjimportwar (Importing WAR applications)
Starting and stopping the management functionality using synchronous execution | A synchronous execution option was added for starting and stopping the management functionality (Management Server and Administration Agent). | Operation, Monitoring, and Linkage Guide | 2.6.1, 2.6.2, 2.6.3, 2.6.4
Command Reference Guide | adminagentctl (Starting and stopping Administration Agent), mngautorun (Setting up and cancelling the settings for auto-start and auto-restart), mngsvrctl (Starting, stopping, and setting up Management Server)
Releasing the Explicit memory block forcefully with the Explicit Memory Management functionality | The release processing of the Explicit memory block can now be executed at any time with the javagc command. | Expansion Guide | 8.6.1, 8.9
Command Reference Guide | javagc (Forced garbage collection)

(6) Other purposes

The following table describes the items that are changed for other purposes.

Table 1-10 Changes due to other purposes

Item
Overview of changes
Reference manual
Reference

Obtaining the definition information
The snapshot (collecting the snapshot log) command can now be used to collect only the definition files.
This manual
2.3

Command Reference Guide
snapshotlog (Collecting the snapshot log)

Output of the cjenvsetup command log
The execution information for the Component Container Administrator setup (cjenvsetup command) is now output to the message log.
System Setup and Operation Guide
4.1.4

Maintenance and Migration Guide
4.20

Command Reference Guide
cjenvsetup (Setting up Component Container Administrator)

Supporting BIG-IP v11
BIG-IP v11 is now added to the available load balancer types.
System Setup and Operation Guide
4.7.2

Virtual System Setup and Operation Guide
2.1

Output of the CPU time to the event log of the Explicit Memory Management functionality
The CPU time taken for the Explicit memory block release processing is now output to the event log of the Explicit Memory Management functionality.
This manual
5.11.3

Extending the functionality of the user-extended trace based performance analysis
The following functionality is added in the user-extended trace based performance analysis:

The trace target specification method can now be specified for packages or classes in addition to the usual trace target specification method for methods.

The range of available event IDs is expanded.

The restrictions on the number of lines that can be specified in the user-extended trace based performance analysis configuration file are relaxed.

The trace collection level can now be specified in the user-extended trace based performance analysis configuration file.

This manual
7.5.2, 7.5.3, 8.28.1

Improving the analysis of information when the asynchronous Session Bean invocation is used
The root application information of the PRF trace can now be used to compare the invocation source and the invocation destination requests.
EJB Container Functionality Guide
2.17.3

2. Troubleshooting

The Application Server provides functionality to output various data that can be used for handling trouble that occurs during system operations. This chapter describes notes about the acquisition of troubleshooting data, the procedures for handling the data, and troubleshooting.

Organization of this chapter

2.1 Organization of this chapter

2.2 Overview of troubleshooting

2.3 Acquiring the Data

2.4 Types of Required Data

2.5 Troubleshooting and Recovery

2.6 Precautions Related to Troubleshooting

2.1 Organization of this chapter

This chapter gives an overview of the acquisition and the handling of data for troubleshooting.

If a failure occurs in the running system, it is necessary to collect the data for analysis purpose based on the type of the error that has occurred. The application server provides a function that outputs the log that can be used as data for maintaining the system.

The following table describes the organization of this chapter.

Table 2-1 Organization of this chapter (Troubleshooting (overview of data acquisition and handling))

Category | Title | Reference
Explanation | Overview of troubleshooting | 2.2
Acquiring the Data | 2.3
Types of Required Data | 2.4
Operation | Troubleshooting and Recovery | 2.5
Notes | Precautions Related to Troubleshooting | 2.6

For details about the data acquisition and output settings for troubleshooting, methods to output the data individually, the output destination and contents of the data, and the troubleshooting procedure, reference the following respective chapters:

Settings related to data acquisition and output
3. Preparing for Troubleshooting

Default output destination of data and methods to output data individually
4. Output Destinations and Output Methods of Data Required for Troubleshooting

Data Output Contents
5. Problem Analysis

Troubleshooting Procedure
6. Troubleshooting Procedure

2.2 Overview of troubleshooting

In component software, when an error occurs, the status of the software when the error occurs is output to the log as troubleshooting information. Collect and analyze this log and study the cause of error. You can even identify the location of error occurrence from the processing status of the request.

In a system built with the application server, you can collect the log and definition file together in the case of an error in the component software. This information is called snapshot log. The batch collection of a snapshot log is executed automatically, just before the logical server is terminated or the J2EE servers are restarted manually in a batch, in the management domain.

Moreover, when you use CTM, you can specify settings in the J2EE server so that when the J2EE server is terminated abnormally, the error is not returned to the client immediately. CTM locks and controls the scheduling queue of the J2EE application until the J2EE server is restarted. CTM maintains the registered requests and continues to accept requests from clients. As a result, if you restart the J2EE server immediately, you can continue with the operations without causing any trouble that the client might notice. Note that you can use CTM for the component software only with the product including Cosminexus Component Transaction Monitor. For details about the products that you can use, see 2.2.2 Component software functional guide in the manual uCosminexus Application Server Overview.

The following subsections describe the flow of data acquisition and handling when a trouble occurs.

Organization of this section

2.2.1 Overview of Troubleshooting

2.2.2 Flow of data acquisition when a trouble occurs

2.2.1 Overview of Troubleshooting

This subsection describes the procedure for dealing with problems that may occur during operation of an application server system.

Note that among the information to be acquired when a problem occurs, preparation before starting operation is required to acquire the information below.

JavaVM log (JavaVM log file)
The JavaVM garbage collection log is also output to this file.

User dump (in Windows)

core dump (in UNIX)

OS statistical information (in Windows)

Perform preparations to acquire the information as and when required during system configuration. For details, see 3.2 Overview of data acquisition settings and 3.3 Execution environment settings.

To deal with problems that occur during system operation, follow the procedure in the figure below. The following figure shows the flow of the process for dealing with the occurred problem.

Figure 2-1 Flow for handling of data when a trouble occurs

Acquiring data
Acquire all the required data for troubleshooting.
For details about the data to be acquired, see 2.4 Types of Required Data. Note that a memory dump is required only when restarting a J2EE Server or CORBA Naming Service.
Moreover, for details about methods of data acquisition, see 2.3 Acquiring the Data, or 4. Output Destinations and Output Methods of Data Required for Troubleshooting.

Reference note

You can acquire the data either collectively as a snapshot log or acquire individual logs.

You can acquire snapshot logs using the management command and with the automatic acquisition as per the settings.

You can automate the process of acquiring required data when an error occurs in the logical server. For details, see 2.3.1 Data That Can Be Acquired Automatically When a Problem Occurs.

Identify the cause of the problem (Primary distinction)
Identify the cause of the problem. Analyze the acquired data to identify the problem. For details about how to investigate data, see 5. Problem Analysis.

Troubleshooting and recovery
Troubleshoot the cause of the problem and perform recovery.
For details about dealing with each type of problem, see 2.5 Troubleshooting and Recovery.

Analyzing the cause of the problem (Secondary analysis)
Analyze the cause of a trouble, as and when required. Request that maintenance personnel further analyze the cause of the problem.

Hint

For details on the troubleshooting specific to the time at which a problem occurs, see 6. Troubleshooting Procedure.

2.2.2 Flow of data acquisition when a trouble occurs

You can acquire the data of troubleshooting automatically in the system built on the Application Server. When you start the logical server, the Administration Agent starts monitoring the logical server. If a failure occurs in the logical server, the Administration Agent detects the failure and notifies it to the Management Server. The Management Server gets and collects the log snapshot data, and stops and restarts the logical server.

The following figure shows the flow when the data is obtained automatically.

Figure 2-2 Flowfor automatic data acquisition

Using commands that are executed when an error is detected, mentioned in step 2, the information required for troubleshooting is output. Collect the information output by these commands and any other information that is required for troubleshooting in a compiled form as a snapshot log in step 3. Now, the snapshot log can also be collected without using the failure detection command, after the logical server is stopped in step 4. of the figure, but the information collected this time is that of J2EE server only. Hitachi, therefore, recommends that you use the failure detection command for collecting the snapshot log in step 3 of the figure. For details about the data acquisition using failure detection commands, see 2.3.2 Collecting the Material Using Commands during Error Detection and about snapshot log, see 2.3.3 Collecting the Snapshot Log.

You can also use the management command (mngsvrutil) of the Management Server to collect the snapshot log at any time. For details about collecting snapshot logs using the management command, see 2.3.3(4) Collecting snapshot logs using the management commands.

The processing flow when the process of the logical server is down or when the process of the logical server has hung up is as follows:

Organization of this subsection

(1) The processing flow when the process of logical server is down

(2) Processing flow when the logical server process hangs

(1) The processing flow when the process of logical server is down

After the logical server is started, the process monitoring of the Administration Agent periodically monitors the process by using the process ID of the logical server process. The following figure shows the processing flow when the logical server process is down.

Figure 2-3 The processing flow when the process of logical server is down

The process is monitored periodically by using the process ID of the logical server process.

If the logical server process ends abnormally, the Administration Agent detects that the process is down, and notifies it to the Management Server.
The existence of the process ID is checked during the monitoring of processes. The contents of this check differ according to the type of the logical server. For details, see 2.3.1 Logical Server Start and Recourse Information in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide and 2.3.2 Stop Logical Server in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

If the Management Server finds that the process is down, the failure detection command is executed and the snapshot log is collected.

The logical server restarts automatically after the execution of the failure detection command and the collection of snapshot log.

(2) Processing flow when the logical server process hangs

After the logical server starts, the process monitoring of the Administration Agent periodically checks for the logical server process that the logical server is running. The following figure shows the processing flow when the logical server process hangs up while checking the operation.

Figure 2-4 Processing flow when the logical server process hangs up

Check the operation of the logical server process periodically.
The operation is checked after the existence of the process ID is checked by the process monitoring. The contents of this check differ according to the type of the logical server.
For details, see 2.3.1 Logical Server Start and Recourse Information in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide and 2.3.2 Stop Logical Server in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

If the operation check fails twice consecutively (default value), the Administration Agent detects that the process has hung up and notifies it to the Management Server. You can change the number of failed attempts of the operation check before a process is determined as hung up.

If the Management Server detects that the process has hung up, it executes the failure detection command and collects the snapshot log.

The automatic stop process is executed because the process is still running when it is detected as hung up.

In the Administration Agent, execute the stop command of the logical server.
The force stop command is executed if the logical server does not stop even after a certain time period has elapsed.

The logical server restarts automatically after the execution of the failure detection command and the collection of snapshot log.

2.3 Acquiring the Data

You can acquire the data required for troubleshooting with any of the following methods:

Acquire automatically when a problem occurs

Acquire in a batch using the management command

Collect each information separately

The information required for troubleshooting can be collected by compiling it together as a snapshot log. The status, when a problem occurs in the component software in a system, is output to the snapshot log. In a system built with the Application Server, you can collect the snapshot log for each type of component software collectively and output as a log file in a ZIP format. Furthermore, the snapshot log can be acquired by dividing into primary delivery data and secondary delivery data. You can also use the snapshotlog command to collect the definition sending data.

This section describes the snapshot logs for data acquisition in a batch and the failure detection commands executed for data acquisition, as methods for data acquisition when a trouble occurs.

For details about the information that is not acquired as a snapshot log, see 2.4.3 Correspondence Between Acquisition Methods and Investigation Methods and for details about the methods for acquiring the respective information individually, see 4. Output Destinations and Output Methods of Data Required for Troubleshooting.

Note that you need to specify the settings in advance depending upon the data to be acquired. For example, the data such as OS statistics or user dump will not be obtained unless you specify the settings for acquiring this data when building the system. Hitachi recommends that you obtain this data because it is required for troubleshooting.

You can change the default settings to obtain the data such as the output destination of the log file, number of log files, and the maximum size of each file. Change the settings for acquiring data as per your requirements.

The data that cannot be collected as snapshot log as per the default settings, can be collected collectively in the form of a snapshot log by defining the get destination of the data as the target of snapshot log collection.

Note

Notes on data collection settings in Windows

With Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, and Windows Vista, you must specify the settings in the registry to obtain data for investigation when an error occurs. The registry settings affect the whole system, so take adequate precautions when you specify the settings.

Note that with Windows Vista without the service pack, you cannot obtain the data required for troubleshooting even if you specify the registry settings.

For details about the data acquisition settings required for troubleshooting, see 3. Preparing for Troubleshooting.

Organization of this section

2.3.1 Data That Can Be Acquired Automatically When a Problem Occurs

2.3.2 Collecting the Material Using Commands during Error Detection

2.3.3 Collecting the Snapshot Log

2.3.4 Location to store the acquired information

2.3.1 Data That Can Be Acquired Automatically When a Problem Occurs

In a system built with the application server, when a problem occurs in the logical server, you can automatically acquire and compile the information required for troubleshooting.

Hint

For automatic data acquisition when a trouble occurs, you must specify the settings required while building systems. For details about data acquisition settings for troubleshooting, see 3.2 Overview of data acquisition settings, and 3.3 Execution environment settings.

Except for the following information, you can make the specification so that you can automatically collect all the other information required for troubleshooting using the commands executed during error detection and by collecting the snapshot log.

OS statistical information (in Windows)

Use the following settings to collect the information that is not collected with default settings:

You use the commands created by the user to be executed when an error is detected to output the required information.

Add the output destination of the information output in 1. to the path of the snapshot log to be collected.
For details about the settings for the snapshot log acquisition, see 3.3.3 Settings for collecting snapshot logs (Systems for executing J2EE applications), or 3.3.4 Settings for collecting snapshot log (Systems for executing batch applications).

Note

Note that among the logs of the component software that can be acquired in the snapshot log, the acquisition of the logs shown in the following table is not explained in this manual. For details about methods to acquire these logs, see Reference manual of the following table.

Table 2-2 Component software for which the method of acquiring the logs is not mentioned in this manual

Log type | Reference | Section
SOAP application execution infrastructure log of Cosminexus Component Container | uCosminexus Application Server SOAP Application Development Guide | Chapter 14
Cosminexus Web Services - Security log | uCosminexus Application Server Web Service Security Setup Guide | Chapter 6
Cosminexus TPBroker log | TPBroker User's Guide

2.3.2 Collecting the Material Using Commands during Error Detection

The failure detection command is executed by the system when the Management Server detects the logical server failure. To execute the error detection command, specify the values in the keys of mserver.properties (Management Server environment configuration file) during system setup.

Note

If a logical server process terminates abnormally when Administration Agent is not running, the error detection command is not executed even if you start Administration Agent later. In such cases, when Administration Agent starts, the KEOS20071-E message with details "The command is not defined." is output. For details on the message, see the manual uCosminexus Application Server Messages.

You can use the failure detection command to execute the process for acquiring the thread dump and the user dump when a failure occurs, and obtain the error data quickly. Moreover, if you use the failure detection command, you can also automatically collect the snapshot log at any of the following timing. Decide the acquisition time according to the settings.

If a failure occurs in the logical server, the failure detection command is executed and the snapshot log is collected before the logical server is stopped.

If a failure occurs in the J2EE server or batch server, the failure detection command is executed and the snapshot log is collected before the J2EE server or batch server is restarted.

There are two types of failure detection commands; the failure detection command provided by the system and the failure detection command created by the user.

Failure detection command provided by the system

This command is already defined in the application server. When a failure occurs in the logical server, the failure detection command provided by the system obtains the information such as the thread dump and the trace based performance analysis of JavaVM of the logical server in which the failure occurred. The data obtained by using the failure detection command provided by the system can be collected as the snapshot log.

According to the default settings, the failure detection command provided by the system is executed when a failure occurs in the logical server and the snapshot log is collected before the logical server in which the error occurred is stopped.

Failure detection command created by the user

A failure detection command can also be created by the user. A batch file or shell script, in which the required process is described by the user for acquiring the data, can be executed as the failure detection command.

To collect the data obtained by using the failure detection command created by the user, as the snapshot log, you need to pre-define the get destination of the data as the collection destination of the snapshot log.

For details about changing the operation settings of commands provided by the system during failure detection or for settings required for commands created by the user during failure detection, see 3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications) or 3.3.2 Data acquisition settings using failure detection time commands (Systems for executing batch applications).

Hint

If the necessary settings are not performed when configuring a system, commands during error detection are not executed. Confirm the following settings:

When true is set in the com.cosminexus.mngsvr.sys_cmd.abnormal_end.enabled key of mserver.properties (Management Server environment settings file), commands during error detection provided by the system are executed..

When true is set in the com.cosminexus.mngsvr.usr_cmd.abnormal_end.enabled key of mserver.properties (Management Server environment settings file), commands created by the user are executed when an error is detected.

The information that can be acquired by each type of the above-mentioned command is described below.

Organization of this subsection

(1) Information that can be acquired by executing the failure detection time commands provided by the system

(2) Information that can be acquired by executing the commands during error detection created by the user

(1) Information that can be acquired by executing the failure detection time commands provided by the system

The following table describes information that can be acquired by executing the commands during error detection provided by the system. The information that can be acquired by executing the commands during error detection differs, depending on the type of error (system down or hang-up) and the OS used.

Note that it is necessary to perform the required settings in adminagent.properties (Administration agent property file) to acquire this information in the snapshot log.

The following table describes the information that can be acquired by executing the commands during error detection.

Table 2-3 Information that can be acquired by command during failure detection

Logical server
OS
Information that you can acquire
J2EE Application
Batch Application

When process down is detected
When hang up is detected

Logical performance tracer
Windows
UNIX

PRF trace file where the buffer contents are output

--
Y
Y

Logical J2EE server#
Windows

Trace based performance analysis file

Thread dump

Trace based performance analysis file

Y
Y

UNIX

Stack trace information of JavaVM

Trace based performance analysis file

Thread dump

Trace based performance analysis file

Y
Y

Logical SFO server (compatibility function)
Windows

Trace based performance analysis file

Thread dump

Trace based performance analysis file

Y
--

UNIX

Stack trace information of JavaVM

Trace based performance analysis file

Thread dump

Trace based performance analysis file

Y
--

Logical Web server
Windows
UNIX

Trace based performance analysis file

Internal trace

Trace based performance analysis file

Y
--

Other logical servers
Windows
UNIX

Trace based performance analysis file

Trace based performance analysis file

Y
--

Legend:

J2EE application: System for executing a J2EE application.

Batch application: System for executing a batch application.

--: Not applicable.

Y: Can be acquired.

#

Define a batch server as a logical J2EE server.

Thread dump of a J2EE server, an SFO server or a batch server where the problem occurred
You can acquire a Thread dump when true is set in the adminagent.j2ee.sys_cmd.abnormal_end.threaddump key of adminagent.properties (Administration agent property file).

Trace based performance analysis
You can acquire the trace based performance analysis when true is set in the adminagent.sys_cmd.abnormal_end.prftrace key of adminagent.properties (Administration agent property file). The trace based performance analysis file is output to Application-Server-installation-directory/manager/tmp. Note that you can change the output destination with the adminagent.prftrace_dir key in adminagent.properties (Administration Agent property file).

Note

A Thread dump is not output when it is determined that the J2EE server or SFO server process where the problem occurred does not exist. Moreover, the trace based performance analysis is not output when it is determined that the performance tracer process does not exist.

(2) Information that can be acquired by executing the commands during error detection created by the user

You can execute batch files or shell scripts in which any process required for acquiring the data is coded, as the user created commands during error detection. For example, you can acquire a user dump or core dump by executing a command such as the drwtsn32 command in this command. For details about how to create failure detection time commands, see 3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications) or 3.3.2 Data acquisition settings using failure detection time commands (Systems for executing batch applications).

Note that the command during error detection created by the user is executed if the adminagent.serverkind.usr_cmd.abnormal_end key of adminagent.properties (Administration agent property file) is specified.

2.3.3 Collecting the Snapshot Log

The log in which the status of the system when failure occurred is output by the component software of the system is called the snapshot log. The snapshot log contains the thread dump, trace based performance analysis, information necessary for system maintenance, and the information necessary for application maintenance and so on, in addition to the logs of the different types of component software. In a system built with the application server, this information can be collected together in the form of snapshot log and obtained as a log file in the ZIP format. The administrator can counter the errors by collecting and analyzing the snapshot log.

The settings are specified in such a way that the data necessary for troubleshooting is automatically collected by executing the failure detection command and collecting the snapshot log. To get the information not collected as per the default settings, in the form of the snapshot log, define the get destination of the data as the collection target of snapshot log. For details on the information that is not collected by default, see the description on the collectability of the snapshot log and the changing of collection-related settings in Appendix A List of Snapshot Logs to Be Collected.

You can change the settings for the target of snapshot log collection, output destination directory, and the number of files, when building the system.

This subsection describes about the timing for collecting snapshot logs, the data that you can collect, and the flow of collection. Also, this subsection describes about collecting snapshot logs by using management commands as a way of collecting the snapshot logs at any time. Note that for the settings of snapshot log collection, see 3.3.3 Settings for collecting snapshot logs (Systems for executing J2EE applications) or 3.3.4 Settings for collecting snapshot log (Systems for executing batch applications).

Organization of this subsection

(1) Timing for collecting snapshot logs

(2) Data that can be collected as snapshot log

(3) Flow of snapshot log collection

(4) Collecting snapshot logs using the management commands

(1) Timing for collecting snapshot logs

You can collect snapshot logs automatically or at a specific timing. The following table describes the timing for the collection of the snapshot log. Note that you can collect the snapshot logs in the host on which a logical server is running.

Table 2-4 Timing for collecting the snapshot log

Category | Collection timing
Collect automatically#1 | Immediately before the logical server stops automatically due to an error#2
Just before automatically restarting the J2EE server or the batch server managed in the management domain#2
Immediately before the J2EE server or batch server is restarted manually in a batch
Collect at the specified timing | When the management command (mngsvrutil) of the Management Server is executed to collect the snapshot log( For the execution method, see (4) Collecting snapshot logs using the management commands)

#1

When building a system you can change the settings for collecting snapshot logs at any of the following timings According to the default settings, the snapshot log is collected when the logical server stops.

- Before terminating the logical server

- Before restarting the J2EE server

#2

The Management Server executes the failure detection command for collecting the snapshot log at this time.

Reference note

You can collect the snapshot log at following timings:

When Collect button in Snapshot Log window in Start/Stop Logical Server of Management Portal is clicked#1

Executing the Snapshotlog command #2

#1

You can collect snapshot logs on a J2EE server or a batch server on which the collection procedure is executed.

#2

You can execute the command irrespective of whether Management Server is used.

For the snapshot log window, see 11.10.5 Collecting snapshot log of a J2EE server in the uCosminexus Application Server Management Portal Operation Guide. For the snapshotlog command, see snapshotlog (collecting snapshot logs) in the uCosminexus Application Server Command Reference Guide.

(2) Data that can be collected as snapshot log

This section describes the data that you can collect as a snapshot log. The snapshot log includes the information required for system maintenance and application maintenance.

The data required for troubleshooting is classified as primary delivery data and secondary delivery data depending on the timing at which the data is delivered to the maintenance service. You can collect the primary delivery data and the secondary delivery data in snapshot logs. You can also use the snapshotlog command to collect the definition sending data.

Primary delivery data
Material that is of a file size that can be sent as an attachment to mail. You can send the data immediately to the maintenance service by using mail.

Secondary delivery data
In addition to the primary delivery data, comparatively large size files are applicable. You must send large files separately to the maintenance service, since sending of large files takes more time than usual.

Definition sending data
The data that collects only the definition files to investigate the errors in the definition file settings. The file is small and can be sent quickly to the maintenance personnel through a mail. Note that you can also collect this data by using the snapshotlog command even if Management Server and the J2EE server are not running.

Note

The definition information collected in the definition sending data might include the user ID and password.

The data to be collected as snapshot log can be changed with the settings of the snapshot log collection target definition files. For example, if you want to collect the information output by a command during error detection created by the user and if the settings are changed, such information will be added to the information to be collected. The snapshot log collection target definition file is set during system configuration.

You can confirm which information will be actually collected in the real environment from the following files:

snapshotlog.conf
The contents to be acquired as the primary delivery data are defined in this file.
The location for storing snapshotlog.conf is as follows:

In Windows
Application-Server-installation-directory\manager\config\snapshotlog.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.conf

snapshotlog.2.conf
The contents that are to be acquired as the secondary delivery data are defined in this file.
The location for storing snapshotlog.2.conf is as follows:

In Windows
Application-Server-installation-directory\manager\config\snapshotlog.2.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.2.conf

However, depending on how the file is specified in adminagent.properties (administration agent property file), there are cases when the information that can be collected differs.

snapshotlog.param.conf
This file defines the content to be obtained as the definition sending data.
The location for storing snapshotlog.param.conf is as follows:

In Windows
Application-Server-installation-directory\manager\config\snapshotlog.param.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.param.conf

For default settings, when a problem occurs the snapshot log acquired automatically includes the following information:

Primary delivery data

Information under the directory defined to collect the primary delivery data for the snapshot log#1

Thread dump of a J2EE server and SFO server#2

Installation information

OS status log

Secondary delivery data

Trace based performance analysis#2

Information under the directory defined to collect the secondary delivery data for the snapshot log#1

Installation information

OS status log

#1

For details about the snapshot logs to be collected, see Appendix A. List of Snapshot Logs to Be Collected.

#2

You can collect this information when the settings are set to output a thread dump and trace based performance analysis by using the system provided commands that are to be executed when an error is detected.

An example of the information that can be collected by default and information that cannot be collected by default is as follows:

Information that can be collected by default

An example of the information that can be collected by default is as follows:

Information required for application maintenance

The message log and user log of Cosminexus Component Container are collected as the information required for application maintenance.

Cosminexus Component Container#

Cosminexus Component Transaction Monitor

Cosminexus Developer's Kit for Java

Cosminexus Performance Tracer

Cosminexus TPBroker

Cosminexus Web Services - Security

Cosminexus HTTP Server

Other than the above, Hitachi Trace Common Library log and program product information (in UNIX) are also collected.

# Also includes the SOAP application execution infrastructure information.

Information required for application maintenance

The message log and user log of Cosminexus Component Container are collected as the information required for application maintenance.

The following information is also collected by default:

Component Container-related information

In Windows

All the items beneath Application-Server-installation-directory\CC\server\public

In UNIX

All the items beneath /opt/Cosminexus/CC/server/public

Note that the default directories created when installing the component software are defined as the collection target for the snapshot log by default. Always change the collection destination when changing the log output destination.

Information that cannot be collected by default

The information described below cannot be collected when operating with default settings. Perform the settings in such a way so that you can collect the information as and when required.

In Windows

Cosminexus Component Container

EAR/JAR file (if it cannot be deployed or imported)

Microsoft IIS

The following data is acquired when integrated with Microsoft IIS.

C:\inetpub\logs (Specify the system drive in place of C:)

OS

Set of the data related to the system monitor (see subsection 4.13)

Event log (application, system)

OS operation data
From the winmsd start-up window, extract the data from the Operation-Save As Text File menu (It may take 5 to 10 minutes).

In UNIX

Cosminexus Component Container

EAR/JAR file (if it cannot be deployed or imported)

OS

OS operation data

(3) Flow of snapshot log collection

If trouble occurs on the logical server, a snapshot log collection service request is executed from Management Server for Administration Agent. The procedure of the process that is executed during snapshot log collection is as follows. Note that the executed process differs according to the settings.

Executing the failure detection command provided by the system

Executing the failure detection command created by a user

Collecting snapshot logs (primary delivery data)

Collecting snapshot logs (secondary delivery data)

Collection of snapshot logs might take more time than usual depending on the operating environment of the machine and status of failure occurrence (such as the status in which an unexpected error occurred). Therefore, you can set respective timeouts for these processes.

Note that you set a timeout for collection of snapshot logs in cases such as when excessive time is consumed for collecting snapshot logs due to the occurrence of an unexpected failure and the logical server is expected to be restarted on priority. If a timeout is set when collecting snapshot logs, the collection process is suspended forcefully and the information required for trouble shooting cannot be acquired.

(4) Collecting snapshot logs using the management commands

You can use the management command (mngsvrutil) to collect the snapshot log at any time, in addition to automatic collection.

Note that the type of information that can be acquired is the same as the snapshot log that is collected automatically in the case of problems. See (2) Data that can be collected as snapshot log.

For details about the log output destinations, see the value of adminagent.snapshotlog.log_dir key of adminagent.properties file (Administration Agent property file). The default output destination is the following directory.

In Windows
Log-output-directory-of-Manager\snapshot

In UNIX
Log-output-directory-of-Manager/snapshot

For collecting the snapshot log, specify the subcommand collect in the management command mngsvrutil and then execute. You can collect the snapshot log from the host specified with -t option.

The execution format and an example of executing the command are described below. In this example, collect both the primary delivery file and the secondary delivery file. In n, specify whether to collect the primary delivery data or secondary delivery data.

Execution format

mngsvrutil -m Management-Server-host-name[:Port number]-u Management-user-ID -p Management-password -t host-name -k host collect snapshot n

Execution example

mngsvrutil -m mnghost -u user01 -p pw1 -t host01 -k host collect snapshot 1
mngsvrutil -m mnghost -u user01 -p pw1 -t host01 -k host collect snapshot 2

2.3.4 Location to store the acquired information

The information acquired automatically by collecting the snapshot log is saved with the following names under the directory specified in the adminagent.snapshotlog.log_dir key of adminagent.properties (Administration agent property file).

File collected as the primary delivery data
snapshot-host name#1-log-yyyyMMddHHmmss#2.zip

File collected as the secondary delivery data
snapshot-host name#1-log-yyyyMMddHHmmss#2.2.zip

Note: The definition sending data is not collected.

#1 When a logical server is specified and the snapshot log is collected, the name of that logical server will be the host name.

#2 yyyy: year MM: month dd: day HH: hour mm: minutes ss: seconds

Note that the default output directory is as follows:

In Windows
Log-output-directory-of-Manager\snapshot

In UNIX
Log-output-directory-of-Manager/snapshot

Reference note

The list of files to be collected as the snapshot log and the list of files actually collected can be confirmed from the following files. These files are in the archived zip file.

List of files to be collected
snapshot-host-name-log-yyyyMMddHHmmss#/filelist_pre.txt
snapshot-host-name-log-yyyyMMddHHmmss#.2/filelist_pre.txt

List of files actually collected
snapshot-host-name-log-yyyyMMddHHmmss#/filelist_post.txt
snapshot-host-name-log-yyyyMMddHHmmss#.2/filelist_post.txt

# yyyy: year MM: month dd: day HH: hour mm: minutes ss: seconds

2.4 Types of Required Data

This section describes the type of a trouble that might occur in a system of the Application Server and the data required according to the trouble.

The troubleshooting data differs depending upon the type of failure that occurs. For example, the troubleshooting data differs depending upon whether an error message is output, or whether the server process of the application server ended abnormally.

Moreover, you need to contact the maintenance personnel depending upon the type of failure. Maintenance personnel refers to the person you need to contact as per the purchase contract.

Problems for which you need to contact maintenance personnel

"Contact maintenance personnel" is mentioned in the action for the output error message

The cause of the error is not known

The action corresponding to the error message cannot be performed

When you contact maintenance personnel, report the following information as accurately as possible:

Error occurrence time

Operations performed just before the error occurred

Window operations when the error occurred

Data acquired when the error occurred

The troubleshooting data is classified into the primary data, secondary data, and definition sending data according to the time at which the data is sent to the maintenance personnel.

Data to be sent immediately through e-mail (Primary delivery data and Definition sending data)
Includes the data of the file size that you can attach and send by e-mail. It can be sent to the maintenance personnel quickly by e-mail.
For example, the following data can be obtained in the form of primary delivery data:

Message log
The status and the error information of the J2EE server, and so on, is output in the message log.

User log
The information of the standard output and the standard error output in the application is output in the user log.

Exception log
The exception information when the error occurred in the system is output in the exception log.

Maintenance log
The failure maintenance information when the error occurred in the system is output in the maintenance log. The maintenance personnel use this information for analyzing the failure.

Also, only the collected definition file information is output as the definition sending data. This information is used to investigate the definition errors.

Data to be sent separately (Secondary delivery data)
This is applicable to the data that you need to send separately without using mail because the file sizes are relatively large and it will take time to send the files to maintenance personnel. Note that secondary delivery data contains primary delivery data.
For example, the following data can be obtained in the form of secondary delivery data.

Trace based performance analysis
The trace information that is output in one cycle of processing of the request is output in the trace based performance analysis.

Memory dump
The memory image of the process is output in the memory dump.

Organization of this section

2.4.1 Trouble types and the required data

2.4.2 List of Required Data to Be Acquired

2.4.3 Correspondence Between Acquisition Methods and Investigation Methods

2.4.1 Trouble types and the required data

Types of problems that can occur in an application server system are as follows:

Error message output
Error messages are output.

System down
The server process of the application server terminates abnormally.

Hang-up (No response)
There is no response to an application call.

Slow down
There is a response to an application call but the response time is excessive.

The following table describes the data to be acquired for each type of problem.

Table 2-5 List of data to be acquired for each type of problem

Item No. | Type of material | Problem type
Error message output | System down | Hang-up (No response) | Slow down
1 | Message log#1 | Y | Y | Y | Y
2 | User log#1 | Y | Y | Y | Y
3 | Exception log#1 | Y | Y | Y | Y
4 | Maintenance log#1 | Y | Y | Y | Y
5 | Trace based performance analysis | Y | Y | Y | Y
6 | Thread dumps of JavaVM | Y | Y | Y | Y
7 | Garbage collection logs of JavaVM | P | Y | Y | Y
8 | Memory dump | -- | Y | Y | Y
9 | JavaVM log file#2 | -- | Y | Y | Y
10 | Error report files | -- | Y | -- | --
11 | OS state or log | Y | Y | Y | Y
12 | Statistical information of OS | P | Y | Y | Y
13 | Definition information | Y | Y | Y | Y
14 | Operation directory#4 | P | P | P | P
15 | Resource setting | Y | Y | Y | Y
16 | Web server log | Y | Y | Y | Y
17 | JavaVM stack trace#3 | -- | Y | -- | --
18 | Event log of the Explicit Heap Memory Management functionality of JavaVM#2 | -- | Y | Y | Y

Legend:

Y: Required

P: Whether to be acquired depends on the actual error contents

--: Do not acquire

#1

Log output by the Application Server component software.

#2

Output when JavaVM start option is specified. For details about acquisition options, see 4.10 JavaVM Log (JavaVM Log File). For details about options, see 16. JavaVM Start Options in the uCosminexus Application Server Definition Reference Guide.

#3

Output only when using UNIX.

#4

The default working directories are Application-Server-installation-directory\CC\server\public (in Windows), or /opt/Cosminexus/CC/server/public (in UNIX).

2.4.2 List of Required Data to Be Acquired

The following table describes a list of data required for troubleshooting in the application server. Moreover, the same table also describes the timing to send the data to maintenance personnel when required.

Table 2-6 List for data acquisition

Item No. | Type of material | Description | Delivery timing
1 | Message log#1 | The status and the error information of the J2EE server, and so on, is output in the message log. | Primary/ Secondary
2 | User log#1 | The information of the standard output and the standard error output in the application is output in the user log. | Primary
3 | Exception log#1 | The exception information when the error occurred in the system is output in the exception log. | Primary
4 | Maintenance log#1 | The failure maintenance information when the error occurred in the system is output in the maintenance log. The maintenance personnel use this information for analyzing the failure. | Primary/ Secondary
5 | Trace based performance analysis | The trace information that is output in one cycle of processing of the request is output in the trace based performance analysis. | Secondary
6 | Thread dumps of JavaVM | Outputs the JavaVM operation information and thread stack status. | Primary
7 | Garbage collection logs of JavaVM | Outputs the activity status of JavaVM garbage collection. | Primary
8 | Memory dump | The memory image of the process is output in the memory dump. | Secondary
9 | JavaVM log file#2 | Outputs the JavaVM log provided with Cosminexus Developer Kit for Java. | Primary
10 | Error report files | A log file output when you stop the JavaVM. | Primary
11 | OS state or log | A record of the OS operation information. | Primary/ Secondary
12 | Statistical information of OS | A record of the OS statistical information. | Primary
13 | Definition information | Definition information of various types of the application server settings. | Primary/ Definition
14 | Operation directory | A directory that stores the work file during the application server operation. | Primary/ Secondary/ Definition
15 | Resource setting | The information of settings of resources used in the application server (data source, resource adapter). | Secondary/ Definition
16 | Web server log | Log of Cosminexus HTTP Server, Microsoft IIS. | Primary/ Secondary
17 | JavaVM stack trace#3 | The information used for cause investigation if JavaVM terminates abnormally. | Primary/ Secondary
18 | Event log of the Explicit Heap Memory Management functionality of JavaVM#2 | Information of an event (initialization of Explicit memory block, object creation to Explicit memory block, release process of Explicit memory block) occurred due to the Explicit Heap Memory Management functionality will be output. | Primary

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

#1

Log output by the Application Server component software.

#2

Output when JavaVM start option is specified. For details about acquisition options, see 4.10 JavaVM Log (JavaVM Log File). For details about options, see 16. JavaVM Start Options in the uCosminexus Application Server Definition Reference Guide.

#3

Output only when using UNIX.

A log file is created automatically in the directory specified in the environment settings file of each component software. A serial number from 1 to the number of specified log files is attached to the file name. When the size of the log file reaches its maximum size for one file, the output destination switches to the next log file. After the number of specified log files are output, the log is output once again to the log file with the number of the file name as 1. Note that there are times when the file size of the log file may slightly increase as compared to the size specified in the environment settings file to ensure that one record of a log file is output without a break. The maximum length of one record is about 4 KB.

2.4.3 Correspondence Between Acquisition Methods and Investigation Methods

This section describes the reference destination of methods for acquiring and investigating the required data to be acquired. Moreover, this section also describes the types of information that can be acquired as a snapshot log.

Table 2-7 Reference destination of methods for acquiring and investigating the required data to be acquired

Item No. | Type of material | Possibility of acquiring in snapshot log with default settings#1 | Reference
Individual collection method | Investigation method
1 | Message log | Y | 4.3, 4.4, 4.5 | 5.2, 5.3
2 | User log | Y
3 | Exception log | Y
4 | Maintenance log | Y
5 | Trace based performance analysis | Y | 4.6 | 5.4, 7.7
6 | JavaVM thread dump | Y#2 | 4.7 | 5.5
7 | Garbage collection logs of JavaVM | -- | 4.8 | 5.6
8 | Memory dump | --#2 | 4.9 | --#3
9 | JavaVM log file#4 | -- | 4.10 | 5.7
10 | Error report files | -- | 4.11 | 5.8
11 | OS status and log | Y | 4.12 | 5.9
12 | OS statistical information | -- | 4.13 | --#3
13 | Definition information | Y | 4.14 | --#3
14 | Working directory | -- | 4.15 | --#3
15 | Resource setting | -- | 4.16 | --#3
16 | Web server log | -- | 4.17 | --#3
17 | JavaVM stack trace#3, #5 | -- | 4.18 | 5.10
18 | Event log of the Explicit Memory Management functionality of JavaVM#4 | -- | 4.19 | 5.11

Legend:

Y: Can be acquired

--: Cannot be acquired

#1

This log can be acquired if the directory, in which snapshot log is collected, is added.

#2

This log can be collected only if it is output using commands when an error is detected in advance. (When collecting the snapshot log, the commands that output a dump cannot be executed).

#3

Maintenance personnel use this data.

#4

Output when JavaVM start option is specified. For details about acquisition options, see 4.10 JavaVM Log (JavaVM Log File). For details about options, see 16. Options for Invoking JavaVM in the uCosminexus Application Server Definition Reference Guide.

#5

Output only when using UNIX.

2.5 Troubleshooting and Recovery

This section describes how to troubleshoot and recover when following errors occur:

If the configuration software process (logical server) terminates abnormally

If forced termination of a J2EE application fails

If a problem occurs when using the database session failover function

If an error occurs when using the EADs session failover functionality

If a problem occurs when using the session failover function

If a problem occurs in the JPA application

If JavaVM terminates abnormally

If the Administration Agent is terminated forcibly, when OutOfMemoryError occurs

If a problem occurs in the system linked with JP1

If a problem occurs in 1-to- node switching systems

If a problem occurs in the node switching system for the host unit management model

If a problem occurs in the EJB client

Organization of this section

2.5.1 If the Configuration Software Process (Logical Server) Terminates Abnormally

2.5.2 When an attempt to forcefully terminate a J2EE application fails

2.5.3 If a Problem Occurs When Using the Database Session Failover Function

2.5.4 When an error occurs in the EADs session failover functionality

2.5.5 If a problem occurs when using the Memory Session Failover Function

2.5.6 If a problem occurs in the JPA Application

2.5.7 If JavaVM Terminates abnormally

2.5.8 If Administration Agent is terminated forcibly when OutOfMemoryError occurs

2.5.9 If a Problem Occurs in the System Linked with JP1

2.5.10 If a problem occurs in 1-to-1 node switching system

2.5.11 If problems occurs in N-to-1 recovery systems

2.5.12 If a problem occurs in the node switching system for the host unit management model

2.5.13 If a Problem Occurs in the EJB Client

2.5.1 If the Configuration Software Process (Logical Server) Terminates Abnormally

The method for restarting the system, when Application Server configuration software process terminates abnormally, is described here.

In a system build on Application Server, if the start order is set up when the component software process (logical server) of Application Server terminates abnormally, the Management Server will automatically restart the component software. In the Management Server, the processing of component software is managed as Logical Server.

When restarting manually, if the abnormally terminated configuration software has startup dependencies, confirm that the configuration software, on which the abnormally terminated configuration software depends for starting, is running. The configuration software, on which the abnormally terminated configuration software depends, varies depending on the configuration of the system. The startup dependencies of the configuration software and the method of restarting the configuration software are explained below:

Hint

In a system using CTM, if component software is restarted immediately by CTM, you can specify settings in such a way so that the system is recovered before the error is returned to the client. However, when the number of maximum registration of the request queue exceeds, an error will return to the client.

For details on a system using CTM, see 3. CTM-based Request Scheduling and Load Balancing in the uCosminexus Application Server Expansion Guide.

Organization of this subsection

(1) Configuration software startup dependencies

(2) Restart method of the process

(1) Configuration software startup dependencies

The startup dependencies of the configuration software process configuring a system built with Application Server are explained here.

Hereafter, the configuration software process startup dependencies are explained for each J2EE server operation mode:

(a) Dependencies of the process

The dependencies of the process are as follows:

Table 2-8 Dependencyof processes

Process type
Dependant process

Performance tracer
--

Smart Agent#1, #2
--

CTM domain manager#1
Smart Agent#1, #2

CORBA naming service
--

CTM daemon#1

Performance tracer

Smart Agent

CTM domain manager

CORBA naming service

SFO server

Performance tracer

J2EE server

Performance tracer

Smart Agent

CTM domain manager#3

CORBA naming service#4

CTM daemon#3

Web server
Performance tracer

Legend:

--: There is no prerequisite process.

#1

It is a process to be started when using CTM.

#2

It is a process to be started when using the transaction service.

#3

This process is a prerequisite when using CTM.

#4

It is a process to be started when using the CORBA naming service in out-process. It is not required when using the CORBA naming service in in-process.

(2) Restart method of the process

The restart method of a process when the process terminates abnormally in a system is as follows.

Hint

When a CTM-related process abnormally terminates and cannot be started, use the following procedure:

When you cannot restart the process, check the cause of the trouble from the output error message.

Execute the ctmrasget command, and acquire backup of the execution environment.

(a) Restart procedure

The procedure of process restart (recovery) is as follows:

Table 2-9 Procedureto restart (recovery) processes

Abnormal process
Start command
Restart (recovery) procedure

Database server
--
Restart the DB server.

OpenTP1
--
Restart the OpenTP1.

Performance tracer
cprfstart
Restart the performance tracer.

Smart Agent#1, #2
Osagent
Restart the Smart Agent.

CTM domain manager#1
ctmdmstart
Restart the CTM domain manager.

CORBA naming service
Nameserv
Perform actions based on the procedure shown below. Furthermore, when CTM is not used, procedure 1 and 4 are not required.

Forcefully terminate the CTM daemon

Forcefully terminate the J2EE server

Restart the CORBA naming service

Restart the CTM daemon

J2EE server restart

CTM daemon#1
ctmstart
Perform actions based on the procedure shown below.

CORBA naming service forced termination

Forcefully terminate the J2EE server

Restart the CORBA naming service

Restart the CTM daemon

Before restarting the J2EE server

CTM regulator
--
Since restarted automatically by CTM daemon, restart is not required.

SFO server#3
cjstartsv
Restart the SFO server.

J2EE server
cjstartsv
Restart the J2EE server.

Web server
--
Restart the Web server.

Legend:

--: The start command differs depending on the products used or there is no corresponding start command.

#1

It is a process to be started when using CTM.

#2

It is a process to be started when using the transaction service.

#3

It is the process to be started when using the memory session failover function.

2.5.2 When an attempt to forcefully terminate a J2EE application fails

When forced termination of a J2EE application fails, the following information is output by the J2EE server:

Message
Message log is output. For details on output destinations of message logs, see 4.3 Application Server log (Systems for executing J2EE applications).

Stack trace
Output in the exception log and thread dump. For details on output destinations of exception logs, see 4.3 Application Server log (Systems for executing J2EE applications). For details on a thread dump, see 5.5 JavaVM Thread Dump.

Note that in forced termination of a J2EE application, method cancellation is performed internally. For the error information output during method cancellation, see 5.3.13 Log information output when the J2EE application execution time is monitored in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

2.5.3 If a Problem Occurs When Using the Database Session Failover Function

The actions for two types of errors in the case of errors in the database session failover function are described here:

When an error occurs in an J2EE server

When a trouble occurs in a database

Organization of this subsection

(1) When an error occurs in an J2EE server

(2) When a trouble occurs in a database

(1) When an error occurs in an J2EE server

During a process that includes changes of the data in a database, if the process is down due to an error in the J2EE server, the consistency of the system will be maintained, because the database will return to the state prior to the occurrence of error the rollback operation. You can eliminate the error of J2EE server and restarting the Web application for recovering from the trouble.

When the host of the J2EE server hangs up or when an error occurs in the network, the operation of the database might be interrupted and the mutual exclusion (lock of the global session information) might become in an unresolved state. In this case, you must resolve the mutual exclusion of the unresolved state before the J2EE server is recovered and the Web application is re-opened.

Reference note

To release the unreleased mutual exclusion, an invalid connection to the database from the client is detected and the connected session can be terminated forcefully. For details on releasing an unreleased mutual exclusion, see the description related to the UAP processing time monitoring functionality of the manual HiRDB UAP Development Guide when using HiRDB. When using Oracle, see the Oracle manual.

(2) When a trouble occurs in a database

When an error occurs in a database and you recover the database, the Web application using the database session failover functionality can re-open the business, because the database will return to the state prior to occurrence of the error by the rollback operation. You are not required to restart the Web application.

For details on the countermeasures to be taken when an error occurrence in other databases, see the manual of each database.

2.5.4 When an error occurs in the EADs session failover functionality

This subsection describes the action to be taken for the following three types of errors occurring in the EADs session failover functionality:

When an error occurs in a J2EE server

When an error occurs in an EADs server

When data cannot be updated on an EADs server

Organization of this subsection

(1) When an error occurs in a J2EE server

(2) When an error occurs in an EADs server

(3) When data cannot be updated on an EADs server

(1) When an error occurs in a J2EE server

If an error occurs in a J2EE server and a process is down, the data on the EADs server does not become inconsistent even if the EADs client is being executed. Therefore, take action according to the procedure described in 2.2.1 Overview of troubleshooting and then start the J2EE server. For details on how to start a J2EE server, see 4.1.24 Starting a system (when CUI is used) in the uCosminexus Application Server System Setup and Operation Guide.

(2) When an error occurs in an EADs server

This subsection describes the following two types of actions to be taken for errors in an EADs server.

(a) When an error occurs in some of the EADs servers in a cluster

When an error occurs in some of the EADs servers in a cluster, operations can continue if one or more EADs servers are available in an EADs cluster. However, if the business is continued without restoring the EADs server with an error, the number of EADs servers reduces, and hence the availability decreases.

The following table describes the procedure of restoring an EADs server with an error separately for the case in which the restore operation is implemented while the business continues and the case in which the restore operation is implemented after stopping the business.

Table 2-10 Restore procedure when an error occurs in some of the EADs servers in a cluster

Business status when the EADs server is restored
Restore procedure
Notes

Business continues
Eliminate the cause of the error in the EADs server, and then use the locked restoration functionality and the functionality for securing data consistency provided by EADs to restore the global session information.#1
The HTTP session operations executed during an error restoration operation are not applied to the EADs server.#2

Business is stopped

Stop the J2EE application or the J2EE server.

Eliminate the cause of the error in the EADs server, and then use the locked restoration functionality and the functionality for securing data consistency provided by EADs to restore the global session information.#1

Start the J2EE application or the J2EE server.

None

#1

For details on the functionality provided by EADs, see the Elastic Application Data store Users Guide.

#2

For details on the operations that are not applied to an EADs server, see (3) When data cannot be updated on an EADs server.

(b) When an error occurs in all the EADs servers

When an error occurs in all the EADs servers, the business can continue due to the HTTP session degeneracy of the EADs session failover functionality. However, if the business is continued without restoring the EADs server, and if an error occurs on a J2EE server, the session is not inherited on another duplicated J2EE server.

The following table describes the procedure of restoring an EADs server with an error separately for the case in which the restore operation is implemented while the business continues and the case in which the restore operation is implemented after stopping the business.

Table 2-11 Restore procedure when an error occurs in all the EADs servers

Business status when the EADs server is restored
Restore procedure
Notes

Business continues
Eliminate the cause of the error in the EADs server, and then reset up the EADs server environment.
For details on setting up the EADs server environment, see 7.6 Preparing an EADs server in the uCosminexus Application Server Expansion Guide.
The operations of a session generated before the error occurred are not applied to the EADs server.#1
The HTTP session operations executed during an error restoration operation are not applied to the EADs server.#2

Business is stopped

Stop the J2EE application or the J2EE server.

Eliminate the cause of the error in the EADs server, and then reset up the EADs server environment. For details on setting up the EADs server environment, see 7.6 Preparing an EADs server in the uCosminexus Application Server Expansion Guide.

Start the J2EE application or the J2EE server.

All the global session information stored in the EADs server is lost, so a session cannot be re-created on the J2EE server.

#1

Only the HTTP session on the J2EE server is used for operations because no session information exists on the EADs server. Unlike a degenerated HTTP session, the information is not applied to the session information cache on the EADs server during the creation or update processing of the global session information when the next request is received.

#2

For details on the operations that are not applied to an EADs server, see (3) When data cannot be updated on an EADs server.

(3) When data cannot be updated on an EADs server

The following table describes the actions to be taken when data cannot be updated on an EADs server.

Table 2-12 Actions to be taken when data cannot be updated on an EADs server

Error contents
Data update contents
Status after the occurrence of an error
Action after an error occurs

Update of data on all the EADs servers failed
Creating the global session information
The global session information is not created on all the EADs servers (session information storage destination server and copy destination server).
The EADs session failover functionality continues the business by degeneracy.#1
None

Updating the global session information
The global session information is not updated on all the EADs servers (session information storage destination server and copy destination server).
The EADs session failover functionality continues the business by degeneracy.#1
None

Deleting the global session information
The global session information is not deleted and remains behind on all the EADs servers (session information storage destination server and copy destination server).
Note that if a request with the same session ID is received, the global session information is inherited on the J2EE server.
Use a command to delete the global session information.
For details on how to delete the information, see 7.8.1 Deleting the global session information on an EADs server (session information storage destination server) in the uCosminexus Application Server Expansion Guide.

Update of data on an EADs server (session information copy destination server) failed
Creating the global session information
The global session information is not created on the session information copy destination server. The EADs session failover functionality continues the business by degeneracy.#1
None

Updating the global session information
The global session information is not updated on the session information copy destination server. The EADs session failover functionality continues the business by degeneracy.# 1
None

Deleting the global session information
The global session information is not deleted and remains behind on the session information copy destination server.
Note that if an error occurs on the session information storage destination server, and if the copy destination server on which the global session information is remaining switches to the storage destination server, the global session information might be inherited on the J2EE server when a request with the same session ID is received.
Use a command to delete the global session information.#2
For details on how to delete the information, see 7.8.2 Deleting the global session information remaining on an EADs server (session information copy destination server) in the uCosminexus Application Server Expansion Guide.

#1

For details on the HTTP session degeneracy, see 5.7.3 Degeneracy of an HTTP session in the uCosminexus Application Server Expansion Guide.

#2

The global session information is not deleted for an EADs server (session information storage destination server and copy destination server) in which an error has occurred and which has been removed from the EADs cluster.

2.5.5 If a problem occurs when using the Memory Session Failover Function

The actions for two types of errors in the case of errors in the memory session failover function are described here:

When an error occurs in a J2EE server or Web server

When an error occurs in an SFO server

Organization of this subsection

(1) When an error occurs in a J2EE server or Web server

(2) When an error occurs in an SFO server

(3) Confirming the log output by the memory session failover function

(1) When an error occurs in a J2EE server or Web server

When an error occurs in a J2EE server or Web server, after following the procedure shown in 2.2.1 Overview of Troubleshooting, take appropriate actions and start the J2EE server or Web server. For details on how to restart J2EE servers or Web servers, see 4.1.24 Starting the system (when using CUI) in the uCosminexus Application Server System Setup and Operation Guide.

Note that if you stop a J2EE server due to an error, restart the Web server that sends a request to the J2EE server where the error occurred. If you do not restart, the redirector continues to use the established connection that is already invalid. As a result, the Web server keeps waiting till a communication timeout occurs after forwarding the request to the J2EE server where the error occurred, and after the communication time out the request is sent back to the client as an error.

For details on the communication timeout, see 4.6 Communication timeout (Web Server integration) in the uCosminexus Application Server Web Container Functionality Guide or 5.9 Communication timeout (In-process HTTP server) in the uCosminexus Application Server Web Container Functionality Guide.

(2) When an error occurs in an SFO server

If an error occurs in an SFO server, after clearing the cause of the error by acquiring the necessary data in the same way as in a J2EE server, restart the SFO server.

Further, when you restart the SFO server, the J2EE server reconnects to the SFO server. At this time, the negotiations process same as that at the time of initialization takes place between J2EE server and SFO server.

In the negotiation process, confirm whether the following information is shared between J2EE applications on redundant J2EE servers:

Context root name of the Web application

Upper limit for the number of HttpSessions

Maximum size of the session information

HTTP Cookie name used by the global session ID

Timeout till lock wait within the SFO server

When this information between J2EE applications on the redundant J2EE servers differs, for those web applications, the memory session failover function continues to be invalid, but the SFO server is not reconnected.

In this case, stop the corresponding J2EE application once and restart it after you make the settings for the J2EE application memory session failover correctly.

(3) Confirming the log output by the memory session failover function

When using the memory session failover function, a log is output by the J2EE server and SFO server that uses the memory session failover function. Check this log if required when an error occurs.

The following table describes the correspondence between the log output level and the contents output in a J2EE server.

Table 2-13 Correspondencebetween the log output level and the contents output in a J2EE server

Log output level
Contents that are output

Error

Information about starting and stopping of memory session failover function

Information about the connection with the SFO server

Information about error occurrence in the SFO server

Information reporting that the size estimation functionality of the global session information is valid.

Size information by the size estimation functionality of the global session information.

Warning

Information on the inheritance of the global session information

Reporting that global session ID was not found by the invalid global session (expired) request

Information

Check results of the health check thread

The following table describes the correspondence between the log output level and the output contents in the SFO server.

Table 2-14 Correspondencebetween the log output level and the output contents in the SFO server

Log output level
Contents that are output

Error

Information related to starting and stopping of the SFO server

Information related to errors that occurred in the SFO server

Reporting that the number of global sessions for the maximum value is "0%","20%","40%","60%","80%", or "100%"

Number of global sessions destroyed due to the expired validity in the SFO server

Warning

Global session ID of the global session destroyed due to the expired validity in the SFO server

Reporting of a creation request for a global session as the maximum value of the number of global sessions has exceeded

Notification of a request to acquire invalid global sessions (expired validity)

Information

Detailed information of global sessions destroyed due to expired validity in the SFO server

2.5.6 If a problem occurs in the JPA Application

This section describes the analysis procedure when a trouble occurs in an application using JPA.

This section describes an example of the model failure and the analysis procedure for the cause.

Note that the information, between each log output by Cosminexus JPA provider, is based on time, Thread ID/Process ID, and PersistenceUnit name. You can raise a log level and acquire the data, when you cannot specify the cause in the acquired log and the log is repeated.

Organization of this subsection

(1) Exception occurrence by user application

(2) Errors occurred in a performance screen

(3) Data used in troubleshooting

(1) Exception occurrence by user application

This point describes an analysis procedure implemented by a user when an exception occurs in a user application. The timing, when the exception occurs, might be when starting an application (including deploy) or when executing the application. This section describes the analysis procedure when an exception occurs in their respective timings.

Exception occurrence when starting an application

The analysis procedure when an exception occurs while starting an application is as follows:

Checking message logs
Reference the message output by a message log. See the message manual and confirm the handling procedure of the message ID that is output. Moreover, examine the countermeasures.

Checking application definitions
Review the contents of the definition information of annotation in the application, persistence.xml, settings of O/R mapping files based on the contents of the message log and check whether there is any problem in the setup contents. When the method of handling the message log involves contacting the maintenance personnel, and when the cause of situations, such as not having any problem in the application process is not revealed, contact maintenance personnel.

Exception occurred when executing an application

This point describes an analysis procedure when an exception occurs while executing an application.

Checking message logs
Check the event of a failure from the message output to a message log. For details on the messages, see the manual uCosminexus Application Server Messages.

Checking exception logs

Specify the point where an exception has occurred from the stack trace output to the exception log. To find out the cause of the exception occurrence, check whether there is any problem in the process contents of the application. Modify the application if there is any problem in the process.

When the method of handling the message log involves contacting the maintenance personnel, and when the causes of situations, such as not having any problem in the application process are not revealed, contact maintenance personnel.

(2) Errors occurred in a performance screen

This point describes an analysis procedure when a performance related failure occurs. For example, certain processes require time. The performance related problem might occur when starting an application or when executing the application.

When you start an application, if any performance related problem occurs, contact maintenance personnel. When you execute the application, and if any performance related problem occurs, specify the location of the problem as per the following procedure:

Checking PRF trace.
Specify the location where the process takes time from the contents of a PRF trace. Specify whether the cause of a failure is in the user-implemented location or in the Cosminexus JPA Provider. Modify the application if there is any problem in the user-implemented location. When the processes in the internal process of Cosminexus JPA provider take time, contact maintenance personnel.

Checking operation logs
For checking the issued SQL, check operation logs.
For example, you can reference the issued SQL and confirm whether it is relevant to the following case or not:

JOIN operation is executed repeatedly by reading the entity because JOINED is used in inheritance strategy.

The entity managed by collection is operated, and therefore, SELECT is generated for each element with extension.

For details on the operation log output to Cosminexus JPA provider, see Appendix C.1 Cosminexus JPA Provider operation log.

(3) Data used in troubleshooting

The following table shows the troubleshooting data and the acquisition source of the data that is required in the Cosminexus JPA Provider, when a failure occurs in the system.

Table 2-15 Troubleshootingdata and data acquisition source required in Cosminexus JPA Provider

Troubleshooting data
Acquisition source
File name of the data

Message log
snapshot (primary)
Message log

Exception log
snapshot (primary)
Exception information when an error occurs

Operation log of Cosminexus JPA Provider
snapshot (primary)
Operation log of CJPA

J2EE server definition information
snapshot (primary)

Option definition file for J2EE server

User property file for J2EE server

Security policy file for J2EE server

Definition information of applications included in the operation directory of J2EE server
persistence.xml
snapshot (secondary)

Contents of EJB server operation directory

Contents of Web container operation directory

O/R mapping file

Property file of EJB, WAR

Connector property file of DB Connector
snapshot (secondary)
Contents of Web container operation directory

DB Connector log
snapshot (primary)
Operation log of the resource adaptor that is deployed and used as a J2EE resource adaptor

Trace based Performance Analysis
snapshot (primary)
PRF daemon and PRF command log

J2EE server thread dump
Thread dump acquisition command

SQL trace of a database to be connected (However, only when the trace information is collected)

HiRDB
SQL trace

See the manual HiRDB SQL Reference

For the Oracle
Trace file that is acquired when setting sql_trace=true in SQL trace init.ora

See the manual of Oracle.

2.5.7 If JavaVM Terminates abnormally

The actions when JavaVM terminates abnormally and the information output in the case of abnormal termination are described below:

Organization of this subsection

(1) Actions in the case of abnormal termination

(2) Information output at the time of abnormal termination

(1) Actions in the case of abnormal termination

In UNIX, in the case of abnormal termination, perform actions in the following order. Further, these actions are not required in Windows.

Execute the javatrace command on the machine where abnormal termination occurs.
Output the javatrace.log file. For the execution method of the javatrace command, see 4.18 JavaVM stack trace information.

Send the acquired javatrace.log file to maintenance personnel along with the error report file (hs_err_pidprocess-ID.log).
For the method of acquiring the error report file, see 4.11 JavaVM Output Message Logs (Standard Output or Error Report File).

Execute the following commands to create the archive file for the JavaVM executable file, the library loaded when the error occurred, and the core dump.

In AIX
Execute the snapcore command. An archive file compressed with the pax command is created.

In HP-UX, Linux, and Solaris
If the compress command is installed, execute the car_tar_Z command. An archive file compressed with the compress command is created.
If the gzip command is installed, execute the car_tar_gz command. An archive file compressed with the gzip command is created.

Send the created archive file to maintenance personnel.

(2) Information output at the time of abnormal termination

The information output when the following kind of abnormal termination occurs in JavaVM is described below:

When C heap is insufficient during JavaVM processing

When an OutOfMemoryError occurs due to a reason other than insufficient C heap during JavaVM processing

When an internal logical error occurred

(a) When C heap is insufficient during JavaVM processing

If C heap is insufficient, in continuation to the following messages, the memory status, Java heap information and stack trace information are output to the standard output and error report file (hs_err_pidprocess-ID.log). After that, JavaVM is forcefully terminated.

Check the output information and take an appropriate action.

Exception in thread thread-name java.lang.OutOfMemoryError:requested size-required-for-securing-memory bytes [for message-for-internal-investigation].

(b) When an OutOfMemoryError occurs due to a reason other than insufficient C heap during JavaVM processing

When setting -XX:+HitachiOutOfMemoryAbort as the option when starting the J2EE server, and when an OutOfMemoryError occurs due to the following causes, output the message and memory dump and perform forced termination of JavaVM. Check the output information and take an appropriate action.

However, the memory dump is not output in Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista. If the OutOfMemoryError occurs due to Java heap insufficiency or Perm heap insufficiency when the OutOfMemory handling functionality is already enabled (when -XX:+HitachiOutOfMemoryHandling is set), sometimes forceful termination is not performed.

Causes for forced termination

Java heap insufficiency

Perm heap insufficiency

Insufficient C heap in J2SE class library

Further, when C heap is insufficient in the JavaVM process, perform forced termination regardless of the specification of this option.

When terminating, output the following message and memory dump.

java.lang.OutOfMemoryError occurred.
JavaVM aborted because of specified -XX:+HitachiOutOfMemoryAbort options.

Forced termination timing

The timing when JavaVM is terminated forcefully differs depending on the option settings.

When -XX:+HitachiOutOfMemoryStackTrace is specified as the option, terminate after performing output of the stack trace. However, even when registering the process that is to be executed at JavaVM termination time by the java.io.File.deleteOnExit method and the java.lang.Runtime.addShutdownHook method beforehand, perform forced termination without executing these.

When setting -XX:+HitachiOutOfMemoryAbortThreadDump as the option, terminate after performing output of the thread dump. Especially for Java heap deficiency or Perm heap deficiency, and even if -XX:+HitachiOutOfMemoryAbortThreadDumpWithJHeapProf is set up as an option, terminate after the thread dump with the statistical information according to the class is output.

Operation when the OutOfMemory Handling functionality is enabled

If -XX:+HitachiOutOfMemoryHandling is set in addition to -XX:+HitachiOutOfMemoryAbort as an option when starting a J2EE server, the OutOfMemory handling functionality gets enabled. If Java heap or Perm heap insufficiency occurs after the OutOfMemory functionality is enabled, a process is executed to determine whether forceful termination should be performed by OutOfMemory handling. As a result of this judgment process, if all of the following OutOfMemoryError throw conditions are satisfied, forceful termination is not executed.

OutOfMemoryError Throw Conditions

OutOfMemory occurs due to Java heap insufficiency or Perm heap insufficiency.

OutOfMemory occurs in either the request processing in which the Web application (Servlet/JSP) on the Web container is running, the processing in which the Enterprise Bean invoked from an EJB client application is running, the processing in which a Message-driven Bean is running, or the processing in which the Enterprise Bean invoked from the TimerService is running.

Does not correspond to the OutOfMemoryError throw exclusion condition.

OutOfMemoryError Throw exclusion condition

If the total count (including the recent OutOf Memory errors) of the OutOfMemory errors that have occurred due to Java heap insufficiency and Perm heap insufficiency within 1 hour from the recent occurrence of the OutOfMemory error is more than the value specified in -XX:HitachiOutOfMemoryHandlingMaxThrowCount option.

For details, see -XX:[+|-]HitachiOutOfMemoryHandling (OutOfMemory handling options) in the uCosminexus Application Server Definition Reference Guide.

If the OutOfMemory handling functionality is enabled, whenever OutOfMemory occurs due to Java heap insufficiency or Perm heap insufficiency, the information related to the frequency of the OutOfMemory occurrence is output in the JavaVM log file.

(c) When an internal logical error occurred

When an internal logical error occurs, the message showing the JavaVM information where the error occurred, the examination error ID and the thread where the error occurred are output to the standard output and the error report file (hs_err_pidprocess-ID.log). Send the output information to maintenance personnel.

2.5.8 If Administration Agent is terminated forcibly when OutOfMemoryError occurs

When Administration Agent is running, if java.lang.OutOfMemoryError occurs, a log is output and the Administration Agent is terminated forcibly. The log is output at the following locations:

In Windows
Manager-log-output-directory\adminagent.javalog[nn].log

In UNIX
Manager-log-output-directory/adminagent.javalog[nn].log
Note [nn] is a number from 0 to 99.

Note that if you have specified the settings to stop all the logical servers in the termination processing of the Administration Agent, the logical servers do not stop even if Administration Agent is terminated forcibly. To specify the settings for stopping the logical servers in the termination processing of the Administration Agent, specify true in the adminagent.finalization.stop_servers key of adminagent.properties (Administration Agent property file).

Also, if you use a product other than JDK that is provided by Cosminexus Application Server, the Administration Agent is not terminated forcibly because of OutOfMemoryError.

Execute the following operations, when Administration Agent is terminated forcibly because of OutOfMemoryError:

Revise the value specified in the following option of adminagentuser.cfg:
Revise the value specified in the following option:
add.jvm.arg = -Xmx

Restart the Administration Agent.

2.5.9 If a Problem Occurs in the System Linked with JP1

When an error occurs in the system linked with JP1, it is necessary to take the following actions:

Organization of this subsection

(1) Actions for problems in the system linked with JP1/IM

(1) Actions for problems in the system linked with JP1/IM

Shown below are the actions for the problems expected in the system linked with JP1/IM:

Table 2-16 Errorsexpected in a system linked with JP1/IM and their actions

Problem type
Actions

Occurrence of an error at the time of auto generation of the monitoring tree
When an error occurs, investigate the cause of the error based on the Cosminexus adapter command message that is output in the JP1/Base plug-in service log file. For details on the JP1/Base plug-in service log file, see the manual JP1/Base Operation Guide.

No notification of the JP1 event to JP1/IM
Confirm the log of the Administration agent, Management agent, and Management Server to check whether the JP1 event is published to JP1/IM from the system built with Application Server. For details on the storage location of the log of Administration Agent, Management Agent, and Management Server, see 4.3.1 Acquiring the Cosminexus Component Container Logs or 4.4.1 Acquiring the Cosminexus Component Container Logs (system executing batch applications).
Take the following actions for the contents of the log of Administration agent, Management agent, and Management Server.

When the JP1 event publishing log is not output, confirm the JP1 event publishing settings of the Management Server#.

When the JP1 event publishing log is output, confirm the contents of the JP1/Base configuration definition created in the JP1 integrated operation management server. Moreover, confirm the action environment settings of the JP1/Base event service in the Management Server# and J2EE server.

Web browser does not start after starting the JP1/IM-View monitor
Investigate the cause of the error that occurred based on the message output in the mngsvrmonitor.log, which is saved in the directory where the monitor start command is copied.

#

This is the Management Server of Application Server.

2.5.10 If a problem occurs in 1-to-1 node switching system

This subsection describes the actions that you must take with for each OS, when the node switching process for a standby host is timed out due to a failure in the database server (such as server is down or deadlock).

Organization of this subsection

(1) In Windows

(2) In UNIX

(1) In Windows

Manually keep the standby host online, after acquiring the log.

(a) Acquiring the log of 1-to-1 node switching system

If a trouble occurs in the 1-to-1 node switching system, you must acquire the cluster log. The following is the output destination of the cluster log when Windows is installed in the standard path:

C:\WINDOWS\cluster\cluster.log

The following information is output to a cluster log:

Operation log of cluster service

Error message when there is an error in the syntax of VBScript

Resource.LogInformation method of multi-purpose script

Other messages

For details on the cluster log, see the documentation on Windows.

If the J2EE server does not run, see Cosminexus Component Container log too.

(b) Manual recovery of 1-to-1 node switching system

You can manually recover the 1-to-1 node switching system according to the following procedure:

Cancel the cause of a timeout by restarting the database.

Create online target resources of the standby host.

(2) In UNIX

Resolve the cause of the timeout by restarting the database.

2.5.11 If problems occurs in N-to-1 recovery systems

This subsection describes the recovery procedure for each OS, when problems occur in N-to-1 recovery systems.

Organization of this subsection

(1) In Windows

(2) In UNIX

(1) In Windows

With N-to-1 recovery systems, if the recovery processing of the standby node host (recovery server) is timed out because of a database server failure (such as server down or deadlock), collect the log and manually execute the recovery procedure. The recovery procedure is as follows:

Collect the log of the N-to-1 node switching system.
If a problem occurs in the N-to-1 recovery system, you must collect cluster logs. Collect the logs same as you would collect when problems occur in 1-to-1 node switching systems. For details on the logs to be collected, see the subsection 2.5.10 If a problem occurs in 1-to-1 node switching system.

Recover the N-to-1 node switching system manually.
Use one of the following methods to manually recover the N-to-1 recovery system:

Set up the target resources of the standby node host as online

Execute the transaction recovery command (cjstartrecover) of the J2EE server

(a) Setting the target resources of the standby node host as online and executing recovery

To set up the target resources of the standby node host as online and execute recovery:

Execute operations, such as restarting the database to resolve causes of the timeout.

Set up the target resources of the standby node host as online.

(b) Executing the transaction recovery command (cjstartrecover) of the J2EE server for recovery

To execute the transaction recovery command (cjstartrecover) of the J2EE server for recovery:

Execute operations, such as restarting the database to resolve causes of the timeout.

Create a folder in the path specified in Dir_Name using the universal script for the standby node host.
If a folder already exists, delete the folder, and then create a new folder.

When the universal script for the standby node host is online, reference cluster logs, and then execute cjstartrecover.

When recovery is successful, delete the folder created in the path specified in Dir_Name.

For details on cjstartrecover command, see cjstartrecover (J2EE Server Transaction Recovery) in the uCosminexus Application Server Command Reference Guide.

(2) In UNIX

With N-to-1 recovery systems, if the recovery processing of the standby node host (recovery server) is timed out because of a database server failure (such as server down or deadlock), manually execute the recovery procedure as follows:

Execute operations, such as restarting the database to resolve causes of the timeout.

In the standby node host, execute monbegin for the failed executing node host.

# monbegin server-identification-name

In the underlined part, specify an identification name of the server for the executing node specified in the operand alias of the servers file.

In the standby node host, execute monact for the failed executing node host.

# monact server-identification-name

In the underlined part, specify an identification name of the server for the executing node specified in the operand alias of the servers file.
You can use a standby node host (recovery server) to execute the recovery processing for the unconcluded transactions in the failed executing node host.

Reference note

For details on the environment settings to support servers in the HA monitor, such as defining the servers file, see 19.5.4 Environment settings of the HA Monitor in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

2.5.12 If a problem occurs in the node switching system for the host unit management model

An action for a problem that occurs in a node switching system of the host unit management model is same as would be the action of a problem that occurs in the 1-to-1 node switching system. For details, see the subsection 2.5.10 If a problem occurs in 1-to-1 node switching system.

2.5.13 If a Problem Occurs in the EJB Client

When an EJB client using a global transaction is down, recovery of the global transaction is necessary. The recovery of the global transaction can be executed by restarting the EJB client.

The method for confirming whether the global transaction recovery process is complete is described below:

Execute the cjlisttrn command in Application Server and confirm whether the transaction is in an active state. For details on the cjlisttrn command, see cjlisttrn (Displaying the transaction information of the operating J2EE server) in the uCosminexus Application Server Command Reference Guide.

Confirm whether the resource adapter can be stopped. If it can be stopped, the recovery process of the global transaction is complete.

Confirm whether Application Server can be stopped successfully. When it can be stopped successfully, the recovery process of the global transaction is complete.

Confirm using tools and commands provided by each resource.

Moreover, when multiple EJB clients exist, to examine which EJB client is required for the recovery of global transaction:

Confirm the unconcluded transactions by executing the cjlisttrn command by specifying the -pending option.

Execution format

cjlisttrn server-name -pending -bqual

Execution example

cjlisttrn MyServer -pending -bqual

From the unconcluded transactions confirmed in procedure 1., confirm whether all the following conditions apply to those transactions:

Elapsed time increases every time the cjlisttrn command is published

Branch type is Sub or Sub(recovered)

TmHash value of the KFCB40051-I message output at the time of starting the stopped EJB client is included in the global transaction ID

The transactions to which all these conditions apply are required for the recovery of global transactions.

2.6 Precautions Related to Troubleshooting

This section describes the precautions related to troubleshooting.

Organization of this section

2.6.1 Precautions Related to the System Log of an EJB Client Application

2.6.2 Precautions When Using CTM

2.6.3 Precautions when using PRF

2.6.4 JavaVM data-related considerations

2.6.1 Precautions Related to the System Log of an EJB Client Application

The precautions when referencing a system log output by an EJB client application in a shared sub-directory mode and operating the shared sub-directory mode EJB client applications are described below:

The valid data in the log file is from the start of the file up to the EOF.
In the system log of an EJB client application, the log data is overwritten from the beginning sequentially when the log file is wrapped around, without deleting the log data prior to wrap around. For this reason, when referencing a log file, ignore the data after the EOF. The data after the EOF is the invalid log file data prior to wrap around.
The end of the valid log file data is the data shown below:

EOF CRLF CRLF CRLF CRLF----------< End of Data >----------CRLF CRLF

EOF are characters (0x1A) denoting the end of trace data. CRLF denotes line feed (0x0D, 0x0A).
The example of output is described below. Further, the character showing the end of trace is described as [EOF].

In Windows

**** Windows XP 5.1               TZ=GMT+09:00                     xxxx/xx/xx xx:xx:xx.xxx
    yyyy/mm/dd hh:mm:ss.sss               pid      tid      message-id            message(LANG=ja)
0000 xxxx/xx/xx xx:xx:xx.xxx     HEJB       BE3F6FE9 015EE671 KDJEXXXXX-W           xxxxxxxxx
0001 xxxx/xx/xx xx:xx:xx.xxx     HEJB       BE3F6FE9 015EE671 KDJEYYYYY-I           yyyyyyyyy
0002 xxxx/xx/xx xx:xx:xx.xxx     HEJB       BE3F6FE9 015EE671 KDJEZZZZZ-I           zzzzzzzzz
[EOF]

----------< End of Data >----------

<<Invalid data before wraparound>>...
...

...

In UNIX

**** "OS name (Including details such as OS version)"               TZ=Asia/Tokyo                     xxxx/xx/xx xx:xx:xx.xxx
    yyyy/mm/dd hh:mm:ss.sss                      pid      tid      message-id            message(LANG=ja)
0000 xxxx/xx/xx xx:xx:xx.xxx     HEJB             BE3F6FE9 015EE671 KDJEXXXXX-W           xxxxxxxxx
0001 xxxx/xx/xx xx:xx:xx.xxx     HEJB             BE3F6FE9 015EE671 KDJEYYYYY-I           yyyyyyyyy
0002 xxxx/xx/xx xx:xx:xx.xxx     HEJB             BE3F6FE9 015EE671 KDJEZZZZZ-I           zzzzzzzzz
[EOF]

----------< End of Data >----------

<< Invalid data before wraparound>>...
...
...

At the time of starting an EJB client application process, a number of trace files specified in the ejbserver.logger.channels.define.channel-name.filenum key of system properties are created. At this time, trace files are initialized as space (0x20).

The capacity of the user log file is fixed as specified in the ejbserver.logger.channels.define.channel-name.filesize key of system properties. The trace files of the specified size are created at the time of process startup. For this reason, capacity does not increase or decrease as per the log output.

When you want to change the log file capacity or the number of files, you need to stop all the processes that output log in the relevant log files, and delete the log management files under the mmap directory and the log files or move them to a different directory.

In cases other than when you want to change the log file capacity or the number of files, do not change or delete the log files and the log management files. If you change or delete them, thereafter, the log may not be output correctly.

Do not delete the sub directories using the cjcldellog command where the EJB client application running in the shared sub-directory mode output log. If you delete such sub-directories, thereafter, the log may not be output correctly.

When starting an EJB client application in the shared sub-directory mode in the environment where the EJB client application is already running in the exclusive sub directory mode, specify a value different than that of the EJB client application running in an exclusive sub-directory mode in the ejbserver.client.ejb.log key of system properties. If the same value is specified, you cannot correctly manage the number of sub directories of the EJB client application operating in the exclusive sub-directory mode. Note that the exclusive sub-directory mode is used for compatibility with earlier versions.

2.6.2 Precautions When Using CTM

The precautions to be taken when using CTM are described below. In CTM, take care of the following things:

Failure information of CTM is acquired under the CTMSPOOL environment variable in the CTM domain unit. As the error information is acquired even at the time of restart after the CTM daemon and CTM domain manager are down, save the error information after the occurrence of error.

The directories under the CTMSPOOL environment variable are the operation directories of the product. Therefore, do not delete the files and directories.

2.6.3 Precautions when using PRF

The precautions to be taken when using PRF are described below. In PRF, take care of the following things:

PRF error information is acquired under the PRFSPOOL environment variable for every PRF daemon identifier. As the error information is acquired even at the time of restart after the PRF daemon is down, save the error information after the occurrence of error.

The directories under the PRFSPOOL environment variable are the operation directories of the product. Therefore, do not delete the files and directories.

2.6.4 JavaVM data-related considerations

This subsection describes the JavaVM data-related considerations.

The following JavaVM data does not support multi-byte characters. The applicable characters, such as the Japanese class names, are corrupted.

JavaVM thread dump log file

JavaVM log file

Error report file (JavaVM output message log)

Event log file of the Explicit Memory Management functionality

In Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista, if you specify names containing the third and fourth level characters of JIS X0213:2004 in the following options, the JavaVM log file of the product and the event log file of the Explicit Memory Management functionality are not output:

-XX:HitachiJavaLog option

-XX:HitachiExplicitMemoryJavaLog option

Also, if the third and fourth level characters of JIS X0213:2004 are included in the output destination directory of the extended thread dump file, the extended thread dump is not output to a file.

3. Preparing for Troubleshooting

You can automatically receive the information required for troubleshooting, when a trouble occurs in a system built on the Application Server. Some of the data that is required for troubleshooting need preparation before starting operations. This chapter describes the settings for respective data acquisition.

Organization of this chapter

3.1 Organization of this chapter

3.2 Overview of data acquisition settings

3.3 Execution environment settings

3.1 Organization of this chapter

This section describes the settings to acquire the data required for troubleshooting.

You can automatically acquire the data required for troubleshooting by default settings, but you must set up a part of the data before starting operations. You can also change the output destination and the log size that is set up by default.

For the information to be acquired when trouble occurs, you must specify the settings before starting the operations to acquire the following information:

JavaVM log (JavaVM log file)
The JavaVM garbage collection log is also output to this file.

User dump (in Windows)

core dump (in UNIX)

OS statistical information (in Windows)

Specify the settings to acquire this information at system configuration time as required.

The following table describes the organization of this chapter.

Table 3-1 Organization of this chapter (Troubleshooting (Data acquisition settings))

Category | Title | Reference
Explanation | Overview of data acquisition settings | 3.2
Settings | Execution environment settings | 3.3

For overview of troubleshooting, data output methods and output contents, see the respective sections:

Overview of troubleshooting and methods to output the data automatically
2. Troubleshooting

Output destination of collected data and methods to output data separately
4. Output Destinations and Output Methods of Data Required for Troubleshooting

Contents output in data
5. Problem Analysis

3.2 Overview of data acquisition settings

For certain materials required for troubleshooting, you need to specify collection of the material before starting the operations. For example, if you do not make settings in advance for collecting material, you cannot acquire the statistical information of the OS, user dumps (in Windows) or core dumps (in UNIX), or garbage collection log of JavaVM. Hitachi recommends that you obtain this data because it is required for troubleshooting.

If the material can be collected with default settings, specific settings are not required, however, if you want to change the log output destination and size, edit the Easy Setup definition file and user definition file to change the settings.

The following table describes handling of the data required for troubleshooting, data that require in advance settings, and the data for which you must change the settings.

Table 3-2 Handling of the data required for troubleshooting, data that require in advance settings, and the data for which the settings must be changed

Data necessary for troubleshooting
Data that require in advance settings or data for which the settings must be changed

Log of Application Server
Message log

Snapshot log

Management Server log

J2EE server log

Batch server log

SFO server log

Web server log

Redirector log

Application user log

In-process HTTP server log

Cosminexus Manager log

Console log

Resource adapter log

Cosminexus TPBroker trace file

Cosminexus JMS Provider log

Server management command log

User log

Exception log

Maintenance log

EJB client application system log
Message log

System log#

Application user log

User log

Exception log

Maintenance log

Trace based performance analysis
Trace based performance analysis file

Thread dumps of JavaVM
JavaVM material

Garbage collection logs of JavaVM
JavaVM material

Memory dump

User dump (in Windows)

core dump (in UNIX)

Hitachi JavaVM log file
JavaVM material

Error report files
--

OS state or log
--

Statistical information of OS
Statistical information of OS

Definition information
--

Operation directory
--

Resource setting
--

Web server log
--

JavaVM stack trace
--

Event log of Explicit Heap Memory Management functionality
JavaVM material

Legend:

--: No data for in advance settings and no data to change the settings

Note:

Besides this table, there is an operation information file for the data that requires in advance settings and the data requires changes in settings. An operation information file is a file used for acquiring the operation information, such as server performance for each functionality and the resource information. You can use this file for operation monitoring of systems. You can acquire the operation information file by default.

#

For details about the system logs of EJB client applications, see 3.8 System log output for EJB client application in the uCosminexus Application Server EJB Container Functionality Guide.

This section gives an overview on the types and settings of the data that require in advance settings and the data that requires changes in the settings, for each system executed that executes an application.

Organization of this section

3.2.1 Specifiable contents

3.2.2 Overview of data acquisition settings (Systems that execute J2EE applications)

3.2.3 Overview of data acquisition settings (Systems executing batch applications)

3.2.1 Specifiable contents

This section describes the contents that can be specified as data acquisition methods.

You can specify the following contents as acquisition methods in some of the data to be used for troubleshooting. The contents that you can specify depend on the data.

Do you want to acquire the data?

Data output destination

Number of output destination files

How to switch the output destination files

Note that for some data output by the following processes, you can select the time at which the output destination files will be switched and the name assignment rules for the switched files:

J2EE server

Administration Agent

Management Server#

Internal setup tool for the virtual server manager

Server Communication Agent

# Applicable when the shift mode is set up for the integrated log.

This subsection describes the time at which the output destination files can be switched and the file name assignment rules that you can select in these processes.

Organization of this subsection

(1) Time at which the output destination files are switched

(2) File name assignment rules when the output destination files are switched

(1) Time at which the output destination files are switched

For some of the data, you can select the switching methods for the data output destination files from the following two types of methods:

File size-based switching method

In this method, when the output destination file reaches a certain size, the log output destination is switched to the next file. You can specify the file size for each data item. However, the file size is fixed for some of the data.

Time and file size-based switching method

In this method, when the specified time is reached, or when the output destination file reaches a certain size, the log output destination is switched to the next file.

You can specify the switching method for each process.

If you select the time and file size-based switching method, and if you want to switch the files by time alone, specify a value larger than the assumed log output volume as the file size. Also, the header information of the new file, created after the output destination file is switched by time, becomes the date and time at which the process that has output the log initialized the log.

For details on the files that are switched by the time and file size-based switching method, see 5.2 Application Server log.

Note

When you select the time and file size-based switching method, the time at which the output destination file is switched might be delayed from the specified time by several milliseconds to a few seconds, depending on the load status of the OS resources.

Also, if the process that performs log output (such as the J2EE server) is not running at the specified time, the log is added into the existing file instead of switching the files when the process next starts after the specified time is past. For example, if the switching time is specified at 12:00:00, and the process is stopped at 11:00:00, the process that starts at 13:00:00 adds the log to the existing file.

(2) File name assignment rules when the output destination files are switched

A file name configured with a data-specific string and serial number is set for the output destination files. You can select the serial number assignment rules from the following two modes:

Wraparound mode

If the data-specific string is xxx, the files are created with the serial number added as xxx1.log, xxx2.log and so on. The range of the serial numbers is from 1 up to (number-of-output-destination-files). If the output destination is changed after the specified number of output destination files are created, the data output destination switches to the file with the serial number 1.

The following figure shows file name assignment rules in the wraparound mode.

Figure 3-1 File name assignment rules in the wraparound mode

Shift mode

The file to which the data is being output currently has a file name containing only the data-specific string. No serial number is given. After the output destination is switched at the specified time, a serial number is given to the previous files.

If the data-specific string is xxx, the file to which the data is output at that time becomes xxx.log (file name without serial number). The names of the previous output destination files are changed (renamed) to file names with the serial number added as xxx1.log, xxx2.log and so on. At this time, the file with the smallest serial number sequentially becomes the latest file.

The range of the serial numbers is from 1 up to (number-of-output-destination-files). Therefore, the total number of files is the specified-number-of-output-destination-files + 1 (current output destination file).

The following figure shows the procedure of switching output destination in the shift mode.

Figure 3-2 Procedure of switching the output destination in the shift mode

For details on the files that are switched in the shift mode, see 5.2 Application Server log.

Note that when deleting a file in Windows, a file that is being used in another process might be stored temporarily. In this case, a file with #removed#[n] (n is an integer of 0 or more value) added at the end of the original file name is created temporarily. This file is automatically deleted when all the processes finish processing the file.

3.2.2 Overview of data acquisition settings (Systems that execute J2EE applications)

For changing the default settings (Output destination or log size) of data or acquiring the data that is not acquired by default, editing the Easy Setup definition file or User definition file and specify the settings. This subsection describes whether you must specify the settings of the systems executing J2EE applications to acquire the data (log) in advance. This subsection also provides an overview of the setting methods.

For each data type, the following tables separately describe the data items for which the data collection settings must be specified and the data items for which settings must only be specified when changing the default data collection settings.

Data items that require data collection settings

Table 3-3 Data acquisition settings (Systems executing J2EE applications)

Type of material
Settings for collecting the material
Reference manual
Reference point

Application user log
Set up the logger or handler settings, output level of log, size, and the number of files in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file.
Use server.policy to specify the security policy.
uCosminexus Application Server Expansion Guide
Chapter 9

Statistical information of OS
In Windows, specify the performance data collection settings of system resources on the Windows system monitor.
This manual
3.3.16

User dump
In Windows, specify the settings for collecting user dumps with Dr. Watson# or the environment variable (CJMEMDUMP_PATH).
This manual
3.3.17

core dump
In Unix, specify the settings for collecting core file using the simple setup definition file and shell commands.
This manual
3.3.18

JavaVM material
Set up the thread dump of JavaVM, output methods, or output contents of the JavaVM logs (JavaVM log files) in the Easy Setup definition file. You can also set up name of a file that executes the event log output or the output level of log in the Explicit Heap Memory Management functionality.
This manual
3.3.19

#

In this manual, the Dr. Watson Diagnostic Tool included in Windows is referred to as Dr. Watson.

Data items that must be set up only when changing the default data collection settings

Table 3-4 Data acquisition settings (Systems executing J2EE applications)

Type of material
Settings for collecting the material
Reference manual
Reference point

snapshot log
To change the collection destination, collection method, and collection timing of the snapshot log, edit the user definition file
This manual
3.3.1, 3.3.3

Management Server log
Use mserver.properties (environment setting files of the Management Server), to set up an output level of a log or to set up the number of log files.
This manual
3.3.5

Trace based performance analysis file
Use mserver.properties (environment settings file of Management Server) to specify the number of Trace based performance analysis files.
Specify the trace acquisition level of performance tracer or number of PFR trace files in the <configuration> tag of Logical Performance Tracer (performance-tracer) in the Easy Setup definition file.
This manual
7.5

J2EE server log
Set up the output level of a log, size, and number of files in <configuration> tag of logical J2EE server (j2ee-server) in the Easy Setup definition file.
When settings of system log output are enabled by ejbserver.logger.systemlog.enabled in the <configuration> tag of logical J2EE server (j2ee-server), the start and stop of J2EE server and abnormal termination messages are output in an event log (in UNIX, syslog).
This manual
3.3.6

SFO server log
Set up the output level of a log, size and number of files in the <configuration> tag of logical SFO server (sfo-server) in the Easy Setup definition file.
This manual
3.3.8

Web server log
Set up the output level of a log and output destination of Web server in the <configuration> tag of logical Web server (web-server) in the Easy Setup definition file.
This manual
3.3.9

Redirector log
Set up the output level of a log, size, and number of files of redirector in the <configuration> tag of logical Web server (web-server), in the Easy Setup definition file.
Specify prefixes of log file names in mod_jk.conf.
This manual
3.3.10

In-process HTTP server log
Set up the availability of log output in the in-process HTTP server and the number of files in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file. You can define the format to customize the output format of an access log.
For details about customizing access logs of the in-process HTTP server, see 5.17.2 Customizing the access logs of the in-process HTTP server in the uCosminexus Application Server Web Container Functionality Guide.
This manual
3.3.11

Operation information file
Set up output destination of operation information file or number of files in the <configuration> tag of logical J2EE server (j2ee-server) or logical SFO server (sfo-server) in the Easy Setup definition file.
uCosminexus Application Server Operation, Monitoring, and Linkage Guide
3.3.3

Cosminexus Manager log
Use manager.cfg to specify the number and size of the files of the integrated log.
This manual
3.3.12

Console log
Use adminagent.properties to specify the application of output, the number, and the size of the console log files.
uCosminexus Application Server Operation, Monitoring, and Linkage Guide
11.3

Resource adapter log
Specify the application of log output for each resource adapter using Server management commands.
Set up the output level of a log, size, and the number of files in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file.
This manual
3.3.13

Cosminexus TPBroker trace file
Set up the output destination of trace file or number of files in the Easy Setup definition file (in the <configuration> tag of logical J2EE server (j2ee-server)) and usrconf.bat (in UNIX, usrconf) and usrconf.properties for the server management commands.
This manual
3.3.14

Cosminexus JMS Provider log
Set up the output level, number of files, and log file size in commonconfig.properties or config.properties and admin.properties for the CJMSP Broker and the management command (cjmsicmd) log.
Also, set up the output level, number of files, and log file size of the CJMSP resource adapter log in the Connector property file.
This manual
3.3.15

Server management command log
You can use usrconf.bat (in UNIX, usrconf) and usrconf.properties for server management commands to specify the log output level.
uCosminexus Application Server Application Setup Guide
3.4

The snapshot logs described here can be collected in batches. In the trace file of Cosminexus TPBroker, the material that can be collected and the material that cannot be collected are mixed. In addition to this, you need to make the settings for collection and add the collection destination of the snapshot log for those logs that cannot be acquired with default settings. Collect user dumps (in Windows) or core dumps (in UNIX) for specific file names. To collect the material when an error occurs, you need to use the user created command at error detection time.

Note that you cannot change the log output destination for the following logs:

The install.log created during setup or log files of migration commands

The Java thread dump files output to the following directories:

In Windows
working-directory\ejb\server-name

In UNIX
working-directory/ejb/server-name

For details about log types or default values, channel names, details of logs that can be acquired or acquisition methods, see 2.4 Types of Required Data.

3.2.3 Overview of data acquisition settings (Systems executing batch applications)

For changing the default settings (output destination or log size) of data or acquiring the data that is not acquired by default, edit the Easy Setup definition file or the user-defined file. This subsection describes whether you must specify the settings for the systems executing batch applications to acquire the data (log) in advance. This subsection also provides an overview of the setting methods.

For each data type, the following tables separately describe the data items for which the data collection settings must be specified and the data items for which settings must only be specified when changing the default data collection settings.

Data items that require data collection settings

Table 3-5 Data acquisition settings (Systems executing batch applications)

Type of material
Settings for collecting the material
Reference manual
Reference point

Application user log
Set up the logger or handler settings, output level of a log, size and number of files in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file.
Use server.policy to specify the security policy.
uCosminexus Application Server Expansion Guide
Chapter 9

Statistical information of OS
In Windows, specify the performance data collection settings of system resources on the Windows system monitor.
This manual
3.3.16#1

User dump
In Windows, specify the settings for collecting user dumps with Dr. Watson#2.
This manual
3.3.17#1

core dump
In Unix, specify the settings for collecting core file using the simple setup definition file and shell commands.
This manual
3.3.18#1

JavaVM material
Set up the thread dump of JavaVM, output methods or output contents of the JavaVM logs (JavaVM log files) in the Easy Setup definition file. You can also set up file names to the output event log or output level of logs of the Explicit Heap Memory Management functionality.
This manual
3.3.19#1

#1

The setting method is same as that of the J2EE server. Substitute J2EE server in the description of reference sections to batch server, and read.

#2

In this manual, the Dr. Watson Diagnostic Tool included in Windows is referred to as Dr. Watson.

Data items that must be set up only when changing the default data collection settings

Table 3-6 Data acquisition settings (Systems executing batch applications)

Type of material
Settings for collecting the material
Reference manual
Reference point

snapshot log
To change the collection destination, collection method, and collection timing of the snapshot log, edit the user definition file
This manual
3.3.2, 3.3.4

Management Server log
Use mserver.properties (environment settings file of the Management Server) to set up the output level of a log and number of log files.
This manual
3.3.5#

Trace based performance analysis file
Use mserver.properties (environment settings file of Management Server) to specify the number of trace based performance analysis files.
Specify the trace acquisition level of performance tracer or number of PFR trace files in the <configuration> tag of logical performance tracer (performance-tracer) in the Easy Setup definition file.
This manual
7.5#

Batch server log
Set up the output level of a log, size, and number of files in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file.
When the settings of system log output are enabled by ejbserver.logger.systemlog.enabled in the <configuration> tag of logical J2EE server (j2ee-server), the start and stop of batch server and abnormal termination messages are output in an event log (in UNIX, syslog).
This manual
3.3.7

Operation information file
Set up the output destination of an operation information file or number of files in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file.
uCosminexus Application Server Operation, Monitoring, and Linkage Guide
3.3.3

Cosminexus Manager log
Use manager.cfg to specify the number and size of the files of the integrated log.
This manual
3.3.12#

Console log
Use adminagent.properties to specify the application of output, the number, and the size of the console log files.
uCosminexus Application Server Operation, Monitoring, and Linkage Guide
11.3#

Resource adapter log
Specify the application of log output for each resource adapter using Server management commands.
Set up the output level of a log, size, and number of files in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file.
This manual
3.3.13#

Cosminexus TPBroker trace file
Set up the output destination of trace files or number of files in the Easy Setup definition file (in the <configuration> tag of logical J2EE server (j2ee-server)) and the usrconf.bat (in UNIX, usrconf) and usrconf.properties for the server management commands.
This manual
3.3.14#

Server management command log
You can use usrconf.bat (in UNIX, usrconf) and usrconf.properties for server management commands to specify the log output level.
uCosminexus Application Server Application Setup Guide
3.4

#

The setting method is same as that of the J2EE server. Substitute J2EE server in the description of reference sections to batch server, and read.

The snapshot log can collects the logs described in table, in batches. In the trace file of Cosminexus TPBroker, the material that can be collected and the material that cannot be collected are mixed. In addition to this, you need to make the settings for collection and add the collection destination of the snapshot log for those logs that cannot be acquired with default settings. Collect user dumps (in Windows) or core dumps (in UNIX) for specific file names. To collect the material when an error occurs, you need to use the user created command at error detection time.

Note that you cannot change the log output destination for the following logs:

The install.log created during setup or log files of migration commands

The Java thread dump files output to the following directories:

In Windows
working-directory\ejb\server-name

In UNIX
working-directory/ejb/server-name

For details about the log types or default values, channel names, details of logs that can be acquired or acquisition methods, see 2.4 Types of Required Data.

3.3 Execution environment settings

Among the data required for troubleshooting, some data require the settings before starting operations and for some data you can change the default settings. This section describes how to set up each material. For details about the data that require in advance settings or changes in the settings, see 3.2 Overview of data acquisition settings.

Organization of this section

3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications)

3.3.2 Data acquisition settings using failure detection time commands (Systems for executing batch applications)

3.3.3 Settings for collecting snapshot logs (Systems for executing J2EE applications)

3.3.4 Settings for collecting snapshot log (Systems for executing batch applications)

3.3.5 Settings for acquiring the Management Server log

3.3.6 Settings for Acquiring the J2EE Server Log

3.3.7 Settings for Acquiring the Batch Server Log

3.3.8 Settings for Acquiring the SFO Server Log

3.3.9 Settings for Acquiring the Web Server Log

3.3.10 Settings for Acquiring the Redirector Log

3.3.11 Settings for acquiring the in-process HTTP server log

3.3.12 Settings for Acquiring the Cosminexus Manager Log

3.3.13 Settings for Acquiring the Resource Adapter Logs

3.3.14 Settings for Acquiring the Cosminexus TPBroker Log

3.3.15 Settings for collecting Cosminexus JMS Provider logs

3.3.16 Settings for Collecting the OS Statistical Information

3.3.17 Settings for Collecting a User Dump

3.3.18 Settings for Acquiring a Core Dump

3.3.19 Settings for Acquiring the JavaVM Material

3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications)

This subsection describes how to specify the settings to acquire the data for troubleshooting using the failure detection time commands. Note that you can collect the material acquired by the failure detection time commands as the snapshot log.

There are two types of failure detection time commands; commands that the system provides and commands that the user creates.

According to the default settings, when an error occurs in a logical server, the failure detection time commands provided by the system are executed and thread dumps and trace based performance analysis are acquired. The snapshot log is collected before terminating the logical server where the error occurs. For the information that can be acquired by executing the failure detection time commands provided by the system, see 2.3.2(1) Information that can be acquired by executing the failure detection time commands provided by the system.

To change the operation settings of the failure detection time commands provided by the system, (1) Environment settings in the Management Server and (2) Environment settings in the Administration Agent are necessary. Also, when using the user created failure detection time commands, (1) Environment settings in the Management Server, (2) Environment settings in the Administration Agent, and (3) Creating a command file of the user created failure detection time commands are necessary. Respective settings are described in points from (1) to (3).

Note

To collect the material acquired by the user created failure detection time commands as the snapshot log, you need to add the collection destination of that material to the snapshot log collection destination. For details about addition of the snapshot log collection destination, see 3.3.3(3) Customizing the snapshot log collection destination.

Organization of this subsection

(1) Environment settings in the Management Server

(2) Environment settings in the Administration Agent

(3) Creating a command file of the user created failure detection time commands

(1) Environment settings in the Management Server

Use mserver.properties (environment settings file of Management Server) to specify the operation of the failure detection time commands.

Specify the operation of the failure detection time commands in the following keys.

Key
Description
Setting requirement

System
User

com.cosminexus.mngsvr.sys_cmd.abnormal_end.enabled
Specify whether to use system provided failure detection time commands. The default setting is true (use).
O
--

com.cosminexus.mngsvr.usr_cmd.abnormal_end.enabled
Specify whether to use the user created failure detection time commands. The default setting is false (do not use).
--
R

com.cosminexus.mngsvr.sys_cmd.abnormal_end.timeout
Specify the waiting period for termination of system provided failure detection time commands. If the command does not terminate even after the specified time lapses, the user recovery process continues.
O
--

com.cosminexus.mngsvr.usr_cmd.abnormal_end.timeout
Specify the waiting period for termination of the user created failure detection time commands.
--
O

com.cosminexus.mngsvr.snapshot.auto_collect.enabled
Specify whether to acquire the snapshot log when an error occurs or for batch restart. The default setting is true (acquire the snapshot log).
O
O

com.cosminexus.mngsvr.snapshot.collect.point
Specify one of the following as the snapshot log collection timing:

Before terminating the logical server

Before restarting the J2EE server

The default timing is before terminating the logical server.
O
O

Legend:

System: You need to set the system provided failure detection time commands.

User: You need to set the user created failure detection time commands.

R: Required

O: Required only when changing the default settings.

--: Not required

(2) Environment settings in the Administration Agent

Use adminagent.properties (Administration Agent property file) to specify the material to be acquired by the failure detection time commands.

In the following keys of adminagent.properties, specify the count of the material to be acquired, application of collection using the failure detection time commands, and the path of the failure detection time commands. For details on the files defining the snapshot log collection target, see 3.3.3(3) Customizing the snapshot log collection destination

Key | Description | Setting requirement
System | User
adminagent.snapshotlog.num_snapshots | Specify the number of snapshot log files to be collected as the primary delivery data for each logical server. | O | O
adminagent.snapshotlog.listfile.2.num_snapshots | Specify the number of snapshot log files to be collected as the secondary delivery data for each logical server. | O | O
adminagent.j2ee.sys_cmd.abnormal_end.threaddump | Specify whether to acquire thread dumps using the system provided failure detection time commands. | O | --
adminagent.sys_cmd.abnormal_end.prftrace | Specify whether to acquire the trace based performance analysis file using the system provided failure detection time commands. | O | --
adminagent.logical-server-type.usr_cmd.abnormal_end | Specify the path of failure detection time commands to be executed for each type of logical server. | -- | R

Legend:

System: You need to set the system provided failure detection time commands.

User: You need to set the user created failure detection time commands.

R: Required

O: Required only when changing the default settings.

--: Not required

(3) Creating a command file of the user created failure detection time commands

You can code the user created failure detection time commands in a command file (batch file or shell script file). At this time, you can code the environment variables described in the following table, in the command file to execute the commands using the information of the logical server where the error occurred and the information related to the error.

Table 3-7 Environment variables that you can code in the command file of the user created failure detection time commands

Environment variable
Description

COSMI_MNG_LSNAME
Logical server name of the logical server where the error occurred. When an error occurs in the naming service of the logical CTM, the logical server name of logical CTM will be set up.

COSMI_MNG_RSNAME
Actual server name of the logical server where the error occurred. For a logical server other than a J2EE server or SFO server, the logical server name is set.

COSMI_MNG_LSPID
Process IDs to be monitored when the logical server starts. When monitoring multiple process IDs on an indirectly started logical user server, the process IDs are specified, demarcated by commas (,) in the order in which the process IDs are acquired by the command executed for acquiring the process IDs when the logical user server is started.

COSMI_MNG_LSARGS
Command line when the logical server is started.

COSMI_MNG_TIME_SUSPENDED
Time at which hang up is detected. Time lapsed (unit: ms) from 0 hour before January 1, 1970 of the universal coordinated time (UTC). Note that the value is set only if the response is detected.

COSMI_MNG_TIME_TERMINATED
Time at which abnormal termination (process down) is detected. Time lapsed (unit: ms) from 0 hour before January 1, 1970 of the universal coordinated time (UTC). Note that the value is not set if hang up occurs.

COSMI_MNG_WEB_SYSTEM
Web system affiliated to the logical server where an error occurs. The value is not required if you do not use the Smart Composer function.

COSMI_MNG_TIER
Physical tier affiliated to the logical server where an error occurs. The value is not required if you do not use the Smart Composer function.

COSMI_MNG_UNIT
Service unit affiliated to the logical server where an error occurs. The value is not required if you do not use the Smart Composer function.

COSMI_MNG_HWS
Cosminexus HTTP Server installation directory.

The Management Server cannot acquire the standard output and standard error output from the commands executed as commands to detect error. To acquire the standard output and standard error output of a command, information must be output to a file during command execution.

(a) Examples of obtaining the user dump or core dump

The following examples describe the execution of the drwtsn32 or kill command when an error is detected in the J2EE server and the collection of user dumps or core dumps:

In Windows

Determine whether the rem error has occurred because the process is down or hung up, from the date and time at which it is detected that the process is down.
if defined COSMI_MNG_TIME_TERMINATED goto END

Acquire a user dump because the rem error has occurred due to hang-up of the process.
"C:\WINDOWS\system32\drwtsn32.exe" -p %COSMI_MNG_LSPID%

:END

In UNIX

#!/bin/sh

# Determine whether the rem error has occurred because the process is down or hung up, from the date and time at which it is detected that the process is down.
if [ "$COSMI_MNG_TIME_TERMINATED" = "" ] ; then

# Acquire a core dump because the error occurred due to hang-up of the process.
/bin/kill -6 $COSMI_MNG_LSPID
fi

(b) Example of obtaining the thread dump

The following is an example of the case in which the cjdumpsv command is executed to obtain the J2EE server (real server name: J2EEServer) thread dump when a Web server error occurs.

In this example, the cjdumpsv command is executed multiple times to check the status transition of each thread in accordance with the lapsed time. As a standard, the cjdumpsv command is executed about ten times every three seconds.

In Windows

Determine whether the rem error has occurred because the process is down or hung up, from the environment variables.
if defined COSMI_MNG_TIME_TERMINATED goto END

Acquire the thread dump because the rem error has occurred due to the hung-up process.
set COUNT=10
set INTERVAL=3000
for /l %%n in (1,1,%COUNT%) do (
"C:\Program Files\Hitachi\Cosminexus\CC\server\bin\cjdumpsv.exe" J2EEServer
if not "%%n" == "%COUNT%" (
rem Stand by until the next thread dump is collected.(milliseconds)
echo WScript.sleep %INTERVAL% > sleep.vbs
"C:\WINDOWS\\system32\cscript.exe" sleep.vbs > NUL
del sleep.vbs
)
)
:END

In UNIX

#!/bin/sh

# Determine whether the error has occurred because the process is down or hung up, from the environment variables.
if [ "$COSMI_MNG_TIME_TERMINATED" = "" ] ; then

# Acquire the thread dump because the error has occurred due to the hung-up process.
COUNT=10
INTERVAL=3
for num in 'seq $COUNT'
do
/opt/Cosminexus/CC/server/bin/cjdumpsv J2EEServer
if [ "$num" -ne "$COUNT" ]; then
# Stand by until the next thread dump is collected.(Seconds)
sleep $INTERVAL
fi
done
fi

(c) Operating user-created failure detection time commands

The logical CTM starts, stops, and monitors two processes; the global CORBA Naming Service and the CTM daemon. There are different execution commands for the case when an error is detected in the global CORBA Naming Service and in the CTM daemon respectively, within the logical server.

When detecting an error in global CORBA Naming Service
The command specified in the adminagent.naming.usr_cmd.abnormal_end key is executed.

When detecting an error in CTM daemon
The command specified in the adminagent.ctm.usr_cmd.abnormal_end key is executed.

Moreover, an error is detected in either of the two processes (CTM daemon or global CORBA Naming Service) in the logical CTM, therefore, the log that reports the startup of the failure detection time commands in the logical server (CTM) will be output in a Management Server log.

3.3.2 Data acquisition settings using failure detection time commands (Systems for executing batch applications)

This subsection describes the settings to acquire the data for troubleshooting using the failure detection time commands. You can collect the material acquired by using the failure detection time commands as the snapshot log.

There are 2 types of failure detection time commands namely, system provided commands and user created commands. According to the default settings, when an error occurs in a logical server, the failure detection time commands provided by the system are executed and thread dumps and trace based performance analysis are acquired. The snapshot log is collected before terminating the logical server where the error occurs. For the information that can be collected by using the failure detection time command provided by system, see 2.3.2(1) Information that can be acquired by executing the failure detection time commands provided by the system.

To change the operation settings for the failure detection time commands provided by the system, you must make environment settings in Management Server and Administration Agent. When using the failure detection time commands created by the user, you must make environment settings in Management Server and Administration Agent as well as create a command file for the failure detection time commands created by the user. For respective settings, see 3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications). Here, read "J2EE server" as "Batch server".

Note

To collect the material acquired by the user created failure detection time commands as the snapshot log, you need to add the collection destination of that material to the snapshot log collection destination. For details about addition of the snapshot log collection destination, see 3.3.3(3) Customizing the snapshot log collection destination.

3.3.3 Settings for collecting snapshot logs (Systems for executing J2EE applications)

This subsection describes the settings for collecting snapshot logs. You can change the settings of the files that are collected as snapshot log and storage destination of the collected snapshot logs.

Organization of this subsection

(1) Data that you can collect for each snapshot log collection timing

(2) Files that can be collected in a snapshot log

(3) Customizing the snapshot log collection destination

(4) Setting snapshot log collection timeout

(1) Data that you can collect for each snapshot log collection timing

The following table describes the settings to change the method to collect the snapshot logs according to the collection timing.

Table 3-8 Settings for changing the snapshot log collection (for a system on which J2EE applications runs)

Category
Collection timing
Settings required to change the default settings

Automatic collection#
Immediately before the automatic termination when the logical server fails

Settings of failure detection time commands

Customization of the collection destination of snapshot logs

Timeout settings for snapshot log collection

Immediately before the automatic restart when the J2EE server fails

Immediately before the J2EE server is restarted manually in a batch

Customization of the collection destination of snapshot logs

Collect at the specified timing
When the management command (mngsvrutil) of the Management Server is executed to collect the snapshot log

#

You can change the timing of collection of snapshot logs to before terminating the logical server or before restarting the J2EE server in the com.cosminexus.mngsvr.snapshot.collect.point key of mserver.properties. According to the default settings, the snapshot log is collected when the logical server stops.

The following points describe the data that you can collect according to the collection timing.

(a) Automatic collection

When the snapshot log is automatically collected at either of the following times, the Management Server executes the failure detection time commands, and the material such as thread dumps and trace based performance analysis are acquired:

Immediately before automatic termination when the logical server fails (default settings)

Immediately before the automatic restart when the J2EE server fails

You can collect the material collected using the failure detection time commands as the snapshot log. For details about changing operations and settings of the failure detection time commands, see 3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications).

(b) Any time collection

You can collect the snapshot log at any time only when thread dump files and user dumps (in Windows) or core dumps (in UNIX) are output. When collecting the snapshot log at any time, thread dump files and user dumps or core dumps are not output when the command is executed.

To collect the snapshot log at any time by executing the operation management commands (mngsvrutil) of the Management Server, you can specify the type of collection destination (type 1 or type 2) when executing the command to collect the snapshot log. When collecting at other times, all files defined as collection targets of type 1 and type 2 are collected.

(2) Files that can be collected in a snapshot log

The troubleshooting data is classified into primary delivery data and secondary delivery data according to the time at which the data is sent to the maintenance personnel. You can collect the primary and secondary delivery data in snapshot log. For each type of data, see 2.3.3(2) Data that can be collected as snapshot log.

Specify the file to be collected as primary delivery data in the snapshot log collection definition file (snapshotlog.conf) of primary delivery data. When collecting the snapshot log, if you specify the argument snapshot 1 in the mngsvrutil command, files specified in snapshotlog.conf are collected. Specify the files to be collected as secondary material in the snapshot log collection target definition file (snapshotlog.2.conf) of secondary delivery data. When collecting the snapshot log, if you specify the argument snapshot 2 in the mngsvrutil command, files specified in snapshotlog.conf and snapshotlog.2.conf are collected.

When you want to collect the files that are not defined as the snapshot log collection destination by default as the snapshot log, add the output destination of those files to the snapshot log collection target definition file. The following settings may also be required depending on the material:

Settings to acquire the material before starting an operation
You need to make the settings for collecting the material before starting the operation.

Acquiring the material using commands
Before collecting as the snapshot log, you need to execute commands to acquire the material targeted for collection. For details about data acquisition, see 4. Output Destinations and Output Methods of Data Required for Troubleshooting.

(Examples)

Before starting the operation, you need to set Dr. Watson, environment variables, or the core file size for user dumps or core dumps. Hitachi recommends that before starting the operation you make the settings for collection and acquire user dumps or core dumps when an error is detected using the user created failure detection time commands, and then collect user dumps or core dumps as the snapshot log.

The default output destination of user dumps or core dumps is specified in the default snapshot log collection target definition file. When you specify Dr. Watson, or the environment variable (CJMEMDUMP_PATH), or the OS is set in a drive other than C, you need to change the collection destination of the snapshot log.

For details about settings of the collection to be implemented before starting the operation, see 3.3.17 Settings for Collecting a User Dump or 3.3.18 Settings for Acquiring a Core Dump. For details about the failure detection time commands created by user, see 3.3.1 Data acquisition settings using failure detection time commands (Systems for executing J2EE applications).

For specifying snapshotlog.conf and snapshotlog.2.conf, see (3) Customizing the snapshot log collection destination. For details about the data to be collected as the primary delivery data and the secondary delivery data as per the default settings, see Appendix A. List of Snapshot Logs to Be Collected.

(3) Customizing the snapshot log collection destination

You can customize the snapshot log collection target definition file as the snapshot log collection destination. You can also use adminagent.properties to specify the number of files of the snapshot log for each logical server. For details about the file, see 12.2 snapshot log collection definition file in the uCosminexus Application Server Definition Reference Guide.

(a) Specifying the snapshot log collection destination

Edit the snapshot log collection target definition file and specify the collection destination for the snapshot log. The storage location of the file listing the files targeted as the snapshot log collection target definition file is as follows:

In Windows
Cosminexus-installation-directory\manager\config\snapshotlog.conf
Cosminexus-installation-directory\manager\config\snapshotlog.2.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.conf
/opt/Cosminexus/manager/config/snapshotlog.2.conf

Specify the destination directory to be collected files as the Primary delivery data in snapshotlog.conf. Also, specify the destination directory to be collected files as the secondary delivery data in snapshotlog.2.conf.

In snapshot log collection target definition file, you can use a variable for the collection path. For example, if "${cosminexus.home}/manager/log/.+" (period (.) represents optional character, and plus (+) represents more than 1 time) is specified for the snapshot log collection target definition file by using "${cosminexus.home}" variable that represents Cosminexus installation directory, all files under Cosminexus-installation-directory/manager\log (in Windows) or /opt/Cosminexus/manager/log directory (in UNIX) are collected. Do not include the dollar sign ($) in the variable value of the snapshot log collection target definition file.

(b) Specifying the number of snapshot log files

You can use the following keys of adminagent.properties to change the number of snapshot log files for each logical server. Default setting is 10. For adminagent.properties, see 10.2 adminagent.properties (Administration Agent properties file) in the uCosminexus Application Server Definition Reference Guide.

adminagent.snapshotlog.num_snapshots
Specify the number of snapshot log files to be collected as the primary delivery data for each logical server.

adminagent.snapshotlog.listfile.2.num_snapshots
Specify the number of snapshot log files to be collected as the secondary delivery data for each logical server.

(c) Specifying storage destination for the snapshot log

You can change the storage destination of the information that is automatically collected by snapshot log collection by using the adminagent.snapshotlog.log_dir key of adminagent.properties. By default, the information is stored at the following locations:

In Windows
Log-output-folder-of-Manager\snapshot

In UNIX
Log-output-directory-of-Manager/snapshot

For adminagent.properties, see 10.2 adminagent.properties (Administration Agent properties file) in the uCosminexus Application Server Definition Reference Guide.

(4) Setting snapshot log collection timeout

You can set the timeout for the processes that are executed when collecting the snapshot log. Set the timeout in mserver.properties. The following table shows the processes that are executed when collecting snapshot logs and their timeouts.

Table 3-9 Processes that are executed when collecting snapshot logs and timeout settings

Process
Timeout settings (mserver.properties key)
Explanation

Execution of the failure detection time command provided by the system
com.cosminexus.mngsvr.sys_cmd.abnormal_end.timeout
Shows the time that the program waits till each of the following processes ends:

Failure detection time command provided by the system

Collection of trace based performance analysis

If the command or collection of trace based performance analysis does not end even after the specified time has elapsed, ignore the executed command or collection of trace based performance analysis and continue the process.

Execution of the failure detection time command created by the user
com.cosminexus.mngsvr.usr_cmd.abnormal_end.timeout
Shows the time the program waits till the user created failure detection time command ends. If the command does not end even after the specified time has elapsed, ignore the executed command and continue the process.

snapshot log (primary delivery data) collection
com.cosminexus.mngsvr.snapshot.timeout
Shows the time the program waits till the collection of primary and secondary delivery data ends. If the collection does not end even after the specified time has elapsed, a service request for canceling the snap log collection is sent from Management Server to Administration Agent, and a KEOS20052-E message is output in the Management Server log.

snapshot log (secondary delivery data) collection

For mserver.properties, see 10.7 mserver.properties (Management Server environment settings file) in the uCosminexus Application Server Definition Reference Guide.

3.3.4 Settings for collecting snapshot log (Systems for executing batch applications)

This subsection describes the settings for collecting the snapshot log when using a batch server. You can change the settings of the files that are collected as snapshot log and storage destination of the collected snapshot logs. The following table describes the settings required for changing the method for collecting snapshot logs according to the collection timing. Other details are same as that of a J2EE server. For details, see 3.3.3 Settings for collecting snapshot logs (Systems for executing J2EE applications).

Table 3-10 Settings for changing the snapshot log collection (for the system on which batch applications run)

Category
Collection timing
Settings required to change the default settings

Automatic collection#
Immediately before the automatic termination when the logical server fails

Settings of failure detection time commands

Customization of the collection destination of snapshot logs

Setting snapshot log collection timeout

Immediately before the automatic restart when the batch server fails.

Immediately before the batch server is restarted manually in a batch.

Customization of the collection destination of snapshot logs

Collect at the specified timing
When the management command (mngsvrutil) of the Management Server is executed to collect the snapshot log

#

You can change the timing of collection of snapshot logs to before terminating the logical server or before restarting the batch server in the com.cosminexus.mngsvr.snapshot.collect.point key of mserver.properties. According to the default settings, the snapshot log is collected when the logical server stops.

3.3.5 Settings for acquiring the Management Server log

This subsection describes the settings for acquiring logs output by the Management Server.

The following is the output destination directory of the Management Server. You can change the output destination of the Management Server by using manager.cfg (Manager log settings file).

In Windows
Cosminexus-installation-directory\manager\log

In UNIX
/opt/Cosminexus/manager/log

Specify the following key in mserver.properties (Management Server environment setup file) to change the output level or the number of log files of the Management Server log.

com.cosminexus.mngsvr.log.level
Specify the output level of the Management Server log.

com.cosminexus.mngsvr.log.rotate
Specify the number of files of the Management Server log.

com.cosminexus.mngsvr.log.size
Specify the file size of the Management Server log.

For details about mserver.properties and the keys, see 10.7 mserver.properties (Management Server environment settings file) in the uCosminexus Application Server Definition Reference Guide.

Note

In UNIX, the Manager log output directory is created automatically by specifying 777 (rwxrwxrwx) in the access permission. To specify a previously manually-created directory in the log output destination, set up 777 (rwxrwxrwx) in the directory access permission. If 777 (rwxrwxrwx) is not set up in the access permission of the directory specified in the log output destination, the log might not be output during the execution of the command.

3.3.6 Settings for Acquiring the J2EE Server Log

This subsection describes the items that you can set up for acquiring J2EE server logs.

You can change the log output destination, log size, the log level, the switching method of the log output destination files, and the switching time of the log output destination files for the J2EE server logs. The following table describes the items that you can change and the corresponding parameters of the Easy Setup definition file.

Table 3-11 Settings for acquiring J2EE server log

Items
Corresponding parameter of the Easy Setup definition file

Log output destination
ejb.server.log.directory in the <configuration> tag on a logical J2EE server (j2ee-server)

Log size

Number of log files

ejbserver.logger.channels.define.channel-name.filenum in the <configuration> tag on a logical J2EE server (j2ee-server)

Maximum size for each log file

ejbserver.logger.channels.define.channel-name.filesize in the <configuration> tag on a logical J2EE server (j2ee-server)

Log level
ejbserver.logger.enabled.* in the <configuration> tag on a logical J2EE server (j2ee-server)

Switching method of the log output destination files
ejbserver.logger.rotationStyle in the <configuration> tag of the logical J2EE server (j2ee-server)

Switching time of the log output destination files
ejbserver.logger.rotationTime in the <configuration> tag of the logical J2EE server (j2ee-server)

If you specify true (default value) in the ejbserver.logger.systemlog.enabled parameter in the <configuration> tag of logical J2EE server (j2ee-server) or if the specification of this parameter is omitted, the message indicating startup, termination, and abnormal termination of the J2EE server will output to an event log (in UNIX, syslog).

Notes (in UNIX)

To output messages related to J2EE server start, stop, and abnormal termination, to syslog, it is necessary to set the priority for the facility daemon to info or debug in the syslog settings. Moreover, the log output destination and log file name of syslog depend on the settings of syslog.

For details about the syslog and its settings, see the description on syslogd or syslog.conf in the manual provided with OS.

For details about the Easy Setup definition file and parameters, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

Organization of this subsection

(1) Changing log output destination

(2) Change log size

(3) Changing the log level

(1) Changing log output destination

Specify the log output destination directory in the Easy Setup definition file to change the output destination of the J2EE server log.

Changing log output destination

The default log output destination is as follows:

In Windows
working-directory\ejb\server-name\logs

In UNIX
working-directory/ejb/server-name/logs

Note that the default directory path of the working directory is Cosminexus-installation-directory\CC\server\public (in Windows) or /opt/Cosminexus/CC/server/public (in UNIX).

You can change the output destination of the working directory and J2EE server log if you specify following parameters in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file:

ejb.public.directory
Specify the path of the working directory of the J2EE server.

ejb.server.log.directory
Specify the output destination directory of the J2EE server log.

Setup example (For definition of the physical tier)

In Windows

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejb.server.log.directory</param-name>
 <param-value>C:\CClogs\server\MyServer</param-value>
</param>
:
</configuration>

In UNIX

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejb.server.log.directory</param-name>
 <param-value>/CClogs/server/MyServer</param-value>
</param>
:
</configuration>

Current directory

The following is the current directory where the log output destination is specified by a relative path:

In Windows
working-directory\ejb\server-name

In UNIX
working-directory/ejb/server-name

Notes

After changing the log output destination, create a log output destination directory before starting the J2EE server.
If there is no log output destination directory after the change, the message KDJE40024-E will output and an abnormal termination will occur when starting the J2EE server. Moreover, the messages KDJE37209-E, KDJE37210-E, and KDJE37211-E will output and an abnormal termination will occur when executing the Management Server.

For starting multiple J2EE servers on the same host, keep the directory name unique for each server including the server name in the directory, so that the log output destination does not have the same directory. When specifying the same directory for a parameter value, the operation is not guaranteed.

After changing the log output destination, if you want to output the log to a directory other than the working directory, you cannot delete the log file if the server is not set up. If you want to delete the log file, delete it manually.

Note that if you set up the JavaVM maintenance information and the output destination of the garbage collection log in the JavaVM startup parameter, the settings of JavaVM startup parameter are given priority, even when the log output destination is set up in the Easy Setup definition file.
A JavaVM startup parameter is defined in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. The specified contents of the JavaVM startup parameter are as follows:

<param-name> tag

add.jvm.arg

<param-value> tag

XX:HitachiJavaLog:<JavaVM-Maintenance-information and garbage-collection-log-output-destination>

When you specify the JavaVM startup parameter, the JavaVM maintenance information and the log file of garbage collection is output to the directory set up for the JavaVM maintenance information and for the output destination of garbage collection log respectively.

You cannot specify the path including UNC name in the log output destination.

(2) Change log size

Set up the number of log files and the maximum size for each log file in the Easy Setup definition file to change the log size of the J2EE server.

Changing the number of log files

Specify the number of J2EE server log files in the ejbserver.logger.channels.define.channel-name.filenum parameter in the <configuration> tag of the logical J2EE server (j2ee-server).

Setup example (For definition of the physical tier)

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejbserver.logger.channels.define.MessageLogFile.filenum</param-name>
 <param-value>3</param-value>
</param>
...
</configuration>

Changing the maximum file size for each log file

Specify the maximum file size (unit: bytes) for each file of the J2EE server log files in the ejbserver.logger.channels.define.channel-name.filesize parameter in the <configuration> tag of the logical J2EE server (j2ee-server).

Setup example (For definition of physical tier)

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejbserver.logger.channels.define.MessageLogFile.filesize</param-name>
 <param-value>2097152</param-value>
</param>
...
</configuration>

(3) Changing the log level

A J2EE server log level indicates the importance of a log. In log levels, there are four levels; Error, Warning, Information, and Debug. If you set up a log level, the log of the level that is set up will be output. By default, you can acquire only an Error level log and use this log as it is.

Specify the log level in the ejbserver.logger.enabled.* parameter in the <configuration> tag of the logical J2EE server in the Easy Setup definition file. Set up the level names Error, Warning, Information, and Debug as one or in multiple character strings in the <param-value> tag of ejbserver.logger.enabled.*. When you set up multiple log levels, the character string of the level name will be demarcated using comma (,).

Setup example (For definition of the physical tier)

1.

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejbserver.logger.enabled.*</param-name>
 <param-value>Error</param-value>
</param>
...
</configuration>

2.

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejbserver.logger.enabled.*</param-name>
 <param-value>Error,Warning</param-value>
</param>
...
</configuration>

3.

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejbserver.logger.enabled.*</param-name>
 <param-value>Error,Warning,Information</param-value>
</param>
...
</configuration>

4.

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>ejbserver.logger.enabled.*</param-name>
 <param-value>Error,Warning,Information,Debug</param-value>
</param>
...
</configuration>

Notes

The number of logs that you can acquire increases in the order of 1, 2, 3, 4 as described in examples. If you acquire the log after setting up multiple log levels, the performance will decrease and the switching of log file will occur frequently.

If you set up a blank value or a character string other than Error, Warning, Information, and Debug for the level name, the message KDJE90009-W will output and the Error level log will be acquired.

Hitachi recommended settings for log level

Hitachi recommends following settings for a log level:

For normal operation
Specify Error in the level name.

For normal operation (verbose)
Specify Error, Warning in the level name to acquire more detailed information than that of the normal operation.

For test
Specify Error, Warning, Information in the level name.

At failure detection time
Specify Failure, Warning, Information, Debug in the level name.

3.3.7 Settings for Acquiring the Batch Server Log

You can change the log output destination, log size, and log level for batch server log. The following table describes the items that can be changed and the parameters of the Easy Setup definition file corresponding to these items. Furthermore, set up these parameters in the user property for the batch server in the Easy Setup definition file.

Table 3-12 Settings for acquiring batch server log

Items
Corresponding parameters of the Easy Setup definition file

Log output destination
ejb.server.log.directory in the <configuration> tag on a logical J2EE server (j2ee-server)

Log size

Number of log files

ejbserver.logger.channels.define.channel-name.filenum in the <configuration> tag on a logical J2EE server (j2ee-server)

Maximum size for each log file

ejbserver.logger.channels.define.channel-name.filesize in the <configuration> tag on a logical J2EE server (j2ee-server)

Log level
ejbserver.logger.enabled.* in the <configuration> tag on a logical J2EE server (j2ee-server)

If you specify true (default value) in the ejbserver.logger.systemlog.enabled parameter in the <configuration> tag of the logical J2EE server (j2ee-server) or if you skip specification of this parameter, the message indicating startup, termination, and abnormal termination of a batch server is output to the event log (in UNIX, syslog).

For details about the above-mentioned respective settings, see 3.3.6 Settings for Acquiring the J2EE Server Log. At this time, substitute J2EE server to batch server.

For details on the parameters to be specified in the Easy Setup definition file, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

Notes (in UNIX)

To output messages related to batch server start, stop, and abnormal termination, to syslog, it is necessary to set the priority for the facility daemon to info or debug in the syslog settings. Moreover, the log output destination and log file name of syslog depend on the setting of syslog.

For details about the syslog and its settings, see the description of syslogd or syslog.conf in the manual provided with OS.

3.3.8 Settings for Acquiring the SFO Server Log

This subsection describes the items that you can set up for acquiring SFO server logs.

You can change the log size and log levels of SFO server logs. The following table describes the items that you can change and the corresponding parameters of the Easy Setup definition file.

Table 3-13 Settings for acquiring SFO server log

Items
Corresponding parameters of the Easy Setup definition file

Log size

Number of log files

ejbserver.logger.channels.define.channel-name.filenum in the <configuration> tag on a logical SFO server (sfo-server)

Maximum size for each log file

ejbserver.logger.channels.define.channel-name.filesize in the <configuration> tag on a logical SFO server (sfo-server)

Log level
ejbserver.logger.enabled.* in the <configuration> tag on a logical SFO server (sfo-server)

If you specify true (default value) in the ejbserver.logger.systemlog.enabled parameter in the <configuration> tag of logical SFO server (sfo-server) or if you skip specification of this parameter, the message indicating start, termination, or abnormal termination of the SFO server will output to an event log (in UNIX, syslog).

Notes (in UNIX)

To output messages related to SFO server start, stop, and abnormal termination, to syslog, it is necessary to set the priority for the facility daemon to info or debug in the syslog settings. Moreover, the log output destination and the log file name of syslog depend on the settings of syslog.

For details about syslog and its settings, see the description of syslogd or syslog.conf in the manual provided with OS.

For details on the parameters to be specified in the Easy Setup definition file, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

Organization of this subsection

(1) Changing log size

(2) Changing the log level

(1) Changing log size

To change the SFO server log size, set up the number of log files and maximum size for each log file in the Easy Setup definition file. This setting method is same as the setting method for acquiring J2EE server logs. For details, see 3.3.6 Settings for Acquiring the J2EE Server Log.

(2) Changing the log level

An SFO server log level indicates the importance of a log. In log levels, there are four levels; Error, Warning, Information, and Debug. If you set up a log level, a log of the specified level will be output. By default, only Error level logs are acquired. Use this log as it is. The setting method is same as the setting method for acquiring J2EE server logs. For details, see 3.3.6 Settings for Acquiring the J2EE Server Log.

3.3.9 Settings for Acquiring the Web Server Log

This subsection describes the items that you can set up for acquiring Web server logs. The Web server set up for acquiring the logs is Cosminexus HTTP Server.

The logs output in the Web server are the Error logs, Access logs and the Request logs. For details about the output logs, see the uCosminexus Application Server HTTP Server User Guide. Among the output logs of the Web server, you can change the output destination or the output method of logs in the Easy Setup definition file for the Error log, Access log, and Request log.

The following table describes the settings of the items that you can change for acquiring the Web server log, and the corresponding parameters of the Easy Setup definition file.

Table 3-14 Settings for acquiring Web server log

Log | Items | Corresponding parameters of the Easy Setup definition file
Error log | Level of error log to be output | LogLevel in the <configuration> tag on a logical Web server (web-server)
Output method of the error log | HttpsdErrorMethod in the <configuration> tag on a logical Web server (web-server)
Output destination directory for error log | HttpsdErrorLogFileDir in the <configuration> tag on a logical Web server (web-server)
Access log | Output method of the access log | HttpsdCustomMethod in the <configuration> tag on a logical Web server (web-server)
Output destination directory for access log | HttpsdCustomLogFileDir in the <configuration> tag on a logical Web server (web-server)
Format of the access log to be output | HttpsdCustomlogFormat in the <configuration> tag on a logical Web server (web-server)
Request log | Trace extraction availability | HWSRequestLogLevel in the <configuration> tag on a logical Web server (web-server)
Output method of the request log | HttpsdRequestMethod in the <configuration> tag on a logical Web server (web-server)
Output destination directory of request log | HttpsdRequestLogFileDir in the <configuration> tag on a logical Web server (web-server)

Moreover, you can specify the unit of time and the output time for Error log, Access log, and Request log in the HWSLogTimeVerbose parameter in the <configuration> tag of logical Web server (web-server).

Notes

When checking the Web server operation by using Management Server, to output the operation check log apart from the usual log (access log), you must make settings in the Easy Setup definition file. Set the AppendDirectives and HttpsdCustomlogFormat parameters by specifying item in the SetBy parameter in the <configuration> tag of the logical Web server (web-server).

The AppendDirectives and HttpsdCustomlogFormat parameters are set as explained in the examples below. The example explains how to collect the operation check log by using the wraparound method. Change the description of the CustomLog directive in the AppendDirectives parameter according to the log output method.

Example of AppendDirectives parameter settings

In Windows

<param>
 <param-name>AppendDirectives</param-name>
 <param-value>
<![CDATA[
SetEnvIf Remote_Addr ^127\.0\.0\.1$ Env_ManagerHealthCheck
CustomLog "|\"\"Cosminexus installation directory/httpsd/sbin/rotatelogs2.exe\" \"Cosminexus-installation-directory/httpsd/servers/HWS_ actual-server-name-of-the-logical-Web-server/logs/access_manager\" 8192 5\"" hws_std env=Env_ManagerHealthCheck
]]>
 </param-value>
</param>

In UNIX

<param>
 <param-name>AppendDirectives</param-name>
 <param-value>
<![CDATA[
SetEnvIf Remote_Addr ^127\.0\.0\.1$ Env_ManagerHealthCheck
CustomLog "|/opt/hitachi/httpsd/sbin/rotatelogs2 \"/opt/hitachi/httpsd/servers/HWS_actual-server-name-of-the-
logical-Web-server/logs/access_manager\" 8192 5" hws_std env=Env_ManagerHealthCheck
]]>
 </param-value>
</param>

Example of HttpsdCustomlogFormat parameter settings

<param>
 <param-name>HttpsdCustomlogFormat</param-name>
 <param-value>hws_std env=!Env_ManagerHealthCheck</param-value>
</param>

3.3.10 Settings for Acquiring the Redirector Log

You can change the output destination or the log output level for the redirector output log. The redirector output log is output in two separate logs; message log and maintenance trace log. In a message log, a message for the log is output when an error occurs. In a maintenance trace log, the trace information from the reception of a HTTP request until sending of response is output.

Hitachi recommends that the log size of the maintenance trace log is to be customized to the size that is maintained from the time an error occurs until the error is detected and log is collected as per the estimation formula.

This subsection describes the items that you can set up for acquiring the redirector log for each of the following execution environments:

Environment using the Smart Composer function

Web redirector environment and environment that does not use the Smart Composer functionality.

Organization of this subsection

(1) Environment using the Smart Composer functionality

(2) Web redirector environment or environment that does not use Smart Composer functionality

(3) Notes

(1) Environment using the Smart Composer functionality

In the environment using the Smart Composer functionality (Management Server), you can change the settings for acquiring the redirector log in the Easy Setup definition file and mod_jk.conf. For details on the files and file keys used in the description, see 4. Files used in Smart Composer Functionality in the uCosminexus Application Server Definition Reference Guide. Furthermore, in UNIX, the user having a root permission (when Component Container administrator is not set up) or a Component Container administrator permission (when Component Container administrator is set up) can change the settings.

Method of enabling the changed settings

This point describes the methods of enabling the changed settings for each OS.

In Windows

To enable the settings for acquiring the changed redirector log, restart Cosminexus HTTP Server.

In UNIX

The methods of enabling the settings for acquiring the changed redirector log differ depending on the availability of change in the file size or number of files.

When file size or file count is changed

For changing the file size or file count, use the following methods to enabling the settings for acquiring the changed redirector log:

Terminate Cosminexus HTTP Server.

Move or delete the log file and management file.
For message log file: Move or delete the message log file and the management file (setup-value- of-JkTrcaeLogFilePrefix.mm) used by HNTRLib.
For maintenance trace log file: Move or delete the maintenance trace log file and the management file (setup-value- of-JkTrcaeLogFilePrefix.mm) used by HNTRLib.

Restart Cosminexus HTTP Server.

The default storage location of the management files that HNTRLib uses is as follows:

/opt/Cosminexus/CC/web/redirector/logs/mmap

When file size or file count is not changed

When you do not want to change the file size or file count, restart Cosminexus HTTP Server.

Settings that can be changed

The following table describes the settings that you can change and the setting contents of each file corresponding to these items.

Table 3-15 Settings for acquiring redirector log (Easy Setup definition file, mod_jk.conf)

Items
Setting location
Setting contents

Log output level for message log and maintenance trace log
Easy Setup definition file
Specify the output level of redirector log in the JkLogLevel parameter in the <configuration> tag of logical Web server (web-server).

Message log output destination
Specify the output destination directory in the
JkLogFileDir parameter in the <configuration> tag of the logical Web server (web-server).

Message log file size
Specify the file size for each log file that outputs redirector log in the JkLogFileSize parameter in the <configuration> tag of logical Web server (web-server).

Number of message log files
Specify the number of log files that output redirector log in the JkLogFileNum parameter in the <configuration> tag of the logical Web server (web-server).

Prefix for message log file name
mod_jk.conf
Specify a prefix for log file name that outputs redirector log in JkLogFilePrefix key in mod_jk.conf.

Availability of output of maintenance trace log
Easy Setup definition file
Specify whether to output a redirector maintenance trace log in the JkTraceLog parameter in the <configuration> tag of the logical Web server (web-server).

Output destination of maintenance trace log
Specify the output destination directory of the redirector maintenance trace log in JkTraceLogFileDir# in <configuration> of the logical Web server (web-server).

Maintenance trace log file size
Specify the file size for each log file that outputs a redirector maintenance trace log in the JkTraceLogFileSize parameter in <configuration> of the logical Web server (web-server).

Number of maintenance trace log files
Specify the number of log files that output a redirector maintenance trace log in JkTraceLogFileNum in <configuration> of the logical Web server (web-server).

Prefix for maintenance trace log file name
mod_jk.conf
Specify the prefix for the log file name that outputs a redirector maintenance trace log in JkTrcaeLogFilePrefix# in mod_jk.conf.

#

Do not specify the same values for the output destination and for the prefix of the maintenance trace log. If same values are specified, redirector will not operate.

Default output destination of the message log and maintenance trace log

In Windows
Cosminexus-installation-directory\CC\web\redirector\logs#

In UNIX
/opt/Cosminexus/CC/web/redirector/logs

#

The log directory does not exist at the time of new installation. The log directory is created while starting Cosminexus HTTP Server.

Log level name

You can specify any of emerg#, error, info, and debug for a log level name in the order of high priority.

emerg: Specify this for normal operation. Only the message, having a high priority that must always be output, is output.#

error: Specify this for normal operation.

Info: Specify this for testing.

Debug: Specify at failure detection time.

Specify the log level separately (do not specify the multiple log levels using comma demarcation). If you specify any log level, the specified log level and log having higher priority than the specified log is output.

#

You can specify in Windows.

Formula for estimating the log size

Estimate the log size for each HTTP access of GET request, POST request using the following formula:

Log size for each HTTP access by GET
= 1.75 + (average-response-body-size / 16)* 0.25

Log size for each HTTP access by POST
= 2.00 + (average-POST-data-size / 16)* 0.5 + (average-response-body-size / 16)* 0.25

Note that all units are in kilobytes and all the values after the decimal point in division result are rounded-off. Moreover, the average size of the request URL and query character string is considered to be of 100 bytes respectively in the formula. If the average size of the request URL and query character string exceeds 100 bytes, calculate the size by adding the increased size to the first value of the formula.

Notes

Consider the following points for the settings to acquire redirector logs:

When the log file initialization process starts and completes, the messages KDJE41029-I and KDJE41030-I are output to a message log respectively. Therefore, check whether the messages KDJE41029-I and KDJE41030-I are output to the message log to confirm that the log file initialization process has completed successfully while starting the Web server.

In UNIX, the file size set up in the Easy Setup definition file and the log file of the number of files are created when first startup process is executed after setting up a link with the Web server. To create a log file, you require processing time proportionate to the log file size and the number of files. If you set up a larger log file size or if you increase the number of files, the process will take time for creating a log file.

(2) Web redirector environment or environment that does not use Smart Composer functionality

In the Web redirector environment and in the environment that does use the Smart Composer functionality, the settings for acquiring the redirector log differ depending on the used Web server. For details about the files and the keys used in the description, see the uCosminexus Application Server Definition Reference Guide.

(a) In the case of Cosminexus HTTP Server

When using Cosminexus HTTP Server, you can change the settings for acquiring the redirector log in the mod_jk.conf file. Furthermore, in UNIX, the user having root permission (when Component Container administrator is not set up) or Component Container administrator permission (when Component Container administrator is set up) can change the settings.

Method of enabling the changed settings

This point describes the methods of enabling the changed settings for each OS.

In Windows

To enable the settings for acquiring the changed redirector log, restart Cosminexus HTTP Server.

In UNIX

The methods of enabling the settings for acquiring the changed redirector log differs depending on the availability of change in the file size or number of files.

When changing file size or file count

For changing the file size or file count, use the following method to enable the settings for acquiring the changed redirector log:

Terminate Cosminexus HTTP Server.

Move or delete the log file and the management file.
For message log file: Move or delete the message log file and the management file (setup-value-of-JkLogFilePrefix.mm) used by HNTRLib.
For maintenance trace log file: Move or delete the maintenance trace log file and the management file (setup-value-of-JkLogFilePrefix.mm) used by HNTRLib.

Restart Cosminexus HTTP Server.

The default storage location of the management files that HNTRLib uses is as follows:

/opt/Cosminexus/CC/web/redirector/logs/mmap

When not changing the file size or file count

When you do not want to change the file size or file count, restart Cosminexus HTTP Server.

Settings that can be changed

The following table describes the items that can be changed, and the user definition files and keys corresponding to these items.

Table 3-16 Settings for acquiring redirector log in Cosminexus HTTP Server

Items | mod_jk.conf key
Log output level for message log and maintenance trace log | JkLogLevel
Output destination of message log | JkLogFileDir
Message log file size | JkLogFileSize
Number of message log files | JkLogFileNum
Prefix for message log file name | JkLogFilePrefix
Availability of output of maintenance trace log | JkTraceLog
Output destination of maintenance trace log | JkTraceLogFileDir#
Maintenance trace log file size | JkTraceLogFileSize
Number of maintenance trace log files | JkTraceLogFileNum
Prefix for maintenance trace log file name | JkTrcaeLogFilePrefix#

#

Do not specify same values for the output destination and for the prefix of a maintenance trace log. If same values are specified, redirector will not operate.

Default output destination of the message log and maintenance trace log

In Windows
Cosminexus-installation-directory\CC\web\redirector\logs#

In UNIX
/opt/Cosminexus/CC/web/redirector/logs

#

The log directory does not exist during the new installation. The log directory is created while starting Cosminexus HTTP Server.

Log level name

You can specify any of emerg#, error, info, and debug for a log level name in the order of high priority.

emerg: Specify for normal operation. Only the message having a high priority that must always be output, is output.#

error: Specify this for normal operation.

Info: Specify this for testing.

Debug: Specify at failure detection time.

Specify the log level separately (do not specify the multiple log levels using comma demarcation). If you specify any log level, the specified log level and log having higher priority than the specified log is output.

#

You can specify in Windows.

Formula for estimating the log size

Estimate the log size for each HTTP access of GET request and POST request using the following formula:

Log size for each HTTP access by GET
= 1.75 + (average-response-body-size / 16)* 0.25

Log size for each HTTP access by POST
= 2.00 + (average-POST-data-size / 16)* 0.5 + (average-response-body-size / 16)* 0.25

Note that all the units are in kilobytes and all the values after the decimal point in division result are rounded-off. Moreover, the average size of the request URL and query character string is considered to be 100 bytes respectively in the formula. If the average size of the request URL and query character string exceeds 100 bytes, calculate the size by adding the increased size to the first value of the formula.

(b) Microsoft IIS

When using Microsoft IIS, you can change the settings for acquiring the redirector log in the isapi_redirect.conf file.

Notes

The file size set up in the isapi_redirect.conf file and the log file of the number of files are created when first request is executed after setting up a link with the Web server. To create a log file, you require the processing time proportionate to the log file size and the number of files. If you set up a larger log file size or if you increase the number of files, the process will take time for creating a log file.

Hitachi recommends that after setting up a link with Web server and after changing the log file settings, execute the first request before starting an operation.

Method of enabling the changed settings

To change the file size or the number of files, use the following procedure for enabling the settings to acquire the changed redirector log:

Terminate Microsoft IIS.

Move or delete the log file and management file.
For message log file: Move or delete the message log file and the management file (setup-value-of-log_file_prefix.mm) used by HNTRLib.
For maintenance trace log file: Move or delete the maintenance trace log file and the management file (setup-value-of-trace_log_file_prefix.mm) used by HNTRLib. Moreover, the default storage location of the management files that HNTRLib uses is as follows:
Cosminexus-installation-directory\CC\web\redirector\logs\mmap

Start Microsoft IIS.
When you do not want to change the file size or the number of files, the procedure for enabling the settings to acquire the changed redirector log is as follows.

Restart the Microsoft IIS, or recycle the worker process.
You can recycle the worker process using information service manager of Microsoft IIS.

Settings that can be changed

The following table describes the items that can be changed, and the user definition files and keys corresponding to these items. For details about isapi_redirect.conf, see 9.2 isapi_redirect.conf (Redirector operation definition file for Microsoft IIS) in the uCosminexus Application Server Definition Reference Guide.

Table 3-17 Settings for acquiring the redirector log in Microsoft IIS

Items | isapi_redirect.conf key
Log output level for message log and maintenance trace log | log_level
Output destination of the message log | log_file_dir
Message log file size | log_file_size
Number of files of message log | log_file_num
Prefix for message log file name | log_file_prefix
Availability of output of maintenance trace log | trace_log
Output destination of maintenance trace log | trace_log_file_dir#
Maintenance trace log file size | trace_log_file_size
Number of files of maintenance trace log | trace_log_file_num
Prefix for maintenance trace log file name | trace_log_file_prefix#

#

Do not specify same values for the output destination and for the prefix of a maintenance trace log. If same values are specified, redirector will not operate.

Default output destination of the message log and maintenance trace log:

Cosminexus-installation-directory\CC\web\redirector\logs#

#

The logs directory does not exist during the new installation. The logs directory is created while executing the first request.

Log level name

You can specify any of emerg#, error, info, and debug for a log level name in the order of high priority.

emerg: Specify this for normal operation. Only the message having high priority that must always be output, is output.#

error: Specify this for normal operation.

Info: Specify this for testing.

Debug: Specify at failure detection time.

Specify the log level separately (do not specify the multiple log levels using comma demarcation). If you specify any log level, the specified log level and log having higher priority than the specified log is output.

Formula for estimating the log size

Estimate the log size for each HTTP access of GET request, POST request using following formula:

Log size for each HTTP access by GET
= 2.25 + (average-response-body-size / 16)* 0.25

Log size for each HTTP access by POST
= 2.50 + (average-POST-data-size / 16)* 0.5 + (average-response-body-size / 16)* 0.25

Note that all the units are in kilobytes and all the values after the decimal point in division result are rounded-off. Moreover, the average size of the request URL and query character string is considered to be of 100 bytes respectively in the formula. If the average size of the request URL and query character string exceeds 100 bytes, calculate the size by adding the increased size to the first value of the formula.

(3) Notes

Consider the following points for the settings to acquire the redirector log are:

When the log file initialization process starts and completes, the messages KDJE41029-I and KDJE41030-I are output to the message log respectively. Therefore, check whether the messages KDJE41029-I and KDJE41030-I are output to the message log to confirm that the log file initialization has completed successfully while starting the Web server.

In UNIX, the file size set up in the mod_jk.conf file and the log file of the number of files are created when first startup process is executed after setting up a link with the Web server. To create a log file, you require processing time proportionate to the log file size and the number of files. If you set up a larger log file size or if you increase the number of files, the process will take some time for creating the log file.

3.3.11 Settings for acquiring the in-process HTTP server log

This subsection describes the items that can be set up for acquiring the in-process HTTP server log.

In the in-process HTTP server, the access log, trace based performance analysis, thread trace, and the communication trace are output for supporting the application development, for performance analysis at operation time, and for troubleshooting at failure detection time. For these files, you can change the number of files and the file size in the Easy Setup definition file.

The following table describes the settings that you can change for acquiring the in-process HTTP server log and parameters of the Easy Setup definition file corresponding to the items.

Table 3-18 Settings for acquiring the in-process HTTP server log

Log or trace
Items
Corresponding parameters of the Easy Setup definition file

Access log
Availability access log output
webserver.logger.access_log.inprocess_http.enabled in the <configuration> tag on a logical J2EE server (j2ee-server)
(By default access log is output)

Access log file name
webserver.logger.access_log.inprocess_http.filename in the <configuration> tag on a logical J2EE server (j2ee-server)

File size of the access log
webserver.logger.access_log.inprocess_http.filesize in the <configuration> tag on a logical J2EE server (j2ee-server)

Number of files of access log
webserver.logger.access_log.inprocess_http.filenum in the <configuration> tag on a logical J2EE server (j2ee-server)

Format name of the access log
webserver.logger.access_log.format_list in the <configuration> tag on a logical J2EE server (j2ee-server)#

Output format of access log
webserver.logger.access_log.format-name in the <configuration> tag on a logical J2EE server (j2ee-server)#

Format when the access log is output
webserver.logger.access_log.inprocess_http.usage_format in the <configuration> tag on a logical J2EE server (j2ee-server)#

Trace based performance analysis
--
Specify acquisition condition, when you want to execute the cprfed command for performing a daily system operation same as for other trace based performance analysis. For details about acquiring the trace based performance analysis files, see 7. Performance Analysis by using Trace Based Performance Analysis.

Thread trace
Number of files of thread trace
webserver.logger.thread_trace.inprocess_http.filenum in the <configuration> tag on a logical J2EE server (j2ee-server)

File size of thread trace
File size of the thread trace =(((A+B) 32,786)+ 32,914) byte
A= Value of webserver.connector.inprocess_http.max_connections parameter in the <configuration> tag on a logical J2EE server (j2ee-server)
B=For 0, the value of the webserver.connector.inprocess_http.send_timeout parameter is 0, and when other than 0, the value is 1 in the <configuration> tag on a logical J2EE server (j2ee-server)

Communication trace
Number of files of the communication trace
webserver.logger.communication_trace.inprocess_http.filenum in the <configuration> tag on a logical J2EE server (j2ee-server).

File size of the communication trace
File size of the communication trace=(((A+B) 172,050)+128) byte
A=Value of webserver.connector.inprocess_http.max_connections parameter in the <configuration> tag on a logical J2EE server (j2ee-server)
B=For 0, the value of the webserver.connector.inprocess_http.send_timeout parameter is 0, and when other than 0, the value is 1 in the <configuration> tag on a logical J2EE server (j2ee-server).

Legend:

--: Not applicable

#

In the access log, you can customize the log output format by defining the format with the above-mentioned keys. For customization of the access log of the in-process HTTP server, see 5.17.2 Customizing the access log of the in-process HTTP server in the uCosminexus Application Server Web Container Functionality Guide.

3.3.12 Settings for Acquiring the Cosminexus Manager Log

In addition to separately acquiring the logs of the Administration Agent, Management Agent, and Management Server you can collectively acquire them as an integrated log. You can acquire integrated message log files, integrated trace log files, or command maintenance log files as an integrated log. For details about the logs that you can acquire as an integrated log, see 4.3 Application Server log (Systems for executing J2EE applications).

This subsection describes the changes in settings of integrated logs. Set up the integrated log in manager.cfg. The location of the manager.cfg file is as follows:

In Windows
Cosminexus-installation-directory\manager\config\manager.cfg

In UNIX
/opt/Cosminexus/manager/config/manager.cfg

Set the following keys in manager.cfg to change the settings of the integrated log.

com.cosminexus.manager.log.dir
Specify the output destination of the integrated log. For default settings, output to the following location:

In Windows
Cosminexus-installation-directory\manager\log

In UNIX
/opt/Cosminexus/manager/log

com.cosminexus.manager.messagelog.size
Specify the maximum size for each integrated message log file.

com.cosminexus.manager.messagelog.fnum
Specify the number of integrated message log files.

com.cosminexus.manager.messagelog.style
Specify how to switch the output destination of the integrated message log file. If SHIFT (shift mode) is specified, com.cosminexus.manager.messagelog.time is enabled.

com.cosminexus.manager.messagelog.time
Specify the time at which the output destination of the integrated message log file will be switched.

com.cosminexus.manager.tracelog.size
Specify the maximum size for each integrated trace log file.

com.cosminexus.manager.tracelog.fnum
Specify the number of integrated trace log files.

com.cosminexus.manager.tracelog.style
Specify how to switch the output destination of the integrated trace log file. If SHIFT (shift mode) is specified, com.cosminexus.manager.tracelog.time is enabled.

com.cosminexus.manager.tracelog.time
Specify the time at which the output destination of the integrated trace log file will be switched.

com.cosminexus.manager.cmdtracelog.size
Specify the maximum size for each file of command maintenance log files.

com.cosminexus.manager.cmdtracelog.fnum
Specify the number of command maintenance log files.

com.cosminexus.manager.log.compatible
Specify whether to output the Administration Agent and Management Server logs separately. According to the default settings, individual logs are output concurrently with the integrated log. Specify false if you do not want to output individual logs.

3.3.13 Settings for Acquiring the Resource Adapter Logs

This subsection describes the settings to acquire the resource adapter logs. The following two settings are required to acquire resource adapter logs.

Settings for application of the log output
Set up the availability of output of the log for each resource adaptor by the server management commands. Acquire Hitachi Connector Property file by the cjgetrarprop command and specify true for LogEnabled in the <property> tag. After editing the file, use the cjsetresprop command to apply the edited contents. Note that for defining the property before deploying the resource adapter, use the cjgetrarprop and cjsetrarprop command.
For details about Hitachi Connector Property file, see 4.1 HITACHI Connector Property file in the uCosminexus Application Server Application and Resource Definition Reference Guide. For details about the above commands, see the uCosminexus Application Server Command Reference Guide. For details about the operations of the server management commands, see 3. Basic Operations of Server Management Commands in the uCosminexus Application Server Application Setup Guide.

Setting the size, number, and the level of logs
Set up the size and number of resource adapter logs in the following parameter in the <configuration> tag of logical J2EE server (j2ee-server) in the Easy Setup definition file.

ejbserver.connector.logwriter.filesize
Set up the maximum size for each resource adapter log file. (unit: byte).

ejbserver.connector.logwriter.filenum
Specify the number of resource adapter log files.

Moreover, the log output level of the J2EE server (log level) is considered as the log level of the resource adapter. For details about settings of the log level of the J2EE server, see 3.3.6(3) Changing the log level.

Note

For the CJMSP resource adapters, methods to set up log size, number of files, and log levels differ from the other resource adapters. For details, see the subsection 3.3.15 Settings for collecting Cosminexus JMS Provider logs.

If the sum of the length of the log output destination directory of the resource adapter and the length of the resource adapter display name exceeds the path length restrictions for the OS, the initialization of the resource adapter log fails, the KDJE90002-E message is output, and then the server stops. This occurs in the cases such as when the log file is locked by another process.
Use one of the following steps to ensure that the resource adapter log does not exceed the maximum path length. For details, see the uCosminexus Application Server System Setup and Operation Guide.
- Change the length of the resource adapter display name
- Change the log output destination directory or work directory
Also, do not lock the log file with another process.

If the initialization of the resource adapter log fails, the KDJE90002-E message is output and then the J2EE server stops. This occurs when the sum of the path length of the log output destination directory of the resource adapter and the length of the resource adapter display name exceeds the path length restrictions for the OS, or in the cases such as when the log file is locked by another process.
Change the length of the resource adapter display name, or change the log output destination directory or work directory to ensure that the resource adapter log does not exceed the maximum path length. Also, do not lock the log file with another process.

3.3.14 Settings for Acquiring the Cosminexus TPBroker Log

This subsection describes the changes in the output destination of trace files, the number of files, and entries of Cosminexus TPBroker.

The default output destination of the trace files of Cosminexus TPBroker is as follows:

For trace information of a J2EE server

In Windows
working-directory\ejb\server-name\logs\TPB\logj

In UNIX
working-directory/ejb/server-name/logs/TPB/logj

For trace information of server management commands

In Windows
Cosminexus-installation-directory\CC\admin\logs\TPB\logj

In UNIX
/opt/Cosminexus/CC/admin/logs/TPB/logj

For the trace information of the EJB client applications

In Windows
EJB-client-log-output-directory#\system\TPB\logj

In UNIX
EJB-client-log-output-directory#/system/TPB/logj

#: For details on the output destination of the EJB client log output directory, see 4.5.2 Output Destination of the EJB Client Application System Log.

For the CTM trace information

In Windows
Product-installation-directory\TPB\log
Product-installation-directory\TPB\logj

In UNIX
/opt/Cosminexus/TPB/log
/opt/Cosminexus/TPB/logj

The following table describes the items that can be changed, the corresponding parameters of the Easy Setup definition file or the corresponding user definition files and keys.

Table 3-19 Settings for acquiring Cosminexus TPBroker log

Items
Category
Corresponding parameters of the Easy Setup definition file or user definition files and keys

Output destination of trace file
J2EE server
ejb.server.log.directory in the <configuration> tag on a logical J2EE server (j2ee-server)
or
vbroker.orb.htc.tracePath in the <configuration> tag on a logical J2EE server (j2ee-server)

Server management commands
-Dejbserver.log.directory option of the USRCONF_JVM_ARGS key of usrconf.bat (in Windows), or usrconf (in UNIX)
or
vbroker.orb.htc.tracePath key# of usrconf.properties for server management commands

EJB client applications

For the cjclstartap command, the vbroker.orb.htc.tracePath key in usrconf.properties for the Java applications

For the vbj command, the vbroker.orb.htc.tracePath key in the JavaVM system properties specified with the vbj command

CTM

For the global CORBA Naming Service, set up the environment variable HVI_TRACEPATH at the location where the logical server type of adminagent.xml (Administration Agent configuration file) is Naming Service.

For the CTM domain manager, set up the environment variable HVI_TRACEPATH in user.env.variable in the <configuration> tag of the logical CTM domain manager (ctm-domain-manager).

For CTM, set up the environment variable HVI_TRACEPATH in user.env.variable in the <configuration> tag of the logical CTM (component-transaction-monitor).

Number of trace files
J2EE server
vbroker.orb.htc.comt.fileCount in the <configuration> tag on a logical J2EE server (j2ee-server)

EJB client applications

For the cjclstartap command, the vbroker.orb.htc.comt.fileCount key in usrconf.properties for the Java applications

For the vbj command, the vbroker.orb.htc.comt.fileCount key in the JavaVM system properties specified with the vbj command

CTM

For the global CORBA Naming Service, set up the environment variable HVI_COMTFILECOUNT at the location where the logical server type of adminagent.xml (Administration Agent configuration file) is Naming Service.

For the CTM domain manager, set up the environment variable HVI_COMTFILECOUNT in user.env.variable in the <configuration> tag of the logical CTM domain manager (ctm-domain-manager).

For CTM, set up the environment variable HVI_COMTFILECOUNT in user.env.variable in the <configuration> tag of the logical CTM (component-transaction-monitor).

Number of trace file entries
J2EE server
vbroker.orb.htc.comt.entryCount in the <configuration> tag on a logical J2EE server (j2ee-server)

EJB client applications

For the cjclstartap command, the vbroker.orb.htc.comt.entryCount key in usrconf.properties for the Java applications

For the vbj command, the vbroker.orb.htc.comt.entryCount key in the JavaVM system properties specified with the vbj command

CTM

For the global CORBA Naming Service, set up the environment variable HVI_COMTENTRYCOUNT at the location where the logical server type of adminagent.xml (Administration Agent setup file) is Naming Service.

For the CTM domain manager, set up the environment variable HVI_COMTENTRYCOUNT in user.env.variable in the <configuration> tag of the logical CTM domain manager (ctm-domain-manager).

For CTM, set up the environment variable HVI_COMTENTRYCOUNT in user.env.variable in the <configuration> tag of the logical CTM (component-transaction-monitor).

#

For details about the usrconf.bat file (in Windows) or usrconf file (in UNIX), and usrconf.properties, see 3.3 Customizing operation settings of server management commands in the uCosminexus Application Server Application Setup Guide. For details about each file and key for the server management commands see the following sections in the uCosminexus Application Server Definition Reference Guide:

5.1 List of files used in server management commands

5.2 usrconf (Option definition file for server management commands for UNIX)

5.3 usrconf.bat (Option definition file for server management commands for Windows)

5.4 usrconf.properties (System property file for server management commands)

For the details on the Easy Setup definition file, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

For details on the usrconf.properties file and keys for the Java applications, see 14.3 usrconf.properties (User property file for Java applications) in the uCosminexus Application Server Definition Reference Guide.

For details on the JavaVM system properties specified with the vbj command, see 14.4 System properties specified in the Java application in the uCosminexus Application Server Definition Reference Guide.

For details on adminagent.xml (Administration Agent setup file), see 10.5 adminagent.xml (Administration Agent settings file) in the uCosminexus Application Server Definition Reference Guide.

For details on the communication trace, see the TPBroker Operation Guide.

Notes

To change the output destination of a trace file, you need to create comtrc and mdltrc in advance as the subdirectory of the changed output destination directory of the trace file. If you change the output destination, the trace file is output to comtrc and mdltrc under the changed log output destination directory.

If you specify both the ejb.server.log.directory and vbroker.orb.htc.tracePath for <param-name> in the <configuration> tag on a logical J2EE server (j2ee-server) in the Easy Setup definition file, the settings of the vbroker.orb.htc.tracePath are given priority.

If you specify both the -Dejbserver.log.directory option of the USRCONF_JVM_ARGS key of usrconf.bat (in Windows) or usrconf (in UNIX) and the vbroker.orb.htc.tracePath key of usrconf.properties for the server management commands, the settings of the vbroker.orb.htc.tracePath key of usrconf.properties is given priority.

You cannot change the output destination of the server management commands when operating from the Management Server Remote Management.

If you specify the number of trace files and entries with the CTM domain manager and CTM, these values are valid not only in the CTM domain manager and the CTM daemon, but also in the processes of the CTM regulator and the ctmstart command. When you increase the number of trace files and entries, note the increase in the disk usage.

When you increase the number of trace file entries of the communication trace file, note the increase in the memory usage.

3.3.15 Settings for collecting Cosminexus JMS Provider logs

This subsection describes the settings for changing output levels, number of files, and file size of the logs of CJMSP Broker, management command (cjmsicmd), and CJMSP resource adapters that are used by Cosminexus JMS Provider.

With Cosminexus JMS Provider, the following three types of logs are output:

CJMSP Broker log

Management command (cjmsicmd) log

CJMSP resource adapter log

The following table describes the default output destination for each of the above logs.

Table 3-20 Default output destination for logs of Cosminexus JMS Provider

Log type
Default output destination

CJMSP Broker log

In Windows

<CJMSP_HOME>#1\var\instances\instanceName\log

In UNIX

<CJMSP_HOME>#1/var/instances/instanceName/log

Management command (cjmsicmd) log

In Windows

<CJMSP_HOME>#1\var\admin\log

In UNIX

<CJMSP_HOME>#1/var/admin/log

CJMSP resource adapter log

In Windows

J2EE-server-log-output-directory (ejb.server.log.directory)#2\cjms\Cosminexus_JMS_Provider_RA

In UNIX

J2EE-server-log-output-directory (ejb.server.log.directory) #2/cjms/Cosminexus_JMS_Provider_RA

#1

<CJMSP_HOME> indicates the following directory:

In Windows

Cosminexus-installation-directory\CC\cjmsp

In UNIX

/opt/Cosminexus/CC/cjmsp

#2

J2EE-server-log-output-directory (ejb.server.log.directory) is the directory specified in the J2EE server option definition. By default, the following directory is used:

In Windows

Directory-specified-in-ejb.public.directory\ejb\J2EE-server-name\logs

In UNIX

Directory-specified-in-ejb.public.directory/ejb/J2EE-server-name/logs

Note that if the default output destination does not exist, a directory is created when the log is output.

Organization of this subsection

(1) Settings for collecting the CJMSP Broker logs

(2) Settings for collecting the management command (cjmsicmd) log

(3) Settings for collecting the CJMSP resource adapter log

(1) Settings for collecting the CJMSP Broker logs

Among the log acquisition settings for CJMSP Broker, you can change the log output level, number of files, and file size.

The following table describes how to change the settings.

Table 3-21 How to change the log collection settings for CJMSP Broker

Item
Changing method

Log output level
Specify the changes in the following properties of commonconfig.properties or config.properties:

broker.logger.MessageLogFile.trace.level

Number of files
Specify the changes in the following properties of commonconfig.properties or config.properties:

broker.logger.MessageLogFile.filenum

broker.logger.ExceptionLogFile.filenum

File size
Specify the changes in the following properties of commonconfig.properties or config.properties:

broker.logger.MessageLogFile.filesize

broker.logger.ExceptionLogFile.filesize

Note:

With CJMSP Broker, you can change the log output destination with the -varhome option of the cjmsbroker command. However, you can only change the log output destination for the <CJMSP_HOME>\var directory (in Windows) or <CJMSP_HOME>/var directory (in UNIX).

Note that if the specified directory does not exist, the default settings are applied.

For details about the properties, see 7.3 commonconfig.properties (common CJMSP broker property file) and 7.4 config.properties (individual CJMSP broker property file) in the uCosminexus Application Server Definition Reference Guide.

(2) Settings for collecting the management command (cjmsicmd) log

Among the log collection settings for the management command (cjmsicmd), you can change the log output level, output destination, number of files, and file size.

The following table describes how to change the settings.

Table 3-22 How to change the log collection settings for management command (cjmsicmd)

Item
Changing method

Log output level
Specify the changes in the following property of admin.properties:

admin.logger.MessageLogFile.trace.level

Output destination
Specify the changes in the following properties of admin.properties:

admin.logger.MessageLogFile.filepath

admin.logger.ExceptionLogFile.filepath

Number of files
Specify the changes in the following properties of admin.properties:

admin.logger.MessageLogFile.filenum

admin.logger.ExceptionLogFile.filenum

File size
Specify the changes in the following properties of admin.properties:

admin.logger.MessageLogFile.filesize

admin.logger.ExceptionLogFile.filesize

Note that if the specified directory does not exist, the default settings are applied.

For details about the properties, see 7.2 admin.properties (administration command property file) in the uCosminexus Application Server Definition Reference Guide.

(3) Settings for collecting the CJMSP resource adapter log

Among the log collection settings for the CJMSP resource adapter, you can change the log output level, number of files, and file size.

The following table describes how to change the settings.

Table 3-23 How to change the log collection settings for CJMSP resource adapter

Item
Changing method

Log output level
Specify the following property in <config-property> below <resourceadapter> in the Connector property file:

MsgLogLevel

Number of files
Specify the following properties in <config-property> below <resourceadapter> in the Connector property file:

MsgLogFileNum

ExpLogFileNum

File size
Specify the following properties in <config-property> below <resourceadapter> in the Connector property file:

MsgLogFileSize

ExpLogFileSize

For details about the Connector property file, see 4.1 Hitachi Connector property file in the uCosminexus Application Server Application and Resource Definition Reference Guide.

3.3.16 Settings for Collecting the OS Statistical Information

This section describes the settings to acquire the OS statistical information when the OS is Windows.

You can acquire the performance data of the system resources using the Windows system monitor. When an error occurs or signs of an error appear, collection of performance data by Windows system monitor begins and after the error occurs the performance data log is stored. For details about the operation of the system monitor, see the manual provided with the OS.

Extract the system monitor logs described in the following table at an interval of 60 seconds. For details about how to set up, see the manual provided with the OS.

Table 3-24 Setting contents of the system monitor

Performance object | Instance | Item name | Description
processor | -- | %Processor Time | CPU usage rate (total value excluding thread in non-idle state)
%Privileged Time | CPU usage rate (kernel mode part)
%User Time | CPU usage rate (user mode part)
memory | -- | Cache Bytes | Number of bytes currently used by file system cache
Cache Faults/sec | Frequency of extracting the memory from another location or extracting from the disk per second
Page Faults/sec | Number of page faults per second
Transition Faults/sec | Number of faults per second
process | _Total | Handle Count | Total number of handles currently open
Page Faults/sec | Occurrence rate of page faults
Private Bytes | Memory Usage (bytes)
Virtual Bytes | Virtual memory usage (bytes)
Working Set Bytes | Actual memory usage (bytes)
cjstartsv | %Processor Time | CPU usage rate (total value excluding thread in non-idle state)
%Privileged Time | CPU usage rate (kernel mode part)
%User Time | CPU usage rate (user mode part)
Page Faults/sec | Occurrence rate of page faults
Thread Count | Number of threads
Private Bytes | Memory Usage (bytes)
Virtual Bytes | Virtual memory usage (bytes)
Working Set Bytes | Actual memory usage (bytes)

Legend:

--: Not applicable

3.3.17 Settings for Collecting a User Dump

This section describes the settings to acquire user dumps in Windows.

Organization of this subsection

(1) When the task manager or the Windows debug tool is used (in Windows Server 2008 or Windows Vista)

(2) When using Dr. Watson (in Windows XP)

(3) Using the cjstopsv command (in Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista)

(4) Using the mngsvrutil command

(5) When the user dump is obtained for the forced termination of a logical server (in Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista)

(1) When the task manager or the Windows debug tool is used (in Windows Server 2008 or Windows Vista)

When the product hangs up, the user dump becomes necessary as the data required for troubleshooting. To obtain the user dump, use the task manager or the Windows debug tool. For details, see the Microsoft website.

Note that if you want to instantly obtain the user dump when JavaVM terminates abnormally, specify the following settings in the registry before you start the product. The registry settings affect the entire system, so take adequate precautions when you specify the settings. However, cjstartsv.exe, cjstartweb.exe, cjclstartap.exe, and adminagent.exe are automatically set up when the product is installed.

Registry key
\\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps

Registry values

DumpCount:number-of-stored-dumps

DumpType:2

(2) When using Dr. Watson (in Windows XP)

We recommend that you use Dr. Watson (drwtsn32) as the Windows debug tool in Windows XP. When acquiring user dumps using Dr. Watson, you need to set Dr. Watson so that you can use Dr. Watson. Set up Dump symbol table, Dump all thread context, and Create the crash dump file as options of Dr. Watson. For details about how to use Dr. Watson, see the manual provided with the OS.

Note that if you want to instantly obtain the user dump when JavaVM terminates abnormally, specify the following settings:

Execute drwtsn32 -i to install Dr. Watson as the prescribed application debugger.
When you execute this command, the value Auto in the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug key of the registry, changes to 1.

In the Windows Control Panel, select System, and in the Details Preference tab, click the Error Report button, and specify the following settings:

Select the Disable error report radio button

Clear the Report the serious errors check box

To collect a user dump when process hang up occurs, obtain userdump.exe provided by Microsoft. For details, see the homepage of Microsoft Corp.

(3) Using the cjstopsv command (in Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista)

When acquiring user dumps using the -fd option of the cjstopsv command, you must set up the output destination directory of the user dump in the environment variable CJMEMDUMP_PATH. File name of the user dump is cjmemdump.dmp.

The following is a setup example of the environment variable CJMEMDUMP_PATH:

Setup example of the environment variable CJMEMDUMP_PATH

set CJMEMDUMP_PATH=C:\temp

In the above-mentioned example, cjmemdump.dmp is created under C:\temp.

When specifying the environment variable CJMEMDUMP_PATH, note the followings:

Confirm that there is enough free disk space in the disk where the data is to be stored since the file size of the user dump is more than the required size of real memory of the J2EE server.

Do not specify the directory that includes Japanese multibyte characters. The output of the user dump might fail.

Specify the existing directory in the output destination directory of the user dump.

(4) Using the mngsvrutil command

When acquiring user dumps using the sub command dump of the mngsvrutil command, obtain userdump.exe provided by Microsoft Corp. to acquire user dumps when process hang up occurs. For details, see the homepage of Microsoft Corp.

Note

If the version of the obtained userdump.exe is Microsoft "User Mode Process Dumper Version 8.1", implement the following after installation:

As a preparatory operation before using the mngsvrutil command to acquire the user dump, check whether userdump.exe exists in the operating environment.

If multiple userdump.exe exists, change the system environment variable PATH in such way so that the storage location of userdump.exe provided by Microsoft, appears at the beginning.

To apply the details changed in the system environment variables, restart the OS.

Also, when a J2EE server is started as a logical server from Management Server, do not use this command for forced termination. If this command is used for forced termination, Management Server determines that the J2EE server terminated abnormally and executes the operations.

(5) When the user dump is obtained for the forced termination of a logical server (in Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista)

When you use Management Server to set up the system, specify the output destination directory of the user dump in the environment variable CJMEMDUMP_PATH to obtain the user dump for the forceful termination of the logical server. If you specify this environment variable, the user dump can be collected beneath the directory specified in this environment variable when the logical J2EE server and logical SFO server (compatibility functionality) are terminated forcefully. The user dump file name is cjmemdump.dmp. For details, see 4.1.11 Setting environment variables of the system in the uCosminexus Application Server System Setup and Operation Guide.

3.3.18 Settings for Acquiring a Core Dump

This section describes the settings for acquiring core dumps in UNIX.

Note

Depending on the Linux specifications, the size information in the core file might be invalid.

Organization of this subsection

(1) Setting the maximum size of core files

(2) Setting the maximum number of files for core files

(1) Setting the maximum size of core files

The maximum size of core files may be 0 depending on the operation environment of the system. In such cases, core dumps cannot be acquired during abnormal termination of server processes, and therefore, you need to set in advance the maximum size of core files to infinite. To set the maximum size of the core file to infinite, either specify the option in the JavaVM start parameter in the simple setup definition file or execute shell commands.

Note that the core file size increases with the increase in the memory pool size specified in the JavaVM start parameter in the simple setup definition file, secure sufficient free disk space.

Setting up the option in the JavaVM startup parameter in the Easy Setup definition file
Define the JavaVM startup parameter in the <configuration> tag on a logical J2EE server (j2ee-server) in the Easy Setup definition file. The setting contents of a JavaVM startup parameter are as follows:

<param-name> tag

add.jvm.arg

<param-value> tag

-XX:+HitachiFullCore

Setup example (For definition of the physical tier)

<configuration>
<logical-server-type>j2ee-server</logical-server-type>
<param>
 <param-name>add.jvm.arg</param-name>
 <param-value>-XX:+HitachiFullCore</param-value>
</param>
:
</configuration>

To execute shell commands
Execute the shell command and specify the maximum size of the core file as infinite.

Execution example of Csh (C shell)

limit coredumpsize unlimit

Execution example of sh (standard shell)

ulimit -c unlimited

Also, in addition to these settings, we recommend that you execute the shell commands to set the maximum file size to unlimited.

Example of execution for csh (C shell)

limit filesize unlimit

Example of execution for sh (standard shell)

ulimit -f unlimited

Reference note

Formula for estimating the core file size

The core file size, generated when a JavaVM process is down, is equal to the amount of virtual memory used. For details on the formula for the virtual memory usage, see the following manuals. The disk, which contains the current directory of the JavaVM process where the core file is generated, must always have free space greater than this core file size.

For the J2EE application execution platform
5.3 Estimating virtual memory usage in the uCosminexus Application Server System Design Guide

For the batch application execution platform
6.3 Estimating virtual memory usage in the uCosminexus Application Server System Design Guide

(2) Setting the maximum number of files for core files

You can define the upper limit for the number of core files in the ejb.server.corefilenum parameter in the <configuration> tag of a logical J2EE server (j2ee-server) in the Easy Setup definition file. Define the ejb.server.corefilenum parameter in the extension parameter of the J2EE server.

If the total of core dump files output to working-directory/ejb/server-name/ while restarting the cjstartsv process exceeds the specified maximum number, the files are deleted in the order of output date, starting from the oldest file.

3.3.19 Settings for Acquiring the JavaVM Material

This section describes the settings for acquiring the following JavaVM material:

Thread dumps of JavaVM

JavaVM log (JavaVM log file)

Event log of the Explicit Heap Memory Management functionality

For details about the JavaVM startup options, see 16. JavaVM Startup Options in the uCosminexus Application Server Definition Reference Guide.

By default, the thread dumps of JavaVM are output under the following directory:

In Windows
working-directory\ejb\server-name

In UNIX
working-directory/ejb/server-name

By default, the JavaVM log is output under the following directory:

In Windows
working-directory\ejb\server-name\logs

In UNIX
working-directory/ejb/server-name/logs

When you want to change the output destination, you must change the log output directory in the ejb.server.log.directory parameter in the <configuration> tag of a logical J2EE server (j2ee-server) in the Easy Setup definition file before starting JavaVM or J2EE server.

The respective settings for acquiring the thread dumps of JavaVM, JavaVM log (JavaVM log file), and event log of the Explicit Memory Management functionality is as follows:

Organization of this subsection

(1) Settings for Acquiring Thread Dumps of JavaVM

(2) Settings for acquiring JavaVM logs

(3) Settings for acquiring the event log of Explicit Heap Memory Management functionality

(1) Settings for Acquiring Thread Dumps of JavaVM

This subsection describes the settings for acquiring thread dumps of JavaVM.

The contents output to the thread dump of JavaVM differs depending on the JavaVM startup option specified in the JavaVM startup parameter in the Easy Setup definition file. Define the JavaVM startup option in the JavaVM startup parameter in <configuration> tag of a logical J2EE server (j2ee-server). The setting contents of a JavaVM startup parameter are as follows:

<param-name> tag

add.jvm.arg

<param-value> tag

JavaVM-startup-option

The following table describes the options to be specified for JavaVM startup options. For details about the options, see 16. JavaVM Startup Options in the uCosminexus Application Server Definition Reference Guide.

Table 3-25 Options to be specified for JavaVM startup option (Settings for acquiring the thread dumps of JavaVM)

Option
Description

-XX:+HitachiThreadDump
Output the extended thread dump. By default, the thread dump is output.

-XX:+HitachiThreadDumpToStdout
The extended thread dump is output to the standard output. By default, the thread dump is output.

-XX:+HitachiThreadDumpWithHashCode
The hash code of the thread is output to the thread information. By default, the thread dump is output.

-XX:+HitachiThreadDumpWithCpuTime
The user CPU time and kernel CPU time after the thread starts are output to the thread information. By default, the thread dump is output.

-XX:+HitachiThreadDumpWithBlockCount
The number of times the process was blocked by the thread and the number of times the process is in the pending state is output to the thread information. By default, the thread dump is output.

-XX:+HitachiOutOfMemoryAbort
-XX:+HitachiOutOfMemoryAbortThreadDump
In either of the settings, the thread dump is output when forced termination is performed due to OutOfMemoryError. If the C heap in the J2SE class library is insufficient, and the C heap in the processing of JavaVM is insufficient, the thread dump is not output

-XX:+HitachiOutOfMemoryAbortThreadDumpWithJHeapProf
A class-wise statistical information is output in the thread dump that is output when forced termination is performed due to OutOfMemoryError. Nothing is output by default.

To change the output destination of the thread dump file, specify the output destination in the environment variable JAVACOREDIR. For details on the environment variable JAVACOREDIR, see 16.7 Details of environment variables used in JavaVM in the uCosminexus Application Server Definition Reference Guide.

(2) Settings for acquiring JavaVM logs

This subsection describes the settings for acquiring JavaVM logs.

The JavaVM log is a log that you can acquire with the extension option added by Hitachi in the standard JavaVM. You can acquire more troubleshooting information as compared to the information acquired from the standard JavaVM. This log file is called JavaVM log file. The JavaVM garbage collection log is also output to this file.

To acquire the JavaVM log file, specify a JavaVM startup option in the JavaVM startup parameter in the Easy Setup definition file. Define the JavaVM startup option in the JavaVM startup parameter in the <configuration> tag of the logical J2EE server (j2ee-server). The following are the setting contents of the JavaVM startup parameter:

<param-name> tag

add.jvm.arg

<param-value> tag

JavaVM-startup-option

The following table describes the options to be specified for the JavaVM startup option. For details about the options, see 16. JavaVM Startup Options in the uCosminexus Application Server Definition Reference Guide.

Table 3-26 Options to be specified for JavaVM startup option (Settings for acquiring JavaVM log)

Option
Description

-XX:+HitachiOutOfMemoryStackTrace
-XX:+HitachiVerboseGC
-XX:+HitachiOutOfMemoryHandling
-XX:+HitachiJavaClassLibTrace
-XX:+JITCompilerContinuation
If any of the following options is specified, the JavaVM log file is output:

If -XX:+HitachiOutOfMemoryStackTrace is specified, the exception information and the stack trace are output to the JavaVM log file. If you specify this option, -XX:+HitachiOutOfMemorySize and -XX:+HitachiOutOfMemoryCause are also specified concurrently.

If -XX:+HitachiVerboseGC is specified, the extended verboseGC information is output to the JavaVM log file, when the garbage collection occurs.

If -XX:+HitachiOutOfMemoryHandling is specified, information related to the frequency of occurrence of OutOfMemory is output to the JavaVM log file, when OutOfMemory occurs due to Java heap insufficiency or Perm heap insufficiency.

If -XX:+HitachiJavaClassLibTrace is specified, the stack trace of the class library is output to the JavaVM log file.

If -XX:+JITCompilerContinuation is specified, the JIT compiler continuation functionality is enabled, therefore, if the JIT compilation fails due to a logical inconsistency in a method configuring the application, the JIT compiler continuation functionality log is output to the JavaVM log file.

Specify the following extension options based on the requirements and set the output methods and the output contents of the JavaVM log file:

File size and the number of JavaVM log files

Extended verboseGC function option

Extension function option when OutOfMemoryError occurs

Class library trace function option

Local variable information output function option

Reserved options of swap area

The settings to output the extended verboseGC information to the maintenance information of JavaVM (Java heap information) and the garbage collection log are described below. With the options described in the following table, apply the output of extended verboseGC information and specify the output format of the extended verboseGC information.

Table 3-27 Options to be specified for output of the extended verbosegc information

Option | Description
-XX:+HitachiVerboseGC | The extended verboseGC information is output to the JavaVM log file.
-XX:+HitachiVerboseGCPrintDate | The date is output to each line of the extended verboseGC information.
-XX:+HitachiVerboseGCCpuTime# | The CPU usage time of the thread executing the garbage collection from the start until the termination of the garbage collection is output. The CPU usage time is divided into the CPU time spent in the user mode and the CPU time spent in the kernel mode and then output.
-XX:HitachiVerboseGCIntervalTime = Time-intervals (seconds) | Specify the output intervals of the extended verboseGC information.
-XX:+HitachiVerboseGCPrintCause | The cause for occurrence of the garbage collection is output to the extended verboseGC information.
-XX:+HitachiOutputMilliTime | Output the date (up to milliseconds) to each line of the extended verboseGC information.
-XX:+HitachiCommaVerboseGC | The extended verboseGC information is output in the CSV format.
-XX:+HitachiVerboseGCPrintTenuringDistribution | The tenuring distribution information of the Survivor area is output. For details about the output format and output information, see 9.11 Tenuring distribution information output functionality of the Survivor area.
-XX:+HitachiVerboseGCPrintJVMInternalMemory | Heap information managed in JavaVM is output to the JavaVM log file.
-XX:+HitachiVerboseGCPrintThreadCount | To monitor the number of Java threads, the number of Java threads is output to the JavaVM log file.
-XX:+HitachiVerboseGCPrintDeleteOnExit | The cumulative heap size secured by JavaVM by invoking java.io.File.deleteOnExit()and the number of times the method is invoked are output to the JavaVM log file.

#

You cannot use this option for HP-UX. Even if you specify an option, it is ignored.

You can acquire the information to estimate the Java heap area size and the Perm area size required by the server from the extended verboseGC information.

(3) Settings for acquiring the event log of Explicit Heap Memory Management functionality

This point describes the settings for acquiring the Event log of Explicit Heap Memory Management functionality. This point also describes the relation of the event log of the Explicit Memory Management functionality with the JavaVM log file.

The settings required for acquiring the event log of Explicit Heap Memory Management functionality are as follows:

Settings for log output level
Set up the log output level to output a log depending on the purpose. You can specify the four log output levels; none, normal, verbose, and debug. Default level of J2EE server is normal. The log details are given in the order of none<normal<verbose<debug and the output volume increases.
For example, you can perform an operation, where you can specify normal for normal and verbose if an error occurs and can acquire a detailed log.

Settings for log output file
The log of Explicit Heap Memory Management functionality is output to a separate file other than the JavaVM log. Set up the file for the output destination, file size, and number of files according to the assumed operation.

For a J2EE server or batch server, you can set up the above-mentioned settings using JavaVM startup option specified in the JavaVM startup parameter in the Easy Setup definition file. Set up the JavaVM startup option in the JavaVM startup parameter in the <configuration> tag of a logical J2EE server (j2ee-server). The settings of the JavaVM startup parameter are as follows:

<param-name> tag

add.jvm.arg

<param-value> tag

JavaVM- startup-option

The following table describes the options to be specified for the JavaVM startup option. For details about the options, see 16. JavaVM Startup Options in the uCosminexus Application Server Definition Reference Guide.

Table 3-28 Option to be specified for JavaVM startup option (Settings for acquiring the event log of the Explicit Heap Memory Management functionality)

Setting contents
Option
Description

Setting of output level
-XX:HitachiExplicitMemoryLogLevel:character-string
Specify log output level.

none
Event log of the Explicit Heap Memory Management functionality is not output.

normal
The status of the Explicit heap is output when the event, into which the size of an Explicit heap greatly changes, occurs or when the garbage is collected.

verbose
Specify if a detailed log is required when error occurs.

debug
Specify when a detailed log is required more than verbose. Performance of the system is lowered.

Settings for file to be output
-XX:HitachiExplicitMemoryJavaLog:character-string
Specify the file name of file that outputs event log.

-XX:HitachiExplicitMemoryJavaLogFileSize=positive-integer
specify the maximum file size for each file.

-XX:HitachiExplicitMemoryJavaLogNumberOfFile=positive-integer
Specify a maximum number of log files to be created. When a specified value exceeds, a wraparound is performed, and the log is output to the file that was created first.

Note that the event log of the Explicit Memory Management functionality is output to a file that differs from the JavaVM log file. However, the values set up in the JavaVM log file are inherited for some options.

The following table describes the items that inherit the settings of the JavaVM log file.

Table 3-29 Items that inherit the settings of the JavaVM log file

Option name | Meaning | Default value
-XX:+HitachiJavaLogNoMoreOutput | An option to specify behavior when an attempt to output the log file fails. | Enabled
-XX:+HitachiOutputMilliTime | An option to specify whether to set millisecond as the unit of time output to the log file. | Disabled

For details about the JavaVM extension options, see 16.2 Details of JavaVM extension options in the uCosminexus Application Server Definition Reference Guide.

4. Output Destinations and Output Methods of Data Required for Troubleshooting

You can acquire the data that is used in the troubleshooting at any time for each data. This chapter describes how to seperately output the data, such as logs and thread dumps, and the default output destination for the data. This chapter also describes the directories to be used for troubleshooting.

Organization of this chapter

4.1 Organization of this chapter

4.2 Types of data used for troubleshooting (When snapshot log is not used)

4.3 Application Server log (Systems for executing J2EE applications)

4.4 Application Server log (Systems for executing batch applications)

4.5 EJB Client Application System Log

4.6 Trace based performance analysis

4.7 JavaVM thread dump

4.8 JavaVM Garbage Collection Log

4.9 Memory Dump

4.10 JavaVM log (JavaVM log file)

4.11 JavaVM Output Message Logs (Standard Output or Error Report File)

4.12 OS Status Information and OS Logs

4.13 OS Statistical Information

4.14 Application Server definition information

4.15 Contents of J2EE server or batch server working directory

4.16 Application Server Resource Setting Information

4.17 Web Server Logs

4.18 JavaVM stack trace information

4.19 Event log of the Explicit Heap Memory Management functionality

4.20 Information on the execution of the Component Container Administrator setup command (In UNIX)

4.1 Organization of this chapter

This chapter describes the output destination and the output method of the data used for troubleshooting.

There are the respective default output destinations for the data used for troubleshooting. Additionally, you can separately acquire the data required for troubleshooting, such as the information without using the snapshot log.

The following table describes the organization of this chapter.

Table 4-1 Organization of this chapter (Output destination and output method of the data used for troubleshooting)

Category | Title | Reference
Explanation | Types of data used for troubleshooting (When snapshot log is not used) | 4.2
Application Server log (Systems for executing J2EE applications) | 4.3
Application Server log (Systems for executing batch applications) | 4.4
EJB Client Application System Log | 4.5
Trace based performance analysis | 4.6
JavaVM thread dump | 4.7
JavaVM Garbage Collection Log | 4.8
Memory Dump | 4.9
JavaVM log (JavaVM log file) | 4.10
JavaVM Output Message Logs (Standard Output or Error Report File) | 4.11
OS Status Information and OS Logs | 4.12
OS Statistical Information | 4.13
Application Server definition information | 4.14
Contents of J2EE server or batch server working directory | 4.15
Application Server Resource Setting Information | 4.16
Web Server Logs | 4.17
JavaVM stack trace information | 4.18
Event log of the Explicit Heap Memory Management functionality | 4.19
Information on the execution of the Component Container Administrator setup command (In UNIX) | 4.20

For an overview of troubleshooting, how to output the data automatically, setup related to data acquisition and data output, and the output contents of the data, see the following respective chapters:

Overview of troubleshooting and how to output the data automatically
2. Troubleshooting

Setup related to data acquisition and data output
3. Preparing for Troubleshooting

Contents output in data
5. Problem Analysis

4.2 Types of data used for troubleshooting (When snapshot log is not used)

Materials, such as log outputs by the application server configuration software, can also be acquired separately without using the snapshot log. This section describes the methods for acquiring the required data separately when a trouble occurs. For details about acquiring the data using the snapshot log, see 2.3.3 Collecting the Snapshot Log.

The following table describes the reference sections for the required data acquired separately when the snapshot log is not used.

Table 4-2 Required data that is to be acquired (When snapshot log is not used)

Data to be acquired | Reference
Application Server log (Systems for executing J2EE applications) | 4.3
Application Server log (Systems for executing batch applications) | 4.4
System log of EJB client application# | 4.5
Trace based performance analysis | 4.6
JavaVM thread dump | 4.7
JavaVM garbage collection log | 4.8
Memory dump | 4.9
JavaVM log (JavaVM log file) | 4.10
JavaVM output message logs (Standard output or error report file) | 4.11
OS status information and OS logs | 4.12
OS statistical information | 4.13
Application Server definition information | 4.14
Contents of J2EE server or batch server working directory | 4.15
Application Server resource setting information | 4.16
Web server logs | 4.17
JavaVM stack trace information | 4.18
Event log of the Explicit Memory Management functionality | 4.19
Information on the execution of the Component Container Administrator setup command (In UNIX) | 4.20

#

Acquire for the system executing an EJB client application.

4.3 Application Server log (Systems for executing J2EE applications)

This section describes how to acquire logs output by the component software of the Application Server manually in the systems for executing J2EE applications. Further, when the application server log is already collected as a snapshot log, you need not perform the tasks explained here.

This section describes how to acquire the following logs:

Cosminexus Component Container logs

Cosminexus Performance Tracer logs

Cosminexus Component Transaction Monitor logs

Logs output in audit log

Application user logs

Reference note

The method of collecting Cosminexus HTTP Server log is described in 4.17 Web Server Logs.

Organization of this section

4.3.1 Acquiring the Cosminexus Component Container Logs

4.3.2 Acquiring the Cosminexus Performance Tracer Log

4.3.3 Acquiring the Cosminexus Component Transaction Monitor Log

4.3.4 Acquiring the log output in audit log

4.3.5 Acquiring the Application User Log

4.3.1 Acquiring the Cosminexus Component Container Logs

This section describes the types and output destinations of Cosminexus Component Container logs. The Cosminexus Component Container logs include the following logs:

J2EE server, redirector, server management command logs

Administration agent, Management agent, Management Server logs

Internal setup tool of the virtual server manager and Server Communication Agent logs

Integrated user management logs

Cosminexus JMS Provider logs

The output destination of each of the log is described below.

Organization of this subsection

(1) Acquiring the J2EE server, redirector, server management command logs

(2) Acquiring the log of Administration agent, Management agent, and Management Server

(3) Acquiring the logs of the internal setup tool of the virtual server manager and Server Communication Agent

(4) Acquiring the integrated user management log

(5) Collecting Cosminexus JMS Provider logs

(6) Required information to be acquired other than a log

(1) Acquiring the J2EE server, redirector, server management command logs

This section describes the method for acquiring the J2EE server, redirector, server management command logs.

Also, in Cosminexus Component Container, the migration command logs are output besides these logs. When the in-process HTTP server or resource depletion monitoring function is used, the in-process HTTP server log or the resource depletion monitoring log is output respectively.

In the J2EE server and redirector log, there are four types of logs, message log, user log, exception log, and maintenance log. Note that in addition to these logs, event log or syslog are output in the case of starting, stopping, and abnormal termination of a J2EE server.

The three types of server management command logs are message log, exception log, and maintenance log.

In the resource adapter version up command (cjrarupdate) log, there are three types of logs, message log, exception log, and maintenance log.

In in-process HTTP server log, there are three types of logs; access log, thread trace log, and communication trace log.

In the Cosminexus JPA provider log, there are four types of logs; message log, exception log, operation log, and maintenance log. The message log and the exception log are same as for the J2EE servers.

The three types of migration command logs are message log, exception log, and maintenance log.

Each of these logs is described below:

Message log

The operation status of a J2EE server, server management command, and migration command is output. Message log is used as the operation monitoring information for various types of servers and commands.

Note that message log is also output in the following cases for Cosminexus JPA Provider:

When failed in class loading and in the query analysis

When ignored the annotation specified by the user with the orm.xml tag.

When an invalid value is specified for the property of the Cosminexus JPA specific functionality specified in persistence.xml

When failed to participate in JTA transaction

When failed to update the database

User log

The information of the standard output and the standard error output in the application is output in the user log. Use this log to check the operation when developing the application. Note that if you specify the java.security.debug property and start the server, the standard output and standard error output information is not output to the user log. This log also includes the JavaVM memory related logs in the case of operating systems other than Solaris.

Exception log

The exception information of Cosminexus Component Container is output when a problem occurs in the system. Note that you need not monitor the exception log in daily operations. Use this log to reference exception information if a message is output to the log.

For the Cosminexus JPA Provider, if you specify cosminexus.jpa.exception.logging.sql in the property of the logical J2EE server of the Easy Setup definition file, the exception message can also include SQL statement (includes an SQL issued internally because of a delay in processing). For details about the properties, see 2.4 usrconf.properties (User property file for J2EE server) in the uCosminexus Application Server Definition Reference Guide.

Maintenance log

The error maintenance information of Cosminexus Component Container is output when a problem occurs in the system. Maintenance personnel use this log to analyze the errors that occur in Cosminexus Component Container.

Event log (in Windows)

The information indicating start, stop, or abnormal termination of a J2EE server is output to this log. The output destination differs depending on the Windows event log settings.

Note that the event log is not output depending on how the J2EE server has been stopped. In the following cases, there are times when the log is not output correctly:

When a problem occurs in JavaVM itself when the J2EE server is running

When the J2EE server process is stopped externally by TerminateProcess

When the J2EE server terminates abnormally due to insufficient memory when the -XX:+HitachiOutOfMemoryAbort option is specified to start the JavaVM.
Note that the -XX:+HitachiOutOfMemoryAbort option is set by default.

syslog (in UNIX)

The information indicating start, stop, or abnormal termination of a J2EE server is output to this log. The output destination differs depending on the settings in the UNIX syslog.

Note that the syslog is not output depending on how the J2EE server has been stopped. In the following cases, there are times when the log is not output correctly:

When a problem occurs in JavaVM itself when the J2EE server is running

When the J2EE server process is stopped externally by the SIGKILL signal (such as kill -9)

When the J2EE server terminates abnormally due to insufficient memory when the -XX:+HitachiOutOfMemoryAbort option is specified to start the JavaVM.
Note that the -XX:+HitachiOutOfMemoryAbort option is set by default.

In-process HTTP server log

The maintenance information and the processing result of a request are output for using the in-process HTTP server. Maintenance personnel use the maintenance information to analyze the errors that occur in Cosminexus Component Container. The processing result of the request is used for analyzing the performance information and the session tracking information of the in-process HTTP server as an access log.

Cosminexus JPA Provider log

In the Cosminexus JPA Provider, the operation information (includes an SQL issued internally because of a delay in the processing) is output. In operation logs, there are two categories; SQL and TRANSACTION. You can specify the output level of the log as per each category. There is the information indicating Off, Information, and Detail for the output level of the operation log. An operation log is output when Information or Detail is specified. The following table describes the output contents of the operation log as per each category.

Table 4-3 Output contents of the operation log as per each category

Category
Output contents in information level
Output contents in detail level

SQL#1

All issued SQL are output.
Issued SQL is output regardless of the user or the Cosminexus JPA Provider.

Return value of PreparedStatement#executeUpdate() is output#2, #3

Output content in Information level is output.

Setup value for the ? parameter (place holder) is output.

TRANSACTION

Message is output showing that the Synchronization is registered to the transaction manager when using JTA transaction.
Message is output when the EntityManager participates in the JTA transaction.

Message is output showing that afterCompletion() of Synchronization is called from the transaction manager when using JTA transaction.

Message is output when JTA transaction is concluded.

Output content of the Information level.
Event message is output showing that begin(), commit(), and rollback() of EntityTrasanction are executed. Message is not output when an exception occurs.

#1

Consider the setup of the log output level as an SQL and a parameter issued to the database are output to log.

#2

When you execute the UPDATE statement, it becomes the updated number of lines. For details, see java.sql.PreparedStatement of Javadoc

When you execute the SELECT statement, there is no output if PreparedStatement#executeUpdate() is not used. However, when Query interface is generated with the SELECT statement of native query, the SELECT statement is also output when you execute Query#executeUpdate().

#3

There is no output if exception occurs when you execute PreparedStatement#executeUpdate().

When the status of the transaction described in the above-mentioned table or the information on persistent unit name cannot be acquired, the operation log is output in the lower case as unknown. For details about the operation log output in the Cosminexus JPA Provider, see Appendix C.1 Cosminexus JPA Provider operation log.

Resource depletion monitoring log

When using the resource depletion monitoring function, the resource depletion monitoring information about the resources being monitored is output. Use it for investigating the cause if the resource usage or the used resource quantity exceeds the threshold value.

The log is recorded in an order starting from the log file attached with the smallest file number. When one log file size attains the maximum size for one file, the log is recorded in the log file attached with the next file number. When the last log file (log file attached with the file count number) size attains the maximum size for one file, the log file of file number 1 is made empty and the log is recorded in that file. Thereafter, the log is recorded in the log files in the order of the file number by emptying those log files before recording a new log.

The following table describes the default of log output destination. The Cosminexus Component Container log can be acquired according to the server or command.

The working-directory shown in the log output destination indicates a directory specified in the ejb.public.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) of the Easy Setup definition file. The default value is Cosminexus-installation-directory\CC\server\public (in Windows) or /opt/Cosminexus/CC/server/public (in UNIX).

(a) J2EE server and redirector log

Table 4-4 Output destination of the J2EE server and the redirector log (Default)

Category
Contents
Log output destination and log file name#1
Default size number of files
Channel name

Message log
Operation log

In Windows
ejb.server.log.directory#2\cjmessage[n].log

In UNIX
ejb.server.log.directory#2/cjmessage[n].log

1MB 2
MessageLogFile

Log operation log#3

In Windows
<ejb.server.log.directory>#2\cjlogger.log

In UNIX
<ejb.server.log.directory>#2/cjlogger.log

1MB 2
--

Redirector message log
Directory#4

In Windows
Cosminexus-installation-directory\CC\web\redirector\logs

In UNIX
/opt/Cosminexus/CC/web/redirector/logs

4MB 5
--

Message log
Redirector message log
File name#4

In Windows
isapi_redirect[n].log (Microsoft IIS)
hws_redirect[n].log (Cosminexus HTTP Server)

In UNIX
hws_redirect[n].log (Cosminexus HTTP Server)

4MB 5
--

Operation log of resource adapter that is deployed and used as a J2EE resource adapter#5

In Windows
(Resource adapter of Connector 1.0 specifications)
ejb.server.log.directory#2\connectors\resource-adapter-display-name[n].log
(Resource adapter of Connector 1.5 specifications)
<ejb.server.log.directory>#2\connectors\resource-adapte-display-name_connection-defintion-arrangement-order_[n].log

In UNIX
(Resource adapter of Connector 1.0 specification)
ejb.server.log.directory#2/connectors/resource-adapter-display-name[n].log
(Resource adapter of Connector 1.5 specification)
<ejb.server.log.directory>#2/connectors/resource-adapter-display-name_connetion-definition-arrangement-order_[n].log

2 MB 4
--

Message log
Operation log of resource adapter used in a J2EE application#5

In Windows
(Resource adapter of normal mode/Connector 1.0 specifications)
<ejb.server.log.directory>#2\connectors\J2EE application-name\resource-adapter-display-name[n].log
(Resource adapter of test mode/Connector 1.0 specifications)
<ejb.server.log.directory>#2\connectors\test#J2EE-application-name\resource-adapter-display-name[n].log
(Resource adapter of normal mode/Connector 1.5 specifications)
<ejb.server.log.directory>#2\connectors\J2EE-application-name\resource-adapter-display-name_connection-defintion-arrangement-order_[n].log
(Resource adapter of test mode/Connector 1.5 specifications)
<ejb.server.log.directory#2>\connectors\test#J2EE-application-name\resource-adapter-display name_connection-defintion-arrangement-order_[n].log

2 MB 4
--

Message log
Operation log of resource adapter used in a J2EE application#5

In UNIX
(Resource adapter of normal mode/Connector 1.0 specifications)
<ejb.server.log.directory>#2/connectors/J2EE-application-name/resource-adapter-display-name[n].log

1MB 2
--

Message log
Operation log of resource adapter used in a J2EE application#5

In UNIX
(Resource adapter of test mode/Connector 1.0 specifications)
<ejb.server.log.directory>#2/connectors/test#J2EE- application-name/resource-adapter-display-name [n].log
(Resource adapter normal mode/Connector 1.5 specifications)
<ejb.server.log.directory>#2/connectors/J2EE-application-name/resource-adapter-display-name_connection-defintion-arrangement-order_[n].log
(Resource adapter of test mode/Connector 1.5 specifications)
<ejb.server.log.directory>#2/connectors/test#J2EE-application-name/resource-adapter-display-name _connection-definition-arrangement-order_[n].log

1MB 2
--

User log
Web servlet log#6

In Windows
ejb.server.log.directory#2\web_servlet[n].log

In UNIX
ejb.server.log.directory#2/web_servlet[n].log

4MB 4
WebServletLogFile

User output log

In Windows
ejb.server.log.directory#2\user_out[n].log

In UNIX
ejb.server.log.directory#2/user_out[n] .log

1MB 2
UserOutLogFile

User error log

In Windows
ejb.server.log.directory#2\user_err[n].log

In UNIX
ejb.server.log.directory#2/user_err[n] .log

1MB 2
UserErrLogFile

User log
JavaVM maintenance information and garbage collection log

In Windows
ejb.server.log.directory#2\javalog[nn].log

In UNIX
ejb.server.log.directory#2/javalog[nn].log

4MB 4
--

Event log of Explicit Heap Memory Management functionality

In Windows
ejb.server.log.directory#2\ehjavalog[nn].log

In UNIX
ejb.server.log.directory#2/ehjavalog[nn].log

4MB 4
--

Exception log
Exception information when an error occurs

In Windows
ejb.server.log.directory#2\cjexception[n].log

In UNIX
ejb.server.log.directory#2/cjexception[n].log

1MB 2
ExceptionLogFile

Maintenance log
Maintenance information

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjmaintenance[n].log

In UNIX
ejb.server.log.director#2/CC/maintenance/cjmaintenance[n].log

16MB 4
MaintenanceLogFile

Console message

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjconsole[n].log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjconsole[n].log

1MB 2
ConsoleLogFile

EJB container maintenance information

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjejbcontainer[n].log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjejbcontainer[n].log

1MB 2
EJBContainerLogFile

Web container maintenance information

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjwebcontainer[n].log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjwebcontainer[n].log

1MB 2
WebContainerLogFile

Maintenance log
Start process standard output information#7

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjstdout.log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjstdout.log

--
--

Start process standard error information#7

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjstderr.log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjstderr.log

--
--

Termination process information

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cj_shutdown[n].log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cj_shutdown[n].log

4KB 2#8
--

Trace log for Web container maintenance

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjweb_access[n].log

In UNIX
<ejb.server.log.directory>#2/CC/maintenance/cjweb_access[n].log

4 MB 16
WebAccessLogFile

Maintenance log
Redirector maintenance trace log
Directory#4

In Windows
Cosminexus-installation-directory\CC\web\redirector\logs

In UNIX
/opt/Cosminexus/CC/web/redirector/logs/

16MB 4
--

File name#4

In Windows
iis_rd_trace[n].log (Microsoft IIS)
hws_rd_trace[n].log (Cosminexus HTTP Server)

In UNIX
hws_rd_trace[n].log (Cosminexus HTTP Server)

RMI communication log of J2EE server

In Windows
<ejb.server.log.directory>#2\CC\rmi\cjrmi[n].log

In UNIX
<ejb.server.log.directory>#2/CC/rmi/cjrmi[n].log

1MB 4
--

Event log
Log showing J2EE server start, stop or abnormal termination
Application log of Windows event viewer#9
--
--

syslog
Log showing J2EE server start, stop or abnormal termination
Depends on UNIX syslog settings.#10
--
--

Debug log
Log for checking development

In Windows
<ejb.server.log.directory>#²\cjdevelopment[n].log

In UNIX
<ejb.server.log.directory>#²/cjdevelopment[n].log

1 MB 4
DevelopmentLogFile

Legend:

--: Not applicable

Note:

Channel name is the name to identify the output destination of the log. Use it as a key value when changing log attributes (size, number of files).

#1

In the part of the log file name [n], the file number (number of files from 1 (maximum 16)) is added.

However, when using Microsoft IIS in the redirector, or when using the sub directory shared mode of an EJB client application, the maximum number of files is 64.

Moreover, in the [nn] part, a serial number from 01 to 99 is added.

#2

<ejb.server.log.directory> indicates a directory specified in the ejb.server.log.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. The default value is Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs.

For details about the ejb.server.log.directory parameter in the Easy Setup definition file, see 4.14.2 Parameters for setting option definition for J2EE server and 2.3 usrconf.cfg (option definition file for J2EE server) in the uCosminexus Application Server Definition Reference Guide.

#3

Check the file contents when the file is output. If the maximum size is exceeded while checking, rename the cjlogger.log file with the backup file name (cjlogger_save.log).

#4

The directory and file names can be set in isapi_redirect.conf (redirector action definition file for Microsoft IIS) or mod_jk.conf (redirector action definition file for Cosminexus HTTP Server). For details about the settings for acquiring the redirector logs, see 3.3.10 Settings for Acquiring the Redirector Log. For details about each file, see the uCosminexus Application Server Definition Reference Guide.

Among the messages output to the redirector message log, messages from KDJE21000-Z to KDJE21999-Z (Z shows the variable, E (error message), W (warning message), I (notification message)) are the messages for maintenance.

#5

Decision about acquiring the resource adapter log depends on the contents specified in server management commands. Moreover, you can use the simple setup definition file to change the size and number of files for a resource adapter log. For details about the settings for acquiring the resource adapter logs, see 3.3.13 Settings for Acquiring the Resource Adapter Logs.

#6

Stack trace for the exception that occurred in a servlet and JSP is also output.

#7

It is a log in which only the start process information is acquired. As it is output mainly while starting and terminating J2EE server, this log is almost not output online. When the file size reaches the upper limit, it is saved in cjstdout_save.log or cjstderr_save.log under working-directory\ejb\server-name\logs (in Windows) or under working-directory/ejb/server-name/logs (in UNIX). If cjstdout_save.log or cjstderr_save.log already exists, it is overwritten.

#8

The size and number of files cannot be changed.

#9

The output destination of the log file differs depending on the Windows event log settings.

#10

To output messages related to J2EE server start, stop, and abnormal termination, to syslog, it is necessary to set the priority for the facility daemon to info or debug in the syslog settings. For details about the syslog settings, see the manual provided with the OS.

Note

When using Cosminexus HTTP Server (UNIX) as a Web server, a specified number of redirector log files are created with a file size specified in mod_jk.conf, when the Web server is started. At this time, trace files are initialized as space (0x20). When working with the default file size and number of files, it is necessary to have 84 MB of disk space in the directory specified in the log output destination.

When using Microsoft IIS as a Web server, the number of redirector log files and the files with the file size specified in isapi_redirect.conf are all created when the Web server is accessed for the first time. At this time, trace files are initialized as space (0x20). When working with the default file size and number of files, it is necessary to have 84 MB of disk space in the directory specified in the log output destination.

In UNIX, execute the following command before acquiring the redirector trace log for maintenance.
/opt/hitachi/HNTRLib2/bin/hntr2sync JkTraceLogFileDir-specification-value/JkTraceLogFilePrefix-specification-value
Note that JkTraceLogFileDir and JkTraceLogFilePrefix are the keys specified in mod_jk.conf (Cosminexus HTTP Server redirector action definition file).

Reference note

When using the session failover function, the log for session failover is output to the following output destination:

Session failover function log
This log is output as a J2EE server log that uses the session failover function.

SFO server log
When the memory session failover functionality is used, the log of a J2EE server operating as the SFO server is output in the same directory as that of the J2EE server. Moreover, the log of applications running on the SFO server is also output to the J2EE server log where the SFO server applications are running.

(b) Server management command log

Table 4-5 Output destination of the server management command log (Default)

Category
Contents
Log output destination and log file name#1
Default size number of files
Channel name

Message log
Operation log#2, #3

In Windows
Cosminexus-installation-directory\CC\admin\logs\cjmessage[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/cjmessage[n].log

1024KB 3
MessageLogFile

Log operation log#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\cjlogger.log

In UNIX
/opt/Cosminexus/CC/admin/logs/ cjlogger.log

1024KB 2
--

Exception log
Exception information when an error occurs#2, #3

In Windows
Cosminexus-installation-directory\CC\admin\logs\cjexception[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/cjexception[n].log

1024KB 6
ExceptionLogFile

Maintenance log
Maintenance information#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\CC\maintenance\cjmaintenance[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/CC/maintenance/cjmaintenance[n].log

1024KB 3
MaintenanceLogFile

Maintenance log
Console message#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\CC\maintenance\cjconsole[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/CC/maintenance/cjconsole[n].log

32KB 3
ConsoleLogFile

Maintenance information of the server management command#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\CC\maintenance\cjserveradmin[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/CC/maintenance/cjserveradmin[n].log

32KB 3
ServerAdminLogFile

Legend:

--: Not applicable

Note:

Channel name is the name to identify the output destination of the log.

#1

In the [n] part of the log file name, add the file number (from 1 to the maximum number of files for each log).

#2

The command name is displayed in the output message (application identification name) of the Hitachi Trace Common Library format. For details on the log in the Trace Common Library format, see 5.2 Application Server log.

#3

For the compatibility mode, the output destination of the operation log and the exception information when an error occurs will differ from the standard mode. For the compatibility mode, the output destination, the default size, and the number of files are as follows:

Table 4-6 Output destination of server management commands log (Compatibility mode)

Contents
Log output destination and log file name#
Default size number of files

Operation log

In Windows
Cosminexus-installation-directory\CC\admin\logs\<command-name>message[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/command-name/message[n].log

128KB 2

Exception information when an error occurs

In Windows
Cosminexus-installation-directory\CC\admin\logs\<command-name>exception[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/command-name/exception[n].log

256KB 2

#

In the [n] part of the log file name, add the file number (from 1 to the maximum number of files for each log).

In the messages output to the message log of the server management commands, there are the cases when the message ID field is blank and message ID (such as KDJEnnnnn-Y) is included in the message text field. This is an additional information of the messages output before or after the messages are output at the server side.

(c) Resource adapter version-up command (cjrarupdate) log

Table 4-7 Output destination of the resource adapter version-up command (cjrarupdate) log

Category
Contents
Log output destination and log file name#
Default size number of files

Message log
Operation log

In Windows
Cosminexus-installation-directory\CC\logs\cjrarupdatemessage[n].log#1

In UNIX
/opt/Cosminexus/CC/logs/cjrarupdatemessage[n].log#1

1MB 2

Exception log
Exception information when an error occurs

In Windows
Cosminexus-installation-directory\CC\logs\cjrarupdateexception[n].log#1

In UNIX
/opt/Cosminexus/CC/logs/cjrarupdateexception[n].log#1

1MB 2

Maintenance log
Maintenance information

In Windows
Cosminexus-installation-directory\CC\logs\cjrarupdatemaintenance[n].log#2

In UNIX
/opt/Cosminexus/CC/logs/cjrarupdatemaintenance[n].log#2

16 MB 4

#1

In the[n]part of the log file name, add the file number (1 or 2).

#2

In the[n]part of the log file name, add the file number (from 1 to 4).

(d) In-process HTTP server log

Table 4-8 Output destination of an in-process HTTP server log (Default)

Category
Contents
Log output destination and log file name
Default size number of files

Access log
Processing result of in-process HTTP server

In Windows
<ejb.server.log.directory>#1\http\cjhttp_access.inprocess_http[n].log#2

In UNIX
<ejb.server.log.directory>#1/http/cjhttp_access.inprocess_http[n].log#2

4MB 16

Thread trace
Information on thread trace

In Windows
<ejb.server.log.directory>#1\http\maintenance\thr\cjhttp_thr.time-information.inprocess_http.mm#3

In UNIX
<ejb.server.log.directory>#1/http/maintenance/thr/cjhttp_thr.time-information.inprocess_http.mm#3

about 3.2MB#4 16

Communication trace
Information on communication trace

In Windows
<ejb.server.log.directory>#1\http\maintenance\comm\cjhttp_comm.time-information.inprocess_http.mm#3

In UNIX
<ejb.server.log.directory>#1/http/maintenance/comm/cjhttp_comm.time-information.inprocess_http.mm#3

About 16.6MB#4 16

#1

<ejb.server.log.directory> indicates a directory specified in the ejb.server.log.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) of the Easy Setup definition file. The default value is Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs.

For details about the ejb.server.log.directory parameter of the Easy Setup definition file, see 4.14.2 Parameters for setting option definition for J2EE server and 2.3 usrconf.cfg (option definition file for J2EE server) in the uCosminexus Application Server Definition Reference Guide.

#2

In [n], the file number (number of files from 1 (maximum 16)) is attached.

#3

In <time information>, the date and time when the file was output is displayed in YYYYMMDDHHmmSSnnn format. For example, if the date and time when the file was output is 2005-01-20 at10:50:30.158, the file name will become as cjhttp_thr.20050120105030158.inprocess_http.mm or cjhttp_comm.20050120105030158.inprocess_http.mm.

#4

At every start-up, create a new trace file. If the number of files exceeds the maximum value (default value is 16), the file with the oldest date and time is reused.

File size is decided as follows:

File size of the thread trace = (((A+B) 32786)+ 32914) byte

File size of the communication trace = (((A+B) 172050)+128) byte

A= Value of webserver.connector.inprocess_http.max_connections

B = If the value of webserver.connector.inprocess_http.send_timeout is 0, then 0 and if it is not 0, then 1

Note

Execute the following commands before acquiring the thread trace and communication trace for in-process HTTP server:

In Windows

Cosminexus-installation-directory\CC\admin\bin\cjtracesync [-thr|-comm] server-name

In UNIX

/opt/Cosminexus/CC/admin/bin/cjtracesync [-thr|-comm] server-name

For details about the cjtracesync command, see cjtracesync (trace file synchronization for in-process HTTP server) in the uCosminexus Application Server Command Reference Guide.

(e) Cosminexus JPA Provider log

Table 4-9 Output destination of the Cosminexus JPA Provider log (Default)

Category
Contents
Log output destination and log file name#
Default size number of files
Channel name

Operation log
SQL

In Windows
Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs\cjpa\cjpaoperation[n].log

In UNIX
/opt/Cosminexus/CC/server/public/ejb/server-name/logs/cjpa/cjpaoperation[n].log

1024KB 2
JPAOperationLogFile

Transaction

Maintenance log
Maintenance information

In Windows
Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs\cjpa\maintenance\cjpamaintenance[n].log

In UNIX
/opt/Cosminexus/CC/server/public/ejb/server-name/logs/cjpa/maintenance/cjpamaintenance[n].log

1024KB 2
JPAMaintenanceLogFile

In Windows
Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs\cjpa\maintenance\cjpadefinition[n].log

In UNIX
/opt/Cosminexus/CC/server/public/ejb/server-name/logs/cjpa/maintenance/cjpadefinition[n].log

1024KB 2
--

Legend:

--: Not applicable

Note:

Channel name is the name to identify the output destination of the log. Use it as a key value when changing log attributes (size, number of files).

#

In [n], add the file number (number of files from 1 (maximum 16)).

(f) Migration command (cjenvupdate) log

Table 4-10 Output destination of the migration command (cjenvupdate) log

Category
Contents
Log output destination and log file name#
Default size number of files

Message log
Operation log of the cjenvupdate command

In Windows
Cosminexus-installation-directory\CC\logs\cjenvupdatemessage[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjenvupdatemessage[n].log

4MB 4

Exception log
Exception information of the cjenvupdate command

In Windows
Cosminexus-installation-directory\CC\logs\cjenvupdateexception[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjenvupdateexception[n].log

4MB 4

Maintenance log
Maintenance information of the cjenvupdate command

In Windows
Cosminexus-installation-directory\CC\logs\cjenvupdatemaintenance[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjenvupdatemaintenance[n].log

4MB 4

#

In [n], the file number (from 1 to 4) is attached.

(g) Resource depletion monitoring log

Table 4-11 Output destination of resource depletion monitoring log

Monitored
Resources
Log acquisition location and log file name#1
Default size number of files
Channel name

Memory

In Windows
<ejb.server.log.directory>#2\watch\cjmemorywatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjmemorywatch[n].log

1MB 2
MemoryWatchLogFile

File descriptors

In UNIX#3
ejb.server.log.directory#2/watch/cjfiledescriptorwatch[n].log

1MB 2
FileDescriptorWatchLogFile

Threads

In Windows
<ejb.server.log.directory>#2\watch\cjthreadwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjthreadwatch[n].log

1MB 2
ThreadWatchLogFile

Thread dump

In Windows
<ejb.server.log.directory>#2\watch\cjthreaddumpwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjthreaddumpwatch[n].log

1MB 2
ThreaddumpWatchLogFile

HTTP requests pending queue

In Windows
<ejb.server.log.directory>#2\watch\cjrequestqueuewatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjrequestqueuewatch[n].log

1MB 2
RequestQueueWatchLogFile

HTTP session numbers

In Windows
<ejb.server.log.directory>#2\watch\cjhttpsessionwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjhttpsessionwatch[n].log

1MB 2
HttpSessionWatchLogFile

Connection pool

In Windows
<ejb.server.log.directory>#2\watch\cjconnectionpoolwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjconnectionpoolwatch[n].log

1MB 2
ConnectionPoolWatchLogFile

Note:

Channel name is the name to identify the output destination of the log. Use it as a key value when changing log attributes (size, number of files).

#1

In [n], the file number (number of files from 1 (maximum 16)) is attached.

#2

<ejb.server.log.directory> indicates the directory specified in the ejb.server.log.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) of the Easy Setup definition file. The default value is Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs.

For details about the ejb.server.log.directory parameter in the Easy Setup definition file, see 4.14.2 Parameters for setting option definition for J2EE server and 2.3 usrconf.cfg (option definition file for J2EE server) in the uCosminexus Application Server Definition Reference Guide.

#3

The file descriptor cannot be monitored in Windows and AIX.

For details about the information output to the resource depletion monitoring log file and for the output format of the log file, see 4.3 Resource depletion monitoring functionality and output of resource depletion monitoring information in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

(h) User definition file to set output destination of the log

When the output destination of the J2EE server, redirector, and server management command log output destination is changed, reference the user definition file in which the log output destination is set, described in the following table and confirm the output destination. Note that if the output destination of a log is changed, that log is not collected when the snapshot log is collected in a batch. Change the collection destination of the snapshot log as and when required.

Table 4-12 User definition file in which the output destination of log is set

Category
User definition file

J2EE server
The ejb.server.log.directory parameter is specified in the <configuration> tag of the logical J2EE server (j2ee-server) of the Easy Setup definition file.
The default is Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs (in Windows), or /opt/Cosminexus/CC/server/public/ejb/server-name/logs (in UNIX).

Redirector

In the case of Cosminexus HTTP Server

Message log
The JkLogFileDir parameter specified in the <configuration> tag of the logical Web server (web-server) of the Easy Setup definition file.
The default is logs.

Maintenance trace log
The JkTraceLogFileDir parameter specified in the <configuration> tag of the logical Web server (web-server) of the Easy Setup definition file
The default is logs.

Microsoft IIS

Message log
log_file_dir key of Cosminexus-installation-directory\CC\web\redirector\isapi_redirect.conf
The default key is Cosminexus-installation-directory\CC\web\redirector\logs.

Maintenance trace log
trace_log_file_dir key of Cosminexus-installation-directory\CC\web\redirector\isapi_redirect.conf
The default key is Cosminexus-installation-directory\CC\web\redirector\logs.

Server management commands
ejbserver.log.directory key of the server management command usrconf.bat (in Windows) or usrconf (in UNIX)
The default key is Cosminexus-installation-directory\CC\admin\logs (in Windows) or /opt/Cosminexus/CC/admin/logs (in UNIX).
You cannot change the output destination of the server management command log when operating from the Management Server remote management functionality.

For details about the settings of the data acquisition for troubleshooting, such as how to change the output destination of the logs, see the chapter 3. Preparing for Troubleshooting.

(2) Acquiring the log of Administration agent, Management agent, and Management Server

This points describes the output destination of the Administration Agent, Management Agent, and the Management Server log.

In the Administration agent, Management agent, and Management Server logs, besides acquiring separately, you can also acquire these logs by compiling as a Integrated log. Following are the types of integrated logs:

Integrated message log
The message logs of the Manager are integrated and output.

Integrated trace log
The trace logs of the Manager are integrated and output.

Command maintenance log#
The management commands, the commands used with Smart Composer functionality, and the trace log of the snapshotlog command are integrated and output.

# For details about the commands used with the Smart Composer functionality, see 8. Commands used in the Smart Composer functionality in the uCosminexus Application Server Command Reference Guide.

The following table describes the output destination of integrated logs.

Table 4-13 Output destination of the integrated log (In Windows)

File name | Contents | Output destination directory | Default size number of files
mngmessage[n].#1log | Integrated message log | Log-output-directory-of-Manager\message#2 | 256KB 4
mngtrace[n]#1.log | Integrated trace log | Log-output-directory-of-Manager\trace#2 | 1MB 4
mngcmd[n]#1.log | Command maintenance log | Log-output-directory-of-Manager\maintenance#2 | 16MB 4

#1

In the part of the log file name [n], the file number (number of files from 1 (maximum 64)) is added.

#2

Log-output-directory-of-Manager indicates the directory specified in manager.cfg (Manager log settings file). The default value is Cosminexus-installation-directory\manager\log. For details about manager.cfg, see 10.10 manager.cfg (Manager settings file) in the uCosminexus Application Server Definition Reference Guide.

Table 4-14 Output destination of the integrated log (in UNIX)

File name | Contents | Output destination directory | Default size number of files
mngmessage[n]#1.log | Integrated message log | Log-output-directory-of-Manager/message#2 | 256KB 4
mngtrace[n]#1.log | Integrated trace log | Log-output-directory-of-Manager/trace#2 | 1MB 4
mngcmd[n]#1.log | Command maintenance log | Log-output-directory-of-Manager/maintenance#2 | 16MB 4

#1

In the part of the log file name [n], the file number (number of files from 1 (maximum 64)) is added.

#2

Log-output-directory-of-Manager indicates the directory specified in manager.cfg (Manager log settings file). The default value is /opt/Cosminexus/manager/log. For details about manager.cfg, see 10.10 manager.cfg (Manager settings file) in the uCosminexus Application Server Definition Reference Guide.

Note that the log output in the integrated log is output separately by default.

Additionally, the logs output in the integrated log might not output separately. For details about the settings to output integrated logs, see 3.3.12 Settings for Acquiring the Cosminexus Manager Log.

The following table describes the Administration agent, Management agent, and Management Server log output destination as well as the possibility of output to integrated message log and integrated trace log when acquiring separately.

Table 4-15 Output destination when acquiring the Administration agent, Management agent, and Management Server log separately (in Windows)

Category
File name
Contents
Output destination directory
Default size number of files
Integrated message log/ integrated trace log

Administration agent
adminagent.err.[1-16].log#1
Standard error output of Administration agent
Log-output-directory-of-the-Manager
64KB 4
N

adminagent.out.[1-16].log#1
Standard output of Administration agent
64KB 4
N

adminagent.err
Standard command line error output of Administration agent
--
N

adminagent[1-16].log
Administration agent log
64KB 4
Y

adminagentctl.exe.[1-2].log
Administration agent start, stop command log
64KB 2
N

adminagent[n]#2.log
Administration agent maintenance log
Log-output-directory-of-Manager\maintenance
16MB 4
N

mngrmi[n]#².log
Maintenance log in RMI processing executed by Administration Agent
16MB 8
N

Administration agent
processConsole[n]#2.log
Console log
Log-output-directory-of-the-Manager
64KB 4
N

adminagentsv.exe.[1-16]log#1
Administration agent service log
64KB 2
N

adminagentsv.exe.out#1
Administration agent service standard output
--
N

adminagentsv.exe.err#1
Administration agent service standard error output
--
N

adminagent.javalog[01-04].log
JavaVM log file of Administration Agent
256KB 4
N

Management agent
mngagent-domain-name-agent-name.[n]#2.log#3

Management agent log and trace

System JP1 event and user JP1 event log#4 for J2EE server

Management event published log#5

Log-output-directory-of-the-Manager
64KB 4
N

Management Server
mngsvr.exe.[1-2
].log
Management Server service log
Log-output-directory-of-the-Manager
64KB 2
N

mngsvr.exe.err#1
Management Server service standard error output
--
N

mngsvr.exe.out#1
Management Server service standard output
--
N

mngsvrctl.exe.[1-2].log
Management Server service start, stop command log
64KB 2
N

mngsvr[n]#2.log

Management Server log

Management server#6 system JP1 event log#4

64KB 4
Y

mngsvr[n]#2.log
Management Server maintenance log
Log-output-directory-of-Manager\maintenance
16MB 2
N

cjmessage[n].log
Operation log
Manager-log-output-directory
1 MB 2
N

cjexception[n].log
Exception information for error
Manager-log-output-directory\maintenance
1 MB 2
N

cjmaintenance[n].log
Maintenance information
16 MB 4
N

cjconsole[n].log
Console message
1 MB 2
N

cjejbcontainer[n].log
EJB container maintenance information
1 MB 2
N

web_servlet[n].log
Web servlet log
4 MB 4
N

user_out[n].log
User output log
1 MB 2
N

user_err[n].log
User error log
1 MB 2
N

cjlogger.log
Log operation log
1 MB 2
N

javalog[nn].log
JavaVM maintenance information and garbage collection log
4 MB 4
N

ehjavalog[nn].log
Event log of the Explicit Memory Management functionality
4 MB 4
N

cjwebcontainer[n].log
Web container maintenance information
1 MB 2
N

cjstdout.log
Standard output information for the start process
Manager-log-output-directory\maintenance/CC/maintenance
--
N

cjstderr.log
Standard error information for the start process
--
N

cj_shutdown[n].log
End process information
4 KB 4
N

cjrmi[n].log
RMI communication log for the J2EE servers
Manager-log-output-directory\maintenance\CC\rmi
1 MB 4
N

cjhttp_thr.time-information.inprocess_http.mm
Thread trace information
Manager-log-output-directory\maintenance\http\maintenance\thr
--
N

cjhttp_comm.time-information.inprocess_http.mm
Communication trace information
Manager-log-output-directory\maintenance\maintenance\http\maintenance\comm
About 3.2 MB 16
N

cjmemorywatch[n].log
Resource depletion monitoring log (Memory)
Manager-log-output-directory\maintenance\watch
16.6 MB 16
N

cjthreadwatch[n].log
Resource depletion monitoring log (Thread)
1 MB 2
N

cjthreaddumpwatch[n].log
Resource depletion monitoring log (Thread dump)
1 MB 2
N

cjrequestqueuewatch[n].log
Resource depletion monitoring log (HTTP request pending queue)
1 MB 2
N

cjhttpsessionwatch[n].log
Resource depletion monitoring log (Number of HTTP sessions)
1 MB 2
N

Legend:

Y: Output to an integrated log

N: No output to an integrated log

[1-n]: Shows that a serial number in the range from 1 to n is used for the number of log files.

--: Not applicable

Note:

<Manager-log-output-directory> shows the directory specified in manager.cfg (Manager log setup file). The default is Cosminexus-installation-directory\manager\log (in Windows) or /opt/Cosminexus/manager/log (in UNIX). For details on manager.cfg, see 10.10 manager.cfg (Manager setup file) in the uCosminexus Application Server Definition Reference Guide.

#1

The log is output in a format different than Hitachi Trace Common Library format. For details on the log in the Trace Common Library format, see 5.2 Application Server log.

#2

In the part of file name [n], the serial number from 1 to total number of specified log files is added.

#3

You can change the output destination of Management agent log trace. If the output destination of Management agent log and trace is changed, see the mngagent.log.filename key value of the mngagent.properties file (Management agent property file).

#4

This log is output if a system built with the application server by integrating with JP1 is to be operated.

#5

This log is output when a Management event is used.

#6

This log is for the Management Server of the Application Server.

Table 4-16 Output destination when acquiring the Administration agent, Management agent, and Management Server log separately (in UNIX)

Category
File name
Contents
Output destination directory
Default size number of files
Integrated message log/ integrated trace log

Administration agent
adminagent.err.[1-16].log#1
Standard error output of Administration agent
Log-output-directory-of-the-Manager
64KB 4
N

adminagent.out.[1-16].log#1
Standard output of Administration agent
64KB 4
N

adminagent.err
Standard command line error output of Administration agent
--
N

adminagent[1-16].log
Administration agent log
64KB 4
Y

adminagentctl.[1-16].log
Administration agent start, stop command log
64KB 2
N

adminagent[n]#2.log
Administration agent maintenance log
Log-output-directory-of-Manager/maintenance
16MB 4
N

mngrmi[n]#2.log
Maintenance log in RMI processing executed by Administration Agent
16MB 8
N

Administration agent
processConsole[n]#2.log
Console log
Log-output-directory-of-the-Manager
64KB 4
N

adminagent.javalog[01-04].log
JavaVM log file of Administration Agent
256KB 4
N

Management agent
mngagent-domain-name-agent-name. [n]#2.log#3

Management agent log and trace

System JP1 event and user JP1 event log#4 for J2EE server

Management event published log#5

64KB 4
N

Management Server
mngsvrctlstart.[1-2].log
Management Server start command
Log-output-directory-of-the-Manager
64KB 2
N

mngsvrctlstop.[1-2].log
Management Server stop command
64KB 2
N

mngsvrctlsetup.[1-2].log
Management Server set up command
64KB 2
N

mngsvr[n].log

Management Server log

Management server#6 system JP1 event log#4

64KB 4
Y

mngenvsetup.[1-2].log
Execution log of the mngenvsetup command
Log-output-directory-of-Manager/maintenance
512KB 2
N

mngsvr[n]#2.log
Management Server maintenance log
Log-output-directory-of-Manager/maintenance
16MB 2
N

cjmessage[n].log
Operation log
Manager-log-output-directory
1 MB 2
N

cjexception[n].log
Exception information for error
Manager-log-output-directory/maintenance
1 MB 2
N

cjmaintenance[n].log
Maintenance information
16 MB 4
N

cjconsole[n].log
Console message
1 MB 2
N

cjejbcontainer[n].log
EJB container maintenance information
1 MB 2
N

web_servlet[n].log
Web servlet log
4 MB 4
N

user_out[n].log
User output log
1 MB 2
N

user_err[n].log
User error log
1 MB 2
N

cjlogger.log
Log operation log
1 MB 2
N

javalog[nn].log
JavaVM maintenance information and garbage collection log
4 MB 4
N

ehjavalog[nn].log
Event log of the Explicit Memory Management functionality
4 MB 4
N

cjwebcontainer[n].log
Web container maintenance information
1 MB 2
N

cjstdout.log
Standard output information for the start process
Manager-log-output-directory/maintenance/CC/maintenance
--
N

cjstderr.log
Standard error information for the start process
--
N

cj_shutdown[n].log
End process information
4 KB 4
N

cjrmi[n].log
RMI communication log for the J2EE servers
Manager-log-output-directory/maintenance/CC/rmi
1 MB 4
N

cjhttp_thr.time-information.inprocess_http.mm
Thread trace information
Manager-log-output-directory/maintenance/http/maintenance/thr
--
N

cjhttp_comm.time-information.inprocess_http.mm
Communication trace information
Manager-log-output-directory/maintenance/http/maintenance/comm
About 3.2 MB 16
N

cjmemorywatch[n].log
Resource depletion monitoring log (Memory)
Manager-log-output-directory/maintenance/watch
16.6 MB 16
N

cjfiledescriptorwatch[n].log
Resource depletion monitoring log (File descriptor)
1 MB 2
N

cjthreadwatch[n].log
Resource depletion monitoring log (Thread)
1 MB 2
N

cjthreaddumpwatch[n].log
Resource depletion monitoring log (Thread dump)
1 MB 2
N

cjrequestqueuewatch[n].log
Resource depletion monitoring log (HTTP request pending queue)
1 MB 2
N

cjhttpsessionwatch[n].log
Resource depletion monitoring log (Number of HTTP sessions)
1 MB 2
N

Legend:

Y: Output to an integrated log

N: No output to an integrated log

[1-n]: Shows that a serial number in the range from 1 to n is used for the number of log files.

--: Not applicable

#1

The log is output in a format different than Hitachi Trace Common Library format. For details on the log in the Trace Common Library format, see 5.2 Application Server log.

#2

In the part of file name [n], the serial number from 1 to total number of specified log files is added.

#3

You can change the output destination of Management agent log trace. If the output destination of Management agent log and trace is changed, see the mngagent.log.filename key value of the mngagent.properties file (Management agent property file).

#4

This log is output if a system built with the application server by integrating with JP1 is to be operated.

#5

This log is output when a Management event is used.

#6

This log is for the Management Server of the Application Server.

Note

In the console log, the standard output and the standard error output of the server process started by the Administration agent is output. The precautions related to console log are as follows.

In Windows, the console log is not output for the following processes:
Logical performance tracer
Logical Web server
Logical CTM domain manager
Logical CTM
Logical user server started indirectly
For the startup types of the logical user server, see 10.21 Logical user server definition files in the uCosminexus Application Server Definition Reference Guide.

When multiple lines of information to be output to the console log are output at the same time, console log displays the information by consolidating into a single line.

When the number of characters of the information to be output in console information exceeds 2039 characters, the information after the 2039th character is split and output to the following line.

(3) Acquiring the logs of the internal setup tool of the virtual server manager and Server Communication Agent

This subsection describes the output destination for logs of the internal setup tool of the virtual server manager and Server Communication Agent.

The following table describes the output destination for logs of the internal setup tool of the virtual server manager and Server Communication Agent, and the presence or absence of output to the integrated message log or integrated trace log.

Table 4-17 Output destination for logs of the internal setup tool of the virtual server manager and Server Communication Agent

Category
File name
Contents
Output destination directory
Default size number of files
Integrated message log/ Integrated trace log

Internal setup tool of the virtual server manager
rasetup[n]#2.log
Logs for the internal setup tool of the virtual server manager

In Windows

Cosminexus-installation-directory\manager\setup\log

In UNIX

/opt/Cosminexus/manager/setup/log

262144 bytes 4
N

rasetup[n#2.log
Maintenance logs for the internal setup tool of the virtual server manager

In Windows

Cosminexus-installation-directory\manager\setup\log\maintenance

In UNIX

/opt/Cosminexus/manager/setup/log/maintenance

16777216​ bytes 4
N

Server Communication Agent
sinaviagent[n] #2.log
Server Communication Agent logs
Log-output-directory-of-Server-Communication-Agent#1
524288 bytes 4
N

sinaviagentsv[n] #2.log
Service logs of the Server Communication Agent
65536 bytes 4
N

snactl[n] #2.log
Start and stop command logs of the Server Communication Agent
65536 bytes 4
N

sinaviagent.err
Standard error output of the Server Communication Agent
65536 bytes 1
N

sinaviagent.out
Standard output of the Server Communication Agent
65536 bytes 1
N

processConsole[n] #2.log
Console logs
65536 bytes 4
N

Server Communication Agent
sinaviagent[n] #2.log
Maintenance logs of the Server Communication Agent

In Windows

Cosminexus-installation-directory\sinagent\log\maintenance

In UNIX

/opt/Cosminexus/sinagent/log/maintenance

1048576​ bytes 4
N

sinaviagentsv[n] #2.log
Maintenance logs for the Server Communication Agent services
65536 bytes 4
N

snactl[n] #2.log
Maintenance logs for the start and stop commands of the Server Communication Agent
65536 bytes 4
N

sinaviagent.javalog[n]. #2log
JavaVM log file of the Server Communication Agent
256 KB 4
N

Legend:

N: No output to an integrated log.

[n]: Shows that a serial number in the range from 1 to n is used for the number of log files.

#1

Log-output-directory-of-Server-Communication-Agent indicates the directory specified in sinaviagent.cfg (option definition file for Server Communication Agent). The default values are Cosminexus-installation-directory\sinagent\log (in Windows), or /opt/Cosminexus/sinagent/log (in UNIX).

#2

In the [n] part of the file name, a serial number is added sequentially from 1 up to the specified number of log files.

(4) Acquiring the integrated user management log

The integrated user management trace file is output according to the settings in the com.cosminexus.admin.auth.trace.prefix option of the ua.conf file (integrated user management configuration file). For details about the ua.conf file, see 14.3 ua.conf (Integrated user management configuration file) in the uCosminexus Application Server Security Management Guide.

(5) Collecting Cosminexus JMS Provider logs

This subsection describes the collection of Cosminexus JMS Provider logs. With Cosminexus JMS Provider, you can collect CJMSP Broker logs, management command (cjmsicmd) logs, and CJMSP resource adapter logs. The following table describes the default log output destinations.

Table 4-18 Output destination of Cosminexus JMS Provider logs (Default)

Log type
Category
Default output destination
Default size Number of files

CJMSP Broker log
Message log

In Windows
<CJMSP_HOME>#1
\var\instances\instanceName\log\cjmsbroker_msg[n].log

In UNIX
<CJMSP_HOME>#
¹/var/instances/instanceName/log/cjmsbroker_msg[n].log

1 MB 2

Error log

In Windows
<CJMSP_HOME>#1
\var\instances\instanceName\log\cjmsbroker_err[n].log

In UNIX
<CJMSP_HOME>#1
/var/instances/instanceName/log/cjmsbroker_err[n].log

1 MB 2

Management command (cjmsicmd) log#2
Message log

In Windows
<CJMSP_HOME>#1
\var\admin\log\cjmsadmin_msg[n].log

In UNIX
<CJMSP_HOME>#1
/var/admin/log/cjmsadmin_msg[n].log

1 MB 2

Error log

In Windows
<CJMSP_HOME>#1
\var\admin\log\cjmsadmin_err[n].log

In UNIX
<CJMSP_HOME>#1
/var/admin/log/cjmsadmin_err[n].log

1 MB 2

CJMSP resource adapter log
Message log

In Windows
J2EE-server-log-output-directory-(ejb.server.log.directory)#3
\cjms\Cosminexus_JMS_Provider_RA\cjmsra_msg[n].log

In UNIX
J2EE-server-log-output-directory-(ejb.server.log.directory)#3
/cjms/Cosminexus_JMS_Provider_RA/cjmsra_msg[n].log

1 MB 2

Error log

In Windows
J2EE-server-log-output-directory-(ejb.server.log.directory)#3
\cjms\Cosminexus_JMS_Provider_RA\cjmsra_err[n].log

In UNIX
J2EE-server-log-output-directory-(ejb.server.log.directory)#3
/cjms/Cosminexus_JMS_Provider_RA/cjmsra_err[n].log

1 MB 2

Note

In [n], add the file number (number of files from 1 (maximum 16)).

#1

<CJMSP_HOME> indicates the following directory:

In Windows

Cosminexus-installation-directory\CC\cjmsp

In UNIX

/opt/Cosminexus/CC/cjmsp

#2

If the log output has reached the specified maximum file size, the log output destination switches to the next file. If the file count reaches the specified number of files, the output destination switches to the first file by the wraparound method and the original information is overwritten. Note that the file is initialized only during the creation and not during the wraparound. If the file size is extended, the file is initialized only for the extended part. Initialization means writing null characters (0x20) in the area from EOF (End Of File) to the specified file size. The existing data is not affected.

#3

J2EE-server-log-output-directory (ejb.server.log.directory) is the directory specified in the J2EE server option definition. By default, the following directory is specified:

In Windows

Directory-specified-in-ejb.public.directory\ejb\J2EE-server-name\logs

In UNIX

Directory-specified-in-ejb.public.directory/ejb/J2EE-server-name/logs

(6) Required information to be acquired other than a log

This section describes the required information to be acquired other than a log.

When using the in-process transaction service

When using the in-process transaction service, it is necessary to acquire the status file of the in-process transaction service. Note that you also acquire the spare status file when the status file is duplicated.

The status file is stored in the path specified in the ejbserver.distributedtx.ots.status.directory1 parameter and the ejbserver.distributedtx.ots.status.directory2 parameter (during duplication) in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy setup definition file.

4.3.2 Acquiring the Cosminexus Performance Tracer Log

This section describes the Cosminexus Performance Tracer log type and output destination of the log.

Organization of this subsection

(1) Cosminexus Performance Tracer log type

(2) Cosminexus Performance Tracer log output destination

(1) Cosminexus Performance Tracer log type

In Cosminexus Performance Tracer, output the PRF daemon, PRF command log for each PRF identifier. Furthermore, output the error analysis log (various maintenance information), used by the maintenance personnel for error analysis when a problem occurs in the system, to the environment variable PRFSPOOL settings directory.

When you want to monitor the daily operations, monitor the event log and syslog.

(2) Cosminexus Performance Tracer log output destination

The output destination of the Cosminexus Performance Tracer log is as follows:

Table 4-19 Output destination of the Cosminexus Performance Tracer log

Contents
Output destination directory#1

PRF daemon and PRF command log

In Windows
environment-variable-PRFSPOOL-settings-directory\log\PRF-identifier\ctmlog[n]
and event log #2

In UNIX
$PRFSPOOL/log/PRF-identifier/ctmlog[n]
and syslog #3

Module trace

In Windows
environment-variable-PRFSPOOL-settings-directory\utt\umt

In UNIX
$PRFSPOOL/utt/umt

Structured exception occurrence log
(In Windows)
Environment-variable-PRFSPOOL-settings-directory\oslttrc

Maintenance information

In Windows
environment-variable-PRFSPOOL-settings-directory

In UNIX
$PRFSPOOL/

#1

01 or 02 is displayed in [n].

#2

The messages required for operations are output. The log file output destination varies according to the Windows event log settings.

#3

The messages required for operations are output. For details on the syslog settings, see the OS documentation.

4.3.3 Acquiring the Cosminexus Component Transaction Monitor Log

This section describes the output destination of the Cosminexus Component Transaction Monitor log.

Organization of this subsection

(1) Types of Component Transaction Monitor logs

(2) Output destination of the Component Transaction Monitor logs

(1) Types of Component Transaction Monitor logs

With Component Transaction Monitor, the CTM daemon and the CTM command logs are output for each CTM identifier. Also, different maintenance information is output to the environment variable CTMSPOOL settings directory for the maintenance personnel to analyze the errors when a problem occurs in the system. Execute the ctmlogcat command to check the output messages.

Monitor the event log and syslog when you want to monitor the daily operations.

(2) Output destination of the Component Transaction Monitor logs

The following table describes the output destination of the Component Transaction Monitor logs.

Table 4-20 Output destination of the Cosminexus Component Transaction Monitor log

Contents
Output destination directory#1

CTM daemon and CTM command log

In Windows
environment-variable-CTMSPOOL-settings-directory\log\CTM-daemon-identifier\ctmlog[n]
and event log #2

In UNIX
$CTMSPOOL/log/CTM-daemon-identifier/ctmlog[n]
and syslog #3

CTM domain daemon log

In Windows
Environment-variable-CTMSPOOL-settings-directory\log\ctmdmlog[n]

In UNIX
$CTMSPOOL/log/ctmdmlog[n]

Module trace

In Windows
Environment-variable-CTMSPOOL-settings-directory\utt\umt

In UNIX
$CTMSPOOL/utt/umt

Structured exception occurrence log
(In Windows)
Environment-variable-PRFSPOOL-settings-directory\oslttrc

Maintenance information

In Windows
environment-variable-CTMSPOOL-settings-directory

In UNIX
$CTMSPOOL

#1

01 or 02 is displayed in [n].

#2

The messages required for operations are output. The log file output destination varies according to the Windows event log settings.

#3

The messages required for operations are output. For details on the syslog settings, see the OS documentation.

4.3.4 Acquiring the log output in audit log

This subsection describes the log file that is output when the audit log functionality is used.

The following table describes the types and output destinations of the log output in audit logs.

Table 4-21 Output destination of the logs output in the audit log (Default)

Category
Contents
Log output destination and log file name#
Default size number of files

Message log
Message log of the audit log

In Windows
Cosminexus-installation-directory\auditlog\rasmessage[n].log

In UNIX
/opt/Cosminexus/auditlog/rasmessage[n].log

1MB 4

Exception log
Exception information of the audit log

In Windows
Cosminexus-installation-directory\auditlog\rasexception[n].log

In UNIX
/opt/Cosminexus/auditlog/rasexception[n].log

1MB 8

#

In the part of the log file name [n], the file number (number of files from 1 (maximum 64)) is added.

4.3.5 Acquiring the Application User Log

You can acquire the application log when the settings are set so that the application log is output in the Hitachi Trace Common Library format. The user logs are in the following two types:

User log output in the J2EE application (J2EE component) running on the J2EE server.

User log output in the EJB client application.

For details on the log in the Trace Common Library format, see 5.2 Application Server log.

Organization of this subsection

(1) Acquiring the user logs of J2EE application

(2) Acquiring the EJB client application user log

(1) Acquiring the user logs of J2EE application

For the log output destination of a J2EE application, the log is output to a file, which has a name containing the prefix specified in the ejbserver.application.userlog.CJLogHandler.handler-name.path parameter in the configuration tag of the logical J2EE server (j2ee-server) in the simple setup definition file, in the directory below. Note that the handler name is specified in the handler-name to identify the key values.

In Windows
Log-output-destination-root-(-ejb.server.log.directory-value-)\user\ (default is J2EE-server-work-directory\ejb\J2EE-server-name\logs\user)

In UNIX
Log-output-destination-root-(-ejb.server.log.directory-value-)/user/ (default is J2EE-server-work-directory/ejb/J2EE-server-name /logs/user)

For details on the settings to output user logs in J2EE applications, see 9.8 Settings to output user logs in J2EE applications in the uCosminexus Application Server Expansion Guide.

(2) Acquiring the EJB client application user log

For the user log output destination of an EJB client application, the log is output to the file with the name having the prefix specified in the ejbserver.application.userlog.CJLogHandler.handler-name.path key value of the EJB client application system property in the directory below. Note that the handler name is specified in the handler-name to identify the key values.

In Windows
Log-output-destination-root-(-ejb.server.log.directory-value-)\user\(default is J2EE-server-work-directory\ejb\J2EE-server-name\logs\user)

In UNIX
Log-output-destination-root-(-ejb.server.log.directory-value-)/user/ (default is J2EE-server-work-directory/ejb/J2EE-server-name/logs/user)

For the method of setting the system properties to output user logs in EJB client applications, see 9.10 Settings of the user log output in EJB client application (for cjclstartap command) or 9.11 Implementation and settings of the user log output in EJB client application (for vbj command) in the uCosminexus Application Server Expansion Guide.

4.4 Application Server log (Systems for executing batch applications)

This subsection describes how to acquire logs output by the component software of the Application Server manually in a system for executing batch applications. Further, when the application server log is already collected as a snapshot log, you need not perform the tasks explained here.

This section describes how to acquire the following logs:

Cosminexus Component Container logs

Application user logs

Additionally, when you acquire the logs output by the component software of the Application Server manually in a system for executing the batch applications, you also acquire the following logs:

Cosminexus Performance Tracer log

Logs output in audit log

For details about how to acquire the above-mentioned logs, see 4.3 Application Server log (Systems for executing J2EE applications). The respective reference details of these logs are as follows:

Cosminexus Performance Tracer log
4.3.2 Acquiring the Cosminexus Performance Tracer Log

Log output in audit log
4.3.4 Acquiring the log output in audit log

Organization of this section

4.4.1 Acquiring the Cosminexus Component Container Logs (systems executing batch applications)

4.4.2 Acquiring the Application User Log (systems executing batch applications)

4.4.1 Acquiring the Cosminexus Component Container Logs (systems executing batch applications)

This section describes the types and output destinations of Cosminexus Component Container logs. There are two types of Cosminexus Component Container logs:

Batch server, server management commands, batch application logs

Administration agent, Management agent, Management Server logs

The output destination of each of the log is described below.

Organization of this subsection

(1) Acquiring the batch server, server management commands, batch application logs

(2) Acquiring the log of Administration agent, Management agent, and Management Server

(3) Required information to be acquired other than a log

(1) Acquiring the batch server, server management commands, batch application logs

This point describes how to acquire the batch server, server management commands, and batch application logs.

Furthermore, in Cosminexus Component Container, the migration command logs are output in addition to these logs. When the resource depletion monitoring functionality is used, the resource depletion monitoring log is output.

The four types of batch server logs are message log, user log, exception log, and maintenance log. Note that in addition to these logs, event log or syslog are output in the case of starting, stopping, and abnormal termination of a batch server.

The three types of server management command logs are message log, exception log, and maintenance log.

The one type of batch application log is message log.

In the resource adapter version up command (cjrarupdate) log, there are three types of logs, message log, exception log, and maintenance log.

The three types of migration command logs are message log, exception log, and maintenance log.

Each of these logs is described below:

Message log

The operation status of a batch server, server management command, and migration command is output. Message log is used as the operation monitoring information for various types of servers and commands.

User log

The information of the standard output and the standard error output in the application is output in the user log. Use this log to check the operation when developing the application. Note that if you specify the java.security.debug property and start the server, the standard output and standard error output information is not output to the user log. This log also includes the JavaVM memory related logs in the case of operating systems other than Solaris.

Exception log

The exception information of Cosminexus Component Container is output when a problem occurs in the system. Note that you need not monitor the exception log in daily operations. Use this log to reference exception information if a message is output to the log.

Maintenance log

The error maintenance information of Cosminexus Component Container is output when a problem occurs in the system. Maintenance personnel use this log to analyze the errors that occur in Cosminexus Component Container.

Event log (in Windows)

The information indicating start, stop, or abnormal termination of a batch server is output to this log. The output destination differs depending on the Windows event log settings.

Note that the event log is not output depending on how the batch server has been stopped. In the following cases, there are times when the log is not output correctly:

When a problem occurs in JavaVM itself when the batch server is running

When the batch server process is stopped externally by TerminateProcess

When the batch server terminates abnormally due to insufficient memory when the -XX:+HitachiOutOfMemoryAbort option is specified to start the JavaVM.
Note that the -XX:+HitachiOutOfMemoryAbort option is set by default.

syslog (in UNIX)

The information indicating start, stop, or abnormal termination of a batch server is output to this log. The output destination differs depending on the settings in the UNIX syslog.

Note that the event log is not output depending on how the batch server has been stopped. In the following cases, there are times when the log is not output correctly:

When a problem occurs in JavaVM itself when the batch server is running

When the batch server process is stopped externally by the SIGKILL signal (such as kill -9)

When the batch server terminates abnormally due to insufficient memory when the -XX:+HitachiOutOfMemoryAbort option is specified to start the JavaVM.
Note that the -XX:+HitachiOutOfMemoryAbort option is set by default.

Resource depletion monitoring log

When using the resource depletion monitoring function, the resource depletion monitoring information about the resources being monitored is output. Use it for investigating the cause if the resource usage or the used resource quantity exceeds the threshold value.

The log is recorded in an order starting from the log file attached with the smallest file number. When one log file size attains the maximum size for one file, the log is recorded in the log file attached with the next file number. When the last log file (log file attached with the file count number) size attains the maximum size for one file, the log file of file number 1 is made empty and the log is recorded in that file. Thereafter, the log is recorded in the log files in the order of the file number by emptying those log files before recording a new log.

The following table describes the default of log output destination. The Cosminexus Component Container log can be acquired according to the server or command.

The working-directory shown in the log output destination indicates a directory specified in the ejb.public.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. The default value is Cosminexus-installation-directory\CC\server\public (in Windows) or /opt/Cosminexus/CC/server/public (in UNIX).

(a) Batch server log

Table 4-22 Output destination of the batch server log (Default)

Category
Contents
Log output destination and log file name#1
Default size number of files
Channel name

Message log
Operation log

In Windows
ejb.server.log.directory#2\cjmessage[n].log

In UNIX
ejb.server.log.directory#2/cjmessage[n].log

1MB 2
MessageLogFile

Log operation log#3

In Windows
<ejb.server.log.directory>#2\cjlogger.log

In UNIX
<ejb.server.log.directory>#2/cjlogger.log

1 MB 2
--

Operation log of resource adapter that is deployed and used in batch server#4

In Windows
ejb.server.log.directory#2\connectors\resource-adapter-display-name[n].log

In UNIX
ejb.server.log.directory#2/connectors/resource-adapter-display-name[n].log

1MB 2
--

User log
User output log

In Windows
ejb.server.log.directory#2\user_out[n].log

In UNIX
ejb.server.log.directory#2/user_out[n].log

1MB 2
UserOutLogFile

User error log

In Windows
ejb.server.log.directory#2\user_err[n].log

In UNIX
ejb.server.log.directory#2/user_err[n].log

1MB 2
UserErrLogFile

JavaVM maintenance information and garbage collection log

In Windows
ejb.server.log.directory#2\javalog[nn].log

In UNIX
ejb.server.log.directory#2/javalog[nn].log

4MB 4
--

Event log of the Explicit Heap Memory Management functionality

In Windows
ejb.server.log.directory#2\ehjavalog[nn].log

In UNIX
ejb.server.log.directory#2/ehjavalog[nn].log

4MB 4
--

Exception log
Exception information when an error occurs

In Windows
ejb.server.log.directory#2\cjexception[n].log

In UNIX
ejb.server.log.directory#2/cjexception[n].log

1MB 2
ExceptionLogFile

Maintenance log
Maintenance information

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjmaintenance[n].log

In UNIX
ejb.server.log.director#2/CC/maintenance/cjmaintenance[n].log

16MB 4
MaintenanceLogFile

Console message

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjconsole[n].log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjconsole[n].log

1MB 2
ConsoleLogFile

EJB container maintenance information

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjejbcontainer[n].log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjejbcontainer[n].log

1MB 2
EJBContainerLogFile

Start process standard output information#5

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjstdout.log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjstdout.log

--
--

Maintenance log
Start process standard error information#5

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cjstderr.log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cjstderr.log

--
--

Termination process information

In Windows
<ejb.server.log.directory>#2\CC\maintenance\cj_shutdown[n].log

In UNIX
ejb.server.log.directory#2/CC/maintenance/cj_shutdown[n].log

4KB 2#6
--

Event log
Log showing batch server start, stop or abnormal termination
Application log of Windows event viewer#⁷
--
--

syslog
Log showing batch server start, stop or abnormal termination
Depends on UNIX syslog settings. #8
--
--

Legend:

--: Not applicable

Note:

Channel name is the name that identifies the log output destination.

#1

In the [n] part of the log file name, add the file number (from 1 to the maximum number of files for each log).

Moreover, in the [nn] part, a serial number from 01 to 99 is added.

#2

<ejb.server.log.directory> indicates a directory specified in the ejb.server.log.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. The default value is Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs.

For details about the ejb.server.log.directory parameter, see 3.2 usrconf.cfg (option definition file for batch server) in the uCosminexus Application Server Definition Reference Guide.

#3

Check the file size when the file is output. If the maximum size is exceeded when the file size is checked, change the name of the cjlogger.log file to the name of the backup file (cjlogger_save.log).

#4

Decision about acquiring the resource adapter log depends on the contents specified in server management commands. Moreover, you can use the simple setup definition file to change the size and number of files for a resource adapter log. For details about settings for acquiring resource adapter logs, see 3.3.13 Settings for Acquiring the Resource Adapter Logs.

#5

It is a log in which only the start process information is acquired. As it is output mainly while starting and terminating the batch server, this log is almost not output online. When the file size reaches the upper limit, it is saved in cjstdout_save.log or cjstderr_save.log under working-directory\ejb\server-name\logs (in Windows) or under working-directory/ejb/server-name/logs (in UNIX). If cjstdout_save.log or cjstderr_save.log already exists, it is overwritten.

#6

The size and number of files cannot be changed.

#7

The output destination of the log file differs depending on the Windows event log settings.

#8

To output messages related to batch server start, stop, and abnormal termination, to syslog, it is necessary to set the priority for the facility daemon to info or debug in the syslog settings. For details about the syslog settings, see the manual provided with the OS.

(b) Server management command log

Table 4-23 Output destination of server management command logs (Default)

Category
Contents
Log output destination and log file name#1
Default size number of files
Channel name

Message log
Operation log#2, #3

In Windows
Cosminexus-installation-directory\CC\admin\logs\cjmessage[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/cjmessage[n].log

1024KB 3
MessageLogFile

Log operation log#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\cjlogger.log

In UNIX
/opt/Cosminexus/CC/admin/logs/ cjlogger.log

1024KB 2
--

Exception log
Exception information when an error occurs#2, #3

In Windows
Cosminexus-installation-directory\CC\admin\logs\cjexception[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/cjexception[n].log

1024KB 6
ExceptionLogFile

Maintenance log
Maintenance information#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\CC\maintenance\cjmaintenance[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/CC/maintenance/cjmaintenance[n].log

1024KB 3
MaintenanceLogFile

Console message#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\CC\maintenance\cjconsole[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/CC/maintenance/cjconsole[n].log

32KB 3
ConsoleLogFile

Maintenance information of the server management command#2

In Windows
Cosminexus-installation-directory\CC\admin\logs\CC\maintenance\cjserveradmin[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/CC/maintenance/cjserveradmin[n].log

32KB 3
ServerAdminLogFile

Legend:

--: Not applicable

Note:

Channel name is the name that identifies the log output destination of the log. Use it as a key value when changing log attributes (size, number of files).

#1

In the [n] part of the log file name, add the file number (from 1 to the maximum number of files for each log).

#2

The command name is displayed in the output message (application identification name) of the Hitachi Trace Common Library format. For details on the log in the Trace Common Library format, see 5.2 Application Server log.

#3

For the compatibility mode, the output destination of the operation log and the exception information when an error occurs will differ from the standard mode. For the compatibility mode, the output destination, default size, and the number of files are as follows:

Table 4-24 Output destination of the server management command log (Compatibility mode)

Contents
Log output destination and log file name#
Default size number of files

Operation log

In Windows
Cosminexus-installation-directory\CC\admin\logs\command-namemessage[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/command-name/message[n].log

128KB 2

Exception information when an error occurs

In Windows
Cosminexus-installation-directory\CC\admin\logs\command-nameexception[n].log

In UNIX
/opt/Cosminexus/CC/admin/logs/command-name/exception[n].log

256KB 2

#

In the part of the log file name [n], the file number (number of files from 1 (maximum 16)) is added.

In the messages output to the message log of the server management commands, there are the cases when the message ID field is blank and message ID (such as KDJEnnnnn-Y) is included in the message text field. This is an additional information of the messages output before or after the message is output at the server side.

(c) Batch application log

Table 4-25 Output destination of the Batch application log (Default)

Category
Contents
Log output destination and log file name#1
Default size number of files

Message log
Operation log of the cjexecjob command, the cjkilljob command, and the cjlistjob command

In Windows
<batch.log.directory>#2\cjmessage[n].log

In UNIX
batch.log.directory#2/cjmessage[n].log

1MB 2

#1

In the part of the log file name [n], the file number (number of files from 1 (maximum 16)) is added.

#2

The <batch.log.directory> indicates a directory specified in the batch.log.directory of option definition file (usrconf.cfg file) for batch applications. The default values are as follows:

In Windows

Cosminexus-installation-directory\CC\batch\logs

In UNIX

/opt/Cosminexus/CC/admin/logs

(d) Resource adapter version-up command (cjrarupdate) log

Table 4-26 Output destination of the resource adapter version-up command (cjrarupdate) log

Category
Contents
Log output destination and log file name#
Default size number of files

Message log
Operation log

In Windows
Cosminexus-installation-directory\CC\logs\cjrarupdatemessage[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjrarupdatemessage[n].log

1MB 2

Exception log
Exception information when an error occurs

In Windows
Cosminexus-installation-directory\CC\logs\cjrarupdateexception[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjrarupdateexception[n].log

1MB 2

Maintenance log
Maintenance information

In Windows
Cosminexus-installation-directory\CC\logs\cjrarupdatemaintenance[n] .log

In UNIX
/opt/Cosminexus/CC/logs/cjrarupdatemaintenance[n].log

1MB 2

#

In the part of the log file name [n], the file number (number of files from 1 (maximum 16)) is added.

(e) Migration command (cjenvupdate) log

Table 4-27 Output destination of the migration command (cjenvupdate) log

Category
Contents
Log output destination and log file name#
Default size number of files

Message log
Operation log of the cjenvupdate command

In Windows
Cosminexus-installation-directory\CC\logs\cjenvupdatemessage[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjenvupdatemessage[n].log

4MB 4

Exception log
Exception information of the cjenvupdate command

In Windows
Cosminexus-installation-directory\CC\logs\cjenvupdateexception[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjenvupdateexception[n].log

4MB 4

Maintenance log
Maintenance information of the cjenvupdate command

In Windows
Cosminexus-installation-directory\CC\logs\cjenvupdatemaintenance[n].log

In UNIX
/opt/Cosminexus/CC/logs/cjenvupdatemaintenance[n].log

4MB 4

#

In [n], the file number (number of files from 1 (maximum 16)) is attached.

(f) Resource depletion monitoring log

Table 4-28 Output destination of resource depletion monitoring log

Monitored
Resources
Log acquisition location and log file name#1
Default size number of files
Channel name

Memory

In Windows
<ejb.server.log.directory>#2\watch\cjmemorywatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjmemorywatch[n].log

1MB 2
MemoryWatchLogFile

File descriptors

In UNIX#3
ejb.server.log.directory#2/watch/cjfiledescriptorwatch[n].log

1MB 2
FileDescriptorWatchLogFile

Threads

In Windows
<ejb.server.log.directory>#2\watch\cjthreadwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjthreadwatch[n].log

1MB 2
ThreadWatchLogFile

Thread dump

In Windows
<ejb.server.log.directory>#2\watch\cjthreaddumpwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjthreaddumpwatch[n].log

1MB 2
ThreaddumpWatchLogFile

HTTP requests pending queue

In Windows
<ejb.server.log.directory>#2\watch\cjrequestqueuewatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjrequestqueuewatch[n].log

1MB 2
RequestQueueWatchLogFile

HTTP session numbers

In Windows
<ejb.server.log.directory>#2\watch\cjhttpsessionwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjhttpsessionwatch[n].log

1MB 2
HttpSessionWatchLogFile

Connection pool

In Windows
<ejb.server.log.directory>#2\watch\cjconnectionpoolwatch[n].log

In UNIX
ejb.server.log.directory#2/watch/cjconnectionpoolwatch[n].log

1MB 2
ConnectionPoolWatchLogFile

Note:

Channel name is the name to identify the output destination of the log. Use it as a key value when changing log attributes (size, number of files).

#1

In [n], the file number (number of files from 1 (maximum 16)) is attached.

#2

<ejb.server.log.directory> indicates a directory specified in the ejb.server.log.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. The default value is Cosminexus-installation-directory\CC\server\public\ejb\server-name\logs.

For details about the ejb.server.log.directory parameter, see 3.2 usrconf.cfg (option definition file for batch server) in the uCosminexus Application Server Definition Reference Guide.

#3

The file descriptor cannot be monitored in Windows and AIX.

For details about the information output to the resource depletion monitoring log file and the output format of the log file, see 4.3 Resource depletion monitoring functionality and Output of resource depletion monitoring information in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

(g) User definition file to set output destination of the log

When the batch server and server management command log output destination is changed, reference the user definition file in which the log output destination is set, described in the following table and confirm the output destination. Note that if the output destination of a log is changed, that log is not collected when the snapshot log is collected in a batch. Change the collection destination of the snapshot log as and when required.

Table 4-29 User definition file in which the output destination of log is set

Category
Location specified for user definition file

Batch server
The ejb.server.log.directory parameter specified in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file
The default is Cosminexus-installation-directory\CC\server\public\ejb\server name\logs (in Windows) or /opt/Cosminexus/CC/server/public/ejb/server-name/logs (in UNIX).

Server management commands
ejbserver.log.directory key of the server management command usrconf.bat (in Windows) or usrconf (in UNIX)
The default key is Cosminexus-installation-directory\CC\admin\logs (in Windows) or /opt/Cosminexus/CC/admin/logs (in UNIX).
You cannot change the output destination of the server management command logs when operating from the Management Server Remote Management functionality.

For details about settings of the data acquisition for troubleshooting, such as how to change the output destination of log, see 3. Preparing for Troubleshooting.

(2) Acquiring the log of Administration agent, Management agent, and Management Server

This point describes the output destination of Administration Agent, Management Agent, and the Management Server log.

For the Administration Agent, Management Agent, and the Management Server logs, besides acquiring separately, you can also acquire these logs by compiling as a integrated log.

For details about the output destination when acquiring the Administration Agent, Management Agent, and the Management Server log by compiling as an integrated log or separately, see 4.3.1(2) Acquiring the log of Administration agent, Management agent, and Management Server.

(3) Required information to be acquired other than a log

For details about the required information to be acquired other than a log, see 4.3.1(6)Required information to be acquired other than a log.

4.4.2 Acquiring the Application User Log (systems executing batch applications)

You can acquire the user log of the batch application when the settings are set so that the user log is output in the Hitachi Trace Common Library format. For details on the log in the Trace Common Library format, see 5.2 Application Server log.

For the output destination of a batch application user log, the log is output to a file that has a name containing the prefix specified in the ejbserver.application.userlog.CJLogHandler.handler-name.path parameter within the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file, in the following directory. Note that the handler name is specified in the handler-name to identify the key values.

In Windows
Log-output-destination-root-(-ejb.server.log.directory-)\user\ (default is batch-server-work-directory\ejb\batch-server-name\logs\user)

In UNIX
log-output-destination-root-(-ejb.server.log.directory-value-)/user/(default is batch-server-work-directory/ejb/batch-server-name/logs/user)

For details about settings to output batch application user logs, see 2.3.5 Log output of batch applications in the uCosminexus Application Server Expansion Guide.

4.5 EJB Client Application System Log

This section describes the system log types and output destination of the EJB client application.

Note that for the precautions to be taken when working with the EJB client application system log, see 2.6.1 Precautions Related to the System Log of an EJB Client Application.

Note

When using the uCosminexus Client, read the Cosminexus-installation-directory\CC of the EJB client application log save directory as Cosminexus-installation-directory\CCL.

Organization of this section

4.5.1 Types of EJB Client Application System Logs

4.5.2 Output Destination of the EJB Client Application System Log

4.5.1 Types of EJB Client Application System Logs

In an EJB client application, output the system log for every EJB client application process. The system log types of an EJB client application are as follows:

Table 4-30 Types of EJB client application system logs

Types | Log contents | File name | Default size number of files | Channel name
Message log | Operation log | cjclmessage[n].log#1 | 1MB 2 | ClientMessageLogFile
cjclstartap command operation log | cjclstartap[n].log#2 | 1MB 2 | --
cjcldellog command operation log | cjcldellog.log | 1MB 2#3 | --
User log | User output log | user_out[n].log#1 | 1MB 2 | UserOutLogFile
User error log | user_err[n].log#1 | 1MB 2 | UserErrLogFile
Java log | JavaVM maintenance information, garbage collection log | javalog[n].log#1 | 256KB 4 | --
Exception log | Exception information when an error occurs | cjclexception[n].log#1 | 1MB 2 | ClientExceptionLogFile
Maintenance log#4 | Maintenance information | cjclmaintenance[n].log#1 | 1MB 2 | ClientMaintenanceLogFile
EJB container maintenance information | cjejbcontainer[n].log#1 | 1MB 2 | EJBContainerLogFile
Start process standard output information | cjstdout[n].log#2 | 1MB 2 | --
Start process standard error information | cjstderr[n].log#2 | 1MB 2 | --
Log operation information | cjlogger.log | 1MB 2#3 | --

Legend:

--: Not applicable

#1

In the part of file name [n], the serial number from 1 to total number of specified log files is added.

#2

In the part of file name [n], number (1 or 2) of the number of specified log files is attached.

#3

When the size of cjcldellog.log exceeds 1 MB, it is renamed to backup log file called cjcldellog_save.log.

#4

Collect this log if it needs to be sent to maintenance personnel.

4.5.2 Output Destination of the EJB Client Application System Log

The EJB client application system log is output to the directory specified in the following keys:

Directory specified in the ejb.client.log.directory key and ejb.client.ejb.log key of option definition file (usrconf.cfg) for Java applications

Directory specified in the ejbserver.client.log.directory key and ejbserver.client.ejb.log key in system properties

When different values are specified in both, the Java application option definition file (usrconf.cfg) and system properties, system property settings are valid.

Note that in system properties, you can set the output destination for the following logs only:

Operation log (cjclmessage[n].log)

Exception information when an error occurs (cjclexception[n].log)

Maintenance information (cjclmaintenance[n].log)

Log operation information (cjlogger.log)

The cjcldellog command operation log (cjcldellog.log) and cjclstartap command operation log (cjclstartap[n].log) are output directly under Cosminexus-installation-directory\CC\client\logs (in Windows) or /opt/Cosminexus/CC/client/logs (in UNIX).

Note

Operations cannot be guaranteed if you execute the cjclstartap command in the exclusive sub-directory mode.

The standard output and the standard error contents of an EJB client application are not output to the log file. To output them to the log file, either uses the user log function or redirect.

There are following two modes to output the system log of the EJB client application. Depending on the mode, the configuration of the subdirectory which is considered as output destination will differs. Select these modes as specified in the class path.

Sub directory shared mode
In this mode, multiple process logs are output to one directory (default is ejbcl directory). Note that if you want to have a separate log output destination for each process (each application), specify the respective output destinations in the ejb.client.log.directory key of usrconf.cfg.

Subdirectory exclusive mode
In this mode, multiple process logs are separately output to subdirectory that is created for each process.
This mode is used for the compatibility with the versions prior to the 06-50 version of the Application Server.
For details on the subdirectory exclusive mode, see 5.3 Subdirectory exclusive mode of the EJB client application logs in the uCosminexus Application Server Compatibility Guide.

The following figure shows the output destination of the EJB client application system log in the subdirectory shared mode.

Figure 4-1 Output destination of the EJB client application system log in the subdirectory shared mode (When specified in the option definition file for Java applications)

Figure 4-2 Output destination of the EJB client application system log in the subdirectory shared mode (When specified in system property)

4.6 Trace based performance analysis

The location for storing the trace based performance analysis is as follows:

In Windows
Environment-variable-PRFSPOOL-settings-directory\utt\prf\PRF-identifier

In UNIX
$PRFSPOOL/utt/prf/PRF-identifier

For details about how to collect the trace based performance analysis, see 7. Performance Analysis by Using Trace Based Performance Analysis. The session trace may also be output to the trace based performance analysis.

4.7 JavaVM thread dump

This section describes the method of acquiring the JavaVM thread dump.

You can use the following method to acquire the JavaVM thread dump:

Acquire a thread dump of J2EE server, SFO server, CORBA naming service, and CTM using the management command (mngsvrutil).

Acquire a thread dump of J2EE server, CORBA naming service, and EJB client application using separate commands.

Acquire the class-wise statistical information or Explicit heap detail information in an extended thread dump using the JavaVM commands.

Note

Obtain the thread dump after the output of the previous thread dump ends.

Each method is described below:

Organization of this section

4.7.1 When using the management command

4.7.2 When using separate commands

4.7.3 When using JavaVM commands

4.7.4 Precautions to be taken when class-wise statistical information is output in the thread dump

4.7.1 When using the management command

To acquire a thread dump of JavaVM using the management command (mngsvrutil), specify server in the argument of the sub command dump of the command mngsvrutil and execute the command.

The following thread dump can be acquired:

J2EE server (including cluster)

SFO server

CORBA naming service and CTM

For the mngsvrutil command, see mngsvrutil (management command of Management Server) in the uCosminexus Application Server Command Reference Guide. For the sub commands of the mngsvrutil command, see 7.3 Details of sub commands of the mngsvrutil command in the uCosminexus Application Server Command Reference Guide.

The execution format, an execution example, and output destination for mngsvrutil command are as follows:

Execution format

mngsvrutil -m Management-Server-host-name[:port-number]-u management-user-ID -p management-password -t logical-server-name dump server

Execution example

mngsvrutil -m mnghost -u user01 -p pw1 -t myserver dump server

Output destination

When the target is a J2EE server

In Windows
working-directory#\ejb\server-name\javacore*.txt

In UNIX
working-directory#/ejb/server-name/javacore*.txt

# The working-directory indicates a directory specified in the user definition of a J2EE server (ejb.public.directory in the usrconf.cfg file). The default values are as follows:

In Windows
Cosminexus-installation-directory\CC\server\public

In UNIX
/opt/Cosminexus/CC/server/public

When the target is a SFO server

In Windows
Cosminexus-installation-directory\CC\server\public\ejb\server-name\javacore*.txt

In UNIX
/opt/Cosminexus/CC/server/public/ejb/server-name/javacore*.txt

When the target is a CORBA naming service and CMT

In Windows
Cosminexus-installation-directory\TPB\logj\javacore*.txt

In UNIX
/opt/Cosminexus/TPB/logj/javacore*.txt

4.7.2 When using separate commands

The method to output a thread dump differs depending on the JavaVM start option in which the specified J2EE server is running.

When -XX:+HitachiThreadDump is set, you can acquire the Extended thread dump. This option is set by default.

If -XX:+HitachiThreadDumpToStdout is set, a thread dump is also output to the standard output. This option is not set by default. Set this option if required.

When the following startup options are set, if -XX:+HitachiOutOfMemoryAbortThreadDump is set, a thread dump is output when forced termination is performed using OutOfMemoryError

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiThreadDump

Except in the following cases:

When C heap is insufficient in the J2SE class library

When C heap is insufficient in JavaVM processing

When the following startup options are set, if -XX:+HitachiOutOfMemoryAbortThreadDumpWithJHeapProf is set, a class wise statistical information is output in the thread dump when forced termination is performed using OutOfMemoryError. For details about the class-wise statistical information, see 9.3 Class-wise statistical functionality. The class-wise statistical information, which is output while setting this above-mentioned option, is same as the information acquired when executing the jheapprof command.

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiOutOfMemoryAbortThreadDump

-XX:+HitachiThreadDump

Organization of this subsection

(1) Acquiring J2EE server thread dump

(2) Acquiring the CORBA naming service thread dump

(3) Acquiring a thread dump of EJB client applications

(1) Acquiring J2EE server thread dump

If the J2EE server process (cjstartsv) exists, the J2EE server thread dump is acquired by executing the cjdumpsv command. An example of executing the cjdumpsv command is described below. As the transition status of each thread is to be confirmed over a period of time, execute the cjdumpsv command multiple times. Execute about 10 times every 3 seconds.

In Windows

Cosminexus-installation-directory\CC\server\bin\cjdumpsv J2EE-server-name

In UNIX

/opt/Cosminexus/CC/server/bin/cjdumpsv J2EE-server-name

When you execute the cjdumpsv command, the JavaVM thread dump is output to the following files:

Server standard output log

working-directory\ejb\server-name\javacoreprocess-number.command-execution-date-and-time.txt (in Windows)

working-directory/ejb/server-name/javacoreprocess-number.command-execution-date-and-time.txt (in UNIX)

The default output destination of the server standard output log is ejb.server.log.directory\CC\maintenance\cjstdout.log (in Windows) or ejb.server.log.directory/CC/maintenance/cjstdout.log (in UNIX). For details about changing the output destination, see 4.3 Application Server log (Systems for executing J2EE applications) or see 4.4 Application Server log (Systems for executing batch applications). Note that the default directory path of the working directory is Cosminexus-installation-directory\CC\server\public (in Windows) or /opt/Cosminexus/CC/server/public (in UNIX).

Furthermore, the output destination of the javacore process-number.command-execution-date-and-time.txt file can be changed with the environmental variable JAVACOREDIR. However, when writing to a specified directory fails, javacore process-number.command-execution-date-and-time.txt file is output to the default output destination. When it is not possible to output even to this directory, it is output only to the standard error output.

For details about the cjdumpsv command, see cjdumpsv (acquiring thread dump of a J2EE server) in the uCosminexus Application Server Command Reference Guide.

Reference note

When a thread dump is output, the following message is output to the standard output and the execution of the java program is continued. This message is output irrespective of the -XX:+HitachiThreadDumpToStdout settings.

Writing Java core to full-file-path-name...OK

(2) Acquiring the CORBA naming service thread dump

In Windows, when the CORBA naming service process (nameserv) exists, press the Ctrl+Break key on the command prompt from where the CORBA naming service is started. As the transition status of each thread is to be confirmed over a period of time, execute it multiple times. Execute about 10 times every 3 seconds. Note that you cannot acquire a thread dump if the CORBA naming service is monitored from the Management Server.

In UNIX, if the CORBA naming service process (java) exists, execute the kill command, and acquire a thread dump of the CORBA naming service. Note that you cannot acquire a thread dump if the CORBA naming service is monitored from the Management Server.

To acquire a thread dump of the CORBA naming service in UNIX:

Acquire the process ID of the CORBA naming service.
The method of acquiring the process ID of the CORBA naming service differs depending on the following cases:

When no other java process is started

ps -ef | grep java

When multiple java processes are started

If the shell script for starting the CORBA naming service is used, you can output the process ID of the CORBA naming service in the namesv_pid file generated in the current working directory.

An example of the shell script for starting the CORBA naming service is as follows:

#!/bin/sh
export VBROKER_ADM=/opt/Cosminexus/TPB/adm
export SHLIB_PATH="${SHLIB_PATH}:/opt/Cosminexus/TPB/lib"

# start name server process
exec /opt/Cosminexus/TPB/bin/nameserv \
-J-Dvbroker.agent.enableLocator=false \
-J-Djava.security.policy==/opt/Cosminexus/CC/server/sysconf/cli.policy \
-J-Dvbroker.se.iiop_tp.scm.iiop_tp.listener.port=900 &

# save background java process pid
echo $! > ./namesv_pid

Specify the acquired process ID, and execute the kill command.

kill -3 `cat namesv_pid`

(3) Acquiring a thread dump of EJB client applications

Acquire a thread dump of EJB client applications by executing the cjcldumpap command.

When the cjcldumpap command is executed, a thread dump of the EJB client application started by executing the cjclstartap command is output. Moreover, it is also possible to output a thread dump for a specific process. For details about the cjcldumpap command, see cjcldumpap (acquiring thread dump of Java applications) in the uCosminexus Application Server Command Reference Guide.

The execution format, execution example, and thread dump output destination of the cjcldumpap command are as follows:

Execution format

To output a thread dump of an EJB client application started with the cjclstartap command

cjcldumpap

To output a thread dump for a specific process

cjcldumpap process-ID

Execution example

To output a thread dump of an EJB client application started with the cjclstartap command

cjcldumpap

To output a thread dump for a specific process

cjcldumpap 3264

Output destination

Current directory from where the cjclstartap command is executed

4.7.3 When using JavaVM commands

When using the JavaVM commands, you can acquire the class-wise statistical information or Explicit heap detail information with the extended thread dump.

Organization of this subsection

(1) Acquiring an extended thread dump of class-wise statistical information

(2) Acquiring an extended thread dump of Explicit heap detail information

(1) Acquiring an extended thread dump of class-wise statistical information

Execute the jheapprof command to acquire an extended thread dump of the class-wise statistical information. The class-wise statistical information is output using the class-wise statistic functionality, and this information is used for changing Java objects and checking the Java object reference depending on the garbage collection. For details about the class-wise statistical functionality, see the section 9.3 Class-wise statistical functionality and for details about how to output the class-wise statistical information, see the subsection 9.3.3 Outputting Statistic Information for Each Class. For the jheapprof command, see jheapprof (output of an extended thread dump with Hitachi class-wise statistical information) in the uCosminexus Application Server Command Reference Guide.

(2) Acquiring an extended thread dump of Explicit heap detail information

Among the Explicit heap detail information, if the Explicit Heap Memory Management functionality is valid, acquire the following information in the extended thread dump:

Explicit heap information

Explicit memory block information

Acquire the object statistical information of the Explicit heap detail information and the release rate information of the Explicit memory block with the extended thread dump by executing the eheapprof command. The object statistical information is the detailed information in Explicit memory blocks. The release rate information is the ratio of objects released in the automatic release processing of the Explicit memory block. This information is used for debugging and for error analysis of the system that uses the Explicit Memory Management functionality.

For details about the Explicit Memory Management functionality, see 8. Preventing the occurrence of full garbage collection by using the Explicit Memory Management functionality in the uCosminexus Application Server Expansion Guide. For details about the eheapprof command, see eheapprof (output of an extended thread dump with Explicit heap detailed information) in the uCosminexus Application Server Command Reference Guide.

Execution format

In Windows

eheapprof [-f|-i] [-freeratio] -p process-ID

In UNIX

eheapprof [-f|-i] [-freeratio] [-force] -p process-ID

Execution example

Here, the class-wise statistical information of Java process with process ID 2463 is output.

In the -p option, specify the process ID of Java process to output class-wise statistical information and then execute the eheapprof command.

% eheapprof -p 2463

When the -f option is omitted using the eheapprof command, the following confirmation message is displayed:

In Windows

The confirmation message whether to output an extended thread dump with Hitachi class-wise statistical information is displayed in the following format:

Force VM to output ExplicitHeapProf: ? (y/n)

In UNIX

Confirmation message of process ID is displayed in the following format:

send SIGQUIT to 2463: ? (y/n)

Enter y
If the extended thread dump with Hitachi class-wise statistics is output, the following message is output in the running java program:

Writing Java core to javacore2463.030806215140​.txt... OK

The running java program creates an extended thread dump with Hitachi class-wise statistics (javacore<process ID>.<date-time>.txt) in the current directory to continue the program.

4.7.4 Precautions to be taken when class-wise statistical information is output in the thread dump

If XX:+HitachiOutOfMemoryAbortThreadDumpWithJHeapProf is set up in the JavaVM startup option, a class-wise statistical information is output in the thread dump when forced termination is performed using OutOfMemoryError.

When you use large number of heap (Java heap, Explicit heap, or Perm heap), it takes time to output the class-wise statistical information in the thread dump. Therefore, when OutOfMemoryError occurs, a JavaVM might not be able to be recovered at once if terminated forcibly.

Note

If the following startup options of JavaVM are not set, the class-wise statistical information is not output in the thread dump:

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiOutOfMemoryAbortThreadDump

-XX:+HitachiThreadDump

4.8 JavaVM Garbage Collection Log

The JavaVM garbage collection log can be acquired only when the log output destination is set before starting JavaVM or the J2EE server.

The output destination of the garbage collection log is specified in the ejb.server.log.directory parameter in the <configuration> tag of logical J2EE server (j2ee-server), in the Easy Setup definition file.

Also, when you want to perform a full garbage collection for the running Java processes, execute the javagc command. The javagc command can also be used for measuring the memory used for one transaction, investigating memory leak, and application debugging other than for investigating the cause when a problem occurs.

The execution format of the javagc command when performing a full garbage collection by specifying a running Java process is as follows. Note that for other options that can be specified, see javagc (forced occurrence of garbage collection) in the uCosminexus Application Server Command Reference Guide.

Execution format

javagc -p process-ID

The following log is output as the execution result. Note that in this example, -XX:+HitachiVerboseGCPrintCause has been specified as the option.

[VGC]<Wed Mar 17 00:42:30 2004>(Skip Full:0,Copy:0)[ Full GC 149K->149K(1984K),0.0786038​
secs] [ DefNew::Eden:264K->0K(512K)] [ DefNew::Survivor:0K->63K(64K)] [ Tenured:
85K->149K(1408K)] [ Perm:1300K->1300K(1536K)] [ cause:JavaGC Command]

4.9 Memory Dump

When restarting a J2EE server or CORBA naming service, acquire the following files as memory dump:

User dump (in Windows)

J2EE server memory dump

CORBA naming service memory dump

These files are used by maintenance personnel for analyzing errors if a problem occurs in the system.

Organization of this section

4.9.1 Acquiring a User Dump (In Windows)

4.9.2 Acquiring J2EE Server Memory Dump

4.9.3 Acquiring the CORBA Naming Service Memory Dump

4.9.4 Notes on obtaining the memory dump

4.9.1 Acquiring a User Dump (In Windows)

This subsection describes the collection of user dumps.

Organization of this subsection

(1) In Windows XP

(2) In OSs other than Windows XP

(1) In Windows XP

When process down occurs and the following file exists, the file will be extracted:

Dr.Watson's-crash-dump-output-destination-specified-directory\user.dmp

For Dr.Watson's-crash-dump-output-destination-specified-directory, execute Dr. Watson (drwtsn32) and confirm the crash dump column path.

Note

In the Dr. Watson (drwtsn32) option, make sure that Report using message box (U) is Disabled. Note that the default value is disabled. If the user dump is obtained (the -fd option of the cjstopsv command is used) when the option is Enabled, problems such as improper output of the user dump occur depending on the time at which the displayed confirmation dialog box is closed.

To acquire a user dump when process hang-up and slow down occurs, confirm the process ID and execute the userdump.exe command. userdump.exe is the command provided by Microsoft.

userdump.exe process-ID

When a user dump is acquired using the userdump.exe command, it is output to the current directory from where userdump.exe is executed.

(2) In OSs other than Windows XP

In Windows Server 2008 or Windows Vista

Use the task manager or a Windows debug tool to obtain the user dump. For details, see the Microsoft website.

In Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista

Acquire the following file using the -fd option of the cjstopsv command:

User-dump-output-destination-directory\cjmemdump.dmp

Specify the user-dump-output-destination-directory in the environment variable CJMEMDUMP_PATH.

4.9.2 Acquiring J2EE Server Memory Dump

This section describes how to acquire a J2EE server memory dump for each OS.

Organization of this subsection

(1) In Windows

(2) In UNIX

(1) In Windows

When a J2EE server is running (when the cjstartsv process exists), acquire the cjstartsv process ID from the task manager. Execute the userdump.exe process-ID and extract the memory dump (user.dump).

(2) In UNIX

When the cjstartsv process is down, acquire a core dump output in the working-directory/ejb/server-name.

When restarting the cjstartsv process, the names of the core dump files are renamed in core.output-date-time# (in AIX, HP-UX, and Solaris) or core.process-ID.output-date-and-time# (in Linux). The core dumps are not saved by overwriting when re-starting the cjstartsv process, therefore, you can save the core dumps generated when errors occur.

#

The output date and time is output in the YYMMDDhhmmss format.

YY: Western calendar year (Last 2 digits) MM: Month (2 digits) DD: Day (2 digits)

hh: Hour (2 digits in 24 hour notation) mm: Minute (2 digits) ss: Seconds (2 digits)

Note that you can set the upper limit value for the core dumps to be saved. In Windows, when restarting the cjstartsv process and executing the javacore command, starting from the oldest, the core dump is deleted in the order of output date and time. In UNIX, when the total size of the core dump files output to the working-directory/ejb/server-name exceeds the upper limit value, the core dump files are deleted in the order of output date and time starting from the oldest. The upper limit value is specified in ejb.server.corefilenum of the J2EE server extension parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. Note that the files are deleted during restart of the cjstartsv process. For details about setting the upper limit value for number of core files, see 3.3.18 Settings for Acquiring a Core Dump.

After acquiring a core dump, execute the javatrace command to acquire only the stack trace information from the core dump. The stack trace information is the information required for investigating the cause of abnormal termination of JavaVM. For details about how to acquire the stack trace information, see the section 4.18 JavaVM stack trace information.

You can acquire a core dump in the following cases. How to acquire a core dump for each case is described below:

Acquiring a core dump when the cjstartsv process is running
Acquiring a core dump when the cjstartsv process (J2EE server) is running, confirm the process ID of the cjstartsv process and execute the kill command. Execute the kill command in the following format. Note that the process terminates when the kill command is executed. Hitachi, therefore, recommends that you execute the kill command before restarting.

kill -6 cjstartsv-process-ID

Acquiring a core dump and thread dump concurrently in a running Java process
Execute the javacore command to acquire a core dump and thread dump concurrently in the running Java process. The execution format of the javacore command is described below. Note that for the options that can be specified, see javacore (Obtaining the core file and thread dump/ In UNIX) in the uCosminexus Application Server Command Reference Guide.

javacore process-ID

The following message is output if you execute the command in the above-mentioned format.

send SIGQUIT to 8662: ? (y/n)

If you enter y, javacore process-ID.output-date-and-time.core (core dump) and javacore process-ID.output-date-and-time.txt (thread dump) is output to the current directory from where the Java program is being executed. If you enter n, the command is terminated without acquiring the core dump and thread dump.
When acquiring a core dump and thread dump, the following message is output by the Java program being executed. Note that the information in Italics is not actually displayed.

Now generating core file (javacore8662.030806215140​.core)...
done

(output of core dump and thread dump terminated)

Writing Java core to javacore8662.030806215140​.txt... OK

4.9.3 Acquiring the CORBA Naming Service Memory Dump

How to acquire the CORBA naming service memory dump for each OS is described below.

Organization of this subsection

(1) In Windows

(2) In UNIX

(1) In Windows

When the CORBA naming service is running (when the CORBA naming service process exists), execute the userdump.exe process-ID and extract the memory dump (user.dump). Confirm the CORBA naming service process ID from the task manager in advance.

(2) In UNIX

When the CORBA naming service is running (when the CORBA naming service process exists), confirm the process ID of the CORBA naming service and execute the kill command. Execute the kill command in the following format. Note that the process terminates when the kill command is executed. Hitachi, therefore, recommends that you execute the kill command before restarting.

ps -ef | grep java
kill -6 CORBA-naming-service-process-ID

4.9.4 Notes on obtaining the memory dump

Organization of this subsection

(1) In Windows

(1) In Windows

With Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, and Windows Vista, the user dump is not output in the following cases:

Forceful termination by specifying the -XX:+HitachiOutOfMemoryAbort option

Forceful termination due to an insufficient C heap during JavaVM processing

4.10 JavaVM log (JavaVM log file)

The JavaVM log is a log that you can acquire with the extension option added by Hitachi in the standard JavaVM. You can acquire more troubleshooting information as compared to the information acquired from the standard JavaVM. The JavaVM log is output to the log file, when any of the following options are specified. Note that this log file is called the JavaVM log file.

-XX:+HitachiOutOfMemoryStackTrace
Note that the JavaVM log file is output even if you specify -XX:+HitachiOutOfMemorySize and -XX:+HitachiOutOfMemoryCause that are specified when you specify -XX:+HitachiOutOfMemoryStackTrace option.

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryHandling

-XX:+HitachiJavaClassLibTrace

-XX:+JITCompilerContinuation

Other than this, you need to specify in options even for the output contents and output method. For details about settings to acquire the JavaVM material, see the subsection 3.3.19 Settings for Acquiring the JavaVM Material.

The JavaVM log file is output with the specified file name in the output destination specified with the -XX:HitachiJavaLog:path-and-file-name option. If the file specification is omitted, the Java VM log file is output under the name of javalogxx.log in the directory specified in the ejb.server.log.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. xx is a serial number of 2 digits starting from 01.

Reference note

When you perform the settings to output the JavaVM log file, create a file while starting the JavaVM. Therefore, until the JavaVM is terminated, the JavaVM log file without any information remains, if the JavaVM log is not output.

4.11 JavaVM Output Message Logs (Standard Output or Error Report File)

This section describes how to acquire the message log output by JavaVM.

When the JavaVM crashes, JavaVM outputs the debug information to the standard output and error report file.

The error report file is output in the following cases:

When a signal occurs in the JNI

When C heap is insufficient in the JavaVM

When an unexpected signal occurs in the JavaVM

When an Internal Error (internal logical error) occurs in the JavaVM

However, this file is not created if a signal or memory is insufficient when creating error report files.

Organization of this section

4.11.1 In Windows

4.11.2 In UNIX

4.11.1 In Windows

The output destination of the Error report file and output file name is as follows.

working-directory\ejb\server-name\hs_err_pidserver-process-ID.log

Reference note

When C heap is insufficient, the message and dump are output in the following order. Acquire the necessary information.

A message log indicating insufficient C heap is output to the error report file and standard output.

If the memory is insufficient during the execution of 1., a simple message is output to the standard output.

The Watson log is launched and the dump is output.

4.11.2 In UNIX

The output destination of the Error report file and output file name is as follows.

working-directory/ejb/server-name/hs_err_pid server-process-process-ID.log

Reference note

When C heap is insufficient, a message is output and a core dump is generated in the following order. Acquire the necessary information.

A message log indicating insufficient C heap is output to the error report file and standard output.

If the memory is insufficient during the execution of 1., a simple message is output to the standard output.

If the memory is still insufficient when a simple message is output, output of the message and error log file is interrupted and a core dump is generated.

4.12 OS Status Information and OS Logs

This section describes the OS log information required as troubleshooting information.

Organization of this section

4.12.1 Acquiring the OS Status Information

4.12.2 Acquiring OS Logs

4.12.1 Acquiring the OS Status Information

How to acquire the OS status information required as troubleshooting information, is described below for each OS:

Organization of this subsection

(1) In Windows

(2) In UNIX

(1) In Windows

You can acquire the OS status information by using the cjgetsysinfo command. If you specify the -f option, you can output the OS status information to the OS status output file.

Execute the command in the following format.

cjgetsysinfo -f OS-status-output-file-path

The information acquired with this command and the following commands of OS is same.

netstat -e
netstat -s
netstat -an
set

Note that the required OS status information to be acquired as troubleshooting information when the cjgetsysinfo command is not to be executed is described below. Create a directory for acquiring each information in advance and generate the file in that directory. Create the directory in any path.

Table 4-31 Required OS status information as a troubleshooting information

Information type
Default file name

Network information
Protocol statistical information and current TCP/IP network connection information. Acquire using the following commands in a sequence.

netstat -e > netstat_e.txt
netstat -s > netstat_s.txt
netstat -an > netstat_an.txt

Environment variable
Currently set environment variables. Acquire using the following command.

set >set.txt

(2) In UNIX

You can acquire the OS status information by using the cjgetsysinfo command. If you specify the -f option, you can output the OS status information to the OS status output file.

Execute the command in the following format.

cjgetsysinfo -f OS-status-output-file-path

The information acquired with this command and the commands of OS shown in the following table is the same.

Table 4-32 OS commands executed by executing the cjgetsysinfo command

In AIX
In HP-UX
In Linux
In Solaris

df -k

ps -elf

ps -A -m -o THREAD

vmstat -t 1 1

vmstat -s

lsps -s

netstat -i

netstat -m

netstat -an

iostat

svmon -P

svmon -G

sar -A 1

instfix -i

lslpp -hac

uname -a

env

set

ipcs -a

df -kt

top -s 1 -d 1

ps -efl

vmstat

vmstat -s

netstat -i

netstat -an

iostat

sar -A 1

swapinfo -a

kctune

swlist

swlist -l product

uname -a

env

set

ipcs -a

df

ps -eflm

vmstat

netstat -s

netstat -an

iostat#

top -b -n 1

sysctl -a

sar -A 1 1#

rpm -qa

rpm -qai

uname -a

env

set

ipcs

ipcs -t

ipcs -p

ipcs -c

ipcs -u

ipcs -l

df -k

ps -eflL

vmstat

vmstat -s

netstat -i

netstat -m

netstat -an

iostat

mpstat

swap -l

sar -A 1

sysdef

pkginfo

patchadd -p

uname -a

env

set

#

To execute the sar command and the iostat command, you must install the sysstat package included in the Linux.

Note that the methods (commands) to acquire the required OS status information to be acquired as troubleshooting information when the cjgetsysinfo command is not to be executed, are as follows:

In AIX

df -k > df_k`date +"%y%m%d%H%M%S"`.txt
ps -efl > ps_efl`date +"%y%m%d%H%M%S"`.txt
ps -A -m -o THREAD > ps_AmoTHREAD`date +"%y%m%d%H%M%S"`.txt
vmstat -t 1 5 > vmstat`date +"%y%m%d%H%M%S"`.txt
vmstat -s > vmstat_s`date +"%y%m%d%H%M%S"`.txt
lsps -s > lsps_s`date +"%y%m%d%H%M%S"`.txt
netstat -i > netstat_i`date +"%y%m%d%H%M%S"`.txt
netstat -m > netstat_m`date +"%y%m%d%H%M%S"`.txt
netstat -an > netstat_an`date +"%y%m%d%H%M%S"`.txt
iostat 1 5 > iostat`date +"%y%m%d%H%M%S"`.txt
svmon -P > svmon_P`date +"%y%m%d%H%M%S"`.txt#1
svmon -G -i 1 5 > svmon_G`date +"%y%m%d%H%M%S"`.txt#1
sar -A 1 5 > sar_A`date +"%y%m%d%H%M%S"`.txt#1
/usr/samples/kernel/vmtune > vmtune`date +"%y%m%d%H%M%S"`.txt
instfix -i > instfix_i`date +"%y%m%d%H%M%S"`.txt
lslpp -hac > lslpp_hac`date +"%y%m%d%H%M%S"`.txt
uname -a > uname_a`date +"%y%m%d%H%M%S"`.txt
env > env`date +"%y%m%d%H%M%S"`.txt
set > set`date +"%y%m%d%H%M%S"`.txt
ipcs -a > ipcs_a`date +"%y%m%d%H%M%S"`.txt

In HP-UX

df -kt > df_kt`date +"%y%m%d%H%M%S"`.txt
top -s 1 -d 10 -f top`date +"%y%m%d%H%M%S"`.txt
ps -efl > ps`date +"%y%m%d%H%M%S"`.txt
vmstat 1 5 > vmstat`date +"%y%m%d%H%M%S"`.txt
vmstat -s > vmstat_s`date +"%y%m%d%H%M%S"`.txt
netstat -i > netstat_i`date +"%y%m%d%H%M%S"`.txt
netstat -an > netstat_an`date +"%y%m%d%H%M%S"`.txt
iostat 1 5 > iostat`date +"%y%m%d%H%M%S"`.txt
sar -A 1 5 > sar_A`date +"%y%m%d%H%M%S"`.txt#1
swapinfo -a > swapinfo_a`date +"%y%m%d%H%M%S"`.txt#1
swlist > swlist`date +"%y%m%d%H%M%S"`.txt
swlist -l product > swlist_l_product`date +"%y%m%d%H%M%S"`.txt
uname -a > uname_a`date +"%y%m%d%H%M%S"`.txt
env > env`date +"%y%m%d%H%M%S"`.txt
set > set`date +"%y%m%d%H%M%S"`.txt
ipcs -a > ipcs_a`date +"%y%m%d%H%M%S"`.txt

In Linux

df > df`date +"%y%m%d%H%M%S"`.txt
ps -eflm > ps`date +"%y%m%d%H%M%S"`.txt
vmstat 1 5 > vmstat`date +"%y%m%d%H%M%S"`.txt
netstat -s > netstat_s`date +"%y%m%d%H%M%S"`.txt
netstat -an > netstat_an`date +"%y%m%d%H%M%S"`.txt
iostat 1 5 > iostat`date +"%y%m%d%H%M%S"`.txt#2
top n 5 > top`date +"%y%m%d%H%M%S"`.txt
sar -A 1 5 > sar`date +"%y%m%d%H%M%S"`.txt#2
sysctl -a > sysctl`date +"%y%m%d%H%M%S"`.txt
rpm -qa > rpm_qa`date +"%y%m%d%H%M%S"`.txt
rpm -qai > rpm_qai`date +"%y%m%d%H%M%S"`.txt
uname -a > uname_a`date +"%y%m%d%H%M%S"`.txt
env > env`date +"%y%m%d%H%M%S"`.txt
set > set`date +"%y%m%d%H%M%S"`.txt
ipcs > ipcs`date +"%y%m%d%H%M%S"`.txt
ipcs -t > ipcs_t`date +"%y%m%d%H%M%S"`.txt
ipcs -p > ipcs_p`date +"%y%m%d%H%M%S"`.txt
ipcs -c > ipcs_c`date +"%y%m%d%H%M%S"`.txt
ipcs -u > ipcs_u`date +"%y%m%d%H%M%S"`.txt
ipcs -l > ipcs_l`date +"%y%m%d%H%M%S"`.txt

In Solaris

df -k > df`date +"%y%m%d%H%M%S"`.txt
ps -eflL > ps_eflL`date +"%y%m%d%H%M%S"`.txt
vmstat 1 5 > vmstat`date +"%y%m%d%H%M%S"`.txt
vmstat -s > vmstat_s`date +"%y%m%d%H%M%S"`.txt
netstat -i > netstat_i`date +"%y%m%d%H%M%S"`.txt
netstat -m > netstat_m`date +"%y%m%d%H%M%S"`.txt
netstat -an > netstat_an`date +"%y%m%d%H%M%S"`.txt
iostat 1 5 > iostat`date +"%y%m%d%H%M%S"`.txt
mpstat 1 5 > mpstat`date +"%y%m%d%H%M%S"`.txt
swap -l > swap_l`date +"%y%m%d%H%M%S"`.txt#1
sar -A 1 5 > sar_A`date +"%y%m%d%H%M%S"`.txt
sysdef > sysdef`date +"%y%m%d%H%M%S"`.txt#1
pkginfo > pkginfo`date +"%y%m%d%H%M%S"`.txt
patchadd -p > patchadd_p`date +"%y%m%d%H%M%S"`.txt#1
uname -a > uname_a`date +"%y%m%d%H%M%S"`.txt
env  > env`date +"%y%m%d%H%M%S"`.txt
set  > set`date +"%y%m%d%H%M%S"`.txt

#1

The root permissions are required for executing the command.

#2

To execute the sar command and the iostat command, you must install the sysstat package included in the Linux.

4.12.2 Acquiring OS Logs

How to acquire the OS logs required as troubleshooting information is described below for each OS:

Organization of this subsection

(1) In Windows

(2) In UNIX

(1) In Windows

The following table describes the OS logs required as troubleshooting information.

Table 4-33 OS log information required as troubleshooting information

Information type
Default file name

Event log
Open the event viewer and save the application and system log.

Watson log
Saved in the following directory.
C:\Documents and Settings\All Users\Documents\DrWatson\drwtsn32.log

Note:

C: Name of the drive where the OS is installed.

Confirm the Watson log output destination from the Dr. Watson settings window.

(2) In UNIX

The location to save the OS logs (syslog) required as a troubleshooting information is as follows:

In AIX

All under /var/adm/ras

In HP-UX

All under /var/adm/syslog

In Linux

All under /var/log

In Solaris

dmesg > dmesg`date +"%y%m%d%H%M%S"`.txt

(Store the execution result of the dmesg command in the optional file)

4.13 OS Statistical Information

How to acquire the statistical information of OS is described below for each OS.

Organization of this section

4.13.1 In Windows

4.13.2 In UNIX

4.13.1 In Windows

Save the performance log after the occurrence of errors. For details on the performance operation, see the manuals provided with the OS.

Hint

The OS statistical information can be acquired only when collection of the performance log is started by the OS-dependent performance function in advance.

Extract the following system monitor logs when a J2EE server is running at an interval of 60 seconds. For details about the settings methods, see the manuals provided with the OS.

Table 4-34 System monitor settings

Performance object | Instance | Item name | Description
processor | -- | %Processor Time | CPU utilization (total value excluding the threads in non-idle state).
%Privileged Time | CPU utilization (in kernel mode).
%User Time | CPU utilization (in user mode).
memory | -- | Cache Bytes | Number of bytes used currently by the file system cache.
Cache Faults/sec | Frequency of fetching from different memory location or from the disk per second.
Page Faults/sec | Number of page faults per second.
Transition Faults/sec | Number of faults per second.
process | _Total | Handle Count | Total number of handles currently opened.
Page Faults/sec | Occurrence rate of page faults.
Private Bytes | Used memory (bytes).
Virtual Bytes | Used virtual memory (bytes).
Working Set Bytes | Used actual memory (bytes).
cjstartsv | %Processor Time | CPU utilization (total value excluding the threads in non-idle state).
%Privileged Time | CPU utilization (in kernel mode).
%User Time | CPU utilization (in user mode).
Page Faults/sec | Occurrence rate of page faults.
Thread Count | Thread count.
Private Bytes | Used memory (bytes).
Virtual Bytes | Used virtual memory (bytes).
Working Set Bytes | Used actual memory (bytes).

Legend:

--: Not applicable

4.13.2 In UNIX

Execute the commands shown below while starting the application server and acquire the OS statistical information. Though Hitachi recommends you to acquire the OS statistical information at an interval of 60 seconds, you can decide the interval according to your disk capacity. Note that if you make the acquisition interval longer, the performance deterioration due to acquiring of statistical information of an OS can be reduced, but the accuracy of the OS statistical information might deteriorate.

In AIX

ps -efl
ps -A -m -o THREAD
vmstat -t
vmstat -s
lsps -s
svmon -P <Process ID of cjstartsv, cjstartweb>#1
svmon -G#1
sar -A 1#1

In HP-UX

ps -efl
top -d 1 -f {file-name}
vmstat -t
vmstat -s
swapinfo -a#1
sar -A 1#1

In Linux

ps -eflm
top n 1
vmstat
sar -A 1#2

In Solaris

ps -eflL
swap -l#1
vmstat
sar -A 1

#1

The root permissions are required for executing the command.

#2

To execute the sar command, you must install the sysstat package included in the Linux.

4.14 Application Server definition information

Acquire the Application Server definition. Use this information to confirm the set definitions when an error occurs.

Definition information related to Cosminexus Component Container

Acquire the set of files that have been saved under the following directory.

In Windows

Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name

In UNIX

/opt/Cosminexus/CC/server/usrconf/ejb/server-name

We recommend you to delete the information such as password that cannot be made public, from the files saved for troubleshooting.

4.15 Contents of J2EE server or batch server working directory

When a problem occurs in a system, maintenance personnel may examine the working directory for investigating the cause. A working directory is specified in the ejb.public.directory parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. Note that the default directory path of the working directory is Cosminexus-installation-directory\CC\server\public (in Windows) or /opt/Cosminexus/CC/server/public (in UNIX).

Confirm the settings, and when trouble occurs, save the files in this directory.

4.16 Application Server Resource Setting Information

Acquire the resource settings information to confirm the resource settings such as connection pool settings. The location to save the settings information is as follows:

In Windows

working-directory\ejb\server-name\import

working-directory\ejb\server-name\rars

In UNIX

working-directory/ejb/server-name/import

working-directory/ejb/server-name/rars

4.17 Web Server Logs

Acquire Web server (Cosminexus HTTP Server or Microsoft IIS) logs that are used in the system.

In the case of Cosminexus HTTP Server
The location to save the log is as follows:

In Windows
Cosminexus-installation-directory\httpsd\logs

In UNIX
/opt/hitachi/httpsd/logs (default)

Microsoft IIS
The location to save the log is as follows:
C:\inetpub\logs (Specify the system drive in place of C:)

4.18 JavaVM stack trace information

In UNIX, when JavaVM terminates abnormally and a core dump is output, the information (stack trace information) required for investigating the cause for such abnormal termination can be acquired by the javatrace command. With the javatrace command, acquire the stack trace information from the core dump output. The javatrace command is installed in /opt/Cosminexus/jdk/jre/bin.

The execution format of the javatrace command is as follows:

javatrace core dump file name, Execution file name where core dump is created

When JavaVM terminates abnormally and you execute this command when a core dump is created with a file name called core, as a result, a file called javatrace.log is output under the current directory. Send this file to maintenance personnel.

Execution example

The example below describes a message that is output when JavaVM terminates abnormally and a core dump is created.

...
# You can get further information from javatrace.log file generated
# by using javatrace command.
# usage: javatrace core-file-name loadmodule-name [out-file-name] [-l(library-name)...]
# Please use javatrace command as follows and submit a bug report
# to Hitachi with javatrace.log file:
# [/opt/Cosminexus/jdk/jre/bin/javatrace core /opt/Cosminexus/CC/server/bin/cjstartsv]
#

Execute the character string of the javatrace command displayed in the message. In the case of this example, execute /opt/Cosminexus/jdk/jre/bin/javatrace core /opt/Cosminexus/CC/server/bin/cjstartsv. As a result of execution, a file called javatrace.log is output under the current directory.

Note that the file name of the core dump actually output depends on the OS and it may be core.process ID in some cases. In such cases, specify the file name of the core dump actually output in the javatrace argument.

4.19 Event log of the Explicit Heap Memory Management functionality

An event log output by an Explicit Heap Memory Management functionality is output to the file specified in the -XX:HitachiExplicitMemoryJavaLog option in the JavaVM startup option. Moreover, the output contents differ depending on the log output level specified in the -XX:HitachiExplicitMemoryLogLevel option.

For details about setting the above-mentioned options, see 3.3.19(3) Settings for acquiring the event log of Explicit Heap Memory Management functionality.

For details about the JavaVM startup option, see 16. JavaVM Startup Options in the uCosminexus Application Server Definition Reference Guide.

4.20 Information on the execution of the Component Container Administrator setup command (In UNIX)

When Component Container Administrator is specified, the information on the execution of the Component Container Administrator setup (cjenvsetup command) is output to a message log and a text file. If the previous execution information exists, a maximum of five files are stored including the latest execution information stored until the fourth generation for each type.

Also, in the case of an overwrite installation, if Component Container Administrator was set up before the overwrite installation, the Component Container Administrator setup (cjenvsetup command) is automatically executed during installation.

The following table describes the output destination of the execution information.

Table 4-35 Output destination of the information on the execution of the Component Container Administrator setup (cjenvsetup command)

Classification | Contents | Log output destination and log file name
Message log | Operation log of the cjenvsetup command | /opt/Cosminexus/CC/logs/cjenvsetupmessage[n]#.log
Text file | File (directory) information before change | /opt/Cosminexus/CC/logs/before_cjenvsetup_files[n]#.txt
Text file | File (directory) information after change | /opt/Cosminexus/CC/logs/after_cjenvsetup_files[n]#.txt

#:

In [n], specify the generation number (from 1 to 4). The generation number is not added to the latest execution information. A maximum of five log files are stored.

For details on the output contents, see 4.1.4 Notes on setting Component Container administrator (For UNIX) in the uCosminexus Application Server System Setup and Operation Guide.

5. Problem Analysis

This chapter describes the log and trace information used for troubleshooting.

Organization of this chapter

5.1 Organization of this chapter

5.2 Application Server Log

5.3 EJB Client Application Log

5.4 Trace based performance analysis

5.5 JavaVM Thread Dump

5.6 JavaVM Garbage Collection Log

5.7 JavaVM log (JavaVM log file)

5.8 Message log output by JavaVM (Standard output and error report file)

5.9 OS status information and OS log

5.10 JavaVM stack trace information

5.11 Event log of Explicit Memory Management functionality

5.1 Organization of this chapter

This section describes the output contents of the data for troubleshooting, from among the description related to the troubleshooting.

Determine the cause for a trouble on the basis of contents output to the acquired data. Note that among the data acquired in 2.3 Acquiring the Data, for the OS statistical information, see the manuals provided with the OS being used. Moreover, the memory dump is not explained here as it is checked by maintenance personnel.

Note

In Windows, if you open a large log file (3 megabytes or more) with a text editor, the computer is burdened and this might affect the system. When you want to reference a log file, take proper precautions.

Note the following points if you are using Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista.
When there is a Unicode supplementary character in the contents output to a log or a PRF trace that supplementary character cannot be output correctly. Other than this, there will not be any problem in other output contents or the application operations. The Unicode supplementary character is sometimes included in the requests from the clients, such as Internet Explorer.

The following table describes the organization of this chapter.

Table 5-1 Organization of this chapter (Data Output Contents used for troubleshooting)

Category | Title | Reference
Explanation | Application Server Log | 5.2
Contents of the EJB Client Application Log | 5.3
Contents of the Trace based performance analysis | 5.4
Contents of the JavaVM Thread Dump | 5.5
Contents of the JavaVM Garbage Collection Log | 5.6
Contents of the JavaVM log (JavaVM log file) | 5.7
Contents of the Message Log Output by JavaVM (Standard Output and Error Report File) | 5.8
OS Status Information and Contents of the OS Log | 5.9
Contents of the JavaVM Stack Trace Information | 5.10
Contents of event log of Explicit Heap Memory Management functionality | 5.11

For an overview of troubleshooting, output destinations and output methods of data, and settings related to the data acquisition and output, see the respective sections:

Overview of troubleshooting and methods for automatic output of data
2. Troubleshooting

Settings related to data acquisition and output
3. Preparing for Troubleshooting

Default output destination of data and methods to output data separately
4. Output Destinations and Output Methods of Data Required for Troubleshooting

5.2 Application Server Log

This section describes how to investigate Application Server log.

By investigating message logs and user logs of Application Server, you can investigate the cause of error occurrence. Moreover, even in the case of process errors, you can confirm the progress status of the process and error indications.

Furthermore, among Application Server logs, for the precautions when referencing a system log of the EJB client applications, see 2.6.1 Precautions Related to the System Log of an EJB Client Application.

The Application Server log includes the following three types of logs:

Trace common library format (single process)

Trace common library format (multi-process)

Specific format

The trace common library format is the log that is output by using the trace common library. For details on the trace common library format, see 9.2.2 User log output mechanism in the uCosminexus Application Server Expansion Guide.

The specific format is the log that is output in a format other than the trace common library format.

This section classifies and describes the Application Server log for each log type. The following Application Server log is described here:

Hitachi Trace Common Library format log

Access log of In-process HTTP Server

Event log

syslog

Log output to audit log

Log output to Cosminexus JPA Provider

Log output by Cosminexus JMS Provider

Furthermore, the following are the three types of Application Server logs:

Hitachi Trace Common Library format (Single process)

Hitachi Trace Common Library format (multi processes)

Proprietary format

Note that the time-based switching of output destinations and file naming in Shift mode might be enabled in the Hitachi Trace Common Library format log. For details, see 3.2.1 Specifiable contents.

The following table describes the logs that are output, the corresponding log types, and whether time-specified switching and shift mode are supported, for each acquired log.

Table 5-2 J2EE server and redirector log type

Category
Contents
Type
Support for time-specified switching and Shift mode

Message log
Operation log
Hitachi Trace Common Library format (single process)
Y

Log operation log
Proprietary format
--

Redirector message log

For using Cosminexus HTTP Server in Windows
Hitachi Trace Common Library format (single process)

For using Microsoft IIS in Windows or for using UNIX
Hitachi Trace Common Library format (multi processes)

--

Operation log of resource adapter that is deployed and used as J2EE resource adapter
Hitachi Trace Common Library format (single process)
Y

Operation log of resource adapter used by including in J2EE application
Hitachi Trace Common Library format (single process)
Y

Web servlet log
Hitachi Trace Common Library format (single process)
Y

User log
User output log
Hitachi Trace Common Library format (single process)
Y

User error log
Hitachi Trace Common Library format (single process)
Y

JavaVM maintenance information and garbage collection log
Proprietary format
--

Event log of the Explicit Heap Memory Management functionality
Proprietary format
--

Exception log
Exception information when an error occurs
Hitachi Trace Common Library format (single process)
Y

Maintenance log
Maintenance information
Hitachi Trace Common Library format (single process)
Y

Console message
Hitachi Trace Common Library format (single process)
Y

EJB container maintenance information
Hitachi Trace Common Library format (single process)
Y

Web container maintenance information
Hitachi Trace Common Library format (single process)
Y

Start process standard output information
Proprietary format
--

Start process standard error information
Proprietary format
--

Termination process information
Hitachi Trace Common Library format (single process)
--

Redirector maintenance trace log

For using Cosminexus HTTP Server in Windows
Hitachi Trace Common Library format (single process)

For using Microsoft IIS in Windows or for using UNIX
Hitachi Trace Common Library format (multi processes)

--

Event log
Log showing J2EE server start, stop or abnormal termination
Hitachi Trace Common Library format (single process)
--

syslog
Log showing J2EE server start, stop or abnormal termination
Hitachi Trace Common Library format (single process)
--

Legend:

Y: Supported

--: Not supported or not applicable

Table 5-3 Server management command log

Category | Contents | Type | Support for time-specified switching and Shift mode
Message log | Operation log | Hitachi Trace Common Library format (multi processes) | --
Log operation log | Proprietary format | --
Exception log | Exception information when an error occurs | Hitachi Trace Common Library format (multi processes) | --
Maintenance log | Maintenance information | Hitachi Trace Common Library format (multi processes) | --
Console message | Hitachi Trace Common Library format (multi processes) | --
Server management command maintenance information | Hitachi Trace Common Library format (multi processes) | --

Legend:

--: Not supported or not applicable

Table 5-4 Resource adapter version-up command (cjrarupdate) log

Category | Contents | Type | Support for time-specified switching and Shift mode
Message log | Operation log | Hitachi Trace Common Library format (multi processes) | --
Exception log | Exception information when an error occurs | Hitachi Trace Common Library format (multi processes) | --
Maintenance log | Maintenance information | Hitachi Trace Common Library format (multi processes) | --

Legend:

--: Not supported or not applicable

Table 5-5 Log of In-process HTTP Server

Category | Contents | Type
Access log | Process results of In-process HTTP Server | Proprietary format
Thread trace | Information of thread trace | Proprietary format
Communication trace | Information of communication trace | Proprietary format

Table 5-6 Migration command (cjenvupdate) log

Category | Contents | Type | Support for time-specified switching and Shift mode
Message log | Operation log of the cjenvupdate command | Hitachi Trace Common Library format (multi processes) | --
Exception log | Exception information of the cjenvupdate command | Hitachi Trace Common Library format (multi processes) | --
Maintenance log | Maintenance information of the cjenvupdate command | Hitachi Trace Common Library format (multi processes) | --

Legend:

--: Not supported or not applicable

Table 5-7 Resource depletion monitoring log

Monitored Resources | Type | Support for time-specified switching and Shift mode
Memory | Hitachi Trace Common Library format (single process) | Y
File descriptors | Hitachi Trace Common Library format (single process) | Y
Threads | Hitachi Trace Common Library format (single process) | Y
Thread dump | Hitachi Trace Common Library format (single process) | Y
HTTP requests pending queue | Hitachi Trace Common Library format (single process) | Y
HTTP session numbers | Hitachi Trace Common Library format (single process) | Y
Connection pool | Hitachi Trace Common Library format (single process) | Y

Legend:

Y: Supported

Table 5-8 Administration agent, Management agent, and Management Server log

Category
Contents
Type
Support for time-specified switching and Shift mode

Integrated log
Integrated message log
Hitachi Trace Common Library format (multi processes)
Y

Integrated trace log
Hitachi Trace Common Library format (multi processes)
Y

Command maintenance log
Hitachi Trace Common Library format (multi processes)
--

Administration agent
Standard error output of Administration agent
Hitachi Trace Common Library format (single process)
--

Standard output of Administration agent
Hitachi Trace Common Library format (single process)
--

Standard command line error output of Administration agent
Proprietary format
--

Administration agent log
Hitachi Trace Common Library format (single process)
--

Administration agent start, stop command log
Hitachi Trace Common Library format (single process)
--

Administration agent maintenance log
Hitachi Trace Common Library format (single process)
--

Console log
Hitachi Trace Common Library format (single process)
Y

Administration agent service log
Hitachi Trace Common Library format (single process)
--

Administration agent service standard output
Proprietary format
--

Administration agent service standard error output
Proprietary format
--

Management agent
Management agent log and trace
J2EE server system JP1 event and J2EE server user JP1 event log
Management event issue log
Hitachi Trace Common Library format (single process)
--

Management Server
Management Server service log
Hitachi Trace Common Library format (single process)
--

Management Server service standard error output
Proprietary format
--

Management Server service standard output
Proprietary format
--

Management Server service start stop command
Hitachi Trace Common Library format (single process)
--

Management Server log
System JP1 event log of Management Server#
Hitachi Trace Common Library format (single process)
--

Execution log of the mngenvsetup command
Hitachi Trace Common Library format (single process)
--

Management Server maintenance log
Hitachi Trace Common Library format (single process)
--

Legend:

Y: Supported

--: Not supported or not applicable

#

Management Server of Application Server.

Table 5-9 Internal setup tool of the virtual server manager and Server Communication Agent logs

Category | Contents | Type | Support for time-specified switching and Shift mode
Internal setup tool of the virtual server manager | Logs for the internal setup tool of the virtual server manager | Trace common library format (single process) | Y
Maintenance logs for the internal setup tool of the virtual server manager | Trace common library format (single process) | --
Server Communication Agent | Server Communication Agent logs | Trace common library format (single process) | Y
Service logs of the Server Communication Agent | Trace common library format (single process) | --
Start and stop command logs of the Server Communication Agent | Trace common library format (single process) | --
Standard error output of the Server Communication Agent | Trace common library format (single process) | --
Standard output of the Server Communication Agent | Trace common library format (single process) | --
Console logs | Trace common library format (single process) | Y
Maintenance logs of the Server Communication Agent | Trace common library format (single process) | --
Maintenance logs for the Server Communication Agent services | Trace common library format (single process) | --
Maintenance logs for the start and stop commands of the Server Communication Agent | Trace common library format (single process) | --
JavaVM log file of the Server Communication Agent | Trace common library format (single process) | --

Legend:

Y: Supported

--: Not supported or not applicable

Table 5-10 Cosminexus Performance Tracer log

Contents | Type
PRF daemon and PRF command log | Proprietary format
Module trace | Proprietary format
Structured exception occurrence log | Proprietary format
Maintenance information | Proprietary format

Table 5-11 Cosminexus Component Transaction Monitor log

Contents | Type
CTM daemon or CTM command log | Proprietary format
Maintenance information | Proprietary format

Table 5-12 Log output to audit log

Category | Contents | Type | Support for time-specified switching and Shift mode
Message log | Message log of audit log | Hitachi Trace Common Library format (multi processes) | --
Exception log | Exception information of audit log | Hitachi Trace Common Library format (multi processes) | --

Legend:

--: Not supported or not applicable

Table 5-13 Log output to Cosminexus JPA Provider

Contents | Type | Support for time-specified switching and Shift mode
Operation log | Hitachi Trace Common Library format (single process) | Y
Maintenance log | Hitachi Trace Common Library format (single process) | Y

Legend:

Y: Supported

For details on the operation log output to Cosminexus JPA provider, see Appendix C.1 Cosminexus JPA Provider operation log.

Table 5-14 Log output by Cosminexus JMS Provider

Category | Contents | Type | Support for time-specified switching and Shift mode
Message log | CJMSP Broker message log | Hitachi Trace Common Library format (single process) | --
Management command (cjmsicmd command) message log | Hitachi Trace Common Library format (multi processes) | --
CJMSP resource adapter message log | Hitachi Trace Common Library format (single process) | Y
Exception log | CJMSP Broker exception log | Hitachi Trace Common Library format (single process) | --
Management command (cjmsicmd command) exception log | Hitachi Trace Common Library format (multi processes) | --
CJMSP resource adapter exception log | Hitachi Trace Common Library format (single process) | Y

Legend:

Y: Supported

--: Not supported or not applicable

Organization of this section

5.2.1 Output Format and Output Items of the Hitachi Trace Common Library Format Log

5.2.2 Precautions to Be Taken When Referencing the Hitachi Trace Common Library Format Log

5.2.3 Output format and output items of access log of In-process HTTP Server

5.2.4 Output Format and Output Items of the Event Log (In Windows)

5.2.5 Output Format and Output Items of syslog (In UNIX)

5.2.1 Output Format and Output Items of the Hitachi Trace Common Library Format Log

The output format and output items of the Hitachi Trace Common Library format log are described below.

Application Server log is output in the Hitachi Trace Common Library format

Organization of this subsection

(1) Output format

(2) Output items

(1) Output format

The output format of Hitachi Trace Common Library format log is as follows:

Number Date Time AP name pid tid message ID Type Message text CRLF

(2) Output items

The output items of the Hitachi Trace Common Library format log are as follows:

Table 5-15 Output items of the Hitachi Trace Common Library format log

Item name | Description
No. | A 4 digit number showing the trace record serial number is output.
Date | Date of acquiring the trace is output in the yyyy/mm/dd format.
Time | Time of acquiring the trace is output in the hh:mm:ss.sss format.
AP name | String showing the program is output.
Pid | Process ID is output.
Tid | Thread ID is output.
Message ID | Message ID is output in the XXXXnnnnn-Y format.
Type | Event type that triggers the trace output is output.
Message text | Message text is output. Additional information may also be output.
CRLF | Terminal code of the record (0x0D, 0x0A) is output.

Editing and displaying log files

When the sort or filter function is used by displaying the Hitachi Trace Common Library format log in Microsoft Excel, you can effectively investigate the cause of the error that occurred.

The example of displaying the Hitachi Trace Common Library format log by using Microsoft Excel is as follows:

Figure 5-1 Display example of log of Hitachi Trace Common Library format using Microsoft Excel

Reference note

As a delimiting data format, select fixed length field data that is right or left justified by using spaces.

Delete the unnecessary arrows in the Data Preview box.

Specify Character string in Display format of each column.

5.2.2 Precautions to Be Taken When Referencing the Hitachi Trace Common Library Format Log

This section describes the precautions to be taken when using the Hitachi Trace Common Library format log.

Organization of this subsection

(1) Common precautions for multi and single processes

(2) Precautions when referencing multi processes Hitachi Trace Common Library

(3) Changes in the multi-process trace common library from the earlier versions

(1) Common precautions for multi and single processes

The common precautions for multi and single processes are as follows:

Do not edit the log file that has been output.

Do not lock files by using a function such as the text editor.

When setting the access rights for the output log file manually, assign the appropriate access rights.

Do not change the update time of the log file that has been output.

During trace output, do not delete log files or change file names. Delete the log files or change file names after stopping all the trace output processes.

(2) Precautions when referencing multi processes Hitachi Trace Common Library

The precautions to be taken when referencing multi processes compliant Hitachi Trace Common Library format log file are as follows:

The line feed code at the end of the message is CRLF, regardless of the OS being used.

In some cases you may need to delete the log files to enable changes in the log file size, number of files and mode options. Before deleting the log files, stop all the processes that output trace.

Even if trace is output, there are cases when the update time of the log file is not updated. Therefore, you cannot judge whether the trace is output based on the updated time of the file.

(3) Changes in the multi-process trace common library from the earlier versions

The log files of the multi-process trace common library have been changed from the earlier versions. The following table describes the changes.

Table 5-16 Differences with the earlier versions of the multi-process trace common library

Item
Application Server V9
Application Server V8 or earlier

File size
Variable (specified size might be exceeded)
Fixed (specified size)

File switching time
The files are switched at the following times:

When the file size exceeds the specified size

For time specified rotation

When the specified time is reached while the process is runing

When the file size + the size you want to output exceeds the specified size

Size when the files are switched
0 (All lines will be deleted)
Fixed (overwrite and store)

File switching operation (Wraparound method)
The trace data is overwritten and output from the beginning of the file (the information before wraparound remains as is)
The trace data is overwritten and output from the beginning of the file (the information before wraparound remains as it is)

File switching operation (Shift method)
All the lines are deleted and the trace data is output from the beginning of the file
--

Log file name numbering rules (Wraparound method)
xxxxxx1.log,
xxxxxx2.log,
xxxxxx3.log,
...
xxxxxx1.log,
xxxxxx2.log,
xxxxxx3.log,
...

Log file name numbering rules (Shift method)
xxxxxx.log,
xxxxxx1.log,
xxxxxx2.log,
...
--

End identifier
No (end of file)
Yes#

Management file
Created
Created

Determining the output file used when the process restarts
Time stamp
Management file, or time stamp

Legend:

--: Not applicable.

#

The end identifier used in the multi-process trace common library of the earlier versions is as follows:

EOF CRLF CRLF CRLF CRLF----------< End of Data >----------CRLF CRLF

EOF is the character (0x1A) that indicates the end of the trace data. CRLF indicates the linefeed (0x0D, 0x0A).

Table 5-17 List of change files for the multi-process trace common library format

Classification of log | Log type | Log file and default file output destination
Common log | Audit log | Product-installation-directory/auditlog/audit?.log
Product-installation-directory/auditlog/rasexception?.log
Product-installation-directory/auditlog/rasmessage?.log
Functionality-specific public log | Performance, error analysis trace | Product-work-directory/ejb/J2EE-server-name/logs/RM/maintenance/mtd_RM-display-name_??.log
Product-work-directory/ejb/J2EE-server-name/logs/RM/maintenance/shq_RM-display-name_??.log
Product-work-directory/ejb/J2EE-server-name/logs/RM/maintenance/lin_RM-display-name_??.log
Product-installation-directory/CC/server/public/ejb/J2EE-server-namecsmxsec_trace?.log
Message log | Product-work-directory/ejb/J2EE-server-name/logs/CJW/cjwmessage?.log
Product-work-directory/ejb/J2EE-server-name/logs/CJR/cjrmessage?.log
Product-work-directory/ejb/J2EE-server-name/logs/WS/ <log_file_prefix>-j2ee-J2EE-server-name-<log_file_num>.log
Product-work-directory/ejb/J2EE-server-name/logs/WS/ c4webcl-default-?.log
Manager log | Integrated message log | Product-installation-directory/manager/log/message/mngmessage?.log
Integrated trace log | Product-installation-directory/manager/log/trace/mngtrace?.log
Console log | Product-installation-directory/manager/log/processConsole?.log
Internal setup tool log of the virtual functionality | Product-installation-directory/manager/setup/log/rasetup?.log
Server communication agent log | Product-installation-directory/sinagent/log/sinaviagent?.log
Server communication agent console log | Product-installation-directory/sinagent/log /processConsole?.log

5.2.3 Output format and output items of access log of In-process HTTP Server

This subsection describes the output format and the output items of access log of the In-process HTTP Server.

Output the process results for requests of the In-process HTTP Server in access log. The output format of access log includes the default format output by default and the extended format. For details on the customization of access log of the In-process HTTP Server, see 5.17.2 Customizing the access log of the In-process HTTP Server in the uCosminexus Application Server Web Container Functionality Guide.

The output format is as follows:

Default format

Host-name-of-client-Authentication-user-name Access-time Request-line Status-code Sent-bytes

Extended format

Host-name-of-client-Authentication-user-name Access-time Request-line Status-code Sent-bytes Contents-of-Referrer-header Contents-of-User-Agent-header

The following table lists the contents of each item.

Table 5-18 Output items of access log

Item No. | Item name | Description
1 | Host name of client | Host name of client is displayed. IP address is displayed when host name is not set.
2 | Authentication user name | Basic user authentication name and form authentication user name is displayed. Hyphen (-) is displayed when form user authentication name and form user authentication name is not set.
3 | Access time | The In-process HTTP Server displays the time at which the processing of requests from the Web client started.
4 | Request line | Request line is displayed.
5 | Status code | Last status code is displayed. However, the internally redirected value is not output.
6 | Sent bytes | Sent bytes excluding HTTP header are displayed. Hyphen (-) is displayed for 0 byte.
7 | Contents of Referrer header | URL of Web page before transition is displayed.
8 | Contents of User-Agent header | Header that includes information of Web client (Version of browser name or browser) is displayed.

You can voluntarily add items, such as IP address of client, IP address of J2EE server, request method and the time required for processing request from client in the access log.

The example of the access log is as follows:

In default format

10.20.30.40 - user1 [18/Jan/2005:13:06:10 +0900] "GET / HTTP/1.0" 200 38
10.20.30.40 - user1 [18/Jan/2005:13:06:25 +0900] "GET /demo/ HTTP/1.0" 500 684

In extended format

10.20.30.40 - user1 [18/Jan/2005:13:06:10 +0900] "GET / HTTP/1.0" 200 38 "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)"
10.20.30.40 - user1 [18/Jan/2005:13:06:25 +0900] "GET /demo/ HTTP/1.0" 500 684 "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)"

5.2.4 Output Format and Output Items of the Event Log (In Windows)

The output format and output items of the event log are described below.

An Event log is output when starting, stopping, and abnormally terminating the J2EE server. The output format is as follows:

ID character string pid: Message text

The output items are as follows:

Table 5-19 Output items of event log

Item name | Description
ID character string | HEJB is output as the character string showing the application.
Pid | Process ID is output.
Message text | Message text is output.

5.2.5 Output Format and Output Items of syslog (In UNIX)

The output format and output items of syslog are described below.

syslog is output when starting, stopping, and abnormally terminating the J2EE server. The output format is as follows:

Date Time Host name ID character string pid: Message text

The output items are as follows:

Table 5-20 Output items of syslog

Item name | Description
Date | Date when the message is output.
Time | Time when the message is output.
Host name | Character string that shows host name is output.
Pid | Process ID is output.
ID character string | HEJB is output as the character string showing the application.
Message text | Message text is output.

Note

Notes on the output format of the syslog messages

If you output the control characters such as linefeed and tabs (ASCII code 0-31, 127) to syslog with Red Hat Enterprise Linux Server 6, the results will differ from the output results of Red Hat Enterprise Linux 5 with the default settings. With Red Hat Enterprise Linux Server 6, convert the control characters to #number (number expresses the character code with a 3-digit octal numeral) to output the characters.

The procedure for changing the output to the one similar to Red Hat Enterprise Linux 5 is as follows:

Update rsyslog to version rsyslog-4.6.2-3.el6_1.4 or later.

Set the following options in /etc/rsyslog.conf:
$EscapeControlCharactersOnReceive off
$ActionFileDefaultTemplate RSYSLOG_SysklogdFileFormat
$SpaceLFOnReceive on
$DropTrailingLFOnReception off

Execute service rsyslog restart to restart rsyslog.

5.3 EJB Client Application Log

The EJB client application log types are described below. For details on log types, log output format and output items for each log, and precautions while referencing logs, see the section 5.2 Application Server Log.

The log types of an EJB client application are as follows:

Table 5-21 Types of log of EJB client application

Types | Contents | Type
Message log | Operation log | Hitachi Trace Common Library format (multi processes)
cjclstartap command operation log | Hitachi Trace Common Library format (multi processes)
cjcldellog command operation log | Hitachi Trace Common Library format (multi processes)
User log | User output log | Hitachi Trace Common Library format (multi processes)
User error log | Hitachi Trace Common Library format (multi processes)
Java log | JavaVM maintenance information, garbage collection log | Proprietary format
Exception log | Exception information when an error occurs | Hitachi Trace Common Library format (multi processes)

Note that the EJB client application logs only support the wraparound mode of switching the output destinations for file sizes.

5.4 Trace based performance analysis

By investigating the trace based performance analysis, you can analyze the processes that are moving further or the processes that are in a bottleneck for each request. Moreover, when you investigate a session trace, the life cycle of that session can be confirmed.

With these traces as a base, you can locate the places where problem has occurred and take appropriate measures for the places with a bottleneck. Check as per the requirement.

For details on the output contents of the trace based performance analysis, see 7. Performance Analysis by Using Trace Based Performance Analysis.

5.5 JavaVM Thread Dump

When you investigate the JavaVM thread dump, it is easy to investigate the cause of the error at the Java program level such as system dead locks.

The type of output information differs depending on the options specified when starting the J2EE server. For details on settings for acquiring the JavaVM material, see the subsection 3.3.19 Settings for Acquiring the JavaVM Material.

Organization of this section

(1) Structure of thread dump information

(2) Mapping between thread dump and trace based performance analysis file

(3) Output contents of Explicit heap details information

(1) Structure of thread dump information

The structure of JavaVM thread dump information is as follows:

Table 5-22 Structure of the thread dump information

Output information
Contents

Header
Date, JavaVM version information, start command line is output.

System settings
Following information is output:

Java home path indicating the installation location of the JDK execution environment

Java DLL path indicating the installation directory of the library configuring JDK

System class path

Java command options

Operation environment
Following information is output:

Host name

OS version

CPU information

Resource information (in UNIX)

Memory information (in Windows)
Current memory usage size and various unused size information is output.

Java heap information
Memory usage status of each generation of Java heap is output.

JavaVM internal memory map information
Memory area information securing the JavaVM its self is output.

JavaVM internal memory size information
Memory size information securing the JavaVM its self is output.

Application environment
Following information is output:

Signal handler

Environment variable

Library information
Loaded library information is output.

Thread information
<Thread 1>
...
<Thread n>
Thread information for each thread is output.

Java monitor dump#
List of Java monitor objects is displayed.

JNI global reference information#2
Output the number of global references to JNI maintained by JavaVM.

Explicit heap detail information
Output the following information for each class of Java process when you use the Explicit Heap Memory Management functionality:

Use status of entire Explicit heap

Use status for each Explicit memory block

When you execute the eheapprof command while using the Explicit Memory Management functionality, the statistical information of object within the Explicit memory block and the release rate information for the Explicit memory block is output.

Class-wise statistical information
Output the following information for each class of Java process specified by the jheapprof command.

Total size and reference of instance as the member of an instance

Total size of instances possessed by static member

Total size of object classes and instances causing an increase in the Tenured area

Footer
The time when thread dump terminated is displayed.

#

In UNIX, the notify pending list might not be displayed.

For details on the JavaVM thread dump information, see -XX:[+|-]HitachiThreadDump (extended thread dump information output option) in the uCosminexus Application Server Definition Reference Guide. For details on the class-wise statistical information, see 9.3 Class-wise statistical functionality. For details on the Explicit heap details information, see (3) Output contents of Explicit heap details information.

(2) Mapping between thread dump and trace based performance analysis file

Moreover, when slowdown or hang-up occurs in a J2EE application, you can investigate the locations where the errors occurred by correlating the thread dump with trace based performance analysis.

To correlate the thread dump with trace based performance analysis, use the thread ID output to the trace based performance analysis file with the nativeID (OS level thread ID) of the thread information output to the thread dump. To specify the corresponding trace based performance analysis file from the thread dump:

Collect the thread dump and trace based performance analysis file.
For details on the collection methods of thread dump, see 4.7 JavaVM thread dump. For details on the collection methods of the trace based performance analysis file, see 7.3.1 How to collect a trace based performance analysis file.

Select the thread dump and trace based performance analysis file to be used.
Based on the time when the thread dump and trace based performance analysis file are output, select the thread dump and trace based performance analysis file to be used for investigation. For details on the output time, see the following information:

Thread dump

Date and time output at the end of the file name and file.

The following is an example showing the date and time output at the end of a file:

...
...
Full thread dump completed. Fri Jul 21 19:22:47 2006

Trace based performance analysis file

Time and Time(msec/usec/nsec)

The following figure shows the Time and Time (msec/usec/nsec) of the trace based performance analysis file.

Convert nid (hexadecimal) and jid (hexadecimal) of thread dump to decimal.

In Windows, AIX, HP-UX, and Solaris
Convert the thread dump nid (hexadecimal) to decimal value.

...
...
"VBJ ThreadPool Worker" daemon prio=5 jid=0x00054f93 tid=0x04cef380 nid=0x1124 in Object.wait() [0x0632f000..0x0632fd18]
stack=[0x06330000​..0x062f5000..0x062f1000..0x062f0000]
[user cpu time=0ms, kernel cpu time=15ms] [blocked count=1, waited count=29]
at java.lang.Object.wait(Native Method)
...
...

1124(Hexadecimal)=4388(Decimal)

In Linux
Convert the thread dump nid (hexadecimal) to decimal value.

...
...
"main" prio=1 jid=0x00006d75 tid=0x00201d70 nid=0x1e51 waiting on condition [0x00000000​..0xbfe80488] stack=[0xbfe87000..0xbfc8c000..0xbfc88000..0xbfc87000] [user cpu time=1320ms, kernel cpu time=4280ms] [blocked count=5, waited count=4]
...
...

6d75(Hexadecimal) = 28021 (Decimal)

Search the row in which the value (Decimal) of Thread(hashcode) in the trace based performance analysis file matches with the value converted to decimal by procedure 3., and specify the trace information.

In Windows, AIX, HP-UX, and Solaris
Search the line where value of Thread (Thread ID) is matching with the value converted to decimals.

In Linux
Search the line where value of hashcode (Hashcode) is matching with the value converted to decimals.

(3) Output contents of Explicit heap details information

The Explicit heap information and the Explicit memory block information is output to the Explicit heap details information. When there is more than one Explicit memory block, they are output to the Explicit memory block information. You can also output the object statistical information within the Explicit memory blocks and the release rate information for the Explicit memory block to the Explicit memory block information.

The output format, output items, and output examples of Explicit heap details information are as follows:

Output format

The output format differs depending on the execution of eheapprof command.

When the eheapprof command is executed

Explicit Heap Status
--------------------
max <EH_MAX>, total <EH_TOTAL>, used <EH_USED>, garbage <EH_GARB> (<EH_PER1> used/max, <EH_PER2> \
used/total, <EH_PER3> garbage/used), <EM_NUMS> spaces exist

Explicit Memories(<EM_MGR_PTR>)
...
"<EM_NAME>" eid=<EID>(<EM_PTR>)/<EM_TYPE>, total <EM_TOTAL>, used <EM_USED>, garbage <EM_GARB> \
(<EM_PER1> used/total, <EM_PER2> garbage/used, <FL_BLOCKS> blocks) <EM_STAT>
deployed objects
________________Size__Instances__FreeRatio__Class________________
  <ISIZE> <INUM> <FRATIO> <CNAME>
  ...
 <AISIZE> <AINUM> total
...

Note:

For details on the signs used in the output format, see 5.11.2(3) Signs used in description of output format of event log.

When the eheapprof command is not executed

Explicit Heap Status
--------------------
max <EH_MAX>, total <EH_TOTAL>, used <EH_USED>, garbage <EH_GARB> (<EH_PER1> used/max, <EH_PER2> \
used/total, <EH_PER3> garbage/used), <EM_NUMS> spaces exist

Explicit Memories(<EM_MGR_PTR>)
...
"<EM_NAME>" eid=<EID>(<EM_PTR>)/<EM_TYPE>, total <EM_TOTAL>, used <EM_USED>, garbage <EM_GARB> \
(<EM_PER1> used/total, <EM_PER2> garbage/used, <FL_BLOCKS> blocks) <EM_STAT>
...

Note:

For details on the signs used in the output format, see 5.11.2(3) Signs used in description of output format of event log.

Output items

The following table describes about each item in output format.

Table 5-23 Output items (Explicit heap details information)

Category
Output items
Output contents
Meaning

Explicit heap information
<EH_MAX>
<const>K
Maximum size of Explicit heap is output. The unit is kilo bytes.

<EH_TOTAL>
<const>K
Secured Explicit heap size is output. The unit is kilo bytes.

<EH_USED>
<const>K
Used Explicit heap size is output. The unit is kilo bytes.

<EH_GARB>
<const>K
The internal status of Explicit heap is output.

<EH_PER1>
<decimal>%
Explicit heap utilization rate (<EH_USED>/<EH_MAX>) is output in % sign.

<EH_PER2>
<decimal>%
Explicit heap utilization rate (<EH_USED>/<EH_TOTAL>) is output in % sign.

<EH_PER3>
<decimal>%
The internal status of Explicit heap is output.

<EM_NUMS>
<const>
The valid Explicit memory blocks are output.

<EM_MGR_PTR>
<ptr>
Memory address that has internal information for Explicit heap control is output. The memory address can be used for investigating errors.

Explicit memory block information
<EM_NAME>
<letters>
Name of Explicit memory block is output.
The output contents are uncertain when multi byte characters are included in name of Explicit memory block (Usually garbled and output).
At times "NULL" is output when name of Explicit memory block is output at about the same time of initialization of Explicit memory block or when JavaVM generates the Explicit memory block internally.

<EID>
<const>
ID of Explicit memory block is output.

<EM_PTR>
<ptr>
Memory address with Explicit memory block internal structure is output. The memory address can be used for investigating errors.

<EM_TYPE>
R|B|A
Explicit type is output. R indicates Explicit memory block used internally in Application Server. B indicates Explicit memory block used by application. A indicates the Explicit memory block that is specified using the automatic allocation configuration file.

<EM_TOTAL>
<const>K
Secured memory size of Explicit memory block is output. The unit is kilo bytes.

<EM_USED>
<const>K
Used size of Explicit memory block is output. The unit is kilo bytes.

<EM_GARB>
<const>K
Internal status of Explicit memory block is output. The unit is kilo bytes.

<EM_PER1>
<decimal>%
Explicit memory block utilization ratio (<EM_USED>/<EM_TOTAL>) is output in % sign.

<EM_PER2>
<decimal>%
Internal status of Explicit memory block is output.

<FL_BLOCKS>
<const>
Normally 0 is output

<EM_STAT>
Enable|Disable
Sub-status of Explicit memory block is output.

Object statistical information#
<ISIZE>
<const>
Size in Explicit memory block of the object that sets the instance of a certain class is output.

<INUM>
<const>
Fixed quantity within the Explicit memory block of the object that sets the instance of certain class is displayed.

<CNAME>
<letters>
Entire class name of class indicating <ISIZE> and <INUM> is output.

<AISIZE>
<const>
Total size of all objects in Explicit memory block is output.

<AINUM>
<const>
Number of all blocks in Explicit memory block is output.

Object release rate information#2
<FRATIO>
<decimal>%
The ratio of the objects released (object release rate) in the automatic release processing of the Explicit memory block is output with the % (percentage) sign.
Object release rate =
(Number-of-class-objects-before-the-automatic-release-processing - Number-of-class-objects-after-the-automatic-release-processing)/Number-of-class-objects-before-the-automatic-release-processing100
Note that when the object release rate information is output, "--" is output for the Explicit memory block that was not subject to the automatic release processing.

Note:

For details on the signs used in the output contents, see 5.11.2(3) Signs used in description of output format of event log.

#1

The object statistical information is output while executing the eheapprof command. You can output actually created size, "[I" indicating the int type array greater than the quantity, in the object statistical information. In such cases, "[I" indicates objects that are not used in an Explicit memory block. Create the int type array in internal process of JavaVM for objects that are not used in the Explicit memory block.

#2

The object release rate information is output when you execute the eheapprof command specifying the -freeratio option.

Example of output

The output format differs depending on execution of the eheapprof command.

When eheapprof command is executed

Explicit Heap Status
--------------------
max 31415926​K, total 162816K, used 150528K, garbage 10004K (0.0% used/max, 91.1% used/total, 6.6% garbage/used), 3 spaces exist

Explicit Memories(0x12345678​)

"EJBMgrData" eid=1(0x02f25610)/R, total 54272K, used 50176K, garbage 0K (91.2% used/total, 0.0% garbage/used, 0 blocks)
deployed objects
________________Size__Instances__FreeRatio__Class________________
 35234568​ 10648  - java.util.HashMap
  5678900​ 10668  - [Ljava.util.HashMap$Entry;
  4456788​ 7436  - java.util.HashMap$Entry
  4321000​ 200  - java.util.WeakHashMap
  1234568​ 190  - [Ljava.util.WeakHashMap$Entry;
  454400  4  - java.util.WeakHashMap$Entry
 51380224​ 29146 total

"VJBStored" eid=3(0x02f25910)/B, total 54272K, used 50176K, garbage 10004K (90.7% used/total, 19.9% garbage/used, 5 blocks)
deployed objects
________________Size__Instances__FreeRatio__Class________________
 35234568​ 10648  49 java.util.HashMap
  5678900​ 10668  43 [Ljava.util.HashMap$Entry;
  4456788​ 7436  50 java.util.HashMap$Entry
  4321000​ 200  32 java.util.WeakHashMap
  1234568​ 190  45 [Ljava.util.WeakHashMap$Entry;
  454400  4  22 java.util.WeakHashMap$Entry
 51380224​ 29146 total

"ExplicitMemory-2" eid=2(0x02f25700)/B, total 54272K, used 50176K, garbage 0K (91.1% used/total, 0.0% garbage/used, 0 blocks)
deployed objects
________________Size__Instances__FreeRatio__Class________________
 35234568​ 10648  - java.util.HashMap
  5678900​ 10668  - [Ljava.util.HashMap$Entry;
  4456788​ 7436  - java.util.HashMap$Entry
  4321000​ 200  - java.util.WeakHashMap
  1234568​ 190  - [Ljava.util.WeakHashMap$Entry;
  454400  4  - java.util.WeakHashMap$Entry
 51380224​ 29146 total

When the eheapprof command is not executed

Explicit Heap Status
--------------------
max 31415926​K, total 213971K, used 205369K, garbage 1234K (1.1% used/max, 96.2% used/total, 0.0% garbage/used), 3 spaces exist

Explicit Memories(0x12345678​)

"EJBMgrData" eid=1(0x02f25610)/R, total 154272K, used 150176K, garbage 1234K (97.0% used/total, 1.2% garbage/used, 0 blocks) Enable

"VJBStored" eid=3(0x02f25910)/B, total 54272K, used 50176K, garbage 0K (90.9% used/total, 0.0% garbage/used, 2 blocks) Enable

"ExplicitMemory-2" eid=2(0x02f25700)/R, total 5427K, used 5017K, garbage 0K (92.1% used/total, 0.0% garbage/used, 0 blocks) Enable

5.6 JavaVM Garbage Collection Log

The garbage collection log is output to the JavaVM log file.

For details, see 5.7 JavaVM log (JavaVM log file).

5.7 JavaVM log (JavaVM log file)

The JavaVM log file is output by using extended options added by Hitachi in the standard JavaVM. To acquire this log, you need to specify the necessary options when starting the target J2EE server.

Organization of this section

5.7.1 Options to output the JavaVM log file

5.7.2 Acquiring the extended verbosegc information

5.7.3 Contents of the code cache area-related log

5.7.1 Options to output the JavaVM log file

The options to output the JavaVM log file are as follows:

-XX:+HitachiOutOfMemoryStackTrace
It is an option to output the stack trace when OutOfMemoryError occurs. Note that the JavaVM log file is output even if you specify -XX:+HitachiOutOfMemorySize and -XX:+HitachiOutOfMemoryCause that are specified when you specify the -XX:+HitachiOutOfMemoryStackTrace option.

-XX:+HitachiVerboseGC
It is an option to output the extended verbosegc information when garbage collection is performed. For acquiring the extended verbosegc information, see 5.7.2 Acquiring the extended verbosegc information.

-XX:+HitachiJavaClassLibTrace
This option is to output the API call trace of System.gc(), System.exit(), System.runFinalizersOnExit(), Runtime.exit(), Runtime.halt(), or Runtime.runFinalizersOnExit() APIs when either of them is executed.
Note that when you specify the -XX:HitachiJavaClassLibTraceLineSize option, the number of characters in the output trace are within the specified number of characters (number of bytes). When the number of characters in one line exceeds the specified value, the first half of the character string after at is deleted and the specified number of characters is output.

-XX:+JITCompilerContinuation
This option enables the JIT compiler continuation functionality. If the JIT compilation fails due to a logical inconsistency in a method configuring the application, the JIT compiler continuation functionality log is output to the JavaVM log file.

For details on the output contents when specifying each option, see the following points in the uCosminexus Application Server Definition Reference Guide:

-XX:[+|-]HitachiOutOfMemoryStackTrace (stack trace output option)

-XX:[+|-]HitachiVerboseGC (extended verbosegc information output option)

-XX:[+|-]HitachiJavaClassLibTrace (stack trace output option of class library)

-XX:[+|-]JITCompilerContinuation (JIT compiler continuation functionality option) in the uCosminexus Application Server Definition Reference Guide

5.7.2 Acquiring the extended verbosegc information

In the J2EE server usrconf.cfg file, if you specify the options shown in the table below, you can acquire extended verbosegc information. From the extended verbosegc information, you can acquire the information for estimating the Java heap area size, Perm area size, required for that server. Note that the stack trace at OutOfMemoryError occurrence time is also output in the Java log.

Table 5-24 Options to be specified for acquiring the extended verbosegc information

Optional
Meaning

-XX:+HitachiVerboseGC
Specify whether to output the extended verbosegc information. Output information for each Eden, Survivor, Tenured, Perm type that is the internal area of garbage collection. Nothing is output by default. If -XX:+HitachiVerboseGC is specified, the extended verbosegc information is output and if -XX:-HitachiVerboseGC is specified, the extended verbosegc information is not output.

-XX:+HitachiVerboseGCPrintDate
Specify whether to display the date of log output at the beginning of each line of the log in which the extended verbosegc information is output.

-XX:+HitachiVerboseGCCpuTime
During the period between the start of garbage collection until the end of garbage collection, specify whether only the time spent in user mode and kernel mode by the garbage collection execution thread should be displayed or the execution time should be displayed.
However, this function cannot be used when HP-UX is used. Even if this option is specified it is invalid.

-XX:HitachiVerboseGCIntervalTime=Time-interval
Specify a numeric value (Unit: Seconds) as an output time interval for -XX:+HitachiVerboseGC. The default value for the time interval is 0 (Output every time garbage collection occurs). Note that when you specify the time interval, the garbage collection frequency during that time interval is also displayed.

-XX:+HitachiVerboseGCPrintCause
Specify whether to display the cause for the occurrence of garbage collection in the log in which the extended verbosegc information is output.

-XX:+HitachiCommaVerboseGC
Specify whether the log in which the extended verbosegc information is output should be in CSV format. If the log is output in the CSV format, all the brackets (( ) [ ] < >) and delimiters of the extended verbosegc information are omitted, and the numeric values or character strings delimited by comma (,) are output.

-XX:+HitachiVerboseGCPrintTenuringDistribution
Specify whether to output Tenuring Distribution information of Survivor area. Nothing is output by default. For output format or output information, see 9.11 Tenuring distribution information output functionality of the Survivor area.

-XX:+HitachiVerboseGCPrintJVMInternalMemory
Specify whether the heap information managed in JavaVM is output to the JavaVM log file.

-XX:+HitachiVerboseGCPrintThreadCount
Specify whether the Java thread count is output to the JavaVM log file to monitor the Java thread count.

-XX:+HitachiVerboseGCPrintDeleteOnExit
Specify whether the cumulative heap size allocated by JavaVM by invoking java.io.File.deleteOnExit()and the frequency of method invocation are output to the JavaVM log file.

-XX:+PrintCodeCacheInfo
Specify whether to output the usage of the code cache area, and also whether to output a message informing the user that the usage has reached the threshold value.

The format and the example of the log file output are as follows:

Output format

[id]<date>(Skip Full:full_count, Copy:copy_count)[gc_kind gc_info, gc_time secs][DefNew::Eden: eden_info][DefNew::Survivor: survivor_info][Tenured: tenured_info][Perm: perm_info][cause:cause_info][User: user_cpu secs][Sys: system_cpu secs] ][IM:jvm_alloc_size, mmap_total_size, malloc_total_size][TC: thread_count][DOE: doe_alloc_size, called_count] [CCI: cc_used_sizeK, cc_max_sizeK, cc_infoK]

Description

id: JavaVM log file identifier
The following table describes the JavaVM log file identifiers. Use these identifiers for investigation by filtering log as per log contents (functions).

Table 5-25 JavaVM log file identifiers

Identifiers | Log contents
CCI | Code cache area information
CLT | Stack trace of class library
JCC | Information on the failure of JIT compilation
JMS | Information on the JIT complier thread that prevents JIT compilation
OMH | Information on the frequency of OutOfMemory occurrences
OOM | Exception information when OutOfMemoryError occurs and stack trace
PTD | Tenuring distribution information of Survivor area
VGC | Extended verbosegc information

date: Date and time

full_count: Frequency of skipping full garbage collection (Only when you specify -XX:HitachiVerboseGCIntervalTime)

copy_count: Frequency of skipping copy garbage collection (Only when you specify -XX:HitachiVerboseGCIntervalTime)

gc_kind: Garbage collection type (Full GC or GC)

gc_info: Garbage collection information (Area length prior to garbage collection-> Area length after garbage collection (Area size))
(Example) 264K->0K(512K)

gc_time: Garbage collection elapsed time (Unit: Seconds)

eden_info: Eden information

survivor_info: Survivor information

tenured_info: Tenured information

perm_info: Perm information

cause_info: Cause of garbage collection

user_cpu secs: CPU time spent in user mode by the garbage collection thread (Unit: Seconds)

system_cpu secs: CPU time spent in kernel mode by the garbage collection thread. (Unit: Seconds)

jvm_alloc_size: The size of the area currently in use, among the areas managed in JavaVM (size of the area currently in use among the total size of mmap_total_size and malloc_total_size) (only when -XX:+HitachiVerboseGCPrintJVMInternalMemory is specified)

mmap_total_size: The total size of C heap allocated by mmap (in Windows VirtualAlloc) , among the areas managed in JavaV (only when -XX:+HitachiVerboseGCPrintJVMInternalMemory is specified)

malloc_total_size: The total size of C heap allocated by malloc, among the areas managed in JavaVM (only when -XX:+HitachiVerboseGCPrintJVMInternalMemory is specified)

thread_count: Java thread count (only when -XX:+HitachiVerboseGCPrintThreadCount is specified)

doe_alloc_size: The accumulated heap size allocated by invoking java.io.File.deleteOnExit() (only when -XX:+HitachiVerboseGCPrintDeleteOnExit is specified)

called_count: The number of times java.io.File.deleteOnExit() is invoked (only when -XX:+HitachiVerboseGCPrintDeleteOnExit is specified)

cc_used_size: Size of the code cache area used during garbage collection (unit: kilobyte) (only when -XX:+PrintCodeCacheInfo is specified)

cc_max_size: Maximum size of the code cache area (unit: kilobyte) (only when -XX:+PrintCodeCacheInfo is specified)

cc_info: Maintenance information (only when -XX:+PrintCodeCacheInfo is specified)

Example of output

Examples of output when the -XX:+HitachiCommaVerboseGC option is specified are as follows:

VGC,Fri Jan 23 21:37:50 2004,11,41,0,GC,16886,16886,65088,0.0559806​,
4094,0,4096,447,447,448,12345,16439,60544,1116,1116,4096,0,0.0312500​, 0.0156250​,729,928,0,509,2167,2054,2301,49152,2304
VGC,Fri Jan 23 21:37:55 2004,6,24,0,Full GC,65082,65082,65088,0.4294532​,
4094,4094,4096,447,447,448,60541,60541,60544,1116,1116,4096,0,0.0156250​, 0.0312500​,729,928,0,509,16,170,2301,49152,2304

5.7.3 Contents of the code cache area-related log

JavaVM speeds up the processing by executing the JIT compilation for the Java methods with a high invocation count and loop count. The JIT compile code generated by the JIT compilation is allocated to the code cache area.

Normally there is no problem if the code cache area size is the default value. However, depending on the scale of the execution environment and Java applications, the code cache area size might be depleted with the default value.

If the code cache area is depleted, JavaVM cannot execute the JIT compilation and, proper performance might not be obtained from the execution of Java applications. In such cases, enable -XX:[+|-]PrintCodeCacheInfo (option to output the code cache area information) or -XX:[+|-]PrintCodeCacheFullMessage (option to output the code cache area depletion message), and then monitor the usage of the code cache area and the messages that are output.

For details on these options, see -XX:[+|-]PrintCodeCacheInfo (Option to output the code cache area information) and -XX:[+|-]PrintCodeCacheFullMessage (Option to output the code cache area depletion message) in the uCosminexus Application Server Definition Reference Guide.

Organization of this subsection

(1) Output contents of the message informing the user that the usage of the code cache area has reached the threshold value

(2) Output contents of the message informing the user that the code cache area has depleted

(1) Output contents of the message informing the user that the usage of the code cache area has reached the threshold value

The output format of the message informing the user that the usage of the code cache area has reached the threshold value is as follows:

[cc_id]<cc_date>CodeCache usage has exceeded the threshold.[cc_used_sizeK, cc_max_sizeK, cc_infoK]

The following table describes the output items:

Output item | Explanation
cc_id | Outputs the CCI (JavaVM log file identifier).
cc_date | Outputs the data and time of JIT compilation.
cc_used_size | Outputs the size of the code cache area used after the JIT compilation (unit: kilobyte).
cc_max_size | Outputs the maximum size of the code cache area (unit: kilobyte).
cc_info | Outputs the maintenance information.

(2) Output contents of the message informing the user that the code cache area has depleted

The output format of the message informing the user that the code cache area has depleted is as follows:

[cc_id]<cc_date>CodeCache is full. Compiler has been disabled.[cc_used_sizeK, cc_max_sizeK, cc_infoK]

The following table describes the output items:

Output item | Explanation
cc_id | Outputs the CCI (JavaVM log file identifier).
cc_date | Outputs the date on which the Java method became subject to the JIT compilation.
cc_used_size | Outputs the used size of the code cache area when the Java method became subject to the JIT compilation (unit: kilobyte).
cc_max_size | Outputs the maximum size of the code cache area (unit: kilobyte).
cc_info | Outputs the maintenance information.

5.8 Message log output by JavaVM (Standard output and error report file)

When the JavaVM crashes, JavaVM outputs the debug information to the standard output and error report file.

The following are cases when the debug information is output to the error report file:

When a signal occurs in JNI

When C heap is insufficient in the JavaVM

When an unexpected signal occurs in the JavaVM

When an Internal Error (internal logical error) occurs in the JavaVM

The contents of message log output in the following cases are as follows.

Table 5-26 Message log output by JavaVM

Message type
Output destination

When a signal occurs in JNI or message in JavaVM#
Standard output
Error report files

Insufficient C heap message#
Standard output
Error report files

Internal Error occurrence message#
Standard output
Error report files

Thread creation failure message#
Standard output

#

The JavaVM proprietary output destination or output contents exist.

Note that the thread creation failure message is output only in the standard output.

Organization of this section

5.8.1 When a Signal Occurs

5.8.2 When C Heap Is Insufficient

5.8.3 When an Internal Error Occurs

5.8.4 When Thread Creation Fails

5.8.1 When a Signal Occurs

When a signal occurs, the items shown below are output to the log. The JavaVM extended contents are included in the output contents.

Abnormal termination location and signal type#

Current thread information

Save destination address of signal information#

Signal information

siginfo information# (in UNIX)

Register information

Information saved from the beginning of the stack

Command code information

Stack trace

Thread information

VM status

Memory information#

Usage status of Java heap#

Library

Command and VM parameters#

Environment variable

Registered signal handlers

Machine information#

System name, CPU, actual memory and VM information

Time information#

Command line of the javatrace startup command# (in UNIX)

#

These are the output contents extended by Hitachi.

Each output contents are described below.

Organization of this subsection

(1) Abnormal termination location and signal type

(2) Current thread information

(3) Save destination address of the signal information

(4) Signal information

(5) siginfo information (in UNIX)

(6) Register information

(7) Information saved from the top of stack

(8) Command code information

(9) Stack trace

(10) Thread information

(11) VM status

(12) Memory information

(13) Java heap usage status

(14) Libraries

(15) Command and VM parameters

(16) Environment variables

(17) Registered signal handlers

(18) Machine information

(19) System name, CPU, actual memory, and VM information

(20) Time information

(21) Command line of javatrace start command (in UNIX)

(1) Abnormal termination location and signal type

Any one of the following contents are output in compliance with the status at the time of abnormal termination. These contents are extended by JavaVM.

(a) When a signal is detected

The following message is output:

#
# A fatal error has been detected by the Java Runtime Environment:

The following contents are output:

Contents output when a signal is detected

#
# A fatal error has been detected by the Java Runtime Environment:
#
# Occurred-signal-name (signal-number) at pc=PC-address, pid=Process-ID, tid=Thread-ID
#
# JRE version :(jre version information)

# Java VM: Java HotSpot(TM) VM-type (Sun-version-information-Hitachi-version-information-build-date mixed modeOS-name-CPU-type)
# Problematic frame:
# <type-code> <library-name-where-signal-occurred+Offset
#

Note: When you are able to extract a function name where the signal occurred, that function name and offset may be displayed in continuation to library-name-where-signal-occured+offset.

(b) When an internal logical error occurs

The following contents are output:

Contents output when an internal logical error occurs

#
# Internal Error (0xe0000000​), pid=process-ID, tid=thread-ID
# Internal logical Error: Internal logical error message
#
# JRE version: 6.0

# Java VM: Java HotSpot(TM) VM-type (Sun-version-information-Hitachi-version-information-build-date mixed modeOS-name-CPU-type)

Note: Either a combination of the file name and number of lines or the Internal Error code is output to the Internal Error. In Internal logical Error, any one of fatal error, guarantee(logical type)failed, or Error is output, according to the type of the internal logical error.

(2) Current thread information

The following three types of information are output to the messages according to the thread type:

Current thread (address): thread-name "thread-name" [_state, id=thread-ID, stack(start-address,end-address)]

Or
Current thread (address): thread-name [_id=thread-ID, stack(start-address,end-address)]

Or
Current thread is native thread

(3) Save destination address of the signal information

The following contents are output. These contents are extended by JavaVM.

siginfo address: address, context address: address

(4) Signal information

The following contents are output.

In Windows

EXCEPTION_ACCESS_VIOLATION(Read violation)

siginfo: ExceptionCode=signal-number, reading address address

EXCEPTION_ACCESS_VIOLATION(Write violation)

siginfo: ExceptionCode=signal-number, writing address address

EXCEPTION_ACCESS_VIOLATION(Others)

siginfo: ExceptionCode=signal-number, ExceptionInformation=additional-information

Other than EXCEPTION_ACCESS_VIOLATION

siginfo: ExceptionCode=signal-number, ExceptionInformation=additional-information-1 additional-information-2 ...

In UNIX

siginfo:si_signo=signal-name, si_errno=number, si_code=number(signal-reason-type), si_addr=address

(5) siginfo information (in UNIX)

The following contents are output. These contents are extended by JavaVM.

siginfo structure dump (location: siginfo-address)
siginfo-address siginfo-address siginfo-address siginfo-address
...
siginfo-address siginfo-address siginfo-address siginfo-address

Note:

The siginfo-address is output in hexadecimal.

(6) Register information

The following contents are output. However, these contents are not output in the case of internal logical errors.

Registers: register-information
...

Note:

In UNIX, different BSP register value and debugger (gdb) value are output. This is because, in debugger, the contents of the backing store area that indicates BSP is output and the position that indicates BSP is modified.

(7) Information saved from the top of stack

The following contents are output. However, these contents are not output in the case of internal logical errors.

Top of Stack: (sp=Address-of-stack-pointer)
Address: Saved-contents
...

Note:

saved-contents are output in hexadecimal.

(8) Command code information

The following contents are output. However, these contents are not output in the case of internal logical errors.

Instructions: (pc=Address-of-program-counter)
Address: Command-code
...

Note: command-code is output in hexadecimal.

(9) Stack trace

The following contents are output. However, these contents are not output when the Current thread is other than JavaThread.

Java frames: (J=compiled Java code, j=interpreted, Vv=VM code)
Stack-trace
...

(10) Thread information

The following contents are output:

Java Threads: ( => current thread )
address JavaThread "thread-name" [state, id=thread-ID, stack(start-address,end-address)]
:
=>address JavaThread "thread-name" [state, id=thread-ID, stack(start-address,end-address)]
Other Threads:
address thread-name [stack(start-address,end-address)] [id=thread-ID]
:

(11) VM status

The following contents are output.

VM state: current-status

VM Mutex/Monitor currently owned by a thread: <mutexs/moniter>

The lock information may be output in continuation with this information.

(12) Memory information

The following contents are output. These contents are extended by JavaVM.

Memory:
secure-memory-function:addressStart-address - End-address (size: size)
...

Heap Size: secured-memory-size
Alloc Size: memory-size-in-use
Free Size: unused-memory-size

memory-securing-function is either mmap()or malloc(). The address is displayed in hexadecimal.

The unit of each type of memory size is bytes.

(13) Java heap usage status

The following contents are output. These contents are extended by JavaVM.

Heap
Java-heap-information

(14) Libraries

The list of loaded libraries is output in continuation to the following contents.

Dynamic libraries:
libraries
...

(15) Command and VM parameters

The following contents are output. These contents are extended by JavaVM.

Command : command-line

Java Home Dir : JDK-execution-environment-install-directory
Java DLL Dir : JDK-library-install-directory
Sys Classpath : system-class-path
User Args :
command-option-1
command-option-2
...

(16) Environment variables

The following contents are output.

Environment Variables:
environment-variable=value
...

(17) Registered signal handlers

The following contents are output.

Signal Handlers:
signal-type:
[signal-handler-address], sa_mask[0]= mask-signal, sa_flags=special-flag
...
Changed Signal Handlers -
signal-type: [signal-handler-address], sa_mask[0]=signal-mask, sa_flags=special-flag
...

The meaning of output contents are as follows:

signal-type: It is the signal name defined in /usr/include/sys/signal.h.

signal-handler-address: It is the signal handler address output in hexadecimal. It may also be displayed in the library-name+offset format.

signal-mask: It is the value where the sa_mask field value of the structure extracted by sigaction() is output in hexadecimal.

special-flag: It is the value where the sa_flags field value of the structure extracted by sigaction() is output in hexadecimal.

(18) Machine information

The following contents are output. These contents are extended by JavaVM.

Host: host-name:IP-address

Note: Multiple IP addresses may be displayed in IP-address.

(19) System name, CPU, actual memory, and VM information

The following contents are output.

In Windows

OS:OS-version

CPU: number-of-CPUs-that-can-be-used, CPU-type

Memory:actual-memory-information

vm_info:VM-information

In UNIX

OS:OS version

[uname:uname output]
[libc:version-number-of-libc(at-times-version number-is-not-output)]
[rlimit:limit-value]
]load average:load-average]
[/proc/meminfo:/proc/meminfo contents]

CPU:number-of-CPUs-that-can-be-used,CPU-type

Memory:actual-memory-information

vm_info:VM-information

(20) Time information

The following contents are output:

time: execution-date

elapsed time: execution-time seconds

Note:

An example of the execution date is as follows:

Example: Wed Aug 25 14:55:04 2004

(21) Command line of javatrace start command (in UNIX)

The following contents are output. These contents are extended by JavaVM.

# You can get further information from javatrace.log file generated
# by using javatrace command.
# usage: javatrace core-file-name loadmodule-name [out-file-name] [-l(library-name)...]
# Please use javatrace command as follows and submit a bug report
# to Hitachi with javatrace.log file:
#[installation-directory/jre/bin/javatrace core-file load-module]

5.8.2 When C Heap Is Insufficient

When C heap is insufficient, the message output, and dump output or core dump generation is performed in the following order:

A message log indicating insufficient C heap is output to the error report file and standard output.

If the memory is insufficient during the execution of 1., a simple message is output to the standard output.

In Windows, the Watson log is started and dump is output. In UNIX, if the memory is still insufficient during the output of a simple message, output of the message and error log file is interrupted and a core dump is generated.

Each output format is described below.

Organization of this subsection

(1) Output contents of a message log indicating insufficient C heap

(2) Output contents of message showing memory insufficiency

(3) Output contents of the message indicating whether the Watson log is output correctly (in Windows)

(4) Output contents of the message indicating core dump generation

(1) Output contents of a message log indicating insufficient C heap

The output format of a message log indicating insufficient C heap is described below. This format is common for the error report file and standard output.

In Windows

Exception in thread <ThreadName> java.lang.OutOfMemoryError:requested <n> bytes [ for <message>].

Memory Status
-------------
Memory in use: utilization-rate%
Physical memory: free-memory-size/total-memory-sizefree
Virtual memory: free-memory-size/Total-memory-sizefree
Paging file: free-volume/total-volumefree

Heap Status
-----------
Java-heap-information
-----------
Stack Trace
-----------
stack-trace
Insufficient memory for malloc. JVM generates core file.
-----------

In AIX, HP-UX, or Linux

Exception in thread <ThreadName> java.lang.OutOfMemoryError: requested <n> bytes [for <message>].

Memory Status
-------------
maximum size of data segment
soft(current) limit: software-limit-value-acquired-by-getrlimit(RLIMIT_DATA) kbytes (Hexadecimal)
hard limit: hardware-limit-value-acquired-by-getrlimit(RLIMIT_DATA) kbytes (Hexadecimal)
current end of the heap: value-acquired-by-sbrk(0)
JVM allocation size by malloc: memory-size-allocated-to-JavaVM kbytes (Hexadecimal)
malloc information
total space in arena :mallinfo.arena value
number of ordinary blocks :mallinfo.ordblks value
number of small blocks :mallinfo.smblks value
number of holding blocks :mallinfo.hblks value
space in holding block headers :mallinfo.hblkhd value
space in small blocks in use :mallinfo.usmblks value
space in free small blocks :mallinfo.fsmblks value
space in ordinary blocks in use :mallinfo.uordblks value
space in free ordinary blocks :mallinfo.fordblks value
cost of enabling keep option :mallinfo.keepcost value

Heap Status
-----------
Java-heap-information
-----------
Stack Trace
-----------
stack-trace
-----------

In Solaris

Exception in thread <ThreadName> java.lang.OutOfMemoryError: requested <n> bytes [for <message>].

Heap Status
-----------
Java-heap-information
-----------
Stack Trace
-----------
stack-trace
-----------

When such a message is output, take appropriate measures such as reducing C heap.

The output contents are as follows:

Table 5-27 Output items of message log when C heap is insufficient

Output items
Description

ThreadName
The thread name extracted by the Thread#getName() method is output.

n
The size of memory securing requests is output.

message
The internal message required by maintenance personnel for investigation is output. In some cases it may not be output.

Java heap information
The usage status of Java heap is output.

Stack trace
The stack trace is output when the thread for which the memory is insufficient is the thread that is executing a Java code.
The stack trace is not output when the memory is insufficient in the thread that is executing internal process such as compilation process in JavaVM.

(2) Output contents of message showing memory insufficiency

If memory becomes insufficient while a message log indicating insufficient C heap is being output, the process cannot be continued. In this case, a simple message in the following format is output to the standard output.

java.lang.OutOfMemoryError:requested <n> bytes for <message>

The output contents are as follows:

Table 5-28 Output contents of a simple message when the memory is insufficient

Output items | Description
n | The size of memory securing requests is output.
message | The internal message required by maintenance personnel for investigation is output.

(3) Output contents of the message indicating whether the Watson log is output correctly (in Windows)

After a simple message is output, the Watson log is started and a dump is output. However, in some cases, since the Watson log cannot be output successfully, check the output message for the process results in the standard output.

The following message is output if Watson log startup fails.

WatosonLog process generated.But couldn't generate dump file,because of resource shortage.

The following message is output if a dump output fails after starting the Watson log.

Couldn't generate dump file, because of resource shortage.

When these processes are successful, the message shown below is output. However, even in these cases, there are times when the Watson log dump output is not performed successfully. Even when this message is output, confirm whether the dump is actually output.

Although Dr.Watson process finished successfully,dump file isn't always generated.
Check your directory where dump file is stored.

(4) Output contents of the message indicating core dump generation

If the memory is still insufficient when a simple message is output, output of the message and error log file is interrupted and a core dump is generated. When a core dump is generated, the message in the following format is output in the standard output.

Can't create logs because of memory shortage.
Insufficient memory for malloc. JVM generates core file

5.8.3 When an Internal Error Occurs

When an internal error that is a logical error within JavaVM occurs, the following information is output.

Abnormal termination location and signal type

Current thread information

Save destination address of signal information#

Thread information

VM status

Memory information#

Heap information#

Library

Command VM parameter#

Environment variable

Registered signal handlers

Machine information#

System name, CPU, actual memory and VM information

Time information

Command line of the javatrace startup command# (in UNIX)

#

These are the output contents extended by Hitachi.

For the output format of each information, see 5.8.1 When a Signal Occurs.

5.8.4 When Thread Creation Fails

When memory insufficiency (OutOfMemoryError) occurs and a new thread cannot be created, the number of threads at that time is output to the standard output. The threads that could not be created are also included in this number of threads.

An example of output when thread creation failed due to memory insufficiency is as follows:

java.lang.OutOfMemoryError:unable to create new native thread.1200 threads exist.
...

An example of output when thread creation failed at JavaVM startup time is as follows:

Error occurred during initialization of VM
Could not create thread for VM:VM Thread.5 threads exist.

5.9 OS status information and OS log

Confirm the existence of an abnormal trend from the acquired OS status and log information. For more details on this, see the manuals provided with the OS.

5.10 JavaVM stack trace information

Of the information output in the stack trace, the contents extended by JavaVM are described here.

When an error occurs in a server and applications, you can investigate the cause for error occurrence by confirming the stack trace contents until the error occurred.

The stack trace is output at either of the following timings:

When an exception occurs in the J2EE servers or J2EE applications

When an exception occurs in batch servers or batch applications

When JavaVM thread dump is output

In JavaVM, you can output the information of local variables in Java methods in the stack trace by specifying start options when starting the server. The information of local variables defined in Java methods is effective for analyzing the cause of errors when exceptions occur.

Note that, the Local variables referenced here are the objects (this) that are passed to the methods as arguments and are invoked by instance methods. In the local variable information, these local variable names, type names, and local variable values are output. Note that the type name is the basic type name, class name (including interface name), or array type name.

The following table describes the options to output the local variable information to stack trace. For details on settings for acquiring the JavaVM material, see the subsection 3.3.19 Settings for Acquiring the JavaVM Material.

Table 5-29 Options to output the local variable information to stack trace

Startup options
Timing to output stack trace
Option that can be specified simultaneously

-XX:+HitachiLocalsInThrowable
When an exception occurred in servers or applications#

-XX:MaxJavaStackTraceDepth= Maximum-depth

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

-XX:HitachiCallToString=applicable-range

-XX:+HitachiLocalsInStackTrace
When JavaVM thread dump is output

-XX:MaxJavaStackTraceDepth= Maximum-depth

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

#

However, when the exception occurred is java.lang.StackOverflowError or java.lang.OutOfMemoryError, the local variables are not output to stack trace.

The contents output is described with an example as base when you specify each of these options. For details on the items output when each option is specified, see the following points in the uCosminexus Application Server Definition Reference Guide:

-XX:[+|-]HitachiLocalsInThrowable (Option for collecting the local variable information when exception is thrown)

-XX:[+|-]HitachiLocalsInStackTrace (Option for collecting the local variable information when thread dump is output)

Organization of this section

5.10.1 When the -XX:+HitachiLocalsInThrowable Option Is Specified

5.10.2 When the -XX:+HitachiLocalsInStackTrace Option Is Specified

5.10.1 When the -XX:+HitachiLocalsInThrowable Option Is Specified

For each stack frame information of the stack trace information output by the java.lang.Throwable.printStackTrace method, the local variable information within the method corresponding to that stack frame is inserted and output.

Organization of this subsection

(1) Example of output in standard format and simple output format

(2) Example of output when class or array type variables are output as a character string

(3) Example of output when the actual type name of class or array type variables is to be output

(1) Example of output in standard format and simple output format

This is the example of output when you specify the -XX:+HitachiLocalsInThrowable option only as a function to output local variables.

The example of Java program and output of the corresponding local variable information within the stack trace are as follows:

Java program example 1

class Example1 {
public static void main(String[] args) {
Example1 e1 = new Example1();
Object obj = new Object();
e1.method(1, 'Q', obj); // Execute-e1.method (5th line).
}

void method(int l1, char l2, Object l3) {
float l4 = 4.0f;
boolean l5 = true;
double l6 = Double.MAX_VALUE;
Object[] l7 = new Object[10];

try {
<Exception occurred!> // methodProcess-when-there-is-an-exception-in-process-of-method(15th line).
} catch (Exception e) {
e.printStackTrace(); // output-stack-trace-information (17th line).
}
}
}

The example of output is described below.

This example is the stack trace information output by e.printStackTrace method on the 17th line when an exception occurs in e1.method method executed on the 5th line of example 1 of the Java program.

Figure 5-2 Output example of local variable information for example 1 of Java program (When the class file is created by specifying -g option or -g:vars option)

The output contents are as follows:

The information of the method that executes the stack trace output process is output. This example shows the output of the stack trace information when an exception occurs on the 15th line of the Java program 1.

As the local variable information, the information of objects invoked by the instance method is output. In this example, the class name and address of the object of example 1 class created on the 3rd line of example 1 of the Java program is output.

As local variable information, the information of the values of local variables specified as arguments of the method are output. The [arg*] after variable name is the information indicating the number of the method argument. The values specified when executing the e1.method method on the 5th line of example 1 of Java program are output.
Note that for local variables 11 and 12, the actual value is output since they are basic type (int type and char type) variables. The local variable l3 is a java.lang.Object class type variable, as a result, the address is output.

As local variable information, from the local variables in the method, information of the values of local variables that are not specified as method argument is output.
Note that since the local variables l4 to l6 are of basic type (float type, boolean type, and double type), their actual value is output. Since the local variable l7 is the java.lang.Object class type variable, the address is output.

The example of output in the simple output format when you specify -XX:+HitachiLocalsSimpleFormat option, is described below. Further, the explanation of the output contents is the same as that for standard format.

Figure 5-3 Output example when -XX:+HitachiLocalsSimpleFormat option is specified

Moreover, if the -g option or -g:vars option is not specified when executing javac command, and since there is no local variable information, the output contents are restricted in the following manner. This is same as when executing the native method.

The local variables that can be output are only the arguments that are passed to the method and objects (this) invoked by the instance method.

For the arguments passed to the method, the variable name is not output. Only the argument number is output.

In the case of the native method, the value when the native method is invoked is output as the value of the local variable. It is not the output result that reflects the result of the executing native method.

The example of output in the case of Java program example 1, when the local variable information does not exist, is described below. The example of output in the simple output format is as follows:

Figure 5-4 Output example when local variable information does not exist (Simple output format)

There are following differences as compared to Figure 5-3.

The variable names of the arguments (l1 to l3) passed to the method is not output.

As the value is output when the method is invoked, the information (l4 to l7) for the local variables set in the method is not output.

(2) Example of output when class or array type variables are output as a character string

When the local variables to be output are of class or array type, there are times when the information required for troubleshooting cannot be acquired in the value expression of only the address. At this time, if you specify the -XX:HitachiCallToString option, you can acquire the value of class or array type variable as a character string. In options, you can specify minimal or full as the applicable scope.

When you specify -XX:HitachiCallToString=minimal option, among the classes in the java.lang package, String, StringBuffer, Boolean, Byte, Character, Short, Integer, Long, Float, or Double are the targets of a parameter. When specifying the -XX:HitachiCallToString=full option, all the classes are targets.

An example of the Java program and example of output when the -XX:HitachiCallToString option is specified is described below. Further, the simple output format is used below.

Java program example 2

class Example2 {
public static void main(String[] args) {
Example2 e2 = new Example2();
e2.method();// Executes-e2.method-method (4th line).
}

void method() {
String l1 = "local 1";
StringBuffer l2 = new StringBuffer(l1);
l2.append(" + local 2");
Boolean l3 = new Boolean(false);
Character l4 = new Character('X');
Long l5 = new Long(Long.MIN_VALUE);
Object l6 = new Thread();
Object[] l7 = new Thread[10];

try {
<Exception occurred!> // Process-when-exception-occurred-in-process-of-method (18th line).
} catch (Exception e) {
e.printStackTrace(); // Output stack trace information (20th line).
}
}

public String toString() {
return "I am an Example2 instance.";
}
}

An example of output when specifying the -XX:HitachiCallToString=minimal option is described below:

This example is the stack trace information output by the 20th line e.printStackTrace method when an exception occurs in the e2.method method executed on the 4th line of example 1 of the Java program.

Figure 5-5 Output example when -XX:HitachiCallToString=minimal option is specified (Simple output format)

The output contents are as follows:

Among the local variables of class type, this information is that of the local variables of class type for which a character string is to be output. In continuation to the address, the value converted into a character string is output.

Among the local variables of class type, this information is that of local variables of class type for which a character string is not to be output. Only the address is output.

Shown below is the example of output when you specify the -XX:HitachiCallToString=full option.

Figure 5-6 Output example when -XX:HitachiCallToString=full option is specified (Simple output format)

There are following differences as compared to Figure 5-5.

When you specify minimal, the character string is output even for the local variables (l6 and l7) of the arrays of java.lang.Object and java.lang.Object class for which a character string is not to be output.

However, the character string is not output and only the address is output, such as in the following cases:

If the value of the local variable is null

If an error occurs again when a character string is being output, you cannot acquire the value successfully.

Note

The object output in the local variable information may be operated in parallel by other threads. For this reason, the character string output by specifying this option may be different than the information corresponding to that object when an exception actually occurs.

(3) Example of output when the actual type name of class or array type variables is to be output

When local variables that are output are of class or array type, there are cases when that variable type name and the type name of actually substituted value differ. For example, depending on the inheritance relationship of classes or the implementation relationship of interfaces, values of different type names are substituted in variables.

In this case, by specifying the -XX:+HitachiTrueTypeInLocals option, you can add the type name of a value actually substituted to the class or array type variables and acquire the character string.

The acquired character string is output by adding one single byte space at the end of the value expression and enclosing with parentheses (()). At this time, there is no limit on the output character string length.

An example of output when you specify -XX:+HitachiTrueTypeInLocals option is described below. Simple output format is shown below. The program to be executed is example 2 of the Java program. Moreover, this example is an example where you specify the -XX:HitachiCallToString=minimal option.

Figure 5-7 Output example when -XX:+HitachiTrueTypeInLocals option is specified (Simple output format)

The output contents are as follows:

The variable type name is an array of java.lang.Object class or java.lang.Object class but the type name of the actually substituted value is output as the array of java.lang.Thread class and java.lang.Thread class.

Note that you can specify the -XX:+HitachiTrueTypeInLocals option along with the -XX:HitachiCallToString=full option.

5.10.2 When the -XX:+HitachiLocalsInStackTrace Option Is Specified

For each stack frame information of stack trace information in a thread dump, the local variable information in the method corresponding to that stack frame is inserted and output.

The output format and output contents are the same as the contents output to the standard output when you specify -XX:+HitachiLocalsInThrowable.

However, specifying this option with the -XX:+HitachiLocalsInStackTrace option is invalid.

-XX:HitachiCallToString option

The example of Java program and output of the corresponding local variable information within the stack trace are as follows:

Java program example 3

class Example3 {
public static void main(String[] args) {
Example3 e3 = new Example3();
e3.method();
}

synchronized void method() {
int l1 = 1;
float l2 = 2.0f;
String l3 = "local 3";
Character l4 = new Character('X');
Object l5 = new Thread();
Object[] l6 = new Thread[10];

The-thread-dump-is-output-here!
}
}

The example of output is described below. This is an example of the following cases.

The class file is created by specifying the -g option or -g:vars option

-XX:+HitachiLocalSimpleFormat option is specified

-XX:+HitachiTrueTypeInLocals option is specified

Figure 5-8 Output example of the local variable information for example 3 of a Java program

5.11 Event log of Explicit Memory Management functionality

This subsection describes the contents of event log of the Explicit Heap Memory Management functionality.

The event log of Explicit Heap Memory Management functionality is output at the timing when events related to the Explicit Heap Memory Management functionality, such as occurrence of garbage collection, initialization, release, extension of Explicit memory block, moving object to Explicit memory block occur. The output contents differ as per the settings of log output level specified in the Java VM start option.

The event log of the Explicit Heap Memory Management functionality can be used for the following purpose:

Tuning of Explicit HEAP

Debug of application implementing the Explicit Heap Memory Management functionality

Statistics collection

For details on the changes in the size of Explicit heap, number of Explicit memory blocks, and changes in each area size of Java heap, see the event log. Furthermore, event log is output as a text file.

Organization of this section

5.11.1 Output trigger of event log of the Explicit Heap Memory Management functionality

5.11.2 Confirmation method of event log of Explicit Heap Memory Management functionality

5.11.3 Contents output when output level is normal

5.11.4 Contents output when output level is verbose

5.11.5 Contents Output when Output Level is Debug

5.11.1 Output trigger of event log of the Explicit Heap Memory Management functionality

This subsection describes the output trigger for event log of the Explicit Heap Memory Management functionality. The events triggered differ depending on the set log output level.

The log output level comprises of three types; normal, verbose and debug. When you specify verbose, besides the contents output to normal, the contents corresponding to verbose are output. When you specify debug, besides the contents output to verbose, the contents corresponding to debug are output.

The following table describes the correspondence between log output levels and the events that trigger the output. Prefixes output for the corresponding events are also displayed in the following table. See the reference sections for contents output to each event.

Table 5-30 Correspondence between log output levels and events that trigger the output

Log output level | Events that trigger the output | Prefix# | Reference
normal | Garbage collection occurrence (Output Explicit heap usage status) | ENS | 5.11.3(1)
Explicit memory block explicit release process | ENS | 5.11.3(2)
Java heap overflow in Explicit memory block explicit release process | ENS | 5.11.3(3)
Automatic release processing of the explicit memory block | ENS | 5.11.3(4)
Java heap overflow in the automatic release processing for the explicit memory block | ENS | 5.11.3(5)
Error in opening the automatic allocation configuration file for explicit memory management | ENA | 5.11.3(6)
Error in parsing the automatic allocation configuration file for explicit memory management | ENA | 5.11.3(7)
Automatic allocation error in explicit memory management | ENA | 5.11.3(8)
Error in opening the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality | ENO | 5.11.3(9)
Error in parsing the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality | ENO | 5.11.3(10)
verbose | Initialization of Explicit memory block | EVO | 5.11.4(1)
Initialization failure of Explicit memory block | EVO | 5.11.4(2)
Disabling sub status of Explicit memory block | EVO | 5.11.4(3)
Object generation to Explicit memory block | EVS | 5.11.4(4)
Migration to Explicit memory block (Output detail information) | EVS | 5.11.4(5)
Explicit memory block explicit release process (Output detail information) | EVS | 5.11.4(6)
Release reservation of Explicit memory block by finalize | EVO | 5.11.4(7)
Automatic allocation to explicit memory management | EVA | 5.11.4(8)
debug | Migration of object to Java heap by explicit release of Explicit memory block | EDO | 5.11.5(1)
Initialization of Explicit memory block (Output detail information) | EDO | 5.11.5(2)
Details of automatic release processing for the explicit memory block (Output detail information) | EDO | 5.11.5(3)

#

Prefixes are the alphabetic characters (three characters) enclosed in "[" and "]" that are output at the beginning of the log line.

For details on each event, see the uCosminexus Application Server Expansion Guide.

5.11.2 Confirmation method of event log of Explicit Heap Memory Management functionality

This subsection describes the reference method of event log output by the Explicit Heap Memory Management functionality.

Organization of this subsection

(1) Confirmation method of output trigger

(2) Checking methods using log prefix

(3) Signs used in description of output format of event log

(1) Confirmation method of output trigger

Events that trigger the log output are output in [cause:<CAUSE>] format. You can confirm the event triggered by confirming the item.

The following table describes the meaning of character string output to <CAUSE>.

Table 5-31 Meaning of character string output to <CAUSE>

<CAUSE> | Meaning
GC | Copy garbage collection occurrence
Full GC | Full garbage collection occurrence
Reclaim | Explicit memory block explicit release process
Reclaiming | Java heap overflow in Explicit memory block explicit release process
New | Object generation in Explicit memory block
Migrate | Automatic release processing for the explicit memory block
Migrating | Java heap overflow in the automatic release processing for the explicit memory block

However, <CAUSE> is not output in a part of the log.

(2) Checking methods using log prefix

You can use log prefixes such as ENS, EVO to perform checking by filtering the log.

The meaning of prefixes of the Explicit Heap Memory Management functionality is as follows:

"E" of first character indicates that a prefix is for the log of Explicit Heap Memory Management functionality.

Second character indicates log output level. N is output for normal level, V is output for verbose level and D is output for debug level.

The third character indicates whether the memory size of Explicit heap or Java heap will change. The memory size changes if the third character is S. The memory size does not change when third character is O. When O, the names of events occurred are output to log. Also, A indicates the log of the automatic allocation configuration file for the explicit memory management.

For example, when you want to check changes of each heap size, perform filtering by S and when you want to check the occurred event, perform filtering by O.

(3) Signs used in description of output format of event log

The following table describes the signs used in the description of output format.

Table 5-32 Signs used in description of output format

Signs
Usage examples
Meaning

*
X*
Repeat the left side items for minimum zero times.
Usage example indicates that X is repeated for minimum zero times.

?
X?
Repeat the left side items for minimum one time.
Usage example indicates that X is repeated for minimum once.

{n,m}
X{1,5}
Repeat the left side items for minimum n times and maximum m times.
Usage example indicates that X is repeated minimum once and maximum five times.

{
{ABC}*
The range included in "{" and "}" is reference unit at left side of "*", "?", "{n,m}".
Usage example indicates that "ABC" is repeated for minimum zero times.

}

\
None
This sign indicates the places with linefeed for visibility in the manual.
There is no linefeed in the actual output contents.

|
X|Y
This sign indicates either the left side or the right side.
Usage example indicates either X or Y.

.
None
Indicates any character.

...
X|Y...
Repeat minimum once from the line that has same indent as this line and that is nearest to forward match of this line, to the line previous to this line.
Usage example indicates that either of X or Y is repeated minimum once.

In the description of output format, numeric values are expressed by combining signs as in Table 5-32 and signs in Table 5-33.

The following table describes the signs used to indicate numeric values.

Table 5-33 Signs used to indicate numeric values

Sign | Definition | Meaning
<digit> | 0|1|2|3|4|5|6|7|8|9 | Indicates 0 to 9.
<hex> | <digit>|a|b|c|d|e|f | Indicates hexadecimals.
<const> | <const><digit>|<digit> | Indicates positive whole number.
<decimal> | <const>.<digit> | Indicates positive integer (Up to 1st Decimal position).
<ptr64> | 0x<hex><hex><hex><hex><hex><hex><hex><hex><hex><hex><hex><hex><hex><hex><hex><hex> | Indicates 64 bit pointer value.
<ptr32> | 0x<hex><hex><hex><hex><hex><hex><hex><hex> | Indicates 32 bit pointer value.
<ptr> | <ptr64>|<ptr32> | Indicates pointer value.
<letters> | .? | Indicates any character or character string.

Note The signs indicated in Table 5-32 would be the reference unit at left side or right side of "*", "?" or "|". For example, when <digit>|<hex> is mentioned, indicates numeric value from zero to nine or hexadecimal.

5.11.3 Contents output when output level is normal

This subsection describes the contents output for each event when normal is specified in log output levels.

The normal is the log output level specified when there are normal operations.

Organization of this subsection

(1) Garbage collection occurrence (Output Explicit heap usage status)

(2) Explicit memory block explicit release process

(3) Java heap overflow in Explicit memory block explicit release process

(4) Automatic release processing of the explicit memory block

(5) Java heap overflow in the automatic release processing of the explicit memory block

(6) Error in opening the automatic allocation configuration file for Explicit Memory Management

(7) Error in parsing the automatic allocation configuration file for Explicit Memory Management

(8) Automatic allocation error in Explicit Memory Management

(9) Error in opening the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality

(10) Error in parsing the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality

(1) Garbage collection occurrence (Output Explicit heap usage status)

Output Explicit heap usage status when garbage collection occurred.

Output this log when there is no object for migration from Java heap to Explicit heap. <EH_USED_BF> and <EH_USED_AF> would have same value when there is no object to migrate to Explicit heap.

(a) Output trigger

Output trigger is the termination of garbage collection.

(b) Output format

[ENS]<ctime>[EH: <EH_USED_BF>-><EH_USED_AF>(<EH_TOTAL>/<EH_MAX>)][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>][cause:<CAUSE>][CF: <CF_CNT>]

(c) Output items

The following table describes each item indicated in (b) output format.

Table 5-34 Output items (Garbage collection occurrence (Output Explicit heap usage status))

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates occurrence date and time of garbage collection. Output in the format same as extended verbosegc information.
Output in millisecond units when the -XX:+HitachiOutputMilliTime option is set.

<EH_USED_BF>
<const>K
Output used size of Explicit heap before execution of garbage collection. The unit is kilo bytes.

<EH_USED_AF>
<const>K
Output used size of Explicit heap after execution of garbage collection. The unit is kilo bytes.

<EH_TOTAL>
<const>K
Output secured memory size of Explicit heap after execution of garbage collection. The unit is kilo bytes.

<EH_MAX>
<const>K
Output Explicit heap maximum size. The unit is kilo bytes.

<AC_NUM>
<const>
Output number of Explicit memory blocks whose sub status is Enable after garbage collection execution.

<FL_NUM>
<const>
Normally 0 is output

<DA_NUM>
<const>
Output number of Explicit memory blocks whose sub status is Disable after garbage collection execution.

<CAUSE>
GC|Full GC
Output type of garbage collection that is triggered.
GC indicates copy garbage collection and Full GC indicates full garbage collection.

<CF_CNT>
<const>
Output the failure count of initialization of Explicit memory blocks from the occurrence of previous garbage collection up to occurrence of current garbage collection.

(d) Example of output

Output example

[ENS]<Thu Oct 21 14:55:50 2007>[EH: 150528K->162816K(162816K/1048576​K)][E/F/D: 200/0/0][cause:GC][CF: 0]

You can check the following contents in this output example:

Output trigger is copy garbage collection occurred on October 21, 2007 (Friday) 14:55:50.

Migration to Explicit heap occurred in garbage collection and used size of Explicit heap changed from 150,528K to 162,816K.

The secured size of Explicit heap after occurrence of garbage collection is 162,816K. Maximum size of Explicit heap is 1,048,576K.

After the occurrence of garbage collection, Explicit memory blocks whose sub status is Enable are 200 blocks.

(2) Explicit memory block explicit release process

Output usage status of the Explicit heap or Java heap after termination of the explicit release process of Explicit memory block.

(a) Output trigger

The Explicit release process of Explicit memory block.

The Explicit release of Explicit memory block occurs immediately after garbage collection. The following log is output after log described in (1) Garbage collection occurrence (Output Explicit heap usage status).

(b) Output format

[ENS]<ctime>[EH: <EH_USED_BF>-><EH_USED_AF>(<EH_TOTAL>/<EH_MAX>), <ELAPSED> secs][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>]\
[DefNew::Eden: <ED_USED_BF>-><ED_USED_AF>(<ED_TOTAL>)][DefNew::Survivor: <SV_USED_BF>-><SV_USED_AF>(<SV_TOTAL>)]\
[Tenured: <TN_USED_BF>-><TN_USED_AF>(<TN_TOTAL>)][User: <USERCPU> secs][Sys: <SYSCPU> secs][cause:<CAUSE>]

Note: The following items are not output in HP-UX (IPF):

[User: <USERCPU> secs]: User CPU time

[Sys: <SYSCPU> secs]: System CPU time

(c) Output items

The following table describes each item indicated in (b) output format.

Table 5-35 Output items (Explicit memory block explicit release process)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the occurrence date and time of the Explicit memory block explicit release process. Output in the format same as extended verbosegc information.
Output in milli-seconds unit when -XX:+HitachiOutputMilliTime option is set.

<EH_USED_BF>
<const>K
Output used size of the Explicit heap before the Explicit memory block explicit release process. The unit is kilo bytes.

<EH_USED_AF>
<const>K
Output used size of the Explicit heap after the Explicit memory block explicit release process. The unit is kilo bytes.

<EH_TOTAL>
<const>K
Output secured size of the Explicit heap after the Explicit memory block explicit release process. The unit is kilo bytes.

<EH_MAX>
<const>K
Output Explicit heap maximum size. The unit is kilo bytes.

<ELAPSED>
<time>
Output time required for the Explicit memory block explicit release process. The unit is seconds.

<AC_NUM>
<const>
Output number of Explicit memory blocks whose sub status is Enable after execution of the Explicit memory block explicit release process.

<FL_NUM>
<const>
Normally 0 is output

<DA_NUM>
<const>
Output number of Explicit memory blocks whose sub status is Disable after execution of the Explicit memory block explicit release process.

<ED_USED_BF>
<const>K
Output used size of the Eden area before executing the Explicit memory block explicit release process. The unit is kilo bytes.

<ED_USED_AF>
<const>K
Output used size of the Eden area after executing the Explicit memory block explicit release process. The unit is kilo bytes.

<ED_TOTAL>
<const>K
Output secured size of the Eden area after executing the Explicit memory block explicit release process. The unit is kilo bytes.

<SV_USED_BF>
<const>K
Output used size of the Survivor area before executing the Explicit memory block explicit release process. The unit is kilo bytes.

<SV_USED_AF>
<const>K
Output used size of the Survivor area after executing the Explicit memory block explicit release process. The unit is kilo bytes.

<SV_TOTAL>
<const>K
Output secured size of the Survivor area after executing the Explicit memory block explicit release process. The unit is kilo bytes.

<TN_USED_BF>
<const>K
Output used size of the Tenured area before executing the Explicit memory block explicit release process. The unit is kilo bytes.

<TN_USED_AF>
<const>K
Output used size of the Tenured area after executing the Explicit memory block explicit release process. The unit is kilo bytes.

<TN_TOTAL>
<const>K
Output secured size of the Tenured area after executing the Explicit memory block explicit release process. The unit is kilo bytes.

<USERCPU>
<time>
Output the user CPU time taken by the explicit release processing of the Explicit memory block. The unit is seconds. This item is not output in HP-UX (IPF).

<SYSCPU>
<time>
Output the system CPU time taken by the explicit release processing of the Explicit memory block. The unit is seconds. This item is not output in HP-UX (IPF).

<CAUSE>
Reclaim
Output as Reclaim. Reclaim is the log output in the explicit release processing of the Explicit memory block.

(d) Example of output

Output example:

[ENS]<Tue Jul 24 01:23:51 2007>[EH: 150528K->149528K(162816K/1048576​K), 0.1129602​ secs][E/F/D: 523/0/0]\
[DefNew::Eden: 0K->0K(243600K)][DefNew::Survivor: 0K->0K(17400K)][Tenured: 103400K->103400K(556800K)]\
[User: 0.0900000​ secs]#[Sys: 0.0200000​ secs]#[cause:Reclaim]

#: This item is not output in HP-UX (IPF).

You can check the following contents in this output example:

Output trigger is the Explicit memory block explicit release process occurred on July 24, 2007 (Tuesday) 1:23:51.

Explicit heap used size reduced from 150,528K to 149,528K by the explicit release process of the Explicit memory block.

Secured size of Explicit heap after Explicit memory block explicit release process is 162,816K. Maximum size of Explicit heap is 1,048,576K.

The time for the explicit release process of Explicit memory block is 0.1129602 seconds.

There are 523 Explicit memory blocks whose sub status is Enable after Explicit memory block explicit release process.

There are no changes in each area of Java heap by the Explicit memory block explicit release process. In other words, there is no object moved to Java heap.

The explicit release processing of the Explicit memory block took 0.0900000 seconds of the user CPU time, and 0.0200000 seconds of the system CPU time. Note that these values are not output in HP-UX (IPF).

(3) Java heap overflow in Explicit memory block explicit release process

The object moves to Java heap in the explicit release process of Explicit memory block and the status is output when Java heap overflows. Output the usage status of Explicit heap and Java heap when Java heap overflows.

(a) Output trigger

The object moves from Explicit heap to Java heap in the explicit release process of the Explicit memory block and output is triggered when Java heap overflows.

(b) Output format

[ENS]<ctime>[EH: <EH_USED_BF>-><EH_USED_AF>(<EM_TOTAL>/<EH_MAX>), <ELAPSED> secs][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>]\
[DefNew::Eden: <ED_USED_BF>-><ED_USED_AF>(<ED_TOTAL>)][DefNew::Survivor: <SV_USED_BF>-><SV_USED_AF>(<SV_TOTAL>)]\
[Tenured: <TN_USED_BF>-><TN_USED_AF>(<TN_TOTAL>)][User: <USERCPU> secs][Sys: <SYSCPU> secs][cause:<CAUSE>]

Note The following items are not output in HP-UX (IPF):

[User: <USERCPU> secs]: User CPU time

[Sys: <SYSCPU> secs]: System CPU time

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-36 Output items (Java heap overflow in the explicit release process of the Explicit memory block)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the occurrence date and time of the Explicit memory block explicit release process. Output in the format same as extended verbosegc information.
Output in milli-seconds unit when -XX:+HitachiOutputMilliTime option is set.

<EH_USED_BF>
<const>K
Output used size of the Explicit heap before the Explicit memory block explicit release process. The unit is kilo bytes.

<EH_USED_AF>
<const>K
Output used size of the Explicit heap after Java heap overflow. When Java heap overflows, the explicit release process of Explicit memory block is not executed and hence the value is always same as <EH_USED_BF>. The unit is kilo bytes.

<EH_TOTAL>
<const>K
Output secured size of the Explicit heap after Java heap overflow. The unit is kilo bytes.

<EH_MAX>
<const>K
Output Explicit heap maximum size. The unit is kilo bytes.

<ELAPSED>
<time>
Output time from start of the Explicit memory block explicit release process to Java heap overflow. The unit is seconds.

<AC_NUM>
<const>
Output number of the Explicit memory blocks whose sub status is Enable after Java heap overflow.

<FL_NUM>
<const>
Normally 0 is output

<DA_NUM>
<const>
Output number of the Explicit memory blocks whose sub status is Disable after Java heap overflow.

<ED_USED_BF>
<const>K
Output used size of the Eden area before executing the Explicit memory block explicit release process. The unit is kilo bytes.

<ED_USED_AF>
<const>K
Output used size of the Eden area after Java heap overflow. The unit is kilo bytes.

<ED_TOTAL>
<const>K
Output secured size of the Eden area after Java heap overflow. The unit is kilo bytes.

<SV_USED_BF>
<const>K
Output used size of the Survivor area before executing the Explicit memory block explicit release process. The unit is kilo bytes.

<SV_USED_AF>
<const>K
Output used size of the Survivor area after Java heap overflow. The unit is kilo bytes.

<SV_TOTAL>
<const>K
Output secured size of the Survivor area after Java heap overflow. The unit is kilo bytes.

<TN_USED_BF>
<const>K
Output used size of the Tenured area before executing the Explicit memory block explicit release process. The unit is kilo bytes.

<TN_USED_AF>
<const>K
Output used size of the Tenured area after Java heap overflow. The unit is kilo bytes.

<TN_TOTAL>
<const>K
Output secured size of the Tenured area after Java heap overflow. The unit is kilo bytes.

<USERCPU>
<time>
Output the user CPU time taken from the start of the explicit release processing of the Explicit memory block until Java heap overflows. The unit is seconds. This item is not output in HP-UX (IPF).

<SYSCPU>
<time>
Output the system CPU time taken from the start of the explicit release processing of the Explicit memory block until Java heap overflows. The unit is seconds. This item is not output in HP-UX (IPF).

<CAUSE>
Reclaiming
Output as "Reclaiming". Reclaiming is the log output by Java heap overflow in the release process of Explicit memory block.

(d) Example of output

Output example:

[ENS]<Tue Jul 24 01:23:51 2007>[EH: 706728K->706728K(706728K/1048576​K), 0.1129602​ secs][E/F/D: 523/0/0]\
[DefNew::Eden: 0K->243600K(243600K)][DefNew::Survivor: 0K->17400K(17400K)][Tenured: 278000K->556800K(556800K)]\
[User: 0.0900000​ secs]#[Sys: 0.0200000​ secs]#[cause:Reclaiming]
[ENS]<Tue Jul 24 01:23:51 2007>[EH: 706728K->706728K(706728K/1048576​K)][E/F/D: 523/0/0][cause:Full GC][CF: 0]
[ENS]<Tue Jul 24 01:23:53 2007>[EH: 706728K->148528K(148528K/1048576​K), 0.0123405​ secs][E/F/D: 521/0/0]\
[DefNew::Eden: 0K->0K(243600K)][DefNew::Survivor: 0K->0K(17400K)][Tenured: 551800K->552800K(556800K)]\
[User: 0.0090000​ secs]#[Sys: 0.0020000​ secs]#[cause:Reclaim]

#:

This item is not output in HP-UX (IPF).

You can confirm the following contents in this output example:

Output trigger is the Java heap overflow in the Explicit memory block explicit release process occurred on July 24, 2007(Tuesday) 1:23:51.

The time from starting the explicit release process of Explicit memory block to Java heap overflow is 0.1129602 seconds.

There are 523 Explicit memory blocks whose sub status is Enable after Java heap overflow.

5,398,00K moved to Java heap in the explicit release process of Explicit memory block causing Java heap overflow.

The process from the start of the explicit release processing of the Explicit memory block until the overflowing of the Java heap took 0.0900000 seconds of the user CPU time, and 0.0200000 seconds of the system CPU time. Note that these values are not output in HP-UX (IPF).

In the output contents of output example, third line ENS onwards is the log output by the explicit release process of Explicit memory block. Always output the log of Explicit memory block release process after log output by Java heap overflow. In this example, the following contents are output:

Restarted the explicit release process of Explicit memory block on July 24, 2007 1:23:53 and output this log.

The used size of Explicit heap reduced from 706,728K to 148,528K in the explicit release process of Explicit memory block that was restarted.

The secured size of Explicit heap after executing the explicit release process of restarted Explicit memory block is 148,528K. Maximum size of Explicit heap is 1,048,576K.

The time for the explicit release process of restarted Explicit memory block is 0.0123405 seconds.

There are 521 Explicit memory blocks whose sub status is Enable after the restarted Explicit memory block explicit release process.

The usage size of Tenured area of Java heap increased from 551,800K to 552,800K as a result of the explicit release process of restarted Explicit memory block.

The explicit release processing of the restarted Explicit memory block took 0.0090000 seconds of the user CPU time and 0.0020000 seconds of the system CPU time. Note that these values are not output in HP-UX (IPF).

(4) Automatic release processing of the explicit memory block

The usage status of the explicit memory and explicit memory block is output from the automatic release - automatic reserve or automatic release - explicit reserve of the explicit memory block up to the automatic release processing of the explicit memory block.

(a) Output trigger

The log is output when the automatic release - automatic reserve or automatic release - explicit reserve of the explicit memory block and automatic release processing of the Explicit memory block occur.

(b) Output format

[ENS]<ctime>[EH: <EH_USED_BF>-><EH_USED_AF>(<EH_TOTAL>/<EH_MAX>), <ELAPSED> secs][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>]\
[DefNew::Eden: <ED_USED_BF>-><ED_USED_AF>(<ED_TOTAL>)][DefNew::Survivor: <SV_USED_BF>-><SV_USED_AF>(<SV_TOTAL>)]\
[Tenured: <TN_USED_BF>-><TN_USED_AF>(<TN_TOTAL>)][target:<EH_MIG_TRG>/<EH_MIG_DED>/<EH_MIG_LIV>]\
[User: <USERCPU> secs][Sys: <SYSCPU> secs][cause:<CAUSE>]

Note: The following items are not output in HP-UX (IPF):

[User: <USERCPU> secs]: User CPU time

[Sys: <SYSCPU> secs]: System CPU time

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-37 Output items (Automatic release processing of the explicit memory block)

Output items | Output contents | Meaning
<ctime> | <letters> | Indicates the occurrence date and time of automatic release - automatic reserve of the explicit memory block. Output with the format same as the extended verboseGC functionality. Output in milliseconds, when the HitachiOutputMilliTime option is set up.
<EH_USED_BF> | <const>K | Outputs the used size of the explicit memory before the automatic release processing of the explicit memory block. The unit is kilobytes.
<EH_USED_AF> | <const>K | Outputs the used size of the explicit memory after the automatic release processing of the explicit memory block. The unit is kilobytes.
<EH_TOTAL> | <const>K | Outputs the secured size of the explicit memory after the automatic release processing of the Explicit memory block. The unit is kilobytes.
<EH_MAX> | <const>K | Outputs the maximum explicit memory size. The unit is kilobytes.
<ELAPSED> | <time> | Outputs the time from the start of the automatic release-automatic reserve process of the explicit memory block up to the end of the automatic release processing. The unit is seconds.
<AC_NUM> | <const> | Outputs the number of valid explicit memory blocks that have the Enable sub state, after the automatic release processing of the explicit memory block.
<FL_NUM> | <const> | Always outputs 0.
<DA_NUM> | <const> | Outputs the number of valid explicit memory blocks that have the Disable sub state, after the automatic release processing of the explicit memory block.
<ED_USED_BF> | <const>K | Outputs the used size of the Eden area before the automatic release processing of the explicit memory block. The unit is kilobytes.
<ED_USED_AF> | <const>K | Outputs the used size of the Eden area after the automatic release processing of the explicit memory block. The unit is kilobytes.
<ED_TOTAL> | <const>K | Outputs the secured size of the Eden area after the automatic release processing of the explicit memory block. The unit is kilobytes.
<SV_USED_BF> | <const>K | Outputs the used size of the Survivor area before the automatic release processing of the explicit memory block. The unit is kilobytes.
<SV_USED_AF> | <const>K | Outputs the used size of the Survivor area after the automatic release processing of the explicit memory block. The unit is kilobytes.
<SV_TOTAL> | <const>K | Outputs the secured size of the Survivor area after the automatic release processing of the explicit memory block. The unit is kilobytes.
<TN_USED_BF> | <const>K | Outputs the used size of the Tenured area before the automatic release processing of the Explicit memory block. The unit is kilobytes.
<TN_USED_AF> | <const>K | Outputs the used size of the Tenured area after the automatic release processing of the explicit memory block. The unit is kilobytes.
<TN_TOTAL> | <const>K | Outputs the secured size of the Tenured area after the automatic release processing of the explicit memory block. The unit is kilobytes.
<EH_MIG_TRG> | <const>K | Outputs the used size of the explicit memory for which the automatic release processing of the explicit memory block was executed. The unit is kilobytes.
<EH_MIG_DED> | <const>K | Outputs the used size of the explicit memory that decreased due to the execution of the automatic release processing of the explicit memory block. The unit is kilobytes.
<EH_MIG_LIV> | <const>K | Outputs the used size of the explicit memory that did not decrease in spite of the execution of the automatic release processing of the explicit memory block. The unit is kilobytes.
<USERCPU> | <time> | Outputs the user CPU time taken from the start of the automatic release - automatic reserve processing of the Explicit memory block until the end of the automatic release processing. The unit is seconds. This item is not output in HP-UX (IPF).
<SYSCPU> | <time> | Outputs the system CPU time from the start of the automatic release - automatic reserve processing of the Explicit memory block until the end of the automatic release processing. The unit is seconds. This item is not output in HP-UX (IPF).
<CAUSE> | Migrate | Outputs Migrate. Indicates that the log was output due to the automatic release processing of the explicit memory block.

(d) Example of output

The following is an output example:

[ENS]<Tue Jul 14 02:31:22 2009>[EH: 256512K->256128K(256256K/1048576​K), 0.1124626​ secs][E/F/D: 423/0/0]\
[DefNew::Eden: 0K->0K(243600K)][DefNew::Survivor: 0K->0K(17400K)][Tenured: 103400K->103400K(556800K)][target:584K/384K/200K]\
[User: 0.0900000​ secs]#[Sys: 0.0200000​ secs]# [cause:Migrate]

#:

This item is not output in HP-UX (IPF).

You can check the following details in this output example:

The output trigger is the automatic release processing of the explicit memory block in the garbage collection that occurred on July 14, 2009 (Tuesday) at 2:31:22.

The used size of explicit memory changed from 256,512K to 256,128K due to the automatic release processing.

The secured size of explicit memory after the automatic release processing is 256,256K and the maximum size is 1,048,576K.

The time taken for the automatic release processing was 0.1124626 seconds.

There are 423 explicit memory blocks whose sub-state is Enable after the automatic release processing.

Among the used size of explicit memory, 584K were automatically released using the automatic release processing. The size that decreased was 384K and the size that did not decrease was 200K.

There are no changes in the Java heap areas due to the automatic release processing for the explicit memory block.

The automatic release processing took 0.0900000 seconds of the user CPU time, and 0.0200000 seconds of the system CPU time. Note that these values are not output in HP-UX (IPF)

(5) Java heap overflow in the automatic release processing of the explicit memory block

During the automatic release processing of the explicit memory block, objects were moved to the Java heap. In this case, the usage status of the explicit memory and the Java heap is output when the Java heap overflows.

The overflow of Java heap indicates that while moving the objects to the Java heap, there was no free space in the Java heap. For details, see 8. Preventing Full Garbage Collection by Using the Explicit Memory Management Functionality in the uCosminexus Application Server Expansion Guide.

(a) Output trigger

If there is a shortage of free space in the explicit memory area during the automatic release processing of the explicit memory block, the objects are moved to the Java heap. A log is output, when the Java heap overflows.

(b) Output format

[ENS]<ctime>[EH: <EH_USED_BF>-><EH_USED_AF>(<EH_TOTAL>/<EH_MAX>), <ELAPSED> secs][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>]\
[DefNew::Eden: <ED_USED_BF>-><ED_USED_AF>(<ED_TOTAL>)][DefNew::Survivor: <SV_USED_BF>-><SV_USED_AF>(<SV_TOTAL>)]\
[Tenured: <TN_USED_BF>-><TN_USED_AF>(<TN_TOTAL>)][target:<EH_MIG_TRG>/<EH_MIG_DED>/<EH_MIG_LIV>]\
[User: <USERCPU> secs][Sys: <SYSCPU> secs][cause:<CAUSE>]

Note:

The following items are not output in HP-UX (IPF):

[User: <USERCPU> secs]: User CPU time

[Sys: <SYSCPU> secs]: System CPU time

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-38 Output items (Java heap overflow in the automatic release processing for the explicit memory block)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the occurrence date and time of the automatic release processing of the explicit memory block. Output in the format same as would output for the extended verboseGC functionality. Output in milliseconds when the HitachiOutputMilliTime option is set up.

<EH_USED_BF>
<const>K
Outputs the used size of the explicit memory before the automatic release processing of the explicit memory block. The unit is kilobytes.

<EH_USED_AF>
<const>K
Outputs the used size of the explicit memory after the Java heap overflows. The unit is kilobytes.

<EH_TOTAL>
<const>K
Outputs the secured size of explicit memory after the Java heap overflows. The unit is kilobytes.

<EH_MAX>
<const>K
Outputs the maximum explicit memory size. The unit is kilobytes.

<ELAPSED>
<time>
Outputs the time from the start of the automatic release processing of the explicit memory block to the overflow of the Java heap. The unit is seconds.

<AC_NUM>
<const>
Outputs the number of explicit memory blocks that have the Enable sub state after the automatic release processing of the explicit memory block.

<FL_NUM>
<const>
Always outputs 0.

<DA_NUM>
<const>
Outputs the number of explicit memory blocks that have the Disable sub state after the Java heap overflows.

<ED_USED_BF>
<const>K
Outputs the used size of the Eden area before the automatic release processing of the explicit memory block. The unit is kilobytes.

<ED_USED_AF>
<const>K
Outputs the used size of the Eden area after the Java heap overflows. The unit is kilobytes.

<ED_TOTAL>
<const>K
Outputs the secured size of the Eden area after the Java heap overflows. The unit is kilobytes.

<SV_USED_BF>
<const>K
Outputs the used size of the Survivor area before the automatic release processing of the explicit memory block. The unit is kilobytes.

<SV_USED_AF>
<const>K
Outputs the used size of the Survivor area after the Java heap overflows. The unit is kilobytes.

<SV_TOTAL>
<const>K
Outputs the secured size of the Survivor area after the Java heap overflows. The unit is kilobytes.

<TN_USED_BF>
<const>K
Outputs the used size of the Tenured area before the automatic release processing of the explicit memory block. The unit is kilobytes.

<TN_USED_AF>
<const>K
Outputs the used size of the Tenured area after the Java heap overflows.
The unit is kilobytes.

<TN_TOTAL>
<const>K
Outputs the secured size of the Tenured area after the Java heap overflows. The unit is kilobytes.

<EH_MIG_TRG>
<const>K
Outputs the used size of the explicit memory for which the automatic release processing of the explicit memory block was executed. The unit is kilobytes.

<EH_MIG_DED>
<const>K
Outputs the used size of explicit memory that has decreased due to the execution of the automatic release processing of the explicit memory block, until the Java heap overflowed. The unit is kilobytes. Always outputs OK.

<EH_MIG_LIV>
<const>K
Outputs the used size of the explicit memory that did not decrease due to the execution of the automatic release processing of the explicit memory block, until the Java heap overflowed. The unit is kilobytes. Does not include the size of the objects that caused the Java heap overflow.

<USERCPU>
<time>
Outputs the user CPU time taken from the start of the automatic release processing of the Explicit memory block until the overflowing of the Java heap. The unit is seconds. This item is not output in HP-UX (IPF).

<SYSCPU>
<time>
Outputs the system CPU time taken from the start of the automatic release processing of the Explicit memory block until the overflowing of the Java heap. The unit is seconds. This item is not output in HP-UX (IPF).

<CAUSE>
Migrating
Outputs Migrating. Indicates that the log was output due to the Java heap overflow in the automatic release processing of the explicit memory block.

(d) Example of output

An output example is as follows:

[ENS]<Tue Jul 14 02:31:22 2009>[EH: 706728K->706728K(706728K/706728K), 0.1129602​ secs][E/F/D: 522/0/1]\
[DefNew::Eden: 0K->243600K(243600K)][DefNew::Survivor: 0K->17400K(17400K)][Tenured: 278000K->556800K(556800K)]\
[target:372000K/0K/339800K] [User: 0.0900000​ secs]#[Sys: 0.0200000​ secs]#[cause:Migrating]

#:

This item is not output in HP-UX (IPF).

You can check the following details in this output example:

The output trigger is the Java heap overflow in the automatic release processing for the explicit memory block in the garbage collection that occurred on July 14, 2009 (Tuesday) at 2:31:22.

The used size of explicit memory changed from 706,728K due to the automatic release processing.

The secured size of explicit memory after the automatic release processing is 706,728K and the maximum size is 706,728K.

The time taken for the automatic release processing was 0.1129602 seconds.

There are 522 explicit memory blocks that have Enable sub state after the automatic release processing. There is one explicit memory block that has Disable sub state.

Among the used size of explicit memory, 372,000K were automatically released using the automatic release processing. The size that did not decrease until Java heap overflow was 339,800K.

Due to Java heap overflow during the automatic release processing, the used size of Java heap reached the upper limit for each area.

The process from the start of the automatic release processing of the Explicit memory block until the overflowing of the Java heap took 0.0900000 seconds of the user CPU time, and 0.0200000 seconds of the system CPU time. Note that these values are not output in HP-UX (IPF).

(6) Error in opening the automatic allocation configuration file for Explicit Memory Management

An error message is output, when an attempt to open or read the automatic allocation configuration file for Explicit Memory Management fails.

(a) Output trigger

The error message is output when an attempt to open or read the automatic allocation configuration file for Explicit Memory Management fails. For example, when the file does not exist, the user does not have the permission to read the file, or an unexpected IO error occurs while reading the file.

(b) Output format

[ENA]<ctime> failed to open file. [file=<FILENAME>]

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-39 Output items (Error in opening the automatic allocation configuration file for Explicit Memory Management)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the occurrence time, when an attempt to open the automatic allocation configuration file using Explicit Memory Management has failed. Output with the format same as would output for the extended verboseGC functionality. Output in milliseconds, when the HitachiOutputMilliTime option is set up.

<FILENAME>
<letters>
Outputs the name of the automatic allocation configuration file that has failed to open (does not include the directory name).

(d) Example of output

An output example is as follows:

[ENA]<Tue Jul 24 01:23:51 2007> failed to open file. [file=usrexmem.cfg]

You can check the following details in this output example:

An attempt to open the automatic allocation configuration file for Explicit Memory Management failed on July 24, 2007 (Tuesday) at 1:23:51.

(7) Error in parsing the automatic allocation configuration file for Explicit Memory Management

An error message is output, when a line that failed in the parsing of the automatic allocation configuration file for Explicit Memory Management exists.

(a) Output trigger

The error message is output when a line that failed in the parsing of the automatic allocation configuration file for Explicit Memory Management exists. If there are coding format errors in multiple lines of the file, the log is output several times.

(b) Output format

[ENA]<ctime> parsed error line. [file=<FILENAME> line=<LINENO>]

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-40 Output items (Error in parsing the automatic allocation configuration file for Explicit Memory Management)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the time when an attempt to parse the automatic allocation configuration file using the Explicit Heap Memory Management functionality has failed. Output with the format same as would output for the extended verboseGC functionality. Output in milliseconds, when the HitachiOutputMilliTime option is set up.

<FILENAME>
<letters>
Outputs the name of the automatic allocation configuration file for which file parsing failed (does not include the directory name).

<LINENO>
<const>
Outputs the line number where the parsing failed.

(d) Example of output

An output example is as follows:

[ENA]<Tue Jul 24 01:23:51 2007> parsed error line. [file=usrexmem.cfg line=25]

You can check the following details in this example of output:

The parsing of the automatic allocation configuration file for the Explicit Heap Memory Management functionality failed in the 25th line on July 24, 2007 (Tuesday) at 1:23:51.

(8) Automatic allocation error in Explicit Memory Management

An error message is output, when a class specified by the Explicit Heap Memory Management functionality fails to allocate automatically to Explicit Memory Management.

(a) Output trigger

The error message is output, when a class specified by the Explicit Heap Memory Management functionality fails to allocate automatically to Explicit Memory Management.

(b) Output format

[ENA]<ctime> creation <CLASS_LIST> class's object in explicit memory is failed. [target=<CLASS_METHOD> \
detail=<MESSAGE>]

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-41 Output items (Automatic allocation error in Explicit Memory Management)

Output items | Output contents | Meaning
<ctime> | <letters> | Indicates the occurrence time when an attempt of the automatic allocation using Explicit Memory Management has failed. Output with the format same as would output for the extended verboseGC function. Output in milliseconds, when the HitachiOutputMilliTime option is set.
<CLASS_LIST> | <letters> | Outputs the list of fully qualified class names of the objects for which an attempt of the automatic allocation using Explicit Memory Management has failed. The list might be blank.
<CLASS_METHOD> | <letters> | Outputs the fully qualified names of the classes for which an attempt of the automatic allocation using Explicit Memory Management has failed. The method names indicating more detailed failure locations might also be output.
<MESSAGE> | <letters> | Outputs a detailed message indicating the cause of the failure during the automatic allocation using Explicit Memory Management.

(d) Example of output

An output example is as follows:

[ENA]<Tue Jul 24 01:23:51 2007> creation java.util.HashMap, java.util.LinkedList \
class's object in explicit memory is failed. [target=com.sample.MainClass.main \
detail=Invalid class file format. (max_stack = 65536, max = 65535, min = 0)]

You can check the following details in this output example:

With the Explicit Heap Memory Management functionality, an attempt to automatically allocate the class jp.co.sample.Main on the explicit memory management using has failed on July 24, 2007 (Tuesday) at 1:23:51.

(9) Error in opening the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality

When an attempt to open and read the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality fails, an error message is output.

(a) Output trigger

The error message is output when an attempt to open and read the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality fails. For example, this includes cases such as when the file does not exist, the user does not have the permission to read the file, and an unexpected IO error occurs while the file is being read.

(b) Output format

[ENO]<ctime> failed to open file. [<TYPE>] [file=<FILENAME>]

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-42 Output items (Error in opening the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality)

Output items
Output contents
Meaning

<ctime>
<letters>
Specifies the time at which the configuration file failed to open. The time is output in the same format as the time output by the extended VerboseGC functionality.
If the HitachiOutputMilliTime option is set up, the time is output in milliseconds.

<TYPE>
SYS|USR|DEF
Outputs the type of the configuration file that could not be opened and read.
SYS indicates the configuration file provided with the system, USR indicates the configuration file with the file path specified in the JavaVM invocation option, and DEF indicates the configuration file existing in the default file path of the JavaVM invocation option.

<FILENAME>
<letters>
Outputs the name of the configuration file that could not be opened (does not include the directory name).

(d) Example of output

An example of output is as follows:

[ENO]<Fri Aug 10 17:41:51 2012> failed to open file. [USR] [file=javamove.cfg]

You can check the following details in this example of output:

The configuration file with the file path specified in the JavaVM invocation option failed to open on August 10, 2012 (Friday) at 17:41:51.

(10) Error in parsing the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality

If there is a line in which the parsing of the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality has failed, an error message is output.

(a) Output trigger

The error message is output if there is a line in which the parsing of the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality has failed. If a coding format error exists in multiple lines of a file, the log is output multiple times.

(b) Output format

[ENO]<ctime> parsed error line. [TYPE] [file=<FILENAME> line=<LINENO>]

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-43 Output items (Parsing error in the automatic allocation configuration file for Explicit Memory Management)

Output items
Output contents
Meaning

<ctime>
<letters>
Specifies the time at which the parsing of the configuration file of the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality failed. The time is output in the same format as the time output by the extended verboseGC functionality. If the HitachiOutputMilliTime option is set up, the time is output in milliseconds.

<TYPE>
SYS|USR|DEF
Outputs the type of configuration file for which the file parsing failed.
SYS indicates the configuration file provided with the system, USR indicates the configuration file with the file path specified in the JavaVM invocation option, and DEF indicates the configuration file existing in the default file path of the JavaVM invocation option.

<FILENAME>
<letters>
Outputs the name of the configuration file for which the file parsing failed (does not include the directory name).

<LINENO>
<const>
Outputs the line number for which the parsing has failed.

(d) Example of output

An example of output is as follows:

[ENO]<Fri Aug 10 17:41:51 2012> parsed error line. [USR] [file=javamove.cfg line=25]

You can check the following details in this example of output:

The parsing of the configuration file with the file path specified in the JavaVM invocation option failed in the 25th line on August 10, 2012 (Friday) at 17:41:51.

5.11.4 Contents output when output level is verbose

This subsection describes the contents output for each event when you specify verbose in the log output level. Verbose is a log output level to output detail information required for the error analysis.

Supplement

In verbose, besides contents output for normal, detail log is output for contents that are not output in normal. The log output would cost some overheads and there might be the degradation in throughput, if verbose is specified for normal operations.

Organization of this subsection

(1) Initialization of Explicit memory block

(2) Initialization failure of Explicit memory block

(3) Disable of sub status of Explicit memory block

(4) Object generation to Explicit memory block

(5) Moving to Explicit memory block (Output detail information)

(6) Explicit memory block explicit release process (Output detail information)

(7) Release reservation of Explicit memory block by finalize

(8) Automatic allocation to Explicit Memory Management

(1) Initialization of Explicit memory block

When you initialize the Explicit memory block newly, the name, ID and type of initialized Explicit memory block is output.

(a) Output trigger

Initialization of Explicit memory block.

(b) Output format

[EVO]<ctime>[Created]["<EM_NAME>" eid=<EID>(<EM_PTR>)/<EM_TYPE>]

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-44 Output items (Initialization of Explicit memory block)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the date and time on which Explicit memory block was initialized. Output in the format same as extended verbosegc information.
Output in milli-seconds unit when -XX:+HitachiOutputMilliTime option is set.

<EM_NAME>
<letters>
Output name of initialized Explicit memory block.
The output contents are uncertain when multi byte characters are included in name of Explicit memory block (Usually garbled and output).

<EID>
<const>
Output ID of initialized Explicit memory block.

<EM_PTR>
<ptr>
Output value that indicates internal status of Explicit memory block.

<EM_TYPE>
R|B
Output type of initialized Explicit memory block.
R indicates Explicit memory block used internally in Application Server. B indicates the type of the Explicit memory block in JavaVM.

(d) Example of output

Output example:

[EVO]<Tue Jul 24 01:23:51 2007>[Created]["BasicExplicitMemory-2" eid=2(0x1234568​)/B]

You can confirm the following contents in this output example:

Output trigger is the initialization of Explicit memory block executed on July 24. 2007 (Tuesday) 1:23:51.

The name of initialized Explicit memory block is BasicExplicitMemory-2.

(2) Initialization failure of Explicit memory block

Output when an attempt to initialize Explicit memory block failed while initializing Explicit memory block. The cause for failure is that the Explicit memory blocks have reached the maximum count. Output the number of Explicit memory blocks and stack trace of Java program that failed in initialization.

This log is output on multiple lines. This log is output asynchronously with the execution of the Java program. Hence, there are cases when some other log is output within the lines of this log. However, other logs are not output within one line.

(a) Output trigger

The output is triggered when Explicit memory block reaches the upper limit of Explicit memory blocks and when an attempt to initialize the Explicit memory block fails.

(b) Output format

[EVO]<ctime>[Creation failed][EH: <EH_USED>(<EH_GARB>)/<EH_TOTAL>/<EH_MAX>][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>][Thread: <TH_PTR>]
[EVO][Thread: <TH_PTR>] at <FRAME><SOURCE>
...

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-45 Output contents (Initialization failure of Explicit memory block)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates failure date and time of initialization of Explicit memory block. Output in the format same as extended verbosegc information.
Output in milli-seconds unit when -XX:+HitachiOutputMilliTime option is set.

<EH_USED>
<const>K
Output used size of Explicit heap when failed in initialization of Explicit memory block. The unit is kilo bytes.

<EH_GARB>
<const>K
The internal status of Explicit heap is output.

<EH_TOTAL>
<const>K
Output secured size of Explicit heap when failed in initialization of Explicit memory block. The unit is kilo bytes.

<EH_MAX>
<const>K
Output Explicit heap maximum size. The unit is kilo bytes.

<AC_NUM>
<const>
Output number of Explicit memory blocks whose sub status is Enable when failed in initialization of Explicit memory block.

<FL_NUM>
<const>
Normally 0 is output

<DA_NUM>
<const>
Output number of Explicit memory blocks whose sub status is Disable when failed in initialization of Explicit memory block.

<TH_PTR>
<ptr>
Output thread ID of threads failed in initialization of Explicit memory block. Thread ID is same as tid output to thread dump.

<FRAME>
<letters>.<letters>
Output one frame in stack trace when failed in initialization of Explicit memory block. Output all class names and method names by delimiting them by a ".".

<SOURCE>
(<letters>:<const>)|(Native Method)|(Unknown Source)
Output the source file names where methods output to <FRAME> are described and the line numbers match the stack trace. Output the file name and line numbers by delimiting them by a ":".
Output as "(Native Method)" for native method. Output as "(Unknown Source)" when you cannot acquire source file name.

(d) Example of output

Output example.

[EVO]<Tue Jul 24 01:23:51 2007>[Creation failed][EH: 12000K(0K)/15000K/30000K][E/F/D: 65535/0/0][Thread: 0x00035a60]
[EVO][Thread: 0x00035a60] at ExplicitMemory.registerExplicitMemory(Native Method)
[EVO][Thread: 0x00035a60] at BasicExplicitMemory.<init>(Unknown Source)
[EVO][Thread: 0x00035a60] at AllocTest.test(AllocTest.java:64)
[EVO][Thread: 0x00035a60] at java.lang.Thread.run(Thread.java:2312)

You can confirm the following contents in this output example:

Output trigger is the failure in initialization of Explicit memory block occurred on July 24, 2007 (Tuesday) 1:23:51. The maximum number of Explicit memory blocks is 65535 that already exist and hence failed in initialization of new Explicit memory block.

On the 64th line of AllocTest.java, try initializing Explicit memory block by executing constructor of BasicExplicitMemory class.

(3) Disable of sub status of Explicit memory block

Output the information of Explicit memory block in which the usage status and sub status are changed to Disable, when the sub status of Explicit memory block is changed to Disable. This log is output on multiple lines and output asynchronously with the execution of Java program. Hence, there are cases where some other log is output within the lines of this log. However, other logs are not output within one line.

(a) Output trigger

Output is triggered when sub status of Explicit memory block is Disable and when you cannot map the object to respective Explicit memory block.

(b) Output format

[EVO]<ctime>[Alloc failed(Disable)][EH: <EH_USED>(<EH_GARB>)/<EH_TOTAL>/<EH_MAX>][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>][cause:<CAUSE>]\
["<EM_NAME>" eid=<EID>/<EM_TYPE>: <EM_USED>(<EM_GARB>)/<EM_TOTAL>][Thread: <TH_PTR>]
[EVO][Thread: <TH_PTR>] at <FRAME><SOURCE>
...

#

The Underlined part is output only for New.

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-46 Output items (Disable sub status of Explicit memory block)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the date and time when sub status of Explicit memory block with <EID> is changed to Disable. Output in the format same as extended verbosegc information.
Output in milli-seconds unit when -XX:+HitachiOutputMilliTime option is set.

<EH_USED>
<const>K
Output used size of Explicit heap when sub status of Explicit memory block with <EID> is Disable. The unit is kilo bytes.

<EH_GARB>
<const>K
Output value indicating internal status of Explicit heap.

<EH_TOTAL>
<const>K
Output secured size of Explicit heap when sub status of Explicit memory block with <EID> is Disable. The unit is kilo bytes.

<EH_MAX>
<const>K
Output Explicit heap maximum size. The unit is kilo bytes.

<AC_NUM>
<const>
Output number of Explicit memory blocks that are Enable after changing the sub status of Explicit memory block with <EID> to Disable.

<FL_NUM>
<const>
Normally 0 is output

<DA_NUM>
<const>
Output number of Explicit memory blocks that whose sub status is Disable after changing the sub status of Explicit memory block with <EID> to Disable.

<CAUSE>
New|GC|Full GC
Output the process that cause Disable of sub status.
The output contents and measures for the cause are as follows:

"New"
The cause is direct generation of object in Explicit heap by newInstance().

"GC"
The cause is moving the object to Explicit heap by copy garbage collection.

"Full GC"
The cause is moving the object to Explicit heap by full garbage collection.

<EM_NAME>
<letters>
Output name of Explicit memory block whose sub status is Disable.
The output contents are uncertain when multi byte characters are included in name of Explicit memory block (Usually garbled and output).

<EID>
<const>
Output ID of Explicit memory block whose sub status is Disable.

<EM_TYPE>
R|B|A
Output type of Explicit memory block whose sub status is Disable.
R indicates Explicit memory block used internally in Application Server. B indicates the type of the Explicit memory block in JavaVM. A indicates the Explicit memory block specified using the automatic allocation configuration file.

<EM_USED>
<const>K
Output used size of Explicit memory block whose sub status is Disable. The unit is kilo bytes.

<EM_GARB>
<const>K
Output value indicating internal status of Explicit memory block.

<EM_TOTAL>
<const>K
Output secured size of Explicit memory block whose sub status is Disable. The unit is kilo bytes.

<TH_PTR>
<ptr>
Output thread ID of thread executing object generation to Explicit heap as the sub status is Disable. Thread ID is same as the tid output to thread dump.
This item is output only when <CAUSE> is "New".

<FRAME>
<letters>.<letters>
Output one frame in stack trace output as a result of direct object generation when sub status is Disable due to direct object generation in Explicit heap.
Output all class names and method names by delimiting them by a ".".
This item is output only when <CAUSE> is "New".

<SOURCE>
(<letters>:<const>)|(Native Method)|(Unknown Source)
Output the source file names where methods output to <FRAME> are described and the line numbers that match the stack trace. Output the file name and line numbers by delimiting them by a ":".
Output as "(Native Method)" for native method. Output as "(Unknown Source)" when you cannot acquire source file name.
This item is output only when <CAUSE> is "New".

(d) Example of output

Output example.

[EVO]<Tue Jul 24 01:23:51 2007>[Alloc failed(Disable)][EH: 12000K(1258K)/15000K/30000K][E/F/D: 321/0/1][cause:GC]\
["ReferenceExplicitMemory-3" eid=3/R: 108K(20K)/108K]

You can confirm the following contents in this output example:

Output trigger is Disable of sub status of Explicit memory block on July 24, 2007 1:23:51.

For Explicit heap, 12000K is used and 15000K is secured.

Maximum size of Explicit heap is 30000K.

There are only 322 valid Explicit memory blocks in the entire Explicit heap. In these blocks, the blocks whose sub status is Enable are 321 blocks and the blocks whose sub status is Disable is 1 block.

The migration of objects to the Explicit memory block during garbage collection is the process as a result of which the sub status is Disabled.

The Explicit memory blocks whose sub status is Disable is when ID is "3" and name of Explicit memory block is "ReferenceExplicitMemory-3".

In "ReferenceExplicitMemory-3", 108k memory is already used.

(4) Object generation to Explicit memory block

Output when object is generated directly in Explicit memory block using ExplicitMemory.newInstance().

(a) Output trigger

Output is triggered when object is generated in Explicit memory block.

(b) Output format

[EVS]<ctime>[EH: <EH_USED_BF>-><EH_USED_AF>(<EH_TOTAL>/<EH_MAX>)][E/F/D: <AC_NUM>/<FL_NUM>/<DA_NUM>][cause:<CAUSE>]\
["<EM_NAME>" eid=<EID>/<EM_TYPE>: <EM_USED_BF>-><EM_USED_AF>(<EM_TOTAL>)]

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-47 Output items (Object generation to Explicit memory block)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the date and time when object is generated in Explicit memory block. Output in the format same as extended verbosegc information.
Output in milli-seconds unit when -XX:+HitachiOutputMilliTime option is set.

<EH_USED_BF>
<const>K
Output used size of Explicit heap before object generation. The unit is kilo bytes.

<EH_USED_AF>
<const>K
Output used size of Explicit heap after object generation. The unit is kilo bytes.

<EH_TOTAL>
<const>K
Output secured size of Explicit heap after object generation. The unit is kilo bytes.

<EH_MAX>
<const>K
Output maximum size of Explicit heap. The unit is kilo bytes.

<AC_NUM>
<const>
Output the number of Explicit memory blocks whose sub status is Enable after object generation.

<FL_NUM>
<const>
Normally 0 is output

<DA_NUM>
<const>
Output number of Explicit memory blocks whose sub status is Disable after object generation.

<CAUSE>
New
Always output as "New".
Indicates that migration of object to Explicit memory block is executed from Java program.

<EM_NAME>
<letters>
Output name of Explicit memory block where object is generated.
The output contents are uncertain when multi byte characters are included in name of Explicit memory block (Usually garbled and output).

<EID>
<const>
Output ID of Explicit memory block where object is generated.

<EM_TYPE>
R|B|A
Output type of Explicit memory block where object is generated.
R indicates Explicit memory block used internally in Application Server. B indicates the type of the Explicit memory block in JavaVM. A indicates the Explicit memory block specified using the automatic allocation configuration file.

<EM_USED_BF>
<const>K
Output used size of Explicit memory block that is generation destination before object generation. The unit is kilo bytes.

<EM_USED_AF>
<const>K
Output used size of Explicit memory block that is generation destination after object generation. The unit is kilo bytes.

<EM_TOTAL>
<const>K
Output secured size of Explicit memory block that is generation destination after object generation. The unit is kilo bytes.

(d) Example of output

Output example.

[EVS]<Thu Oct 21 14:55:50 2007>[EH: 150528K->150529K(150532K/1048576​K)][E/F/D: 200/0/0][cause:New]["BEM" eid=2/B: 30K->31K(32K)]

You can confirm the following contents in this output example:

Output trigger is the generation of object to Explicit memory block executed on October 21, 2007 (Thursday) 14:55:50.

The used size of Explicit heap changed from 150528K to 150529K as object is generated in Explicit heap.

Secured size of Explicit heap after object generation to Explicit heap is 150532K. Maximum size is 1048576K.

The number of Explicit memory blocks whose sub status is Enable after object generation to Explicit heap, is 200.

Changed the used size of memory block named "BEM" from 30K to 31K. Secured size of BEM after object generation is 32K.

(5) Moving to Explicit memory block (Output detail information)

Output detail information for moving object to Explicit memory block. Besides the output contents described in 5.11.3(1) Garbage collection occurrence (Output Explicit heap usage status), output the usage status of all Explicit memory blocks where the objects are to be moved.

(a) Output trigger

Output is triggered when object moves to Explicit memory block as a result of occurrence of garbage collection.

(b) Output format

<Explicit heap usage status when garbage collection occurred>#
[EVS]{["<EM_NAME>" eid=<EID>/<EM_TYPE>: <EM_USED_BF>-><EM_USED_AF>(<EM_TOTAL>)]}{1,5}
...

Note:

Linefeed information of Explicit memory block after output of every five blocks.

#

For output items, see 5.11.3(1) Garbage collection occurrence (Output Explicit heap usage status).

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-48 Output items (Moving to Explicit memory block (Output detail information))

Output items
Output contents
Meaning

Explicit heap usage status when garbage collection occurred
See 5.11.3(1) Garbage collection occurrence (Output Explicit heap usage status).

<EM_NAME>
<letters>
Output name of Explicit memory block where the object is to be moved when garbage collection occurred.
The output contents are uncertain when multi byte characters are included in name of Explicit memory block (Usually garbled and output).

<EID>
<const>
Output ID of Explicit memory block where the object is to be moved when garbage collection occurred.

<EM_TYPE>
R|A
Output type of Explicit memory block where the object is to be moved when garbage collection occurred.
R or A is output. R indicates the type of the Explicit memory block in JavaVM. A indicates the Explicit memory block specified by using the automatic allocation configuration file.

<EM_USED_BF>
<const>K
Output used size before occurrence of garbage collection of Explicit memory block where the object is to be moved when garbage collection occurred. The unit is kilo bytes.

<EM_USED_AF>
<const>K
Output used size after occurrence of garbage collection of Explicit memory block where the object is to be moved when garbage collection occurred. The unit is kilo bytes.

<EM_TOTAL>
<const>K
Output secured size after occurrence of garbage collection of Explicit memory block where the object is to be moved when garbage collection occurred. The unit is kilo bytes.

(d) Example of output

Output example.

[ENS]<Thu Oct 21 14:55:50 2007>[EH: 150528K->162816K(162816K/1048576​K)][E/F/D: 200/0/0][cause:GC][CF: 0]
[EVS]["REM2" eid=2/R: 0K->88K(128K)]["REM3" eid=3/R: 30K->230K(256K)]["REM6" eid=6/R: 30K->2030K(2048K)]\
["Session1" eid=8/R: 30K->2530K(2548K)]["Session2" eid=10/R: 30K->2530K(2548K)]
[EVS]["Session3" eid=12/R: 30K->5030K(5048K)]

You can confirm the following contents in this output example:

Output trigger is the moving of object to Explicit heap in garbage collection occurred on October 21, 2007 (Thursday) 14:55:50.

Used size of Explicit heap changed from 150528K to 162816K.

Secured size of Explicit heap after executing garbage collection is 162816K. Maximum size is 1048576K.

There are 200 Explicit memory blocks whose sub status is Enable after executing garbage collection.

Type of garbage collection is copy garbage collection.

There are minimum five Explicit memory blocks where the objects are to be moved. Perform one linefeed after output of five blocks.

Following is the breakdown for moving 2288k to (162816K-150528K) explicit heap:

Move 88K in Explicit memory block "REM2"(eid=2).

Move 200K in Explicit memory block "REM3"(eid=3).

Move 2000K in Explicit memory block "REM6"(eid=6).

Move 2500K in Explicit memory block "Session1"(eid=8).

Move 2500K in Explicit memory block "Session2"(eid=10).

Move 5000K in Explicit memory block "Session3"(eid=12).

Moved to Explicit memory blocks used internally in all Application Servers.

(6) Explicit memory block explicit release process (Output detail information)

Output detail information when the explicit release process of Explicit memory block occurred. Besides the contents output to 5.11.3(2) Explicit memory block explicit release process, output the information of all the explicitly released Explicit memory blocks.

While explicitly releasing the Explicit memory block, if there is a Java heap overflow, output the information by adding information of Explicit memory blocks explicitly released before overflow. The information described here is not output to the output contents of 5.11.3(3) Java heap overflow in Explicit memory block explicit release process.

(a) Output trigger

The Explicit release process of Explicit memory block.

(b) Output format

<Explicit memory block explicit release process>#
[EVS]{["<EM_NAME>" eid=<EID>/<EM_TYPE>: <EM_TOTAL>]}{1,5}
...

Note:

Linefeed information of Explicit memory block after every five blocks.

#

For details on the output item, see 5.11.3(2) Explicit memory block explicit release process.

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-49 Output items (Explicit memory block explicit release process (Output detail information))

Output items
Output contents
Meaning

Information output by release process of Explicit memory block
See 5.11.3(2) Explicit memory block explicit release process.

<EM_NAME>
<letters>
Output name of the explicitly released Explicit memory block.
The output contents are uncertain when multi byte characters are included in name of Explicit memory block (Usually garbled and output).

<EID>
<const>
Output ID of the explicitly released Explicit memory blocks.

<EM_TYPE>
R|B|A
Output type of the explicitly released Explicit memory blocks.
R indicates Explicit memory block used internally in Application Server. B indicates the type of the Explicit memory block in JavaVM. A indicates the Explicit memory block specified using the automatic allocation configuration file.

<EM_TOTAL>
<const>K
Output secured memory size (memory size released explicitly in the explicit release process) of the explicitly released Explicit memory blocks. The unit is kilo bytes.

(d) Example of output

Output example.

[ENS]<Tue Jul 24 01:23:51 2007>[EH: 150528K->149528K(162816K/1048576​K), 0.1129602​ secs][E/F/D: 523/0/0]\
[DefNew::Eden: 0K->0K(243600K)][DefNew::Survivor: 0K->0K(17400K)][Tenured: 103400K->103400K(556800K)][cause:Reclaim]
[EVS]["REM2" eid=3/R: 300K]["BEM3" eid=5/B: 300K]["BEM1" eid=7/B: 400K]

You can confirm the following contents in this output example:

Output trigger is the explicit release process of Explicit memory block occurred on July 24, 2007 (Friday) 1:23:51.

The used size of Explicit heap reduced from 150528K to 149528K by the explicit release process of Explicit memory block.

The secured size of Explicit heap after Explicit memory block explicit release process is 162816K. Maximum size is 1048576K.

The explicit release process of Explicit memory block took 0.1129602 seconds.

The number of Explicit memory blocks, whose sub status is Enable after Explicit memory block explicit release process, are 523 blocks.

The memory size of each area of Java heap is not changed as a result of the explicit release process of Explicit memory block. In other words, no objects were moved to Java heap.

The following Explicit memory blocks were target for the explicit release process:

Explicit memory block "REM2"(eid=3) whose secured memory size is 300K

Explicit memory block "BEM3"(eid=5) whose secured memory size was 300K

Explicit memory block "BEM1"(eid=7) whose secured memory size was 400K

REM2 is the Explicit memory block used internally in Application Server. BEM3 and BEM1 are Explicit memory blocks used by application.

(7) Release reservation of Explicit memory block by finalize

Output when an Explicit memory block corresponding to the finalize method of the ExplicitMemory class is reserved for release as a result of the disconnection of a reference to an ExplicitMemory instance.

(a) Output trigger

Output is triggered when release of Explicit memory block is reserved by ExplicitMemory.finalize() method.

(b) Output format

[EVO]<ctime>[Finalized]["<EM_NAME>" eid=<EID>/<EM_TYPE>: <EM_TOTAL>]

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-50 Output items (Release reservation of Explicit memory block by finalize)

Output items
Output contents
Meaning

<ctime>
<letters>
Indicates the reserved date and time for release. Output in the format same as extended verbosegc information.
Output in milli-seconds unit when -XX:+HitachiOutputMilliTime option is set.

<EM_NAME>
<letters>
Output name of Explicit memory block reserved for release.
The output contents are uncertain when multi byte characters are included in name of Explicit memory block (Usually garbled and output).

<EID>
<const>
Output ID of Explicit memory block reserved for release.

<EM_TYPE>
B
Output type of Explicit memory block reserved for release.
B indicates the type of the Explicit memory block in JavaVM. Indicates Explicit memory block used by the application if Application Server version is earlier than 08-50.

<EM_TOTAL>
<const>K
Output size secured (Memory size released by release process) by Explicit memory blocks reserved for release. The unit is kilo bytes.

(d) Example of output

Output example.

[EVO]<Tue Jul 24 01:23:51 2007>[Finalized]["REM1" eid=3/R: 512K]

You can confirm the following contents in this output example:

Output trigger is reservation for release of Explicit memory block "REM1"(eid=3) on July 24, 2007 (Friday) 1:23:51. Release and reservation is executed by finalize().

(8) Automatic allocation to Explicit Memory Management

A log message is output, when the specified class succeeds in automatic allocation to Explicit Memory Management.

(a) Output trigger

The log message is output, when the specified class succeeds in automatic allocation to Explicit Memory Management.

(b) Output format

[EVA]<ctime> creation in explicit memory is succeeded. [class=<CLASSNAME>]

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-51 Output items (Automatic allocation to Explicit Memory Management)

Output items | Output contents | Meaning
<ctime> | <letters> | Indicates the occurrence time when the specified class succeeded in automatic allocation to Explicit Memory Management. Output with the format same as would output for the extended verboseGC functionality. Output in milliseconds, when the HitachiOutputMilliTime option is set.
<CLASSNAME> | <letters> | Outputs the fully qualified class name of the class that succeeded in automatic allocation to Explicit Memory Management.

(d) Example of output

An output example is as follows:

[EVA]<Tue Jul 24 01:23:51 2007> creation in explicit memory is succeeded. [class=jp.co.sample.Main]

You can check the following details in this output example:

When the Explicit Heap Memory Management functionality succeeds in automatic allocation of the class jp.co.sample.Main to Explicit Memory Management on July 24, 2007 (Tuesday) at 1:23:51.

5.11.5 Contents Output when Output Level is Debug

This subsection describes the contents output for each event when you specify debug in log output level.

Supplement

Use debug, for detail information besides the contents output to verbose, while implementing by debugging. In the logs output within debug, there are some logs with high overheads than that of the logs that require execution of full garbage collection for output.

Organization of this subsection

(1) Migration of object to Java heap by the explicit release of Explicit memory block

(2) Initialization of Explicit memory block (Output detail information)

(3) Details of automatic release processing of the Explicit memory block (Output detailed information)

(1) Migration of object to Java heap by the explicit release of Explicit memory block

If you want to refer an object in Explicit memory block from the Explicit memory block that is not the target for explicit release, move that object to Java heap for explicitly releasing the Explicit memory block. This log does output of information of object moved to Java heap and object of the reference source.

(a) Output trigger

Output is triggered when an object is moved to Java heap in the explicit release process of Explicit memory block.

(b) Output format

[EDO][eid=<EID>: Reference to <REFED_NAME>(<REFED_PTR>), total <R_SIZE>]
[EDO] <REF_NAME>(<REF_PTR>)<REF_GEN>

Note:

Output for each object referred by Explicit memory block that is not the target for explicit release.

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-52 Output items (Migration of objects to Java heap as a result of the explicit release of Explicit memory block)

Output items | Output contents | Meaning
<EID> | <const> | Output ID of the Explicit memory block that has objects referred from other Explicit heap and that are not target for explicit release in the Explicit memory block explicit release process.
<REFED_NAME> | <letters> | Output all class names of objects (Objects shown in<REF_NAME>(<REF_PTR>) ) referred from objects other than Explicit heap that are not target for explicit release in Explicit memory block explicit release process.
<REFED_PTR> | <ptr> | Output memory address before migration of objects indicating <REFED_NAME> to Java heap.
<R_SIZE> | <const>K | Output total size of objects to be moved to Java heap by referring from <REF_NAME>(<REF_PTR>). Total size is the value including the objects in the Explicit memory block that are to be released explicitly and objects that are indirectly referred from <REF_NAME>(<REF_PTR>)#. The unit is kilo bytes.
<REF_NAME> | <letters>|JVM | Output all class names of objects referring <REFED_NAME>(<REFED_PTR>). Output as "JVM" when reference source is stack or internal JavaVM.
<REF_PTR> | <ptr> | Output object indicating <REF_NAME>, stack or memory address in JavaVM.
<REF_GEN> | (eid=<EID>)|(DefNew)|(Tenured)|(Perm)|(JVM) | Output area belonging to <REF_NAME>(<REF_PTR>) or generation name. Output ID of Explicit memory block for Explicit memory block. Output "JVM" when referred from stack or JavaVM.

#

Also refer to the following supplement:

Supplement

This supplement gives an overview when there are many reference routes to an object moving to Java heap.

The description is provided with following figure as an example.

Figure 5-9 Example where there are multiple reference routes to object moving to Java heap

Output when object to be moved to Java heap is referred from multiple objects

There are cases when the objects to be moved to Java heap are referred from multiple objects. In the figure, there are two types; A->B and E->B of reference routes for object B.

In such cases, the information related to reference of A->B, E->B is output separately in logs.

<R_SIZE> calculation when there is indirect referring from multiple objects

Output value that includes objects in the Explicit memory block that are to be released explicitly and objects that are referred indirectly from <REF_NAME>(<REF_PTR>) in <R_SIZE>. However, the calculation method differs when object to be moved to Java heap is indirectly referred from multiple objects.

In the figure, object D is indirectly referred by the following three types of routes:

A->B->D

E->B->D

E->F->D

When referred by multiple routes, the size of object is added to <R_SIZE> reference relation calculated initially. For example, when the reference relation is output in the following A->B, E->B, E->F sequence, the size of object D is added in <R_SIZE> of A->B. In such cases, the output of <R_SIZE> of each reference relation would be as follows:

A->B
Total of size of object B and object D is 4K.

E->B
2k that is the size of object B.

E->F
1K that is the size of object F.

(d) Example of output

Output example.

[EDO][eid=5: Reference to java.lang.HashMap$Entry(0x1234568​), total 125K]
[EDO] java.util.HashMap$KeyIterator(0x1134428​)(eid=1)
[EDO][eid=5: Reference to ClassA(0x1234580​), total 19250K]
[EDO] ClassV(0x1234468​)(Tenured)
[EDO][eid=5: Reference to ClassZ(0x1234680​), total 12K]
[EDO] ClassU(0x1233468​)(DefNew)
[EDO][eid=9: Reference to JP.co.Hitachi.soft.jvm.BBB(0x1034428​), total 1250K]
[EDO] JVM(0x23456780​)(JVM)

You can check the following contents in this output example:

Object of java.lang.HashMap$Entry that is in the Explicit memory block of eid=5 is referred from object of java.util.HashMap$KeyIterator that is in the Explicit memory block of eid=1 which is not the explicit release target. As a result, object of 125Kbyte is moved to Java heap.

Object of ClassA that is in Explicit memory block of eid=5 is referred from object of ClassV in Tenured area. As a result, an object of 19,250 Kbyte is moved to Java heap.

Object of ClassZ in Explicit memory block of eid=5 is referred from object of ClassU in New area. As a result, object of 12Kbyte is moved to Java heap.

Object of JP.co.Hitachi.soft.jvm.BBB that is in Explicit memory block of eid=9 is referred from stack or internal JavaVM. As a result, an object of 1,250 kilobyte is moved to Java heap.

(2) Initialization of Explicit memory block (Output detail information)

Output detail information when you initialize a new Explicit memory block. Besides the output contents in 5.11.4(1) Initialization of Explicit memory block, output the stack trace of Java program executing initialization process. This log is output asynchronously with the execution of Java program on multiple lines. Hence, there are cases where some other log is output within the lines of this log. However, other logs are not output within one line.

(a) Output trigger

Initialization of Explicit memory block.

(b) Output format

<Information(verbose) of initialization of Explicit memory block>#[Thread: <TH_PTR>]
[EDO][Thread: <TH_PTR>] at <FRAME><SOURCE>
...

#

For output items, see 5.11.4(1) Initialization of Explicit memory block.

(c) Output items

The following table describes each item indicated in (b) output trigger.

Table 5-53 Output items (Initialization of Explicit memory block(Output detail information))

Output items
Output contents
Meaning

Information(vervose) when initialization of Explicit memory block
See 5.11.4(1) Initialization of Explicit memory block.

<TH_PTR>
<ptr>
Output thread ID of thread to initialize Explicit memory block. Thread ID is same as tid output to thread dump.

<FRAME>
<letters>.<letters>
Output one frame in stack trace when initializing Explicit memory block. Output all class names and method names by delimiting them by a ".".

<SOURCE>
(<letters>:<const>)|(Native Method)|(Unknown Source)
Output the source file names where methods output to <FRAME> are described and line numbers match the stack trace. Output file names and line numbers by delimiting them by a ":".
Output as "(Native Method)" when native method.
Output as "(Unknown Source)" when you cannot acquire the source file name.

(d) Example of output

Output example.

[EVO]<Tue Jul 24 01:23:51 2007>[Created]["BasicExplicitMemory-2" eid=2(0x1234568​)/B][Thread: 0x00035a60]
[EDO][Thread: 0x00035a60] at ExplicitMemory.registerExplicitMemory(Native Method)
[EDO][Thread: 0x00035a60] at BasicExplicitMemory.<init>(Unknown Source)
[EDO][Thread: 0x00035a60] at AllocTest.test(AllocTest.java:64)
[EDO][Thread: 0x00035a60] at java.lang.Thread.run(Thread.java:2312)

You can check the following contents in this output example:

Output trigger is initialization of memory block executed on July 24, 2007 1:23:51. Name of Explicit memory block is "BasicExplicitMemory-2". ID of Explicit memory block is eid=2.

Try initializing Explicit memory block by executing constructor of BasicExplicitMemory class on 64th line of AllocTest.java.

(3) Details of automatic release processing of the Explicit memory block (Output detailed information)

Output the detailed information when the automatic release processing of the Explicit memory block occurs. Besides the output contents described in the subsection 5.11.3(4) Automatic release processing of the explicit memory block, output the EID information of the Explicit memory block executing the automatic release processing. The automatic release processing of the Explicit memory block might include the automatic release processing without the movement of objects, many-to-one automatic release processing, and one-to-one automatic release processing. Therefore, the information about EID without object movement, many-to-one EID, and one-to-one EID is output.

(a) Output trigger

The log is output when the automatic release processing for the explicit memory block occurs.

(b) Output format

[EDO][migrate:(<EID_DEL>{,<EID_DEL>}*|)/(<EID_MBF>{,<EID_MBF>}*-><EID_MAF>|)/(<EID_MIG>{,<EID_MIG>}*|)]

(c) Output items

The following table describes the items specified in (b) Output format.

Table 5-54 Output items (Details of automatic release processing of the Explicit memory block (output detailed information))

Output items | Output contents | Meaning
<EID_DEL> | <const> | Outputs EID of the Explicit memory blocks without moving the objects, among the Explicit memory blocks released by the automatic release processing of the Explicit memory block.
<EID_MBF> | <const> | Outputs EID used before reserving the automatic release of the Explicit memory block where many-to-one automatic release processing occurred, among the Explicit memory blocks released by the automatic release processing of the Explicit memory block.
<EID_MAF> | <const> | Outputs EID of the Explicit memory blocks generated by the many-to-one automatic release processing, among the Explicit memory blocks generated by the automatic release processing of the Explicit memory block.
<EID_MIG> | <const> | Outputs EID of the Explicit memory blocks where the one-to-one automatic release processing occurred, among the Explicit memory blocks released by the automatic release processing of the Explicit memory block.

(d) Example of output

An output example is as follows:

[EVS]<Tue Jul 14 02:31:22 2009>[EH: 256512K->256128K(256256K/1048576​K), 0.1124626​ secs][E/F/D: 423/0/0][target:584K/384K/200K]\
[cause:Migrate]
[EDO][migrate:()/(2,4,6,9->10)/(1,8)]

You can check the following details in this output example:

The output trigger is the automatic release processing of the Explicit memory block in the garbage collection that occurred on July 14, 2009 (Tuesday) at 2:31:22.

The used size of Explicit memory changed from 256,512K to 256,128K due to the automatic release processing.

The secured size of Explicit memory after the automatic release processing is 256,256K and the maximum size is 1,048,576K.

The time taken for the automatic release processing was 0.1124626 seconds.

There are 423 Explicit memory blocks whose sub-state is Enable after the automatic release processing.

The automatic release processing was executed for the Explicit memory used size 584K.

The Explicit memory blocks with IDs (2, 4, 6, 9) are moved to the Explicit memory block with ID (10).

The Explicit memory blocks with IDs (1, 8) are moved to the same IDs (1, 8).

6. Troubleshooting Procedure

This chapter describes the troubleshooting procedure for Application Server.

Organization of this chapter

6.1 Organization of this chapter

6.2 List of main problems

6.3 Processes that output logs

6.4 Troubleshooting during setup

6.5 Troubleshooting during operations

6.6 Troubleshooting the server management commands

6.7 Examples of troubleshooting during operations

6.1 Organization of this chapter

This chapter describes the main problems that occur in Application Server and how to troubleshoot the problems.

The following table describes the organization of this chapter.

Table 6-1 Organization of this chapter (Troubleshooting procedure)

Category | Title | Reference section
Explanation | List of main problems | 6.2
Processes that output logs | 6.3
Troubleshooting during setup | 6.4
Troubleshooting during operations | 6.5
Troubleshooting the server management commands | 6.6
Examples of troubleshooting during operations | 6.7

6.2 List of main problems

This section describes the locations to check the main causes of problems and logs required for actions, for the different times at which problems occur.

This subsection describes the main causes and actions for problems, for each of the following times:

During installation

During server setup

During server startup

During application startup

During operations

During server or application maintenance

The following is a description of each of the above problems:

Organization of this section

(1) Main problems occurring during installation

(2) Main problems occurring during server setup

(3) Main problems occurring during server startup

(4) Main problems occurring during application startup

(5) Main problems occurring during operations

(6) Main problems occurring during server/application maintenance

(1) Main problems occurring during installation

The following table describes the main problems that occur during installation.

Table 6-2 List of main problems occurring during installation

Tool reporting the problem
Event
Main effects
Main causes
Checking location

Installer
Output of error message (dialog box or command prompt)
Installation will be interrupted. In some cases, un-installation is required.
There is a problem with the environment (such as the OS or disk).

Dialog box

install.log

Legend:

--: Not applicable.

Reference note

For details on the notes related to installation and un-installation, see Appendix J Notes on Installation and Un-installation in the uCosminexus Application Server System Setup and Operation Guide.

(2) Main problems occurring during server setup

The following table describes the main problems that occur during server setup.

Table 6-3 List of main problems occurring during server setup

Tool reporting the problem
Event
Main effects
Main causes
Checking location
Reference location

Setup Wizard
Output of error message (command prompt)
The setup operation is interrupted. In some cases, un-setup is required.
The possible causes are as follows:

There is a problem with the environment (such as the OS, network, memory, disk)

Operation error

Settings error

Command error

Setup Wizard log

Manager log

J2EE server log

Web server log

OS

6.4

SmartComposer
Output of error message (command prompt)

Command error

Manager log

J2EE server log

Web server log

OS

Management portal
Output of error message (GUI)

Displayed log

Manager log

J2EE server log

Web server log

OS

(3) Main problems occurring during server startup

The following table describes the main problems that occur when you start a server.

Table 6-4 List of main problems occurring during server startup

Tool reporting the problem
Event
Main effects
Main causes
Checking location
Reference

SmartComposer
Output of error message (command prompt)
The deploy operation is interrupted.
The possible causes are as follows:

There is a problem with the environment (such as the OS, network, memory, disk)

Operation error

Settings error

Command error

Manager log

J2EE server log

Web server log

OS

6.4

Management portal
Output of error message (GUI)

Displayed log

Manager log

J2EE server log

Web server log

OS

(4) Main problems occurring during application startup

The following table describes the main problems that occur when you start an application.

Table 6-5 List of main problems occurring during application startup

Tool reporting the problem
Event
Main effects
Main causes
Checking location
Reference

SmartComposer (for compatibility)
Output of error message (command prompt)
The deploy operation is interrupted.
The possible causes are as follows:

There is a problem with the environment (such as the OS, network, memory, disk)

Operation error

Settings error

There is a problem with the created application

There is a problem between an application and Application Server

Command error

Manager log

J2EE server log

Web server log

OS

6.4

Management portal
Output of error message (GUI)

Displayed log

Manager log

admin log

J2EE server log

Web server log

OS

Server management commands#
Output of error message (command prompt)

Command error

admin log

J2EE server log

Application

6.6

#

When you use the server management commands, the action to be taken for the problems varies. Check the action described at the Reference column indicated in the table.

(5) Main problems occurring during operations

The following table describes the main problems that occur during operations.

Table 6-6 List of main problems occurring during operations

Tool reporting the problem
Event
Main effects
Main causes
Checking location
Reference

Management portal
Output of error message (GUI)
The business cannot continue.
The possible causes are as follows:

There is a problem with the environment (such as the OS, network, memory, disk)

Resource depletion in the server (such as OOM)

There is a problem with the integrated system (such as DB)

Lengthy processing on an application

HA switching

Displayed log

Manager log

J2EE server log

Web server log

OS

JavaVM, container resources

PRF trace

Thread dump

Application

6.5

(Client)#

Output of business errors

Browser-specific errors (such as server not found, 404, 500, 503)

No response

Delayed response (performance deterioration)

The business might not be continued.

Displayed log

Manager log

J2EE server log

Web server log

OS

JavaVM, container resources

PRF trace

Thread dump

Application

#

Appears as an event on the client using the service.

(6) Main problems occurring during server/application maintenance

The following table describes the main problems that occur during server/application maintenance.

Table 6-7 List of main problems occurring during server/application maintenance

Tool reporting the problem
Event
Main effects
Main causes
Checking location
Reference

SmartComposer
Output of error message (command prompt)

The server settings cannot be changed

The application cannot be updated

The possible causes are as follows:

There is a problem with the environment (such as the OS, network, memory, disk)

Operation error

Settings error

There is a problem with the created application

There is a problem between an application and Application Server

Command error

Manager log

J2EE server log

Web server log

OS

6.4

Management portal
Output of error message (GUI)

Displayed log

Manager log

admin log

J2EE server log

Web server log

OS

Server management commands#
Output of error message (command prompt)

Command error

admin log

J2EE server log

OS

Application

6.6

#

The action to be taken for the problems varies when you use the server management commands. Check the action described at the Reference column indicated in the table.

6.3 Processes that output logs

Multiple logs are output by Application Server. You reference the logs to identify the cause of a problem, and then take action.

This section describes the logs that are mainly used for troubleshooting and the processes that output the logs. The following figure shows the logs that are mainly used for troubleshooting and the processes that output the logs.

Figure 6-1 Processes that output logs

Four types of logs are mainly used for troubleshooting with Application Server. The following table describes each of the logs.

Table 6-8 Log types and output contents

Number in the figure | Log type | Output contents
1 | Manager logs | Logs output by Management Server or Administration Agent. This type of log is output during the setup, operations, and maintenance by using the Cosminexus Manager functionality.
2 | Server management command logs | This type of log is output during the server management command operations.
3 | Web server logs | This type of log is output by Cosminexus HTTP Server.
4 | J2EE server logs | This type of log is output by the J2EE server.

During troubleshooting, you check these logs and then take action. The following sections describe specific troubleshooting procedure for each tool used.

6.4 Troubleshooting during setup

This section describes the actions for problems that occur during setup.

Setup refers to the following times:

During server setup

During server startup

During application startup

During server/ application maintenance

The following figure shows the procedure of checks during setup.

Figure 6-2 Procedure of checks for the tools being used (During setup)

Implement the required checks as per the procedure shown in the figure for the tools being used. The following subsections describe the details for the respective checks.

Reference note

Use the management portal to check the Manager logs. For details on the Management portal, see the uCosminexus Application Server Management Portal User Guide.

Organization of this section

(1) Checking the command errors

(2) Checking the Setup Wizard logs

(3) Displaying and checking the Manager logs

(4) Checking the admin logs

(5) Checking the J2EE server logs

(6) Checking the Web server logs

(7) OS peripheral checks

(1) Checking the command errors

Hint

This check is required when you use the following tools:

Setup Wizard

SmartComposer

The errors are displayed in the Setup Wizard and Smart Composer windows. Check the displayed error contents, and then take action. For details on the actions for the error messages, see the manual uCosminexus Application Server Messages.

(2) Checking the Setup Wizard logs

Hint

This check is required when you use the following tool:

Setup Wizard

Check the Setup Wizard logs. The output destination of the Setup Wizard logs is specified in setup.log.dir of setup.cfg. For details on setup.cfg, see 10.20 setup.cfg (Configuration file for Setup Wizard) in the uCosminexus Application Server Definition Reference Guide.

(3) Displaying and checking the Manager logs

Hint

This check is required when you use the following tools:

Setup Wizard

Management portal

SmartComposer

Use the management portal to check the logs output by Manager. To display the logs:

On the management portal, click the Manage logical server applications anchor.
Perform one of the following operations in the tree pane:

For a J2EE server

Click Logical J2EE Server - J2EE server - J2EE-server-name - Application.

For a J2EE server cluster

Click Logical J2EE server - J2EE server cluster - J2EE-server-cluster-name - Application, or click Logical J2EE server - J2EE server cluster - J2EE-server-cluster-name - Member - J2EE-server-name - Application.

Click the Display log tab.

The following figure shows the window when the log is displayed on the management portal window.

Figure 6-3 Example of output for the log displayed on the management portal window

After displaying the log using the Display log tab, find the message that was output closest to the time at which the system error was confirmed, identify the error message (a message with an ID ending with E), and then check the type and name of the logical server where the error occurred.

(4) Checking the admin logs

Hint

This check is required when you use the following tools:

Management portal

Note that this check is necessary when an error occurs while an application is being started.

Check the server management command logs.

The server management command logs include the message log, exception log, and maintenance log. These logs output information such as the operating status of the server management commands, the standard output and standard error output information output in an application, and the information used by the maintenance personnel to analyze the Component Container errors.

For details on the default output destination and the names of the log files, see the description related to the server management command logs in 4.3.1 Acquiring the Cosminexus Component Container logs.

(5) Checking the J2EE server logs

Hint

This check is required when you use the following tools:

Setup Wizard

Management portal

SmartComposer

Check the contents of the log files output by the J2EE server. The following table lists and describes the log files to be checked.

Table 6-9 List of log files to be collected

Log file name# | Log description | Checking method
cjmessage?.log | Log for J2EE server operations | Check the contents of the error message ID (message with message type E) for the time at which the error message is output by Cosminexus Manager.
cjexception?.log | Exception information log for J2EE server operations
web_servlet?.log | Web servlet log (messages output in JSP/ Servlet)
user_out?.log | User output log (standard output of messages in applications)
user_err?.log | User error log (standard error output of messages in applications)
javalog?.log | Logs for JavaVM maintenance information and garbage collection information
hs_err? | JavaVM error report file | Send to maintenance personnel.

#:

? indicates the number of log files.

For details on the default output destination of the log files, see 4.3.1 Acquiring the Cosminexus Component Container Logs.

For details on how to acquire hs_err, see 4.11 JavaVM Output Message Logs (Standard Output or Error Report File).

(6) Checking the Web server logs

Hint

This check is required when you use the following tools:

Setup Wizard

Management portal

SmartComposer

Check the log files output by the Web server. The following table lists and describes the log files to be checked.

Table 6-10 List of log files to be collected

Log file name# | Log description | Checking method
processConsole?.log | Console logs for Manager (Error information when the Web server starts) | Check the contents of the error message ID (message with message type E) for the time at which the error message is output by Cosminexus Manager.
error? | Web server error log | Check the contents of the error message (emerg, alert, and crit) for the time at which the error message is output by Cosminexus Manager.

#:

? indicates the number of log files.

For details on the default output destination of the console logs for Manager, see 4.11 JavaVM Output Message Logs (Standard Output or Error Report File).

For details on the default output destination of the Web server error logs, see 6.2.4 Directives beginning with E, F, G, H, and I in the uCosminexus Application Server HTTP Server User Guide.

(7) OS peripheral checks

Hint

This check is required when you use the following tools:

Setup Wizard

Management portal

SmartComposer

Check the memory size and operating status of the machine on which Application Server is installed.

6.5 Troubleshooting during operations

This section describes the actions to be taken for the problems occurring during operations.

"During operations" indicates the time immediately after the server startup is complete or when the server is running.

The following figure shows the procedure of checks during the operations of the tools being used.

Figure 6-4 Procedure of checks for the tools being used (during operations)

Implement the required checks as per the procedure shown in the figure for the tools being used. The following subsections describe the details for the respective checks.

Reference note

Use the management portal to check the Manager logs. For details on the Management portal, see the uCosminexus Application Server Management Portal User Guide.

Organization of this section

(1) Displaying and checking the Manager logs

(2) Checking the J2EE server logs

(3) Checking the Web server logs

(4) OS peripheral checks

(5) Checking JavaVM and container resources

(6) Checking the PRF trace

(7) Checking the thread dump

(8) Checking the applications

(1) Displaying and checking the Manager logs

Use the management portal to check the logs output by Manager. For details on displaying and checking the Manager logs, see 6.4(3) Displaying and checking the Manager logs.

(2) Checking the J2EE server logs

Check the log files output by the J2EE server. For details on the J2EE server log checks, see 6.4(5) Checking the J2EE server logs.

(3) Checking the Web server logs

Check the log files output by Web server. For details on the Web server log checks, see 6.4(6) Checking the Web server logs.

(4) OS peripheral checks

Check the memory size and operating status of the machine on which the Application Server is installed.

(5) Checking JavaVM and container resources

Check whether there are errors in JavaVM (occurrence of OutOfMemoryError) and in resources. For details on the action to be taken when an error occurs in JavaVM, see 2.5.7 If JavaVM Terminates abnormally.

(6) Checking the PRF trace

Check the trace based performance analysis and verify if there are any bottlenecks or if the processing is delayed at any location. For details on the trace based performance analysis, see 7. Performance Analysis by Using Trace Based Performance Analysis.

(7) Checking the thread dump

Check the thread dump and verify if there are any deadlocks or if there are any errors in the Java programs. For details on the information output to a thread dump, see 5.5 JavaVM Thread Dump.

(8) Checking the applications

Check the contents of the applications in which you think errors might have occurred. Request the creators of the application to perform the check.

6.6 Troubleshooting the server management commands

This section describes the actions to be taken for the problems that occur when the server management commands are used.

The actions for problems described in this section are as follows:

During application startup

During server/ application maintenance

The following figure shows the procedure of checks using the server management commands.

Figure 6-5 Procedure of checks using the server management commands

The details of the respective operations are as follows:

Organization of this section

(1) Checking the command errors

(2) Checking the admin logs

(3) Checking the J2EE server logs

(4) Checking the applications

(1) Checking the command errors

The errors are displayed on the command prompt. Check the displayed error contents, and then take action.

(2) Checking the admin logs

Check the server management command logs. For details on the default output destination of the log files, see the description related to the server management command logs in 4.3.1 Acquiring the Cosminexus Component Container Logs.

(3) Checking the J2EE server logs

Check the log files output by the J2EE server. For details on the J2EE server log checks, see 6.4(5) Checking the J2EE server logs.

(4) Checking the applications

Check the contents of the applications in which you think errors might have occurred. Request the creators of the application to perform the check.

6.7 Examples of troubleshooting during operations

This section describes the procedure of troubleshooting for the following problems as examples of troubleshooting during operations:

Process down

Delayed response

Note

This section specifies the default path settings of Application Server. Also, the OS used is Windows.

Organization of this section

6.7.1 Troubleshooting when a process is down

6.7.2 Troubleshooting when a response is delayed

6.7.1 Troubleshooting when a process is down

This subsection describes troubleshooting when a process is down.

Organization of this subsection

(1) Flow of actions when a process is down

(2) Flow of actions when a process is down

(1) Flow of actions when a process is down

The following figure shows the flow of troubleshooting when a process is down.

Figure 6-6 Flow of actions when a process is down

The details of the processing shown in the figure are described in subsection (2).

(2) Flow of actions when a process is down

The following points describe the operations according to the contents of the process down flow:

Open the error report file (hs_err_pidprocess-ID.log)
Open the error report file that was output around the time the error occurred and compare it with the Manager log.

Output destination of the error report file and the output file name
C:\Program Files\Hitachi\Cosminexus\CC\server\public\ejb\server-name\hs_err_pidserver-process-ID.log

Check whether OutOfMemoryError occurs
If java.lang.OutOfMemoryError occurred. is displayed, the message indicates that OutOfMemoryError has occurred.
The location where OutOfMemoryError has occurred is indicated in bold characters.

Example of output when OutOfMemoryError occurs

 :
#
# java.lang.OutOfMemoryError occurred.
# JavaVM aborted because of specified -XX:+HitachiOutOfMemoryAbort options.
# Please check Javacorefile:D:\Cosminexus\CC\server\public\ejb\MyJ2EEServer\javacore2100.120124144835​.txt
#

Example of output when OutOfMemoryError does not occur

:
#
# An unexpected error has been detected by Java Runtime Environment:
#
# EXCEPTION_ACCESS_VIOLATION (0xc0000005​) at pc=0x0000000008303​b00, pid=1356, tid=2604
#
# Java VM: Java HotSpot(TM) 64-Bit Server VM (11.3-b02-CDK0853-20101027​ mixed mode windows-amd64)
# Problematic frame:
# V [C:\Program Files\Hitachi\Cosminexus\jdk\jre\bin\server\jvm.dll+0x303b00]
#

Note

If OutOfMemoryError occurs, you must check the error report file. Go to step 3.

If OutOfMemoryError does not occur, see the description for the point Checks when OutOfMemoryError does not occur.

Check the extended verbosegc information and tune the memory size
Check the extended verbosegc information and adjust the Java heap memory size.
However, note that the hard disk memory size must not be exceeded.

For Windows x86
Specify -Xmx1024m.
If -Xmx1024m is already specified, you must either reduce the number of concurrently executing threads, or start multiple J2EE servers to distribute the load.

For Windows x64
Using the set value of the -Xmx option as an indicator, specify 1.5 to 2 times the value.

Restart the machine
Restart the machine and check if the operations can be executed without any problems.

Hint

Troubleshooting is complete when you restart the machine and can perform operations without any problems.

If the operations are not performed correctly even after the machine is restarted, go to step 5.

Output the class-wise statistics
Check the JavaVM garbage collection log (javalog[n].log), or operation log (HJVMStats_YYYYMMDDhhmmTZ.csv), for every 10 MB to 20 MB memory increased, execute the jheapprof command to output the class-wise statistics (txt file).
Repeat the process until the memory is increased to 100 MB or more.
If the command execution interval is short, the leaked memory size is also small, so it is difficult to find the class for which the memory has been increased.
By increasing the execution interval and incrementing the increase in memory, the class from which the memory is leaking is made to stand out.

Example of execution

% jheapprof -p 2463

Note

2463 in the example of execution becomes the process ID. When you execute the command, specify the process ID with the problem.

Output the class structure list
List and output the class structure containing the class picked up in the previous step as a member, create the class list to be checked, and then list up the check targets.

Example of execution

% jheapprof -class org.apache.catalina.loader.WebappClassLoder -p 2463

Note

2463 in the example of execution becomes the process ID. When you execute the command, specify the class with the problem.

org.apache.catalina.loader.WebappClassLoder in the example of execution becomes the class name. Use this class to check OutOfMemoryError caused by an insufficient Permanent area.

Request the developer to perform the check
Send the information collected in the previous step to the developer and request a check.

Hint

The procedure of performing a check when OutOfMemoryError does not occur is as follows. Note that the step numbers correspond to Figure 6-6.

Checks when OutOfMemoryError does not occur

3-1 Check the library where the signal occurred

Check the red portion in the example of output, and make a note of the down library name and the down native function.

In the example of output, the library name is NativeCrash.dll and the down native function is (null)+0x77C785BA.

3-2 Check the signal

If the location specified after "An unexpected error has been detected by HotSpot Virtual Machine: " is down due to signal 6 (SIGABRT, SIGIOT), the invocation destination library must be checked because the library is aborted by a higher abort function.

The above example is not aborted.

In this example, request a detailed check to the Oracle support service.

3-3 Send the collected results to the helpdesk

Send the library you have noted and the signal contents to the module developer or to the helpdesk based on the purchase agreement and request a check.

6.7.2 Troubleshooting when a response is delayed

This subsection describes troubleshooting for a delayed response.

Organization of this subsection

(1) Flow of actions when a response is delayed

(2) Flow of actions when a response is delayed

(1) Flow of actions when a response is delayed

The following figure shows the flow of troubleshooting when a response is delayed.

Figure 6-7 Flow of actions when a response is delayed

The details of the processing shown in the figure are described in subsection (2).

(2) Flow of actions when a response is delayed

The following points describe the operations according to the contents of the delayed response flow:

Check the CPU usage
Check the CPU usage of the applicable process.
The following is an example display of CPU usage with the task manager.

Figure 6-8 CPU usage

Hint

If 1core is close to 100%

This includes cases that run into an infinite loop and recursive invocation. A CPU bottleneck is a possible cause. Go to step 2 and proceed with the check.

If 1core is close to 0%

A possible cause is a non-responding or deadlocked back-end process, based on the reason that the back-end process does not return a response. Go to step 2 and proceed with the check.

Acquire the PRF trace
Execute the mngsvrutil command to output the PRF trace.

Example of execution

mngsvrutil -m 123.45.67.89 -u admin2 collect allPrfTraces

Open the PRF trace
Open the PRF trace.

Output destination

C:\Program Files\Hitachi\Cosminexus\manager\log\prf

File name

The file is output with the following file names for the trace information to be collected.

Note that the date and time at which the PRF trace was collected is displayed in date-and-time.

Performance tracer types | File name
All the performance tracers running on the hosts in the management domain | management-domain-name-date-and-time.zip
All the performance tracers running on a specific host | host-name-date-and-time.zip
Specific performance tracer | logical-server-name-date-and-time.zip

Check the PRF trace
Check the Time column in PRF trace and find the processing that requires a long period of time.
The PRF trace is a trace information that outputs events across processes and effective data for performance analysis or error analysis.

Figure 6-9 Example of output of PRF trace

In the example, there is a gap of 11 minutes after the SQL statement is issued. Furthermore, the execution of the SQL statement has not ended. Therefore, a problem might have occurred in the database while the SQL statement was being executed.
Note that the PRF trace is easy to check if you use spreadsheet software.

Output the thread dump
Execute the mngsvrutil command to output the thread dump.

Example of execution

mngsvrutil -m 123.45.67.89 -u admin2 dump server

Check the thread dump

For an infinite loop

The following figure shows an example of the thread dump output and the check points in the case of an infinite loop.

Figure 6-10 Example of thread dump output (infinite loop)

Output the thread dump multiple times, observe the time series, and perform a comparative check of the stack trace of the threads with the same tid in each thread dump.

Point 1

If the thread attribute is runnable, this thread is executable. This thread is participating in the increased CPU usage (if the attribute is waiting for monitor entry, the thread is not executable and so does not increase the CPU usage).

Point 2

All the thread attributes with the same tid are runnable in multiple thread dump files.

The threads might be running for a long period of time.

Point 3

If a specific line in the same method is being executed repeatedly, an infinite loop might be suspected.

Hint

If an infinite loop is suspected in the checks until now, request the developer to perform the check.

If an infinite loop is not suspected, go to step 7.

For a deadlock

The following figure shows an example of thread dump output and the check points in the case of a deadlock.

Figure 6-11 Example of thread dump output (deadlock)

The above figure shows an example of thread dump when a deadlock occurs.

The thread attributes are output after nid:... in the example of output.

Find the thread with the attribute waiting for monitor entry.

Check the contents of "-waiting to lock..." and "-locked...". There is a deadlock if the threads are waiting to acquire a lock for the areas that are mutually locked.

Point 1

If the thread attribute is runnable, this thread is executable, and so this thread is irrelevant to a deadlock.

Point 2

If the thread attribute is waiting for monitor entry, it indicates that this thread is waiting to acquire a lock.

This thread might have caused the deadlock.

Point 3

If a thread has acquired a lock, and if the thread is waiting for a lock at Point 2, there is a high possibility that the thread is causing the deadlock.

Compare the addresses of the locked objects to detect the deadlock for a thread applicable to Point 2 and Point 3.

In the example, Thread-3 has acquired the <02A328C8> lock and is waiting to acquire <02A328C0>.

On the other hand, Thread-1 has acquired the <02A328C0> lock and is waiting to acquire <02A328C8>. This shows that Thread-3 and Thread-1 are in a deadlock.

Hint

If a deadlock is suspected in the checks until now, request the developer to perform the check.

If a deadlock is not suspected, go to step 7.

Improve the business application. Remove redundant processing
Based on the results of checks on the PRF trace and the thread dump, check and take action if you suspect delays in the business application.

Hint

If the problem is resolved, the troubleshooting process ends at this point.

If the problem is not resolved and if the CPU usage is high, go to step 8.

If the problem is not resolved and if the CPU usage is low, request the helpdesk to check, based on the purchase agreement.

Reduce the parameters with concurrently executing threads and control the number of concurrently executing processing
The pending requests might accumulate, but you must wait for some time for the processing.

Upgrade the machine CPU
Note the additional middleware license costs when you upgrade the CPU.

Add more machines and distribute the load of the transactions
Note the additional hardware and software license costs when you add machines.

Hint

If the problem is resolved, the troubleshooting process is complete.

If the problem is not resolved, request the helpdesk to check, based on the purchase agreement.

7. Performance Analysis by Using Trace based Performance Analysis

The trace based performance analysis is the functionality to collect the performance analysis information (trace information) output by each functionality of Application Server when processing the requests from the client, and the performance analysis information (trace information) output by the processing of applications.

You can analyze the system and application performance based on this information. This chapter describes methods for analyzing the performance of the system and applications using the trace based performance analysis. For details on the collection of performance analysis information by the trace based performance analysis (trace collection point) and acquisition range of the information (PRF trace collection level), see the chapter 8. Trace Collection Points and PRF Trace Collection Levels of the Trace Based Performance Analysis.

Organization of this chapter

7.1 Organization of this chapter

7.2 Overview of the trace based performance analysis

7.3 Collecting the trace based performance analysis file by using Management Server

7.4 Implementation for collection of root application information of trace based performance analysis

7.5 Settings of execution environment

7.6 Logs output when the user-extended trace based performance analysis is executed

7.7 Analysis operation of the processing performance by using the trace based performance analysis file

7.8 Notes on using the user-extended trace based performance analysis

7.1 Organization of this chapter

By using the trace based performance analysis, you can monitor the operational status of each software type that configures the system and the trace information output by each server during request processing, thus you can check the processing performance of the whole system. If you monitor the processing performance, you can determine whether the study of an Application Server bottleneck and implementation of performance tuning is required. Furthermore, by analyzing the trace information output by the processing of the applications, you can check and compare the application performance. If you analyze the performance, you can check for application bottlenecks and determine whether the application requires improvement.

The following table describes the organization of this chapter.

Table 7-1 Organization of this chapter (Trace based Performance Analysis)

Category | Title | Reference location
Explanation | Overview of the trace based performance analysis | 7.2
Collecting the trace based performance analysis file by using Management Server | 7.3
Implementation | Implementation for collection of root application information of trace based performance analysis | 7.4
Setting | Settings of execution environment | 7.5
Operation | Logs output when the user-extended trace based performance analysis is executed | 7.6
Analysis operation of the processing performance by using the trace based performance analysis file | 7.7
Notes | Notes on using the user-extended trace based performance analysis | 7.8

7.2 Overview of the trace based performance analysis

The trace based performance analysis functionality uses the performance analysis information output by the Application Server functionality and the application processing to analyze the performance of Application Server and application processing.

The trace based performance analysis functionality includes the following types based on the performance analysis information to be used:

Trace based performance analysis of Application Server

Trace based performance analysis of applications

Note that in both the cases you use the component software Cosminexus Performance Tracer to analyze the processing performance.

The following figure gives an overview of the trace based performance analysis.

Figure 7-1 Overview of the trace based performance analysis

Points 1 and 2 in the figure indicate the trace based performance analysis of Application Server, and points 3 and 4 indicate the trace based performance analysis of applications. You can collectively analyze both the trace based performance analysis as the trace based performance analysis information.

Organization of this section

7.2.1 Overview of the trace based performance analysis of Application Server

7.2.2 Overview of the trace based performance analysis of applications

7.2.1 Overview of the trace based performance analysis of Application Server

The trace based performance analysis of Application Server is a functionality that analyzes the Application Server performance by using the performance analysis information (trace information) output by the Application Server functionality in the processes that handle the requests from the client, and the information used to determine the session life cycle (hereafter, the trace based performance analysis of Application Server will be referred to as trace based performance analysis). This analysis enables you to analyze the Application Server bottlenecks, to improve the efficiency of troubleshooting by checking the extent to which request processing has been attained when an error occurs, and to understand the session and global session information life cycles.

Organization of this subsection

(1) Collecting the trace information of the trace based performance analysis

(2) Working of Trace based performance analysis

(3) Configuration of the trace based performance analysis

(4) Troubleshooting by acquiring the Trace Information

(1) Collecting the trace information of the trace based performance analysis

The trace information of the trace based performance analysis collects the performance analysis information output in a series of processing of requests until the client reaches the components of the EIS such as a database, and until the processing results are returned to the client.

The following figure shows an overview of the trace information collection by the trace based performance analysis.

Figure 7-2 Overview of trace information collection of trace based performance analysis

When a request is sent from the Web client or the EJB client, the Web server, J2EE server, and CTM output the trace information to the buffer at determined processing points. If constant output information is collected, the trace is output in the trace file (PRFTrace file) depending on the performance tracer (PRF demon). The point at which the trace is output is called the trace get point. You can set the trace collection levels (standard or detailed) in the performance tracer. The trace collection levels set in the performance tracer are called PRF trace collection levels.

When you use Management Server for operations, you can collect the trace based performance analysis file by editing the PRF trace file in the text format. On the basis of the collected trace based performance analysis file, the operations administrator can perform the entire performance and bottleneck analysis in the management domain. For details on how to collect the trace based performance analysis file and the information that is output, see 7.3 Collecting the trace based performance analysis file by using Management Server.

(2) Working of Trace based performance analysis

You can use the trace based performance analysis to collect the trace information across multiple nodes and processes in an event within the system. This helps to trace the process in a sequence of processes in which there is a bottleneck.

To obtain the trace in an event, set a uniform key for the sequence of processes of an event in the trace based performance analysis. The information of the key is added to the trace that is output at the trace acquisition point in an event. The sequence of processes can be traced in this way.

Figure 7-3 Overview of trace output depending on the trace based performance analysis

The redirector and the Web container that output the trace are referred to as the function layer. In the trace based performance analysis, trace information is output at the entrance and the exit of the following function layer. Moreover, the trace information is output as and when necessary for each process that affects the performance among the processes of the function layers. The following table describes the execution environment of the application and the applicable function layer. In the trace based performance analysis, trace information is output at the entrance and the exit of the following function layer.

Table 7-2 Execution environment of the application and the applicable function layer

Function layer | Execution environment of the application
Execution environment of the J2EE application | Execution environment of the batch application
CTM | Y | --
Redirector | Y | --
Web container | Y | --
EJB container | Y | --
Timer Service | Y | --
JNDI | Y | Y
JTA | Y | Y
JCA container | Y | Y
DB Connector | Y | Y
RMI (communication processing)#1 | Y | Y
OTS | Y | Y
Standard output, standard error output, and user log | Y | Y
DI | Y | --
Batch application execution functionality | -- | Y#2
JPA | Y | --
Cosminexus JPA Provider | Y | --
TP1 inbound integrated function | Y | --
Cosminexus JMS Provider | Y | --
JavaMail | Y | --
CDI | Y | --

Legend:

Y: Applicable

--: Not applicable

#1

You can control the collection of the layer information for the function layer of RMI (communication processing). In such cases, you have to set control in the trace collection level. For details on the setting methods, see cprfstart command (Starting the PRF daemon) in the uCosminexus Application Server Command Reference Guide or cprflevel command (Displaying and changing the PRF trace collection level) in the uCosminexus Application Server Command Reference Guide.

#2

The trace information is output immediately before (immediately before invoking main method) executing the batch application and immediately after terminating the batch application. The trace information is not output at the execution of cjexecjob and cjkilljob command.

In addition to these function layers, the trace based performance analysis outputs the trace for the start process and stop process of the J2EE server, as well as when transaction timeout occurs, and when a session is generated or cancelled.

The trace information contains information such as the process ID used to get the trace information, eventID that indicates the get point, and the IP address of the client application that gets the trace get date or the trace information.

Reference note

In addition to these function layers, you can also obtain the PRF trace in the following function layers with the configuration software and related programs of Application Server:

Cosminexus Web Services - Base

uCosminexus TP1 Connector

TP1/Client/J

TP1/MQ Access

Cosminexus RM

HCSC server

HCSC server (Object Access adapter)

Service Coordinator Interactive Workflow

HCSC server ( file adapter)

HCSC server (Message Queue adapter)

HCSC server (FTP adapter)

JAX-WS Engine

Elastic Application Data store

The key information of the trace information consists of the following elements:

Configuration of the key information

Process ID used to obtain the key information

IP address of the host that invoked the process of acquiring the key information

Communication number allocated to the I/O process (PRF daemon) of the PRF trace
If the PRF daemon is not running, the time is returned as the communication number. It is important, however, to ensure that the PRF daemon is running, because the communication number may not be unique.

The following two types of key information are added to the PRF trace:

Root application information
This is the information obtained during the process that is executed first in the sequence of the processes in every event.

In the case of J2EE application
It is the information obtained in the redirector or the EJB client.

In the case of Batch application
It is the information obtained immediately before executing the batch application.

Client application information
In case of J2EE application, this is the information that is set for each processing that invokes the following Enterprise Beans:

Invoking the EJB container from the Web container

Invoking the EJB container from the EJB client

Invoking the EJB container from the EJB container

For batch applications, it is the information set immediately before executing batch application.

(3) Configuration of the trace based performance analysis

The trace based performance analysis consists of the following programs:

PRF trace output library
This program is embedded in each function layer of Application Server. The PRF trace output by each function layer is output in the buffer that is created in the shared memory.

PRF daemon
This is the I/O process to output the PRF trace that is output in the buffer to a file, after a certain amount of PRF trace is collected. At least one PRF daemon is invoked on each host that obtains the PRF trace. We recommend that you deploy one PRF daemon on one host.
The following figure shows the relationship between the PRF trace output library and the PRF daemon.

Figure 7-4 Relation between PRF trace output library and PRF daemon

The buffer area output by trace is created when the PRF daemon starts, depending on the PRF trace output library. The buffer area is created in the common memory. Any buffer area that was created in the previous invocations of the PRF daemon that is still remaining is re-used. The buffer area is not deleted when the PRF daemon that was invoked previously ends abnormally.

When the PRF daemon ends normally, the buffer data in the buffer area is output to a PRF trace file and the buffer area is deleted.

When the buffer area is insufficient, the message of KFCT26999-W might output and the PRF trace might not output at all. Therefore, you must tune the buffer size when the message is output.

(4) Troubleshooting by acquiring the Trace Information

The use of trace information in troubleshooting errors is explained below.

You can output the information in the trace based performance analysis and use it for troubleshooting as follows:

When a timeout occurs during the transaction of the J2EE application or in the redirector in receiving the response, you can use the root application information that is output in the trace based performance analysis to identify the transaction and the request that timed out.

If a failure occurs while connecting to the database, you can use the connection ID that is output in the trace based performance analysis to identify the connection in which the error occurred.

7.2.2 Overview of the trace based performance analysis of applications

The trace based performance analysis of applications is a functionality that analyzes the application processing performance by using the performance analysis information (trace information) output when the application processing to be traced is executed in the processes from the start up to the termination of an application (hereafter, the trace based performance analysis of applications is referred to as the user-extended trace based performance analysis). The user-extended trace based performance analysis presumes the use of the trace based performance analysis of the Application Server. This analysis enables you to identify the processing bottlenecks and to improve the efficiency of troubleshooting by checking the extent to which the processing has been attained when an error occurs. Furthermore, you specify the processing for which you want to acquire the performance analysis information in the configuration file for the user-extended trace based performance analysis. You can efficiently check and compare the application performance because the application need not acquire the performance analysis information.

Organization of this subsection

(1) Collecting the trace information of the user-extended trace based performance analysis

(2) Working of the user-extended trace based performance analysis

(3) Configuration of the user-extended trace based performance analysis

(1) Collecting the trace information of the user-extended trace based performance analysis

The trace information of the user-extended trace based performance analysis collects the performance analysis information that is output when the processing specified in the configuration file for the user-extended trace based performance analysis is executed.

The following figure gives an overview of the trace information collection for the user-extended trace based performance analysis.

Figure 7-5 Overview of the trace information collection for the user-extended trace based performance analysis

When you start the J2EE server, the configuration file for the user-extended trace based performance analysis is read. When the processing (trace collection point) specified in the configuration file for the user-extended trace based performance analysis is invoked, the trace information is output to a buffer. When a certain amount of information is collected, the performance tracer (PRF daemon) outputs the information to a trace file (PRF trace file).

When you use Management Server for operations, you can collect the trace based performance analysis file by editing the PRF trace file in the text format. On the basis of the collected trace based performance analysis file, the operations administrator can perform the entire performance and bottleneck analysis in the management domain. For details on how to collect the trace based performance analysis file and the information that is output, see 7.3 Collecting the trace based performance analysis file by using Management Server.

(2) Working of the user-extended trace based performance analysis

In the user-extended trace based performance analysis, you specify the names of the methods that will be used to acquire the trace information, in the configuration file for the user-extended trace based performance analysis. The following figure gives an overview of trace output for the specified methods.

Figure 7-6 Overview of trace output by the user-extended trace based performance analysis

If you enable the user-extended trace based performance analysis, the user-extended trace based performance analysis reads the configuration file for the user-extended trace based performance analysis. If the application is executed and if the methods (methods to be traced) specified in the configuration file for the user-extended trace based performance analysis are invoked, the trace information is output to the following locations:

Method entry
Trace information immediately after the method is started.

Normal exit of method
Trace information just before the method terminates normally.

Abnormal exit of method
Trace information immediately after an exception or error occurs in the method. However, the exceptions or errors thrown at the method invocation source are excluded.

(3) Configuration of the user-extended trace based performance analysis

The user-extended trace based performance analysis is configured from the following elements.

Note that the user-extended trace based performance analysis uses the class load hook processing of the instrumentation functionality and rewrites the applications to be traced in order to output the trace based performance analysis.

Configuration file for the user-extended trace based performance analysis
You set up the information about the methods to be traced by the user-extended trace based performance analysis by using the configuration file for the user-extended trace based performance analysis. For details on the contents of the configuration file for the user-extended trace based performance analysis, see 7.5.3 Settings for the methods to be traced by the user-extended trace based performance analysis.

PRF daemon
This is the I/O process to output the PRF trace that is output in the buffer to a file, after a certain amount of PRF trace is collected. At least one PRF daemon is invoked on each host that acquires the PRF trace. We recommend that you allocate one PRF daemon to one host.

The following figure shows the relationship between the configuration file for the user-extended trace based performance analysis and the PRF daemon.

Figure 7-7 Relationship between the configuration file for the user-extended trace based performance analysis and the PRF daemon

7.3 Collecting the trace based performance analysis file by using Management Server

When you use Management Server for operations, you can collect the contents of the trace file output to each host on the management server in a batch by using the management commands (mngsvrutil) of Management Server. Note that the PRF trace file output by the PRF daemon is a binary file. Management Server collects the file obtained by issuing instructions to Administration Agent, editing the PRF trace file in a text-format (CSV) file, and then compressing it (ZIP format). The PRF trace output by the hosts in the management domain can be collected on Management Server.

Note that the trace file edited in the text format is called the trace based performance analysis file.

For details on the management commands, see mngsvrutil (Management Server management commands) in the uCosminexus Application Server Command Reference Guide.

This section describes about the collection methods, output destination and the information of the trace based performance analysis file.

Organization of this section

7.3.1 How to collect a trace based performance analysis file

7.3.2 Output Destination and Output Information of a trace based performance analysis file

7.3.3 Output information of the trace based performance analysis file (for the trace based performance analysis)

7.3.4 Output information of the trace based performance analysis file (for the user-extended trace based performance analysis)

7.3.1 How to collect a trace based performance analysis file

When collecting the trace based performance analysis file, you have to use the management command (mngsvrutil) of the Management Server. Specify the subcommand collect to the mngsvrutil command. In the case of collecting a trace based performance analysis file, select the target for collecting the trace information. The following are the targets for collecting the trace information when using management command:

All the performance tracer that operate on the host in the management domain.

All the performance tracer that operate on a specific host

An identified performance tracer

The execution format and example of each case is described below:

When all the performance tracer that operate on the host in the management domain is the target

Execution format

mngsvrutil-m Host-name-of-Management-Server [:Port-Number]-u Management-user-ID -p Management-password collect allPrfTraces

Execution example

mngsvrutil -m mnghost -u user01 -p pw1 collect allPrfTraces

When all the performance tracer that operate on specific host is the target

Execution format

mngsvrutil-m Host-name-of-Management-Server -[:Port-Number]-u Management-user-ID -p Management-password -t Host-name -k host collect prfTrace

Execution example

mngsvrutil -m mnghost -u user01 -p pw1 -t host01 -k host collect prfTrace

When an identified performance tracer is the target

Execution format

mngsvrutil -m Host-name-of-Management-Server -u[:Port-Number] Management-user-ID -p Management-password -t Logical-performance-trace-user -k logicalServer collect prfTrace

Execution example

mngsvrutil -m mnghost -u user01 -p pw1 -t ID01 -k logicalServer collect prfTrace

7.3.2 Output Destination and Output Information of a trace based performance analysis file

This subsection describes the output destination and output information of the collected trace based performance analysis file.

Organization of this subsection

(1) Output destination of trace based performance analysis files

(1) Output destination of trace based performance analysis files

In Windows
log-output-directory-of-the-Manager\prf

In UNIX
log-output-directory-of-the-Manager/prf

Note that a trace based performance analysis file is output based on the trace information to be collected by the following file names.

Table 7-3 File names of trace based performance analysis files

Target for collecting trace information | File name
All the performance tracer that operate on the host in the management domain. | Management-domain-name - date-and-time#¹.zip
All the performance tracer that operate on a specific host. | Host-name - date-and-time#¹.zip
An identified performance tracer | Logical-server-name#² - date-and-time#¹.zip

#1

The date when the trace based performance analysis file is collected is displayed.

#2

The name of the identified performance tracer is displayed.

7.3.3 Output information of the trace based performance analysis file (for the trace based performance analysis)

The trace based performance analysis collects the trace information for the functionality layer.

The following table describes the information output to trace based performance analysis file (CSV format) from the performance tracer. The collection items differ in CTM and the other function layers. Note that the output items are different depending on each collection point such as the existence of the additional information. For details on the items output for each collection point, see the chapter 8. Trace Collection Points and PRF Trace Collection Levels of the Trace Based Performance Analysis.

Table 7-4 Information output to the trace based performance analysis file (for the trace based performance analysis)

Trace information header
Description
Range of values

PRF
Record status of that process (normal and abnormal).
Either of the following is output:
Normal: Rec
Abnormal: ErrRec

Process
Process ID of the process that acquired the trace information.
A decimal number of ten digits is output.

Thread
Thread ID and hash value of the thread in the process that acquired the trace information#1.
Thread ID: A decimal number up to twenty digits is output.
Hash value: A decimal number up to ten digits is output.

Trace
Trace sequence number of the thread in the process that acquired the trace information.
A decimal number of ten digits is output.

ProcessName
Process name
A string#2 displaying the process up to 32 characters is output.

Event
Event ID showing the trace collection point.
A hexadecimal number of six digits (include 0x also in six digits) is output#3.

Date
Date when the trace information is acquired.
The date is output in the yyyy/mm/dd format.
yyyy: Year
mm: Month
dd: Day

Time
Time when the trace information is acquired (Hours: Minutes: Seconds).
The time is output in the hh:mm:ss format.
hh: Hours
mm: Minutes
ss: Seconds

Time(msec/usec/nsec)
Time when the trace information is acquired (milli seconds/micro seconds/nanoseconds).
The time is output in the ms/us/ns format.
ms: Milli seconds
us: micro seconds
ns: nanoseconds

Rc
Return code.
A hexadecimal number of sixteen digits (include "0x" also in sixteen digits) is output.
Normal:0
Abnormal:1 (or other than 0)

ClientAP IP#4
IP address of the client application that acquired the trace information.
The IP address is output in the aaa.bbb.ccc.ddd format.

ClientAP PID#4
Process ID of the client application that acquired the trace information.
A decimal number of ten digits is output.

ClientAP CommNo.#4
Communication number of the client application that acquired the trace information.
A hexadecimal number of 18 digits (include 0x also in 18 digits) is output.

RootAP IP#5
IP address of a root application that acquired the trace information.
The IP address is output in the aaa.bbb.ccc.ddd format.

RootAP PID#5
Process ID of a root application that acquired the trace information.
A decimal number of ten digits is output.

RootAP CommNo.#5
The communication number of the root application that acquired the trace information.
A hexadecimal number of eighteen digits (include "0x" also in eighteen digits) is output.

SendSCD IP#5
IP address of the request source CTM.
The IP address is output in the aaa.bbb.ccc.ddd format.

SendSCD PID#6
Process ID of the request source CTM.
A decimal number of ten digits is output.

ReceiveSCD IP#6
IP address of the request destination CTM
The IP address is output in the aaa.bbb.ccc.ddd format.

ReceiveSCD PID#6
Process ID of the request destination CTM.
The decimal number of ten digits is output.

INT
Interface name for each collection point.
A string#7 up to 33 characters is output.

OPR
Operation information related to the collection point.
A string#7 up to 33 characters is output.

LookupName#6
Lookup name.
A string#7 up to 33 characters is output.

OPT#8
Additional information for each collection point.
A hexadecimal number string up to 514 characters is output.

ASCII
ASCII character output of the additional information for each collection point.
The OPT contents is output as ASCII character strings within 514 characters.

#1

There are cases when the hash value of a thread is not output in the trace information acquired by the redirector and CTM.

#2

The process name is decided as described below:

In the case of EJB client applications
The name specified in the system property ejbserver.server.prf.processName of the EJB client application.
If this system property is not specified or null character is specified in this property, the process name will be EJBClient.

In the case of J2EE server, batch server, or Web container server
The server name will be the process name.

In the case of redirector
If Hitachi Web Server is used as the Web server, "RD-Web-server-waits-to-receive-request-on-this-port-number" will be the process name. If Microsoft IIS is used, the process name will be Redirector.

In case of CTM
It is the name of each CTM process.

#3

An event ID is allocated to each trace collection point of the function layer. For details, see 8. Trace Collection Points and PRF Trace Collection Levels of the Trace based performance analysis.

#4

This is a component of client application information.

#5

This is a component of root application information. At the trace point that is output to the Web container, there are cases when the IP address, process ID, and communication number of the root application that acquired the trace information are output as 0.0.0. 0/0/0x0000000000000000. For details, see 7.7.7 Investigating the Log Using the Root Application Information.

Note that when you operate an HTTP server in a dual stack environment of IPv4 and IPv6, the IPv4 address is output to the process ID of the root application. Also, if the client address is IPv6 and is 33 characters or more, edit and output the trace information event IDs 0x8000 and 0x8100.

For event ID 0x8000: 32-characters-from-the-beginning + *

For event ID 0x8100: 16-characters-from-the-beginning + * + 16-characters-from-behind

In such cases, if both event IDs 0x8000 and 0x8100 are referenced, you can obtain the entire client address.

#6

The information that is output only for CTM. "****" is displayed in the layer other than CTM. In the systems executing batch application, the schedule group name is displayed.

#7

If the interface name, operation name, and lookup name exceeds 32 characters, the name is changed to 33 characters and is output with one of the following methods. For details, see 8. Trace Collection Points and PRF Trace Collection Levels of the Trace based performance analysis.

First 32 characters + *

First 16 characters + * + last 16 characters

* + last 32 characters

#8

Some function layers have trace collection points that output the entry time to OPT. The entry time is the time at which the entry trace corresponding to the trace of the trace collection point is output. For example, in the case of trace collection point of a redirector, the entry time output at the trace collection point when the process of sending HTTP response body information to a Web server finishes (0x8104), will be the time to start sending the HTTP response body information from a Web container (0x8004).

Note that the entry time is output in 16 bytes that is the time elapsed from 01/01/1970 00:00:00. The first 8 bytes of the value are seconds and the last 8 bytes of the value are microseconds. However, in the case of trace based performance analysis of redirector, the last 8 bytes are milli seconds.

7.3.4 Output information of the trace based performance analysis file (for the user-extended trace based performance analysis)

The user-extended trace based performance analysis collects the trace information output by the application processing.

For details on the items output in the trace based performance analysis, see 7.3.3 Output information of the trace based performance analysis file (for the trace based performance analysis).

Note that the items output at each collection point, such as presence or absence of the operation information, are different. For details on the items output at the collection points, see 8.28 Trace collection points for an application.

7.4 Implementation for collection of root application information of trace based performance analysis

This section describes an overview and implementation methods of the functionality of acquiring root application information of the trace based performance analysis.

root application information is the information that is acquired by the redirector or the EJB client among the information acquired by trace based performance analysis functionality. You can implement the functionality of acquiring the character string expression of the root application information in the J2EE application and batch application using API. When implemented, it would be helpful in troubleshooting when the trouble occurs since the functionality of acquiring the character string expression of the root application information can be compared with the trace based performance analysis file at the optional timing when the acquired character string expression is recorded in log file.

Use CprfTrace class for implementing the functionality of acquiring root application information of trace based performance analysis. To use CprfTrace class, specify the following path in the class path and compile.

In Windows
Cosminexus-installation-directory\CC\lib\ejbserver.jar

In Unix
/opt/Cosminexus/CC/lib/ejbserver.jar

For details on the CprfTrace class, see 9.2 CprfTrace Class in the uCosminexus Application Server API Reference Guide.

For details on the investigation of using the root application information, see the subsection 7.7.7 Investigating the Log Using the Root Application Information.

7.5 Settings of execution environment

This section describes the settings required for using the trace based performance analysis and user-extended trace based performance analysis.

Different items will be set up for the trace based performance analysis and the user-extended trace based performance analysis. The following table describes the settings required for the trace information to be acquired.

Table 7-5 Settings required for the trace information to be acquired

Settings | Trace information to be acquired | Reference location
Trace based performance analysis | User-extended trace based performance analysis
Settings for using the trace based performance analysis | Y | Y | 7.5.1
Settings for using the user-extended trace based performance analysis | -- | Y | 7.5.2
Settings for the methods to be traced by the user-extended trace based performance analysis | -- | Y | 7.5.3

Legend:

Y: Settings are required.

--: Settings are not required.

Organization of this section

7.5.1 Settings for using the trace based performance analysis

7.5.2 Settings for using the user-extended trace based performance analysis

7.5.3 Settings for the methods to be traced by the user-extended trace based performance analysis

7.5.1 Settings for using the trace based performance analysis

The following settings are required when using the trace based performance analysis:

Management Server

Performance tracer

Note

Note the following points when you specify the environment variables in AIX:

With the Performance Tracer execution environment, set up early in the environment variable PSALLOC. If this value is not set and if a memory shortage occurs, the operations might not function correctly.

Set up early in the environment variable PSALLOC specifying the early paging space allocation in AIX. For the points to be considered when you estimate the paging space for the early paging space allocation, see the AIX manual System Management Concepts: Operation Systems and Devices.

With the Performance Tracer execution environment, set up true in the environment variable NODISCLAIM. If you specify early in the environment variable PSALLOC, and do not specify true in the environment variable NODISCLAIM, the responses, throughput, and CPU usage might deteriorate greatly.

To extend the user data area and shared memory area to be used with Performance Tracer, set up MAXDATA=0x40000000 in the environment variable LDR_CNTRL. Allocate 1 gigabyte memory.

With the Performance Tracer execution environment, set up ON in the environment variable EXTSHM. If no value is set up, sometimes the shared memory cannot be referenced.

Organization of this subsection

(1) Management Server settings

(2) Setting of performance trace

(1) Management Server settings

The setting of the Management Server is executed by mserver.properties (Management Server environment setting file). The setting parameters are as follows:

com.cosminexus.manager.tracelog.size
Specify the number of files of the trace based performance analysis file collected by Management Server.

For details on mserver.properties and the key, see 10.7 mserver.properties (Management Server environment setting file) in the uCosminexus Application Server Definition Reference Guide.

For details on the trace based performance analysis file, see the section 7.3 Collecting the trace based performance analysis file by using Management Server.

(2) Setting of performance trace

The setting of the performance tracer (PRF daemon) is implemented by the Easy Setup definition file. Specify the definition of trace based performance analysis in the <configuration> tab of the logical performance trace (performance-tracer) of the Easy Setup definition file.

The following table describes the definition of the trace based performance analysis in the Easy Setup definition file.

Table 7-6 Definition of trace based performance analysis in the Easy Setup definition file

Parameter to specify | Setting contents
PrfTraceLevel | The functionality (Web server, J2EE server, CTM) of Application Server outputs in the buffer, specifies trace collection level of the performance trace.
PrfTraceCount | Specifies the number of files of the PRF trace of performance trace.
PrfTraceFileSize | Specifies the file size of the performance tracer. Set the value consisting the relation of PrfTraceFileSize PrfTraceBufferSize.
PrfTraceBufferSize | Specifies the buffer size of the performance tracer. Set the value consisting the relation of PrfTraceFileSize PrfTraceBufferSize.

#

For details on the Easy Setup definition file and each parameter to be specified, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

7.5.2 Settings for using the user-extended trace based performance analysis

To use the user-extended trace based performance analysis, you must specify the following settings before you start the server:

J2EE server

Batch server

EJB client application

Settings for the methods to be traced by the user-extended trace based performance analysis

Organization of this subsection

(1) J2EE server settings

(2) Batch server settings

(3) EJB client application settings

(4) Settings for the user-extended trace based performance analysis configuration file

(1) J2EE server settings

Implement the J2EE server settings using the Easy Setup definition file.

Define the user-extended trace based performance analysis in the JavaVM startup parameter (add.jvm.arg) in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file.

The following table describes the definition of the user-extended trace based performance analysis in the Easy Setup definition file.

Table 7-7 Definition of the user-extended trace based performance analysis in the Easy Setup definition file

Item
Specified parameter
Settings

Settings to enable the user-extended trace based performance analysis
jvm.userprf.Enable
To use the user-extended trace based performance analysis, specify the settings to enable.

Settings to specify the configuration file for the user-extended trace based performance analysis
jvm.userprf.File#1
Specify the file path of the user-extended trace based performance analysis configuration file to be used for the user-extended trace based performance analysis.

Settings related to application rewriting
jvm.userprf.Limit
Specify the maximum number of methods to be rewritten from the methods specified in the configuration file for the user-extended trace based performance analysis. Among the methods specified in the configuration file for the user-extended trace based performance analysis, the methods exceeding this value are not traced.

jvm.userprf.Trace
Specify whether log will be output when the class files specified in the configuration file for the user-extended trace based performance analysis are successfully rewritten. Note that if the rewriting of the class files fails, the log is necessarily output.

Settings related to the output information of the user-extended trace based performance analysis
jvm.userprf.ExtendedSetting#2
Specify whether the trace target can be specified for packages or classes in addition to methods.

jvm.userprf.LineNumber
Specify whether the line number of the line that the method executes last in the case of a normal exit, will be output to the trace information.

jvm.userprf.ThrowableName
Specify whether the exception or error class name will be output to the trace information.

jvm.userprf.ThrowableNameEditMethod
Specify how the name will be edited when the exception or error class name exceeds the limit of 32 characters.

jvm.userprf.LogLevel
Specify the trace output level of the user-extended trace based performance analysis.

#1

The default values are as follows:

In Windows

JDK-installation-directory\usrconf\userprf.cfg

In UNIX

/opt/Cosminexus/jdk/usrconf/userprf.cfg

#2

The amount of methods to be traced increases due to the specification format of the user-extended trace based performance analysis configuration file permitted by setting up the jvm.userprf.ExtendedSetting property. Therefore, note that the amount of trace that is output increases and affects the system performance. For details on the notes for using the user-extended trace based performance analysis, see 7.8 Notes for using the user-extended trace based performance analysis.

For details on the Easy Setup definition file and the parameters to be specified, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

An example of definition is as follows:

...
<param>
<param-name>add.jvm.arg</param-name>
<param-value>-Djvm.userprf.Enable=true</param-value>
<param-value>-Djvm.userprf.File=Cosminexus-installation-directory/CC/server/usrconf/ejb/real-server-name/userprf.cfg</param-value>
<param-value>-Djvm.userprf.LogLevel=class</param-value>
</param>
...

Reference note

You can also specify the J2EE server settings in the Start Parameter Settings window (defining the logical J2EE server) of the management portal. For details on how to specify the settings on the management portal, see 10.9.20 Startup parameter settings (J2EE server) in the uCosminexus Application Server Management Portal Operation Guide.

(2) Batch server settings

Implement the batch server settings using the Easy Setup definition file.

Define the user-extended trace based performance analysis in the JavaVM startup parameter (add.jvm.arg) in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. For details on the parameter values to be specified, see (1) J2EE server settings.

(3) EJB client application settings

Implement the settings for an EJB client application, which is running with the cjclstartap command, using the option definition file for EJB client applications (usrconf.cfg).

Define the user-extended trace based performance analysis in the JavaVM startup parameter (add.jvm.arg) of the option definition file for EJB client applications (usrconf.cfg). For details on the parameter values to be specified, see (1) J2EE server settings.

An example of definition in the option definition file for EJB client applications (usrconf.cfg) is as follows:

...
add.jvm.arg= -Djvm.userprf.Enable=true
add.jvm.arg= -Djvm.userprf.File=Cosminexus-installation-directory/CC/server/usrconf/ejb/real-server-name/userprf.cfg
add.jvm.arg= -Djvm.userprf.LogLevel=class
...

(4) Settings for the user-extended trace based performance analysis configuration file

To use the user-extended trace based performance analysis, you must create the configuration file for the user-extended trace based performance analysis and specify the settings for the methods to be traced.

Specify the settings for the methods to be traced in the UserPrfText parameter in the <configuration> tag of the logical J2EE server (J2EE-Server) in the Easy Setup definition file.

An example of definition is as follows:

...
<param>
<param-name>UserPrfText</param-name>
<param-value>
<![CDATA[
org.apache.struts.action.Action.execute(*), struts, true
Info.getInfo(*), struts, true
]]>
</param-value>
</param>
...

For details on how to create the configuration file for the user-extended trace based performance analysis, see 7.5.3 Settings for the methods to be traced by the user-extended trace based performance analysis.

Reference note

You can also set up the configuration file for the user-extended trace based performance analysis in the Start Parameter Settings window (defining the logical J2EE server) of the management portal or a user optional file (file specified in the jvm.userprf.File property).

7.5.3 Settings for the methods to be traced by the user-extended trace based performance analysis

Use the configuration file for the user-extended trace based performance analysis to specify the settings for the methods to be traced by the user-extended trace based performance analysis. You can code the contents of the configuration file for the user-extended trace based performance analysis in one of the following files or window:

Easy Setup definition file

Start Parameter Settings window (defining the logical J2EE server) of the management portal

Default file or any user-specified file (file specified in the jvm.userprf.File property)

Organization of this subsection

(1) Format of description

(2) Description items

(3) Rules of description

(4) Example of description of the configuration file for the user-extended trace based performance analysis

(5) Notes on creating the configuration file for the user-extended trace based performance analysis

(1) Format of description

The format for coding the configuration file for the user-extended trace based performance analysis is as follows:

specification-format#, identity-ID, subclass-flag [, [event-ID][,[trace-collection-level]]] [# Comment]

#1:

You can omit the items enclosed within [ ].

#2:

To trace all the methods with matching class names and package names, set up true in the value of the jvm.userprf.ExtendedSetting property.

#:

Specify specification-format in one of the following formats:

To trace a method with matching method name and argument types
package-name.class-name.method-name (type name of the method argument)

To trace methods with matching method names
package-name.class-name.method-name(*)

To trace all the methods with matching class names
package-name.class-name

To trace all the methods with matching package names
package-name.*

Example of coding format:

com.sample.Test.method(),TEST1,false,0xae02,A
com.sample.Test.method(),TEST1,false,0xae02
com.sample.Test.method(),TEST1,false,0xae02,
com.sample.Test.method(),TEST1,false,,A
com.sample.Test.method(),TEST1,false
com.sample.Test.method(),TEST1,false,
com.sample.Test.method(),TEST1,false,,

(2) Description items

The items coded in the configuration file for the user-extended trace based performance analysis are as follows:

Specification-format

Specify the method to be traced.

package-name

Specify the package name of the class or interface of the method to be traced.

class-name

Specify the class name or interface name of the method to be traced. If you specify the interface name instead of the class name, and if true is specified in the subclass flag, the method implementing that interface is traced.

method-name

Specify the method to be traced.

type-name-of-the-method-argument

Specify the argument type of the method to be traced using the fully qualified name.

identity-ID

Specify the character string for identifying the method to be traced.

The characters you can use are the ASCII characters from 0x21(!) to 0x7e(~). However, you cannot specify 0x22(") , 0x23(#), and 0x2c(,).

The identity ID is output to the PRF trace file. Note that up to 32 characters are output to the PRF trace file. The 33rd and subsequent characters are omitted and * (asterisk) is output as the 33rd character.

Note

If a subclass exists in the class defining the method to be traced and if the method to be traced is not overridden in that subclass, the specified identity ID is output for the superclass method to be traced.

subclass-flag

Specify whether to trace the methods of the class that has an inheritance relationship with the classes or interfaces of the specified method, using true or false.

If you specify true, the specified method and the methods overriding the specified method are traced.

If you specify false, only the specified method is traced, and the methods overriding the specified method are not traced.

event-ID

Specify the point for acquiring the trace information (trace collection point) using a hexadecimal value (0xae02 to 0xae7e and 0xc000 to 0xcffe). The default value is 0xae00.

This value is output in the trace information that is output at the method entry, and this value + 1 is output in the trace information that is output at the method exit.

trace-collection-level

Specify A, B, C, or their respective lower cases in the trace collection level of the methods to be traced. The default value is A.

A: Standard level

B: Advanced level

C: Maintenance level

Reference note

The trace collection level is the same as the PRF trace collection level of the cprflevel command. All the methods to be traced reference the levels of the Java VM layers. For details on the PRF collection levels and layers, see cprflevel (Displaying and changing PRF trace collection level) in the uCosminexus Application Server Command Reference Guide.

comment

A comment begins with # (hash mark). All the characters from # (hash mark) up to the end of the line are assumed to be a comment.

(3) Rules of description

The rules for coding the configuration file for the user-extended trace based performance analysis are as follows:

You can use only single-byte characters in the code.

A space character becomes a single-byte space character (0x20) or a tab character (\t or 0x09). Note that the space characters are ignored when the configuration file for the user-extended trace based performance analysis is read.

Code one method to be traced on one line.

You can specify up to 2,048 characters in 1 line. This character count includes the spaces and comments.

The end of the line is indicated by 1 or more continuous linefeed characters (\n or 0x0A) or carriage return characters (\r or 0x0D).

If the description in the configuration file for the user-extended trace based performance analysis is incorrect, a message describing the incorrect contents is displayed. Also, if invalid values are coded for the items, a message indicating incorrect contents is output, and the settings for that line are disabled.
For details on the message, see 7.6 Logs output when the user-extended trace based performance analysis is executed.

With the user-extended trace based performance analysis, you cannot specify the JavaVM classes and Cosminexus classes in the methods to be traced. The following packages are applicable:

Classes beneath java

Classes beneath javax

Classes beneath com.hitachi

Classes beneath JP.co.Hitachi

Therefore, when you want to specify a package name by specifying the jvm.userprf.ExtendedSetting property, code the package name such that only the application classes are included.

You cannot specify the following methods as the methods to be traced:

Non-existent package name, class name, and method name

native method

abstract method

Classes in JavaVM and the methods of those classes
(Example) Classes of packages beginning with java and javax

Classes specified in -Xbootclasspath and the methods of those classes

Classes in Cosminexus

You can specify the following methods as the methods to be traced using the following code:

You can specify the constructor using the same method name as the class name, or <init>.
(Example) Specify as follows for the constructor of the MyMain class:
MyMain.MyMain() or MyMain.<init>()

If you specify a method with the same name as a non-constructor class name, whether a constructor or a method has been specified cannot be determined, therefore, the constructor and method are traced.

When specifying a method with variable length arguments, describe the variable length arguments as an array.
(Example) Specification of a method with variable length argument
Example of correct specification: com.sample.Test.method(java.lang.String[] args)
Example of incorrect specification: com.sample.Test.method(java.lang.String args)

Specify the name of a nested class using '$' (dollar sign) as a delimiter instead of '. ' (period).
(Example) Specification of a nested class
Example of correct specification: com.sample.Test$NestClass
Example of incorrect specification: com.sample.Test.NestClass

You can specify a non-generics and non-parameter class name (raw type).
(Example) Specification of a non-generics class
Example of correct specification: com.sample.Test.method()
Example of incorrect specification: com.sample.Test<java.lang.String,java.lang.Object>.method()

The methods to be traced differ when you specify a class name and when you specify an interface name in class-name in specification-format.
The following table describes the methods to be traced based on the class or interface specification.

Table 7-8 Methods to be traced based on the class or interface specification

Class or interface | Method to be traced
When false is specified in the subclass flag | When true is specified in the subclass flag
Class | Method of the specified class | The methods of the specified class and the methods overriding these methods
Interface | None | The methods of the class#1 that directly implements the specified interface and the class#2 that indirectly implements the interface, and the methods overriding these methods

#1

This class implements the interface specified by using implements when the class is declared.

#2

This subclass of the class that directly implements the specified interface, or the class that directly implements the interface that inherits the specified interface.

(4) Example of description of the configuration file for the user-extended trace based performance analysis

This section describes the examples of coding of the configuration file for the user-extended trace based performance analysis for each method to be traced.

Note that the examples of code assume that the package name is com.sample, and that the application has the class structure shown in the following figure.

Figure 7-8 Example of the class structure of the application

(a) To trace a method with matching method name and argument types

The following is an example of coding the user-extended trace based performance analysis configuration file when you want to trace a method with a matching method name and argument types:

If the subclass flag is false

com.sample.ClassA.methodA1(java.lang.String,java.lang.Object),1000,false

If the subclass flag is false, the coded method with a matching method name and argument types is traced.

Method to be traced

methodA1(String,Object) of the ClassA class

The event ID is not set for the method to be traced, so if you invoke the method to be traced, the default value 0xae00 is output as the event ID at the method entry, 0xae01 is output at the method exit. Also, 1000 is set in the identity ID, so 1000 is output as the identity ID.

If the subclass flag is true

com.sample.ClassA.methodA2(),2000,true

If the subclass flag is true, in addition to the method in which the method name and argument types match the code, the methods overriding the coded method are also traced.

Methods to be traced

methodA2() of the ClassA class

methodA2() of the ClassB class that overrides methodA2() of the ClassA class

The event ID is not set for the method to be traced, so if you invoke the method to be traced, the default value 0xae00 is output as the event ID at the method entry, 0xae01 is output at the method exit. Also, 2000 is set in the identity ID, so 2000 is output as the identity ID for all the methods to be traced.

(b) To trace methods with matching method names

The following is an example of coding the user-extended trace based performance analysis configuration file when you want to trace methods with matching method names:

If the subclass flag is false

com.sample.ClassA.methodA1(*),methodA1,false,0xae30

If the subclass flag is false, all the methods matching with the coded method names are traced.

Methods to be traced

methodA1(String,Object) of the ClassA class

methodA1(int) of the ClassA class

If the method to be traced is invoked, 0xae30 is output as the event ID at the method entry, and 0xae31 is output at the method exit. Also, methodA1 is output as the identity ID for all the methods to be traced.

If the subclass flag is true

com.sample.ClassA.methodA1(*),methodA1,true,0xae30

If the subclass flag is true, all the methods matching with the coded method names are traced. Also, in addition to the coded method, the methods overriding the coded method are also traced.

Methods to be traced

methodA1(String,Object) and methodA1(int) of the ClassA class

methodA1(String,Object) of the ClassB class that overrides methodA1(String,Object) of the ClassA class

methodA1(String,Object) of the ClassC class that overrides methodA1(String,Object) of the ClassB class

If the method to be traced is invoked, 0xae30 is output as the event ID at method entry, and 0xae31 is output at method exit. Also, methodA1 is output as the identity ID for all the methods to be traced.

(c) To trace all the methods with matching class names

The following is an example of coding the user-extended trace based performance analysis configuration file when you trace all the methods with matching class names, omitting the methods and arguments.

If the subclass flag is false

com.sample.ClassA,TEST01,false

If the subclass flag is false, all the methods with the coded class name (ClassA class) are traced.

Methods to be traced

methodA1(String,Object), methodA1(int), and methodA2() of the ClassA class

If the method to be traced is invoked, 0xae00 is output at method entry and 0xae01 is output at method exit because the event ID is omitted. Also, TEST01 is output as the identity ID for all the methods.

If the subclass flag is true

com.sample.ClassB,TEST02,true

If the subclass flag is true, all the methods with the coded class name (ClassB class), and all the methods that override these methods are traced.

Methods to be traced

methodA1(String,Object) of the ClassB class

methodA2() of the ClassB class

methodB1() of the ClassB class

methodA1(String,Object) of the ClassC class that overrides methodA1(String,Object) of the ClassB class

If the method to be traced is invoked, 0xae00 is output at method entry and 0xae01 is output at method exit because the event ID is omitted. Also, TEST02 is output as the identity ID for all the methods.

(d) To trace all the methods with matching package names

The following is an example of coding the user-extended trace based performance analysis configuration file when you trace all the methods of all the classes with matching package names, omitting the class names, method names, and arguments.

Note

This specification also includes the sub-packages as trace targets. When a sub-package is to be traced, the trace is output when the target method is invoked.

If the com.sample package has a sub-package, all the methods of all the classes of that sub-package are also traced.

If the subclass flag is false

com.sample.*,6000,false

If the subclass flag is false, all the methods of all the classes in the coded package (com.sample) are traced.

Methods to be traced

All the methods of ClassA, ClassB, ClassC, and ClassD are traced.

If the method to be traced is invoked, 0xae00 is output at method entry and 0xae01 is output at method exit because the event ID is omitted. Also, 6000 is output as the identity ID for all the methods.

If the subclass flag is true

com.sample.*,6000,false

If the subclass flag is true, all the methods of all the classes in the coded package (com.sample), and all the methods that override these methods are traced.

Methods to be traced

All the methods of ClassA, ClassB, ClassC, and ClassD, and all the methods that override these methods are traced.

If the method to be traced is invoked, 0xae00 is output at method entry and 0xae01 is output at method exit because the event ID is omitted. Also, 6001 is output as the identity ID for all the methods.

(5) Notes on creating the configuration file for the user-extended trace based performance analysis

The precautions to be taken when you create a configuration file for the user-extended trace based performance analysis are as follows:

If you specify a different event ID or identity ID in multiple lines for the same method in the configuration file for the user-extended trace based performance analysis, the settings coded first in the configuration file for the user-extended trace based performance analysis will have priority.

If you code multiple methods as targets in the configuration file for the user-extended trace based performance analysis, all the target methods are output with the same event ID or identity ID. In this case, if the method name that is output exceeds the number of characters that can be output, you might not be able to identify the method. Specify the settings so that one method can be identified.

If you want to trace an interface, specify true in the subclass flag. If you specify false in the subclass flag, the trace information is not output because the methods to be traced do not exist in an interface.

Use the specification format where multiple methods are the targets for user-extended analysis trace only when you want to understand the application operations.
In the code of the configuration file for the user-extended trace based performance analysis, if true is specified in the subclass flag, and you specify the specification format by which the methods with matching method names are traced, many unintended methods become targets of the user-extended trace based performance analysis, and identifying the cause of performance deterioration might become difficult. To identify the cause of performance deterioration, we recommend that you limit the targets for user-extended trace based performance analysis by specifying false in the subclass flag of the configuration file for the user-extended trace based performance analysis, or use the specification format by which the methods with matching method name and argument types are traced.

7.6 Logs output when the user-extended trace based performance analysis is executed

When you execute the user-extended trace based performance analysis, the following logs are output to the JavaVM log file:

Logs for reading the configuration file for the user-extended trace based performance analysis

Logs for application rewriting

The following points describe the respective logs.

Organization of this section

(1) Logs for the reading of the configuration file for the user-extended trace based performance analysis

(2) Logs for application rewriting

(1) Logs for the reading of the configuration file for the user-extended trace based performance analysis

The following table describes the logs output when the configuration file for the user-extended trace based performance analysis is read during the user-extended trace based performance analysis.

Table 7-9 Logs output the configuration file for the user-extended trace based performance analysis is read

Output format
Output contents
Explanation

[UPR#1]<DATE>Setting file not found.<file=FILEPATH>

DATE#2
The date and time at which an attempt to read the configuration file for the user-extended trace based performance analysis failed.

FILEPATH
The absolute file path of the configuration file for the user-extended trace based performance analysis that could not be read.

The default configuration file, or the configuration file for the user-extended trace based performance analysis specified in the jvm.userprf.File property does not exist.

[UPR#1]<DATE>Failed to open setting file.<file=FILEPATH>

DATE#2
The date and time at which an attempt to read the configuration file for the user-extended trace based performance analysis failed.

FILEPATH
The absolute file path of the configuration file for the user-extended trace based performance analysis that could not be read.

The configuration file for the user-extended trace based performance analysis cannot be opened or read.

[UPR#1]<DATE>Failed to parse setting file.<file=FILEPATH><line=LINE>

DATE#2
The date and time at which an error was detected in the configuration file for the user-extended trace based performance analysis.

FILEPATH
The absolute file path of the configuration file for the user-extended trace based performance analysis.

LINE
The line number in the configuration file for the user-extended trace based performance analysis.

There is a description format error in the contents of the configuration file for the user-extended trace based performance.

[UPR#1]<DATE>Event ID is invalid value.<file=FILEPATH><eventID=EventID>

DATE#2
The date and time at which an error was detected in the configuration file for the user-extended trace based performance analysis.

FILEPATH
The absolute file path of the configuration file for the user-extended trace based performance analysis.

EventID: The event ID specified in the user-extended trace based performance analysis configuration file.

The event ID of the configuration file for the user-extended trace based performance analysis is outside the range of valid values.

[UPR#1]<DATE>No valid settings in setting file.<file=FILEPATH>

DATE#2
The date and time at which invalid settings were detected in the configuration file for the user-extended trace based performance analysis.

FILEPATH
The absolute file path of the configuration file for the user-extended trace based performance analysis.

The settings in the configuration file for the user-extended trace based performance analysis are invalid.

[UPR#1]<DATE>User Extended PRF started successfully.<file=FILEPATH>

DATE#2
The date and time at which the reading of the configuration file for the user-extended trace based performance analysis was successful.

FILEPATH
The absolute file path of the configuration file for the user-extended trace based performance analysis that was read properly.

The user-extended trace based performance analysis configuration file is read correctly, and the user-extended trace based performance analysis is now valid.

#1

An identifier indicating that the log was output by the user-extended trace based performance analysis.

#2

Output in the same format as the extended verbosegc information.

(2) Logs for application rewriting

The user-extended trace based performance analysis uses the instrumentation functionality and rewrites the application classes when the class is loaded, in order to output the trace based performance analysis. The following table describes the logs output at this time.

Table 7-10 Logs for application rewriting

Output format
Output contents
Explanation

[UPR#1]<DATE>BCI process failed.<class=CLASS>

DATE#2
The date and time at which an attempt to rewrite failed.

CLASS
The fully qualified class name for which rewriting failed.

An attempt to rewrite the class specified in the configuration file for the user-extended trace based performance analysis failed.

[UPR#1]<DATE>BCI process finished successfully.<class=CLASS>

DATE#2
The date and time at which rewriting was successful.

CLASS
The fully qualified class name for which rewriting was successful.

The class specified in the configuration file for the user-extended trace based performance analysis was successfully rewritten. Note that this log is output when true is specified in the jvm.userprf.Trace property.

[UPR#1]<DATE>BCI count exceeded a limit.

DATE#2
The date and time at which the rewriting count exceeded the upper limit.

An attempt was made to rewrite the methods to be traced, exceeding the number specified in the jvm.userprf.Limit property. Take one of the following actions:

Reduce the number of target methods of the user-extended trace based performance analysis.

Increase the value specified in the jvm.userprf.Limit property.

Note that this log is output when the value specified in the jvm.userprf.Limit property is exceeded for the first time.

#1

An identifier indicating that the log was output by the user-extended trace based performance analysis.

#2

Output in the same format as the extended verbosegc information.

7.7 Analysis operation of the processing performance by using the trace based performance analysis file

This section describes about the analysis operation of the processing performance using the trace based performance analysis file.

Organization of this section

7.7.1 Overview of the Operation for Analyzing the Processing Performance

7.7.2 Analyzing the Response Time of a Web Server

7.7.3 Investigating the Processing Status of a Request in an Application Server

7.7.4 Investigating the Life Cycle of a Session

7.7.5 Identifying the Transaction in Which a Timeout Occurred

7.7.6 Identifying the Request for Which Timeout Occurred

7.7.7 Investigating the Log Using the Root Application Information

7.7.8 Identifying the Connection in Which an Error Occurred

7.7.9 Investigation about the location of the problem associated to the trace based performance analysis file and thread dump

7.7.1 Overview of the Operation for Analyzing the Processing Performance

You can analyze the processing performance of Application Server based on the trace information output from the function layer such as the redirector and Web container, in the series of processes from the client to EIS such as databases, until the processing result is returned to the client.

Note that the trace information of each function layer is output to the PRF trace file in the binary format. When analyzing the processing performance of Application Server, use the trace based performance analysis file where PRF trace file is converted in to text format (CSV format).

The description of the operation of analyzing the processing performance of Application Server is as follows:

Reference note

Maintenance level trace information

The PRF trace collection level includes the maintenance level in addition to the standard level and detailed level. The maintenance level is a level for acquiring the maintenance information in the case of an error. Do not specify the maintenance level in normal cases.

For how to set up the maintenance level in PRF trace collection levels, see cprflevel (Displaying and changing the PRF trace collection level) in the uCosminexus Application Server Command Reference Guide.

Organization of this subsection

(1) Collecting a trace based performance analysis file

(2) Analyzing the processing performance of Application Server using a trace based performance analysis file

(1) Collecting a trace based performance analysis file

Collect the trace based performance analysis files used for analyzing the processing performance of Application Server, which is output using the management command mngsvrutil. For details on how to collect the trace based performance analysis file and on the output destinations and output information of the trace based performance analysis file, see 7.3 Collecting the trace based performance analysis file by using Management Server.

(2) Analyzing the processing performance of Application Server using a trace based performance analysis file

To analyze the performance using a trace based performance analysis file, display the file in an application program that can edit CSV format files, and use the filtering or sorting function as required.

For example, when the information is output in the CSV format, you can filter the output items as 'event-wise', or 'process-wise', in the application programs that can edit files in the CSV format, list the locations to be focused, and analyze the information according to your requirement.

How to use the trace based performance analysis file is described below by giving an example.

For details on analyzing the response time of the Web server, see 7.7.2 Analyzing the Response Time of a Web Server.

For details on investigating the processing status of a request in Application Server, see 7.7.3 Investigating the Processing Status of a Request in an Application Server.

For details on investigating the life cycle of the session, see 7.7.4 Investigating the Life Cycle of a Session.

For details on identifying the transaction in which the timeout occurs, see 7.7.5 Identifying the Transaction in Which a Timeout Occurred.

For details on identifying of the request for which time-out occurs, see 7.7.6 Identifying the Request for Which Timeout Occurred.

For details on the log investigation where root application information is used, see 7.7.7 Investigating the log Using the Root Application Information.

For details on identifying the connection where the trouble occurred, see 7.7.8 Identifying the Connection in Which an Error Occurred.

For details on the investigation about the location of the problem associated to Trace based performance analysis and thread dump, see 7.7.9 Investigation about the location of the problem associated to the trace based performance analysis file and thread dump.

Note that the collection of trace based performance analysis files in such an environment as the following Web client configuration environment is a prerequisite.

Figure 7-9 Example of Web client configuration

7.7.2 Analyzing the Response Time of a Web Server

This subsection describes how to analyze the time from when a Web server received a request from a client to when the response was returned to the client, with an example.

You use the event ID x8001 and 0x8101 assigned to the redirector as a key to perform filtering of trace based performance analysis files collected in the Web server. The following table describes the trace collection points which are indicated by the event IDs used in filtering.

Table 7-11 Trace collection points indicated by the event IDs used in filtering

Event ID | Trace acquisition points
0x8001 | Sending the request header information to a Web container
0x8101 | Receiving the response completion notification from the Web container

The following is an example of filtering the trace based performance analysis, by using the event IDs 0x8001 and 0x8101 as a key.

Figure 7-10 Example of filtered trace based performance analysis file

You can analyze the response time of each request from the trace collection date and time of 0x8001 and 0x8101. In the example shown in Figure 7-10, if you compare the response time of requests in which communication number of the client application information are 0x00000000000000c7 and 0x00000000000000cc, you will observe that the time taken for processing the request 0x00000000000000c7 is more.

7.7.3 Investigating the Processing Status of a Request in an Application Server

This subsection gives an example to describe how to investigate whether the request received by a Web server from a client is processed on an application server.

In the following figure, from the trace based performance analysis files collected on the Web server you will understand that the request is received on 2004/2/5 16:32:31.

Figure 7-11 Example of the trace based performance analysis file collected in the Web server

You use the root application information of this request as a key to investigate trace based performance analysis files collected on Application Server.

The following figure shows an example of filtering the trace based performance analysis files collected in Application Server with RootAP IP:10.209.13.123, RootAP ID:2200, and RootAP CommNo.:0x00000000000000c7 as keys.

Figure 7-12 Example of the filtered trace based performance analysis file collected in Application Server

In this way, if you filter the trace based performance analysis files collected on an application server with a root application information as a key, you can investigate the processing of a series of requests in an application server.

7.7.4 Investigating the Life Cycle of a Session

This subsection describes how to investigate the life cycle of a session using a trace based performance analysis.

You can investigate the life cycle of a session by using the trace (Session trace) that is output when the PRF trace collection level is set as details.

You can investigate a session trace information by using the session ID of the trace based performance analysis file that is output or the global session ID (when the memory session fail over function is used), as a key.

The session ID is output to the option area of the event, output as the session trace information in the following format:

Number of session characters: Session ID

For example, if there is a session ID called as abc123, in the option area 6:abc123 is output. When the session ID is a blank character, 0: is output as the number of session characters. When the session ID cannot be acquired, nothing is output.

In the case of a global session ID as well, the session ID is output in the same format.

The session ID of the identified event is acquired from a URL when the Cookie or URL of the request header is overwritten. You can confirm from where the session ID is acquired referring to the character that is output at the end of the session ID. When the session ID is acquired from a Cookie, C is output following the session IDs that are output to these events. When a session ID is acquired from a URL, U is output following the session ID. The following are the events where you can confirm the acquisition source of the session ID:

0x8000 (After a request for processing a request is acquired)

0x8002 (Receive a request for an HTTP request body from a Web container)

0x8102 (Send and receive an HTTP request body to the Web container)

0x8200 (Acquire a request through the Web server and complete the analysis of the request header)

The following figure gives an example of trace based performance analysis file in which the session trace information is output. In this example, the trace information of a request to generate a session, a request to use the session, and a request to destroy the session are output in the validity period of one session. Also, a request to generate a session, a request to use the session, and a request to destroy the session are shown separately. In reality, the trace information in these three examples is output one after another. In these windows, all items are related to the session trace.

Figure 7-13 Example of trace based performance analysis file where the session trace information is output (request part where the session is created)

In the ASCII example of the 0x8208 event, the generated session ID is output. 60 in the option column indicate the session validity period.

In the ASCII example of the 0x8300 event, the generated global session ID is output.

Figure 7-14 Example of the trace based performance analysis file where the session trace information is output (request part where the session is used)

Indicate the session IDs acquired from the Cookie of a request header.

Figure 7-15 Example of the trace based performance analysis file where the session trace information is output (request part where the session is cancelled)

In the ASCII example of the 0x8209 event, the session ID of the destroyed session is output. The operation example describes the generation time of the destroyed session.

Indicates that the global session is destroyed. The cancelled global session ID is not output.

The items that you can confirm in this trace file are described here.

Confirming the validity period of the session

When generating a session, the 0x8208 event is output. When destroying a session, the 0x8209 event is output. You can confirm the validity range of the session from the date and time of these acquisitions. Also, in the case of the 0x8208 event, you can even confirm the validity period (seconds) of the session generated from the operation name.

The same ID is output to the event 0x8209 of the request to destroy the session until the session is destroyed. You can confirm the date and time of generating the session that is destroyed from the operation name.

Confirming the validity period of the global session (in the case of the memory session failover function)

You can confirm the validity period of the global session based on the global session ID that is output. The global session ID indicates that the session inherited between redundant J2EE servers is unique, if you use the memory session failover function. For details, see 6.4.1 Global session ID in the uCosminexus Application Server Compatibility Guide.

When a global session ID is generated, the global session ID is output following the session ID at the identified trace collection points.

In Figure 7-13, the global session ID is generated at the timings of the event 0x8300 in the request to generate a session, and that ID is output. The same global session ID is output until the request processing finishes in the event 0x8209 of the request to destroy the session.

7.7.5 Identifying the Transaction in Which a Timeout Occurred

This subsection describes how to identify the transaction that is timed out using the message or trace based performance analysis information file, if a timeout occurs in the transaction of a J2EE application or batch application.

The subsection describes the following two methods:

Method of identifying the transaction using messages

Method of identifying the transaction depending on the output contents of the trace based performance analysis file

Organization of this subsection

(1) Method of identifying the transaction using messages

(2) Method of identifying the transaction depending on the output contents of the trace based performance analysis file

(1) Method of identifying the transaction using messages

If a timeout occurs in a transaction, the KDJE31002-W and KDJE50080-W messages are output. The following information is output in these messages:

KDJE31002-W

J2EE application name or the class name of the batch application that started the transaction.

Hash code of the instance and the class name of J2EE component (Enterprise Bean, servlets, or JSPs) that started the transaction

Maintenance information

Root application information of the trace based performance analysis

You can confirm the location where the transaction timeout occurred in the trace based performance analysis by matching and confirming the root application information of the trace based performance analysis output to the message with the root application information that is output to the trace based performance analysis file.

You can confirm the trace information before and after the timeout for checking the process contents of the transaction in which a timeout occurred.

KDJE50080-W

IP address, process ID, and root application information

Connection ID of the connection that executed the SQL

Name of the method that executed SQL

Whether the method that executed SQL is running

SQL executed last

You can refer to the SQL information that is output in the message, and can investigate the location where the timeout occurred.

For details on messages, see KDJE31002-W and KDJE50080-W in the uCosminexus Application Server Messages.

(2) Method of identifying the transaction depending on the output contents of the trace based performance analysis file

In the trace based performance analysis file, the trace information is output at the trace collection point immediately before or after the occurrence of timeout in the transaction.

Check the processing contents of the following event IDs.

Table 7-12 Trace based performance analysis that is output when timeout occurs in the transaction

Event ID | Description
0x8819 | This information is output in the process immediately before a timeout occurs in the transaction. The root application information of the transaction that is timed out is output to the interface name.
0x8820 | This information is output to the process immediately after a transaction is timed out.
0x8C41 | This information is output when the SQL for investigating an error is output.

7.7.6 Identifying the Request for Which Timeout Occurred

This subsection describes how to identify a request in which timeout occurred by using the trace based performance analysis, if a timeout has occurred while receiving the response in the redirector.

If a timeout occurs while receiving a response in the redirector, the KDJE41019-E message is output. The following information is output in this message:

URI of the request

IP address of the host in which the Web container used for communication with the Web server is running

Port number of the Web container used for the communication with the Web server

File descriptor of the Web container used for communication with the Web server

Root application information of the trace based performance analysis

You can check where the timeout has occurred in a request in the trace based performance analysis, by comparing the root application information of the trace based performance analysis output in the message with the root application information output in the trace based performance analysis file.

You can check the request that is timed out with the trace information of the event IDs, described in the table below, of the request processing in which the corresponding root application information is output. Identify the corresponding request with the URI output to the operation name.

Table 7-13 Trace based performance analysis that you can use to check the request that is timed out

Event ID
Description

0x8000
This information is output after getting a request for processing the request.
The URI of the request is output as an operation name.

0x8100
This information is output after the processing of the redirector finishes.
The URI of the request is output as an operation name.

7.7.7 Investigating the Log Using the Root Application Information

If the application API is used in a J2EE application or batch application, the character string expression of root application information of the performance analysis information can be output to the log file at any time.

The character string expression of the root application information is output to the following format (maximum 48 characters):

IP address / process ID / communication number
(Example: 10.209.15.130/1234/0x0000000000000001)

If the root application information is output to a log file using an API, you compare the log file with the trace based performance analysis file to investigate.

When a new request is received in the Web container, a new root application information is assigned to the single request. The following table describes the trace points to which the new root application information is assigned.

Table 7-14 Trace point to which the new root application information is assigned

Conditions | Event ID (process contents) | Process contents
When using the in-process HTTP server | 0x8211 | When acquiring a request, when completing the request header analysis
When connecting to a Web server# | 0x8200 | When acquiring a request, when completing the request header analysis

#

When connecting to a Web server, the root application information acquired by the redirector is assigned. When the root application information is not issued due to an error in a redirector or the PRF daemon used by the redirector, new root application information is assigned to the Web container.

Moreover, in the following trace collection point, 'IPaddress / process ID / communication number' might be output as '0.0.0. 0/0/0x0000000000000000'

0x8212
When data is read from Web client where the in-process HTTP server is used.

0x8312
When data is written to the Web client where the in-process HTTP server is used.

In the following cases the IP-address/process-ID/communication-number is output as 0.0.0. 0/0/0x0000000000000000:

If an HTTP request header is received

If an incorrect data that is not an HTTP request is received

If an exception occurs during processing of the request

Note that the APIs used to output the character string expression of the root application information is the getRootApInfo method of the CprfTrace class, provided in the com.hitachi.software.ejb.application.prf package.

For details on the implementation of acquiring the root application when the J2EE application or batch application is started, see the section 7.4 Implementation for collection of root application information of trace based performance analysis. For details on the APIs, see the uCosminexus Application Server API Reference Guide.

7.7.8 Identifying the Connection in Which an Error Occurred

When HiRDB or Oracle is used as a database, you can compare the connection ID output to the trace based performance analysis file with the connection ID output to the log file and trace file , HiRDB client, and Oracle client for confirming the connection in which an error has occurred. For details on how to confirm, see Appendix B. Identifying the Connection in Which an Error Has Occurred When Connecting to a Database.

7.7.9 Investigation about the location of the problem associated to the trace based performance analysis file and thread dump

If slow down or hang-up occurs in a J2EE application or batch application, you can investigate the location of the error by correlating the trace based performance analysis file with the thread dump.

Use the thread ID that is output to the trace based performance analysis file and nativeID (thread IDs of the OS level) of the thread information output to the thread dump, for correlating the trace based performance analysis file with the thread dump. This subsection describes how to identify the corresponding thread dump from the trace based performance analysis file.

The following are the steps to identify the corresponding thread dump from the trace based performance analysis file:

Collect the trace based performance analysis file and thread dump.
For details on the collection methods of trace based performance analysis file, see 7.3.1 How to collect a trace based performance analysis file. For details on the collection method of thread dump, see 4.7 JavaVM thread dump.

Select the trace based performance analysis file and thread dump to be used.
Select the trace based performance analysis file and thread dump to be used, based on the date and time when the trace based performance analysis file and thread dump are output. For details on the output time, see the following information:

Trace based performance analysis file

Time and Time(msec/usec/nsec)

The following figure shows the Time and Time (msec/usec/nsec) of the trace based performance analysis file.

Thread dump

Date and time output at the end of the file name and file.

The following is an example showing the date and time output at the end of a file:

...
...
Full thread dump completed. Fri Jul 21 19:22:47 2006

Convert the value of Thread (hash code), corresponding to the event ID of the trace based performance analysis file that you want to investigate, in to a hexadecimal number.

In Windows, AIX, HP-UX, or Solaris
Change the value of the thread (thread ID) from decimal numbers to hexadecimal numbers.

In Linux
Change the value of the hashcode (hash code) from decimal numbers to hexadecimal numbers.

Specify the thread information corresponding to the thread matching to the value of Thread (hashcode) that is converted into a hexadecimal number in step 3.

In Windows, AIX, HP-UX, or Solaris
The thread dump nid searches for the thread that matches with the value (1124) of the Thread (Thread ID) that is converted into hexadecimal numbers.

...
...
"VBJ ThreadPool Worker" daemon prio=5 jid=0x00054f93 tid=0x04cef380 nid=0x1124 in Object.wait() [0x0632f000..0x0632fd18]
stack=[0x06330000​..0x062f5000..0x062f1000..0x062f0000]
[user cpu time=0ms, kernel cpu time=15ms] [blocked count=1, waited count=29]
at java.lang.Object.wait(Native Method)
...
...

In Linux
The thread dump jid searches for the thread that matches with the value (6d75) of hashcode (hash code) that is converted into hexadecimal numbers.

...
...
"main" prio=1 jid=0x00006d75 tid=0x00201d70 nid=0x1e51 waiting on condition [0x00000000​..0xbfe80488]
stack=[0xbfe87000..0xbfc8c000..0xbfc88000..0xbfc87000]
[user cpu time=1320ms, kernel cpu time=4280ms] [blocked count=5, waited count=4]
...
...

7.8 Notes on using the user-extended trace based performance analysis

This section describes the notes on using the user-extended trace based performance analysis.

If the methods to be traced are invoked frequently, it might be difficult to identify the method that causes performance deterioration, due to the performance deterioration caused by the processing overhead of the user-extended trace based performance analysis. Therefore, in the methods to be traced, specify a method that serves as the entry to the processing that can identify the cause of deterioration.
For example, in the case of applications with a method invocation relationship as shown in the following figure, take method 1 (trace collection point 1) that serves as an entry to processing as the target. If you specify the methods 4, 5, and 6 of the trace collection point 2, and if the processing of the user-extended trace based performance analysis for these methods takes time, the performance measurement of this application might be affected.

Figure 7-16 Method invocation relationship in an application

If you use the user-extended trace based performance analysis for a method invoked before the root application information is acquired, the root application information might be output with 0.

If you increase the frequency of invoking the method to be traced and specify a property that increases the amount of trace output, the amount of PRF trace file output increases. In this case, increase the number of PRF trace files or the PRF trace file size. For details on how to change the number and size of PRF trace files, see 10.3.1 Setting up the performance tracer in the uCosminexus Application Server Management Portal Operation Guide.
Note that the increase in the amount of PRF trace files that are output causes the following events:

Overhead occurs due to the writing to the trace files and leads to performance deterioration.

The number of trace files is switched due to a large amount of writing, and the J2EE server can no longer obtain the trace that could be obtained.

For normal operations, specify the contents of the user-extended trace based performance analysis configuration file appropriately and adjust the trace collection amount.

The application classes are rewritten in the user-extended trace based performance analysis. At this time, if the rewritten class size exceeds 64 KB, the rewriting fails. In this case, take actions such as dividing the class to reduce the class size.

8. Trace Collection Points and PRF Trace Collection Levels of the Trace Based Performance Analysis

The trace based performance analysis includes the trace based performance analysis that analyzes the Application Server performance, and the user-extended trace based performance analysis that extends the target of the trace based performance analysis and analyzes the performance of the applications set up on an Application Server machine. This chapter describes the trace collection points and PRF trace collection levels output in the trace based performance analysis and user-extended trace based performance analysis.

For an overview of the trace based performance analysis and for details about how to perform the analysis, see the chapter 7. Performance Analysis by Using Trace Based Performance Analysis.

Organization of this chapter

8.1 Organization of this chapter

8.2 Trace Get Point of trace based performance analysis and the PRF Trace Get Level

8.3 Trace collection points of a CTM

8.4 Trace collection points of a redirector

8.5 Trace collection points of a Web container (trace of request processing)

8.6 Trace collection points of a Web container (session trace)

8.7 Trace collection points of a Web container (filter trace)

8.8 Trace collection points of a Web container (trace of the database session failover functionality)

8.9 Trace collection points of a Web container (Trace of the EADs session failover functionality)

8.10 Trace collection points of a Web container (trace of the memory session failover functionality)

8.11 Trace collection points of an EJB container

8.12 Trace collection points of a JNDI

8.13 Trace collection points of a JTA

8.14 Trace collection points of a DB Connector and JCA container

8.15 Trace collection points of an RMI

8.16 Trace collection points of an OTS

8.17 Trace collection points of standard output, standard error output, and user log

8.18 Trace collection points of a DI

8.19 Trace collection points of the batch application execution functionality

8.20 Trace collection points in a JPA

8.21 Trace collection points of the Cosminexus JPA provider

8.22 Trace collection points of the TP1 inbound integrated function

8.23 Trace collection points of Cosminexus JMS Provider

8.24 Trace collection points of JavaMail

8.25 Trace collection points of JSF

8.26 Trace collection points of CDI

8.27 Trace collection points when a J2EE server is started or terminated

8.28 Trace collection points of an application

8.1 Organization of this chapter

This chapter describes the trace collection points and PRF trace collection levels of the following trace based performance analysis.

Trace collection points and PRF trace collection levels output for each function layer by the trace based performance analysis

When a request is sent from the Web client or the EJB client, the Web server, J2EE server, and CTM output the trace information at the point (trace acquisition point) of some specified processes. Furthermore, in the trace based performance analysis, the trace can be output by setting up the PRF trace collection level, such as Standard and Advanced.

Trace collection points and PRF trace collection levels output for each method forming the starting point of application processing by the user-extended trace based performance analysis
In the user-extended trace based performance analysis, by specifying a method that forms the starting point of application processing as the processing point for acquiring the application performance analysis information, you can output the trace at the point when that method is called.

The following table describes the organization of this chapter.

Table 8-1 Organization of this chapter (trace based performance analysis)

Category | Title | Reference location
Explanation | Trace Get Point of trace based performance analysis and the PRF Trace Get Level | 8.2
Trace collection points of a CTM | 8.3
Trace collection points of a redirector | 8.4
Trace collection points of a Web container (trace of request processing) | 8.5
Trace collection points of a Web container (session trace) | 8.6
Trace collection points of a Web container (filter trace) | 8.7
Trace collection points of a Web container (trace of the database session failover functionality) | 8.8
Trace collection points of a Web container (Trace of the EADs session failover functionality) | 8.9
Trace collection points of a Web container (trace of the memory session failover functionality) | 8.10
Trace collection points of an EJB container | 8.11
Trace collection points of a JNDI | 8.12
Trace collection points of a JTA | 8.13
Trace collection points of a DB Connector and JCA container | 8.14
Trace collection points of an RMI | 8.15
Trace collection points of an OTS | 8.16
Explanation | Trace collection points of standard output, standard error output, and user log | 8.17
Trace collection points of a DI | 8.18
Trace collection points of the batch application execution functionality | 8.19
Trace collection points in a JPA | 8.20
Trace collection points of the Cosminexus JPA provider | 8.21
Trace collection points of the TP1 inbound integrated function | 8.22
Trace collection points of Cosminexus JMS Provider | 8.23
Trace collection points of JavaMail | 8.24
Trace collection points of JSF | 8.25
Trace collection points of CDI | 8.26
Trace collection points when a J2EE server is started or terminated | 8.27
Trace collection points of an application | 8.28

Note:

There is no specific description of Implementation, Setup, Operation, and Notes for this functionality.

For an overview of the trace based performance analysis, and details on how to perform the analysis, see 7. Performance Analysis by Using Trace Based Performance Analysis.

8.2 Trace Get Point of trace based performance analysis and the PRF Trace Get Level

This section describes the trace collection points and PRF trace collection levels.

Organization of this section

(1) Trace collection point

(2) PRF trace collection level

(1) Trace collection point

The trace collection points are broadly classified into trace collection during the startup and termination of a J2EE server, trace collection during processing in each function layer, and trace collection during the startup and termination of application methods.

Trace collection during the startup and termination of the J2EE server

The trace information can be collected when the startup processing of the J2EE server ends, and when the termination processing of the J2EE server starts. The event IDs that can be acquired, and the references are as follows:

Event ID
0x8FFE to 0x8FFF

Reference
For details about trace collections during the startup and termination of the J2EE server, see 8.27 Trace collection points when a J2EE server is started or terminated.

Trace collection in each function layer

The following table describes the correspondence between the event IDs that can be acquired and the function layers.

Table 8-2 Event IDs that can be acquired and function layers

Event ID
Function layer
No. in the figures#
Reference location

0x1101 to 0x1102
0x1301 to 0x1302
0x1401 to 0x1406
0x2002 to 0x2003
0x2101 to 0x2104
0x3000 to 0x3008
CTM
5
8.3

0x8000 to 0x8004
0x8100 to 0x8104
Redirector
1
8.4

0x8200 to 0x8203
0x8206 to 0x8225
0x8300 to 0x8303
0x8306 to 0x8307
0x8311 to 0x8325
0x8E01 to 0x8E06
Web container
2
8.5, 8.6, 8.7, 8.8, 8.10

0x8401 to 0x840A
0x8425 to 0x8428
0x842D to 0x8434
0x8453 to 0x8454
0x8460 to 0x846D
0x8470 to 0x8477
0x8490 to 0x8491
0x84A0 to 0x84D9
0x8C41
EJB container
6
8.11

0x8603 to 0x861C
JNDI
4
8.12

0x8435 to 0x843F
0x8811 to 0x8820
0x8C41
JTA
7
8.13

0x8B00 to 0x8B01
0x8B80 to 0x8B89
0x8B8A to 0x8C03
0x8C10 to 0x8C13
0x8C20 to 0x8C41
0x8C60 to 0x8C65
0x8C80 to 0x8C93
0x8CC0 to 0x8CD9
0x8D00 to 0x8D19
0x8D60 to 0x8D63
0x8D80 to 0x8D89
0x8D8A to 0x8D8F
0x8D90 to 0x8D99
DB Connector and JCA container
8
8.14

0x8E01 to 0x8E06
RMI
3
8.15

0x9400 to 0x9413
OTS
9
8.16

0x9C00 to 0x9C03
Standard output, standard error output, and user log
--
8.17

0x9D00, 0x9D01
DI
10
8.18

0xA100, 0xA101
Batch application execution functionality
11
8.19

0xA500 to 0xA5AF
JPA
12
8.20

0xA300 to 0xA305
0xA310 to 0xA315
0xA320 to 0xA323
0xA330 to 0xA331
0xA340 to 0xA363
0xA370 to 0xA381
0xA390 to 0xA3C3
Cosminexus JPA provider
13
8.21

0x842F
0x8430 to 0x8432
0x8825
0x8826
0x8B86, 0x8B87
0x8B8A to 0x8B93
0xAA00 to 0xAA06
0xAA08 to 0xAA0D
0xAA10 to 0xAA19
TP1 inbound integrated function
14
8.22

0xA600 to 0xA60F
0xA610 to 0xA619
0xA61E, 0xA61F
0xA620 to 0xA62F
0xA630 to 0xA63F
0xA640 to 0xA64F
0xA650 to 0xA65F
0xA660 to 0xA667
0xA61A, 0xA61B
0xA668 to 0xA66F
0xA670 to 0xA67F
0xA686 to 0xA68D
0xA692 to 0xA69B
0xA69E, 0xA69F
0xA6A0, 0xA6A1
0xA6A6 to 0xA6AB
Cosminexus JMS Provider
15
8.23

0xAD00 to 0xAD15
0xAD80 to 0xAD93
JavaMail
16
8.24

0xAF00 to 0xAF13
JSF
17
8.25

0xb002 to 0xb009
CDI
18
8.26

Legend:

--: Not applicable

#

Corresponds to the numbers in Figure 8-1 through Figure 8-4.

The following figures show the function layers for which the PRF trace is output, and the trace collection points for each system configuration.

Figure 8-1 Function layers and trace collection points (in the case of Web client configuration)

Figure 8-2 Function layers and trace collection points (in the case of a system for executing batch applications)

Figure 8-3 Function layers and trace collection points (in the case of EJB client, TPBroker client, or TPBroker OTM client configuration (CTM usage))

Figure 8-4 Functionality layers and trace collection points (In the TP1 inbound integrated function)

The trace collection points are divided in detail in each function layer, and the PRF trace collection level differs depending on the trace collection point. For details about trace collection points of each function layer, and the PRF trace collection level, see the references described in Table 8-2.

Reference note

Apart from the function layers described in Table 8-2, the PRF trace can be collected for some Application Server processes, component software, and related programs as well.

The following table describes the correspondence between the function layers other than those described in Table 8-2 for which the PRF trace can be collected, and their event IDs.

Table 8-3 Correspondence between the event IDs and function layers other than those described in table 8-2 for which the PRF trace can be collected

Event ID
Function layer

0x9000 to 0x90FF
0xA400 to 0xA4FF
Cosminexus Web Services - Base

0x9100 to 0x91FF

uCosminexus TP1 Connector

TP1/Client/J

0x9200 to 0x92FF
TP1/MQ Access

0x9300 to 0x93FF
Cosminexus RM

0x9800 to 0x9B6E
HCSC server

0x9E00 to 0x9EFF
Service Coordinator Interactive Workflow

0x9F00 to 0x9FFF
HCSC server (Object Access adapter)

0xA000 to 0xA0FF
HCSC server (File adapter)

0xA200 to 0xA2FF
HCSC server (Message Queue adapter)

0xAB00 to 0xABFF
0xAC00 to 0xACFF
HCSC server (FTP adapter)

0xA400 to 0xA4FF
JAX-WS Engine

0xE000 to 0xE0FF
Elastic Application Data store

Trace collection during the startup and termination of application methods

You can collect the trace information when an application method starts and terminates. The trace information that you can collect is as follows:

Method start and termination time

Identity ID

Package name, class name, method name

Line number of the last line executed by the method

Class name of the exception or error that occurs

For details on the trace information, see 8.28 Trace collection points of an application.

Return codes for each trace

For an entrance trace, the return code of each trace is always output as 0.

For an exit trace and the trace after invocation, the return codes are output as follows:

Normal termination: 0

Abnormal termination: Other than 0

(2) PRF trace collection level

In the trace based performance analysis, you can specify the following four types of PRF trace collection levels to output the trace. The number of trace collection points differs depending upon the PRF trace level used. For details about the trace collection points, and PRF trace collection levels, see the references described in Table 8-2.

Standard level
Output the trace information that can identify the boundaries (entrance and exit) of each function layer.

Advanced level
Output the trace information of processes in every function layer, in addition to the output contents of the standard level.

Maintenance level
This is the level for acquiring the maintenance information required when a failure occurs.

Prevention level
This is the level for preventing the output of trace information. This level can be set up only in the RMI function layer.

When the operation is performed by using the Management Server, the trace information is output by setting up a common level for all function layers, in the Easy Setup definition file.

In the next sections, the trace collection points for the trace collection levels Standard and Advanced are described. Because the Maintenance level is the level for collecting maintenance information, such as when a failure occurs, the information for this level need not usually be collected.

8.3 Trace collection points of a CTM

This section describes the trace collection points in a CTM, and the trace information that can be collected.

Organization of this section

8.3.1 Trace collection points and PRF trace collection levels

8.3.2 Trace information that can be collected

8.3.1 Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-4 Details of trace collection points in a CTM

Event ID | No. in the figures# | Trace acquisition points | Level
0x1101 | 21 | Immediately before sending a request from the OTM gateway | A
0x1102 | 22 | Immediately before receiving a response from the OTM gateway | A
0x1301 | 4 | Immediately before sending a request from the EJB regulator | A
0x1302 | 13 | Immediately after receiving a response in the EJB regulator | A
0x1401 | 1 | Entrance of the Create method in the CTM | A
0x1402 | 2 | Exit of the Create method in the CTM | A
0x1403 | 5 | Immediately after receiving a request from the EJB regulator | A
0x1404 | 8 | Immediately before sending a request from the CTM to the J2EE server or batch server | A
0x1405 | 9 | Immediately after receiving a request from the J2EE server or batch server in the CTM | A
0x1406 | 12 | Immediately before sending a response from the CTM to the EJB regulator | A
0x2002 | 23 | Immediately before receiving a request from the OTM client | A
0x2003 | 24 | Immediately before receiving a response from the OTM client | A
0x2101 | 3 | Immediately after receiving a request from the EJB client or cjexecjob command | A
0x2102 | 14 | Immediately before sending a response to the EJB client or cjexecjob command | A
0x2103 | 15 | Entrance of the Remove method in the CTM | A
0x2104 | 16 | Exit of the Remove method in the CTM | A
0x3000 | 6 | Immediately before queue of the request | A
0x3001 | 7 | Immediately after extracting a request from the queue | A
0x3002 | 17 | Immediately before sending a request to another CTM | A
0x3003 | 18 | Immediately after receiving a request from another CTM | A
0x3004 | 10 | Immediately before queue of the request response | B
0x3005 | 11 | Immediately after extracting the request response from the queue | B
0x3006 | 19 | Immediately before sending a request response to another CTM | A
0x3007 | 20 | Immediately after receiving a request response from another CTM | A
0x3008 | -- | Collected when the server status changes. (Not collected when a request is being processed) | B

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-5 through Figure 8-8.

The following figure shows the trace collection points in a CTM.

Figure 8-5 Trace collection points of a CTM

For linkage with another CTM, the trace information is also collected at the locations shown in the following figure. The figure might be referenced in connection with the above figure. Note that this figure displays only the locations that are linked with another CTM.

Figure 8-6 Trace collection points of a CTM (For linkage with another CTM)

Furthermore, when using the OTM gateway or ORB gateway, the trace information is also collected at the locations shown in the following figure. The figure might be referenced in connection with the above figure. Note that this figure displays only the locations that are linked with another CTM.

Figure 8-7 Trace collection points of a CTM (when using the OTM gateway)

Figure 8-8 Trace collection points of a CTM (when using the ORB gateway)

8.3.2 Trace information that can be collected

The following table describes the trace information that can be collected in a CTM.

Table 8-5 Trace information that can be collected in a CTM

No. in the figures# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x1401 | A | Remote interface name | Method Name | --
2 | 0x1402 | A | Remote interface name | Method Name | Internal information
3 | 0x2101 | A | Remote interface name | Method Name | --
4 | 0x1301 | A | Remote interface name | Method Name | --
5 | 0x1403 | A | Remote interface name | Method Name | --
6 | 0x3000 | A | -- | -- | --
7 | 0x3001 | A | -- | -- | Internal information
8 | 0x1404 | A | Remote interface name | Method Name | Internal information
9 | 0x1405 | A | Remote interface name | Method Name | Internal information
10 | 0x3004 | B | -- | -- | --
11 | 0x3005 | B | -- | -- | Internal information
12 | 0x1406 | A | Remote interface name | Method Name | --
13 | 0x1302 | A | Remote interface name | Method Name | --
14 | 0x2102 | A | Remote interface name | Method Name | --
15 | 0x2103 | A | Remote interface name | Method Name | --
16 | 0x2104 | A | Remote interface name | Method Name | --
17 | 0x3002 | A | -- | -- | --
18 | 0x3003 | A | -- | -- | --
19 | 0x3006 | A | -- | -- | --
20 | 0x3007 | A | -- | -- | --
21 | 0x1101 | A | Remote interface name | Method Name | --
22 | 0x1102 | A | Remote interface name | Method Name | --
23 | 0x2002 | A | Remote interface name | Method Name | --
24 | 0x2003 | A | Remote interface name | Method Name | --
-- | 0x3008 | B | -- | -- | Internal information

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-5 through Figure 8-8.

8.4 Trace collection points of a redirector

This section describes the trace collection points of a redirector, and the trace information that can be collected.

Note that when the PRF trace collection level is set to Advanced, the trace of request processing and the session trace is output.

Organization of this section

8.4.1 Trace collection points and PRF trace collection levels

8.4.2 Trace information that can be collected

8.4.1 Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels. The session trace is not output at the point 0x8003.

Table 8-6 Details of trace collection points in a redirector

Event ID | No. in the figure# | Trace acquisition points | Level
0x8000 | 1 | Immediately after acquiring the request processing request | A/B
0x8001 | 2 | Immediately after sending the request header information to a Web container | A/B
0x8002 | 4 | Immediately after receiving a request for the HTTP request body information from the Web container | B
0x8003 | 6 | Immediately after receiving the HTTP response header information from the Web container | B
0x8004 | 8 | Immediately after starting the transmission of the HTTP response body information from the Web container | B
0x8100 | 11 | Immediately after the completion of redirector processing | A/B
0x8101 | 10 | Immediately after receiving the response completion notification from the Web container | A/B
0x8102 | 3, 5 | Immediately before sending the HTTP request body information to the Web container | B
0x8103 | 7 | Immediately after the setup completion of the HTTP response header information in the Web server | B
0x8104 | 9 | Immediately after the completion of transmission of the HTTP response body information to the Web server | B

Legend:

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels

#

Corresponds to the numbers in Figure 8-9.

The following figure shows the trace collection points in a redirector.

Figure 8-9 Trace collection points of a redirector

Because a connection is usually used repeatedly to establish a permanent connection, it is not disconnected during a request. A connection is disconnected only when either an exception occurs during communication, or the upper limit value of the permanent connection is reached.

The output of the trace information is limited at the following points:

Point 3

The trace information is output when the body data is not in the chunk format. When the body data is in the chunk format, the request body request is not sent to the Web server between points 2 and 4, and the request body information is not sent to the Web container.

Points 4 and 5

The trace information is output only in the case of a request for the request body information from the Web container. Furthermore, because the request body information and response body information is sent to the client more than once at the points 4, 5, 8, and 9, the trace information is also output more than once.

Either an invalid session ID might be acquired, or the session ID might not be acquired at the following points:

Points 1 to 5

The session ID can be acquired. However, an invalid session ID (the ID of an HttpSession discarded in a J2EE application, or the ID of an HttpSession discarded due to the expiry of the valid period) might be acquired because the session ID is acquired from the Cookie or URL of the request header.

Even when a valid session ID is acquired, the session might be discarded in the J2EE application.

Points 7 to 11

The session ID can be acquired only when a session is generated.

8.4.2 Trace information that can be collected

The following table describes the trace information that can be collected in a redirector.

Table 8-7 Trace information that can be collected in a redirector

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional#2
1 | 0x8000 | A/B | Client address: HTTP method | URI | #3
2 | 0x8001 | A/B | Container address: Port number | -- | #3
3, 5 | 0x8102 | B | Transmission size | -- | Entrance-time number-of-session-ID-characters: collection-method
4 | 0x8002 | B | Request size | -- | Number-of-session-ID-characters: session ID: collection-method
6 | 0x8003 | B | -- | -- | --
7 | 0x8103 | B | -- | -- | #4
8 | 0x8004 | B | Transmission size | -- | Number-of-session-ID-characters: session ID: collection-method
9 | 0x8104 | B | Transmitted size | -- | Entrance-time number-of-session-ID-characters: session-ID
10 | 0x8101 | A/B | Container address: Port number | -- | #5
11 | 0x8100 | A/B | Client address: HTTP method | URI | #6

Legend:

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels

--: Not applicable

#1

Corresponds to the numbers in Figure 8-9.

#2

If the session Cookie name is changed to a string other than JSESSIONID, the number of session ID characters, session ID, and collection method are not output.

#3

When the level is Standard, nothing is output.

When the level is Advanced, the number of session ID characters: session ID: collection method is output.

#4

When the processing is performed normally, the entrance time and session ID are displayed.

When an exception occurs, in addition to the entrance time, four-byte maintenance information, and the number of session ID characters: session ID is displayed.

#5

When the level is Standard, the entrance time is displayed.

When the level is Advanced, in addition to the entrance time, the number of session ID characters: session ID is displayed.

#6

When the level is Standard, the entrance time and status code are displayed at all times.

However, if an exception occurs during the use of Microsoft IIS, in addition to the entrance time and status code, four-byte maintenance information will be displayed.

When the level is Detailed, in addition to the information that is output when the level is Standard, the number of session ID characters: session ID is displayed.

8.5 Trace collection points of a Web container (trace of request processing)

This section describes the trace collection points of a Web container, and the trace information that can be collected. In a Web container, the trace of request processing and the session trace are output. The trace of request processing is described below. The trace points when an in-process HTTP server is used, and the trace information that can be collected is also described.

Organization of this section

8.5.1 Trace Get Point and the PRF Trace Get Level

8.5.2 Trace information that can be collected

8.5.3 Trace collection points and PRF trace collection levels (when an in-process HTTP server is used)

8.5.4 Trace information that can be collected

8.5.1 Trace Get Point and the PRF Trace Get Level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-8 Details of trace collection points in a Web container (trace of request processing)

Event ID
No. in the figure#1
Trace acquisition points
Level

0x8200#2
1
Immediately after a request is acquired, or when the request header analysis is complete
Via the Web server
A

0x8201
Via the simple Web server
A

0x8202#3
3
Immediately before a servlet or JSP is invoked
A

0x8203
2
Immediately before the filter that is executed before the execution of the servlet or JSP that receives the request is invoked (when the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or when a filter for which REQUEST is specified in the [[dispatcher]] tag is invoked)
B

0x8206
4
Immediately before a servlet or JSP is invoked via RequestDispatcher
B

0x8207
3
When the static contents are invoked
B

0x8300
8
When request processing is complete
Via the Web server
A

0x8301
Via the simple Web server
A

0x8302
6
Immediately after the processing of the servlet or JSP is complete
A

0x8303
7
Immediately after the completion of processing of the filter that is executed before the execution of the servlet or JSP that receives the request
(when the processing of the filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is complete)
B

0x8306
5
Immediately after the processing of the servlet or JSP via RequestDispatcher is complete
B

0x8307
6
Immediately after the completion of processing of static contents (DefaultServlet)
B

Legend:

A: Standard

B: Advanced

#1

Corresponds to the numbers in Figure 8-10.

#2

For a POST request, if the POST data does not arrive from the client, the request processing might be delayed in this interval.

#3

If a JSP compilation is required, the trace is collected after the JSP compilation is executed.

The following figure shows the trace collection points in a Web container.

Figure 8-10 Trace collection points of a Web container (trace of request processing)

8.5.2 Trace information that can be collected

The following table describes the trace information that can be collected in a Web container.

Table 8-9 Trace information that can be collected in a Web container (trace of request processing)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8200
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session ID: collection-method

0x8201
A
HTTP method
URI
--

2
0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

3
0x8202
A
Class name or JSP file name
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8207
B
--
--
--

4
0x8206
B
Class name
Dispatch type
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

5
0x8306
B
Class name
Dispatch type
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

6
0x8302
A
Class name or JSP file name
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

7
0x8303
B
Class name
--

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

8
0x8300
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

B

When normal:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

For an exception:
Entrance-time status-code exception-name: number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8301
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-10.

Reference note

When a request is received from other than the SOAP client, 0 is displayed always in the client application information that is the key information of the trace information. The client application information is output only when a request is received from the SOAP client.

8.5.3 Trace collection points and PRF trace collection levels (when an in-process HTTP server is used)

The following table describes the events IDs, trace collection points, and PRF trace collection levels when an in-process HTTP server is used.

Table 8-10 Details of trace collection points in an in-process HTTP server

Event ID
No. in the figure#1
Trace acquisition points
Level

0x8202#2
5
Immediately before a servlet or JSP is invoked
A/B

0x8203
4
Immediately before the filter that is executed before the execution of the servlet or JSP that receives the request is invoked (when the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted or when a filter for which REQUEST is specified in the [[dispatcher]] tag is invoked)
B

0x8206
6
Immediately before a servlet or JSP is invoked via RequestDispatcher
B

0x8207
5
Immediately before the static contents are invoked
B

0x8211
3
Immediately after acquiring a request/completing the request header analysis
A/B

0x8212
1
Immediately before data reading from the Web client starts
B

0x8213
8
Immediately before data writing into the Web client starts
B

0x8302
10
Immediately after the completion of processing of the servlet or JSP
A

0x8303
11
Immediately after the completion of processing of the filter that is executed before the execution of the servlet or JSP that receives the request
(when the processing of the filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is complete)
B

0x8306
7
Immediately after the completion of processing of the servlet or JSP via RequestDispatcher
B

0x8307
10
Immediately after completion of processing of static contents (DefaultServlet)
B

0x8311
12
Immediately after the completion of request processing
A/B

0x8312
2
Immediately after the completion of data reading from the Web client
B

0x8313
9
Immediately after the completion of data writing into the Web client
B

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#1

Corresponds to the numbers in Figure 8-11.

#2

If JSP compilation is required, the trace is collected after the JSP compilation is executed.

The following figure shows the trace collection points when an in-process HTTP server is used.

Figure 8-11 Trace collection points of an in-process HTTP server

Because the request information is received from the client more than once at the points 1 and 2, the trace information is also output more than once.

Because the response information is sent to the client more than once at the points 8 and 9, the trace information is also output more than once.

Even when a request for the request body information, and a response are sent from the filter, the trace for points 2 or 8, and points 8 and 9 is output.

8.5.4 Trace information that can be collected

The following table describes the trace information that can be collected in an in-process HTTP server.

Table 8-11 Trace information that can be collected in an in-process HTTP server (trace of request processing)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8212
B
Request size
--
--

2
0x8312
B
Read size
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8211
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session ID: collection-method

4
0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

5
0x8202
A
Class name or JSP file name
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8207
B
-
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

6
0x8206
B
Class name
Dispatch type
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

7
0x8306
B
Class name
Dispatch type
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

8
0x8213
B
Write size
--
--

9
0x8313
B
Written size
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

10
0x8302
A
Class name or JSP file name
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
-
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

11
0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

12
0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-11.

8.6 Trace collection points of a Web container (session trace)

This section describes the trace collection points of the trace of a Web container, and the trace information that can be collected. In a Web container, the trace of request processing and the session trace are output. The trace collection points of the session trace and global session, and the trace information that can be collected is described below.

Organization of this section

8.6.1 Trace Get Point and the PRF Trace Get Level (Session Trace)

8.6.2 Trace information that can be collected

8.6.1 Trace Get Point and the PRF Trace Get Level (Session Trace)

The following table describes the event IDs, trace collection points, and PRF trace collection levels of the trace concerning the session trace. Note that the information about the global session is also output at points 0x8203, 0x8202, 0x8207, 0x8206, and 0x8300.

Table 8-12 Details of trace collection points in a Web container (session trace)

Event ID
No. in the figure#1
Trace acquisition points
Level#2

0x8200
1
Immediately after a request is acquired, or when the request header analysis is complete (via the Web server)
A/B

0x8202
4, 9
Immediately before a servlet or JSP is invoked
A/B

0x8203
2, 3
Immediately before the filter that is executed before the execution of the servlet or JSP that receives the request is invoked (when the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or when a filter for which REQUEST is specified in the [[dispatcher]] tag is invoked)
B

0x8206
7
Immediately before a servlet or JSP is invoked via RequestDispatcher
B

0x8207
4, 9
Immediately before the static contents are invoked (DefaultServlet)
B

0x8208
5
After a session is generated
B

0x8209
6
After a session is discarded
B

0x8210
17
After the session times out
B

0x8211
1
Immediately after a request is acquired, or when the request header analysis is complete (via the in-process HTTP server)
A/B

0x8214
8
Immediately before the filter executed during Forward is invoked (when the filter for which FORWARD is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is invoked)
B

0x8215
8
Immediately before the filter executed during Include is invoked (when the filter for which INCLUDE is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is invoked)
B

0x8216
2
Immediately before the filter that is executed during transfer to the error page is invoked
(when the filter for which ERROR is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is invoked)
B

0x8300
16
Immediately after the completion of request processing (via the Web server)
A/B

0x8302
10, 13
Immediately after the completion of processing of the servlet or JSP
A/B

0x8303
14, 15
Immediately after the completion of processing of the filter that is executed before the execution of the servlet or JSP that receives the request
(when the processing of the filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is complete)
B

0x8306
12
Immediately after the completion of the processing of the servlet or JSP via RequestDispatcher
B

0x8307
10, 13
Immediately after the completion of the processing of the static contents (DefaultServlet)
B

0x8311
16
Immediately after the completion of the request processing (via the in-process HTTP server)
A/B

0x8314
11
Immediately after the completion of the processing of the filter executed during Forward
(when the processing of the filter for which FORWARD is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is complete)
B

0x8315
11
Immediately after the completion of the processing of the filter executed during Include
(when the processing of the filter for which INCLUDE is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is complete)
B

0x8316
15
Immediately after the completion of the processing of the filter executed during transfer to the error page
(when the processing of the filter for which ERROR is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is complete)
B

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#1

Corresponds to the numbers in Figure 8-12.

#2

The information about the session trace is output only when the level is Advanced.

The following figure shows the trace collection points of the session trace in a Web container.

Figure 8-12 Trace collection points of a Web container (session trace)

The session ID that can be acquired at each point is as follows:

Point 1

The session ID can be acquired. However, an invalid session ID (the ID of an HttpSession discarded in a J2EE application, or the ID of an HttpSession discarded due to the expiry of the valid period) might be acquired because the session ID is acquired from the Cookie or URL of the request header.

Even when a valid session ID is acquired, the session might be discarded in the J2EE application.

Points 2, 3, 4, 7, 8, and 9

A valid session ID can be acquired at the trace collection points. However, the session might be discarded in the J2EE application.

Furthermore, the global session ID can also be acquired at these points. The contents of the global session ID that can be acquired are different for each trace collection point.

Point 2 is the trace collection point at which the event ID 0x8203 is output initially for one request. At this trace collection point, the global session ID sent as a request from the Web client can be acquired. However, at this point, a global session ID that has already become invalid might also be output.

Valid global session IDs can be acquired from the trace with event IDs 0x8216, 0x8202, 0x8203, 0x8206, 0x8207, 0x8214, and 0x8215 output at points 3, 4, 7, 8, and 9.

Point 5

A valid session ID can be acquired at the trace collection point only when a session is generated in the J2EE application. However, the session might be discarded in the J2EE application.

Point 6

An invalid session ID can be acquired at the trace collection point only when a session is discarded in the J2EE application. However, the session might be discarded in the J2EE application.

Points 10, 11, 12, and 13

A valid session ID can be acquired at the trace collection points. However, the session might be discarded in the J2EE application.

Points 14 and 15

A valid session ID can be acquired at the trace collection points. When the request processing finishes at these trace collection points, the session is not discarded in the J2EE application thereafter.

Point 16

A valid session ID can be acquired at the trace collection point. When the request processing finishes at this trace collection point, the session is not discarded in the J2EE application thereafter.

Furthermore, when a global session is generated, a valid global session ID can be acquired when the request processing ends.

Point 17

An invalid session ID can be acquired only when a session that has exceeded the valid period is discarded.

8.6.2 Trace information that can be collected

The following table describes the trace information about the session trace that can be collected in a Web container. The information about the global session is also output at the trace collection points with event IDs 0x8202, 0x8203, 0x8206, 0x8207, 0x8214, 0x8215, 0x8300, and 0x8311.

Table 8-13 Trace information that can be collected in a Web container (session trace)

No. in the figure#1
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8200
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session-ID: collection-method#2

4, 9
0x8202
A
Class name (JSP file name when a JSP is invoked)
--
--

B
Context root name#2
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID#2

2, 3
0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

7
0x8206
B
Class name
Dispatch type
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

4, 9
0x8207
B
--
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

5
0x8208
B
Context root name
Session valid period
Number-of-session-ID-characters: Session-ID

6
0x8209
B
Context root name
Session generation time
Number-of-session-ID-characters: Session-ID

17
0x8210
B
Context root name
Session valid period: session generation time
Number-of-session-ID-characters: Session-ID

1
0x8211
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session-ID: collection-method

8
0x8214
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

8
0x8215
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

2
0x8216
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

16
0x8300
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

B

When normal:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

For an exception:
Entrance-time status-code exception-name: number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

10, 13
0x8302
A
Class name (JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

14, 15
0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

12
0x8306
B
Class name
Dispatch type
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

10, 13
0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

16
0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

11
0x8314
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

11
0x8315
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

15
0x8316
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-IDIn the case of an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-12.

8.7 Trace collection points of a Web container (filter trace)

This section describes the trace collection points of the trace of a Web container when a filter that is invoked during Forward or Include is specified, and also describes the trace information that can be collected.

In the case of a Web container in which a filter that is invoked during Forward or Include is specified, the trace information that can be collected is different when the processing terminates normally, and when an error occurs. Trace acquisition points for both cases are explained below.

When an error page is set up by using the errorPage attribute in the page directive of a JSP, and an exception occurs in the JSP, the error page will be displayed when forwarding the request. Therefore, the trace output during Forward will be output even when an error page is displayed in the JSP.

Organization of this section

8.7.1 Trace collection points of a Web container when the processing terminates normally (filter trace)

8.7.2 Trace collection points of a Web container when an exception occurs (filter trace)

8.7.1 Trace collection points of a Web container when the processing terminates normally (filter trace)

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-14 Details of trace collection points in a Web container during normal termination (filter trace)

Event ID
No. in the figure#
Trace acquisition points
Level

0x8200
1
Immediately after a request is acquired, or when the request header analysis is complete (via the Web server)
A/B

0x8201
1
Immediately after a request is acquired, or when the request header analysis is complete (via the simple Web server)
A

0x8202
3
Immediately before a servlet or JSP is invoked
A/B

0x8202
6
Immediately before a servlet or JSP is invoked
A/B

0x8203
2
Immediately before the filter that is executed before the execution of the servlet or JSP that receives the request is invoked (filter for which the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or for which REQUEST is specified in the [[dispatcher]] tag)
B

0x8206
4
Immediately before a servlet or JSP is invoked via RequestDispatcher
B

0x8207
6
Immediately before the static contents are invoked (DefaultServlet)
B

0x8211
1
Immediately after a request is acquired, or when the request header analysis is complete (via the in-process HTTP server)
A/B

0x8214
5
Immediately before the filter executed during Forward is invoked (when the filter for which FORWARD is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is invoked)
B

0x8215
5
Immediately before the filter executed during Include is invoked
(filter for which INCLUDE is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8300
12
Immediately after completion of the request processing (via the Web server)
A/B

0x8301
12
Immediately after completion of the request processing (via the simple Web server)
A

0x8302
7
Immediately after completion of the processing of the servlet or JSP is complete
A/B

0x8302
10
Immediately after completion of the processing of the servlet or JSP is complete
A/B

0x8303
11
Immediately before the processing of the filter that is executed before the execution of the servlet or JSP that receives the request is complete (filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8306
9
Immediately after the processing of the servlet or JSP via RequestDispatcher is complete
B

0x8307
7
Immediately after completion of the processing of the static contents (DefaultServlet)
B

0x8311
12
Immediately after completion of the request processing is complete (via the in-process HTTP server)
A

0x8314
8
Immediately after completion of the processing of the filter executed during Forward (filter for which FORWARD is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8315
8
Immediately after completion of the processing of the filter executed during Include (filter for which INCLUDE is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#

Corresponds to the numbers in Figure 8-13.

The following figure shows the trace collection points in a Web container, when the filter that is invoked during Forward or Include is specified.

Figure 8-13 Trace collection points in a Web container during normal termination (filter trace)

(2) Trace information that can be collected

The following table describes the trace information that can be collected in a Web container, when the filter that is invoked during Forward or Include is specified.

Table 8-15 Trace information that can be collected in a Web container during normal termination (filter trace)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8200
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session ID: collection-method

0x8201
A
HTTP method
URI
--

0x8211
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session ID: collection-method

2
0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

3
0x8202
A
Class name (JSP file name when a JSP is invoked)
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

4
0x8206
B
Class name
Dispatch type
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

5
0x8214
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8215
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

6
0x8202
A
Class name (JSP file name when a JSP is invoked)
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8207
B
--
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

7
0x8302
A
Class name (JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

8
0x8314
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8315
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

9
0x8306
B
Class name
Dispatch type
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

10
0x8302
A
Class name (JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

11
0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

12
0x8300
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

B

When normal:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

For an exception:
Entrance-time status-code exception-name: number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8301
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-13.

8.7.2 Trace collection points of a Web container when an exception occurs (filter trace)

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-16 Details of trace collection points in a Web container when an exception occurs (filter trace)

Event ID
No. in the figure#
Trace acquisition points
Level

0x8200
1
Immediately after a request is acquired, or when the request header analysis is complete (via the Web server)
A/B

0x8201
1
Immediately after a request is acquired, or when the request header analysis is complete (via the simple Web server)
A

0x8211
1
Immediately after a request is acquired, or when the request header analysis is complete (via the in-process HTTP server)
A/B

0x8203
2
Immediately before the filter that is executed before the execution of the servlet or JSP that receives the request is invoked (filter for which the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or for which REQUEST is specified in the [[dispatcher]] tag)
B

0x8202
3
Immediately before a servlet or JSP is invoked
A/B

0x8302
4, 9
Immediately after completion of the processing of the servlet or JSP
A/B

0x8303
5
Immediately after completion of the processing of the filter that is executed before the execution of the servlet or JSP that receives the request (filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8206
6
Immediately before a servlet or JSP is invoked via RequestDispatcher
B

0x8216
7
Immediately before the filter that is executed during transfer to the error page is invoked
(filter for which ERROR is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8202
8
Immediately before a servlet or JSP is invoked
A/B

0x8207
8
Immediately before the static contents are invoked (DefaultServlet)
B

0x8307
9
Immediately after completion of the processing of the static contents (DefaultServlet)
B

0x8316
10
Immediately after completion of the processing of the filter executed during transfer to the error page
(filter for which ERROR is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8306
11
Immediately after completion of the processing of the servlet or JSP via RequestDispatcher
B

0x8300
12
Immediately after completion of the request processing (via the Web server)
A

0x8301
12
Immediately after completion of the request processing (via the simple Web server)
A

0x8311
12
Immediately after completion of the request processing (via the in-process HTTP server)
A/B

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#

Corresponds to the numbers in Figure 8-14.

The following figure shows the trace collection points in a Web container when an exception occurs.

Figure 8-14 Trace collection points in a Web container when an exception occurs

(2) Trace information that can be collected

The following table describes the trace information that can be collected in a Web container, when the filter that is invoked during Forward or Include is specified.

Table 8-17 Trace information that can be collected in a Web container when an exception occurs (filter trace)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8200
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session ID: collection-method

0x8201
A
HTTP method
URI
--

0x8211
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session ID: collection-method

2
0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

3
0x8202
A
Class name (JSP file name when a JSP is invoked)
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

4
0x8302
A
Class name (JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

5
0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

6
0x8206
B
Class name
Dispatch type
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

7
0x8216
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

8
0x8202
A
Class name (JSP file name when a JSP is invoked)
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8207
B
-
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

9
0x8302
A
Class name (JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

10
0x8316
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

11
0x8306
B
Class name
Dispatch type
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

12
0x8300
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

B

When normal:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

For an exception:
Entrance-time status-code exception-name: number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8301
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-14.

8.8 Trace collection points of a Web container (trace of the database session failover functionality)

This section describes the trace collection points and the trace information that can be collected when the database session failover functionality is used.

Organization of this section

8.8.1 Trace collection points and trace information that can be collected during request processing for creating an HTTP session (Trace of the database session failover functionality)

8.8.2 Trace collection points and trace information that can be collected during request processing for updating an HTTP session (Trace of database session failover functionality)

8.8.3 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session (Trace of database session failover functionality)

8.8.4 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session through valid period monitoring (Trace of database session failover functionality)

8.8.1 Trace collection points and trace information that can be collected during request processing for creating an HTTP session (Trace of the database session failover functionality)

This subsection describes the trace collection points and the trace information that can be collected during request processing for creating an HTTP session.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-18 Details of trace collection points of the request processing for creating an HTTP session (database session failover functionality)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8200 | 1 | Immediately after the acquisition of a request, or after the completion of the request header analysis (via the Web server) | A/B
0x8202 | 2 | Immediately before invoking a servlet or JSP | A/B
0x8203 | 2 | Immediately before invoking the filter that is executed before the execution of the servlet or JSP that receives the request (filter for which the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or for which REQUEST is specified in the [[dispatcher]] tag) | B
0x8207 | 2 | Immediately before invoking the static contents (DefaultServlet) | B
0x8211 | 1 | Immediately after the acquisition of a request, or after the completion of the request header analysis (via the in-process HTTP server) | A/B
0x8219 | 6 | Immediately before starting the serialization of the HTTP session property information with the database session failover functionality | A
0x8222 | 8 | Immediately before starting database access after the Web application processing with the database session failover functionality | A
0x8223 | 3 | Immediately before starting database access during the creation of the HTTP session with the database session failover functionality | A
0x8300 | 10 | Immediately after the completion of request processing (via the Web server) | A/B
0x8302 | 5 | Immediately after the completion of processing of the servlet or JSP | A/B
0x8303 | 5 | Immediately after the completion of processing of the filter that is executed before the execution of the servlet or JSP that receives the request (filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml) | B
0x8307 | 5 | Immediately after the completion of processing of the static contents (DefaultServlet) | B
0x8311 | 10 | Immediately after the completion of request processing (via the in-process HTTP server) | A/B
0x8316 | 5 | Immediately after the completion of processing of the filter executed during transfer to the error page is complete (filter for which ERROR is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml) | B
0x8319 | 7 | Immediately after the termination of serialization of the HTTP session property information with the database session failover functionality | A
0x8322 | 9 | Immediately after the termination of database access after the Web application processing with the database session failover functionality | A
0x8323 | 4 | Immediately after the termination of database access during the creation of the HTTP session with the database session failover functionality | A

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#

Corresponds to the numbers in Figure 8-15.

The following figure shows the trace collection points.

Figure 8-15 Trace collection points of the request processing for creating an HTTP session (database session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected during request processing for creating an HTTP session.

Table 8-19 Trace information that can be collected during request processing for creating an HTTP session (database session failover functionality)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8200
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session-ID: collection-method

0x8211
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session-ID: collection-method

2
0x8202
A
Class name
(JSP file name when a JSP is invoked)
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8207
B
--
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

3
0x8223
A
--
--
-

4
0x8323
A

When integrity protection mode is set

Number of the record for which exclusion is acquired

When integrity protection mode is

-1

--

When normal:
Entrance-time number-of-session-ID-characters: session-ID: session-ID-of-HTTP-session-created

For an exception:
Entrance-time exception-name

5
0x8302
A
Class name
(JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8316
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

6
0x8219
A
Request URL
--
Number-of-session-ID-characters: session-ID

7
0x8319
A
Request URL
Size (bytes) of the HTTP session property information after serialization

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

8
0x8222
A
--
--
Number-of-session-ID-characters: session-ID-of-HTTP-session

9
0x8322
A

When integrity protection mode is set

Number of the record for which exclusion is released

When integrity protection mode is disabled

-1

-

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

10
0x8300
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

B

When normal:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

For an exception:
Entrance-time status-code exception-name: number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-15.

8.8.2 Trace collection points and trace information that can be collected during request processing for updating an HTTP session (Trace of database session failover functionality)

This subsection describes the trace collection points and the trace information that can be collected during request processing for updating an HTTP session.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-20 Details of trace collection points of the request processing for updating an HTTP session (database session failover functionality)

Event ID
No. in the figure#1
Trace acquisition points
Level

0x8200
1
Immediately after the acquisition of a request, or after the completion of the request header analysis (via the Web server)
A/B

0x8202
6
Immediately before invoking a servlet or JSP
A/B

0x8203
6
Immediately before invoking the filter that is executed before the execution of the servlet or JSP that receives the request (filter for which the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or for which REQUEST is specified in the [[dispatcher]] tag)
B

0x8207
6
Immediately before invoking the static contents (DefaultServlet)
B

0x8211
1
Immediately after the acquisition of a request, or after the completion of the request header analysis (via the in-process HTTP server)
A/B

0x8219#2
8
Immediately before starting the serialization of the HTTP session property information with the database session failover functionality
A

0x8220
4
Immediately before starting the de-serialization of the HTTP session property information with the database session failover functionality
A

0x8221
2
Immediately before starting database access before the Web application processing with the database session failover functionality
A

0x8222#2
10
Immediately before starting database access after the Web application processing with the database session failover functionality
A

0x8300
12
Immediately after the completion of request processing (via the Web server)
A/B

0x8302
7
Immediately after the completion of processing of the servlet or JSP
A/B

0x8303
7
Immediately after the completion of processing of the filter that is executed before the execution of the servlet or JSP that receives the request (filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8307
7
Immediately after the completion of processing of the static contents (DefaultServlet)
B

0x8311
12
Immediately after the completion of request processing (via the in-process HTTP server)
A/B

0x8316
7
Immediately after the completion of processing of the filter executed during transfer to the error page is complete
(filter for which ERROR is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8319#2
9
Immediately after the termination of serialization of the HTTP session property information with the database session failover functionality
A

0x8320
5
Immediately after the termination of de-serialization of the HTTP session property information with the database session failover functionality
A

0x8321
3
Immediately after the termination of database access before the Web application processing with the database session failover functionality
A

0x8322#2
11
Immediately after the termination of database access after the Web application processing with the database session failover functionality
A

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#1

Corresponds to the numbers in Figure 8-16.

#2

Not output for requests meant for referencing the HTTP session.

The following figure shows the trace collection points.

Figure 8-16 Trace collection points of the request processing for updating an HTTP session (database session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected during request processing for updating an HTTP session.

Table 8-21 Trace information that can be collected during request processing for creating an HTTP session (database session failover functionality)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8200
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session ID: collection-method

0x8211
A
HTTP method
URI
-

B
Number-of-session-ID-characters: session ID: collection-method

2
0x8221
A
--
--
Number-of-session-ID-characters: session-ID-received-with-the-request

3
0x8321
A

When integrity protection mode is set

Number of the record for which exclusion is acquired

When integrity protection mode is disabled

-1

--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

4
0x8220
A
Request URL
Size (bytes) of the HTTP session property information before de-serialization
Number-of-session-ID-characters: session-ID

5
0x8320
A
Request URL
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

6
0x8202
A
Class name
(JSP file name when a JSP is invoked)
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8207
B
--
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

7
0x8302
A
Class name
(JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8316
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

8
0x8219
A
Request URL
--
Number-of-session-ID-characters: session-ID

9
0x8319
A
Request URL
Size (bytes) of the HTTP session property information after serialization

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

10
0x8222
A
--
--
Number-of-session-ID-characters: session-ID-of-HTTP-session

11
0x8322
A

When integrity protection mode is set

Number of the record for which exclusion is released

When integrity protection mode is disabled

-1

--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

12
0x8300
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

B

When normal:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

For an exception:
Entrance-time status-code exception-name: number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8311
A
HTTP method
URI
Entrance-time-status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-16.

8.8.3 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session (Trace of database session failover functionality)

This subsection describes the trace collection points and the trace information that can be collected during request processing for disabling an HTTP session.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-22 Details of trace collection points of the request processing for disabling an HTTP session (database session failover functionality)

Event ID
No. in the figure#
Trace acquisition points
Level

0x8200
1
Immediately after the acquisition of a request, or after the completion of the request header analysis (via the Web server)
A/B

0x8202
6
Immediately before invoking a servlet or JSP
A/B

0x8203
6
Immediately before invoking the filter that is executed before the execution of the servlet or JSP that receives the request (filter for which the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or for which REQUEST is specified in the [[dispatcher]] tag)
B

0x8207
6
Immediately before invoking the static contents (DefaultServlet)
B

0x8211
1
Immediately after the acquisition of a request, or after the completion of the request header analysis (via the in-process HTTP server)
A/B

0x8220
4
Immediately before starting the de-serialization of the HTTP session property information with the database session failover functionality
A

0x8221
2
Immediately before starting database access before the Web application processing with the database session failover functionality
A

0x8224
7
Immediately before starting database access when disabling the HTTP session with the database session failover functionality
A

0x8300
10
Immediately after the completion of request processing (via the Web server)
A/B

0x8302
9
Immediately after the completion of processing of the servlet or JSP
A/B

0x8303
9
Immediately after the completion of processing of the filter that is executed before the execution of the servlet or JSP that receives the request (filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8307
9
Immediately after the completion of processing of the static contents (DefaultServlet)
B

0x8311
10
Immediately after the completion of request processing (via the in-process HTTP server)
A/B

0x8316
9
Immediately after the completion of processing of the filter executed during transfer to the error page is complete
(filter for which ERROR is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml)
B

0x8320
5
Immediately after the termination of de-serialization of the HTTP session property information with the database session failover functionality
A

0x8321
3
Immediately after the termination of database access before the Web application processing with the database session failover functionality
A

0x8324
8
Immediately after the termination of database access when the HTTP session is disabled with the database session failover functionality
A

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#

Corresponds to the numbers in Figure 8-17.

The following figure shows the trace collection points.

Figure 8-17 Trace collection points of the request processing for disabling an HTTP session (database session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected during request processing for disabling an HTTP session.

Table 8-23 Trace information that can be collected during request processing for disabling an HTTP session (database session failover functionality)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8200
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session-ID: collection-method

0x8211
A
HTTP method
URI
--

B
Number-of-session-ID-characters: session-ID: collection-method

2
0x8221
A
--
--
Number-of-session-ID-characters: session-ID-received-with-the-request

3
0x8321
A

When integrity protection mode is set

Number of the record for which exclusion is acquired

When integrity protection mode is disabled

-1

--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

4
0x8220
A
Request URL
Size (bytes) of the HTTP session property information before de-serialization
Number-of-session-ID-characters: session-ID

5
0x8320
A
Request URL
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

6
0x8202
A
Class name
(JSP file name when a JSP is invoked)
--
--

B
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8207
B
--
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

7
0x8224
A
--
--
Number-of-session-ID-characters: session-ID-of-the-disabled-HTTP-session

8
0x8324
A

When integrity protection mode is set

Number of the record for which exclusion is released

When integrity protection mode is disabled

-1

--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

9
0x8302
A
Class name
(JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8316
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

10
0x8300
A
HTTP method
URI

When normal:
Entrance-time status-code

For an exception:
Entrance-time status-code exception-name

B

When normal:
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

For an exception:
Entrance-time status-code exception-name: number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

0x8311
A
HTTP method
URI
Entrance-time-status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-17.

8.8.4 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session through valid period monitoring (Trace of database session failover functionality)

This subsection describes the trace collection points and the trace information that can be collected during request processing for disabling an HTTP session by monitoring the valid period.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-24 Details of trace collection points of the request processing for disabling an HTTP session through valid period monitoring (database session failover functionality)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8210 | 3 | After session timeout | B
0x8225 | 1 | Immediately before starting the valid period monitoring process of the global session information on the database | A
0x8325 | 2 | Immediately after the termination of the valid period monitoring process of the global session information on the database | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-18.

The following figure shows the trace collection points.

Figure 8-18 Trace collection points of the request processing for disabling an HTTP session through valid period monitoring (database session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected during request processing for disabling an HTTP session through valid period monitoring.

Table 8-25 Trace information that can be collected during request processing for disabling an HTTP session through valid period monitoring (database session failover functionality)

No. in the figure#1
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8225#2
A
--
--
--

2
0x8325#2
A

When the valid period checking of the global session information is executed

Number of disabled global sessions

When the valid period checking of the global session information is not executed

Name (IP address) of the J2EE server that currently manages the valid period checking

--

When normal:
Entrance-time

For an exception:

Entrance-time exception-name

3
0x8210
B
Context root name
Session valid period: session generation time
Number-of-session-ID-characters: session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-18.

#2

Not output when the integrity protection mode is disabled.

8.9 Trace collection points of a Web container (Trace of the EADs session failover functionality)

This section describes the trace collection points and the trace information that can be collected when the EADs session failover functionality is used.

Organization of this section

8.9.1 Trace collection points and trace information that can be collected during request processing for creating an HTTP session (Trace of the EADs session failover functionality)

8.9.2 Trace collection points and trace information that can be collected during request processing for updating an HTTP session (Trace of the EADs session failover functionality)

8.9.3 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session (Trace of the EADs session failover functionality)

8.9.4 Trace collection points and trace information that can be collected when an EADs client is invoked (Trace of the EADs session failover functionality)

8.9.1 Trace collection points and trace information that can be collected during request processing for creating an HTTP session (Trace of the EADs session failover functionality)

This section describes the trace collection points and the trace information that can be collected during request processing for creating an HTTP session.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-26 Details of the trace collection points during request processing for creating an HTTP session (EADs session failover functionality)

Event ID
No. in the figure#
Trace collection points
Level

0x8200
1
Obtaining a request or analyzing the request header (via a Web server)
A/B

0x8202
2
Immediately before a servlet/JSP is invoked
A/B

0x8203
2
Immediately before invoking the filter executed before executing the servlet/JSP that receives the request (filter for which the <dispatcher> tag is omitted in the <filter-mapping> tag of web.xml, or a filter specifying REQUEST in the <dispatcher> tag)
B

0x8207
2
Immediately before invoking the static contents (DefaultServlet)
B

0x8211
1
Immediately after the process of obtaining a request or analyzing a request header is complete (via an in-process HTTP server)
A/B

0x8227
6
Immediately before the EADs session failover functionality starts serializing the HTTP session attribute information
A

0x8230
8
Immediately before the EADs session failover functionality starts accessing the EADs after processing a Web application
A

0x8231
3
Immediately before the EADs session failover functionality starts accessing the EADs for creating an HTTP session
A

0x8300
10
Immediately after the processing is completed (via a Web server)
A/B

0x8302
5
Immediately after the servlet/JSP processing is complete
A/B

0x8303
5
Immediately after completing the processing of the filter executed before executing the servlet/JSP that receives the request (filter specifying REQUEST in the <dispatcher> tag of the <filter-mapping> tag in web.xml)
B

0x8307
5
Immediately after the processing of the static contents is complete (DefaultServlet)
B

0x8311
10
Immediately after the processing of a request is complete
(via an in-process HTTP server)
A/B

0x8316
5
Immediately after completing the processing of the filter executed for transmission to the error page (filter specifying ERROR in the <dispatcher> tag of the <filter-mapping> tag in web.xml)
B

0x8327
7
Immediately after the EADs session failover functionality finishes serializing the HTTP session attribute information
A

0x8330
9
Immediately after the EADs session failover functionality finishes accessing the EADs after processing the Web application
A

0x8331
4
Immediately after the EADs session failover functionality finishes accessing the EADs for creating an HTTP session
A

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#:

Corresponds to the numbers in Figure 8-19.

The following figure shows the trace collection points.

Figure 8-19 Trace collection points during request processing for creating an HTTP session (EADs session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected during request processing for creating an HTTP session.

Table 8-27 Trace information that can be collected during request processing for creating an HTTP session (EADs session failover functionality)

No. in the figure#
Event ID
Level
Information that can be collected

Interface name
Operation name
Option

1
0x8200
A
HTTP method
URI
--

B
number-of-session-ID-characters: session-ID:collection-method

0x8211
A
HTTP method
URI
--

B
number-of-session-ID-characters: session-ID:collection-method

2
0x8202
A
Class name
(JSP file name when a JSP is invoked)
--
--

B
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8207
B
--
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8203
B
Class name
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

3
0x8231
A
--
--
--

4
0x8331
A
--
--

When normal
Entrance-time number-of-session-ID-characters:session-ID-of-created-HTTP-session

For an exception
Entrance-time exception-name

5
0x8302
A
Class name
(JSP file name when a JSP is invoked)
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

B
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8303
B
Class name
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8316
B
Class name
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

6
0x8227
A
Request URL
--
number-of-session-ID-characters: session-ID

7
0x8327
A
Request URL
Size of the HTTP session attribute information after serialization (bytes)

When normal
Entrance-time

For an exception
Entrance-time exception-name

8
0x8230
A
--
--
number-of-session-ID-characters:session-ID-of-HTTP-session

9
0x8330
A
--
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

10
0x8300
A
HTTP method
URI

When normal
Entrance-time status-code

For an exception
Entrance-time status-code exception-name

B

When normal
Entrance-time status-code number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

For an exception
Entrance-time status-code exception-name:number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#:

Corresponds to the numbers in Figure 8-19.

8.9.2 Trace collection points and trace information that can be collected during request processing for updating an HTTP session (Trace of the EADs session failover functionality)

This subsection describes the trace collection points and trace information that can be collected during request processing for updating an HTTP session.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-28 Details of the trace collection points during request processing for updating an HTTP session (EADs session failover functionality)

Event ID | No. in the figure#1 | Trace collection points | Level
0x8200 | 1 | Immediately after the process of obtaining a request or analyzing a request header is complete (via a Web server) | A/B
0x8202 | 6 | Immediately before a servlet/JSP is invoked | A/B
0x8203 | 6 | Immediately before invoking the filter executed before executing the servlet/JSP that receives the request (filter for which the <dispatcher> tag is omitted in the <filter-mapping> tag of web.xml, or a filter specifying REQUEST in the <dispatcher> tag) | B
0x8207 | 6 | Immediately before invoking the static contents (DefaultServlet) | B
0x8211 | 1 | Immediately after the process of obtaining a request or analyzing a request header is complete (via in-process HTTP server) | A/B
0x8227#2 | 8 | Immediately before the EADs session failover functionality starts serializing the HTTP session attribute information | A
0x8228 | 4 | Immediately before the EADs session failover functionality starts de-serializing the HTTP session attribute information | A
0x8229 | 2 | Immediately before the EADs session failover functionality starts accessing the EADs before processing a Web application | A
0x8230#2 | 10 | Immediately before the EADs session failover functionality starts accessing the EADs after processing a Web application | A
0x8300 | 12 | Immediately after the processing of a request is complete (via a Web server) | A/B
0x8302 | 7 | Immediately after the servlet/JSP processing is complete | A/B
0x8303 | 7 | Immediately after completing the processing of the filter executed before executing the servlet/JSP that receives the request (filter specifying REQUEST in the <dispatcher> tag of the <filter-mapping> tag in web.xml) | B
0x8307 | 7 | Immediately after the processing of the static contents is complete (DefaultServlet) | B
0x8311 | 12 | Immediately after the processing of a request is complete (via an in-process HTTP server) | A/B
0x8316 | 7 | Immediately after completing the processing of the filter executed for transmission to the error page (filter specifying ERROR in the <dispatcher> tag of the <filter-mapping> tag in web.xml) | B
0x8327#2 | 9 | Immediately after the EADs session failover functionality finishes serializing the HTTP session attribute information | A
0x8328 | 5 | Immediately after the EADs session failover functionality finishes de-serializing the HTTP session attribute information | A
0x8329 | 3 | Immediately after the EADs session failover functionality finishes accessing the EADs before processing a Web application | A
0x8330#2 | 11 | Immediately after the EADs session failover functionality finishes accessing the EADs after processing a Web application | A

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#1:

Corresponds to the numbers in Figure 8-20.

#2:

Not output for the requests that only reference the HTTP session.

The following figure shows the trace collection points.

Figure 8-20 Trace collection points during request processing for updating an HTTP session (EADs session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected during request processing for updating an HTTP session.

Table 8-29 Trace information that can be collected during request processing for updating an HTTP session (EADs session failover functionality)

No. in the figure#
Event ID
Level
Information that can be collected

Interface name
Operation name
Option

1
0x8200
A
HTTP method
URI
--

B
number-of-session-ID-characters: session-ID:collection-method

0x8211
A
HTTP method
URI
--

B
number-of-session-ID-characters: session-ID:collection-method

2
0x8229
A
--
--
number-of-session-ID-characters:session-ID-received-with-request

3
0x8329
A
--
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

4
0x8228
A
Request URL
Size of the HTTP session attribute information before de-serialization (bytes)
number-of-session-ID-characters: session-ID

5
0x8328
A
Request URL
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

6
0x8202
A
Class name
(JSP file name when a JSP is invoked)
--
--

B
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8207
B
--
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8203
B
Class name
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

7
0x8302
A
Class name
(JSP file name when a JSP is invoked)
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

B
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8303
B
Class name
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8316
B
Class name
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

8
0x8227
A
Request URL
--
number-of-session-ID-characters: session-ID

9
0x8327
A
Request URL
Size of the HTTP session attribute information after serialization (bytes)

When normal
Entrance-time

For an exception
Entrance-time exception-name

10
0x8230
A
--
--
number-of-session-ID-characters:session-ID-of-HTTP-session

11
0x8330
A
--
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

12
0x8300
A
HTTP method
URI

When normal
Entrance-time status-code

For an exception
Entrance-time status-code exception-name

B

When normal
Entrance-time status-code number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

For an exception
Entrance-time status-code exception-name:number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#:

Corresponds to the numbers in Figure 8-20.

8.9.3 Trace collection points and trace information that can be collected during request processing for disabling an HTTP session (Trace of the EADs session failover functionality)

Trace collection points and trace information that can be collected during request processing for disabling an HTTP session.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-30 Details of the trace collection points during request processing for disabling an HTTP session (EADs session failover functionality)

Event ID | No. in the figure# | Trace collection points | Level
0x8200 | 1 | Immediately after the process of obtaining a request or analyzing a request header is complete (via a Web server) | A/B
0x8202 | 6 | Immediately before a servlet/JSP is invoked | A/B
0x8203 | 6 | Immediately before invoking the filter executed before executing the servlet/JSP that receives the request (filter for which the <dispatcher> tag is omitted in the <filter-mapping> tag of web.xml, or a filter specifying REQUEST in the <dispatcher> tag) | B
0x8207 | 6 | Immediately before invoking the static contents (DefaultServlet) | B
0x8211 | 1 | Immediately after the process of obtaining a request or analyzing a request header is complete (via in-process HTTP server) | A/B
0x8228 | 4 | Immediately before the EADs session failover functionality starts de-serializing the HTTP session attribute information | A
0x8229 | 2 | Immediately before the EADs session failover functionality starts accessing the EADs before processing a Web application | A
0x8232 | 7 | Immediately before the EADs session failover functionality starts accessing the EADs for disabling an HTTP session | A
0x8300 | 10 | Immediately after the processing of a request is complete (via a Web server) | A/B
0x8302 | 9 | Immediately after the servlet/JSP processing is complete | A/B
0x8303 | 9 | Immediately after completing the processing of the filter executed before executing the servlet/JSP that receives the request (filter specifying REQUEST in the <dispatcher> tag of the <filter-mapping> tag in web.xml) | B
0x8307 | 9 | Immediately after the processing of the static contents is complete (DefaultServlet) | B
0x8311 | 10 | Immediately after the processing of a request is complete (via an in-process HTTP server) | A/B
0x8316 | 9 | Immediately after completing the processing of the filter executed for transmission to the error page (filter specifying ERROR in the <dispatcher> tag of the <filter-mapping> tag in web.xml) | B
0x8328 | 5 | Immediately after the EADs session failover functionality finishes de-serializing the HTTP session attribute information | A
0x8329 | 3 | Immediately after the EADs session failover functionality finishes accessing the EADs before processing a Web application | A
0x8332 | 8 | Immediately after the EADs session failover functionality finishes accessing the EADs for disabling an HTTP session | A

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

#:

Corresponds to the numbers in Figure 8-21.

The following figure shows the trace collection points.

Figure 8-21 Trace collection points during request processing for disabling an HTTP session (EADs session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected during request processing for disabling an HTTP session.

Table 8-31 Trace information that can be collected during request processing for disabling an HTTP session (EADs session failover functionality)

No. in the figure#
Event ID
Level
Information that can be collected

Interface name
Operation name
Option

1
0x8200
A
HTTP method
URI
--

B
number-of-session-ID-characters: session-ID:collection-method

0x8211
A
HTTP method
URI
--

B
number-of-session-ID-characters: session-ID:collection-method

2
0x8229
A
--
--
number-of-session-ID-characters:session-ID-received-with-request

3
0x8329
A
--
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

4
0x8228
A
Request URL
Size of the HTTP session attribute information before de-serialization (bytes)
number-of-session-ID-characters: session-ID

5
0x8328
A
Request URL
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

6
0x8202
A
Class name
(JSP file name when a JSP is invoked)
--
--

B
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8207
B
--
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8203
B
Class name
Context root name
number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

7
0x8232
A
--
--
number-of-session-ID-characters:session-ID-of-disabled-HTTP-session

8
0x8332
A
--
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

9
0x8302
A
Class name
(JSP file name when a JSP is invoked)
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

B
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8303
B
Class name
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

0x8316
B
Class name
Context root name

When normal
Entrance-time number-of-session-ID-characters: session-ID

For an exception
Entrance-time exception-name:number-of-session-ID-characters: session-ID

10
0x8300
A
HTTP method
URI

When normal
Entrance-time status-code

For an exception
Entrance-time status-code exception-name

B

When normal
Entrance-time status-code number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

For an exception
Entrance-time status-code exception-name:number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

0x8311
A
HTTP method
URI
Entrance-time status-code

B
Entrance-time status-code number-of-session-ID-characters: session-ID:number-of-global-session-ID-characters:global-session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#:

Corresponds to the numbers in Figure 8-21.

8.9.4 Trace collection points and trace information that can be collected when an EADs client is invoked (Trace of the EADs session failover functionality)

This subsection describes the trace collection points and trace information that can be collected when an EADs client is invoked.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-32 Details of the trace collection points when an EADs client is invoked (EADs session failover functionality)

Event ID | No. in the figure# | Trace collection points | Level
0x8233 | 1 | Immediately before the EADs session failover functionality invokes an EADs client | A
0x8333 | 2 | Immediately after the EADs session failover functionality invokes an EADs client | A

Legend:

A: Standard

#:

Corresponds to the numbers in Figure 8-22.

The following figure shows the trace collection points.

Figure 8-22 Trace collection points when an EADs client is invoked (EADs session failover functionality)

(2) Trace information that can be collected

The following table describes the trace information that can be collected when an EADs client is invoked.

Table 8-33 Trace information that can be collected when an EADs client is invoked (EADs session failover functionality)

No. in the figure#
Event ID
Level
Information that can be collected

Interface name
Operation name
Option

1
0x8233
A
Class name of the invoked EADs client
Method name of the invoked EADs client
Method-argument-of-invoked-EADs-client

2
0x8333
A
--
--

When normal
Entrance-time

For an exception
Entrance-time exception-name

Legend:

A: Standard

--: Not applicable

#:

Corresponds to the numbers in Figure 8-22.

8.10 Trace collection points of a Web container (trace of the memory session failover functionality)

This section describes the trace collection points and the trace information that can be collected in a Web container when the memory database session failover functionality is used.

Organization of this section

8.10.1 Trace collection points and PRF trace collection levels

8.10.2 Trace information that can be collected

8.10.1 Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-34 Details of trace collection points in a Web container (memory session failover functionality)

Event ID
No. in the figure#1
Trace acquisition points
Level

0x8203
1
Immediately before invoking the filter that is executed before the execution of the servlet or JSP that receives the request (when the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or when a filter for which REQUEST is specified in the [[dispatcher]] tag is invoked)
B

0x8E01
2
When the process for sending a request with the stub starts
A

0x8E05
3
During the processing for receiving the request at the server side
A

0x8405
4
Immediately after the EJB container receives the request
A

0x8406
5
Immediately before the EJB container sends a response
A

0x8E06
6
During the processing for sending a response at the server side
A

0x8E02
7
When the process for receiving a response with the stub is complete
A

0x8218#2
8
Immediately before starting de-serialization of the memory session failover functionality
A

0x8318#2
9
Immediately after the termination of de-serialization of the memory session failover functionality
A

0x8203
10
Immediately before invoking the filter that is executed before the execution of the servlet or JSP that receives the request (when the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or when a filter for which REQUEST is specified in the [[dispatcher]] tag is invoked)
B

0x8202
11
Immediately before invoking a servlet or JSP
A/B

0x8207
11
Immediately before invoking the static contents (DefaultServlet)
B

0x8302
12
Immediately after the completion of processing of the servlet or JSP
A/B

0x8307
12
Immediately after the completion of processing of the static contents (DefaultServlet)
B

0x8303
13
Immediately after the completion of processing of the filter that is executed before the execution of the servlet or JSP that receives the request
(when the processing of the filter for which REQUEST is specified in the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is complete)
B

0x8217#2
14
Immediately before starting the serialization of the memory session failover functionality
A

0x8317#2
15
Immediately after the termination of serialization of the memory session failover functionality
A

0x8E01
16
When the process for sending a request with the stub starts
A

0x8E05
17
During the processing for receiving the request at the server side
A

0x8405
18
Immediately after the EJB container receives the request
A

0x8406
19
Immediately before the EJB container sends a response
A

0x8E06
20
During the processing for sending a response at the server side
A

0x8E02
21
When the process for receiving a response with the stub is complete
A

0x8203
22
Immediately before invoking the filter that is executed before the execution of the servlet or JSP that receives the request (when the [[dispatcher]] tag of the [[filter-mapping]] tag of web.xml is omitted, or when a filter for which REQUEST is specified in the [[dispatcher]] tag is invoked)
B

Legend:

A: Standard

B: Advanced

A/B: Different information is collected for the Standard and Advanced levels.

--: Not applicable

#1

Corresponds to the numbers in Figure 8-23.

#2

Output when all of the below conditions are fulfilled:

- The inheritance of the objects of a serializable class is enabled.

- Session information to be serialized exists.

The following figure shows the trace collection points in the memory session failover functionality.

Figure 8-23 Trace collection points in a Web container (memory session failover functionality)

8.10.2 Trace information that can be collected

The following table describes the trace information that can be collected in the memory session failover functionality.

Table 8-35 Trace information that can be collected in a Web container (memory session failover functionality).

No. in the figure#1
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

2
0x8E01
A
Interface name
Operation name
--

3
0x8E05
A
--
--
--

4
0x8405
A
Bean name
Method name, number of arguments
--

5
0x8406
A
Bean name
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

6
0x8E06
A
--
--
--

7
0x8E02
A
Interface name (No occurrence of exception)
Operation name (No occurrence of exception)

When normal:
Nil

For an exception:
Exception-name

8
0x8218#2
A
Request URL
Size (bytes) of the global session information before de-serialization
Number-of-global-session-ID-characters: global-session-ID

9
0x8318#2
A
Request URL
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

10
0x8203
B
Class name
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

11
0x8202
A
Class name (JSP file name when a JSP is invoked)
--
--

B

Context root name

Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

11
0x8207
B
--
Context root name
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

12
0x8302
A
Class name (JSP file name when a JSP is invoked)
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

0x8307
B
--
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

13
0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

14
0x8217#2
A
Request URL
None
Number-of-session-ID-characters: session-ID: number-of-global-session-ID-characters: global-session-ID

15
0x8317#2
A
Request URL
Size (bytes) of the global session information after serialization#3

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

16
0x8E01
A
Interface name
Operation name
--

17
0x8E05
A
--
--
--

18
0x8405
A
Bean name
Method name, number of arguments
--

19
0x8406
A
Bean name
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

20
0x8E06
A
--
--
--

21
0x8E02
A
Interface name (No occurrence of exception)
Operation name (No occurrence of exception)

When normal:
--

For an exception:
Exception-name

22
0x8303
B
Class name
Context root name

When normal:
Entrance-time number-of-session-ID-characters: session-ID

For an exception:
Entrance-time exception-name: number-of-session-ID-characters: session-ID

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-23.

#2

Output when all of the below conditions are fulfilled:

- The inheritance of the objects of a serializable class is enabled.

- Session information to be serialized exists.

#3

When an exception occurs, 0 is displayed.

8.11 Trace collection points of an EJB container

This section describes the trace collection points of an EJB container and also the trace information that can be collected, in different cases of a Session Bean or Entity Bean, Message-driven Bean, or during the use of the Timer Service, and in the case of occurrence of method cancellation.

Organization of this section

8.11.1 In the case of a Session Bean or Entity Bean

8.11.2 In the Case of Message-driven Bean (EJB2.0)

8.11.3 In the case of a Message-driven Bean (EJB2.1 and later)

8.11.4 For Timer Service

8.11.5 When the Session Bean is invoked asynchronously

8.11.6 When method cancellation occurs

8.11.1 In the case of a Session Bean or Entity Bean

This subsection describes the trace collection points of a Session Bean or Entity Bean, and the trace information that can be collected.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-36 Details of trace collection points in a Session Bean or Entity Bean

Event ID | No. in the figure# | Trace acquisition points | Level
0x8401 | 1 | In the case of a remote home interface | Immediately after the EJB container receives a request | A
0x8402 | 4 | Immediately before the EJB container sends a response | A
0x8403 | 1 | In the case of a local home interface | Immediately after the EJB container receives a request | A
0x8404 | 4 | Immediately before the EJB container sends a response | A
0x8405 | 1 | In the case of a remote component interface | Immediately after the EJB container receives a request | A
0x8406 | 4 | Immediately before the EJB container sends a response | A
0x8407 | 1 | In the case of a local component interface | Immediately after the EJB container receives a request | A
0x8408 | 4 | Immediately before the EJB container sends a response | A
0x8409 | 2 | Immediately before the EJB container calls back the business method of the EJB | B
0x840A | 3 | Immediately after returning from the callback of the EJB business method | B
0x8453 | 2 | Immediately before the EJB container calls back the home method of the EJB | B
0x8454 | 3 | Immediately after returning from the callback of the EJB home method | B
0x8470 | 1 | In the case of a remote business interface | Immediately after the EJB container receives a request | A
0x8471 | 4 | Immediately before the EJB container sends a response | A
0x8472 | 1 | In the case of a local business interface | Immediately after the EJB container receives a request | A
0x8473 | 4 | Immediately before the EJB container sends a response | A
0x8474 | 1 | In the case of a remote business interface | Immediately after the EJB container receives a request for creating an instance of the Stateful Session Bean via remote business interface | A
0x8475 | 1 | Immediately before the EJB container sends a response for the request to create an instance of the Stateful Session Bean via remote business interface | A
0x8476 | 1 | In the case of a local business interface | Immediately after the EJB container receives a request for creating an instance of the Stateful Session Bean via local business interface | A
0x8477 | 1 | Immediately before the EJB container sends a response for the request to create an instance of the Stateful Session Bean via local business interface | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-24.

The following figure shows the trace collection points in a Session Bean or Entity Bean.

Figure 8-24 Trace collection points of a Session Bean or Entity Bean

(2) Trace information that can be collected

The following table describes the trace information that can be collected in a Session Bean or Entity Bean.

Table 8-37 Trace information that can be collected in a Session Bean or Entity Bean

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8401
A
Bean name
Method name, number of arguments
--

0x8403
A
Bean name
Method name, number of arguments
--

0x8405
A
Bean name
Method name, number of arguments
--

0x8407
A
Bean name
Method name, number of arguments
--

0x8470
A
Bean name
Method name, number of arguments
--

0x8472
A
Bean name
Method name, number of arguments
--

0x8474
A
Bean name
--
--

0x8475
A
Bean name
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

0x8476
A
Bean name
--
--

0x8477
A
Bean name
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

2
0x8409
B
Bean name
Method name, number of arguments
--

0x8453
B
Bean name
Method name, number of arguments
--

3
0x840A
B
Bean name
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

0x8454
B
Bean name
Method name, number of arguments

4
0x8402
A
Bean name
Method name, number of arguments

0x8404
A
Bean name
Method name, number of arguments

0x8406
A
Bean name
Method name, number of arguments

0x8408
A
Bean name
Method name, number of arguments

0x8471
A
Bean name
Method name, number of arguments

0x8473
A
Bean name
Method name, number of arguments

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-24.

8.11.2 In the Case of Message-driven Bean (EJB2.0)

This subsection describes the trace collection points of a Message-driven Bean (EJB2.0), and also the trace information that can be collected.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-38 Details of trace collection points in a Message-driven Bean (EJB2.0)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8425 | 1 | When the message processing in the EJB container starts | A
0x8426 | 4 | When the message processing in the EJB container ends | A
0x8427 | 2 | Immediately before the EJB container call backs the onMessage method of the Message-driven Bean | B
0x8428 | 3 | Immediately after returning from the callback of the onMessage method of the Message-driven Bean | B

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-25.

The following figure shows the trace collection points in a Message-driven Bean (EJB2.0).

Figure 8-25 Trace collection points of a Message-driven Bean (EJB2.0)

(2) Trace information that can be collected

The following table describes the trace information that can be collected in a Message-driven Bean (EJB2.0).

Table 8-39 Trace information that can be collected in a Message-driven Bean (EJB2.0)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8425
A
Bean name
--
--

2
0x8427
B
--
--
--

3
0x8428
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

4
0x8426
A
Bean name
--

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-25.

8.11.3 In the case of a Message-driven Bean (EJB2.1 and later)

This subsection describes the trace collection points of a Message-driven Bean (EJB2.1 and later), and also the trace information that can be collected.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-40 Details of trace collection points in a Message-driven (EJB2.1 and later)

Event ID | No. in the figures# | Trace acquisition points | Level
0x842D | 1 | Immediately after invoking the beforeDelivery() method of the Message-driven Bean | A
0x842E | 2 | Immediately before the return the beforeDelivery() method of the Message-driven Bean | A
0x842F | 3 | Immediately after invoking the method of message listener of the Message-driven Bean from the resource adapter | A
0x8431 | 4 | Immediately before the EJB container calls back the method of message listener of the Message-driven Bean | A
0x8432 | 5 | Immediately after returning from the callback of the method of message listener of the Message-driven Bean | A
0x8430 | 6 | Immediately before the return of the method of message listener of the Message-driven Bean that is invoked from the resource adapter | A
0x8433 | 7 | Immediately after invoking the beforeDelivery() method of the Message-driven Bean | A
0x8434 | 8 | Immediately before the return the beforeDelivery() method of the Message-driven Bean | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-26 and Figure 8-27.

The following figure shows the trace collection points in a Message-driven Bean (EJB2.1 and later).

Figure 8-26 Trace collection points of a Message-driven Bean (EJB2.1 and later) (in the case of optionA#)

# Indicates the message delivery option described in Connector 1.5 specifications.

Figure 8-27 Trace collection points of a Message-driven Bean (EJB2.1 and later) (in the case of optionB#)

# Indicates the message delivery option described in Connector 1.5 specifications.

(2) Trace information that can be collected

The following table describes the trace information that can be collected in a Message-driven Bean (EJB2.1 and later).

Table 8-41 Trace information that can be collected in a Message-driven Bean (EJB2.1 and later)

No. in the figures#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x842D
A
Bean name
--
--

2
0x842E
A
Bean name
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x842F
A
Bean name
Method Name
--

4
0x8431
A
Bean name
Method Name
--

5
0x8432
A
Bean name
Method Name

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

6
0x8430
A
Bean name
Method Name

7
0x8433
A
Bean name
--
--

8
0x8434
A
Bean name
--

When normal:
Entrance-time
For an exception:
Entrance-time exception-name

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-26 and Figure 8-27.

8.11.4 For Timer Service

This subsection describes the trace collection points of the Timer Service, and the trace information that can be collected.

Organization of this subsection

(1) For createTimer

(2) For cancel

(3) In the case of a callback

(4) In the case of createSingleActionTimer

(5) In the case of createIntervalTimer

(6) In the case of createCalendarTimer

(1) For createTimer

(a) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-42 Details of trace collection points in Timer Service (for createTimer)

Event ID | No. in the figure# | Trace collection points | Level
0x8460 | 1 | When the processing of TimerService.createTimer(Date initialExpiration, long intervalDuration, Serializable info) starts | A
0x8462 | 1 | When the processing of TimerService.createTimer(Date expiration, Serializable info) starts | A
0x8464 | 1 | When the processing of TimerService.createTimer(long initialDuration, long intervalDuration, Serializable info) starts | A
0x8466 | 1 | When the processing of 'TimerService.createTimer(long duration, Serializable info) starts | A
0x8461 | 2 | When the processing of TimerService.createTimer(Date initialExpiration, long intervalDuration, Serializable info) ends | A
0x8463 | 2 | When the processing of TimerService.createTimer(Date expiration, Serializable info) ends | A
0x8465 | 2 | When the processing of 'TimerService.createTimer(long initialDuration, long intervalDuration, Serializable info) ends | A
0x8467 | 2 | When the processing of TimerService.createTimer(long duration, Serializable info) ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-28.

The following figure shows the trace collection points of Timer Service for createTimer.

Figure 8-28 Trace collection points of Timer Service (for createTimer)

(b) Trace information that can be collected

The following table describes the trace information that can be collected in Timer Service for createTimer.

Table 8-43 Trace information that can be collected in Timer Service (for createTimer)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8460
A
Class name of the Bean to be called back
--
Argument information

1
0x8462
A
Class name of the Bean to be called back
--
Argument information

1
0x8464
A
Class name of the Bean to be called back
--
Argument information

1
0x8466
A
Class name of the Bean to be called back
--
Argument information

2
0x8461
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

2
0x8463
A
Class name of the Bean to be called back
--

2
0x8465
A
Class name of the Bean to be called back
--

2
0x8467
A
Class name of the Bean to be called back
--

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-28.

(2) For cancel

(a) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-44 Details of the trace collection points in Timer Service (for cancel)

Event ID | No. in the figure# | Trace collection points | Level
0x8468 | 1 | When the processing of javax.ejb.Timer.cancel() starts | A
0x8469 | 2 | When the processing of javax.ejb.Timer.cancel() ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-29.

The following figure shows the trace collection points of Timer Service for cancel.

Figure 8-29 Trace collection points of Timer Service (for cancel)

(b) Trace information that can be collected

The following table describes the trace information that can be collected in Timer Service for cancel.

Table 8-45 Trace information that can be collected in Timer Service (for cancel)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8468
A
Class name of the Bean to be called back
--
--

2
0x8469
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-29.

(3) In the case of a callback

(a) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-46 Details of the trace collection points in Timer Service (for a callback)

Event ID | No. in the figure# | Trace collection points | Level
0x846C | 1 | When the thread starts the callback processing | B
0x846A | 2 | When the callback of the timeout callback method of the Enterprise Bean starts | A
0x846B | 3 | When the callback of the timeout callback method of the Enterprise Bean ends | A
0x846D | 4 | When the thread terminates the callback processing | B

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-30.

The following figure shows the trace collection points of Timer Service for a callback.

Figure 8-30 Trace collection points of Timer Service (for a callback)

(b) Trace information that can be collected

The following table describes the trace information that can be collected in Timer Service for a callback.

The information collected during callback of the timeout method is output to the root application information. Furthermore, 0 is output to the client application information.

Table 8-47 Trace information that can be collected in Timer Service (for a callback)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x846C
B
Class name of the Bean to be called back
--
--

2
0x846A
A
Class name of the Bean to be called back
--
--

3
0x846B
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

4
0x846D
B
Class name of the Bean to be called back
--

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-30.

(4) In the case of createSingleActionTimer

(a) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-48 Details of the trace collections points in Timer Service (for createSingleActionTimer)

Event ID | No. in the figure# | trace collection point | Level
0x84A0 | 1 | When the processing of TimerService.createSingleActionTimer(long duration, TimerConfig timerConfig) starts | A
0x84A1 | 2 | When the processing of TimerService.createSingleActionTimer(long duration, TimerConfig timerConfig) ends | A
0x84A2 | 1 | When the processing of TimerService.createSingleActionTimer(Date expiration, TimerConfig timerConfig) starts | A
0x84A3 | 2 | When the processing of TimerService.createSingleActionTimer(Date expiration, TimerConfig timerConfig) ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-31.

The following figure shows the trace collection points in createSingleActionTimer.

Figure 8-31 Trace collection points of Timer Service (for createSingleActionTimer)

(b) trace information that can be collected

The following table describes the trace information that can be collected in createSingleActionTimer.

Table 8-49 Trace information that can be collected in Timer Service (for createSingleActionTimer)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x84A0
A
Class name of the Bean to be called back
--
Argument information

2
0x84A1
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

1
0x84A2
A
Class name of the Bean to be called back
--
Argument information

2
0x84A3
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-31.

(5) In the case of createIntervalTimer

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-50 Details of the trace collections points in Timer Service (for createIntervalTimer)

Event ID | No. in the figure# | Trace collection points | Level
0x84A4 | 1 | When the processing of TimerService.createIntervalTimer(long initialDuration, long intervalDuration, TimerConfig timerConfig) starts | A
0x84A5 | 2 | When the processing of TimerService.createIntervalTimer(long initialDuration, long intervalDuration, TimerConfig timerConfig) ends | A
0x84A6 | 1 | When the processing of TimerService.createIntervalTimer(Date initialExpiration, long intervalDuration, TimerConfig timerConfig) starts | A
0x84A7 | 2 | When the processing of TimerService.createIntervalTimer(Date initialExpiration, long intervalDuration, TimerConfig timerConfig) ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-32.

The following figure shows the trace collection points of createIntervalTimer.

Figure 8-32 Trace collection points of Timer Service (for createIntervalTimer)

(b) Trace information that can be collected

The following table describes the trace information that can be collected in createIntervalTimer.

Table 8-51 Trace information that can be collected in Timer Service (for createIntervalTimer)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x84A4
A
Class name of the Bean to be called back
--
Argument information

2
0x84A5
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

1
0x84A6
A
Class name of the Bean to be called back
--
Argument information

2
0x84A7
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-32.

(6) In the case of createCalendarTimer

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-52 Details of the trace collections points in Timer Service (for createCalendarTimer)

Event ID | No. in the figure# | Trace collection points | Level
0x84A8 | 1 | When the processing of TimerService.createCalendarTimer(ScheduleExpression schedule) starts | A
0x84A9 | 2 | When the processing of TimerService.createCalendarTimer(ScheduleExpression schedule) ends | A
0x84AA | 1 | When the processing of TimerService.createCalendarTimer(ScheduleExpression schedule, TimerConfig config) starts | A
0x84AB | 2 | When the processing of TimerService.createCalendarTimer(ScheduleExpression schedule, TimerConfig config) ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-33.

The following figure shows the trace collection points of createCalendarTimer.

Figure 8-33 Trace collection points of Timer Service (for createCalendarTimer)

(b) trace information that can be collected

The following table describes the trace information that can be collected in createCalendarTimer.

Table 8-53 Trace information that can be collected in Timer Service (for createCalendarTimer)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x84A8
A
Class name of the Bean to be called back
--
Argument information

2
0x84A9
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

1
0x84AA
A
Class name of the Bean to be called back
--
Argument information

2
0x84AB
A
Class name of the Bean to be called back
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-33.

8.11.5 When the Session Bean is invoked asynchronously

This subsection describes the trace collection points when the Session Bean is invoked asynchronously, and the trace information that can be collected.

In an asynchronous invocation, the output order of the event IDs output by the same thread is guaranteed, but the output order of the event IDs output by different threads is not guaranteed. Therefore, the following events might occur:

The output order of the event IDs might differ from the order described in this subsection.

The event IDs of asynchronous invocation might be output between the event IDs of other functionality.

Organization of this subsection

(1) When a Session Bean is invoked asynchronously from the local client

(2) When the Session Bean is invoked asynchronously from the remote client

(3) When get is invoked from the local client

(4) When get is invoked from the remote client

(5) When isDone is invoked from the local client

(6) When isDone is invoked from the remote client

(7) When isCancelled is invoked from the local client

(8) When isCancelled is invoked from the remote client

(9) When cancel is invoked from the local client

(10) When cancel is invoked from the remote client

(1) When a Session Bean is invoked asynchronously from the local client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-54 Details of the trace collection points when the Session Bean is invoked asynchronously from the local client

Event ID | No. in the figure# | Trace collection points | Level
0x8472 | 1 | Immediately after the EJB container receives a request (for a local invocation) | A
0x8473 | 2 | Immediately before the EJB container sends a response (for a local invocation) | A
0x84C0 | 3 | Immediately before the EJB container calls back the asynchronous business method of EJB | A
0x84D6 | 4 | Immediately before the EJB container starts the asynchronous business method of EJB (for a local invocation) | A
0x8409 | 5 | Immediately before the EJB container calls back the EJB business method | B
0x840A | 6 | Immediately after returning from a callback of the EJB business method | B
0x84D7 | 7 | Immediately after the asynchronous business method of EJB is terminated (for a local invocation) | A
0x84C1 | 8 | Immediately after returning from a callback of the asynchronous business method of EJB | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-34.

The following figure shows the trace collection points when the Session Bean is invoked asynchronously from the local client.

Figure 8-34 Trace collection points when the Session Bean is invoked asynchronously from the local client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when the Session Bean is invoked asynchronously from the local client.

Table 8-55 Trace information that can be collected when the Session Bean is invoked asynchronously from the local client

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Option

1
0x8472
A
Bean name
Method name, number of arguments
--

2
0x8473
A
Bean name
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

3
0x84C0
A
Class name of the Bean to be called back
Method name, number of arguments
Root application information at the source of an asynchronous method invocation

4
0x84D6
A
Class name of the Bean to be called back
Method name, number of arguments
--

5
0x8409
B
Bean name
Method name, number of arguments
--

6
0x840A
B
Bean name
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

7
0x84D7
A
Class name of the Bean to be called back
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

8
0x84C1
A
Class name of the Bean to be called back
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-34.

(2) When the Session Bean is invoked asynchronously from the remote client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-56 Details of the trace collection points when the Session Bean is invoked asynchronously from the remote client

Event ID | No. in the figure# | Trace collection points | Level
0x8470 | 1 | Immediately after the EJB container receives a request (for a remote invocation) | A
0x8471 | 2 | Immediately before the EJB container sends a response (for a remote invocation) | A
0x84C0 | 3 | Immediately before the EJB container calls back the asynchronous business method of EJB | A
0x84D8 | 4 | Immediately before the EJB container starts the asynchronous business method of EJB (for a remote invocation) | A
0x8409 | 5 | Immediately before the EJB container calls back the EJB business method | B
0x840A | 6 | Immediately after returning from a callback of the EJB business method | B
0x84D9 | 7 | Immediately after the asynchronous business method of EJB is terminated (for a remote invocation) | A
0x84C1 | 8 | Immediately after returning from a callback of the asynchronous business method of EJB | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-35.

The following figure shows the trace collection points when the Session Bean is invoked asynchronously from the remote client.

Figure 8-35 Trace collection points when the Session Bean is invoked asynchronously from the remote client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when the Session Bean is invoked asynchronously from the remote client.

Table 8-57 Trace information that can be collected when the Session Bean is invoked asynchronously from the remote client

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Option

1
0x8470
A
Bean name
Method name, number of arguments
--

2
0x8471
A
Bean name
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

3
0x84C0
A
Class name of the Bean to be called back
Method name, number of arguments
Root application information at the source of an asynchronous method invocation

4
0x84D8
A
Class name of the Bean to be called back
Method name, number of arguments
--

5
0x8409
B
Bean name
Method name, number of arguments
--

6
0x840A
B
Bean name
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

7
0x84D9
A
Class name of the Bean to be called back
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

8
0x84C1
A
Class name of the Bean to be called back
Method name, number of arguments

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-35.

(3) When get is invoked from the local client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-58 Details of the trace collection points when get is invoked from the local client

Event ID | No. in the figure# | Trace collection points | Level
0x84C2 | 1 | When the processing of Future.get() starts (for a local invocation) | B
0x84C3 | 2 | When the processing of Future.get() ends (for a local invocation) | B
0x84C4 | 1 | When the processing of Future.get(long timeout, TimeUnit unit) starts (for a local invocation) | B
0x84C5 | 2 | When the processing of Future.get(long timeout, TimeUnit unit) ends (for a local invocation) | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-36.

The following figure shows the trace collection points when get is invoked from the local client.

Figure 8-36 Trace collection points when get is invoked from the local client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when get is invoked from the local client.

Table 8-59 Trace information that can be collected when get is invoked from the local client

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Option

1
0x84C2
B
--
--
--

2
0x84C3
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

1
0x84C4
B
--
--
Method name, argument information

2
0x84C5
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-36.

(4) When get is invoked from the remote client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-60 Details of the trace collection points when get is invoked from the remote client

Event ID | No. in the figure# | Trace collection points | Level
0x84C6 | 1 | When the processing of Future.get() starts (for a remote invocation) | B
0x84C2 | 2 | When the processing of Future.get() starts (for a local invocation) | B
0x84C3 | 3 | When the processing of Future.get() ends (for a local invocation) | B
0x84C7 | 4 | When the processing of Future.get() ends (for a remote invocation) | B
0x84C8 | 1 | When the processing of Future.get(long timeout, TimeUnit unit) starts (for a remote invocation) | B
0x84C4 | 2 | When the processing of Future.get(long timeout, TimeUnit unit) starts (for a local invocation) | B
0x84C5 | 3 | When the processing of Future.get(long timeout, TimeUnit unit) ends (for a local invocation) | B
0x84C9 | 4 | When the processing of Future.get(long timeout, TimeUnit unit) ends (for a remote invocation) | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-37.

The following figure shows the trace collection points when get is invoked from the remote client.

Figure 8-37 Trace collection points when get is invoked from the remote client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when get is invoked from the remote client.

Table 8-61 Trace information that can be collected when get is invoked from the remote client

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x84C6
B
--
--
--

2
0x84C2
B
--
--
--

3
0x84C3
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

4
0x84C7
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

1
0x84C8
B
--
--
Method name, argument information

2
0x84C4
B
--
--
Method name, argument information

3
0x84C5
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

4
0x84C9
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-timeexception-name

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-37.

(5) When isDone is invoked from the local client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-62 Details of the trace collection points when isDone is invoked from the local client

Event ID | No. in the figure# | Trace collection points | Level
0x84CA | 1 | When the processing of Future.isDone() starts (for a local invocation) | B
0x84CB | 2 | When the processing of Future.isDone() ends (for a local invocation) | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-38.

The following figure shows the trace collection points when isDone is invoked from the local client.

Figure 8-38 Trace collection points when isDone is invoked from the local client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when isDone is invoked from the local client.

Table 8-63 Trace information that can be collected when isDone is invoked from the local client

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Option
1 | 0x84CA | B | -- | -- | --
2 | 0x84CB | B | -- | -- | Return value of isDone()

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-38.

Note

No exceptions are thrown in the execution of this method. Therefore, the logs showing abnormal status are not generated.

(6) When isDone is invoked from the remote client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-64 Details of the trace collection points when isDone is invoked from the remote client

Event ID | No. in the figure# | Trace collection points | Level
0x84CE | 1 | When the processing of Future.isDone() starts (for a remote invocation) | B
0x84CA | 2 | When the processing of Future.isDone() starts (for a local invocation) | B
0x84CB | 3 | When the processing of Future.isDone() ends (for a local invocation) | B
0x84CF | 4 | When the processing of Future.isDone() ends (for a remote invocation) | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-39.

The following figure shows the trace collection points when isDone is invoked from the remote client.

Figure 8-39 Trace collection points when isDone is invoked from the remote client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when isDone is invoked from the remote client.

Table 8-65 Trace information that can be collected when isDone is invoked from the remote client

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Option

1
0x84CE
B
--
--
--

2
0x84CA
B
--
--
--

3
0x84CB
B
--
--
Return value of isDone()

4
0x84CF
B
--
--

When normal:
Entrance-time

For an exception:
exception-name

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-39.

(7) When isCancelled is invoked from the local client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-66 Details of the trace collection points when isCancelled is invoked from the local client

Event ID | No. in the figure# | Trace collection points | Level
0x84CC | 1 | When the processing of Future.isCancelled() starts (for a local invocation) | B
0x84CD | 2 | When the processing of Future.isCancelled() ends (for a local invocation) | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-40.

The following figure shows the trace collection points when isCancelled is invoked from the local client.

Figure 8-40 Trace collection points when isCancelled is invoked from the local client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when isCancelled is invoked from the local client.

Table 8-67 Trace information that can be collected when isCancelled is invoked from the local client

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Option
1 | 0x84CC | B | -- | -- | --
2 | 0x84CD | B | -- | -- | Return value of isCancelled()

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-40.

Note

No exceptions are thrown in the execution of this method. Therefore, the logs showing abnormal status are not generated.

(8) When isCancelled is invoked from the remote client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-68 Details of the trace collection points when isCancelled is invoked from the remote client

Event ID | No. in the figure# | Trace collection points | Level
0x84D0 | 1 | When the processing of Future.isCancelled() starts (for a remote invocation) | B
0x84CC | 2 | When the processing of Future.isCancelled() starts (for a local invocation) | B
0x84CD | 3 | When the processing of Future.isCancelled() ends (for a local invocation) | B
0x84D1 | 4 | When the processing of Future.isCancelled() ends (for a remote invocation) | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-41.

The following figure shows the trace collection points when isCancelled is invoked from the remote client.

Figure 8-41 Trace collection points when isCancelled is invoked from the remote client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when isCancelled is invoked from the remote client.

Table 8-69 Trace information that can be collected when isCancelled is invoked from the remote client

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Option

1
0x84D0
B
--
--
--

2
0x84CC
B
--
--
--

3
0x84CD
B
--
--
Return value of isCancelled()

4
0x84D1
B
--
--

When normal:
Return value of isCancelled()

For an exception:
exception-name

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-41.

(9) When cancel is invoked from the local client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-70 Details of the trace collection points when cancel is invoked from the local client

Event ID | No. in the figure# | Trace collection points | Level
0x84D2 | 1 | When the processing of Future.cancel() starts (for a local invocation) | A
0x84D3 | 2 | When the processing of Future.cancel() ends (for a local invocation) | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-42.

The following figure shows the trace collection points when cancel is invoked from the local client.

Figure 8-42 Trace collection points when cancel is invoked from the local client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when cancel is invoked from the local client.

Table 8-71 Trace information that can be collected when cancel is invoked from the local client

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Option
1 | 0x84D2 | A | -- | -- | Method name, argument information
2 | 0x84D3 | A | -- | -- | Return value of cancel()

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-42.

Note

No exceptions are thrown in the execution of this method. Therefore, the logs showing abnormal status are not generated.

(10) When cancel is invoked from the remote client

(a) Trace collection points and PRF trace

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-72 Details of the trace collection points when cancel is invoked from the remote client

Event ID | No. in the figure# | Trace collection points | Level
0x84D4 | 1 | When the processing of Future.cancel() starts (for a remote invocation) | A
0x84D2 | 2 | When the processing of Future.cancel() starts (for a local invocation) | A
0x84D3 | 3 | When the processing of Future.cancel() ends (for a local invocation) | A
0x84D5 | 4 | When the processing of Future.cancel() ends (for a remote invocation) | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-43.

The following figure shows the trace collection points when cancel is invoked from the remote client.

Figure 8-43 Trace collection points when cancel is invoked from the remote client

(b) Trace information that can be collected

The following table describes the trace information that can be collected when cancel is invoked from the remote client.

Table 8-73 Trace information that can be collected when cancel is invoked from the remote client

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Option

1
0x84D4
A
--
--
Method name, argument information

2
0x84D2
A
--
--
Method name, argument information

3
0x84D3
A
--
--
Return value of cancel()

4
0x84D5
A
--
--

When normal:
Return value of cancel()

For an exception:
exception-name

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-43.

8.11.6 When method cancellation occurs

This subsection describes the trace collection points when method cancellation occurs, and also describes the trace information that can be collected.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-74 Details of the trace collection points when method cancellation occurs

Event ID | No. in the figure# | Trace collection points | Level
0x8490 | 1 | When the method cancellation processing starts | A
0x8C41 | 2 | When an SQL statement is output to check errors | A
0x8491 | 3 | When the method cancellation processing is completed | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-44.

The following figure shows the trace collection points when method cancellation occurs.

Figure 8-44 Trace collection points when method cancellation occurs

(2) Trace information that can be collected

The following table describes the trace information that can be collected when method cancellation occurs.

Table 8-75 Trace information that can be collected when method cancellation occurs

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x8490 | A | Root application information of the application for which method cancellation is to be executed | -- | --
2 | 0x8C41 | A | Root application information of the connection for which a transaction timeout, forced termination of the J2EE application, or method cancellation was executed | -- | SQL statement
3 | 0x8491 | A | -- | -- | Entrance-time

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-44.

8.12 Trace collection points of a JNDI

This section describes the trace collection points of a JNDI, and the trace information that can be collected.

Organization of this section

8.12.1 Trace Get Point and the PRF Trace Get Level

8.12.2 Trace information that can be collected

8.12.1 Trace Get Point and the PRF Trace Get Level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-76 Details of trace collection points in a JNDI

Event ID | No. in the figure# | Trace acquisition points | Level
0x8603 | 1 | When searching the name space in JNDI, or the CORBA Naming Service | javax.naming.Context.lookup | Immediately after invocation | A
0x8604 | 2 | Immediately before return | A
0x8605 | 1 | javax.naming.Context.list | Immediately after invocation | B
0x8606 | 2 | Immediately before return | B
0x8607 | 1 | javax.naming.Context.listBindings | Immediately after invocation | B
0x8608 | 2 | Immediately before return | B
0x8609 | 1 | When searching the name space in which javax.ejb.EJBLocalHome is saved | javax.naming.Context.lookup | Immediately after invocation | A
0x860A | 2 | Immediately before return | A
0x860B | 1 | javax.naming.Context.list | Immediately after invocation | B
0x860C | 2 | Immediately before return | B
0x860D | 1 | javax.naming.Context.listBindings | Immediately after invocation | B
0x860E | 2 | Immediately before return | B
0x860F | 1 | When searching the java: name space | javax.naming.Context.lookup | Immediately after invocation | A
0x8610 | 2 | Immediately before return | A
0x8611 | 1 | javax.naming.Context.list | Immediately after invocation | B
0x8612 | 2 | Immediately before return | B
0x8613 | 1 | javax.naming.Context.listBindings | Immediately after invocation | B
0x8614 | 2 | Immediately before return | B
0x8615 | 1 | When using the round-robin search functionality | javax.naming.Context.lookup | Immediately after invocation | A
0x8616 | 2 | Immediately before return | A
0x8617 | 1 | When using the CORBA Naming Service switch functionality | javax.naming.Context.lookup | Immediately after invocation | A
0x8618 | 2 | Immediately before return | A
0x8619 | 1 | javax.naming.Context.list | Immediately after invocation | B
0x861A | 2 | Immediately before return | B
0x861B | 1 | javax.naming.Context.listBindings | Immediately after invocation | B
0x861C | 2 | Immediately before return | B

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-45.

The following figure shows the trace collection points in a JNDI.

Figure 8-45 Trace collection points of a JNDI

8.12.2 Trace information that can be collected

The following table describes the trace information that can be collected in a JNDI.

Table 8-77 Trace information that can be collected in a JNDI

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8603
A
--
Specified name
--

0x8609
A

0x860F
A

0x8615
A

0x8617
A

0x8605
B

0x860B
B

0x8611
B

0x8619
B

0x8607
B

0x860D
B

0x8613
B

0x861B
B

2
0x8604
A
--
Specified name

When normal:
Entrance-time

For an exception:
Entrance-time: exception name: message

0x860A
A

0x8610
A

0x8616
A

0x8618
A

0x8606
B

0x860C
B

0x8612
B

0x861A
B

0x8608
B

0x860E
B

0x8614
B

0x861C
B

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-45.

Reference note

In the trace information of a JNDI, 0 is displayed in the root application information and client application information that constitutes the key information, in the following cases:
- When the lookup method is invoked from the client
- When the server is either starting or stopping

0x8609 and 0x860A are output twice when you are using business interface.

8.13 Trace collection points of a JTA

This section describes the trace collection points of the JTA and the trace information that can be collected.

Organization of this section

8.13.1 When a CMT and TransactionManager are used

8.13.2 When UserTransaction is used

8.13.3 In the case of a transaction timeout

8.13.4 When using the asynchronous concurrent processing for threads

8.13.1 When a CMT and TransactionManager are used

This subsection describes the trace collection points when a CMT and javax.transaction.TransactionManager are used, and also the trace information that can be collected.

Organization of this subsection

(1) Trace collection points and the PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and the PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-78 Details of trace collection points when a CMT and TransactionManager are used

Event ID | No. in the figure# | Trace acquisition points | Level
0x8811 | 1 | Immediately before the transaction starts | A
0x8812 | 2 | Immediately after the transaction starts | A
0x8815 | 3 | Immediately before the transaction is committed | A
0x8816 | 4 | Immediately after the transaction is committed | A
0x8817 | 3 | Immediately before the transaction rolls back | A
0x8818 | 4 | Immediately after the transaction rolls back | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-46 and Figure 8-47.

The following figure shows the trace collection points when a CMT is used.

Figure 8-46 Trace collection points when a CMT is used

The following figure shows the trace collection points when TransactionManager is used.

Figure 8-47 Trace collection points when TransactionManager is used

(2) Trace information that can be collected

The following table describes the trace information that can be collected when a CMT and TransactionManager are used.

Table 8-79 Trace information that can be collected when a CMT and TransactionManager are used

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8811
A
--
--
--

2
0x8812
A
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8815
A
--
--
--

0x8817
A
--
--
--

4
0x8816
A
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

0x8818
A
--
--

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-46 and Figure 8-47.

8.13.2 When UserTransaction is used

This subsection describes the trace collection points when UserTransaction is used, and also the trace information that can be collected.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-80 Details of trace collection points when UserTransaction is used

Event ID | No. in the figure# | Trace acquisition points | Level
0x8813 | 1 | Immediately before the transaction starts | A
0x8814 | 2 | Immediately after the transaction starts | A
0x8815 | 3 | Immediately before the transaction is committed | A
0x8816 | 4 | Immediately after the transaction is committed | A
0x8817 | 3 | Immediately before the transaction rolls back | A
0x8818 | 4 | Immediately after the transaction rolls back | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-48.

The following figure shows the trace collection points when UserTransaction is used.

Figure 8-48 Trace collection points when UserTransaction is used

(2) Trace information that can be collected

The following table describes the trace information that can be collected when UserTransaction is used.

Table 8-81 Trace information that can be collected when UserTransaction is used

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8813
A
--
--
--

2
0x8814
A
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8815
A
--
--
--

0x8817
A
--
--
--

4
0x8816
A
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

0x8818
A
--
--

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-48.

8.13.3 In the case of a transaction timeout

This subsection describes the trace collection points in the case of a transaction timeout, and also describes the trace information that can be collected.

Organization of this subsection

(1) Trace get point and the PRF trace get level

(2) Trace information that can be collected

(1) Trace get point and the PRF trace get level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-82 Details of trace collection points in the case of a transaction timeout

Event ID | No. in the figure# | Trace acquisition points | Level
0x8819 | 1 | Immediately before the transaction timeout processing | A
0x8C41 | 2 | SQL output for failure checking | A
0x8820 | 3 | Immediately after the transaction timeout processing | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-49.

The following figure shows the trace collection points in the case of a transaction timeout.

Figure 8-49 Trace collection points in the case of a transaction timeout

(2) Trace information that can be collected

The following table describes the trace information that can be collected in the case of a transaction timeout.

Table 8-83 Trace information that can be collected in the case of a transaction timeout

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x8819 | A | Root application information of the transaction that has timed out | -- | --
2 | 0x8C41 | A | Root application information of the connection for which a transaction timeout, forced termination of the J2EE application, or method cancellation was executed | -- | SQL statement
3 | 0x8820 | A | -- | -- | Entrance time

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-49.

8.13.4 When using the asynchronous concurrent processing for threads

This subsection describes the trace collection points and the trace information that can be acquired, when you use the asynchronous concurrent processing for threads.

Organization of this subsection

(1) Trace collection points of TimerManager

(2) Trace collection points of WorkManager

(1) Trace collection points of TimerManager

Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels:

Table 8-84 Details of the trace collection points of TimerManager

Event ID | Number in the figure# | Trace collection point | Level
0x8435 | 1 | Immediately before TimerManager starts | A
0x8436 | 2 | Just after TimerManager starts | A
0x8439 | 5 | Immediately before TimerManager stops | A
0x843A | 6 | Just after TimerManager stops | A
0x843D | 3 | Immediately before executing the listener for TimerManager | A
0x843E | 4 | Just after executing the listener for TimerManager | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-50.

The following figure shows the trace collection points of TimerManager.

Figure 8-50 Trace collection points of TimerManager

Trace information that can be collected

The following table describes the trace information that can be collected for TimerManager.

Table 8-85 Trace information that can be collected for TimerManager

Number in the figure#1
Event ID
Level
Information that can be collected

Interface name
Operation name
Option

1
0x8435
A
N
N
N

2
0x8436
A
N
N

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x843D
A
Method name#2
Unique number for each schedule
N

4
0x843E
A
Method name#2
Unique number for each schedule

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

5
0x8439
A
N
N
N

6
0x843A
A
N
N

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

Legend:

A: Standard

N: Not applicable

#1

Corresponds to the numbers in Figure 8-50.

#2

TimerManager.timerExpired, StopTimerListener.timerStop, or CancelTimerListener.timerCancel is output.

(2) Trace collection points of WorkManager

Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-86 Details of the trace collection points of WorkManager

Event ID | Number in the figure# | Trace collection point | Level
0x8437 | 1 | Immediately before WorkManager starts | A
0x8438 | 2 | Just after WorkManager starts | A
0x8440 | 4 | Just after executing the listener or task processing for WorkManager | A
0x843B | 5 | Immediately before WorkManager stops | A
0x843C | 6 | Just after WorkManager stops | A
0x843F | 3 | Immediately before executing the listener or task processing for WorkManager | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-51.

The following figure shows the trace collection points of WorkManager.

Figure 8-51 Trace collection points of WorkManager

Trace information that can be collected

The following table describes the trace information that can be collected for WorkManager.

Table 8-87 Trace information that can be collected for WorkManager

Number in the figure#1
Event ID
Level
Information that can be collected

Interface name
Operation name
Option

1
0x8437
A
--
--
--

2
0x8438
A
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x843F
A
Method name#2
Unique number for each schedule
--

4
0x8440
A
Method name#2
Unique number for each schedule

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

5
0x843B
A
--
--
--

6
0x843C
A
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-51.

#2

Work.run, WorkListener.workAccepted, WorkListener.workRejected, WorkListener.workStarted, or WorkListener.workCompleted is output.

8.14 Trace collection points of a DB Connector and JCA container

This section describes the trace collection points of a DB Connector and JCA container, and also the trace information that can be collected.

Of the trace collection points related to a connection, some can be collected only when a local transaction is used. This section separately describes the trace collection points that can be collected irrespective of the transaction support level, and the trace collection points that can be collected only when a local transaction is used. Here, the trace collection points that can be collected irrespective of the transaction support level are called connection-related trace collection points.

Organization of this section

8.14.1 Connection-related trace collection points and trace information that can be collected

8.14.2 Trace collection points and trace information that can be collected when a local transaction is used

8.14.3 Trace collection points and trace information that can be collected when a connection association is used

8.14.4 Trace collection points and trace information that can be collected when the automatic connection close functionality is used

8.14.5 Trace collection points and trace information that can be collected in the case of linkage with the DB Connector for Cosminexus RM

8.14.6 Trace collection points and trace information that can be collected when work management is used

8.14.1 Connection-related trace collection points and trace information that can be collected

This subsection describes the connection-related trace collection points and trace information that can be collected.

Organization of this subsection

(1) Trace get point and the PRF trace get level

(2) Trace information that can be collected

(1) Trace get point and the PRF trace get level

The following four tables describe the event IDs, trace collection points, and PRF trace collection levels with reference to each event ID:

In the case of 0x8B00, 0x8B01, 0x8B80-0x8B83, 0x8C00-0x8C03, 0x8C10-0xC13, 0x8C20-0x8C29, 0x8C2A-0x8C3F (when connection-related processing is executed)
Reference: Table 8-88

In the case of 0x8C80-0x8C93 (when a method of the java.sql.Statement interface is executed)
Reference: Table 8-89

In the case of 0x8CC0-0x8CD9 (when a method of the java.sql.PreparedStatement interface is executed)
Reference: Table 8-90

In the case of 0x8D00-0x8D19 (when a method of the java.sql.CallableStatement interface is executed)
Reference: Table 8-91

Hint

For details about the event ID 0x8C41, see the sections 8.11 Trace collection points of an EJB container and 8.13 Trace collection points of a JTA.

Table 8-88 Details of trace collection points in a DB Connector and JCA container (when connection-related processing is executed) 1

Event ID | No. in the figure# | Trace acquisition points | Level
0x8B00 | 2 | Immediately after invoking the connection acquisition request from the resource adapter | B
0x8B01 | 5 | Immediately before the return of the connection acquisition request from the resource adapter | B
0x8B80 | 3 | Immediately before the invocation of physical connection creation | B
0x8B81 | 4 | Immediately after the return of physical connection creation | B
0x8B82 | 14 | Immediately before the invocation of physical connection discard | B
0x8B83 | 15 | Immediately after the return of physical connection discard | B
0x8C00 | 1 | When a database connection is established with javax.sql.DataSource.getConnection() | When the processing starts | A
0x8C01 | 6 | When the processing ends | A
0x8C02 | 1 | When a database connection is established with javax.sql.DataSource.getConnection(String username, String password) | When the processing starts | A
0x8C03 | 6 | When the processing ends | A
0x8C10 | 1 | When a database connection is established with javax.sql.DataSource.getConnection() during the use of the connection pool clustering functionality | When the processing starts | A
0x8C11 | 6 | When the processing ends | A
0x8C12 | 1 | When a database connection is established with javax.sql.DataSource.getConnection(String username, String password) during the use of the connection pool clustering functionality | When the processing starts | A
0x8C13 | 6 | When the processing ends | A
0x8C20 | 13 | When the database and JDBC resources of the Connection object are released with java.sql.Connection.close() | When the processing starts | A
0x8C21 | 16 | When the processing ends | A
0x8C22 | 11 | java.sql.Connection.commit() | When the processing starts | B
0x8C23 | 12 | When the processing ends | B
0x8C24 | 11 | java.sql.Connection.rollback() | When the processing starts | B
0x8C25 | 12 | When the processing ends | B
0x8C26 | 11 | java.sql.Connection.rollback(Savepoint savepoint) | When the processing starts | B
0x8C27 | 12 | When the processing ends | B
0x8C28 | 7 | java.sql.Connection.createStatement() | When the processing starts | B
0x8C29 | 8 | When the processing ends | B
0x8C2A | 7 | java.sql.Connection.createStatement(int resultSetType, int resultSetConcurrency) | When the processing starts | B
0x8C2B | 8 | When the processing ends | B
0x8C2C | 7 | java.sql.Connection.createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) | When the processing starts | B
0x8C2D | 8 | When the processing ends | B
0x8C2E | 7 | java.sql.Connection.prepareCall(String sql) | When the processing starts | B
0x8C2F | 8 | When the processing ends | B
0x8C30 | 7 | java.sql.Connection.prepareCall(String sql, int resultSetType, int resultSetConcurrency) | When the processing starts | B
0x8C31 | 8 | When the processing ends | B
0x8C32 | 7 | java.sql.Connection.prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) | When the processing starts | B
0x8C33 | 8 | When the processing ends | B
0x8C34 | 7 | java.sql.Connection.prepareStatement(String sql) | When the processing starts | B
0x8C35 | 8 | When the processing ends | B
0x8C36 | 7 | java.sql.Connection.prepareStatement(String sql, int autoGeneratedKeys) | When the processing starts | B
0x8C37 | 8 | When the processing ends | B
0x8C38 | 7 | java.sql.Connection.prepareStatement(String sql, int[] columnIndexes) | When the processing starts | B
0x8C39 | 8 | When the processing ends | B
0x8C3A | 7 | java.sql.Connection.prepareStatement(String sql, int resultSetType, int resultSetConcurrency) | When the processing starts | B
0x8C3B | 8 | When the processing ends | B
0x8C3C | 7 | java.sql.Connection.prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) | When the processing starts | B
0x8C3D | 8 | When the processing ends | B
0x8C3E | 7 | java.sql.Connection.prepareStatement(String sql, String[] columnNames) | When the processing starts | B
0x8C3F | 8 | When the processing ends | B

Legend:

A: Standard

B: Advanced

Note: Event ID of DB Connector is not output, if you are using SQL Server 2005.

#

Corresponds to the numbers in Figure 8-52.

Table 8-89 Details of trace collection points in a DB Connector and JCA container (when a method of the java.sql.Statement interface is executed) 2

Event ID | No. in the figure# | Trace acquisition points | Level
0x8C80 | 9 | execute(String sql) | When the processing starts | B
0x8C81 | 10 | When the processing ends | B
0x8C82 | 9 | execute(String sql, int autoGeneratedKeys) | When the processing starts | B
0x8C83 | 10 | When the processing ends | B
0x8C84 | 9 | execute(String sql, int[] columnIndexes) | When the processing starts | B
0x8C85 | 10 | When the processing ends | B
0x8C86 | 9 | execute(String sql, String[] columnNames) | When the processing starts | B
0x8C87 | 10 | When the processing ends | B
0x8C88 | 9 | executeBatch() | When the processing starts | B
0x8C89 | 10 | When the processing ends | B
0x8C8A | 9 | executeQuery(String sql) | When the processing starts | B
0x8C8B | 10 | When the processing ends | B
0x8C8C | 9 | executeUpdate(String sql) | When the processing starts | B
0x8C8D | 10 | When the processing ends | B
0x8C8E | 9 | executeUpdate(String sql, int autoGeneratedKeys) | When the processing starts | B
0x8C8F | 10 | When the processing ends | B
0x8C90 | 9 | executeUpdate(String sql, int[] columnIndexes) | When the processing starts | B
0x8C91 | 10 | When the processing ends | B
0x8C92 | 9 | executeUpdate(String sql, String[] columnNames) | When the processing starts | B
0x8C93 | 10 | When the processing ends | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-52.

Table 8-90 Details of trace collection points in a DB Connector and JCA container (when a method of the java.sql.PreparedStatement interface is executed) 3

Event ID | No. in the figure# | Trace acquisition points | Level
0x8CC0 | 9 | execute() | When the processing starts | B
0x8CC1 | 10 | When the processing ends | B
0x8CC2 | 9 | execute(String sql) | When the processing starts | B
0x8CC3 | 10 | When the processing ends | B
0x8CC4 | 9 | execute(String sql, int autoGeneratedKeys) | When the processing starts | B
0x8CC5 | 10 | When the processing ends | B
0x8CC6 | 9 | execute(String sql, int[] columnIndexes) | When the processing starts | B
0x8CC7 | 10 | When the processing ends | B
0x8CC8 | 9 | execute(String sql, String[] columnNames) | When the processing starts | B
0x8CC9 | 10 | When the processing ends | B
0x8CCA | 9 | executeBatch() | When the processing starts | B
0x8CCB | 10 | When the processing ends | B
0x8CCC | 9 | executeQuery() | When the processing starts | B
0x8CCD | 10 | When the processing ends | B
0x8CCE | 9 | executeQuery(String sql) | When the processing starts | B
0x8CCF | 10 | When the processing ends | B
0x8CD0 | 9 | executeUpdate() | When the processing starts | B
0x8CD1 | 10 | When the processing ends | B
0x8CD2 | 9 | executeUpdate(String sql) | When the processing starts | B
0x8CD3 | 10 | When the processing ends | B
0x8CD4 | 9 | executeUpdate(String sql, int autoGeneratedKeys) | When the processing starts | B
0x8CD5 | 10 | When the processing ends | B
0x8CD6 | 9 | executeUpdate(String sql, int[] columnIndexes) | When the processing starts | B
0x8CD7 | 10 | When the processing ends | B
0x8CD8 | 9 | executeUpdate(String sql, String[] columnNames) | When the processing starts | B
0x8CD9 | 10 | When the processing ends | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-52.

Table 8-91 Details of trace collection points in a DB Connector and JCA container (when a method of the java.sql.CallableStatement interface is executed) 4

Event ID | No. in the figure# | Trace acquisition points | Level
0x8D00 | 9 | execute() | When the processing starts | B
0x8D01 | 10 | When the processing ends | B
0x8D02 | 9 | execute(String sql) | When the processing starts | B
0x8D03 | 10 | When the processing ends | B
0x8D04 | 9 | execute(String sql, int autoGeneratedKeys) | When the processing starts | B
0x8D05 | 10 | When the processing ends | B
0x8D06 | 9 | execute(String sql, int[] columnIndexes) | When the processing starts | B
0x8D07 | 10 | When the processing ends | B
0x8D08 | 9 | execute(String sql, String[] columnNames) | When the processing starts | B
0x8D09 | 10 | When the processing ends | B
0x8D0A | 9 | executeBatch() | When the processing starts | B
0x8D0B | 10 | When the processing ends | B
0x8D0C | 9 | executeQuery() | When the processing starts | B
0x8D0D | 10 | When the processing ends | B
0x8D0E | 9 | executeQuery(String sql) | When the processing starts | B
0x8D0F | 10 | When the processing ends | B
0x8D10 | 9 | executeUpdate() | When the processing starts | B
0x8D11 | 10 | When the processing ends | B
0x8D12 | 9 | executeUpdate(String sql) | When the processing starts | B
0x8D13 | 10 | When the processing ends | B
0x8D14 | 9 | executeUpdate(String sql, int autoGeneratedKeys) | When the processing starts | B
0x8D15 | 10 | When the processing ends | B
0x8D16 | 9 | executeUpdate(String sql, int[] columnIndexes) | When the processing starts | B
0x8D17 | 10 | When the processing ends | B
0x8D18 | 9 | executeUpdate(String sql, String[] columnNames) | When the processing starts | B
0x8D19 | 10 | When the processing ends | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-52.

The following figure shows the trace collection points in a DB Connector and JCA container.

Figure 8-52 Trace collection points in a DB Connector and JCA container (connection-related)

(2) Trace information that can be collected

The trace information that can be collected in a DB Connector or JCA container is described below. The details are explained in correlation to the numbers of Figure 8-52.

Trace information corresponding to numbers 1-6 and 11-16
The following table describes the event IDs and trace information corresponding to numbers 1-6 and 11-16.

Table 8-92 Trace information that can be collected in a DB Connector and JCA container (when connection-related processing is executed)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8C00
A
--
--
--

0x8C02
A
--
--
--

0x8C10
A
--
--
--

0x8C12
A
--
--
--

2
0x8B00
B
--
--
--

3
0x8B80
B
--
--
--

4
0x8B81
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

5
0x8B01
B
--
--

6
0x8C01
A
Connection ID
--

0x8C03
A
Connection ID
--

0x8C11
A
Connection ID
--

0x8C13
A
Connection ID
--

11
0x8C22
B
--
--
--

0x8C24
B
--
--
--

0x8C26
B
--
--
--

12
0x8C23
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

0x8C25
B
--
--

0x8C27
B
--
--

13
0x8C20
A
Connection ID
--
--

14
0x8B82
B
--
--
--

15
0x8B83
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

16
0x8C21
A
--
--

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-52.

Trace information corresponding to number 7
The event IDs corresponding to number 7 are as follows:
0x8C28, 0x8C2A, 0x8C2C, 0x8C2E, 0x8C30, 0x8C32, 0x8C34,
0x8C36, 0x8C38, 0x8C3A, 0x8C3C, 0x8C3E
The trace information that can be collected at these event IDs is as follows:

PRF trace collection level
All Advanced.

Interface name and operation name
Not output at these event IDs.

Optional
If an sql exists in the method argument, the SQL statement is displayed:

Trace information corresponding to number 8
The event IDs corresponding to number 8 are as follows:
0x8C29, 0x8C2B, 0x8C2D, 0x8C2F, 0x8C31, 0x8C33, 0x8C35,
0x8C37, 0x8C39, 0x8C3B, 0x8C3D, 0x8C3F
The trace information that can be collected at these event IDs is as follows:

PRF trace collection level
All Advanced.

Interface name and operation name
Not output at these event IDs.

Optional
At these event IDs, the entrance time is displayed when the processing is performed normally. When an exception occurs, the entrance time and exception are displayed.

Trace information corresponding to number 9
The event IDs corresponding to number 9 are as follows:
0x8C80, 0x8C82, 0x8C84, 0x8C86, 0x8C88, 0x8C8A, 0x8C8C, 0x8C8E, 0x8C90, 0x8C92, 0x8CC0, 0x8CC2, 0x8CC4, 0x8CC6, 0x8CC8, 0x8CCA, 0x8CCC, 0x8CCE, 0x8CD0, 0x8CD2, 0x8CD4, 0x8CD6, 0x8CD8, 0x8D00, 0x8D02, 0x8D04, 0x8D06, 0x8D08, 0x8D0A, 0x8D0C, 0x8D0E, 0x8D10, 0x8D12, 0x8D14, 0x8D16, 0x8D18
The trace information that can be collected at these event IDs is as follows:

PRF trace collection level
All Advanced.

Interface name and operation name
Not output at these event IDs.

Optional
If an sql exists in the method argument, the SQL statement is displayed:

Trace information corresponding to number 10
The event IDs corresponding to number 10 are as follows:
0x8C81, 0x8C83, 0x8C85, 0x8C87, 0x8C89, 0x8C8B, 0x8C8D, 0x8C8F, 0x8C91, 0x8C93, 0x8CC1, 0x8CC3, 0x8CC5, 0x8CC7, 0x8CC9, 0x8CCB, 0x8CCD, 0x8CCF, 0x8CD1, 0x8CD3, 0x8CD5, 0x8CD7, 0x8CD9, 0x8D01, 0x8D03, 0x8D05, 0x8D07, 0x8D09, 0x8D0B, 0x8D0D, 0x8D0F, 0x8D11, 0x8D13, 0x8D15, 0x8D17, 0x8D19
The trace information that can be collected at these event IDs is as follows:

PRF trace collection level
All Advanced.

Interface name and operation name
Not output at these event IDs.

Optional
At these event IDs, the entrance time is displayed when the processing is performed normally. When an exception occurs, the entrance time and exception are displayed.

8.14.2 Trace collection points and trace information that can be collected when a local transaction is used

This subsection describes the trace collection points and the trace information that can be collected when a local transaction is used.

Organization of this subsection

(1) Trace get point and the PRF trace get level

(2) Trace information that can be collected

(1) Trace get point and the PRF trace get level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-93 Details of trace collection points in a DB Connector and JCA container (when the processing of a local transaction is executed)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8C60 | 1 | When a local transaction starts | When the processing starts | B
0x8C61 | 2 | When the processing ends | B
0x8C62 | 3 | When the local transaction is committed | When the processing starts | B
0x8C63 | 4 | When the processing ends | B
0x8C64 | 3 | When the local transaction rolls back | When the processing starts | B
0x8C65 | 4 | When the processing ends | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-53.

The following figure shows the trace collection points.

Figure 8-53 Details of trace collection points in a DB Connector and JCA container (local transaction-related)

(2) Trace information that can be collected

The following table describes the trace information that can be collected.

Table 8-94 Details of trace collection points in a DB Connector and JCA container (when the processing of a local transaction is executed)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8C60
B
--
--
--

2
0x8C61
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8C62
B
--
--
--

0x8C64
B
--
--
--

4
0x8C63
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

0x8C65
B
--
--

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-53.

8.14.3 Trace collection points and trace information that can be collected when a connection association is used

This subsection describes the trace collection points and the trace information that can be collected when a connection association is used.

Organization of this subsection

(1) Trace get point and the PRF trace get level

(2) Trace information that can be collected

(1) Trace get point and the PRF trace get level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-95 Details of trace collection points in a DB Connector and JCA container (when the processing of a connection association is executed)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8C40 | 1 | When a logical connection is replaced with a physical connection with the connection association functionality | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-54.

The following figure shows the trace collection points.

Figure 8-54 Details of trace collection points in a DB Connector and JCA container (connection association-related)

(2) Trace information that can be collected

The following table describes the trace information that can be collected.

Table 8-96 Details of trace collection points in a DB Connector and JCA container (when the connection association processing is executed)

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x8C40 | A | Connection ID (connection ID of the physical connection that replaces another connection with the connection association functionality) | -- | --

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-54.

8.14.4 Trace collection points and trace information that can be collected when the automatic connection close functionality is used

This subsection describes the trace collection points and the trace information that can be collected when the connection closes automatically.

Organization of this subsection

(1) Trace get point and the PRF trace get level

(2) Trace information that can be collected

(1) Trace get point and the PRF trace get level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-97 Details of trace collection points in a DB Connector and JCA container (when the connection closes automatically)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8B84 | 1 | Immediately after the invocation of the close processing by the automatic connection close functionality | B
0x8B82 | 2 | Immediately before the invocation of physical connection discard | B
0x8B83 | 3 | Immediately after the return of physical connection discard | B
0x8B85 | 4 | Immediately before the return of the close processing by the automatic connection close functionality | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-55.

The following figure shows the trace collection points.

Figure 8-55 Details of trace collection points in a DB Connector and JCA container (when the connection closes automatically)

(2) Trace information that can be collected

The following table describes the trace information that can be collected.

Table 8-98 Details of trace collection points in a DB Connector and JCA container (when the connection closes automatically)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8B84
B
Connection ID
--
--

2
0x8B82
B
--
--
--

3
0x8B83
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

4
0x8B85
B
--
--
Entrance time

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-55.

8.14.5 Trace collection points and trace information that can be collected in the case of linkage with the DB Connector for Cosminexus RM

This subsection describes the trace collection points and the trace information that can be collected in the case of linkage with the DB Connector for Cosminexus RM.

In the case of the DB Connector for Cosminexus RM, a connection is established to the database by using the DB Connector. Therefore, when the DB Connector for Cosminexus RM is used, the trace points of the DB Connector are also collected. The items generated during the JDBC connection (such as java.sql.Statement) have the same trace collection points as the DB Connector.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-99 Details of trace collection points in a DB Connector and JCA container (during linkage with the DB Connector for Cosminexus RM)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8D60 | 1 | When a database connection is established with javax.sql.DataSource.getConnection() during the use of the DB Connector for Cosminexus RM | When the processing starts | A
0x8D61 | 2 | When the processing ends | A
0x8D62 | 1 | When a database connection is established with javax.sql.DataSource.getConnection(String username, String password) during the use of the DB Connector for Cosminexus RM | When the processing starts | A
0x8D63 | 2 | When the processing ends | A
0x8D80 | 5 | When the database and JDBC resources of the Connection object are released with java.sql.Connection.close() during the use of the DB Connector for Cosminexus RM | When the processing starts | A
0x8D81 | 6 | When the processing ends | A
0x8D82 | 3 | Connection.createStatement() during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D83 | 4 | When the processing ends | B
0x8D84 | 3 | Connection.createStatement(int resultSetType, int resultSetConcurrency) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D85 | 4 | When the processing ends | B
0x8D86 | 3 | Connection.createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D87 | 4 | When the processing ends | B
0x8D88 | 3 | Connection.prepareCall(String sql) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D89 | 4 | When the processing ends | B
0x8D8A | 3 | (String sql, int resultSetType, int resultSetConcurrency) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D8B | 4 | When the processing ends | B
0x8D8C | 3 | Connection.prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D8D | 4 | When the processing ends | B
0x8D8E | 3 | Connection.prepareStatement(String sql) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D8F | 4 | When the processing ends | B
0x8D90 | 3 | Connection.prepareStatement(String sql, int autoGeneratedKeys) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D91 | 4 | When the processing ends | B
0x8D92 | 3 | Connection.prepareStatement(String sql, int[] columnIndexes) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D93 | 4 | When the processing ends | B
0x8D94 | 3 | Connection.prepareStatement(String sql, int resultSetType, int resultSetConcurrency) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D95 | 4 | When the processing ends | B
0x8D96 | 3 | Connection.prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D97 | 4 | When the processing ends | B
0x8D98 | 3 | Connection.prepareStatement(String sql, String[] columnNames) during the use of the DB Connector for Cosminexus RM | When the processing starts | B
0x8D99 | 4 | When the processing ends | B

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-56.

The following figure shows the trace collection points.

Figure 8-56 Details of trace collection points in a DB Connector and JCA container (during linkage with the DB Connector for Cosminexus RM)

(2) Trace information that can be collected

The following table describes the trace information that can be collected.

Table 8-100 Details of trace collection points in a DB Connector and JCA container (during linkage with the DB Connector for Cosminexus RM)

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8D60
A
--
--
--

2
0x8D61
A
Connection ID
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

1
0x8D62
A
--
--
--

2
0x8D63
A
Connection ID
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

5
0x8D80
A
Connection ID
--
--

6
0x8D81
A
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D82
B
--
--
--

4
0x8D83
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D84
B
--
--
--

4
0x8D85
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D86
B
--
--
--

4
0x8D87
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D88
B
--
--
SQL statement

4
0x8D89
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D8A
B
--
--
SQL statement

4
0x8D8B
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D8C
B
--
--
SQL statement

4
0x8D8D
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D8E
B
--
--
SQL statement

4
0x8D8F
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D90
B
--
--
SQL statement

4
0x8D91
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D92
B
--
--
SQL statement

4
0x8D93
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D94
B
--
--
SQL statement

4
0x8D95
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D96
B
--
--
SQL statement

4
0x8D97
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

3
0x8D98
B
--
--
SQL statement

4
0x8D99
B
--
--

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-56.

8.14.6 Trace collection points and trace information that can be collected when work management is used

This subsection describes the trace collection points and the trace information that can be collected when work management is used in a resource adapter conforming to Connector1.5.

Note that if you are using a resource adapter other than the product resource adapter, new numbers will be allotted to the root AP information when 0x8B86 is output. If the <resourceadapter>-<resourceadapter-class> value of DD (ra.xml) starts with "com.hitachi" or "com.cosminexus", the resource adapter will be considered as a product resource adapter.

The root AP information set at the entrance of MDB container is treated as the root AP information of Work, if you invoke Message-driven Bean from Work. Individual Message-driven Bean processing is distinguished by the thread ID.

Organization of this subsection

(1) Trace get point and the PRF trace get level

(2) Trace information that can be collected

(1) Trace get point and the PRF trace get level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-101 Details of trace collection points in a DB Connector and JCA container (when work management is used)

Event ID | No. in the figure# | Trace acquisition points | Level
0x8B86 | 1 | Immediately after invoking a method of javax.resource.spi.work.WorkManager | A
0x8B87 | 6, 9, 14 | Immediately before the return of the method of javax.resource.spi.work.WorkManager | A
0x8B88 | 2, 4, 7, 12 | Immediately before invoking a method of javax.resource.spi.work.WorkListener | B
0x8B89 | 3, 5, 8, 13 | Immediately after the return of the method of javax.resource.spi.work.WorkListener | B
0x8B8A | 10 | Immediately before invoking a method of javax.resource.spi.work.Work | A
0x8B8B | 11 | Immediately after the return of the method of javax.resource.spi.work.Work | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-57 through Figure 8-59.

The following figure shows the trace collection points.

Figure 8-57 Details of trace collection points in a DB Connector and JCA container (when scheduleWork() is invoked)

Figure 8-58 Details of trace collection points in a DB Connector and JCA container (when startWork() is invoked)

Figure 8-59 Details of trace collection points in a DB Connector and JCA container (when doWork() is invoked)

(2) Trace information that can be collected

The following table describes the trace information that can be collected.

Table 8-102 Details of trace collection points in a DB Connector and JCA container (when work management is used)

No. in the figure
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x8B86
A
Work class name
Method Name
Display name of the resource adapter

2
0x8B88
B
Work class name
Method Name
Display name of the resource adapter#1

3
0x8B89
B
Work class name
Method Name

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

4
0x8B88
B
Work class name
Method Name
Display name of the resource adapter#2

5
0x8B89
B
Work class name
Method Name

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

6
0x8B87
A
Work class name
Method Name

7
0x8B88
B
Work class name
Method Name
Display name of the resource adapter#1

8
0x8B89
B
Work class name
Method Name

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

9
0x8B87
A
Work class name
Method Name

10
0x8B8A
A
Work class name
Method Name
Display name of the resource adapter#1

11
0x8B8B
A
Work class name
Method Name

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

12
0x8B88
B
Work class name
Method Name
Display name of the resource adapter#1

13
0x8B89
B
Work class name
Method Name

When normal:
Entrance-time

For an exception:
Entrance-time exception-name

14
0x8B87
A
Work class name
Method Name

Legend:

A: Standard

B: Advanced

#1

Corresponds to the numbers from Figure 8-57 to Figure 8-59.

#2

In the case of a resource adapter included in the application, 'Application name: display name of resource adapter' is displayed.

8.15 Trace collection points of an RMI

This section describes the trace collection points of an RMI, and the trace information that can be collected.

Organization of this section

8.15.1 Trace get point and the PRF trace get level

8.15.2 Trace information that can be collected

8.15.1 Trace get point and the PRF trace get level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-103 Details of trace collection points in an RMI

Event ID | No. in the figure# | Trace acquisition points | Level
0x8E01 | 1 | When the process for sending a request with the stub starts | A
0x8E02 | 6 | When the process for receiving a response with the stub is complete | A
0x8E03 | 2 | During the processing for sending the request at the client side | A
0x8E04 | 5 | During the processing for receiving the response at the client side | A
0x8E05 | 3 | During the processing for receiving the request at the server side | A
0x8E06 | 4 | During the processing for sending the response at the server side | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-60.

The following figure shows the trace collection points in an RMI.

Figure 8-60 Trace collection points of an RMI

8.15.2 Trace information that can be collected

The following table describes the trace information that can be collected in an RMI.

Table 8-104 Trace information that can be collected in an RMI

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x8E01 | A | Interface name | Operation name | --
2 | 0x8E03 | A | -- | -- | --
3 | 0x8E05 | A | -- | -- | --
4 | 0x8E06 | A | -- | -- | --
5 | 0x8E04 | A | -- | -- | --
6 | 0x8E02 | A | Interface name#2 | Operation name#2 | --#2

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-60.

#2

When an exception occurs, the interface name and operation name are not displayed. Furthermore, the exception that has occurred is displayed in the option.

8.16 Trace collection points of an OTS

This section describes the trace collection points of an OTS, and also the trace information that can be collected.

Organization of this section

8.16.1 Trace Get Point and the PRF Trace Get Level

8.16.2 Trace information that can be collected

8.16.1 Trace Get Point and the PRF Trace Get Level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-105 Details of trace collection points in an OTS

Event ID | No. in the figure# | Trace acquisition points | Level
0x9400 | 1 | Immediately after a transaction is generated | A
0x9401 | 2 | Immediately after the transaction status transits to MarkedRollback | A
0x9402 | 3 | Immediately after the transaction status transits to Rollingback | A
0x9403 | 12 | Immediately after the transaction concludes | A
0x9404 | 4 | Immediately before the conclusion processing to javax.transaction.xa.XAResource | B
0x9405 | 5 | Immediately after the conclusion processing to javax.transaction.xa.XAResource | B
0x9406 | 6 | Immediately before the conclusion processing to a subordinate transaction | B
0x9407 | 9 | Immediately after the conclusion processing to a subordinate transaction | B
0x9408 | 7 | Immediately after receiving a request for conclusion processing from a superior transaction | B
0x9409 | 8 | Immediately before replying to the request for conclusion processing from the superior transaction | B
0x9410 | 13 | Immediately before acquiring the javax.transaction.xa.XAResource object | B
0x9411 | 14 | Immediately after acquiring the javax.transaction.xa.XAResource object | B
0x9412 | 10 | Immediately before writing into or reading from the status file | B
0x9413 | 11 | Immediately after writing into or reading from the status file | B

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers from Figure 8-61 to Figure 8-66.

The following figure shows the trace collection points in an OTS.

Figure 8-61 Trace collection points from the generation of a transaction until its conclusion

Figure 8-62 Trace collection points related to reading or writing into the status file during the in-process OTS initialization

Figure 8-63 Trace collection points during the recovery process of javax.transaction.xa.Xid

Figure 8-64 Trace collection points in a typical one-phase commit model

Figure 8-65 Trace collection points in a typical two-phase commit model

Figure 8-66 PRF acquisition information during transaction linkage with OpenTP1

8.16.2 Trace information that can be collected

The following table describes the trace information that can be collected in an OTS. Note that when more than one instance of information is described for a single item as different points, it implies that any one of those is output.

Table 8-106 Trace information that can be collected in an OTS

No. in the figure#1
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0x9400
A
global transaction

| created
Generated upon receiving an instruction for starting a transaction.

| recreated
Generated upon receiving an instruction from another node for participating in a transaction processing.

| recovered
Recovered from the status file.

| recovered(orphan)
Xid was recovered from javax.transaction.xa.XAResource, but because no corresponding transaction existed, a new transaction was generated.

[[Global-transaction-ID]]

2
0x9401
A
global transaction
| marked rollback(reason-for-transition#2)
[[Global-transaction-ID]]

3
0x9402
A
global transaction
| rolling back(reason-for-transition#3)
[[Global-transaction-ID]]

12
0x9403
A
global transaction

| committed
Committed.

| rolled back
Rolled back.

| heuristic commit
Committed forcibly.

| heuristic rollback
Rolled back forcibly.

| heuristic mixed
Committed and rolled back partially.

| heuristic hazard
Not clear if committed or rolled back.

| unknown
Unknown if committed or rolled back.

| invalid status
Concluded with a status other than those described above.

[[Global-transaction-ID]]

4
0x9404
B

XAResource-identifier

None

]] prepare
prepare is issued.

]] commit(second phase)
Second-phase commit is issued.

]] commit(one phase)
First-phase commit is issued.

]] rollback
rollback is issued.

]] forget
forget is issued.

]] recover
recover is issued.

[[Global-transaction-ID]]

None

5
0x9405
B

XAResource-identifier

None

In the case of normal return

[[ prepare

[[ commit(second phase)

[[ commit(one phase)

[[ rollback

[[ forget

[[ recover

In the case of abnormal return (when an unexpected value is returned, or when an exception occurs)

[[!prepare

[[!commit(second phase)

[[!commit(one phase)

[[!rollback

[[!forget

[[!recover

[[Global-transaction-ID]]:[[result]]#4

None

6
0x9406
B
resource

]] prepare
prepare is issued.

]] commit(second phase)
Second-phase commit is issued.

]] commit(one phase)
First-phase commit is issued.

]] rollback
rollback is issued.

]] forget
forget is issued.

[[Global-transaction-ID]]

9
0x9407
B
resource

In the case of normal return

[[ prepare

[[ commit(second phase)

[[ commit(one phase)

[[ rollback

[[ forget

In the case of abnormal return (when an unexpected value is returned, or when an exception occurs)

[[!prepare

[[!commit(second phase)

[[!commit(one phase)

[[!rollback

[[!forget

[[Global-transaction-ID]]

[[Global-transaction-ID]]:[[result]]#5

7
0x9408
B
subordinate transaction

]] prepare
A prepare instruction is received.

]] commit(second phase)
A second-phase commit instruction is received.

]] commit(one phase)
A first-phase commit instruction is received.

]] rollback
A rollback instruction is received.

]] forget
A forget instruction is received.

[[Global-transaction-ID]]

8
0x9409
B
subordinate transaction

In the case of normal return

[[ prepare

[[ commit(second phase)

[[ commit(one phase)

[[ rollback

[[ forget

In the case of abnormal return (when an unexpected value is returned, or when an exception occurs)

[[!prepare

[[!commit(second phase)

[[!commit(one phase)

[[!rollback

[[!forget

[[Global-transaction-ID]]

[[Global-transaction-ID]]:[[result]]#6

13
0x9410
B

None

XAResource-identifier

]] get xaresource

None

[[Global-transaction-ID]]

14
0x9411
B

None

XAResource-identifier

In the case of normal return

[[ get xaresource

In the case of abnormal return (when an unexpected value is returned, or when an exception occurs)

[[!get xaresource

None

[[result]]#7

[[Global-transaction-ID]]

[[Global-transaction-ID]]:[[result]]#7

10
0x9412
B

Status-file-name

Status-file-name:entry-number#8

]] write(contents-to-be-written#9)

]] read(contents-to-be-read#10)

None

[[Global-transaction-ID]]

11
0x9413
B

Status-file-name

Status-file-name:entry-number#8

In the case of normal return

[[ write

[[ read

In the case of abnormal return (when an unexpected value is returned, or when an exception occurs)

[[!write

[[!read

None

[[result]]#11

[[Global-transaction-ID]]

[[Global-transaction-ID]]:[[result]]#11

Legend:

A: Standard

B: Advanced

#1

Corresponds to the numbers from Figure 8-61 to Figure 8-66.

#2

Any one of the following is output as the reason for transition:

operation
The instruction is received from outside the in-process OTS.

server call
An attempt to send a call to a server in another node has failed.

superior
An instruction for participating in the transaction processing was received from another node, but that transaction was already in the MarkedRollback status.

sync before
The callback processing to a JTA for which the conclusion processing is in progress has failed.

#3

Any one of the following is output as the reason for transition:

operation
The instruction is received from outside the in-process OTS.

timeout
The global transaction has timed out.

superior
The instruction is received from a superior transaction or the cjrollbacktrn command.

forgotten
It is determined that the transaction that outputs the conclusion instruction to the subordinate transaction, or javax.transaction.xa.XAResource does not exist.

end
An attempt to execute end for javax.transaction.xa.XAResource has failed.

prepare
An attempt to execute prepare for javax.transaction.xa.XAResource has failed.

write prepared
An attempt to write prepared in the status file has failed.

write committing
An attempt to write committing in the status file has failed.

#4

Any of the following is output as the result in the case of prepare, commit, rollback, or forget

Return value

Error code of the XAException

toString() of the exception (an exception other than the XAException)

Any of the following is output as the result in the case of recover:

Number of recovered Xids

Null (when the Xid array itself is null)

Error code of the XAException

toString() of the exception (an exception other than the XAException)

#5

Any of the following is output as the result in the case of prepare:

Returned value

toString() of the exception

In cases other than prepare, toString() of the exception is output as the result.

#6

Any of the following is output as the result in the case of prepare:

Value to be returned

toString() of the exception

In cases other than prepare, toString() of the exception is output as the result.

#7

Any of the following is output as the result:

toString() of the exception

Null (when the return value is null)

#8

This is the internal information.

#9

Any of the following are output as the contents to be written:

management info
Status file management information

status file body
Status file body

prepared
Prepared status

committing
Commit determined status

heuristic commit
Forced commit status

heuristic rollback
Forced rollback status

heuristic mixed
Partially committed and rolled back status

heuristic hazard
Unclear committed or rolled status

forgotten
Transaction conclusion complete status

#10

Any of the following are output as the contents to be read:

management info
Status file management information

status file body
Status file body

#11

Any of the following is output as the result:

Writing size (unit: bytes)

Reading size (unit: bytes)

toString() of the exception

8.17 Trace collection points of standard output, standard error output, and user log

This subsection describes the trace collection points of the standard output, standard error output, and user log, and also describes the trace information that can be collected.

Organization of this section

8.17.1 Trace collection points of standard output or standard error output

8.17.2 Trace collection points of the user log

8.17.1 Trace collection points of standard output or standard error output

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-107 Details of trace collection points in the case of standard output or standard error output

Event ID | No. in the figure# | Trace acquisition points | Level
0x9C00 | 1 | When the output to standard output or standard error output starts | B
0x9C01 | 2 | When the output to standard output or standard error output is complete | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-67.

The following figure shows the trace collection points in the case of standard output or standard error output.

Figure 8-67 Trace collection points of standard output or standard error output

(2) Trace information that can be collected

The following table describes the trace information that can be collected in the case of standard output or standard error output.

Table 8-108 Trace information that can be collected in the case of standard output or standard error output

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x9C00 | B | Stream name (out or err) | -- | --
2 | 0x9C01 | B | Stream name (out or err) | -- | --

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-67.

8.17.2 Trace collection points of the user log

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-109 Details of trace collection points of the user log

Event ID | No. in the figure# | Trace acquisition points | Level
0x9C02 | 1 | When message output using the user log starts | B
0x9C03 | 2 | When message output using the user log is complete | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-68.

The following figure shows the trace collection points of the user log.

Figure 8-68 Trace collection points of the user log

(2) Trace information that can be collected

The following table describes the trace information that can be collected in the user log.

Table 8-110 Trace information that can be collected in the user log

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x9C02 | B | Application distinguished name | Message ID | --
2 | 0x9C03 | B | Application distinguished name | Message ID | --

Legend:

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-68.

8.18 Trace collection points of a DI

This section describes the trace collection points of a DI, and the trace information that can be collected.

Organization of this section

8.18.1 Trace Get Point and the PRF Trace Get Level

8.18.2 Trace information that can be collected

8.18.1 Trace Get Point and the PRF Trace Get Level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-111 Details of trace collection points in a DI

Event ID | No. in the figure# | Trace acquisition points | Level
0x9D00 | 1 | Immediately before injecting the dependency | A
0x9D01 | 2 | Immediately after injecting the dependency | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-69.

The following figure shows the trace collection points in a DI.

Figure 8-69 Trace collection points of a DI

8.18.2 Trace information that can be collected

The following table describes the trace information that can be collected in a DI.

Table 8-112 Trace information that can be collected in a DI

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x9D00 | A | Target name of the destination where dependency is to be injected | Reference name to be injected | --
2 | 0x9D01 | A | Target name of the destination where dependency is injected | Injected reference name | #2

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-69.

#2

When the processing is performed normally, the entrance time is displayed.

When an exception occurs, the entrance time and exception are displayed.

8.19 Trace collection points of the batch application execution functionality

This section describes the trace collection points of the batch application execution functionality, and the trace information that can be collected.

Organization of this section

8.19.1 Trace Get Point and the PRF Trace Get Level

8.19.2 Trace information that can be collected

8.19.1 Trace Get Point and the PRF Trace Get Level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-113 Details of trace collection points in the batch application execution functionality

Event ID | Number in the figure#1 | Trace acquisition point | Level
0x8E05 | 1#2 | Just after receiving the batch application execution request | A
0xA100 | 2 | Immediately before the execution of the batch application | A
0xA101 | 3 | Immediately after the termination of the batch application | A
0x8E06 | 4#2 | Immediately before sending the termination results of the batch application | A

Legend:

A: Standard

#1

Corresponds to the numbers in Figure 8-70.

#2

The trace is only collected when the scheduling function is used.

The following figure shows the trace collection points in the batch application execution functionality.

Figure 8-70 Trace collection points in the batch application execution functionality

8.19.2 Trace information that can be collected

The following table describes the trace information that can be collected in the batch application execution functionality.

Table 8-114 Trace information that can be collected in the batch application execution functionality

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0x8E05 | A | N | N | N
2 | 0xA100 | A | Class name of the batch application (including the package name) | -- | --
3 | 0xA101 | A | Class name of the batch application (including the package name) | -- | #2
4 | 0x8E06 | A | N | N | N

Legend:

A: Standard

N: Not applicable

#1

Corresponds to the numbers in Figure 8-70.

#2

When the processing is performed normally, the entrance time is displayed.

When an exception occurs, the entrance time and exception are displayed.

8.20 Trace collection points in a JPA

This section describes the trace collection points of a JPA, and the trace information that can be collected.

Organization of this section

8.20.1 Trace collection points and trace information that can be collected when the persistent context of application management is used

8.20.2 Trace collection points and trace information that can be collected when the persistent context of container management is used

8.20.1 Trace collection points and trace information that can be collected when the persistent context of application management is used

This subsection describes the trace collection points and the trace information that can be collected when the persistent context of application management is used.

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-115 Details of trace collection points when the persistent context of application management is used

Event ID | No. in the figure# | Trace acquisition points | Level
0xA500 | 1 | When the processing of EntityManagerFactory#createEntityManagerFactory() starts | A
0xA501 | 2 | When the processing of EntityManagerFactory#createEntityManagerFactory() ends | A
0xA502 | 1 | When the processing of EntityManagerFactory#createEntityManagerFactory(Map map) starts | A
0xA503 | 2 | When the processing of EntityManagerFactory#createEntityManagerFactory(Map map) ends | A
0xA504 | 1 | When the processing of EntityManagerFactory#isOpen() starts | A
0xA505 | 2 | When the processing of EntityManagerFactory#isOpen() ends | A
0xA506 | 1 | When the processing of EntityManagerFactory#close() starts | A
0xA507 | 2 | When the processing of EntityManagerFactory#close() ends | A
0xA508 | 1 | When the processing of EntityManager#find(Class<T> entityClass, Object primaryKey) starts | A
0xA509 | 2 | When the processing of EntityManager#find(Class<T> entityClass, Object primaryKey) ends | A
0xA50A | 1 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) starts | A
0xA50B | 2 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) ends | A
0xA50C | 1 | When the processing of EntityManager#contains(Object entity) starts | A
0xA50D | 2 | When the processing of EntityManager#contains(Object entity) ends | A
0xA50E | 1 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) starts | A
0xA50F | 2 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) ends | A
0xA510 | 1 | When the processing of EntityManager#merge(T entity) starts | A
0xA511 | 2 | When the processing of EntityManager#merge(T entity) ends | A
0xA512 | 1 | When the processing of EntityManager#persist(Object entity) starts | A
0xA513 | 2 | When the processing of EntityManager#persist(Object entity) ends | A
0xA514 | 1 | When the processing of EntityManager#refresh(Object entity) starts | A
0xA515 | 2 | When the processing of EntityManager#refresh(Object entity) ends | A
0xA516 | 1 | When the processing of EntityManager#remove(Object entity) starts | A
0xA517 | 2 | When the processing of EntityManager#remove(Object entity) ends | A
0xA518 | 1 | When the processing of EntityManager#clear() starts | A
0xA519 | 2 | When the processing of EntityManager#clear() ends | A
0xA51A | 1 | When the processing of EntityManager#flush() starts | A
0xA51B | 2 | When the processing of EntityManager#flush() ends | A
0xA51C | 1 | When the processing of EntityManager#createQuery(String qlString) starts | A
0xA51D | 2 | When the processing of EntityManager#createQuery(String qlString) ends | A
0xA51E | 1 | When the processing of EntityManager#createNamedQuery(String name) starts | A
0xA51F | 2 | When the processing of EntityManager#createNamedQuery(String name) ends | A
0xA520 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString) starts | A
0xA521 | 2 | When the processing of EntityManager#createNativeQuery(String sqlString) ends | A
0xA522 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) starts | A
0xA523 | 2 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) ends | A
0xA524 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) starts | A
0xA525 | 2 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) ends | A
0xA526 | 1 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) starts | A
0xA527 | 2 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) ends | A
0xA528 | 1 | When the processing of EntityManager#getFlushMode() starts | A
0xA529 | 2 | When the processing of EntityManager#getFlushMode() ends | A
0xA52A | 1 | When the processing of EntityManager#joinTransaction() starts | A
0xA52B | 2 | When the processing of EntityManager#joinTransaction() ends | A
0xA52C | 1 | When the processing of EntityManager#getTransaction() starts | A
0xA52D | 2 | When the processing of EntityManager#getTransaction() ends | A
0xA52E | 1 | When the processing of EntityManager#getDelegate() starts | A
0xA52F | 2 | When the processing of EntityManager#getDelegate() ends | A
0xA530 | 1 | When the processing of EntityManager#isOpen() starts | A
0xA531 | 2 | When the processing of EntityManager#isOpen() ends | A
0xA532 | 1 | When the processing of EntityManager#close() starts | A
0xA533 | 2 | When the processing of EntityManager#close() ends | A
0xA534 | 1 | When the processing of EntityTransaction#begin() starts | A
0xA535 | 2 | When the processing of EntityTransaction#begin() ends | A
0xA536 | 1 | When the processing of EntityTransaction#commit() starts | A
0xA537 | 2 | When the processing of EntityTransaction#commit() ends | A
0xA538 | 1 | When the processing of EntityTransaction#rollback() starts | A
0xA539 | 2 | When the processing of EntityTransaction#rollback() ends | A
0xA53A | 1 | When the processing of EntityTransaction#getRollbackOnly() starts | A
0xA53B | 2 | When the processing of EntityTransaction#getRollbackOnly() ends | A
0xA53C | 1 | When the processing of EntityTransaction#setRollbackOnly() starts | A
0xA53D | 2 | When the processing of EntityTransaction#setRollbackOnly() ends | A
0xA53E | 1 | When the processing of EntityTransaction#isActive() starts | A
0xA53F | 2 | When the processing of EntityTransaction#isActive() ends | A
0xA540 | 1 | When the processing of Query#executeUpdate() starts | A
0xA541 | 2 | When the processing of Query#executeUpdate() ends | A
0xA542 | 1 | When the processing of Query#getResultList() starts | A
0xA543 | 2 | When the processing of Query#getResultList() ends | A
0xA544 | 1 | When the processing of Query#getSingleResult() starts | A
0xA545 | 2 | When the processing of Query#getSingleResult() ends | A
0xA546 | 1 | When the processing of Query#setFlushMode(FlushModeType flushMode) starts | A
0xA547 | 2 | When the processing of Query#setFlushMode(FlushModeType flushMode) ends | A
0xA548 | 1 | When the processing of Query#setFirstResult(int startPosition) starts | B
0xA549 | 2 | When the processing of Query#setFirstResult(int startPosition) ends | B
0xA54A | 1 | When the processing of Query#setMaxResults(int maxResult) starts | B
0xA54B | 2 | When the processing of Query#setMaxResults(int maxResult) ends | B
0xA54C | 1 | When the processing of Query#setHint(String hintName, Object value) starts | B
0xA54D | 2 | When the processing of Query#setHint(String hintName, Object value) ends | B
0xA54E | 1 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) starts | B
0xA54F | 2 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) ends | B
0xA550 | 1 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) starts | B
0xA551 | 2 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) ends | B
0xA552 | 1 | When the processing of Query#setParameter(int position, Object value) starts | B
0xA553 | 2 | When the processing of Query#setParameter(int position, Object value) ends | B
0xA554 | 1 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) starts | B
0xA555 | 2 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) ends | B
0xA556 | 1 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) starts | B
0xA557 | 2 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) ends | B
0xA558 | 1 | When the processing of Query#setParameter(String name, Object value) starts | B
0xA559 | 2 | When the processing of Query#setParameter(String name, Object value) ends | B

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-71.

The following figure shows the trace collection points.

Figure 8-71 Trace collection points when the persistent context of application management is used

(2) Trace information that can be collected

The following table describes the trace information that can be collected when the persistent context of application management is used.

Table 8-116 Trace information that can be collected when the persistent context of application management is used

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0xA500
A
--
--
--

0xA502
A
--
--
--

0xA504
A
--
--
--

0xA506
A
--
--
--

0xA508
A
entity class name
--
--

0xA50A
A
entity class name
--
--

0xA50C
A
entity class name
--
--

0xA50E
A
entity class name
lockMode value
--

0xA510
A
entity class name
--
--

0xA512
A
entity class name
--
--

0xA514
A
entity class name
--
--

0xA516
A
entity class name
--
--

0xA518
A
--
--
--

0xA51A
A
--
--
--

0xA51C
A
--
--
--

0xA51E
A
name
--
--

0xA520
A
--
--
--

0xA522
A
resultClass class name
--
--

0xA524
A
resultSetMapping
--
--

0xA526
A
flushMode value
--
--

0xA528
A
--
--
--

0xA52A
A
--
--
--

0xA52C
A
--
--
--

0xA52E
A
--
--
--

0xA530
A
--
--
--

0xA532
A
--
--
--

0xA534
A
--
--
--

0xA536
A
--
--
--

0xA538
A
--
--
--

0xA53A
A
--
--
--

0xA53C
A
--
--
--

0xA53E
A
--
--
--

0xA540
A
--
--
--

0xA542
A
--
--
--

0xA544
A
--
--
--

0xA546
A
flushMode value
--
--

0xA548
B
startPosition value
--
--

0xA54A
B
maxResult value
--
--

0xA54C
B
hintName
value class name
--

0xA54E
B
position value
--
--

0xA550
B
position value
--
--

0xA552
B
position value
--
--

0xA554
B
name value
--
--

0xA556
B
name value
--
--

0xA558
B
name value
--
--

2
0xA501
A
--
--
When normal:
Entrance-time
For an exception:
Entrance-time exception-name

0xA503
A
--
--

0xA505
A
--
--

0xA507
A
--
--

0xA509
A
--
--

0xA50B
A
--
--

0xA50D
A
--
--

0xA50F
A
--
--

0xA511
A
--
--

0xA513
A
--
--

0xA515
A
--
--

0xA517
A
--
--

0xA519
A
--
--

0xA51B
A
--
--

0xA51D
A
--
--

0xA51F
A
--
--

0xA521
A
--
--

0xA523
A
--
--

0xA525
A
--
--

0xA527
A
--
--

0xA529
A
--
--

0xA52B
A
--
--

0xA52D
A
--
--

0xA52F
A
--
--

0xA531
A
--
--

0xA533
A
--
--

0xA535
A
--
--

0xA537
A
--
--

0xA539
A
--
--

0xA53B
A
--
--

0xA53D
A
--
--

0xA53F
A
--
--

0xA541
A
--
--

0xA543
A
--
--

0xA545
A
--
--

0xA547
A
--
--

0xA549
B
--
--

0xA54B
B
--
--

0xA54D
B
--
--

0xA54F
B
--
--

0xA551
B
--
--

0xA553
B
--
--

0xA555
B
--
--

0xA557
B
--
--

0xA559
B
--
--

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers in Figure 8-71.

8.20.2 Trace collection points and trace information that can be collected when the persistent context of container management is used

This subsection describes the trace collection points and the trace information that can be collected when the persistent context of container management is used. The explanation is divided into the following four categories:

When the persistent context of the transaction scope is used in the transaction

When the entity manager related to the persistent context of the transaction scope is used outside a transaction

When a Query generated outside a transaction is used outside the transaction

When an extended persistent context is used

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

(a) When the persistent context of the transaction scope is used in the transaction

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-117 Details of trace collection points when the persistent context of the transaction scope is used in the transaction

Event ID | No. in the figure# | Trace acquisition points | Level
0xA508 | 1 | When the processing of EntityManager#find(Class<T>entityClass, Object primaryKey) starts | A
0xA509 | 6 | When the processing o EntityManager#find(Class<T> entityClass, Object primaryKey) ends | A
0xA50A | 1 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) starts | A
0xA50B | 6 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) ends | A
0xA50C | 1 | When the processing of EntityManager#contains(Object entity) starts | A
0xA50D | 6 | When the processing of EntityManager#contains(Object entity) ends | A
0xA50E | 1 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) starts | A
0xA50F | 6 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) ends | A
0xA510 | 1 | When the processing of EntityManager#merge(T entity) starts | A
0xA511 | 6 | When the processing of EntityManager#merge(T entity) ends | A
0xA512 | 1 | When the processing of EntityManager#persist(Object entity) starts | A
0xA513 | 6 | When the processing of EntityManager#persist(Object entity) ends | A
0xA514 | 1 | When the processing of EntityManager#refresh(Object entity) starts | A
0xA515 | 6 | When the processing of EntityManager#refresh(Object entity) ends | A
0xA516 | 1 | When the processing of EntityManager#remove(Object entity) starts | A
0xA517 | 6 | When the processing of EntityManager#remove(Object entity) ends | A
0xA518 | 1 | When the processing of EntityManager#clear() starts | A
0xA519 | 6 | When the processing of EntityManager#clear() ends | A
0xA51A | 1 | When the processing of EntityManager#flush() starts | A
0xA51B | 6 | When the processing of EntityManager#flush() ends | A
0xA51C | 1 | When the processing of EntityManager#createQuery(String qlString) starts | A
0xA51D | 6 | When the processing of EntityManager#createQuery(String qlString) ends | A
0xA51E | 1 | When the processing of EntityManager#createNamedQuery(String name) starts | A
0xA51F | 6 | When the processing of EntityManager#createNamedQuery(String name) ends | A
0xA520 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString) starts | A
0xA521 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString) ends | A
0xA522 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) starts | A
0xA523 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) ends | A
0xA524 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) starts | A
0xA525 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) ends | A
0xA526 | 1 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) starts | A
0xA527 | 6 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) ends | A
0xA528 | 1 | When the processing of EntityManager#getFlushMode() starts | A
0xA529 | 6 | When the processing of EntityManager#getFlushMode() ends | A
0xA52A | 1 | When the processing of EntityManager#joinTransaction() starts | A
0xA52B | 6 | When the processing of EntityManager#joinTransaction() ends | A
0xA52C | 1 | When the processing of EntityManager#getTransaction() starts | A
0xA52D | 6 | When the processing of EntityManager#getTransaction() ends | A
0xA52E | 1 | When the processing of EntityManager#getDelegate() starts | A
0xA52F | 6 | When the processing of EntityManager#getDelegate() ends | A
0xA530 | 1 | When the processing of EntityManager#isOpen() starts | A
0xA531 | 6 | When the processing of EntityManager#isOpen() ends | A
0xA532 | 1 | When the processing of EntityManager#close() starts | A
0xA533 | 6 | When the processing of EntityManager#close() ends | A
0xA540 | 1 | When the processing of Query#executeUpdate() starts | A
0xA541 | 6 | When the processing of Query#executeUpdate() ends | A
0xA542 | 1 | When the processing of Query#getResultList() starts | A
0xA543 | 6 | When the processing of Query#getResultList() ends | A
0xA544 | 1 | When the processing of Query#getSingleResult() starts | A
0xA545 | 6 | When the processing of Query#getSingleResult() ends | A
0xA546 | 1 | When the processing of Query#setFlushMode(FlushModeType flushMode) starts | A
0xA547 | 6 | When the processing of Query#setFlushMode(FlushModeType flushMode) ends | A
0xA548 | 1 | When the processing of Query#setFirstResult(int startPosition) starts | B
0xA549 | 6 | When the processing of Query#setFirstResult(int startPosition) ends | B
0xA54A | 1 | When the processing of Query#setMaxResults(int maxResult) starts | B
0xA54B | 6 | When the processing of Query#setMaxResults(int maxResult) ends | B
0xA54C | 1 | When the processing of Query#setHint(String hintName, Object value) starts | B
0xA54D | 6 | When the processing of Query#setHint(String hintName, Object value) ends | B
0xA54E | 1 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) starts | B
0xA54F | 6 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) ends | B
0xA550 | 1 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) starts | B
0xA551 | 6 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) ends | B
0xA552 | 1 | When the processing of Query#setParameter(int position, Object value) starts | B
0xA553 | 6 | When the processing of Query#setParameter(int position, Object value) ends | B
0xA554 | 1 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) starts | B
0xA555 | 6 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) ends | B
0xA556 | 1 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) starts | B
0xA557 | 6 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) ends | B
0xA558 | 1 | When the processing of Query#setParameter(String name, Object value) starts | B
0xA559 | 6 | When the processing of Query#setParameter(String name, Object value) ends | B
0xA560 | 4 | When the processing of find(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider starts | B
0xA561 | 5 | When the processing of find(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider ends | B
0xA562 | 4 | When the processing of getReference(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider starts | B
0xA563 | 5 | When the processing of getReference(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider ends | B
0xA564 | 4 | When the processing of contains(Object entity) of EntityManager of the JPA provider starts | B
0xA565 | 5 | When the processing of contains(Object entity) of EntityManager of the JPA provider ends | B
0xA566 | 4 | When the processing of lock(Object entity, LockModeType lockMode) of EntityManager of the JPA provider starts | B
0xA567 | 5 | When the processing of lock(Object entity, LockModeType lockMode) of EntityManager of the JPA provider ends | B
0xA568 | 4 | When the processing of merge(T entity) of EntityManager of the JPA provider starts | B
0xA569 | 5 | When the processing of merge(T entity) of EntityManager of the JPA provider ends | B
0xA56A | 4 | When the processing of persist(Object entity) of EntityManager of the JPA provider starts | B
0xA56B | 5 | When the processing of persist(Object entity) of EntityManager of the JPA provider ends | B
0xA56C | 4 | When the processing of refresh(Object entity) of EntityManager of the JPA provider starts | B
0xA56D | 5 | When the processing of refresh(Object entity) of EntityManager of the JPA provider ends | B
0xA56E | 4 | When the processing of remove(Object entity) of EntityManager of the JPA provider starts | B
0xA56F | 5 | When the processing of remove(Object entity) of EntityManager of the JPA provider ends | B
0xA570 | 4 | When the processing of clear() of EntityManager of the JPA provider starts | B
0xA571 | 5 | When the processing of clear() of EntityManager of the JPA provider ends | B
0xA572 | 4 | When the processing of flush() of EntityManager of the JPA provider starts | B
0xA573 | 5 | When the processing of flush() of EntityManager of the JPA provider ends | B
0xA574 | 4 | When the processing of createQuery(String qlString) of EntityManager of the JPA provider starts | B
0xA575 | 5 | When the processing of createQuery(String qlString) of EntityManager of the JPA provider ends | B
0xA576 | 4 | When the processing of createNamedQuery(String name) of EntityManager of the JPA provider starts | B
0xA577 | 5 | When the processing of createNamedQuery(String name) of EntityManager of the JPA provider ends | B
0xA578 | 4 | When the processing of createNativeQuery(String sqlString) of EntityManager of the JPA provider starts | B
0xA579 | 5 | When the processing of createNativeQuery(String sqlString) of EntityManager of the JPA provider ends | B
0xA57A | 4 | When the processing of createNativeQuery(String sqlString, Class resultClass) of EntityManager of the JPA provider starts | B
0xA57B | 5 | When the processing of createNativeQuery(String sqlString, Class resultClass) of EntityManager of the JPA provider ends | B
0xA57C | 4 | When the processing of createNativeQuery(String sqlString, String resultSetMapping) of EntityManager of the JPA provider starts | B
0xA57D | 5 | When the processing of createNativeQuery(String sqlString, String resultSetMapping) of EntityManager of the JPA provider ends | B
0xA57E | 4 | When the processing of setFlushMode(FlushModeType flushMode) of EntityManager of the JPA provider starts | B
0xA57F | 5 | When the processing of setFlushMode(FlushModeType flushMode) of EntityManager of the JPA provider ends | B
0xA580 | 4 | When the processing of getFlushMode() of EntityManager of the JPA provider starts | B
0xA581 | 5 | When the processing of getFlushMode() of EntityManager of the JPA provider ends | B
0xA582 | 4 | When the processing of joinTransaction() of EntityManager of the JPA provider starts | B
0xA583 | 5 | When the processing of joinTransaction() of EntityManager of the JPA provider ends | B
0xA584 | 4 | When the processing of isOpen() of EntityManager of the JPA provider starts | B
0xA585 | 5 | When the processing of isOpen() of EntityManager of the JPA provider ends | B
0xA586 | 4 | When the processing of executeUpdate() of Query of the JPA provider starts | B
0xA587 | 5 | When the processing of executeUpdate() of Query of the JPA provider ends | B
0xA588 | 4 | When the processing of getResultList() of Query of the JPA provider starts | B
0xA589 | 5 | When the processing of getResultList() of Query of the JPA provider ends | B
0xA58A | 4 | When the processing of getSingleResult() of Query of the JPA provider starts | B
0xA58B | 5 | When the processing of getSingleResult() of Query of the JPA provider ends | B
0xA58C | 4 | When the processing of setFlushMode(FlushModeType flushMode) of Query of the JPA provider starts | B
0xA58D | 5 | When the processing of setFlushMode(FlushModeType flushMode) of Query of the JPA provider ends | B
0xA58E | 4 | When the processing of setFirstResult(int startPosition) of Query of the JPA provider starts | B
0xA58F | 5 | When the processing of setFirstResult(int startPosition) of Query of the JPA provider ends | B
0xA590 | 4 | When the processing of setMaxResults(int maxResult) of Query of the JPA provider starts | B
0xA591 | 5 | When the processing of setMaxResults(int maxResult) of Query of the JPA provider ends | B
0xA592 | 4 | When the processing of setHint(String hintName, Object value) of Query of the JPA provider starts | B
0xA593 | 5 | When the processing of setHint(String hintName, Object value) of Query of the JPA provider ends | B
0xA594 | 4 | When the processing of setParameter(int position, Calendar value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA595 | 5 | When the processing of setParameter(int position, Calendar value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA596 | 4 | When the processing of setParameter(int position, Date value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA597 | 5 | When the processing of setParameter(int position, Date value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA598 | 4 | When the processing of setParameter(int position, Object value) of Query of the JPA provider starts | B
0xA599 | 5 | When the processing of setParameter(int position, Object value) of Query of the JPA provider ends | B
0xA59A | 4 | When the processing of setParameter(String name, Calendar value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA59B | 5 | When the processing of setParameter(String name, Calendar value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA59C | 4 | When the processing of setParameter(String name, Date value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA59D | 5 | When the processing of setParameter(String name, Date value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA59E | 4 | When the processing of setParameter(String name, Object value) of Query of the JPA provider starts | B
0xA59F | 5 | When the processing of setParameter(String name, Object value) of Query of the JPA provider ends | B
0xA5A0 | 2 | At the time of start of the processing for generating the persistent context, when the persistent context of the transaction scope is used | A
0xA5A1 | 3 | At the time of termination of the processing for generating the persistent context, when the persistent context of the transaction scope is used | A
0xA5A2 | 7 | At the time of start of the processing for discarding the persistent context, when the persistent context of the transaction scope is used | A
0xA5A3 | 8 | At the time of termination of the processing for discarding the persistent context, when the persistent context of the transaction scope is used | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-72.

The following figure shows the trace collection points.

Figure 8-72 Trace collection points when the persistent context of the transaction scope is used in the transaction

(b) When the entity manager related to the persistent context of the transaction scope is used outside a transaction

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-118 Details of trace collection points when the entity manager related to the persistent context of the transaction scope is used outside a transaction

Event ID | No. in the figure# | Trace acquisition points | Level
0xA508 | 1 | When the processing of EntityManager#find(Class<T> entityClass, Object primaryKey) starts | A
0xA509 | 8 | When the processing of EntityManager#find(Class<T> entityClass, Object primaryKey) ends | A
0xA50A | 1 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) starts | A
0xA50B | 8 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) ends | A
0xA50C | 1 | When the processing of EntityManager#contains(Object entity) starts | A
0xA50D | 8 | When the processing of EntityManager#contains(Object entity) ends | A
0xA50E | 1 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) starts | A
0xA50F | 8 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) ends | A
0xA510 | 1 | When the processing of EntityManager#merge(T entity) starts | A
0xA511 | 8 | When the processing of EntityManager#merge(T entity) ends | A
0xA512 | 1 | When the processing of EntityManager#persist(Object entity) starts | A
0xA513 | 8 | When the processing of EntityManager#persist(Object entity) ends | A
0xA514 | 1 | When the processing of EntityManager#refresh(Object entity) starts | A
0xA515 | 8 | When the processing of EntityManager#refresh(Object entity) ends | A
0xA516 | 1 | When the processing of EntityManager#remove(Object entity) starts | A
0xA517 | 8 | When the processing of EntityManager#remove(Object entity) ends | A
0xA518 | 1 | When the processing of EntityManager#clear() starts | A
0xA519 | 8 | When the processing of EntityManager#clear() ends | A
0xA51A | 1 | When the processing of EntityManager#flush() starts | A
0xA51B | 8 | When the processing of EntityManager#flush() ends | A
0xA526 | 1 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) starts | A
0xA527 | 8 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) ends | A
0xA528 | 1 | When the processing of EntityManager#getFlushMode() starts | A
0xA529 | 8 | When the processing of EntityManager#getFlushMode() ends | A
0xA52A | 1 | When the processing of EntityManager#joinTransaction() starts | A
0xA52B | 8 | When the processing of EntityManager#joinTransaction() ends | A
0xA52C | 1 | When the processing of EntityManager#getTransaction() starts | A
0xA52D | 8 | When the processing of EntityManager#getTransaction() ends | A
0xA52E | 1 | When the processing of EntityManager#getDelegate() starts | A
0xA52F | 8 | When the processing of EntityManager#getDelegate() ends | A
0xA530 | 1 | When the processing of EntityManager#isOpen() starts | A
0xA531 | 8 | When the processing of EntityManager#isOpen() ends | A
0xA532 | 1 | When the processing of EntityManager#close() starts | A
0xA533 | 8 | When the processing of EntityManager#close() ends | A
0xA560 | 4 | When the processing of find(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider starts | B
0xA561 | 5 | When the processing of find(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider ends | B
0xA562 | 4 | When the processing of getReference(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider starts | B
0xA563 | 5 | When the processing of getReference(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider ends | B
0xA564 | 4 | When the processing of contains(Object entity) of EntityManager of the JPA provider starts | B
0xA565 | 5 | When the processing of contains(Object entity) of EntityManager of the JPA provider ends | B
0xA566 | 4 | When the processing of lock(Object entity, LockModeType lockMode) of EntityManager of the JPA provider starts | B
0xA567 | 5 | When the processing of lock(Object entity, LockModeType lockMode) of EntityManager of the JPA provider ends | B
0xA568 | 4 | When the processing of merge(T entity) of EntityManager of the JPA provider starts | B
0xA569 | 5 | When the processing of merge(T entity) of EntityManager of the JPA provider ends | B
0xA56A | 4 | When the processing of persist(Object entity) of EntityManager of the JPA provider starts | B
0xA56B | 5 | When the processing of persist(Object entity) of EntityManager of the JPA provider ends | B
0xA56C | 4 | When the processing of refresh(Object entity) of EntityManager of the JPA provider starts | B
0xA56D | 5 | When the processing of refresh(Object entity) of EntityManager of the JPA provider ends | B
0xA56E | 4 | When the processing of remove(Object entity) of EntityManager of the JPA provider starts | B
0xA56F | 5 | When the processing of remove(Object entity) of EntityManager of the JPA provider ends | B
0xA570 | 4 | When the processing of clear() of EntityManager of the JPA provider starts | B
0xA571 | 5 | When the processing of clear() of EntityManager of the JPA provider ends | B
0xA572 | 4 | When the processing of flush() of EntityManager of the JPA provider starts | B
0xA573 | 5 | When the processing of flush() of EntityManager of the JPA provider ends | B
0xA57E | 4 | When the processing of setFlushMode(FlushModeType flushMode) of EntityManager of the JPA provider starts | B
0xA57F | 5 | When the processing of setFlushMode(FlushModeType flushMode) of EntityManager of the JPA provider ends | B
0xA580 | 4 | When the processing of getFlushMode() of EntityManager of the JPA provider starts | B
0xA581 | 5 | When the processing of getFlushMode() of EntityManager of the JPA provider ends | B
0xA582 | 4 | When the processing of joinTransaction() of EntityManager of the JPA provider starts | B
0xA583 | 5 | When the processing of joinTransaction() of EntityManager of the JPA provider ends | B
0xA584 | 4 | When the processing of isOpen() of EntityManager of the JPA provider starts | B
0xA585 | 5 | When the processing of isOpen() of EntityManager of the JPA provider ends | B
0xA5A4 | 2 | At the time of start of the processing for generating the persistent context, when an API that is not generated in the Query of EntityManager of the transaction scope is used while the transaction does not exist | A
0xA5A5 | 3 | At the time of termination of the processing for generating the persistent context, when an API that is not generated in the Query of EntityManager of the transaction scope is used while the transaction does not exist | A
0xA5A6 | 6 | At the time of start of the processing for discarding the persistent context generated when an API that is not generated in the Query of EntityManager of the transaction scope is used while the transaction does not exist | A
0xA5A7 | 7 | At the time of termination of the processing for discarding the persistent context generated when an API that is not generated in the Query of EntityManager of the transaction scope is used while the transaction does not exist | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-73.

The following figure shows the trace collection points.

Figure 8-73 Trace collection points when the entity manager related to the persistent context of the transaction scope is used outside a transaction

(c) When a Query generated outside a transaction is used outside the transaction

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-119 Details of trace collection points when a Query generated outside a transaction is used outside the transaction

Event ID | No. in the figure# | Trace acquisition points | Level
0xA51C | 1 | When the processing of EntityManager#createQuery(String qlString) starts | A
0xA51D | 6 | When the processing of EntityManager#createQuery(String qlString) ends | A
0xA51E | 1 | When the processing of EntityManager#createNamedQuery(String name) starts | A
0xA51F | 6 | When the processing of EntityManager#createNamedQuery(String name) ends | A
0xA520 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString) starts | A
0xA521 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString) ends | A
0xA522 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) starts | A
0xA523 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) ends | A
0xA524 | 1 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) starts | A
0xA525 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) ends | A
0xA540 | 1, 11 | When the processing of Query#executeUpdate() starts | A
0xA541 | 6, 16 | When the processing of Query#executeUpdate() ends | A
0xA542 | 1, 11 | When the processing of Query#getResultList() starts | A
0xA543 | 6, 16 | When the processing of Query#getResultList() ends | A
0xA544 | 1, 11 | When the processing of Query#getSingleResult() starts | A
0xA545 | 6, 16 | When the processing of Query#getSingleResult() ends | A
0xA546 | 1, 7 | When the processing of Query#setFlushMode(FlushModeType flushMode) starts | A
0xA547 | 6, 10 | When the processing of Query#setFlushMode(FlushModeType flushMode) ends | A
0xA548 | 1, 7 | When the processing of Query#setFirstResult(int startPosition) starts | B
0xA549 | 6, 10 | When the processing of Query#setFirstResult(int startPosition) ends | B
0xA54A | 1, 7 | When the processing of Query#setMaxResults(int maxResult) starts | B
0xA54B | 6, 10 | When the processing of Query#setMaxResults(int maxResult) ends | B
0xA54C | 1, 7 | When the processing of Query#setHint(String hintName, Object value) starts | B
0xA54D | 6, 10 | When the processing of Query#setHint(String hintName, Object value) ends | B
0xA54E | 1, 7 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) starts | B
0xA54F | 6, 10 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) ends | B
0xA550 | 1, 7 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) starts | B
0xA551 | 6, 10 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) ends | B
0xA552 | 1, 7 | When the processing of Query#setParameter(int position, Object value) starts | B
0xA553 | 6, 10 | When the processing of Query#setParameter(int position, Object value) ends | B
0xA554 | 1, 7 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) starts | B
0xA555 | 6, 10 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) ends | B
0xA556 | 1, 7 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) starts | B
0xA557 | 6, 10 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) ends | B
0xA558 | 1, 7 | When the processing of Query#setParameter(String name, Object value) starts | B
0xA559 | 6, 10 | When the processing of Query#setParameter(String name, Object value) ends | B
0xA574 | 4 | When the processing of createQuery(String qlString) of EntityManager of the JPA provider starts | B
0xA575 | 5 | When the processing of createQuery(String qlString) of EntityManager of the JPA provider ends | B
0xA576 | 4 | When the processing of createNamedQuery(String name) of EntityManager of the JPA provider starts | B
0xA577 | 5 | When the processing of createNamedQuery(String name) of EntityManager of the JPA provider ends | B
0xA578 | 4 | When the processing of createNativeQuery(String sqlString) of EntityManager of the JPA provider starts | B
0xA579 | 5 | When the processing of createNativeQuery(String sqlString) of EntityManager of the JPA provider ends | B
0xA57A | 4 | When the processing of createNativeQuery(String sqlString, Class resultClass) of EntityManager of the JPA provider starts | B
0xA57B | 5 | When the processing of createNativeQuery(String sqlString, Class resultClass) of EntityManager of the JPA provider ends | B
0xA57C | 4 | When the processing of createNativeQuery(String sqlString, String resultSetMapping) of EntityManager of the JPA provider starts | B
0xA57D | 5 | When the processing of createNativeQuery(String sqlString, String resultSetMapping) of EntityManager of the JPA provider ends | B
0xA586 | 4, 12 | When the processing of executeUpdate() of Query of the JPA provider starts | B
0xA587 | 5, 13 | When the processing of executeUpdate() of Query of the JPA provider ends | B
0xA588 | 4, 12 | When the processing of getResultList() of Query of the JPA provider starts | B
0xA589 | 5, 13 | When the processing of getResultList() of Query of the JPA provider ends | B
0xA58A | 4, 12 | When the processing of getSingleResult() of Query of the JPA provider starts | B
0xA58B | 5, 13 | When the processing of getSingleResult() of Query of the JPA provider ends | B
0xA58C | 4, 8 | When the processing of setFlushMode(FlushModeType flushMode) of Query of the JPA provider starts | B
0xA58D | 5, 9 | When the processing of setFlushMode(FlushModeType flushMode) of Query of the JPA provider ends | B
0xA58E | 4, 8 | When the processing of setFirstResult(int startPosition) of Query of the JPA provider starts | B
0xA58F | 5, 9 | When the processing of setFirstResult(int startPosition) of Query of the JPA provider ends | B
0xA590 | 4, 8 | When the processing of setMaxResults(int maxResult) of Query of the JPA provider starts | B
0xA591 | 5, 9 | When the processing of setMaxResults(int maxResult) of Query of the JPA provider ends | B
0xA592 | 4, 8 | When the processing of setHint(String hintName, Object value) of Query of the JPA provider starts | B
0xA593 | 5, 9 | When the processing of setHint(String hintName, Object value) of Query of the JPA provider ends | B
0xA594 | 4, 8 | When the processing of setParameter(int position, Calendar value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA595 | 5, 9 | When the processing of setParameter(int position, Calendar value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA596 | 4, 8 | When the processing of setParameter(int position, Date value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA597 | 5, 9 | When the processing of setParameter(int position, Date value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA598 | 4, 8 | When the processing of setParameter(int position, Object value) of Query of the JPA provider starts | B
0xA599 | 5, 9 | When the processing of setParameter(int position, Object value) of Query of the JPA provider ends | B
0xA59A | 4, 8 | When the processing of setParameter(String name, Calendar value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA59B | 5, 9 | When the processing of setParameter(String name, Calendar value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA59C | 4, 8 | When the processing of setParameter(String name, Date value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA59D | 5, 9 | When the processing of setParameter(String name, Date value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA59E | 4, 8 | When the processing of setParameter(String name, Object value) of Query of the JPA provider starts | B
0xA59F | 5, 9 | When the processing of setParameter(String name, Object value) of Query of the JPA provider ends | B
0xA5A8 | 2 | At the time of start of the processing for generating the persistent context, when an API generated in the Query of EntityManager of the transaction scope, or an API of the same Query object after searching or updating with the Query is used while the transaction does not exist | A
0xA5A9 | 3 | At the time of termination of the processing for generating the persistent context, when an API generated in the Query of EntityManager of the transaction scope, or an API of the same Query object after searching or updating with the Query is used while the transaction does not exist | A
0xA5AA | 14 | At the time of start of the processing for discarding the persistent context generated when an API generated in the Query of EntityManager of the transaction scope, or an API of the same Query object after searching or updating with the Query is used while the transaction does not exist | A
0xA5AB | 15 | At the time of termination of the processing for discarding the persistent context generated when an API generated in the Query of EntityManager of the transaction scope, or an API of the same Query object after searching or updating with the Query is used while the transaction does not exist | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-74.

The following figure shows the trace collection points.

Figure 8-74 Trace collection points when a Query generated outside a transaction is used outside the transaction

(d) When an extended persistent context is used

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-120 Details of trace collection points when an extended persistent context is used

Event ID | No. in the figure# | Trace acquisition points | Level
0xA508 | 3 | When the processing of EntityManager#find(Class<T> entityClass, Object primaryKey) starts | A
0xA509 | 6 | When the processing of EntityManager#find(Class<T> entityClass, Object primaryKey) ends | A
0xA50A | 3 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) starts | A
0xA50B | 6 | When the processing of EntityManager#getReference(Class<T> entityClass, Object primaryKey) ends | A
0xA50C | 3 | When the processing of EntityManager#contains(Object entity) starts | A
0xA50D | 6 | When the processing of EntityManager#contains(Object entity) ends | A
0xA50E | 3 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) starts | A
0xA50F | 6 | When the processing of EntityManager#lock(Object entity, LockModeType lockMode) ends | A
0xA510 | 3 | When the processing of EntityManager#merge(T entity) starts | A
0xA511 | 6 | When the processing of EntityManager#merge(T entity) ends | A
0xA512 | 3 | When the processing of EntityManager#persist(Object entity) starts | A
0xA513 | 6 | When the processing of EntityManager#persist(Object entity) ends | A
0xA514 | 3 | When the processing of EntityManager#refresh(Object entity) starts | A
0xA515 | 6 | When the processing of EntityManager#refresh(Object entity) ends | A
0xA516 | 3 | When the processing of EntityManager#remove(Object entity) starts | A
0xA517 | 6 | When the processing of EntityManager#remove(Object entity) ends | A
0xA518 | 3 | When the processing of EntityManager#clear() starts | A
0xA519 | 6 | When the processing of EntityManager#clear() ends | A
0xA51A | 3 | When the processing of EntityManager#flush() starts | A
0xA51B | 6 | When the processing of EntityManager#flush() ends | A
0xA51C | 3 | When the processing of EntityManager#createQuery(String qlString) starts | A
0xA51D | 6 | When the processing of EntityManager#createQuery(String qlString) ends | A
0xA51E | 3 | When the processing of EntityManager#createNamedQuery(String name) starts | A
0xA51F | 6 | When the processing of EntityManager#createNamedQuery(String name) ends | A
0xA520 | 3 | When the processing of EntityManager#createNativeQuery(String sqlString) starts | A
0xA521 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString) ends | A
0xA522 | 3 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) starts | A
0xA523 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString, Class resultClass) ends | A
0xA524 | 3 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) starts | A
0xA525 | 6 | When the processing of EntityManager#createNativeQuery(String sqlString, String resultSetMapping) ends | A
0xA526 | 3 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) starts | A
0xA527 | 6 | When the processing of EntityManager#setFlushMode(FlushModeType flushMode) ends | A
0xA528 | 3 | When the processing of EntityManager#getFlushMode() starts | A
0xA529 | 6 | When the processing of EntityManager#getFlushMode() ends | A
0xA52A | 3 | When the processing of EntityManager#joinTransaction() starts | A
0xA52B | 6 | When the processing of EntityManager#joinTransaction() ends | A
0xA52C | 3 | When the processing of EntityManager#getTransaction() starts | A
0xA52D | 6 | When the processing of EntityManager#getTransaction() ends | A
0xA52E | 3 | When the processing of EntityManager#getDelegate() starts | A
0xA52F | 6 | When the processing of EntityManager#getDelegate() ends | A
0xA530 | 3 | When the processing of EntityManager#isOpen() starts | A
0xA531 | 6 | When the processing of EntityManager#isOpen() ends | A
0xA532 | 3 | When the processing of EntityManager#close() starts | A
0xA533 | 6 | When the processing of EntityManager#close() ends | A
0xA540 | 3 | When the processing of Query#executeUpdate() starts | A
0xA541 | 6 | When the processing of Query#executeUpdate() ends | A
0xA542 | 3 | When the processing of Query#getResultList() starts | A
0xA543 | 6 | When the processing of Query#getResultList() ends | A
0xA544 | 3 | When the processing of Query#getSingleResult() starts | A
0xA545 | 6 | When the processing of Query#getSingleResult() ends | A
0xA546 | 3 | When the processing of Query#setFlushMode(FlushModeType flushMode) starts | A
0xA547 | 6 | When the processing of Query#setFlushMode(FlushModeType flushMode) ends | A
0xA548 | 3 | When the processing of Query#setFirstResult(int startPosition) starts | B
0xA549 | 6 | When the processing of Query#setFirstResult(int startPosition) ends | B
0xA54A | 3 | When the processing of Query#setMaxResults(int maxResult) starts | B
0xA54B | 6 | When the processing of Query#setMaxResults(int maxResult) ends | B
0xA54C | 3 | When the processing of Query#setHint(String hintName, Object value) starts | B
0xA54D | 6 | When the processing of Query#setHint(String hintName, Object value) ends | B
0xA54E | 3 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) starts | B
0xA54F | 6 | When the processing of Query#setParameter(int position, Calendar value, TemporalType temporalType) ends | B
0xA550 | 3 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) starts | B
0xA551 | 6 | When the processing of Query#setParameter(int position, Date value, TemporalType temporalType) ends | B
0xA552 | 3 | When the processing of Query#setParameter(int position, Object value) starts | B
0xA553 | 6 | When the processing of Query#setParameter(int position, Object value) ends | B
0xA554 | 3 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) starts | B
0xA555 | 6 | When the processing of Query#setParameter(String name, Calendar value, TemporalType temporalType) ends | B
0xA556 | 3 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) starts | B
0xA557 | 6 | When the processing of Query#setParameter(String name, Date value, TemporalType temporalType) ends | B
0xA558 | 3 | When the processing of Query#setParameter(String name, Object value) starts | B
0xA559 | 6 | When the processing of Query#setParameter(String name, Object value) ends | B
0xA560 | 4 | When the processing of find(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider starts | B
0xA561 | 5 | When the processing of find(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider ends | B
0xA562 | 4 | When the processing of getReference(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider starts | B
0xA563 | 5 | When the processing of getReference(Class<T> entityClass, Object primaryKey) of EntityManager of the JPA provider ends | B
0xA564 | 4 | When the processing of contains(Object entity) of EntityManager of the JPA provider starts | B
0xA565 | 5 | When the processing of contains(Object entity) of EntityManager of the JPA provider ends | B
0xA566 | 4 | When the processing of lock(Object entity, LockModeType lockMode) of EntityManager of the JPA provider starts | B
0xA567 | 5 | When the processing of lock(Object entity, LockModeType lockMode) of EntityManager of the JPA provider ends | B
0xA568 | 4 | When the processing of merge(T entity) of EntityManager of the JPA provider starts | B
0xA569 | 5 | When the processing of merge(T entity) of EntityManager of the JPA provider ends | B
0xA56A | 4 | When the processing of persist(Object entity) of EntityManager of the JPA provider starts | B
0xA56B | 5 | When the processing of persist(Object entity) of EntityManager of the JPA provider ends | B
0xA56C | 4 | When the processing of refresh(Object entity) of EntityManager of the JPA provider starts | B
0xA56D | 5 | When the processing of refresh(Object entity) of EntityManager of the JPA provider ends | B
0xA56E | 4 | When the processing of remove(Object entity) of EntityManager of the JPA provider starts | B
0xA56F | 5 | When the processing of remove(Object entity) of EntityManager of the JPA provider ends | B
0xA570 | 4 | When the processing of clear() of EntityManager of the JPA provider starts | B
0xA571 | 5 | When the processing of clear() of EntityManager of the JPA provider ends | B
0xA572 | 4 | When the processing of flush() of EntityManager of the JPA provider starts | B
0xA573 | 5 | When the processing of flush() of EntityManager of the JPA provider ends | B
0xA574 | 4 | When the processing of createQuery(String qlString) of EntityManager of the JPA provider starts | B
0xA575 | 5 | When the processing of createQuery(String qlString) of EntityManager of the JPA provider ends | B
0xA576 | 4 | When the processing of createNamedQuery(String name) of EntityManager of the JPA provider starts | B
0xA577 | 5 | When the processing of createNamedQuery(String name) of EntityManager of the JPA provider ends | B
0xA578 | 4 | When the processing of createNativeQuery(String sqlString) of EntityManager of the JPA provider starts | B
0xA579 | 5 | When the processing of createNativeQuery(String sqlString) of EntityManager of the JPA provider ends | B
0xA57A | 4 | When the processing of createNativeQuery(String sqlString, Class resultClass) of EntityManager of the JPA provider starts | B
0xA57B | 5 | When the processing of createNativeQuery(String sqlString, Class resultClass) of EntityManager of the JPA provider ends | B
0xA57C | 4 | When the processing of createNativeQuery(String sqlString, String resultSetMapping) of EntityManager of the JPA provider starts | B
0xA57D | 5 | When the processing of createNativeQuery(String sqlString, String resultSetMapping) of EntityManager of the JPA provider ends | B
0xA57E | 4 | When the processing of setFlushMode(FlushModeType flushMode) of EntityManager of the JPA provider starts | B
0xA57F | 5 | When the processing of setFlushMode(FlushModeType flushMode) of EntityManager of the JPA provider ends | B
0xA580 | 4 | When the processing of getFlushMode() of EntityManager of the JPA provider starts | B
0xA581 | 5 | When the processing of getFlushMode() of EntityManager of the JPA provider ends | B
0xA582 | 4 | When the processing of joinTransaction() of EntityManager of the JPA provider starts | B
0xA583 | 5 | When the processing of joinTransaction() of EntityManager of the JPA provider ends | B
0xA584 | 4 | When the processing of isOpen() of EntityManager of the JPA provider starts | B
0xA585 | 5 | When the processing of isOpen() of EntityManager of the JPA provider ends | B
0xA586 | 4 | When the processing of executeUpdate() of Query of the JPA provider starts | B
0xA587 | 5 | When the processing of executeUpdate() of Query of the JPA provider ends | B
0xA588 | 4 | When the processing of getResultList() of Query of the JPA provider starts | B
0xA589 | 5 | When the processing of getResultList() of Query of the JPA provider ends | B
0xA58A | 4 | When the processing of getSingleResult() of Query of the JPA provider starts | B
0xA58B | 5 | When the processing of getSingleResult() of Query of the JPA provider ends | B
0xA58C | 4 | When the processing of setFlushMode(FlushModeType flushMode) of Query of the JPA provider starts | B
0xA58D | 5 | When the processing of setFlushMode(FlushModeType flushMode) of Query of the JPA provider ends | B
0xA58E | 4 | When the processing of setFirstResult(int startPosition) of Query of the JPA provider starts | B
0xA58F | 5 | When the processing of setFirstResult(int startPosition) of Query of the JPA provider ends | B
0xA590 | 4 | When the processing of setMaxResults(int maxResult) of Query of the JPA provider starts | B
0xA591 | 5 | When the processing of setMaxResults(int maxResult) of Query of the JPA provider ends | B
0xA592 | 4 | When the processing of setHint(String hintName, Object value) of Query of the JPA provider starts | B
0xA593 | 5 | When the processing of setHint(String hintName, Object value) of Query of the JPA provider ends | B
0xA594 | 4 | When the processing of setParameter(int position, Calendar value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA595 | 5 | When the processing of setParameter(int position, Calendar value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA596 | 4 | When the processing of setParameter(int position, Date value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA597 | 5 | When the processing of setParameter(int position, Date value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA598 | 4 | When the processing of setParameter(int position, Object value) of Query of the JPA provider starts | B
0xA599 | 5 | When the processing of setParameter(int position, Object value) of Query of the JPA provider ends | B
0xA59A | 4 | When the processing of setParameter(String name, Calendar value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA59B | 5 | When the processing of setParameter(String name, Calendar value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA59C | 4 | When the processing of setParameter(String name, Date value, TemporalType temporalType) of Query of the JPA provider starts | B
0xA59D | 5 | When the processing of setParameter(String name, Date value, TemporalType temporalType) of Query of the JPA provider ends | B
0xA59E | 4 | When the processing of setParameter(String name, Object value) of Query of the JPA provider starts | B
0xA59F | 5 | When the processing of setParameter(String name, Object value) of Query of the JPA provider ends | B
0xA5AC | 1 | At the time of start of the processing for generating the persistent context, when the persistent context of the extended scope is used | A
0xA5AD | 2 | At the time of termination of the processing for generating the persistent context, when the persistent context of the extended scope is used | A
0xA5AE | 7 | When the processing of EntityManager.close() starts while the persistent context of the extended scope is being used | A
0xA5AF | 8 | When the processing of EntityManager.close() ends while the persistent context of the extended scope is being used | A

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-75.

The following figure shows the trace collection points.

Figure 8-75 Trace collection points when an extended persistent context is used

(2) Trace information that can be collected

(a) When the persistent context of the transaction scope is used in the transaction

The following table describes the trace information that can be collected when the persistent context of the transaction scope is used in the transaction.

Table 8-121 Trace information that can be collected when the persistent context of the transaction scope is used in the transaction

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA508 | A | entity class name | -- | --
0xA50A | A | entity class name | -- | --
0xA50C | A | entity class name | -- | --
0xA50E | A | entity class name | lockMode value | --
0xA510 | A | entity class name | -- | --
0xA512 | A | entity class name | -- | --
0xA514 | A | entity class name | -- | --
0xA516 | A | entity class name | -- | --
0xA518 | A | -- | -- | --
0xA51A | A | -- | -- | --
0xA51C | A | -- | -- | --
0xA51E | A | name | -- | --
0xA520 | A | -- | -- | --
0xA522 | A | resultClass class name | -- | --
0xA524 | A | resultSetMapping | -- | --
0xA526 | A | flushMode value | -- | --
0xA528 | A | -- | -- | --
0xA52A | A | -- | -- | --
0xA52C | A | -- | -- | --
0xA52E | A | -- | -- | --
0xA530 | A | -- | -- | --
0xA532 | A | -- | -- | --
0xA540 | A | -- | -- | --
0xA542 | A | -- | -- | --
0xA544 | A | -- | -- | --
0xA546 | A | flushMode value | -- | --
0xA548 | B | startPosition value | -- | --
0xA54A | B | maxResult value | -- | --
0xA54C | B | hintName | value class name | --
0xA54E | B | position value | -- | --
0xA550 | B | position value | -- | --
0xA552 | B | position value | -- | --
0xA554 | B | name value | -- | --
0xA556 | B | name value | -- | --
0xA558 | B | name value | -- | --
2 | 0xA5A0 | A | -- | -- | --
3 | 0xA5A1 | A | -- | -- | #2
4 | 0xA560 | B | entity class name | -- | --
0xA562 | B | entity class name | -- | --
0xA564 | B | entity class name | -- | --
0xA566 | B | entity class name | lockMode value | --
0xA568 | B | entity class name | -- | --
0xA56A | B | entity class name | -- | --
0xA56C | B | entity class name | -- | --
0xA56E | B | entity class name | -- | --
0xA570 | B | -- | -- | --
0xA572 | B | -- | -- | --
0xA574 | B | -- | -- | --
0xA576 | B | name | -- | --
0xA578 | B | -- | -- | --
0xA57A | B | resultClass class name | -- | --
0xA57C | B | resultSetMapping | -- | --
0xA57E | B | flushMode value | -- | --
0xA580 | B | -- | -- | --
0xA582 | B | -- | -- | --
0xA584 | B | -- | -- | --
0xA586 | B | -- | -- | --
0xA588 | B | -- | -- | --
0xA58A | B | -- | -- | --
0xA58C | B | flushMode value | -- | --
0xA58E | B | startPosition value | -- | --
0xA590 | B | maxResult value | -- | --
0xA592 | B | hintName | value class name | --
0xA594 | B | position value | -- | --
0xA596 | B | position value | -- | --
0xA598 | B | position value | -- | --
0xA59A | B | name value | -- | --
0xA59C | B | name value | -- | --
0xA59E | B | name value | -- | --
5 | 0xA561 | B | -- | -- | #2
0xA563 | B | -- | -- | #2
0xA565 | B | -- | -- | #2
0xA567 | B | -- | -- | #2
0xA569 | B | -- | -- | #2
0xA56B | B | -- | -- | #2
0xA56D | B | -- | -- | #2
0xA56F | B | -- | -- | #2
0xA571 | B | -- | -- | #2
0xA573 | B | -- | -- | #2
0xA575 | B | -- | -- | #2
0xA577 | B | -- | -- | #2
0xA579 | B | -- | -- | #2
0xA57B | B | -- | -- | #2
0xA57D | B | -- | -- | #2
0xA57F | B | -- | -- | #2
0xA581 | B | -- | -- | #2
0xA583 | B | -- | -- | #2
0xA585 | B | -- | -- | #2
0xA587 | B | -- | -- | #2
0xA589 | B | -- | -- | #2
0xA58B | B | -- | -- | #2
0xA58D | B | -- | -- | #2
0xA58F | B | -- | -- | #2
0xA591 | B | -- | -- | #2
0xA593 | B | -- | -- | #2
0xA595 | B | -- | -- | #2
0xA597 | B | -- | -- | #2
0xA599 | B | -- | -- | #2
0xA59B | B | -- | -- | #2
0xA59D | B | -- | -- | #2
0xA59F | B | -- | -- | #2
6 | 0xA509 | A | -- | -- | #2
0xA50B | A | -- | -- | #2
0xA50D | A | -- | -- | #2
0xA50F | A | -- | -- | #2
0xA511 | A | -- | -- | #2
0xA513 | A | -- | -- | #2
0xA515 | A | -- | -- | #2
0xA517 | A | -- | -- | #2
0xA519 | A | -- | -- | #2
0xA51B | A | -- | -- | #2
0xA51D | A | -- | -- | #2
0xA51F | A | -- | -- | #2
0xA521 | A | -- | -- | #2
0xA523 | A | -- | -- | #2
0xA525 | A | -- | -- | #2
0xA527 | A | -- | -- | #2
0xA529 | A | -- | -- | #2
0xA52B | A | -- | -- | #2
0xA52D | A | -- | -- | #2
0xA52F | A | -- | -- | #2
0xA531 | A | -- | -- | #2
0xA533 | A | -- | -- | #2
0xA541 | A | -- | -- | #2
0xA543 | A | -- | -- | #2
0xA545 | A | -- | -- | #2
0xA547 | A | -- | -- | #2
0xA549 | B | -- | -- | #2
0xA54B | B | -- | -- | #2
0xA54D | B | -- | -- | #2
0xA54F | B | -- | -- | #2
0xA551 | B | -- | -- | #2
0xA553 | B | -- | -- | #2
0xA555 | B | -- | -- | #2
0xA557 | B | -- | -- | #2
0xA559 | B | -- | -- | #2
7 | 0xA5A2 | A | -- | -- | --
8 | 0xA5A3 | A | -- | -- | #2

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-72.

#2

When the processing is performed normally, the entrance time is displayed.

When an exception occurs, the entrance time and exception are displayed.

(b) When the entity manager related to the persistent context of the transaction scope is used outside a transaction

The following table describes the trace information that can be collected when the entity manager related to the persistent context of the transaction scope is used outside a transaction.

Table 8-122 Trace information that can be collected when the entity manager related to the persistent context of the transaction scope is used outside a transaction

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA508 | A | entity class name | -- | --
0xA50A | A | entity class name | -- | --
0xA50C | A | entity class name | -- | --
0xA50E | A | entity class name | lockMode value | --
0xA510 | A | entity class name | -- | --
0xA512 | A | entity class name | -- | --
0xA514 | A | entity class name | -- | --
0xA516 | A | entity class name | -- | --
0xA518 | A | -- | -- | --
0xA51A | A | -- | -- | --
0xA526 | A | flushMode value | -- | --
0xA528 | A | -- | -- | --
0xA52A | A | -- | -- | --
0xA52C | A | -- | -- | --
0xA52E | A | -- | -- | --
0xA530 | A | -- | -- | --
0xA532 | A | -- | -- | --
2 | 0xA5A4 | A | -- | -- | --
3 | 0xA5A5 | A | -- | -- | #2
4 | 0xA560 | B | entity class name | -- | --
0xA562 | B | entity class name | -- | --
0xA564 | B | entity class name | -- | --
0xA566 | B | entity class name | lockMode value | --
0xA568 | B | entity class name | -- | --
0xA56A | B | entity class name | -- | --
0xA56C | B | entity class name | -- | --
0xA56E | B | entity class name | -- | --
0xA570 | B | -- | -- | --
0xA572 | B | -- | -- | --
0xA57E | B | flushMode value | -- | --
0xA580 | B | -- | -- | --
0xA582 | B | -- | -- | --
0xA584 | B | -- | -- | --
5 | 0xA561 | B | -- | -- | #2
0xA563 | B | -- | -- | #2
0xA565 | B | -- | -- | #2
0xA567 | B | -- | -- | #2
0xA569 | B | -- | -- | #2
0xA56B | B | -- | -- | #2
0xA56D | B | -- | -- | #2
0xA56F | B | -- | -- | #2
0xA571 | B | -- | -- | #2
0xA573 | B | -- | -- | #2
0xA57F | B | -- | -- | #2
0xA581 | B | -- | -- | #2
0xA583 | B | -- | -- | #2
0xA585 | B | -- | -- | #2
6 | 0xA5A6 | A | -- | -- | --
7 | 0xA5A7 | A | -- | -- | #2
8 | 0xA509 | A | -- | -- | #2
0xA50B | A | -- | -- | #2
0xA50D | A | -- | -- | #2
0xA50F | A | -- | -- | #2
0xA511 | A | -- | -- | #2
0xA513 | A | -- | -- | #2
0xA515 | A | -- | -- | #2
0xA517 | A | -- | -- | #2
0xA519 | A | -- | -- | #2
0xA51B | A | -- | -- | #2
0xA527 | A | -- | -- | #2
0xA529 | A | -- | -- | #2
0xA52B | A | -- | -- | #2
0xA52D | A | -- | -- | #2
0xA52F | A | -- | -- | #2
0xA531 | A | -- | -- | #2
0xA533 | A | -- | -- | #2

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-73.

#2

When the processing is performed normally, the entrance time is displayed.

When an exception occurs, the entrance time and exception are displayed.

(c) When a Query generated outside a transaction is used outside the transaction

The following table describes the trace information that can be collected when a Query generated outside a transaction is used outside the transaction.

Table 8-123 Trace information that can be collected when a Query generated outside a transaction is used outside the transaction

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA51C | A | -- | -- | --
0xA51E | A | name | -- | --
0xA520 | A | -- | -- | --
0xA522 | A | resultClass class name | -- | --
0xA524 | A | resultSetMapping | -- | --
1, 11 | 0xA540 | A | -- | -- | --
0xA542 | A | -- | -- | --
0xA544 | A | -- | -- | --
1, 7 | 0xA546 | A | flushMode value | -- | --
0xA548 | B | startPosition value | -- | --
0xA54A | B | maxResult value | -- | --
0xA54C | B | hintName | value class name | --
0xA54E | B | position value | -- | --
0xA550 | B | position value | -- | --
0xA552 | B | position value | -- | --
0xA554 | B | name value | -- | --
0xA556 | B | name value | -- | --
0xA558 | B | name value | -- | --
2 | 0xA5A8 | A | -- | -- | --
3 | 0xA5A9 | A | -- | -- | #2
4 | 0xA574 | B | -- | -- | --
0xA576 | B | name | -- | --
0xA578 | B | -- | -- | --
0xA57A | B | resultClass class name | -- | --
0xA57C | B | resultSetMapping | -- | --
4, 12 | 0xA586 | B | -- | -- | --
0xA588 | B | -- | -- | --
0xA58A | B | -- | -- | --
4, 8 | 0xA58C | B | flushMode value | -- | --
0xA58E | B | startPosition value | -- | --
0xA590 | B | maxResult value | -- | --
0xA592 | B | hintName | value class name | --
0xA594 | B | position value | -- | --
0xA596 | B | position value | -- | --
0xA598 | B | position value | -- | --
0xA59A | B | name value | -- | --
0xA59C | B | name value | -- | --
0xA59E | B | name value | -- | --
5 | 0xA575 | B | -- | -- | #2
0xA577 | B | -- | -- | #2
0xA579 | B | -- | -- | #2
0xA57B | B | -- | -- | #2
0xA57D | B | -- | -- | #2
5, 13 | 0xA587 | B | -- | -- | #2
0xA589 | B | -- | -- | #2
0xA58B | B | -- | -- | #2
5, 9 | 0xA58D | B | -- | -- | #2
0xA58F | B | -- | -- | #2
0xA591 | B | -- | -- | #2
0xA593 | B | -- | -- | #2
0xA595 | B | -- | -- | #2
0xA597 | B | -- | -- | #2
0xA599 | B | -- | -- | #2
0xA59B | B | -- | -- | #2
0xA59D | B | -- | -- | #2
0xA59F | B | -- | -- | #2
6 | 0xA51D | A | -- | -- | #2
0xA51F | A | -- | -- | #2
0xA521 | A | -- | -- | #2
0xA523 | A | -- | -- | #2
0xA525 | A | -- | -- | #2
6, 16 | 0xA541 | A | -- | -- | #2
0xA543 | A | -- | -- | #2
0xA545 | A | -- | -- | #2
6, 10 | 0xA547 | A | -- | -- | #2
0xA549 | B | -- | -- | #2
0xA54B | B | -- | -- | #2
0xA54D | B | -- | -- | #2
0xA54F | B | -- | -- | #2
0xA551 | B | -- | -- | #2
0xA553 | B | -- | -- | #2
0xA555 | B | -- | -- | #2
0xA557 | B | -- | -- | #2
0xA559 | B | -- | -- | #2
14 | 0xA5AA | A | -- | -- | --
15 | 0xA5AB | A | -- | -- | #2

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-74.

#2

When the processing is performed normally, the entrance time is displayed.

When an exception occurs, the entrance time and exception are displayed.

(d) When an extended persistent context is used

The following table describes the trace information that can be collected when an extended persistent context is used.

Table 8-124 Trace information that can be collected when an extended persistent context is used

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA5AC | A | -- | -- | --
2 | 0xA5AD | A | -- | -- | #2
3 | 0xA508 | A | entity class name | -- | --
0xA50A | A | entity class name | -- | --
0xA50C | A | entity class name | -- | --
0xA50E | A | entity class name | lockMode value | --
0xA510 | A | entity class name | -- | --
0xA512 | A | entity class name | -- | --
0xA514 | A | entity class name | -- | --
0xA516 | A | entity class name | -- | --
0xA518 | A | -- | -- | --
0xA51A | A | -- | -- | --
0xA51C | A | -- | -- | --
0xA51E | A | name | -- | --
0xA520 | A | -- | -- | --
0xA522 | A | resultClass class name | -- | --
0xA524 | A | resultSetMapping | -- | --
0xA526 | A | flushMode value | -- | --
0xA528 | A | -- | -- | --
0xA52A | A | -- | -- | --
0xA52C | A | -- | -- | --
0xA52E | A | -- | -- | --
0xA530 | A | -- | -- | --
0xA532 | A | -- | -- | --
0xA540 | A | -- | -- | --
0xA542 | A | -- | -- | --
0xA544 | A | -- | -- | --
0xA546 | A | flushMode value | -- | --
0xA548 | B | startPosition value | -- | --
0xA54A | B | maxResult value | -- | --
0xA54C | B | hintName | value class name | --
0xA54E | B | position value | -- | --
0xA550 | B | position value | -- | --
0xA552 | B | position value | -- | --
0xA554 | B | name value | -- | --
0xA556 | B | name value | -- | --
0xA558 | B | name value | -- | --
4 | 0xA560 | B | entity class name | -- | --
0xA562 | B | entity class name | -- | --
0xA564 | B | entity class name | -- | --
0xA566 | B | entity class name | lockMode value | --
0xA568 | B | entity class name | -- | --
0xA56A | B | entity class name | -- | --
0xA56C | B | entity class name | -- | --
0xA56E | B | entity class name | -- | --
0xA570 | B | -- | -- | --
0xA572 | B | -- | -- | --
0xA574 | B | -- | -- | --
0xA576 | B | name | -- | --
0xA578 | B | -- | -- | --
0xA57A | B | resultClass class name | -- | --
0xA57C | B | resultSetMapping | -- | --
0xA57E | B | flushMode value | -- | --
0xA580 | B | -- | -- | --
0xA582 | B | -- | -- | --
0xA584 | B | -- | -- | --
0xA586 | B | -- | -- | --
0xA588 | B | -- | -- | --
0xA58A | B | -- | -- | --
0xA58C | B | flushMode value | -- | --
0xA58E | B | startPosition value | -- | --
0xA590 | B | maxResult value | -- | --
0xA592 | B | hintName | value class name | --
0xA594 | B | position value | -- | --
0xA596 | B | position value | -- | --
0xA598 | B | position value | -- | --
0xA59A | B | name value | -- | --
0xA59C | B | name value | -- | --
0xA59E | B | name value | -- | --
5 | 0xA561 | B | -- | -- | #2
0xA563 | B | -- | -- | #2
0xA565 | B | -- | -- | #2
0xA567 | B | -- | -- | #2
0xA569 | B | -- | -- | #2
0xA56B | B | -- | -- | #2
0xA56D | B | -- | -- | #2
0xA56F | B | -- | -- | #2
0xA571 | B | -- | -- | #2
0xA573 | B | -- | -- | #2
0xA575 | B | -- | -- | #2
0xA577 | B | -- | -- | #2
0xA579 | B | -- | -- | #2
0xA57B | B | -- | -- | #2
0xA57D | B | -- | -- | #2
0xA57F | B | -- | -- | #2
0xA581 | B | -- | -- | #2
0xA583 | B | -- | -- | #2
0xA585 | B | -- | -- | #2
0xA587 | B | -- | -- | #2
0xA589 | B | -- | -- | #2
0xA58B | B | -- | -- | #2
0xA58D | B | -- | -- | #2
0xA58F | B | -- | -- | #2
0xA591 | B | -- | -- | #2
0xA593 | B | -- | -- | #2
0xA595 | B | -- | -- | #2
0xA597 | B | -- | -- | #2
0xA599 | B | -- | -- | #2
0xA59B | B | -- | -- | #2
0xA59D | B | -- | -- | #2
0xA59F | B | -- | -- | #2
6 | 0xA509 | A | -- | -- | #2
0xA50B | A | -- | -- | #2
0xA50D | A | -- | -- | #2
0xA50F | A | -- | -- | #2
0xA511 | A | -- | -- | #2
0xA513 | A | -- | -- | #2
0xA515 | A | -- | -- | #2
0xA517 | A | -- | -- | #2
0xA519 | A | -- | -- | #2
0xA51B | A | -- | -- | #2
0xA51D | A | -- | -- | #2
0xA51F | A | -- | -- | #2
0xA521 | A | -- | -- | #2
0xA523 | A | -- | -- | #2
0xA525 | A | -- | -- | #2
0xA527 | A | -- | -- | #2
0xA529 | A | -- | -- | #2
0xA52B | A | -- | -- | #2
0xA52D | A | -- | -- | #2
0xA52F | A | -- | -- | #2
0xA531 | A | -- | -- | #2
0xA533 | A | -- | -- | #2
0xA541 | A | -- | -- | #2
0xA543 | A | -- | -- | #2
0xA545 | A | -- | -- | #2
0xA547 | A | -- | -- | #2
0xA549 | B | -- | -- | #2
0xA54B | B | -- | -- | #2
0xA54D | B | -- | -- | #2
0xA54F | B | -- | -- | #2
0xA551 | B | -- | -- | #2
0xA553 | B | -- | -- | #2
0xA555 | B | -- | -- | #2
0xA557 | B | -- | -- | #2
0xA559 | B | -- | -- | #2
7 | 0xA5AE | A | -- | -- | --
8 | 0xA5AF | A | -- | -- | #2

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-75.

#2

When the processing is performed normally, the entrance time is displayed.

When an exception occurs, the entrance time and exception are displayed.

8.21 Trace collection points of the Cosminexus JPA provider

This subsection describes the trace collection points of the Cosminexus JPA provider, and also describes the trace information that can be collected.

Organization of this section

8.21.1 Trace collection points and trace information that can be collected during the acquisition or release processing of EntityManagerFactory

8.21.2 Trace collection points and trace information that can be collected during the acquisition processing of EntityManager

8.21.3 Trace collection points and trace information that can be collected during the operation of EntityManager

8.21.4 Trace collection points and trace information that can be collected during the release processing of EntityManager

8.21.5 Trace collection points and trace information that can be collected during the operation of Query

8.21.6 Trace collection points and trace information that can be collected during the operation of EntityTransaction

8.21.7 Trace collection points and trace information that can be collected in the case of callback method to the user

8.21.8 Trace collection points and trace information that can be collected during binary conversion of the entity class

8.21.9 Trace collection points and trace information that can be collected during transaction linkage with the transaction manager

8.21.10 Trace collection points and trace information that can be collected during the connection operation of the DB Connector

8.21.1 Trace collection points and trace information that can be collected during the acquisition or release processing of EntityManagerFactory

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-125 Details of trace collection points during the acquisition or release processing of EntityManagerFactory

Event ID | No. in the figure#1 | Trace acquisition points | Level
0xA304#2 | 3 | When the processing of EntityManagerFactory#close() starts | B
0xA305#2 | 4 | When the processing of EntityManagerFactory#close() ends | B
0xA320#3 | 1 | When the processing of PersistenceProvider#createEntityManagerFactory(String, Map) starts | A
0xA321#3 | 2 | When the processing of PersistenceProvider#createEntityManagerFactory(String, Map) ends | A
0xA322#3 | 1 | When the processing of PersistenceProvider#createContainerEntityManagerFactory(PersistenceUnitInfo, Map) starts | A
0xA323#3 | 2 | When the processing of PersistenceProvider#createContainerEntityManagerFactory(PersistenceUnitInfo, Map) ends | A

Legend:

A: Standard

B: Advanced

#1

Corresponds to the numbers in Figure 8-76.

#2

Trace collection point for javax.persistence.EntityManagerFactory.

#3

Trace collection point for javax.persistence.spi.PersistenceProvider.

The following figure shows the trace collection points.

Figure 8-76 Trace collection points of the acquisition or release processing of EntityManagerFactory

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the acquisition or release processing of EntityManagerFactory.

Table 8-126 Trace information that can be collected during the acquisition or release processing of EntityManagerEntityFactory

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1#2 | 0xA320#3 | A | -- | -- | --
0xA322 | A | -- | -- | --
2#2 | 0xA321#3 | A | -- | -- | #4
0xA323 | A | -- | -- | #4
3#5 | 0xA304 | B | -- | -- | --
4#5 | 0xA305 | B | -- | -- | #4

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-76.

#2

Trace collection point for javax.persistence.spi.PersistenceProvider.

#3

Not output when the Cosminexus JPA provider is used.

#4

When an exception occurs, the exception is displayed.

#5

Trace collection point for javax.persistence.EntityManagerFactory.

8.21.2 Trace collection points and trace information that can be collected during the acquisition processing of EntityManager

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-127 Details of trace collection points for javax.persistence.EntityManagerFactory

Event ID | No. in the figure# | Trace acquisition points | Level
0xA300 | 1 | When the processing of EntityManagerFactory#createEntityManager() starts | B
0xA301 | 2 | When the processing of EntityManagerFactory#createEntityManager() ends | B
0xA302 | 1 | When the processing of EntityManagerFactory#createEntityManager(Map) starts | B
0xA303 | 2 | When the processing of EntityManagerFactory#createEntityManager(Map) ends | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-77.

The following figure shows the trace collection points.

Figure 8-77 Trace collection points for javax.persistence.EntityManagerFactory

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the acquisition processing of EntityManager.

Table 8-128 Trace information that can be collected for javax.persistence.EntityManagerFactory

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA300 | B | -- | -- | --
0xA302 | B | -- | -- | --
2 | 0xA301 | B | -- | -- | #2
0xA303 | B | -- | -- | #2

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-77.

#2

When an exception occurs, the exception is displayed.

8.21.3 Trace collection points and trace information that can be collected during the operation of EntityManager

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-129 Details of trace collection points for javax.persistence.EntityManager

Event ID | No. in the figure#1 | Trace acquisition points | Level
0xA340 | 1 | When the processing of EntityManager#persist(Object) starts | B
0xA341 | 2 | When the processing of EntityManager#persist(Object) ends | B
0xA342 | 1 | When the processing of EntityManager#merge(T) starts | B
0xA343 | 2 | When the processing of EntityManager#merge(T) ends | B
0xA344 | 1 | When the processing of EntityManager#remove(Object) starts | B
0xA345 | 2 | When the processing of EntityManager#remove(Object) ends | B
0xA346 | 1 | When the processing of EntityManager#find(Class<T>, Object) starts | B
0xA347 | 2 | When the processing of EntityManager#find(Class<T>, Object) ends | B
0xA348 | 1 | When the processing of EntityManager#getReference(Class<T>, Object) starts | B
0xA349 | 2 | When the processing of EntityManager#getReference(Class<T>, Object) ends | B
0xA34A | 1 | When the processing of EntityManager#flush() starts | B
0xA34B | 2 | When the processing of EntityManager#flush() ends | B
0xA34C | 1 | When the processing of EntityManager#lock(Object, LockModeType) starts | B
0xA34D | 2 | When the processing of EntityManager#lock(Object, LockModeType) ends | B
0xA34E | 1 | When the processing of EntityManager#refresh(Object) starts | B
0xA34F | 2 | When the processing of EntityManager#refresh(Object) ends | B
0xA350 | 1 | When the processing of EntityManager#clear() starts | B
0xA351 | 2 | When the processing of EntityManager#clear() ends | B
0xA352 | 1 | When the processing of EntityManager#contains(Object) starts | B
0xA353 | 2 | When the processing of EntityManager#contains(Object) ends | B
0xA35E | 1 | When the processing of EntityManager#joinTransaction() starts | B
0xA35F | 2 | When the processing of EntityManager#joinTransaction() ends | B

Legend:

B: Advanced

#1

Corresponds to the numbers in Figure 8-78.

The following figure shows the trace collection points.

Figure 8-78 Trace collection points for javax.persistence.EntityManager

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the operation of EntityManager.

Table 8-130 Trace information that can be collected for javax.persistence.EntityManager

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA340 | B | -- | -- | --
0xA342 | B | -- | -- | --
0xA344 | B | -- | -- | --
0xA346 | B | -- | -- | --
0xA348 | B | -- | -- | --
0xA34A | B | -- | -- | --
0xA34C | B | -- | -- | --
0xA34E | B | -- | -- | --
0xA350 | B | -- | -- | --
0xA352 | B | -- | -- | --
0xA35E | B | -- | -- | --
2 | 0xA341 | B | -- | -- | #2
0xA343 | B | -- | -- | #2
0xA345 | B | -- | -- | #2
0xA347 | B | -- | -- | #2
0xA349 | B | -- | -- | #2
0xA34B | B | -- | -- | #2
0xA34D | B | -- | -- | #2
0xA34F | B | -- | -- | #2
0xA351 | B | -- | -- | #2
0xA353 | B | -- | -- | #2
0xA35F | B | -- | -- | #2

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-78.

#2

When an exception occurs, the exception is displayed.

8.21.4 Trace collection points and trace information that can be collected during the release processing of EntityManager

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-131 Details of trace collection points for javax.persistence.EntityManager

Event ID | No. in the figure# | Trace acquisition points | Level
0xA360 | 1 | When the processing of EntityManager#close() starts | B
0xA361 | 2 | When the processing of EntityManager#close() ends | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-79.

The following figure shows the trace collection points.

Figure 8-79 Trace collection points for javax.persistence.EntityManager

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the release processing of EntityManager.

Table 8-132 Trace information that can be collected for javax.persistence.EntityManager

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA360 | B | -- | -- | --
2 | 0xA361 | B | -- | -- | #2

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-79.

#2

When an exception occurs, the exception is displayed.

8.21.5 Trace collection points and trace information that can be collected during the operation of Query

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-133 Details of trace collection points of the Query operation

Event ID | No. in the figure# | Trace acquisition points | Level
0xA354#2 | 1 | When the processing of EntityManager#createQuery(String) starts | B
0xA355#2 | 2 | When the processing of EntityManager#createQuery(String) ends | B
0xA356#2 | 1 | When the processing of EntityManager#createNamedQuery(String) starts | B
0xA357#2 | 2 | When the processing of EntityManager#createNamedQuery(String) ends | B
0xA358#2 | 1 | When the processing of EntityManager#createNativeQuery(String) starts | B
0xA359#2 | 2 | When the processing of EntityManager#createNativeQuery(String) ends | B
0xA35A#2 | 1 | When the processing of EntityManager#createNativeQuery(String, Class) starts | B
0xA35B#2 | 2 | When the processing of EntityManager#createNativeQuery(String, Class) ends | B
0xA35C#2 | 1 | When the processing of EntityManager#createNativeQuery(String, String) starts | B
0xA35D#2 | 2 | When the processing of EntityManager#createNativeQuery(String, String) ends | B
0xA370#3 | 5 | When the processing of Query#getResultList() starts | B
0xA371#3 | 6 | When the processing of Query#getResultList() ends | B
0xA372#3 | 5 | When the processing of Query#getSingleResult() starts | B
0xA373#3 | 6 | When the processing of Query#getSingleResult() ends | B
0xA374#3 | 5 | When the processing of Query#executeUpdate() starts | B
0xA375#3 | 6 | When the processing of Query#executeUpdate() ends | B
0xA376#3 | 3 | When the processing of Query#setParameter(String, Object) starts | B
0xA377#3 | 4 | When the processing of Query#setParameter(String, Object) ends | B
0xA378#3 | 3 | When the processing of Query#setParameter(String, Date, TemporalType) starts | B
0xA379#3 | 4 | When the processing of Query#setParameter(String, Date, TemporalType) ends | B
0xA37A#3 | 3 | When the processing of Query#setParameter(String, Calendar, TemporalType) starts | B
0xA37B#3 | 4 | When the processing of Query#setParameter(String, Calendar, TemporalType) ends | B
0xA37C#3 | 3 | When the processing of Query#setParameter(int, Object) starts | B
0xA37D#3 | 4 | When the processing of Query#setParameter(int, Object) ends | B
0xA37E#3 | 3 | When the processing of Query#setParameter(int, Date, TemporalType) starts | B
0xA37F#3 | 4 | When the processing of Query#setParameter(int, Date, TemporalType) ends | B
0xA380#3 | 3 | When the processing of Query#setParameter(int, Calendar, TemporalType) starts | B
0xA381#3 | 4 | When the processing of Query#setParameter(int, Calendar, TemporalType) ends | B

Legend:

B: Advanced

#1

Corresponds to the numbers in Figure 8-80.

#2

Trace collection point for javax.persistence.EntityManager.

#3

Trace collection point for javax.persistence.Query.

The following figure shows the trace collection points.

Figure 8-80 Trace collection points of the Query operation

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the Query operation.

Table 8-134 Trace information that can be collected during the Query operation

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1#2 | 0xA354 | B | -- | -- | --
0xA356 | B | -- | -- | --
0xA358 | B | -- | -- | --
0xA35A | B | -- | -- | --
0xA35C | B | -- | -- | --
2#2 | 0xA355 | B | -- | -- | #3
0xA357 | B | -- | -- | #3
0xA359 | B | -- | -- | #3
0xA35B | B | -- | -- | #3
0xA35D | B | -- | -- | #3
3#4 | 0xA376 | B | -- | -- | --
0xA378 | B | -- | -- | --
0xA37A | B | -- | -- | --
0xA37C | B | -- | -- | --
0xA37E | B | -- | -- | --
0xA380 | B | -- | -- | --
4#4 | 0xA377 | B | -- | -- | #3
0xA379 | B | -- | -- | #3
0xA37B | B | -- | -- | #3
0xA37D | B | -- | -- | #3
0xA37F | B | -- | -- | #3
0xA381 | B | -- | -- | #3
5#4 | 0xA370 | B | -- | -- | --
0xA372 | B | -- | -- | --
0xA374 | B | -- | -- | --
6#4 | 0xA371 | B | -- | -- | #3
0xA373 | B | -- | -- | #3
0xA375 | B | -- | -- | #3

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-80.

#2

Trace collection point for javax.persistence.EntityManager.

#3

When an exception occurs, the exception is displayed.

#4

Trace collection point for javax.persistence.Query.

8.21.6 Trace collection points and trace information that can be collected during the operation of EntityTransaction

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-135 Details of trace collection points during the operation of EntityTransaction

Event ID | No. in the figure#1 | Trace acquisition points | Level
0xA310#2 | 3 | When the processing of EntityTransaction#begin() starts | B
0xA311#2 | 4 | When the processing of EntityTransaction#begin() ends | B
0xA312#2 | 5 | When the processing of EntityTransaction#commit() starts | B
0xA313#2 | 6 | When the processing of EntityTransaction#commit() ends | B
0xA314#2 | 5 | When the processing of EntityTransaction#rollback() starts | B
0xA315#2 | 6 | When the processing of EntityTransaction#rollback() ends | B
0xA362#3 | 1 | When the processing of EntityManager#getTransaction() starts | B
0xA363#3 | 2 | When the processing of EntityManager#getTransaction() ends | B

Legend:

B: Advanced

#1

Corresponds to the numbers in Figure 8-81.

#2

Trace collection point for javax.persistence.EntityTransaction.

#3

Trace collection point for javax.persistence.EntityManager.

The following figure shows the trace collection points.

Figure 8-81 Trace collection points for the operation of EntityTransaction

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the operation of EntityTransaction.

Table 8-136 Trace information that can be collected during the operation of EntityTransaction

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1#2 | 0xA362 | B | -- | -- | --
2#2 | 0xA363 | B | -- | -- | #3
3#4 | 0xA310 | B | -- | -- | --
4#4 | 0xA311 | B | -- | -- | #3
5#4 | 0xA312 | B | -- | -- | --
0xA314 | B | -- | -- | --
6#4 | 0xA313 | B | -- | -- | #3
0xA315 | B | -- | -- | #3

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-81.

#2

Trace collection point for javax.persistence.EntityManager.

#3

When an exception occurs, the exception is displayed.

#4

Trace collection point for javax.persistence.EntityTransaction.

8.21.7 Trace collection points and trace information that can be collected in the case of callback method to the user

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-137 Details of trace collection points in the case of callback method to the user

Event ID | No. in the figure#1 | Trace acquisition points | Level
0xA390 | 1 | Immediately before invoking the PrePersist() callback method | A
0xA391 | 2 | Immediately after returning from the PrePersist() callback method | A
0xA392 | 1 | Immediately before invoking the PostPersist() callback method | A
0xA393 | 2 | Immediately after returning from the PostPersist() callback method | A
0xA394 | 1 | Immediately before invoking the PreRemove() callback method | A
0xA395 | 2 | Immediately after returning from the PreRemove() callback method | A
0xA396 | 1 | Immediately before invoking the PostRemove() callback method | A
0xA397 | 2 | Immediately after returning from the PostRemove() callback method | A
0xA398 | 1 | Immediately before invoking the PreUpdate() callback method | A
0xA399 | 2 | Immediately after returning from the PreUpdate() callback method | A
0xA39A | 1 | Immediately before invoking the PostUpdate() callback method | A
0xA39B | 2 | Immediately after returning from the PostUpdate() callback method | A
0xA39C | 1 | Immediately before invoking the PostLoad() callback method | A
0xA39D | 2 | Immediately after returning from the PostLoad() callback method | A

Legend:

A: Standard

#1

Corresponds to the numbers in Figure 8-82.

The following figure shows the trace collection points.

Figure 8-82 Trace collection points of the callback method to the user

(2) Trace information that can be collected

The following table describes the trace information that can be collected in the case of the callback method to the user.

Table 8-138 Trace information that can be collected in the case of the callback method to the user

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA390 | A | Callback method name specified by the user | -- | --
0xA392 | A | -- | --
0xA394 | A | -- | --
0xA396 | A | -- | --
0xA398 | A | -- | --
0xA39A | A | -- | --
0xA39C | A | -- | --
2 | 0xA391 | A | Callback method name specified by the user | -- | #2
0xA393 | A | -- | #2
0xA395 | A | -- | #2
0xA397 | A | -- | #2
0xA399 | A | -- | #2
0xA39B | A | -- | #2
0xA39D | A | -- | #2

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-82.

#2

When an exception occurs, the exception is displayed.

8.21.8 Trace collection points and trace information that can be collected during binary conversion of the entity class

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-139 Details of trace collection points during the binary conversion of the entity class

Event ID | No. in the figure#1 | Trace acquisition points | Level
0xA330 | 1 | Immediately before the binary conversion processing for the entity class starts | B
0xA331 | 2 | Immediately after the binary conversion processing for the entity class is complete | B

Legend:

B: Advanced

#1

Corresponds to the numbers in Figure 8-83.

The following figure shows the trace collection points.

Figure 8-83 Trace collection points during binary conversion of the entity class

Hint

In an application using JPA, this trace information is collected even for classes other than the entity class, when the class is loaded from the class loader.

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the binary conversion of the entity class.

Table 8-140 Trace information that can be collected during the binary conversion of the entity class

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA330 | B | -- | -- | --
2 | 0xA331 | B | -- | -- | #2

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-83.

#2

When an exception occurs, the exception is displayed.

8.21.9 Trace collection points and trace information that can be collected during transaction linkage with the transaction manager

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-141 Details of trace collection points during transaction linkage with the transaction manager

Event ID | No. in the figure#1 | Trace acquisition points | Level
0xA39E | 1 | Immediately before the process for correlating the persistent context and transaction starts | B
0xA39F | 2 | Immediately after the process for correlating the persistent context and transaction is complete | B
0xA3A0 | 3 | Immediately before the pre-processing of the JTA transaction conclusion starts | B
0xA3A1 | 4 | Immediately after the pre-processing of the JTA transaction conclusion ends | B
0xA3A2 | 5 | Immediately before the post-processing of the JTA transaction conclusion starts | B
0xA3A3 | 6 | Immediately after the post-processing of the JTA transaction conclusion ends | B

Legend:

B: Advanced

#1

Corresponds to the numbers in Figure 8-84.

The following figure shows the trace collection points.

Figure 8-84 Trace collection points during transaction linkage with the transaction manager

(2) Trace information that can be collected

The following table describes the trace information that can be collected during transaction linkage with the transaction manager.

Table 8-142 Trace information that can be collected during transaction linkage with the transaction manager

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA39E | B | -- | -- | --
2 | 0xA39F | B | -- | -- | #2
3 | 0xA3A0 | B | -- | -- | --
4 | 0xA3A1 | B | -- | -- | #2
5 | 0xA3A2 | B | -- | Status (int value of javax.transaction.Status) of the transaction passed by an argument of afterCompletion() | --
6 | 0xA3A3 | B | -- | -- | #2

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-84.

#2

When an exception occurs, the exception is displayed.

8.21.10 Trace collection points and trace information that can be collected during the connection operation of the DB Connector

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-143 Details of trace collection points during the connection operation of the DB Connector

Event ID | No. in the figure# | Trace acquisition points | Level
0xA3A4 | 1 | Immediately before invoking DataSource#getConnection() | B
0xA3A5 | 2 | Immediately after returning from DataSource#getConnection() | B
0xA3A6 | 1 | Immediately before invoking DataSource#getConnection(String, String) | B
0xA3A7 | 2 | Immediately after returning from DataSource#getConnection(String, String) | B
0xA3A8 | 1 | Immediately before invoking DriverManager#getConnection(String, Properties) | B
0xA3A9 | 2 | Immediately after returning from DriverManager#getConnection(String, Properties) | B
0xA3AA | 1 | Immediately before invoking DriverManager#getConnection(String, String, String) | B
0xA3AB | 2 | Immediately after returning from DriverManager#getConnection(String, String, String) | B
0xA3AC | 9 | Immediately before invoking Connection#close() | B
0xA3AD | 10 | Immediately after returning from Connection#close() | B
0xA3AE | 7 | Immediately before invoking Connection#commit() | B
0xA3AF | 8 | Immediately after returning from Connection#commit() | B
0xA3B0 | 3 | Immediately before invoking Connection#createStatement() | B
0xA3B1 | 4 | Immediately after returning from Connection#createStatement() | B
0xA3B2 | 3 | Immediately before invoking Connection#prepareCall(String) | B
0xA3B3 | 4 | Immediately after returning from Connection#prepareCall(String) | B
0xA3B4 | 3 | Immediately before invoking Connection#prepareCall(String, int, int) | B
0xA3B5 | 4 | Immediately after returning from Connection#prepareCall(String, int, int) | B
0xA3B6 | 3 | Immediately before invoking Connection#prepareStatement(String) | B
0xA3B7 | 4 | Immediately after returning from Connection#prepareStatement(String) | B
0xA3B8 | 3 | Immediately before invoking Connection#prepareStatement(String, int, int) | B
0xA3B9 | 4 | Immediately after returning from Connection#prepareStatement(String , int, int) | B
0xA3BA | 7 | Immediately before invoking Connection#rollback() | B
0xA3BB | 8 | Immediately after returning from Connection#rollback() | B
0xA3BC | 5 | Immediately before invoking Statement#executeQuery(String) | B
0xA3BD | 6 | Immediately after returning from Statement#executeQuery(String) | B
0xA3BE | 5 | Immediately before invoking Statement#executeUpdate(String) | B
0xA3BF | 6 | Immediately after returning from Statement#executeUpdate(String) | B
0xA3C0 | 5 | Immediately before invoking PreparedStatemen#executeUpdate() | B
0xA3C1 | 6 | Immediately after returning from PreparedStatemen#executeUpdate() | B
0xA3C2 | 5 | Immediately before invoking PreparedStatemen#executeQuery() | B
0xA3C3 | 6 | Immediately after returning from PreparedStatemen#executeQuery() | B

Legend:

B: Advanced

#

Corresponds to the numbers in Figure 8-85.

The following figure shows the trace collection points.

Figure 8-85 Trace collection points during the connection operation of the DB Connector

(2) Trace information that can be collected

The following table describes the trace information that can be collected during the connection operation of the DB Connector.

Table 8-144 Trace information that can be collected during the connection operation of the DB Connector

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xA3A4 | B | -- | -- | --
0xA3A6 | B | -- | -- | --
0xA3A8 | B | -- | -- | --
0xA3AA | B | -- | -- | --
2 | 0xA3A5 | B | -- | -- | #2
0xA3A7 | B | -- | -- | #2
0xA3A9 | B | -- | -- | #2
0xA3AB | B | -- | -- | #2
3 | 0xA3B0 | B | -- | -- | --
0xA3B2 | B | -- | -- | --
0xA3B4 | B | -- | -- | --
0xA3B6 | B | -- | -- | --
0xA3B8 | B | -- | -- | --
4 | 0xA3B1 | B | -- | -- | #2
0xA3B3 | B | -- | -- | #2
0xA3B5 | B | -- | -- | #2
0xA3B7 | B | -- | -- | #2
0xA3B9 | B | -- | -- | #2
5 | 0xA3BC | B | -- | -- | --
0xA3BE | B | -- | -- | --
0xA3C0 | B | -- | -- | --
0xA3C2 | B | -- | -- | --
6 | 0xA3BD | B | -- | -- | #2
0xA3BF | B | -- | -- | #2
0xA3C1 | B | -- | -- | #2
0xA3C3 | B | -- | -- | #2
7 | 0xA3AE | B | -- | -- | --
0xA3BA | B | -- | -- | --
8 | 0xA3AF | B | -- | -- | #2
0xA3BB | B | -- | -- | #2
9 | 0xA3AC | B | -- | -- | --
10 | 0xA3AD | B | -- | -- | #2

Legend:

B: Advanced

--: Not applicable

#1

Corresponds to the numbers in Figure 8-85.

#2

When an exception occurs, the exception is displayed.

8.22 Trace collection points of the TP1 inbound integrated function

This section describes the trace collection points of the TP1 inbound integrated function and the trace information that can be collected.

Organization of this section

8.22.1 Trace collection points and PRF trace collection levels

8.22.2 Trace information that can be collected

8.22.1 Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels:

Organization of this subsection

(1) Details of trace collection points of the TP1 inbound integrated function

(2) Trace collection points of the TP1 inbound integrated function

(3) Trace point collection in synchronous point processing

(1) Details of trace collection points of the TP1 inbound integrated function

The following table describes the details of trace collection points of the TP1 inbound integrated function.

Table 8-145 Details of trace collection points of the TP1 inbound integrated function

Event ID
Number in the figure#
Trace collection point
Level

0x842F
19
Immediately after invoking the message listener method of Message-driven Bean from the resource adapter
A

0x8430
22
Immediately before the message listener method of Message-driven Bean that is invoked from the resource adapter returns
A

0x8431
20
Immediately before the EJB container calls back the message listener method of Message-driven Bean
A

0x8432
21
Immediately after returning from the callback of the message listener method of Message-driven Bean
A

0x8825
17
Immediately before the completion of recreate process of the transaction
B

0x8826
18
Immediately after the completion of recreate process of the transaction
B

0x8B86
14
Immediately after invoking the method of javax.resource.spi.work.WorkManager
A

0x8B87
15
Immediately before returning the method of javax.resource.spi.work.WorkManager
A

0x8B8A
16
Immediately before invoking the method of javax.resource.spi.work.Work
A

0x8B8B
29
Immediately after returning the method of javax.resource.spi.work.Work
A

0x8B8C
33
Immediately after invoking javax.resource.spi.XATerminator.prepare (Xid xid)
B

0x8B8D
34
Immediately before returning javax.resource.spi.XATerminator.prepare (Xid xid)
B

0x8B8E
--
Immediately after invoking javax.resource.spi.XATerminator.commit (Xid xid, boolean onePhase)
B

0x8B8F
--
Immediately before returning javax.resource.spi.XATerminator.commit (Xid xid, boolean onePhase)
B

0x8B90
--
Immediately after invoking javax.resource.spi.XATerminator.rollback (Xid xid)
B

0x8B91
--
Immediately before returning javax.resource.spi.XATerminator.rollback (Xid xid)
B

0x8B92
--
Immediately after invoking javax.resource.spi.XATerminator.forget (Xid xid)
B

0x8B93
--
Immediately before returning javax.resource.spi.XATerminator.forget (Xid xid)
B

0xAA00
8
Immediately after the message reception starts
A

0xAA01
12
Immediately after the sending of RPC response is completed
A

0xAA02
4
Immediately after the reading of the message from OpenTP1 starts
A

0xAA03
10
Immediately before disconnecting from OpenTP1 (when rpc_close_after_send=Y is specified in OpenTP1 definition)
A

0xAA04
5
Immediately before invoking socket read
B

0xAA05
6
Immediately after completing socket read
B

0xAA06
13
Immediately before inserting the message into the schedule queue once the message reception is completed.
A

0xAA08
23
Immediately before the sending of RPC response starts
A

0xAA09
27
Immediately before disconnecting the connection for response (when rpc_close_after_send=true is specified in TP1 inbound adaptor property)
A

0xAA0A
25
Immediately before invoking socket write
B

0xAA0B
26
Immediately after completing socket write
B

0xAA0C
30
Sending has failed. Immediately before the standby for retry starts
A

0xAA0D
31
Immediately before retry starts
A

0xAA10
11

Immediately after disconnecting the connection, if an invalid message is received

Immediately after disconnecting the connection, if reception timeout occurs

Immediately after reception timer monitoring thread detects reception timeout for RPC requests and destroys the message

A

0xAA11
28
Immediately after an attempt to send the RPC response fails
A

0xAA12
2
Immediately before including the connection with OpenTP1 in reception monitoring
B

0xAA13
3
When message reception is detected in the connection with OpenTP1
B

0xAA14
32
Immediately after the completion of reception from OpenTP1 during synchronization point processing
A

0xAA15
35
Immediately after the completion of sending to OpenTP1 during synchronization point processing or immediately after an error occurs in the sending process
A

0xAA16
1
Immediately after the connection with OpenTP1 is established
A

0xAA17
9
Immediately before disconnecting the connection with OpenTP1 or immediately after disconnection from OpenTP1, since a communication error is detected
A

0xAA18
7
Immediately after analyzing the received message
B

0xAA19
24
Immediately before sending the message
B

Legend:

A: Standard

B: Advanced

--: Not applicable

#

Corresponds to the numbers from Figures 8-86 to 8-92.

(2) Trace collection points of the TP1 inbound integrated function

The following figure shows the overall trace collection points in the TP1 inbound integrated function. Note that there are detailed trace collections points for A and B parts of the figure.

Figure 8-86 Overall trace collection points in the TP1 inbound integrated function

The following two figures show the detailed trace collections points for A and B parts in the above figure.

Figure 8-87 Trace collection points of part A

#1

Nothing is output, if an exception occurs in read.

#2

This is output after message reception. For segmented mails, the output is generated for each segmented mail. However, nothing is output for invalid messages.

#3

For processing of RPC response sending (PRF trace collection points other than 0xAA01), see Figure 8-88.

In addition to Figure 8-87, the PRF trace collection point for RPC reception is 0xAA10 that is output immediately after the reception timer monitoring thread detects a reception timeout for RPC requests and destroys the message.

Figure 8-88 Trace collection points of part B

For the PRF trace output point of response sending in Figure 8-88, the trace is not only output during RPC communication, but also when J2EE applications stop. The root application information at this time is not the root application information inherited from OpenTP1, but the root application information generated by the J2EE server. Therefore, use the root application information, output to the interface name of 0xAA08 when the J2EE applications stop, to associate the PRF trace output points for stopping J2EE applications and the other PRF trace output points for RPC communication.

(3) Trace point collection in synchronous point processing

The following figure describes the trace collection points in the synchronous point processing. Note that points A and B in the figure have further detailed trace collection points.

Figure 8-89 Overview of the trace collection points in the synchronous point processing

#1

When the processing request is passed on to XATerminator, different Event IDs are output for each method. The following table describes the mapping between each method and its Event ID.

Table 8-146 Method and Event ID mapping

Method | Event ID | Number used in the figure
prepare method | 0x8B8C | 33
commit method | 0x8B8E | --
rollback method | 0x8B90 | --
forget method | 0x8B92 | --

Legend:

--: Not used in the figure

#2

For OTS output points, see 8.16 Trace collection points of an OTS.

#3

When the processing request is passed on from XATerminator to the synchronous point mail sending thread, different Event IDs are output for each method. The following table describes the mapping between each method and its Event ID.

Table 8-147 Method and Event ID mapping

Method | Event ID | Number used in the figure
prepare method | 0x8B8D | 34
commit method | 0x8B8F | --
rollback method | 0x8B91 | --
forget method | 0x8B93 | --

Legend:

--: Not used in the figure

For the detailed trace collection points of A and B in the figure, see the following 2 figures.

Figure 8-90 Trace collection point of the A part in the synchronous point processing

#1

Nothing is output, if read throws an exception.

#2

Outputs after receiving the mail. For segmented mails, output is generated for each segmented mail. However, nothing is output, for invalid mails.

Figure 8-91 Trace collection point of the B part in the synchronous point processing

The following figure shows the trace collection points for the connection count adjustment thread.

Figure 8-92 Trace collection points for the connection count adjustment thread

8.22.2 Trace information that can be collected

The following table describes the trace information that can be collected for the TP1 inbound integrated function.

Table 8-148 Trace information that can be collected for the TP1 inbound integrated function

Number in the figure#1
Event ID
Level
Information that can be collected

Interface name
Operation name
Option

1
0xAA16
A
IP address of OpenTP1: listen port number of OpenTP1#2
--
Listen port number of TP1 inbound adapter side

2
0xAA12
B
IP address of OpenTP1: listen port number of OpenTP1#2
--
Listen port number of TP1 inbound adapter side

3
0xAA13
B
IP address of OpenTP1: listen port number of OpenTP1#2
--
Listen port number of TP1 inbound adapter side

4
0xAA02
A
IP address of OpenTP1: listen port number of OpenTP1#2
--
Listen port number of TP1 inbound adapter side

5
0xAA04
B
Request size
--
--

6
0xAA05
B
Read size
--
--

7
0xAA18
B
IP address of OpenTP1: listen port number of OpenTP1#2
Message type
Listen port number of TP1 inbound adapter side

8
0xAA00
A
Service group name
Service name
Node identifier of OpenTP1 that invokes the service#3, transaction global identifier (for transactional RPC)

9
0xAA17
A
IP address of OpenTP1: listen port number of OpenTP1#2
--
Listen port number of TP1 inbound adapter side

10
0xAA03
A
IP address of OpenTP1: listen port number of OpenTP1#2
--
Listen port number of TP1 inbound adapter side

11
0xAA10
A
Service group name#4
Service name #5
Entrance time

12
0xAA01
A
Service group name
Service name
When successful: Entrance time
In the case of an error: Entrance time and error response code

13
0xAA06
A
Service group name
Service name
Node identifier of OpenTP1 that invokes the service#3 , number of messages in the queue

14
0x8B86
A
Work class name
Method name
Resource adapter display name

15
0x8B87
A
Work class name
Method name
When normal: Entrance time
In the case of an error: Entrance time and exception

16
0x8B8A
A
Work class name
Method name
Resource adapter display name

17
0x8825
B
--
--
Global transaction ID of OpenTP1 (byte column)

18
0x8826
B
--
--
When normal: Entrance time
For an error: Entrance time and exception

19
0x842F
A
Bean name
Method name
-

20
0x8431
A
Bean name
Method name
-

21
0x8432
A
Bean name
Method name
When normal: Entrance time
For an error: Entrance time and exception

22
0x8430
A
Bean name
Method name
When normal: Entrance time
In the case of an error: Entrance time and exception

23
0xAA08
A
Root application information#6
--
--

24
0xAA19
B
IP address of OpenTP1: listen port number of OpenTP1#2
Message type
Listen port number of TP1 inbound adapter side

25
0xAA0A
B
Writing size
--
--

26
0xAA0B
B
Written size
--
--

27
0xAA09
A
IP address of OpenTP1: listen port number of OpenTP1#2
--
Listen port number of TP1 inbound adapter side

28
0xAA11
A
Service group name
Service name
Entrance time

29
0x8B8B
A
Work class name
Method name
When normal: Entrance time
For an error: Entrance time and exception

30
0xAA0C
A
--
--
--

31
0xAA0D
A
--
--
--

32
0xAA14
A
Node identifier of OpenTP1
Output one of the following

prepare

commit

rollback

Transaction global identifier

33
0x8B8C
B
--
--
Global transaction ID of xid argument of XATerminator (byte column)

34
0x8B8D
B
--
--
When normal: Entrance time
For an error: Entrance time and exception

35
0xAA15
A
--
In normal cases output one of the following:#7

prepared

read only

committed

rolled back

No output in the case of an error.
Entrance time

--
0x8B8E
B
--
--
Global transaction ID of xid argument of XATerminator (byte column)

--
0x8B8F
B
--
--
When normal: Entrance time
For an error: Entrance time and exception

--
0x8B90
B
--
--
Global transaction ID of xid argument of XATerminator (byte column)

--
0x8B91
B
--
--
When normal: Entrance time
For an error: Entrance time and exception

--
0x8B92
B
--
--
Global transaction ID of xid argument of XATerminator (byte column)

--
0x8B93
B
--
--
When normal: Entrance time
For an error: Entrance time and exception

Legend:

A: Standard

B: Advanced

--: Not applicable

#1

Corresponds to the numbers from Figures 8-86 to 8-92.

#2

If the listen port of OpenTP1 cannot be determined, "IP address of OpenTP1: --" is output.

#3

If the PRF information is inherited from OpenTP1 that invokes the service, "root RPC node identifier" is output. If the information is not inherited, "invocation source node ID" is output.

#4

If the service group name output in the interface name cannot be determined, "--" is output.

#5

If the service name output in the operation name cannot be determined, "--" is output.

#6

Outputs only when the J2EE applications stop. The following contents are output:

If the PRF information is inherited from OpenTP1 that invokes the service, the root application information inherited from OpenTP1 is output.

If the PRF information is not inherited from OpenTP1 that invokes the service, the root application information numbered by the TP1 inbound adapter is output.

#7

These are output in the following respective conditions:

prepared: When prepare is completed

read only: When the transaction setting of Message-driven Bean (service) that is executed is CMT NotSupported or BMT

committed: When commit is completed

rolled back: When rollback is completed. This includes the cases when the result of prepare and commit is treated as rollback.

8.23 Trace collection points of Cosminexus JMS Provider

This section describes the trace collection points of Cosminexus JMS Provider and the trace information that can be collected.

Organization of this section

8.23.1 Trace collection points of the JMS ConnectionFactory interface and the trace information that can be collected

8.23.2 Trace collection points of the JMS Connection interface and the trace information that can be collected

8.23.3 Trace collection points of the JMS session interface and the trace information that can be collected

8.23.4 Trace collection points of the JMS messages, producer, consumer, and queue browser and the trace information that can be collected

8.23.5 Trace collection points of CJMSP Broker when connecting to the CJMSP resource adapter and the trace information that can be collected

8.23.6 Trace collection points of the transaction management in the CJMSP resource adapter and trace information that can be collected

8.23.7 Trace collection points when Message-driven Bean is deployed from the CJMSP resource adapter and the trace information that can be collected

8.23.1 Trace collection points of the JMS ConnectionFactory interface and the trace information that can be collected

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-149 Details of the trace collection points in the JMS ConnectionFactory interface

Event ID | Number in the figure# | Trace collection point | Level
0xA600 | 1 | When the processing of ConnectionFactory.createConnection() starts | A
0xA601 | 4 | When the processing of ConnectionFactory.createConnection() ends | A
0xA602 | 1 | When the processing of ConnectionFactory.createConnection(uname,pwd) starts | A
0xA603 | 4 | When the processing of ConnectionFactory.createConnection(uname,pwd) ends | A
0xA604 | 1 | When the processing of QueueConnectionFactory.createQueueConnection()starts | A
0xA605 | 4 | When the processing of QueueConnectionFactory.createQueueConnection()ends | A
0xA606 | 1 | When the processing of QueueConnectionFactory.createQueueConnection(uname,pwd) starts | A
0xA607 | 4 | When the processing of QueueConnectionFactory.createQueueConnection(uname,pwd) ends | A
0xA608 | 1 | When the processing of TopicConnectionFactory.createTopicConnection() starts | A
0xA609 | 4 | When the processing of TopicConnectionFactory.createTopicConnection() ends | A
0xA60A | 1 | When the processing of TopicConnectionFactory.createTopicConnection(uname,pwd) starts | A
0xA60B | 4 | When the processing of TopicConnectionFactory.createTopicConnection(uname,pwd) ends | A
0xA60C | 2 | When the processing of ManagedConnectionFactory.matchManagedConnections() starts | B
0xA60D | 3 | When the processing of ManagedConnectionFactory.matchManagedConnections() ends | B

Legend:

A: Standard

B: Advanced

#

Corresponds to the numbers in Figure 8-93.

The following figure shows the trace collection points of the JMS ConnectionFactory interface.

Figure 8-93 Trace collection points in JMS ConnectionFactory interface

(2) Trace information that can be collected

Trace information (interface name, operation name, and option) cannot be collected for the JMS ConnectionFactory interface.

8.23.2 Trace collection points of the JMS Connection interface and the trace information that can be collected

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-150 Details of the trace collection points in JMS Connection interface

Event ID | Number in the figure# | Trace collection point | Level
0xA60E | 1 | When the processing of Connection.createSession(transacted,acknowledgeMode) starts | A
0xA60F | 4 | When the processing of Connection.createSession(transacted,acknowledgeMode) ends | A
0xA610 | 1 | When the processing of QueueConnection.createQueueSession(transacted,acknowledgeMode) starts | A
0xA611 | 4 | When the processing of QueueConnection.createQueueSession(transacted,acknowledgeMode) ends | A
0xA612 | 1 | When the processing of TopicConnection.createTopicSession(transacted,acknowledgeMode) starts | A
0xA613 | 4 | When the processing of TopicConnection.createTopicSession(transacted,acknowledgeMode) ends | A
0xA614 | 5 | When the processing of Connection.close() starts | A
0xA615 | 8 | When the processing of Connection.close() ends | A
0xA616 | 2 | Invocation by CJMSP Broker immediately before creating the session | A
0xA617 | 3 | Invocation by CJMSP Broker just after creating the session | A
0xA618 | 6 | Invocation by CJMSP Broker immediately before disconnection | A
0xA619 | 7 | Invocation by CJMSP Broker just after disconnection | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-94.

The following figure shows the trace collection points of the JMS Connection interface.

Figure 8-94 Trace collection points of the JMS Connection interface

(2) Trace information that can be collected

The following table describes the trace information that can be collected for the JMS Connection interface.

Table 8-151 Trace information that can be collected for the JMS Connection interface

Number in the figure# | Event ID | Level | Information that can be collected
Interface name | Operation name | Option
1 | 0xA60E | A | Transaction | Ack mode | N
0xA610 | A
0xA612 | A
2 | 0xA616 | A | N | N | N
3 | 0xA617 | A | N | N | N
4 | 0xA60F | A | N | N | N
0xA611 | A
0xA613 | A
5 | 0xA614 | A | N | N | N
6 | 0xA618 | A | N | N | N
7 | 0xA619 | A | N | N | N
8 | 0xA615 | A | N | N | N

Legend:

A: Standard

N: Not applicable

#

Corresponds to the numbers in Figure 8-94.

Note

The event IDs 0xA618 and 0xA619 are also output when the Message-driven Bean applications are not running.

Reference note

The Acknowledgement mode is output using a numerical value. The numerical value is mapped to the types of Acknowledgement modes. The mapping is as follows:

AUTO_ACKNOWLEDGE = 1

CLIENT_ACKNOWLEDGE = 2

DUPS_OK_ACKNOWLEDGE = 3

SESSION_TRANSACTED = 0

The numerical values of the respective modes are defined in the JMS specifications.

8.23.3 Trace collection points of the JMS session interface and the trace information that can be collected

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-152 Details of trace collection points in the JMS session interface

Event ID | Number in the figure# | Trace collection point | Level
0xA61E | 5 | When the processing of Session.createSubscriber(topic) starts | A
0xA61F | 8 | When the processing of Session.createSubscriber(topic) ends | A
0xA620 | 1 | When the processing of Session.createBrowser(queue) starts | A
0xA621 | 4 | When the processing of Session.createBrowser(queue) ends | A
0xA622 | 1 | When the processing of Session.createBrowser(queue,selector) starts | A
0xA623 | 4 | When the processing of Session.createBrowser(queue,selector) ends | A
0xA624 | 5 | When the processing of Session.createSubscriber(topic,selector,noLocal) starts | A
0xA625 | 8 | When the processing of Session.createSubscriber(topic,selector,noLocal) ends | A
0xA626 | 5 | When the processing of Session.createDurableSubscriber(topic,name) starts | A
0xA627 | 8 | When the processing of Session.createDurableSubscriber(topic,name) ends | A
0xA628 | 5 | When the processing of Session.createDurableSubscriber(topic,name,selector,noLocal) starts | A
0xA629 | 8 | When the processing of Session.createDurableSubscriber(topic,name,selector,noLocal) ends | A
0xA62A | 5 | When the processing of Session.createConsumer(destination) starts | A
0xA62B | 8 | When the processing of Session.createConsumer(destination) ends | A
0xA62C | 5 | When the processing of Session.createConsumer(destination,selector) starts | A
0xA62D | 8 | When the processing of Session.createConsumer(destination,selector) ends | A
0xA62E | 5 | When the processing of Session.createConsumer(destination,selector,noLocal) starts | A
0xA62F | 8 | When the processing of Session.createConsumer(destination,selector,noLocal) ends | A
0xA630 | 5 | When the processing of Session.createReceiver(queue) starts | A
0xA631 | 8 | When the processing of Session.createReceiver(queue) ends | A
0xA632 | 5 | When the processing of Session.createReceiver(queue,selector) starts | A
0xA633 | 8 | When the processing of Session.createReceiver(queue,selector) ends | A
0xA634 | 9 | When the processing of Session.createPublisher(topic) starts | A
0xA635 | 12 | When the processing of Session.createPublisher(topic) ends | A
0xA636 | 9 | When the processing of Session.createProducer(destination) starts | A
0xA637 | 12 | When the processing of Session.createProducer(destination) ends | A
0xA638 | 9 | When the processing of Session.createSender(queue) starts | A
0xA639 | 12 | When the processing of Session.createSender(queue) ends | A
0xA63A | 13 | When the processing of Session.createQueue() starts | A
0xA63B | 16 | When the processing of Session.createQueue() ends | A
0xA63C | 13 | When the processing of Session.createTopic() starts | A
0xA63D | 16 | When the processing of Session.createTopic() ends | A
0xA63E | 13 | When the processing of Session.createTemporaryQueue() starts | A
0xA63F | 16 | When the processing of Session.createTemporaryQueue() ends | A
0xA640 | 13 | When the processing of Session.createTemporaryTopic() starts | A
0xA641 | 16 | When the processing of Session.createTemporaryTopic() ends | A
0xA642 | 17 | When the processing of Session.unsubscribe() starts | A
0xA643 | 20 | When the processing of Session.unsubscribe() ends | A
0xA644 | 21 | When the processing of Session.commit() starts | A
0xA645 | 24 | When the processing of Session.commit() ends | A
0xA646 | 21 | When the processing of Session.rollback() starts | A
0xA647 | 24 | When the processing of Session.rollback() ends | A
0xA648 | 25 | When the processing of Session.recover() starts | A
0xA649 | 26 | When the processing of Session.recover() ends | A
0xA64A | 25 | When the processing of Session.close() starts | A
0xA64B | 26 | When the processing of Session.close() ends | A
0xA64C | 2 | Invocation by CJMSP Broker immediately before invoking destination authentication for the browser | A
0xA64D | 3 | Invocation by CJMSP Broker just after invoking destination authentication for the browser | A
0xA64E | 6 | Invocation by CJMSP Broker immediately before invoking consumer | A
0xA64F | 7 | Invocation by CJMSP Broker just after invoking consumer | A
0xA650 | 10 | Invocation by CJMSP Broker immediately before invoking producer | A
0xA651 | 11 | Invocation by CJMSP Broker just after invoking producer | A
0xA652 | 14 | Invocation by CJMSP Broker immediately before invoking create destination | A
0xA653 | 15 | Invocation by CJMSP Broker just after invoking create destination | A
0xA654 | 18 | Invocation by CJMSP Broker immediately before invoking create persistence subscriber | A
0xA655 | 19 | Invocation by CJMSP Broker just after invoking create persistence subscriber | A
0xA656 | 22 | Invocation by CJMSP Broker immediately before invoking session commit | A
0xA657 | 23 | Invocation by CJMSP Broker just after invoking session commit | A
0xA658 | 22 | Invocation by CJMSP Broker immediately before invoking session rollback | A
0xA659 | 23 | Invocation by CJMSP Broker just after invoking session rollback | A
0xA65A | 22 | Invocation by CJMSP Broker immediately before invoking session recovery | A
0xA65B | 23 | Invocation by CJMSP Broker just after invoking session recovery | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-95.

Note

The methods corresponding to the event IDs 0xA644 and 0xA645, 0xA646 and 0x647, Session.commit(), and Session.rollback() are not supported.

The event IDs 0xA65A and 0xA65B are not output.

The event IDs are output when XATransaction is used.

The following figure shows the trace collection points in the JMS session interface.

Figure 8-95 Trace collection points in the JMS session interface

Reference note

destination is created during the creation of producer or consumer. Therefore, the event IDs 0xa652 and 0xa653 might be invoked in the createProducer() and createConsumer() methods.

(2) Trace information that can be collected

The following table describes the trace information that can be collected for the JMS session interface.

Table 8-153 Trace information that can be collected for the JMS session interface

Number in the figure# | Event ID | Level | Information that can be collected
Interface name | Operation name | Option
1 | 0xA620 | A | Queue name | N | N
0xA622 | A | Selector string
2 | 0xA64C | A | N | N | N
3 | 0xA64D | A | N | N | N
4 | 0xA621 | A | N | N | N
0xA623 | A
5 | 0xA61E | A | Topic name | N | N
0xA624 | A | Selector string
0xA626 | A | N
0xA628 | A | Selector string
0xA62A | A | Destination name | N
0xA62C | A | Selector string
0xA62E | A
0xA630 | A | Queue name | N
0xA632 | A | Selector string
6 | 0xA64E | A | N | N | N
7 | 0xA64F | A | N | N | N
8 | 0xA61F | A | N | N | N
0xA625 | A
0xA627 | A
0xA629 | A
0xA62B | A
0xA62D | A
0xA62F | A
0xA631 | A
0xA633 | A
9 | 0xA634 | A | Topic name | N | N
0xA636 | A | Destination name | N | N
0xA638 | A | Queue name | N | N
10 | 0xA650 | A | N | N | N
11 | 0xA651 | A | N | N | N
12 | 0xA635 | A | N | N | N
0xA637 | A
0xA639 | A
13 | 0xA63A | A | Queue name | N | N
0xA63C | A | Topic name | N | N
0xA63E | A | N | N | N
0xA640 | A
14 | 0xA652 | A | N | N | N
15 | 0xA653 | A | N | N | N
16 | 0xA63B | A | N | N | N
0xA63D | A
0xA63F | A
0xA641 | A
17 | 0xA642 | A | N | N | N
18 | 0xA654 | A | N | N | N
19 | 0xA655 | A | N | N | N
20 | 0xA643 | A | N | N | N
21 | 0xA644 | A | N | N | N
0xA646 | A
0xA648 | A
22 | 0xA656 | A | N | N | N
0xA658 | A
0xA65A | A
23 | 0xA657 | A | N | N | N
0xA659 | A
0xA65B | A
24 | 0xA645 | A | N | N | N
0xA647 | A
0xA649 | A
25 | 0xA64A | A | N | N | N
26 | 0xA64B | A | N | N | N

Legend:

A: Standard

N: Not applicable

#

Corresponds to the numbers in Figure 8-95.

8.23.4 Trace collection points of the JMS messages, producer, consumer, and queue browser and the trace information that can be collected

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-154 Details of the trace collection points in the JMS messages, producer, consumer, and queue browser

Event ID | Number in the figure# | Trace collection point | Level
0xA65C | 1 | When the processing of MessageProducer.send(msg) starts | A
0xA65D | 4 | When the processing of MessageProducer.send(msg) ends | A
0xA65E | 1 | When the processing of MessageProducer.send(msg,deliveryMode,priority,timeToLive) starts | A
0xA65F | 4 | When the processing of MessageProducer.send(msg,deliveryMode,priority,timeToLive) ends | A
0xA660 | 1 | When the processing of MessageProducer.send(destination,msg) starts | A
0xA661 | 4 | When the processing of MessageProducer.send(destination,msg) ends | A
0xA662 | 1 | When the processing of MessageProducer.send(destination,msg,deliveryMode,priority,timeToLive) starts | A
0xA663 | 4 | When the processing of MessageProducer.send(destination,msg,deliveryMode,priority,timeToLive) ends | A
0xA664 | 9 | When the processing of MessageProducer.close() starts | A
0xA665 | 10 | When the processing of MessageProducer.close() ends | A
0xA666 | 5 | When the processing of MessageConsumer.receive() starts | A
0xA667 | 8 | When the processing of MessageConsumer.receive() ends | A
0xA61A | 5 | When the processing of MessageConsumer.receive(timeout) starts | A
0xA61B | 8 | When the processing of MessageConsumer.receive(timeout) ends | A
0xA668 | 5 | When the processing of MessageConsumer.receiveNoWait() starts | A
0xA669 | 8 | When the processing of MessageConsumer.receiveNoWait() ends | A
0xA66A | 9 | When the processing of MessageConsumer.close() starts | A
0xA66B | 10 | When the processing of MessageConsumel.close() ends | A
0xA66C | 11 | When the processing of QueueBrowser.getEnumeration() starts | A
0xA66D | 14 | When the processing of QueueBrowser.getEnumeration() ends | A
0xA66E | 15 | When the processing of Message.acknowledge() starts | A
0xA66F | 18 | When the processing of Message.acknowledge() ends | A
0xA670 | 2 | Invocation by CJMSP Broker immediately before invoking the writing of the JMS messages | A
0xA671 | 3 | Invocation by CJMSP Broker just after invoking the writing of the JMS messages | A
0xA672 | 6 | Invocation by CJMSP Broker immediately before invoking the receiving of the JMS messages | A
0xA673 | 7 | Invocation by CJMSP Broker just after invoking the receiving of the JMS messages | A
0xA674 | 12 | Invocation by CJMSP Broker immediately before invoking the delivery of all the JMS messages | A
0xA675 | 13 | Invocation by CJMSP Broker just after invoking the delivery of all the JMS messages | A
0xA676 | 16 | Invocation by CJMSP Broker immediately before invoking the authentication of the JMS messages | A
0xA677 | 17 | Invocation by CJMSP Broker just after invoking the authentication of the JMS messages | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-96.

Note

When Transaction is used, or when the acknowledgement mode is not set to CLIENT_ACKNOWLEDGE, and if a message is received, the event IDs 0xA676 and 0xA677 are output.

When a Message-driven Bean is executed, the root application information for the event IDs 0xA672 and 0xA673 becomes invalid.

The following figure shows the trace collection points in the JMS messages, producer, consumer, and queue browser.

Figure 8-96 Trace collection points of the JMS messages, producer, consumer, and queue browser

(2) Trace information that can be collected

The following table describes the trace information that can be collected for the JMS messages, producer, consumer, and queue browser.

Table 8-155 Trace information that can be collected for the JMS messages, producer, consumer, and queue browser

Number in the figure# | Event ID | Level | Information that can be collected
Interface name | Operation name | Option
1 | 0xA65C | A | Destination name | N | N
0xA65E | A | Priority
0xA660 | A | N
0xA662 | A | Priority
2 | 0xA670 | A | N | N | N
3 | 0xA671 | A | N | N | N
4 | 0xA65D | A | N | N | N
0xA65F | A
0xA661 | A
0xA663 | A
5 | 0xA666 | A | Destination name | 0 | N
0xA61A | A | Timeout
0xA668 | A | N
6 | 0xA672 | A | N | N | N
7 | 0xA673 | A | N | N | N
8 | 0xA667 | A | N | N | N
0xA61B | A
0xA669 | A
9 | 0xA664 | A | N | N | N
0xA66A | A
10 | 0xA665 | A | N | N | N
0xA66B | A
11 | 0xA66C | A | N | N | N
12 | 0xA674 | A | N | N | N
13 | 0xA675 | A | N | N | N
14 | 0xA66D | A | N | N | N
15 | 0xA66E | A | N | N | N
16 | 0xA676 | A | N | N | N
17 | 0xA677 | A | N | N | N
18 | 0xA66F | A | N | N | N

Legend:

A: Standard

N: Not applicable

#

Corresponds to the numbers in Figure 8-96.

8.23.5 Trace collection points of CJMSP Broker when connecting to the CJMSP resource adapter and the trace information that can be collected

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-156 Details of trace collection points in CJMSP Broker when connecting to the CJMSP resource adapter

Event ID | Number in the figure# | Trace collection points | Level
0xA678 | 1 | When the processing of ResourceAdapter.start(ctx) starts | A
0xA679 | 4 | When the processing of ResourceAdapter.start(ctx) ends | A
0xA67A | 5 | When the processing of ResourceAdapter.stop() starts | A
0xA67B | 8 | When the processing of ResourceAdapter.stop() ends | A
0xA67C | 2 | Invocation by CJMSP Broker immediately before invoking the hello method | A
0xA67D | 3 | Invocation by CJMSP Broker just after invoking the hello method | A
0xA67E | 6 | Invocation by CJMSP Broker immediately before invoking the good bye method | A
0xA67F | 7 | Invocation by CJMSP Broker just after invoking the good bye method | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-97.

Note

The event IDs 0xA67C and 0xA67D are also output when CJMSP Broker and the CJMSP resource adapter are communicating in order to establish the connection.

The following figure shows the trace collection points in CJMSP Broker when connecting to the CJMSP resource adapter.

Figure 8-97 Trace collection points of CJMSP Broker when connecting to the CJMSP resource adapter

(2) Trace information that can be collected

Trace information (interface name, operation name, and option) cannot be collected for CJMSP Broker when connecting to the CJMSP resource adapter.

8.23.6 Trace collection points of the transaction management in the CJMSP resource adapter and trace information that can be collected

Organization of this subsection

(1) Transaction management in the CJMSP resource adapter (for LocalTransaction)

(2) Transaction management in the CJMSP resource adapter (for XAResource)

(1) Transaction management in the CJMSP resource adapter (for LocalTransaction)

Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-157 Details of the trace collection points of the transaction management (for LocalTransaction) in the CJMSP resource adapter

Event ID | Number in the figure# | Trace collection point | Level
0xA656 | 6 | Invocation by CJMSP Broker immediately before invoking session commit | A
0xA657 | 7 | Invocation by CJMSP Broker just after invoking session commit | A
0xA658 | 6 | Invocation by CJMSP Broker immediately before invoking session rollback | A
0xA659 | 7 | Invocation by CJMSP Broker just after invoking session rollback | A
0xA686 | 1 | When the processing of LocalTransaction.begin() starts | A
0xA687 | 4 | When the processing of LocalTransaction.begin() ends | A
0xA688 | 5 | When the processing of LocalTransaction.commit() starts | A
0xA689 | 8 | When the processing of LocalTransaction.commit() ends | A
0xA68A | 5 | When the processing of LocalTransaction.rollback() starts | A
0xA68B | 8 | When the processing of LocalTransaction.rollback() ends | A
0xA68C | 2 | Invocation by CJMSP Broker immediately before the transaction starts | A
0xA68D | 3 | Invocation by CJMSP Broker just after the transaction starts | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-98.

The following figure shows the trace collection points of the transaction management in the CJMSP resource adapter (for LocalTransaction).

Figure 8-98 Trace collection points of the transaction management in the CJMSP resource adapter (for LocalTransaction)

Trace information that can be collected

Trace information (interface name, operation name, and option) cannot be collected for the transaction management in the CJMSP resource adapter (for LocalTransaction).

(2) Transaction management in the CJMSP resource adapter (for XAResource)

Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-158 Details of the trace collection points of the transaction management in the CJMSP resource adapter (for XAResource)

Event ID | Number in the figure# | Trace collection points | Level
0xA656 | 2 | Invocation by CJMSP Broker immediately before invoking session commit | A
0xA657 | 3 | Invocation by CJMSP Broker just after invoking session commit | A
0xA658 | 2 | Invocation by CJMSP Broker immediately before invoking session rollback | A
0xA659 | 3 | Invocation by CJMSP Broker just after invoking session rollback | A
0xA68C | 2 | Invocation by CJMSP Broker immediately before the transaction starts | A
0xA68D | 3 | Invocation by CJMSP Broker just after the transaction starts | A
0xA692 | 1 | When the processing of XAResource.start() starts | A
0xA693 | 4 | When the processing of XAResource.start() ends | A
0xA694 | 1 | When the processing of XAResource.end() starts | A
0xA695 | 4 | When the processing of XAResource.end() ends | A
0xA696 | 1 | When the processing of XAResource.prepare() starts | A
0xA697 | 4 | When the processing of XAResource.prepare() ends | A
0xA698 | 1 | When the processing of XAResource.commit() starts | A
0xA699 | 4 | When the processing of XAResource.commit() ends | A
0xA69A | 1 | When the processing of XAResource.rollback() starts | A
0xA69B | 4 | When the processing of XAResource.rollback() ends | A
0xA69E | 2 | Invocation by Broker immediately before invoking stop XAResource | A
0xA69F | 3 | Invocation by Broker just after invoking stop XAResource | A
0xA6A0 | 2 | Invocation by Broker immediately before preparing XAResource | A
0xA6A1 | 3 | Invocation by Broker just after preparing XAResource | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-99.

The following figure shows the trace collection points of the transaction management in the CJMSP resource adapter (for XAResource).

Figure 8-99 Trace collection points of the transaction management in the CJMSP resource adapter (for XAResource)

Trace information that can be collected

The following table describes the trace information that can be collected for the transaction management in the CJMSP resource adapter (for XAResource).

Table 8-159 Trace information that can be collected for the transaction management in the CJMSP resource adapter (for XAResource)

Number in the figure# | Event ID | Level | Information that can be collected
Interface name | Operation name | Option
1 | 0xA692 | A | Flag | N | N
0xA694 | A | Flag
0xA696 | A | N
0xA698 | A | Flag
0xA69A | A | N
2 | 0xA656 | A | N | N | N
0xA658 | A
0xA68C | A
0xA69E | A
0xA6A0 | A
3 | 0xA657 | A | N | N | N
0xA659 | A
0xA68D | A
0xA69F | A
0xA6A1 | A
4 | 0xA693 | A | N | N | N
0xA695 | A
0xA697 | A
0xA699 | A
0xA69B | A

Legend:

A: Standard

N: Not applicable

#

Corresponds to the numbers in Figure 8-99.

8.23.7 Trace collection points when Message-driven Bean is deployed from the CJMSP resource adapter and the trace information that can be collected

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-160 Details of trace collection points when Message-driven Bean is deployed from the CJMSP resource adapter

Event ID | Number in the figure# | Trace collection point | Level
0xA6A6 | 1 | When the processing of ResourceAdapter.endpointActivation(endpointFactory,spec) starts | A
0xA6A7 | 2 | When the processing of ResourceAdapter.endpointActivation(endpointFactory,spec) ends | A
0xA6A8 | 3 | When the processing of ResourceAdapter.endpointDeactivation(endpointFactory,spec) starts | A
0xA6A9 | 4 | When the processing of ResourceAdapter.endpointDeactivation(endpointFactory,spec) ends | A
0xA6AA | 5 | When the processing of MessageListener.onMessage() starts | A
0xA6AB | 6 | When the processing of MessageListener.onMessage() ends | A

Legend:

A: Standard

#:

Corresponds to the numbers in Figure 8-100.

Note

0xA67E and 0xA67F are output when you invoke endpointDeactivation().

0xA67C are 0xA67D are output when you invoke endpointActivation().

The following figure shows the trace collection points when Message-driven Bean is deployed from the CJMSP resource adapter.

Figure 8-100 Trace collection points when Message-driven Bean is deployed from the CJMSP resource adapter

(2) Trace information that can be collected

Trace information (interface name, operation name, and option) cannot be collected when Message-driven Bean is deployed from the CJMSP resource adapter.

8.24 Trace collection points of JavaMail

This section describes the trace collection points of JavaMail and the trace information that you can collect.

Organization of this section

8.24.1 Trace collection points of JavaMail transmission and the trace information that you can collect

8.24.2 Trace collection points on JavaMail receipt and the trace information that you can collect

8.24.1 Trace collection points of JavaMail transmission and the trace information that you can collect

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that you can collect

(1) Trace collection points and PRF trace collection levels

The following table describes the information such as Event ID, trace collection points, and PRF trace collection level.

Table 8-161 Details of trace collection points on JavaMail transmission

Event ID | Numbers used in the figures#1 | Trace collection point | Level
0xAD00 | 1 | Entry point of the connect(String host, int port, String user, String password) method of the javax.mail.Transport class | A
0xAD01 | 22 | Exit point of the connect(String host, int port, String user, String password) method of the javax.mail.Transport class | A
0xAD02 | 23 | Entry point of the sendMessage(Message message, Address[] addresses) method of the javax.mail.Transport class | A
0xAD03 | 38 | Exit point of the sendMessage(Message message, Address[] addresses) method of the javax.mail.Transport class | A
0xAD04 | 39 | Entry point of the close method of the javax.mail.Transport class | A
0xAD05 | 44 | Exit point of the close method of the javax.mail.Transport class | A
0xAD06 | 2 | Immediately before starting the process to fetch the connection | A
0xAD07 | 3 | Immediately after ending the process to fetch the connection | A
0xAD08 | 26#2 | Immediately before starting to send the entire recipient information | A
0xAD09 | 29#2 | Immediately after sending the entire recipient information | A
0xAD0A | 34#3 | Immediately before starting to send the mail | A
0xAD0B | 35#3 | Immediately after sending the mail | A
0xAD0C | 42 | Immediately before starting the process to terminate the connection | B
6 | Immediately before starting the process to terminate the connection | B
0xAD0D | 43 | Immediately after ending the process to terminate the connection | B
7 | Immediately after ending the process to terminate the connection | B
0xAD0E | 45 | Entry point of the send(Message msg, Address[] addresses) method and send(Message msg) method of the javax.mail.Transport class | A
0xAD0F | 46 | Exit point of the send(Message msg, Address[] addresses) method and send(Message msg) method of the javax.mail.Transport class | A
0xAD10 | 8#4 | Immediately before issuing the EHLO or HELO command | A
0xAD11 | 9#4 | Immediately after receiving a response to the EHELO or HELO command | A
0xAD12 | 10 | Immediately before issuing the AUTH command | B
14 | Immediately before starting to send the user name and password | B
16 | Immediately before starting to notify the end of authentication | B
18 | Immediately before starting to send the user name | B
20 | Immediately before starting to send the password | B
24 | Immediately before starting to issue the MAIL command | B
27#5 | Immediately before starting to issue the RCPT command | B
30 | Immediately before starting to issue the RSET command | B
32 | Immediately before starting to issue the DATA command | B
36 | Immediately before starting to issue the notification for the end of mail text transmission | B
40 | Immediately before starting to issue the QUIT command | B
47#6 | Immediately after receiving a response to the NOOP command | B
12 | Immediately after starting to issue the STARTTLS command | B
0xAD13 | 11 | Immediately after receiving a response to AUTH | B
15 | Immediately after receiving a response to the sent user name and password | B
17 | Immediately after notifying the end of authentication | B
19 | Immediately after receiving a response to the sent user name | B
21 | Immediately after receiving a response to the sent password | B
25 | Immediately after receiving a response to the MAIL command | B
28#5 | Immediately after receiving a response to the RCPT command | B
31 | Immediately after receiving a response to the RSET command | B
33 | Immediately after receiving a response to the DATA command | B
37 | Immediately after receiving a response to the notification for the end of mail text transmission | B
41 | Immediately after receiving a response to the QUIT command | B
48#6 | Immediately before starting to issue the NOOP command | B
13 | Immediately after receiving a response to the STARTTLS command | B
0xAD14 | 4 | Immediately before receiving the server response on connection | B
0xAD15 | 5 | Immediately after receiving the server response on connection | B

Legend:

A: Standard

B: Detail

#1

Corresponds to the numbers used in Figure 8-101, Figure 8-102, or Figure 8-103.

#2

Fetched at the start and end of sending the entire recipient information.

#3

The data to be sent is read and sent to the mail server in the data transfer described in the Trace collection point column of point 32 or 33. For example, if a file is attached, the file is read and the data of the file is sent to the mail server.

#4

Sometimes 1 log each for EHLO and HELO is output, because if EHLO fails, the reconnection is tried by issuing HELO.

#5

Fetched at the start and end of sending the individual recipient information.

#6

Fetched only when connected with the server.

The following figure shows the trace collection points on JavaMail transmission.

Figure 8-101 Trace collection points on JavaMail transmission (when the sendMessage(Message message, Address[] addresses) method of the javax.mail.Transport class is used)

Figure 8-102 Trace collection points on JavaMail transmission (when the send(Message msg, Address[] addresses) method and send(Message msg) method of the javax.mail.Transport class are used)

#1: The connect method of the javax.mail.Transport class is invoked internally, so the collection points from 1 to 20, shown in Figure 8-101, are also output.

#2: The sendMessage method of the javax.mail.Transport class is invoked internally, so the collection points from 21 to 36, shown in Figure 8-101, are also output.

#3: The close method of the javax.mail.Transport class is invoked internally, so the collection points from 37 to 42, shown in Figure 8-101, are also output.

Figure 8-103 Trace collection point on confirming the JavaMail connection

(2) Trace information that you can collect

The following table describes the trace information that you can collect on JavaMail transmission.

Table 8-162 Trace information that you can collect on JavaMail transmission

Numbers used in the figures#1 | Event ID | Level | Interface name | Operation name | Option
1 | 0xAD00 | A | -- | -- | --
2 | 0xAD06 | A | -- | -- | #2
3 | 0xAD07 | A | -- | -- | Exception class name in the event of an abnormality
4 | 0xAD14 | B | String that shows communication#3 | -- | --
5 | 0xAD15 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
6 | 0xAD0C | B | -- | -- | --
7 | 0xAD0D | B | -- | -- | Exception class name in the event of an abnormality
8 | 0xAD10 | A | String that shows communication#3 | -- | --
9 | 0xAD11 | A | String that shows communication#3 | Response code from the mail server#4, #6 | Exception class name in the event of an abnormality#7
10 | 0xAD12 | B | String that shows communication#3 | -- | --
11 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
12 | 0xAD12 | B | String that shows communication #3 | -- | --
13 | 0xAD13 | B | String that shows communication #3 | Response code from the mail server #4, #5, #6 | Name of the exception class if an error occurs #7
14 | 0xAD12 | B | String that shows communication#3 | -- | --
15 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
16 | 0xAD12 | B | String that shows communication#3 | -- | --
17 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
18 | 0xAD12 | B | String that shows communication#3 | -- | --
19 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
20 | 0xAD12 | B | String that shows communication#3 | -- | --
21 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
22 | 0xAD01 | A | -- | -- | Exception class name in the event of an abnormality
23 | 0xAD02 | A | -- | -- | --
24 | 0xAD12 | B | String that shows communication#3 | -- | --
25 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
26 | 0xAD08 | A | -- | -- | --
27 | 0xAD12 | B | String that shows communication#3 | -- | --
28 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
29 | 0xAD09 | A | -- | -- | Exception class name in the event of an abnormality
30 | 0xAD12 | B | String that shows communication#3 | -- | --
31 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
31 | 0xAD12 | B | String that shows communication#3 | -- | --
32 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
33 | 0xAD0A | A | -- | -- | --
34 | 0xAD0B | A | -- | -- | Exception class name in the event of an abnormality
35 | 0xAD12 | B | String that shows communication#3 | -- | --
36 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
37 | 0xAD03 | A | -- | -- | Exception class name in the event of an abnormality
38 | 0xAD04 | A | -- | -- | --
39 | 0xAD12 | B | String that shows communication#3 | -- | --
40 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7
41 | 0xAD0C | B | -- | -- | --
42 | 0xAD0D | B | - | - | Exception class name in the event of an abnormality
43 | 0xAD05 | A | -- | -- | Exception class name in the event of an abnormality
44 | 0xAD0E | A | Method name (send(Message, Address[]) or send(Message)) | -- | --
45 | 0xAD0F | A | Method name (send(Message, Address[]) or send(Message)) | -- | Exception class name in the event of an abnormality
46 | 0xAD12 | B | String that shows communication#3 | -- | --
47 | 0xAD13 | B | String that shows communication#3 | Response code from the mail server#4, #5, #6 | Exception class name in the event of an abnormality#7

Legend:

A: Standard

B: Detail

-: Not applicable

#1

Corresponds to the numbers used in Figure 8-101, Figure 8-102, or Figure 8-103.

#2

Outputs the following items:

Timeout value for fetching host name, port number, and connection. Communication timeout value.

Each of the items must be output by separating them with a single byte space.

0 is output, if the timeout is set to infinite. -1 is output, if the user omits the timeout setting.

(Example) localhost 25 10000 10000

#3

The following table describes the output contents of the strings that show communication:

Sr. No.
String that shows communication
Communication process

1
-- (Not applicable)
Fetch connection

2
connect-mail-server
Fetch server response on connection

3
EHLO command arguments
Issue EHLO command

4
HELO command arguments
Issue HELO command

5
AUTH LOGIN
Issue AUTH command
(LOGIN as argument)

6
AUTH PLAIN
Issue AUTH command
(PLAN as argument)

7
AUTH DIGEST-MD5
Issue AUTH command
(DIGEST-MD5 as argument)

8
SEND USER
Send user name

9
SEND PASS
Send password

10
SEND USER PASS
Send user name and password

11
AUTH END
Notify authentication end

12
QUIT
Issue QUIT command

13
MAIL command arguments
Issue MAIL command

14
RCPT command arguments
Issue RCPT command

15
RSET
Issue RSET command

16
NOOP
Issue NOOP command

17
DATA
Issue DATA command

18
SEND MAIL
Send mail body data

19
.
Notifying the end of the mail text transmission

20
STARTTLS
Issuing the STARTTLS command

#4

The following table describes the output contents of responses:

Response
Output contents

Response code is correct (satisfies the RFC specifications)
Response code

Response code is incorrect (does not satisfy the RFC specifications)
Header 4 letters of the 1st line of the response (See KDJE59111-E message for details)

If the 1st line is less than 4 letters
Output all the letters that exist in the 1st line

No response
Output empty string

#5

In the QUIT command, response code is output only if mail.smtp.quitwait or mail.smtps.quitwait is true.

#6

Response code is output only if the response is received. Response code is not output, if the response is not received due to the abnormal conditions such as occurrence of IOException in communication.

#7

If the response code does not satisfy the RFC specifications and if EOF is detected, the exception class is not output.

8.24.2 Trace collection points on JavaMail receipt and the trace information that you can collect

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that you can collect

(1) Trace collection points and PRF trace collection levels

The following table describes the information such as Event ID, trace collection points, and PRF trace collection level.

Table 8-163 Details of trace collection points on JavaMail receipt

Event ID
Numbers used in the figures#1
Trace collection points
Level

0xAD80
1
Entry point of the connect(String host, int port, String user, String password) method of the javax.mail.Store class
A

0xAD81
14
Exit point of the connect(String host, int port, String user, String password) method of the javax.mail.Store class
A

0xAD82
2
Immediately before starting the process to fetch the connection
A

0xAD83
3
Immediately after ending the process to fetch the connection
A

0xAD84
15
Entry point of the open(int) method of the javax.mail.Folder class
A

0xAD85
18
Exit point of the open(int) method of the javax.mail.Folder class
A

0xAD86
25
Entry point of the close(boolean) method of the javax.mail.Folder class
A

0xAD87
36
Exit point of the close(boolean) method of the javax.mail.Folder class
A

0xAD88
34
Immediately before starting the process to terminate the connection
B

6
Immediately before starting the process to terminate the connection
B

0xAD89
35
Immediately after ending the process to terminate the connection
B

7
Immediately after ending the process to terminate the connection
B

0xAD8A
19#2
Immediately before starting the process to fetch the entire message
information
A

0xAD8B
22#2
Immediately after ending the process to fetch the entire message information.
A

0xAD8C
28#2
Immediately before issuing the DELE command for all the messages to be deleted
A

0xAD8D
31#2
Immediately after receiving the response to the DELE command for all the messages to be deleted
A

0xAD8E
10
Immediately before starting to issue the USER command
A

23#3
Immediately before starting to issue the LIST, UIDL, RETR, or TOP commands
A

26
Immediately before starting to issue the RSET command
A

8
Immediately before starting to issue the CAPA command
A

0xAD8F
11
Immediately after receiving the response to the USER command
A

24#3
Immediately after receiving the response to the LIST, UIDL, RETR, or TOP command
A

27
Immediately after receiving the response to the RSET command
A

9
Immediately after receiving the response to the CAPA command
A

0xAD90
12
Immediately before starting to issue the PASS command
B

16
Immediately before starting to issue the STAT command
B

20#4, #5
Immediately before starting to issue the TOP or LIST command
B

29#5
Immediately before starting to issue the DELE command
B

32
Immediately before starting to issue the QUIT command
B

37#6
Immediately before starting to issue the NOOP command
B

0xAD91
13
Immediately after receiving the response to the PASS command
B

17
Immediately after receiving the response to the STAT command
B

21#4, #5
Immediately after receiving the response to the TOP command
B

30#5
Immediately after receiving the response to the DELE command
B

33
Immediately after receiving the response to the QUIT command
B

38#6
Immediately after receiving the response to the NOOP command
B

0xAD92
4
Immediately before receiving the server response on connection
B

0xAD93
5
Immediately after receiving the server response on connection
B

Legend:

A: Standard

B: Detail

#1

Corresponds to the numbers used in Figure 8-104 or Figure 8-105.

#2

Fetched at the start and end of receiving the entire mail information.

#3

If not called by specifying ENVELOPE in the 2nd argument of the fetch method of the javax.mail.Folder class.

#4

Only if called by specifying ENVELOPE in the 2nd argument of the fetch method of the javax.mail.Folder class.

#5

Fetched at the start and end of receiving the individual mail information.

#6

Collected only when connected to the server.

The following figure shows the trace collection points on JavaMail receipt.

Figure 8-104 Trace collection points on JavaMail receipt

Figure 8-105 Trace collection point on confirming the JavaMail connection

(2) Trace information that you can collect

The following table describes the trace information that you can collect on JavaMail receipt.

Table 8-164 Trace information that you can collect on JavaMail receipt

Numbers used in the figures#1 | Event ID | Level | Interface name | Operation name | Option
1 | 0xAD80 | A | -- | -- | --
2 | 0xAD82 | A | -- | -- | #2
3 | 0xAD83 | A | -- | -- | Exception class name in the event of an abnormality
4 | 0xAD92 | B | String that shows communication#3 | -- | --
5 | 0xAD93 | B | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
6 | 0xAD88 | B | -- | -- | --
7 | 0xAD89 | B | -- | -- | Exception class name in the event of an abnormality
8 | 0xAD8E | A | String that shows communication #3 | -- | --
9 | 0xAD8F | A | String that shows communication #3 | Response code from the mail server #4 | Name of the exception class if an error occurs
8 | 0xAD8E | A | String that shows communication#3 | -- | --
9 | 0xAD8F | A | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
10 | 0xAD90 | B | String that shows communication#3 | -- | --
11 | 0xAD91 | B | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
12 | 0xAD81 | A | -- | -- | Exception class name in the event of an abnormality
13 | 0xAD84 | A | -- | -- | --
14 | 0xAD90 | B | String that shows communication#3 | -- | --
15 | 0xAD91 | B | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
16 | 0xAD85 | A | -- | -- | Exception class name in the event of an abnormality
17#5 | 0xAD8A | A | -- | -- | --
18 | 0xAD90 | B | String that shows communication#3 | -- | --
19#6 | 0xAD91 | B | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
20#5 | 0xAD8B | A | -- | -- | Exception class name in the event of an abnormality
21 | 0xAD8E | A | String that shows communication#3 | -- | --
22#6 | 0xAD8F | A | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
23 | 0xAD86 | A | -- | -- | --
24 | 0xAD8E | A | String that shows communication#3 | -- | --
25 | 0xAD8F | A | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
26 | 0xAD8C | A | -- | -- | --
27 | 0xAD90 | B | String that shows communication#3 | -- | --
28 | 0xAD91 | B | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
29 | 0xAD8D | A | -- | -- | Exception class name in the event of an abnormality
30 | 0xAD90 | B | String that shows communication#3 | -- | --
31 | 0xAD91 | B | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality
32 | 0xAD88 | B | -- | -- | --
33 | 0xAD89 | B | -- | -- | Exception class name in the event of an abnormality
34 | 0xAD87 | A | -- | -- | Exception class name in the event of an abnormality
35 | 0xAD90 | B | String that shows communication#3 | -- | --
36 | 0xAD91 | B | String that shows communication#3 | Response code from the mail server#4 | Exception class name in the event of an abnormality

Legend:

A: Standard

B: Detail

--: Not applicable

#1

Corresponds to the numbers used in Figure 8-104 or Figure 8-105.

#2

Outputs the following items:

Timeout value for fetching host name, port number, and connection. Communication timeout value.

Each of the items should be output by separating them with a space.

0 is output if the timeout is set to infinite. -1 is output, if the user omits the timeout setting.

(Example) localhost 25 10000 10000

#3

The following table describes the output contents of the strings that show communication:

Sr. No. | String that shows communication | Communication process
1 | -- (Not applicable) | Fetch connection
2 | connect-mail-server | Fetch server response on connection
3 | USER | Issue USER command
4 | PASS | Issue PASS command
5 | QUIT | Issue QUIT command
6 | STAT | Issue STAT command
7 | LIST command arguments | Issue LIST command
8 | UIDL command arguments | Issue UIDL command
9 | RETR command arguments | Issue RETR command
10 | TOP command arguments | Issue TOP command
11 | DELE command arguments | Issue DELE command
12 | NOOP | Issue NOOP command
13 | RSET | Issue RSET command
14 | CAPA | Issuing the CAPA command

#4

Response code is output only if the 1st line of the response is received. Response code is not output, if the response is not received due to the abnormal conditions such as occurrence of IOException in communication.

#5

The following table describes the output contents of responses:

Response
Output contents

Response code is correct (satisfies the RFC specifications)
Response code

Response code is incorrect (does not satisfy the RFC specifications)
Header 4 letters of the 1st line of the response (See KDJE59112-E message for details)

If the 1st line is less than 4 letters
Output all the letters present in the 1st line

No response
Output empty string

#6

For the commands (RETR command, TOP command, and UIDL command) that receive multiple-line response, return code 0 is output on fetching the 1st line of the response.

8.25 Trace collection points of JSF

This section describes the trace collection points of JSF and the trace information that can be collected.

Organization of this section

8.25.1 Trace collection points in the processing between JSF and Web container and the trace information that can be collected

8.25.2 Trace collection points in the processing between JSF and user applications

8.25.1 Trace collection points in the processing between JSF and Web container and the trace information that can be collected

Organization of this subsection

(1) Trace collection points when a Web application starts and the trace information that can be collected

(2) Trace collection points when a Web application stops and the trace information that can be collected

(1) Trace collection points when a Web application starts and the trace information that can be collected

(a) Trace collection points and the PRF trace collection levels when a Web application starts

The following table describes the event IDs, trace collection points, and PRF trace collection levels.15,15,55,15

Table 8-165 Details of the trace collection points when a Web application starts

Event ID
No. in the figure#
Trace collection points
Level

0xAF00
1
Immediately before the JSF initialization starts during Web application startup
A

0xAF01
2
Immediately after the JSF initialization completes during
Web application startup
A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-106.

The following figure shows the trace collection points when a Web application starts.

Figure 8-106 Trace collection points when a Web application starts

(b) Trace information that can be collected when a Web application starts

The following table describes the trace information that can be collected when a Web application starts.

Table 8-166 Trace information that can be collected when a Web application starts

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF00 | A | #2 | -- | --
2 | 0xAF01 | A | #3 | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-106.

#2

The context root name of the application is output.

#3

If the application has already been initialized, already-been-initialized is output.

For the Web applications that are not JSF applications, the initialization processing is immediately terminated, and No-FacesServlet-Found-In-web.xml is output.

(2) Trace collection points when a Web application stops and the trace information that can be collected

(a) Trace collection points and PRF trace collection levels when a Web application stops

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-167 Details of the trace collection points when a Web application stops

Event ID | No. in the figure# | Trace collection points | Level
0xAF02 | 1 | Immediately before the JSF termination starts during the termination of a Web application | A
0xAF03 | 2 | Immediately after the JSF termination completes during the termination of a Web application | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-107.

The following figure shows the trace collection points when a Web application stops.

Figure 8-107 Trace collection points when a Web application stops

(b) Trace information that can be collected when a Web application stops

The following table describes the trace information that can be collected when a Web application stops.

Table 8-168 Trace information that can be collected when a Web application stops

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF02 | A | #2 | -- | --
2 | 0xAF03 | A | #3 | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-107.

#2

The context root name of the application is output.

#3

If the application has not been initialized, not-been-initialized is output.

8.25.2 Trace collection points in the processing between JSF and user applications

Organization of this subsection

(1) Trace collection points between a JSF application and a user application

(2) Trace collection points in resource handling

(1) Trace collection points between a JSF application and a user application

In a JSF application, the trace information is output when a user application is invoked.

(a) Trace collection points when a custom converter is invoked and the trace information that can be collected

Trace collection points and PRF trace collection levels when a custom converter is invoked

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-169 Details of the trace collection points when a custom converter is invoked

Event ID | No. in the figure# | Trace collection points | Level
0xAF04 | 1 | Immediately before a custom converter is invoked | A
0xAF05 | 2 | Immediately after the processing of the custom converter ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-108.

The following figure shows the trace collection points when a custom converter is invoked.

Figure 8-108 Trace collection points when a custom converter is invoked

Trace information that can be collected when a custom converter is invoked

The following table describes the trace information that can be collected when a custom converter is invoked.

Table 8-170 Trace information that can be collected when a custom converter is invoked

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF04 | A | #2 | #3 | --
2 | 0xAF05 | A | -- | -- | For an error, exception class name #4

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-108.

#2

The client ID of the component that invokes the user application is output.

#3

The class name and the method name of the custom converter are output.

#4

If ConverterException occurs because the user entered an incorrect value, the exception class name is output, but the processing terminates normally and the return code is 0.

Depending on when the custom converter is invoked from JSF, the exception processing terminates abnormally.

If you invoke the custom converter by specifying the <f:converter> tag of the UI component on the facelets page, only the component ID is displayed as the client ID.

(b) Trace collection points when a custom validator is invoked and the trace information that can be collected

Trace collection points and PRF trace collection levels when a custom validator is invoked

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-171 Details of the trace collection points when a custom validator is invoked

Event ID | No. in the figure# | Trace collection points | Level
0xAF06 | 1 | Immediately before a custom validator is invoked | A
0xAF07 | 2 | Immediately after the processing of the custom validator ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-109.

The following figure shows the trace collection points when a custom validator is invoked.

Figure 8-109 Trace collection points when a custom validator is invoked

Trace information that can be collected when a custom validator is invoked

The following table describes the trace information that can be collected when a custom validator is invoked.

Table 8-172 Trace information that can be collected when a custom validator is invoked

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF06 | A | #2 | #3 | --
2 | 0xAF07 | A | -- | -- | For an error, exception class name #4

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-109.

#2

The client ID of the component that invokes the user application is output.

#3

The class name of the custom validator is output. If you use MethodExpression to invoke the custom validator, MethodExpression is output.

#4

If ValidatorException occurs because the user entered an incorrect value, the exception class name is output, but the processing terminates normally and the return code is 0.

(c) Trace collection points when ValueChangeListener is invoked and the trace information that can be collected

Trace collection points and PRF trace collection levels when ValueChangeListener is invoked

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-173 Details of the trace collection points when ValueChangeListener is invoked

Event ID | No. in the figure# | Trace collection points | Level
0xAF08 | 1 | Immediately before ValueChangeListener is invoked | A
0xAF09 | 2 | Immediately after the processing of ValueChangeListener ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-110.

The following figure shows the trace collection points when ValueChangeListener is invoked.

Figure 8-110 Trace collection points when ValueChangeListener is invoked

Trace information that can be collected when ValueChangeListener is invoked

The following table describes the trace information that can be collected when ValueChangeListener is invoked.

Table 8-174 Trace information that can be collected when ValueChangeListener is invoked

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF08 | A | #2 | #3 | --
2 | 0xAF09 | A | #4 | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-110.

#2

The client ID of the component that invokes the user application is output.

#3

The class name of ValueChangeListener is output. If you use MethodExpression to invoke ValueChangeListener, MethodExpression is output.

#4

When you invoke ValueChangeListener with MethodExpression and the processing terminates normally, one argument is output when a method with one argument is invoked and no argument is output when a method without arguments is invoked. A null character is output for an abnormal termination.

(d) Trace collection points when ActionListener is invoked and the trace information that can be collected

Trace collection points and PRF trace collection levels when ActionListener is invoked

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-175 Details of the trace collection points when ActionListener is invoked

Event ID | No. in the figure# | Trace collection points | Level
0xAF0A | 1 | Immediately before ActionListener is invoked | A
0xAF0B | 2 | Immediately after the processing of ActionListener ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-111.

The following figure shows the trace collection points when ActionListener is invoked.

Figure 8-111 Trace collection points when ActionListener is invoked

Trace information that can be collected when ActionListener is invoked

The following table describes the trace information that can be collected when ActionListener is invoked.

Table 8-176 Trace information that can be collected when ActionListener is invoked

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF0A | A | #2 | #3 | --
2 | 0xAF0B | A | #4 | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-111.

#2

The client ID of the component that invokes the user application is output.

#3

The class name of ActionListener is output. If you use MethodExpression to invoke ActionListener, MethodExpression is output.

#4

When you invoke ActionListener with MethodExpression and the processing terminates normally, one argument is output when a method with one argument is invoked and no argument is output when a method without arguments is invoked. A null character is output for an abnormal termination.

(e) Trace collection points when AjaxBehaviorListener is invoked and the trace information that can be collected

Trace collection points and PRF trace collection levels when AjaxBehaviorListener is invoked

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-177 Details of the trace collection points when AjaxBehaviorListener is invoked

Event ID | No. in the figure# | Trace collection points | Level
0xAF0C | 1 | Immediately before AjaxBehaviorListener is invoked | A
0xAF0D | 2 | Immediately after the processing of AjaxBehaviorListener ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-112.

The following figure shows the trace collection points when AjaxBehaviorListener is invoked.

Figure 8-112 Trace collection points when AjaxBehaviorListener is invoked

Trace information that can be collected when AjaxBehaviorListener is invoked

The following table describes the trace information that can be collected when AjaxBehaviorListener is invoked.

Table 8-178 Trace information that can be collected when AjaxBehaviorListener is invoked

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF0C | A | #2 | #3 | --
2 | 0xAF0D | A | #4 | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-112.

#2

The client ID of the component that invokes the user application is output.

#3

The class name of AjaxBehaviorListener is output. If you use MethodExpression to invoke AjaxBehaviorListener, MethodExpression is output.

#4

When the processing terminates normally, one argument is output when a method with one argument is invoked and no argument is output when a method without arguments is invoked. A null character is output for an abnormal termination.

(f) Trace collection points when Action Method is invoked and the trace information that can be collected

Trace collection points and PRF trace collection levels when Action Method is invoked

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-179 Details of the trace collection points when Action Method is invoked

Event ID | No. in the figure# | Trace collection points | Level
0xAF0E | 1 | Immediately before Action Method is invoked | A
0xAF0F | 2 | Immediately after the processing of Action Method ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-113.

The following figure shows the trace collection points when Action Method is invoked.

Figure 8-113 Trace collection points when Action Method is invoked

Trace information that can be collected when Action Method is invoked

The following table describes the trace information that can be collected when Action Method is invoked.

Table 8-180 Trace information that can be collected when Action Method is invoked

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF0E | A | #2 | -- | --
2 | 0xAF0F | A | -- | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-113.

#2

The client ID of the component that invokes the user application is output.

(g) Trace collection points when ComponentSystemEventListener is invoked and the trace information that can be collected

Trace collection points and PRF trace collection levels when ComponentSystemEventListener is invoked

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-181 Details of the trace collection points when ComponentSystemEventListener is invoked

Event ID | No. in the figure# | Trace collection points | Level
0xAF12 | 1 | Immediately before ComponentSystemEventListener is invoked | A
0xAF13 | 2 | Immediately after the processing of ComponentSystemEventListener ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-114.

The following figure shows the trace collection points when ComponentSystemEventListener is invoked.

Figure 8-114 Trace collection points when ComponentSystemEventListener is invoked

Trace information that can be collected when ComponentSystemEventListener is invoked

The following table describes the trace information that can be collected when ComponentSystemEventListener is invoked.

Table 8-182 Trace information that can be collected when ComponentSystemEventListener is invoked

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF12 | A | #2 | #3 | --
2 | 0xAF13 | A | #4 | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#1

Corresponds to the numbers in Figure 8-114.

#2

The client ID of the component that invokes the user application is output.

#3

The class name of ComponentSystemEventListener is output. If you use MethodExpression to invoke ComponentSystemEventListener, MethodExpression is output.

#4

When you invoke ComponentSystemEventListener with MethodExpression and the processing terminates normally, one argument is output when a method with one argument is invoked and no argument is output when a method without arguments is invoked. A null character is output for an abnormal termination.

(2) Trace collection points in resource handling

A JSF application outputs the trace information when a requested resource is processed.

The trace can be collected in the following cases:

For a JSF resource request

For a request using the <name> attribute in the <h:graphicImage> tag

(a) Trace collection points and PRF trace collection levels

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-183 Details of the trace collection points in resource handling

Event ID | No. in the figure# | Trace collection points | Level
0xAF10 | 1 | Immediately before the processing of the resource request starts | A
0xAF11 | 2 | Immediately after the processing of the resource request ends | A

Legend:

A: Standard

#

Corresponds to the numbers in Figure 8-115.

The following figure shows the trace collection points in resource handling.

Figure 8-115 Trace collection points in resource handling

(b) Trace information that can be collected

The following table describes the trace information that can be collected in resource handling.

Table 8-184 Trace information that can be collected in resource handling

No. in the figure# | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xAF10 | A | -- | -- | --
2 | 0xAF11 | A | -- | -- | For an error, exception class name

Legend:

A: Standard

--: Not applicable

#

Corresponds to the numbers in Figure 8-115.

8.26 Trace collection points of CDI

This section describes the trace collection points of CDI and the trace information that can be collected.

Organization of this section

8.26.1 Trace collection points of CDI and the trace information that can be collected

8.26.1 Trace collection points of CDI and the trace information that can be collected

This subsection describes the trace collection points of CDI and the trace information that can be collected. The following two cases will be described separately:

When a combination of JSF and CDI is used

When a combination of servlets and CDI is used

Organization of this subsection

(1) Trace collection points and PRF trace collection levels

(2) Trace information that can be collected

(1) Trace collection points and PRF trace collection levels

(a) When a combination of JSF and CDI is used

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-185 Details of the trace collection points when a combination of JSF and CDI is used

Event ID | No. in the figure# | Trace collection points | Level
0xb002 | 1 | When the reading of the JSF settings required for using CDI starts | A
0xb003 | 2 | When the reading of the JSF settings required for using CDI ends (normal termination) | A
0xb004 | 3 | When the JSF preparations required for using CDI start | A
0xb005 | 4 | When the JSF preparations required for using CDI end (normal termination) | A
0xb006 | 5 | When the EL assessment starts | B
0xb007 | 6 | When the EL assessment ends (normal termination) | B

Legend:

A: Standard

B: Advanced

#:

Corresponds to the numbers in Figure 8-116 and Figure 8-117.

The following figure shows the trace collection points.

Figure 8-116 Trace collection points when a combination of JSF and CDI is used (when the JSF settings are read and prepared)

Figure 8-117 Trace collection points when a combination of JSF and CDI is used (for EL evaluation)

(b) When a combination of servlets, filters, listeners, and CDI is used

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-186 Details of the trace collection points when a combination of servlets, filters, listeners, and CDI is used

Event ID | No. in the figure# | Trace collection points | Level
0xb008 | 1 | When the generation of servlet/filter/listener instances starts | A
0xb009 | 2 | When the generation of servlet/filter/listener instances ends (normal termination) | A

Legend:

A: Standard

#:

Corresponds to the numbers in Figure 8-118.

The following figure shows the trace collection points.

Figure 8-118 Trace collection points when a combination of servlets, filters, listeners, and CDI is used

(2) Trace information that can be collected

(a) When a combination of JSF and CDI is used

The following table describes the trace information that can be collected when a combination of JSF and CDI is used.

Table 8-187 Trace information that can be collected when a combination of JSF and CDI is used

No. in the figure#1 | Event ID | Level | Information that you can acquire
Interface name | Operation name | Optional
1 | 0xb002#2 | A | WeldFacesConfigProvider | -- | Context information of the Web container
2 | 0xb003#2 | A | WeldFacesConfigProvider | -- | Entrance time
3 | 0xb004#2 | A | WeldApplicationFactory | -- | --
4 | 0xb005#2 | A | WeldApplicationFactory | -- | Entrance time
5 | 0xb006#3 | B | WeldApplication | -- | --
6 | 0xb007#3 | B | WeldApplication | -- | Entrance time

Legend:

A: Standard

B: Advanced

--: Not applicable

#1:

Corresponds to the numbers in Figure 8-116 and Figure 8-117.

#2:

The trace information for the reading of the JSF settings required for using CDI and for the JSF preparations required for using CDI is collected when the application starts.

#3:

The trace information for EL assessment is collected when FacesServlet is initialized and when Expression Language specified in JSF is evaluated.

(b) When servlets are invoked from CDI

The following table describes the trace information that can be collected when servlets are invoked from CDI.

Table 8-188 Trace information that can be collected when servlets are invoked from CDI

No. in the figure#
Event ID
Level
Information that you can acquire

Interface name
Operation name
Optional

1
0xb008
A
CDIServiceImpl
--
The following information is output:

Managed class

Class name

Context root

2
0xb009
A
CDIServiceImpl
--
Entrance time

Legend:

A: Standard

--: Not applicable

#:

Corresponds to the numbers in Figure 8-118.

Note that the trace information is collected when the servlet/filter/listener interfaces are generated.

8.27 Trace collection points when a J2EE server is started or terminated

Trace information can be collected when the startup processing of a J2EE server finishes, and when the termination processing of the J2EE server starts.

Organization of this section

8.27.1 Trace Get Point and the PRF Trace Get Level

8.27.2 Trace information that can be collected

8.27.1 Trace Get Point and the PRF Trace Get Level

The following table describes the event IDs, trace collection points, and PRF trace collection levels.

Table 8-189 Details of trace collection points in a J2EE server

Event ID | Trace acquisition points | Level
0x8FFE | When the startup processing of the J2EE server is complete (message KDJE30028-I is output) | A
0x8FFF | When the shutdown of the J2EE server starts (message KDJE30031-I is output) | A

Legend:

A: Standard

8.27.2 Trace information that can be collected

The trace information that can be collected when a J2EE server is started or terminated is as follows:

Event ID
0x8FFE, 0x8FFF

PRF trace collection level
All Advanced.

Interface name, operation name, and optional
The information is not output.

8.28 Trace collection points of an application

The application trace is output in the user-extended trace based performance analysis. The user-extended trace based performance analysis outputs the trace information when the methods specified in the configuration file for the user-extended trace based performance analysis are invoked.

This section describes the trace points and trace information for the user-extended trace based performance analysis.

Organization of this section

8.28.1 Trace collection points and PRF trace collection levels

8.28.2 Trace information that can be collected

8.28.1 Trace collection points and PRF trace collection levels

The following table describes the points at which the user-extended trace based performance analysis outputs the trace.

Table 8-190 Trace collection points of the user-extended trace based performance analysis

Trace collection points | No. in the figure#1 | Explanation | Level
Normal entry of method | 1 | Immediately after a method is invoked. | Trace collection levels specified in the user-extended trace based performance analysis configuration file#2
Normal exit of method | 2 | Immediately before a method terminates normally.
Abnormal exit of method | 3 | Immediately before a method terminates abnormally due to an exception or error.

Legend:

A: Standard

#1:

Corresponds to the numbers in Figure 8-119.

#2:

For details on the specification of the trace collection levels specified in the user-extended trace based performance analysis configuration file, see 7.5.3 Settings for the methods to be traced by the user-extended trace based performance analysis.

Reference note

If a method to be traced terminates because an exception or error occurred in the method to be traced or in the invocation destination method of the method to be traced, the trace is collected as the abnormal exit of the method.

If an exception or error is processed by the try-catch syntax in a method to be traced, and if an exception or error is not thrown at the invocation source of the method to be traced, the trace is collected as the normal exit of the method.

The following figure shows the trace collection points in the user-extended trace based performance analysis.

Figure 8-119 Trace collection points of the user-extended trace based performance analysis

8.28.2 Trace information that can be collected

This subsection describes the trace information of the user-extended trace based performance analysis.

Organization of this subsection

(1) Trace information of the user-extended trace based performance analysis

(2) Output levels

(3) Example of output of the user-extended trace based performance analysis

(1) Trace information of the user-extended trace based performance analysis

The following table describes the trace information of the user-extended trace based performance analysis.

Table 8-191 Trace information of the user-extended trace based performance analysis

No. in the figure#1
Information that you can acquire

Event ID
(Event)
Return code (Rc)
Interface name (INT)
Operation information (OPR)
Additional information#2
(OPT/ASCII#3)

1
Event ID specified in the configuration file for the user-extended trace based performance analysis.
When not specified, 0xae00.
0
Identity ID specified by the user in the configuration file for the user-extended trace based performance analysis.
--
The following information is output:

Package name

Class name

Method name

2
Event ID specified in the configuration file for the user-extended trace based performance analysis + 1.
When not specified, 0xae01.
0
Identity ID specified by the user in the configuration file for the user-extended trace based performance analysis.
Line number of the text executed last by the method #4.
The following information is output:

Package name

Class name

Method name

3
Event ID specified in the configuration file for the user-extended trace based performance analysis +1.
When not specified, 0xae01.
1
Identity ID specified by the user in the configuration file for the user-extended trace based performance analysis.
Class name of the exception or error#5.
The following information is output:

Package name

Class name

Method name

Legend:

--: No output.

#1:

Corresponds to the numbers in Figure 8-119.

#2:

The user-extended trace based performance analysis outputs the method name with the output level specified in the jvm.userprf.LogLevel property. For details on the output levels and the information output at each level, see (2) Output levels.

#3:

If the additional information output to the ASCII area exceeds 256 ASCII characters, 256 characters are output from the beginning.

#4:

Output when true is specified for the jvm.userprf.LineNumber property. For details on the jvm.userprf.LineNumber property, see 16.3 Properties used in JavaVM in the manual uCosminexus Application Server Definition Reference Guide.

#5:

When true is specified for the jvm.userprf.ThrowableName property, the class name is output with the output level specified in the jvm.userprf.LogLevel property, and the editing method specified in the jvm.userprf.ThrowableNameEditMethod property. For details on the jvm.userprf.ThrowableName and jvm.userprf.ThrowableNameEditMethod properties, see 16.3 Properties used in JavaVM in the manual uCosminexus Application Server Definition Reference Guide.

(2) Output levels

You specify the trace information output level for the user-extended trace based performance analysis in the jvm.userprf.LogLevel property.

The following table describes the output levels and the trace information that is output.

Table 8-192 Specification of the output levels and the trace information that is output

Specification in the jvm.userprf.LogLevel property | Additional information (OPT/ASCII) | Operation information for abnormal exit of the method (OPR)
class | Class name | Class name of the exception or error
package | Fully qualified class name | Fully qualified class name of the exception or error
method | Fully qualified class name + method name
signature | Fully qualified class name + method name + method argument type

For details on the jvm.userprf.LogLevel property, see 16.3 Properties used in JavaVM in the manual uCosminexus Application Server Definition Reference Guide.

(3) Example of output of the user-extended trace based performance analysis

The following are the examples of output of the user-extended trace based performance analysis.

Example when the output contents of the trace information are not changed

The following is an example of settings when the output contents of the trace information are not changed:

Example of settings in the Easy Setup definition file

...
<param>
<param-name>UserPrfText</param-name>
<param-value>
<![CDATA[
com.sample.ClassA.method1(int),test00,false
]]>
</param-value>
</param>
<param>
<param-name>add.jvm.arg</param-name>
<param-value>-Djvm.userprf.Enable=true</param-value>
</param>
...

Output contents

Event | Rc | INT | OPR | ASCII
0xae00 | 0 | test00 | (Blank) | ClassA
0xae01 | 0 | test00 | (Blank) | ClassA

The trace information is output as follows in this example:

The event ID settings are omitted for the method to be traced, so if the method to be traced is invoked, the default value of 0xae00 is output as the event ID at the method entry, and 0xae01 is output as the event ID at the method exit.

Example for the output of the line number in the operation information

The following is an example of settings when the configuration file for the user-extended trace based performance analysis (/test/setting.txt) is used to output the line number in the operation information:

Example of settings in the Easy Setup definition file

...
<param>
<param-name>add.jvm.arg</param-name>
<param-value>-Djvm.userprf.Enable=true</param-value>
<param-value>-Djvm.userprf.File=/test/setting.txt</param-value>
<param-value>-Djvm.userprf.LineNumber=true</param-value>
</param>
...

Example of settings in the configuration file for the user-extended trace based performance analysis (setting.txt)

com.sample.ClassA.method1(java.lang.String),test00,false,0xae77
com.sample.ClassB.method2(boolean),test01.false

Output contents

jvm.userprf.LineNumber=true is specified in this example, so the line number executed last by each method is output in the operation information (OPR area) if the method exits normally.

Event | Rc | INT | OPR | ASCII
0xae77 | 0 | test00 | (Blank) | ClassA
0xae78 | 0 | test00 | 324 | ClassA
0xae00 | 0 | test01 | (Blank) | ClassB
0xae01 | 0 | test01 | 15 | ClassB

The trace information is output as follows in this example:

In the second line specified in the configuration file for the user-extended trace based performance analysis, the event ID settings are omitted for the method to be traced, so if the method to be traced is invoked, the default value of 0xae00 is output as the event ID at the method entry, and 0xae01 is output as the event ID at the method exit.

Example for the output of the exception or error class name

The following is an example of settings when the class name of the thrown exception is output in the operation information (OPR area) if the method exits abnormally. Note that this example describes the case in which ClassC exists in the subclass ClassA, and ClassA.method1 is overridden in ClassC.

Example of settings in the Easy Setup definition file

...
<param>
<param-name>UserPrfText</param-name>
<param-value>
<![CDATA[
com.sample.ClassA.method1(),test00,true,0xae0a
]]>
</param-value>
</param>
<param>
<param-name>add.jvm.arg</param-name>
<param-value>-Djvm.userprf.Enable=true</param-value>
<param-value>-Djvm.userprf.LineNumber=true</param-value>
<param-value>-Djvm.userprf.ThrowableName=true</param-value>
</param>
...

Output contents

Event | Rc | INT | OPR | ASCII
0xae0a | 0 | test00 | (Blank) | ClassA
0xae0b | 0 | test00 | 324 | ClassA
0xae0a | 0 | test00 | (Blank) | ClassC
0xae0b | 1 | test00 | IOException | ClassC

The trace information is output as follows in this example:

true is set in the subclass flag, so the information of ClassC.method1 that overrides ClassA.method1 is also output.

jvm.userprf.LineNumber=true is specified, so the line number executed last by each method is output in the operation information (OPR area) if the method exits normally.

jvm.userprf.ThrowableName=true is set, so the class name of the thrown exception is output in the operation information (OPR area) if the method exits abnormally. However, the jvm.userprf.LogLevel property is not specified, so only the class name of the thrown exception is output.

Example of changing the output method of the exception or error class name

The following is an example of settings when the output method of the exception or error class name is changed.

Example of settings in the Easy Setup definition file

...
<param>
<param-name>UserPrfText</param-name>
<param-value>
<![CDATA[
com.sample.ClassA.method1(),test00,false
]]>
</param-value>
</param>
<param>
<param-name>add.jvm.arg</param-name>
<param-value>-Djvm.userprf.Enable=true</param-value>
<param-value>-Djvm.userprf.ThrowableName=true</param-value>
<param-value>-Djvm.userprf.ThrowableNameEditMethod=FRONT_CUT</param-value>
<param-value>-Djvm.userprf.LogLevel=method</param-value>
</param>
...

Output contents

Event | Rc | INT | OPR | ASCII
0xae00 | 0 | test00 | (Blank) | com.sample.ClassA.method1
0xae01 | 1 | test00 | *ment.IllegalClassFormatException | com.sample.ClassA.method1

The trace information is output as follows in this example:

The event ID settings are omitted for the method to be traced, so if the method to be traced is invoked, the default value of 0xae00 is output as the event ID at the method entry, and 0xae01 is output as the event ID at the method exit.

jvm.userprf.ThrowableName=true is specified, so the exception or error class name is output to the operation information (OPR area) if the method exits abnormally. However, the thrown exception name is 33 characters or more and jvm.userprf.ThrowableNameEditMethod=FRONT_CUT is specified, so the name is output with the front part omitted. The omitted part is displayed using * (asterisk).

jvm.userprf.LogLevel=method is specified, so the fully qualified class name + method name is output in the additional information (ASCII area).

9. Product JavaVM Functionality

The product JavaVM is JavaVM that is provided in Application Server. You can use the product JavaVM for acquiring the data at error time and the information used for tuning. This chapter describes about the functionality provided by the product JavaVM. For details about the Explicit Memory Management functionality provided by the product JavaVM, see 8. Preventing the Occurrence of Full Garbage Collection by using the Explicit Memory Management Functionality in the uCosminexus Application Server Expansion Guide.

Organization of this chapter

9.1 Organization of this chapter

9.2 Overview of the product JavaVM functionality

9.3 Class-wise statistical functionality

9.4 Instance statistical functionality

9.5 STATIC member statistical functionality

9.6 Reference-related information output functionality

9.7 Pre-statistical garbage collection selection functionality

9.8 Unused objects statistical functionality in the Tenured area

9.9 Base object list output functionality for Tenured augmentation factors

9.10 Class-wise statistical information analysis functionality

9.11 Tenuring distribution information output functionality of the Survivor area

9.12 hndlwrap functionality

9.13 Functionality to set the upper limit of allocation size of C heap during JIT compilation

9.14 Functionality to set the upper limit of the number of threads

9.15 Notes on using the product JavaVM functionality (in UNIX)

9.1 Organization of this chapter

The product JavaVM is provided by the component software, Cosminexus Developer's Kit for Java. The process of the J2EE server or the batch server running in the Application Server is executed on the JavaVM. This section explains the functionality of the product JavaVM.

For an overview of the product JavaVM functionality, see 9.2 Overview of the product JavaVM functionality.

The following table lists the product JavaVM functionality provided in the Application Server and corresponding reference section.

Table 9-1 product JavaVM functionality provided in the Application Server

Functionality name | Reference location
Class-wise statistical functionality | 9.3
Instance statistical functionality# | 9.4
STATIC member statistical functionality# | 9.5
Reference-related information output functionality# | 9.6
Pre-statistical garbage collection selection functionality# | 9.7
Unused objects statistical functionality in the Tenured area# | 9.8
Base object list output functionality for Tenured augmentation factors# | 9.9
Class-wise statistical information analysis functionality | 9.10
Tenuring distribution information output functionality of the Survivor area | 9.11
hndlwrap functionality | 9.12
Functionality to set the upper limit of allocation size of C heap during JIT compilation | 9.13
Functionality to set the upper limit of number of threads | 9.14
Notes on using the product JavaVM functionality | 9.15

#

One of the class-wise statistical functionality that outputs the class-wise statistical information.

9.2 Overview of the product JavaVM functionality

The process of the J2EE server or the batch server running in the Application Server is executed on the JavaVM. The functionality provided by the product JavaVM is as follows:

Explicit management heap functionality

Class-wise statistical functionality

Instance statistical functionality

STATIC member statistical functionality

Reference-related information output functionality

Pre-statistical garbage collection selection functionality

Unused objects statistical functionality in the Tenured area

Base object list output functionality for Tenured augmentation factors

Class-wise statistical information analysis functionality#

Tenuring distribution output functionality of the Survivor area

hndlwrap functionality

Functionality to set the upper limit of allocation size of C heap during JIT compilation

Functionality to set the upper limit of the number of threads

#

If using the class-wise statistical information analysis functionality, you can output the class-wise statistical information to the extended thread dump file in the CSV format.

Hint

When you execute the unused objects statistical functionality in the Tenured of the class-wise statistical functionality, the following functionality are disabled:

Instance statistical functionality

STATIC member statistical functionality

Pre-statistical garbage collection selection functionality

In the product JavaVM, the output contents of the log are expanded so that the output contents can be used for the cause analysis of the error occurrence and for checking the system state. This log is output to the Hitachi JavaVM log file, and therefore, you can acquire many troubleshoot information than the standard JavaVM. You can improve the system availability by implementing an appropriate tuning using this log (extended verbose information). For details about the Hitachi JavaVM log files, see 5.7 Contents of the JavaVM log (JavaVM log file). For details about the tuning of the Java VM, see 7. JavaVM Memory Tuning in the uCosminexus Application Server System Design Guide.

Hereafter, the following section describes each functionality of the product JavaVM. For details about the Explicit Memory Management functionality, see 8. Preventing the Occurrence of Full Garbage Collection by using the Explicit Memory Management Functionality in the uCosminexus Application Server Expansion Guide.

9.3 Class-wise statistical functionality

This section describes the class-wise statistical functionality.

You can use the class-wise statistical functionality to output the instance information of the reference-related class for each class, to the extended thread dump.

The following table describes the organization of this section.

Table 9-2 Organization of this section (class-wise statistical functionality)

Category | Title | Reference
Explanation | Overview of the class-wise statistical functionality | 9.3.1
Functionality that requires the class-wise statistical functionality | 9.3.2
Operation | Outputting statistic information for each class | 9.3.3
Notes | Precautions to output the class-wise statistical information | 9.3.4

Note:

The function-specific description is not available for "Implementation" and "Settings".

Organization of this section

9.3.1 Overview of the class-wise statistical functionality

9.3.2 Functionality that requires the class-wise statistical functionality

9.3.3 Outputting Statistic Information for Each Class

9.3.4 Precautions to output the class-wise statistical information

9.3.1 Overview of the class-wise statistical functionality

You can output the size of all instances those are under the members of each class that has instances, to the extended thread dump, as the statistical information for each class. This statistical information is called as class-wise statistical information. You can output the class-wise statistical information multiple times for investigating the change in the Java object by garbage collection, the status of the Java object having short life, change in the size of each class, and the Java object parent-child relation. You can use this information for measuring the memory used for one transaction and for investigating the memory leak.

The class-wise statistical information is output based on the following functionality:

Instance statistical functionality

STATIC member statistical functionality

Reference-related information output functionality

Pre-statistical garbage collection selection functionality

Unused objects statistical functionality in the Tenured area

Base object list output functionality for Tenured augmentation factors

For details about each functionality, see 9.3.2 Functionality that requires the class-wise statistical functionality.

Moreover, in the class-wise statistical information, the instances in the Java heap (combining the Eden area, the Survivor area, and the Tenured area) and in the Permanent area are the target for statistics. Additionally, when using Explicit management heap functionality, you can also target the instances that exists the in Explicit heap for statistics. For details about how to output a class-wise statistical information, see 9.3.3 Outputting Statistic Information for Each Class.

Reference note

The extended thread dump is set such as to be output by default. For details about the settings for acquiring the extended thread dump, see 3.3.19(1) Settings for Acquiring Thread Dumps of JavaVM. For details about an output information, see 5.5 JavaVM Thread Dump.

Also, you can output the class-wise statistical information in the CSV format. For details about how to output the class-wise statistical information in the CSV format, see 9.10 Class-wise statistical information analysis functionality.

9.3.2 Functionality that requires the class-wise statistical functionality

The following table lists the types and the overview of the functionality that requires the class-wise statistical functionality.

Table 9-3 Types and overview of the functionality that requires the class-wise statistical functionality

Types
Overview
Reference

Instance statistical functionality
Outputs the total size of instances that have instances of class as members, for each class.
9.4

STATIC member statistical functionality
Outputs the total size of the instances of the static members for each class.
9.5

Reference-related information output functionality
Outputs the reference relation of the class that has a specified class (instance) as member.
9.6

Pre-statistical garbage collection selection functionality
You can select whether to execute the garbage collection before a class-wise statistical information is output. Use the options to specify this functionality when executing the jheapprof command. In default setting, the garbage collection is executed before a class-wise statistical information is output.
9.7

Unused objects statistical functionality in the Tenured area
Identifies the unused objects in the Tenured area.
9.8

Base object list output functionality for Tenured augmentation factors
Outputs the information about objects acting as the base of the unused objects that are identified using the unused object statistical functionality in the Tenured area.
9.9

Among the above functionalities, an instance statistical functionality, the STATIC member statistical functionality, reference-related information output functionality, and the base object list output functionality for Tenured augmentation factors are enabled when executing the class-wise statistical functionality.

You can set the pre-statistical garbage collection selection functionality when executing the class-wise statistical functionality. Select this functionality as per the purpose of investigating the class-wise statistical information. For details, see 9.7.2 Guidelines for selecting the garbage collection.

9.3.3 Outputting Statistic Information for Each Class

This subsection describes how to output the class-wise statistical information.

Use the jheapprof commands to output the class-wise statistical information to the extended thread dump. Specify the Java process, where you want to output the class-wise statistical information, and the class, where you want to output the reference-related information, and then execute the jheapprof commands.

You can specify the following when executing the jheapprof command:

Specify whether to output the information of an Explicit heap as class-wise statistical information.

Specify whether to execute the garbage collection before acquiring the class-wise statistical information.

The execution format and the execution example of the jheapprof command and each specification method are described as follows:

Organization of this subsection

(1) Execution format and execution example of the jheapprof command

(2) When the information of an Explicit heap is output to the class-wise statistical information

(3) When specifying whether to execute the garbage collection

(1) Execution format and execution example of the jheapprof command

The execution format and example of the jheapprof command are described below: For details about the jheapprof commands, see jheapprof (output of an extended thread dump with Hitachi class-wise statistical information) in the uCosminexus Application Server Command Reference Guide.

Execution format

In Windows

jheapprof [-f|-i] [-explicit|-noexplicit] [-class class-name] [-fullgc|-copygc|-nogc] [-garbage|-nogarbage] [-rootobjectinfo|-norootobjectinfo] [-rootobjectinfost size] -p process-ID

In UNIX

jheapprof [-f|-i] [-explicit|-noexplicit] [-class class-name] [-fullgc|-copygc|-nogc] [-garbage|-nogarbage] [-rootobjectinfo|-norootobjectinfo] [-rootobjectinfost size] [-force] -p process-ID

Execution example

Here, the class-wise statistical information of Java process with process ID 2463 is output.

In the -p option, specify the process ID of the Java process where you want to output the class-wise statistical information, and then execute the jheapprof command.

% jheapprof -p 2463

When the -f option is being omitted in the jheapprof command, the following confirmation message is displayed:

In Windows

The confirmation message 'whether to output an extended thread dump with Hitachi class-wise statistical information' is displayed in the following format:

Force VM to output HitachiJavaHeapProfile: ? (y/n)

In UNIX

The confirmation message of process ID is displayed in the following format:

send SIGQUIT to 2463: ? (y/n)

Enter y.
An extended thread dump with Hitachi class-wise statistics is output. The following message is output in the running java program:

Writing Java core to javacore2463.030806215140​.txt... OK

The running java program creates an extended thread dump with Hitachi class-wise statistics (javacore.process ID.date-time.txt) in the current directory and continues the program.

(2) When the information of an Explicit heap is output to the class-wise statistical information

If the following conditions are satisfied, you can output the information of an Explicit heap to the class-wise statistical information:

-XX:+HitachiUseExplicitMemory is specified in the JavaVM start option.

Explicit heap is used for implementing the application, or setting the execution environment (J2EE server).

Specify the -explicit option in the jheapprof command, and then execute the command to output the information of an Explicit heap to the class-wise statistical information.

For details about the Explicit Memory Management functionality, see 8. Preventing the Occurrence of Full Garbage Collection by using the Explicit Memory Management Functionality in the uCosminexus Application Server Expansion Guide.

(3) When specifying whether to execute the garbage collection

You can select whether to execute the garbage collection before the class-wise statistical information is output. This functionality is called as pre-statistical garbage collection selection functionality. Specify any of the following options in the jheapprof command, if you want to execute the garbage collection before the class-wise statistical information is output:

-fullgc
Executes the full garbage collection, and then outputs the class-wise statistical information.

-copygc
Executes the copy garbage collection, and then outputs the class-wise statistical information.

-nogc
Outputs the class-wise statistical information without executing the garbage collection.

For details about the pre-statistical garbage collection selection functionality, see 9.7 Pre-statistical garbage collection selection functionality. Note that you cannot execute the pre-statistical garbage collection selection functionality, when you execute the unused objects statistical functionality in the Tenured area.

9.3.4 Precautions to output the class-wise statistical information

The precautions to be taken to output the class-wise statistical information is described as follows:

For running Java process, if you execute the jheapprof command in which the -copygc option is set, you can try to execute the pre-statistical copy garbage collection. In this case, if a free space of the Tenured area is insufficient, the copy garbage collection might not be executed.
When you cannot execute the copy garbage collection, the extended verbosegc information when garbage collection occurred is not output, even if you specify -XX:+HitachiVerboseGC in the JavaVM start option. Furthermore, an extended thread dump that contains the class-wise statistical information is output simultaneously when executing the garbage collection.

For Java process where -XX:+PrintGCDetails is specified when starting the JavaVM, you can execute the jheapprof command in which -copygc option is set, for executing the pre-statistical copy garbage collection. In this case, a 'Full GC' is output in the garbage collection that is output by specifying -XX:+PrintGCDetails.

9.4 Instance statistical functionality

This section describes the instance statistical functionality.

The instance statistical functionality is the functionality that outputs the class-wise statistical information. You can output an instance count of the class and the total size of the instances for each class.

The instance statistical functionality uses the jheapprof commands for output.

For details about the execution format and the execution examples of the jheapprof commands, see 9.3.3 Outputting Statistic Information for Each Class.

The following table describes the organization of this section.

Table 9-4 Organization of this section (Instance statistical functionality)

Category | Title | Reference
Description | Overview of the instance statistical functionality | 9.4.1
Class-wise statistical information output by the instance statistical functionality | 9.4.2

Note:

The function-specific explanation is not available for "Implementation", "Settings", "Operations", and "Notes".

Organization of this section

9.4.1 Overview of the instance statistical functionality

9.4.2 Class-wise statistical information output by the instance statistical functionality

9.4.1 Overview of the instance statistical functionality

The instance statistical functionality is used to check memory leaks in applications.

The instance statistical functionality investigates the reference relation of instances, such as relation with instances of class A->member variable of class A(the class is classB)->instances of classB->..., and recurrently adds the size of the instances without referencing to other instances in the class that has the instances as the member. In other words, the instance statistical functionality outputs the total size of the instances referenced by the class instances.

To check the cause of memory leak, execute the instance statistical functionality as follows, before and after the application processing for which you want to check the memory leak, then take the difference between the number of instances and the total size of the instances in points 1 and 3, check the amount of the increase in the numbers, and then identify the classes that are causing the memory leak.

Execute the instance statistical functionality.

Execute the application processing for which you want to check the memory leak.

Execute the instance statistical functionality.

Note that because the instance statistical functionality recursively adds the size of all the instances referenced by each class instance, you cannot check the size of only the instances of each class (the size excludes the size of the instances being referenced).

In the instance statistical functionality, when using the Explicit management heap functionality, the output result of the class-wise statistical information changes according to whether to set the instances of the Explicit heap as a target for statistics. Furthermore, specify the -explicit option in the jheapprof command, and then execute the same command to set the instances of an Explicit heap as a target for statistics.

The following figure shows an example of an instance structure that describes the output result of each statistical target.

Figure 9-1 Example of instance structure

When the statistical target contains an Explicit heap, the instances a1, b1, b2, c1, and c2 becomes the target for the class-wise statistical information. When the statistical target does not contains an Explicit heap, the instances a1, b2, and c2 becomes the target for the class-wise statistical information.

The following table lists the instance count and the total size of instances for each statistical target.

Table 9-5 Instance count and total size of instances for each statistical target

Arguments of the jheapprof command
Statistical target
Class A
Class B
Class C

Instance count
Total size#
Instance count
Total size#
Instance count#
Total size#

-explicit

Java heap

Permanent area

Explicit heap

1
122
2
22
2
2

-noexplicit

Java heap

Permanent area

1
111
1
11
1
1

#

The total size indicates the total size of the instances. The unit is bytes.

The formula for calculating the total size of the instances of each class is as follows:

When statistical target contains an Explicit heap

In class A: a1+b1+b2+c1+c2

In class B: b1+b2+c1+c2

In class C: c1+c2

When statistical target does not contains an Explicit heap

In class A: a1+b2+c2

In class B: b2+c2
(Though the instance b1 is not targeted, the instance b2 and c2 under b1 are targeted, and therefore, the size of those instances that exist in the reference relation is added to the class B)

In class C: c2

In the instance statistical functionality, investigate for the reference relation of the object referred in the following order from the object that is the base. The base objects are the objects those are not investigated in other reference relation. 1., 2., and 3. indicates the priority order for investigating reference relation.

Ascending order of the address within the Java heap

Ascending order of the address within an Explicit management heap

Ascending order of the address within the Permanent heap

When the reference destination objects are investigated, return up to the branch point, and investigate for the reference relation.

Moreover, when the reference destination objects are the objects that is the base of other reference relation, handle it as a reference destination object. Investigate for the reference relation until all the objects that are the base are lost.

When using instance statistical functionality, instance count of each class is output for number of instances. The following contents are output for the total size of instances:

The size of the object that is the base is added to the corresponding class. The size of the reference destination object is added to the corresponding class, and also added to the object that is the base and to their corresponding class of all objects that exist in the reference relation extended up to the corresponding class.

9.4.2 Class-wise statistical information output by the instance statistical functionality

This subsection describes about the output format, the output items, and the output examples of the class-wise statistical information output by the instance statistical functionality.

Organization of this subsection

(1) Output format and output items

(2) Example of output

(1) Output format and output items

The output format of the class-wise statistical information output by the instance statistical functionality is as follows:

Output format

Java Heap Profile
-----------------------
________________Size__Instances__Class________________
<total_size> <Instance_count> <class_name>
<total_size> <Instance_count> <class_name>
...

Output items

The items listed in the output format are described as follows.

Table 9-6 Output items (instance statistical functionality)

Output items | Meaning
<total_size> | The total size of the instance is output in byte unit.
<Instance_count> | The number of instance is output.
<class_name> | The class name is output.

(2) Example of output

The output example of the class-wise statistical information output by the instance statistical functionality is described as the example of the following source.

public class instance {
public static void main(String args[]) {
classA cls_a = new classA();
try {
Thread.sleep(20000);
} catch (Exception e) {}
}
}
class classA {
classB a1;
classC a2;
classA() {
a1 = new classB();
a2 = new classC();
}
}
class classB {
classD b1;
String b2;
classB() {
b1 = new classD();
b2 = null;
}
}
class classC {
String c1, c2;
classC() {
c1 = null;
c2 = null;
}
}
class classD {
String d1, d2;
classD() {
d1 = null;
d2 = null;
}
}

The following figure shows the instance structure for above source.

Figure 9-2 Instance structure (instance statistical functionality)

When using the above instance structure, add the following size for each class in the instance statistical functionality:

Size of class A: a1+a2+ b1+b2+ c1+c2+ d1+d2

Size of class B: b1+b2+ d1+d2

Size of class C: c1+c2

Size of class D: d1+d2

The following figure shows the output result of the instance statistical functionality.

Figure 9-3 Output result (instance statistical functionality)

9.5 STATIC member statistical functionality

This section describes the STATIC member statistical functionality.

The STATIC member statistical functionality is the functionality that outputs the class-wise statistical functionality. You can output the total size of instances of static members for each class.

The STATIC member statistical functionality uses the jheapprof command for output.

For details about the execution format and the execution examples of the jheapprof commands, see 9.3.3 Outputting Statistic Information for Each Class.

The following table describes the organization of this section.

Table 9-7 Organization of this section (STATIC member statistical functionality)

Category | Title | Reference
Description | Overview of the STATIC member statistical functionality | 9.5.1
Class-wise statistical information output by the STATIC member statistical functionality | 9.5.2

Note:

The function-specific explanation is not available for "Implementation", "Settings", "Operations", and "Notes".

Organization of this section

9.5.1 Overview of the STATIC member statistical functionality

9.5.2 Class-wise statistical information output by the STATIC member statistical functionality

9.5.1 Overview of the STATIC member statistical functionality

Like the instance statistical functionality, the STATIC member statistical functionality is used to check the memory leak in applications.

The point of difference with the instance statistical functionality is that the instance statistical functionality recursively adds the size of the instances referenced from the non-static fields of the instance retrieved first, while the STATIC member statistical functionality recursively adds the size of the instances referenced from the static fields (static fields of the class) of the instance retrieved first. This enables you to acquire the total size of the instances of the static member for each class. However, apart from the instances retrieved first, both instance statistical functionality and STATIC member statistical functionality check the reference relationship based on the non-static members of the instances.

For details about the difference between the instance statistical functionality and the STATIC member statistical functionality, see 9.5.2(2) Output examples.

To check the cause of a memory leak, execute the STATIC member statistical functionality as follows, before and after the application processing for which you want to check the memory leak, then take the difference between the number of instances and the total size of the instances in points 1 and 3, check the amount of increase in the numbers, and then identify the classes that are causing the memory leak.

Execute the STATIC member statistical functionality.

Execute the application processing for which you want to check the memory leak.

Execute the STATIC member statistical functionality.

Note that because the STATIC member statistical functionality recursively adds the size of the instances referenced by the static fields of each class, you cannot check the total size of only the instances of each class (the size excludes the size of the instances being referenced).

In the STATIC member statistical functionality, investigate for the reference relation from the object that is the base. The base objects are the object those are not investigated in other reference relation and refers the STATIC member of all classes of JavaVM.

When the reference destination objects are investigated, return up to the branch point, and investigate for the reference relation. Investigate for the reference relation until all the objects that are the base are lost.

When using the STATIC member statistical functionality, the following contents are output for instance count and for the total size of instances:

Add the size of all objects that exist in the reference relation and number of objects in the object that is the base. Add this value in the class having STATIC member that is referred by the object that is the base, as a statistical value.

9.5.2 Class-wise statistical information output by the STATIC member statistical functionality

This subsection describes about the output format, the output items, and the output examples of the class-wise statistical information output by the STATIC member statistical functionality.

Organization of this subsection

(1) Output format and output items

(2) Output examples

(1) Output format and output items

The output format of the class-wise statistical information output by the STATIC member statistical functionality is as follows:

Output format

Java Heap Dump Static Profile
-----------------------
________________Size__Instances__Class________________
<total_size> <Instance_count> <class_name>
<total_size> <Instance_count> <class_name>
...

Output items

The items listed in the output format are described as follows.

Table 9-8 Output items (STATIC member statistical functionality)

Output items | Meaning
<total_size> | The total size of the instance is output in byte unit.
<Instance_count> | The number of instance is output.
<class_name> | The class name is output.

(2) Output examples

The output example of the class-wise statistical information output by the STATIC member statistical functionality, is described as an example of the following source:

public class static_instance {
public static void main(String args[]) {
classA cls_a;
classB cls_b;
classC cls_c;

cls_a = new classA();
cls_b = new classB();
cls_c = new classC();
cls_b.cls_c = cls_c;
cls_a.cls_b = cls_b;

try {
Thread.sleep(20000);
} catch (Exception e) {}
}
}
class classA {
static classB cls_b;
}
class classB {
classC cls_c;
}
class classC {
}

The following figure shows the output result of the STATIC member statistical functionality.

Figure 9-4 Output result (STATIC member statistical functionality)

Moreover, there is a difference in the reference relation for the above source in the instance statistical functionality and in the STATIC member statistical functionality and the following figure shows this difference.

Figure 9-5 Difference in reference relation in the instance statistical functionality and in the STATIC member statistical functionality

The reference relation of the respective functionality is as follows:

Reference relation of the instance statistical functionality
Instance variable cls_b of Instance A ->Instance variable cls_c of instance B -> Instance C

Reference relation of the STATIC member statistical functionality
Class variable cls_b of class A ->Instance variable cls_c of instance B -> Instance C

9.6 Reference-related information output functionality

This section describes about the reference-related information output functionality.

You can output the reference relation of the instances for the specified class in a sequence from the beginning, using the reference-related information output functionality.

The following table describes the organization of this section.

Table 9-9 Organization of this section (reference-related information output functionality)

Category | Title | Reference
Description | Overview of the reference-related information output functionality | 9.6.1
Class-wise statistical information output by the reference-related information output functionality | 9.6.2
Class-wise statistical information output by the static field-based reference relationship output functionality | 9.6.3
Notes | Notes for the output of the static field-based reference relationships | 9.6.4

Note:

The function-specific explanation is not available for "Implementation", "Settings", and "Operations".

Organization of this section

9.6.1 Overview of the reference-related information output functionality

9.6.2 Class-wise statistical information output by the reference-related information output functionality

9.6.3 Class-wise statistical information output by the static field-based reference relationship output functionality

9.6.4 Notes for the output of the static field-based reference relationships

9.6.1 Overview of the reference-related information output functionality

The class from which an instance of the class that is specified in the -class option of the jheapprof command is to be referenced, is output in the sequence beginning from the reference relation of the instance.

If there are many instances of the specified class, all the corresponding instances are output. Even if there are many instances having same name, you can identify the instances separately since the following information is output after the instance name:

Address of the instance

Area name to which instance belongs

In the reference-related information output functionality, investigate for the reference relation of object referred in the following order from the object that is the base. The base objects are the objects those are not investigated in other reference relation. 1., 2., and 3. indicates the priority order for investigating reference relation.

Ascending order of the address within the Java heap

Ascending order of the address within an Explicit management heap

Ascending order of the address within the Permanent heap

When the reference destination object is the class specified in the -class option, the reference relation extended from the base object up to the object of the class specified in the -class option, is output in the reference-related information. Moreover, when the reference destination objects are investigated, return up to the branch point, and investigate for the reference relation. Moreover, when the reference destination objects are the objects that is the base of other reference relation, handle it as a reference destination object. Investigate for the reference relation until all the objects that are the base are lost.

Also, the static field-based reference relationship output functionality is enabled when you specify the -staticroot option with the jheapprof command. The reference relationship output functionality is a prerequisite for this functionality. With the static field-based reference relationship output functionality, the static field-based reference relationship is additionally output to the reference relationship output by the reference relationship output functionality. This output information is used to ascertain the cause of the memory leak using the reference relationships based on static fields.

The following figure shows an example of a reference relationship with a memory leak:

If you execute the static field-based reference relationship output functionality for the reference relationship instance d/Cd in the figure, the following reference relationship is output:

Based on this information, the references of the following fields will be cleared as a measure against the leak. Due to this, the d/Cd instance is collected in a garbage collection, so the memory leak can be resolved.

Instance field id1 of the instance c/Cc

Static field sd1 of the class Ca

For details on the reference relationships of the reference relationship output functionality, see 9.6.2 Class-wise statistical information output by the reference-related information output functionality, and for the static field-based reference relationships, see 9.6.3 Class-wise statistical information output by the static field-based reference relationship output functionality.

9.6.2 Class-wise statistical information output by the reference-related information output functionality

This subsection describes about the output format, the output items, and the output examples of the class-wise statistical information output by the reference-related information output functionality.

Organization of this subsection

(1) Output format and output items

(2) Example of output

(1) Output format and output items

The output format of the class-wise statistical information output by the reference-related information output functionality is as follows:

Output format

Reference of class <option-specified-class-name>
--------------------------------------------#
<class-name>(<address>)[<area-name>]
<class-name>(<address>)[<area-name>]
<option-specified-class-name>(<address>)[<area-name>]
------
<class-name>(<address>)[<area-name>]
java.lang.ref.Finalizer<<repetition-count> times>
<class-name>(<address>)[<area-name>]
<class-name>(<address>)[<area-name>]
<option-specified-class-name>(<address>)[<area-name>]
------
...

# '-(hyphen)' for the number in which 19 is added is output to the string length of the option-specified-class-name.

Output items

The each items listed in the output format are described as follows:

Table 9-10 Output items (reference-related information output functionality)

Output items
Meaning

<Class name>
The class name to be referenced by an instance of the class that is specified in the -class option of the jheapprof command is output.

<Address>
The address of the instance is output.

Area-name
The area where instance belongs is output.

Eden: Indicates Eden area.

Survivor: Indicates Survivor area.

Tenured: Indicates Tenured area.

Perm: Indicates Permanent area.

EM(eid=<id>): Indicates Explicit memory block.

Option-specified-class-name
The class name specified in the -class option of the jheapprof command is output.

java.lang.ref.Finalizer
The object of java.lang.ref.Finalizer created in the class having the finalize() method is output all together.

Iteration-count
The count where the reference of the Finalizer instance is continuous is output.

(2) Example of output

The output example of the class-wise statistical information output by the reference-related information output functionality, is described as the example of the following source:

public class instance2 {
public static void main(String args[]) {
classA cls_a1 = new classA(); classA cls_a2 = new classA();
classB cls_b1 = new classB(); classB cls_b2 = new classB();
classC cls_c1 = new classC(); classC cls_c2 = new classC();
classC cls_c3 = new classC(); classC cls_c4 = new classC();
cls_a1.cls_a = cls_a2; cls_a1.cls_b = cls_b1;
cls_a1.cls_c = cls_c1; cls_a2.cls_b = cls_b2;
cls_b1.cls_c = cls_c2; cls_b2.cls_c = cls_c3;
cls_c1.cls_c = cls_c4;
try {
Thread.sleep(20000);
} catch (Exception e) {}
}
}
class classA {
classA cls_a;
classB cls_b;
classC cls_c;

classA() {
classB cls_b;
}
}
class classB {
classC cls_c;
}
class classC {
classC cls_c;
}

The following figure shows the instance structure.

Figure 9-6 Instance structure (reference-related information output functionality)

The following figure shows the output result of the reference-related information output functionality. In such case, specify an argument -class class-name in the jheapprof command, and then execute the command.

Figure 9-7 Output result (reference-related information output functionality)

The address of all class A has same addresses (0x10766840). Therefore, it is understood that instances of all class A are same. On the other hand, the class B in (1) and (4) has different address and therefore, has different instances.

Note that the placement for the instances on the memory is changed due to the garbage collection occurrence. Therefore, whenever the address and the area name is output, they might change every time.

9.6.3 Class-wise statistical information output by the static field-based reference relationship output functionality

This subsection describes the output format, output items, and examples of output of the class-wise statistical information output by the static field-based reference relationship output functionality.

Organization of this subsection

(1) Output format and output items

(2) Examples of output

(1) Output format and output items

Output format

The output format of the class-wise statistical information output by the static field-based reference relationship output functionality is as follows:

Reference of class option-specified-class-name from static field
-------------------------------------------------------------#¹
static field static-field-declaring-class-name#².static-field-name#²
class-name(address)[area-name]
class-name(address)[area-name]
option-specified-class-name(address)[area-name]
------
...

#1:

The number of "-" (hyphens) that are output is equal to 37 added to the number of characters in option-specified-class-name.

#2:

Indicates the base of the reference relationship.

Output items

The following table describes the items shown in the output format.

Table 9-11 Output items (static field-based reference relationship output functionality)

Output items
Meaning

static-field-declaring-class-name
The class name declaring the static field that forms the base is output.

static-field-name
The name of the static field that forms the base is output.

class-name
The class name of the instance that references the instances of the classes specified in the -class option of the jheapprof command is output.

address
The address of the instance is output.

area-name
The area to which the instance belongs is output.

Eden: Indicates the Eden area.

Survivor: Indicates the Survivor area.

Tenured: Indicates the Tenured area.

Perm: Indicates the Permanent area.

EM(eid=<id>): Indicates the Explicit memory block.

option-specified-class-name
The class name specified in the -class option of the jheapprof command is output.

(2) Examples of output

This subsection gives an example output of the class-wise statistical information output by the static field-based reference relationship output functionality using the following source as an example:

import JP.co.Hitachi.soft.jvm.MemoryArea.*;
public class static_reference {
public static void main(String args[]) {
try {
classA cls_a1 = new classA();
classB cls_b1 = new classB();
classB cls_b2 = new classB();
classC cls_c1 = new classC();
classC cls_c2 = new classC();
classC cls_c3 = new classC();
BasicExplicitMemory emem = new BasicExplicitMemory();
classC cls_c4 = (classC)emem.newInstance(classC.class);
cls_a1.s_cls_a = cls_a1;
cls_a1.s_cls_b = cls_b1;
cls_a1.s_cls_c = cls_c1;
cls_a1.cls_b = cls_b2;
cls_b1.cls_c = cls_c2;
cls_b2.cls_c = cls_c3;
cls_c1.cls_c = cls_c4;
Thread.sleep(20000);
} catch (Exception e) {e.printStackTrace();}
}
}
class classA {
static classA s_cls_a;
static classB s_cls_b;
static classC s_cls_c;
classB cls_b;
}
class classB {
classC cls_c;
}
class classC {
classC cls_c;
public classC(){
}
}

The following figure shows the structure of the instances.

Figure 9-8 Structure of the instances (static field-based reference relationship output functionality)

The following figure shows the output result of the static field-based reference relationship output functionality. In this case, the jheapprof command is executed specifying the argument -class class-name -staticroot.

Figure 9-9 Output result (static field-based reference relationship output functionality)

9.6.4 Notes for the output of the static field-based reference relationships

If the static field-based reference relationship output functionality is enabled, the execution time of the jheapprof command is longer by the time taken for executing the reference relationship output functionality, as compared to when the static field-based reference relationship output functionality is disabled.

9.7 Pre-statistical garbage collection selection functionality

This section describes about the pre-statistical garbage collection selection functionality.

You can use the pre-statistical garbage collection selection functionality for selecting the processing that is to be executed before the class-wise statistical information is output.

The following table describes the organization of this section.

Table 9-12 Organization of this section (Pre-statistical garbage collection selection functionality)

Category | Title | Reference
Description | Overview of the pre-statistical garbage collection selection functionality | 9.7.1
Guidelines for selecting the garbage collection | 9.7.2

Note:

The function-specific explanation is not available for "Implementation", "Settings", "Operations", and "Notes".

Organization of this section

9.7.1 Overview of the pre-statistical garbage collection selection functionality

9.7.2 Guidelines for selecting the garbage collection

9.7.1 Overview of the pre-statistical garbage collection selection functionality

You can execute the class-wise statistical functionality to output the class-wise statistical information to the extended thread dump. In the pre-statistical garbage collection selection functionality, you can select the processing that is to be executed before the class-wise statistical information is output. By selecting this processing that is to be executed, you can acquire the various changes in the appearance of the Java object in the class-wise statistical information, depending on the purpose of investigation.

When using the pre-statistical garbage collection selection functionality, specify the processing to be executed by an argument of the jheapprof command. The following table lists the process and the arguments of the jheapprof commands that can be implemented before executing the class-wise statistical functionality.

Table 9-13 Process and the arguments of the jheapprof commands that can be implemented before executing the class-wise statistical functionality

Type of process | Process contents | Argument of the jheapprof command
Execution of a full garbage collection | Collects the used object for an entire JavaVM specific area even including Tenured area. | -fullgc
Execution of a copy garbage collection | Collects the used object only for the Eden area and for the Survivor area | -copygc
No execution of a garbage collection | Does not collect the used object though available. | -nogc

Note that if you execute the class-wise statistical functionality when specifying -XX:+HitachiVerboseGC and -XX:+HitachiVerboseGCPrintCause in the JavaVM start option, the following information is output to extended verbosegc information:

Type of garbage collection

Cause for garbage collection occurrence in the extended thread dump

The above information differs with the information output by an argument specified in the jheapprof command. The following table lists the relation between the arguments of the jheapprof command and the output information.

Table 9-14 Relation between the arguments of the jheapprof command and the output information

Argument of the jheapprof command | Type of garbage collection | Cause for garbage collection occurrence
-fullgc | FullGC | JHeapProf Command
-copygc | GC | JHeapProf Command

9.7.2 Guidelines for selecting the garbage collection

The processing that is to be specified using the pre-statistical garbage collection selection functionality differs depending on the purpose of investigating the class-wise statistical information to be output.

The guidelines for selecting the processing depending on the purpose of investigation is described here.

Specify the processing that can be selected using the pre-statistical garbage collection selection functionality by the argument of the jheapprof command. Depending on the object that is to be investigated or depending on the class-wise statistical information used in the type of investigation, you can select the processing.

The following table lists the guidelines for selecting the processing.

Table 9-15 Guidelines for selecting the processing

Processing
(argument of the jheapprof command)
Investigation target
Example of how to investigate the class-wise statistical information

Execution of a full garbage collection (-fullgc)
Changing the object by full garbage collection
You can identify the object that causes the memory leak of the Java heap, since the used object is collected by full garbage collection.

Execution of a copy garbage collection (-copygc)
Changing the object by copy garbage collection
By a copy garbage collection, you can identify the object with a long life that migrates to the Tenured area. From this information, you can identify the object that causes increase in the occurrence count of the full garbage collection.

No execution of a garbage collection (-nogc)#
Object with short life is being collected by executing garbage collection
Information on all objects including the used object is output. You can identify the object with a high memory sharing that becomes the cause (super-large object) when the copy garbage collection occurs frequently.

#

When -nogc is specified in the argument of the jheapprof command, the information on all short-lived objects is output, and therefore, the log output volume increases.

9.8 Unused objects statistical functionality in the Tenured area

This section describes the unused objects statistical functionality in the Tenured area.

The unused objects statistical functionality in the Tenured area is the functionality used to output the class-wise statistical information. You can use this functionality in the Tenured area to identify the unused objects of the Tenured area.

To use the statistical functionality for the unused objects of the Tenured area, specify -garbage in the arguments of the jheapprof command. For details on the jheapprof command, see jheapprof (output of an extended thread dump with Hitachi class-wise statistical information) in the uCosminexus Application Server Command Reference Guide.

The following table describes the organization of this section.

Table 9-16 Organization of this section (Unused objects statistical functionality in the Tenured area)

Category | Title | Reference
Description | Overview of the unused objects statistical functionality in the Tenured area | 9.8.1
Class-wise statistical information output by the unused objects statistical functionality in the Tenured area | 9.8.2
Notes | Notes for executing the unused objects statistical functionality in the Tenured area | 9.8.3

Note:

The function-specific explanation is not available for "Implementation", "Settings", and "Operations".

Organization of this section

9.8.1 Overview of the unused objects statistical functionality in the Tenured area

9.8.2 Class-wise statistical information output by the unused objects statistical functionality in the Tenured area

9.8.3 Notes for executing the unused objects statistical functionality in the Tenured area

9.8.1 Overview of the unused objects statistical functionality in the Tenured area

You can use the unused objects statistical functionality in the Tenured area to identify only the unused objects that are accumulated in the Tenured area, and output them to the thread dump file. This subsection describes the mechanism of the unused objects statistical functionality in the Tenured area.

Organization of this subsection

(1) Output of the size of unused objects

(2) Checking the reference relationship of unused objects

(1) Output of the size of unused objects

Objects with a long life accumulate in the Tenured area based on iteration of the copy garbage collection. Among the accumulated objects with a long life, the objects that lose their usage as time lapses, remain in the Tenured area as unused objects. After this, a full garbage collection occurs, when the memory becomes full. You can check the usage of the Tenured area from the time of occurrence of a copy garbage collection until the time of occurrence of a full garbage collection using the unused objects statistical functionality in the Tenured area and the instance statistical functionality.

The following figure shows the contents that you can identify using the unused objects statistical functionality in the Tenured area and the instance statistical functionality.

Figure 9-10 Contents that can be identified using the unused objects statistical functionality in the Tenured area and the instance statistical functionality

When the instance statistical functionality is executed without executing the pre-statistical garbage collection, the size of the unused object shown in step 3 in Figure 9-10 is output. This size is same as the memory usage status in the Tenured area that includes the size of unused objects of the Tenured area corresponding to step 1 of Figure 9-10 and the objects in use in the Tenured area corresponding to step 2 of Figure 9-10. On the other hand, when you execute the unused objects statistical functionality in the Tenured area, you can output the memory usage status (corresponding to step 1 of Figure 9-10) in the Tenured area that excludes the objects in use shown in step 2 of Figure 9-10. You can use the unused objects statistical functionality in the Tenured area to identify the unused objects that act as the augmentation factors for the Tenured area, which enables you to inhibit the full garbage collection.

(2) Checking the reference relationship of unused objects

In the unused objects statistical functionality of the Tenured area, search the base objects in the ascending order of their address in the Tenured area. Even among the searched objects, the objects that are not investigated in another reference relationship become the base objects.

When you have already investigated the referenced objects, return to the branching point and investigate the reference relationship. Also, if a referenced object is the base object of another reference relationship, then handle as a referenced object. Investigate a reference relationship until all base objects are eliminated.

For the unused objects statistical functionality in the Tenured area, the total of the number of instances and instance size is output. Add the corresponding classes for number of instances. The following contents are output to the total size of instances:

The size of the base objects is added to the corresponding class. The size of the referenced objects is added to the corresponding class, and then added to the corresponding classes of the base objects and all objects that exist in the reference relationship up to the corresponding class.

Note that when you execute the unused objects statistical functionality in the Tenured area, the instance statistical functionality, STATIC member statistical functionality, and pre-statistical garbage collection selection functionality become disabled.

The following figure shows an example of the reference relationship based on the unused objects in the Tenured area.

Figure 9-11 Example of the reference relationship based on the unused objects in the Tenured area

The reference relationship shown in Figure 9-11 is described as follows:

Number of instances

classA: One, because of the existence of a1

classB: Two, because of the existence of b1 and b2

classC: Two, because of the existence of c1 and c2

Total instance size

classA: 122, when the size of the instance of classA (a1) and the size of the referenced instances (b1, b2, c1, c2) are added

classB: 22, when the size of the instances of classB (b1, b2) and the size of the referenced instances (c1, c2) are added

classC: 2, when the instances of classC (c1, c2) are added

The following is an output example, when the reference-related information shown in Figure 9-11 is output by executing the unused objects statistical functionality in the Tenured area:

Garbage Profile
---------------
________________Size__Instances__Class________________
122 1 A
22 2 B
2 2 C

9.8.2 Class-wise statistical information output by the unused objects statistical functionality in the Tenured area

This subsection describes the output format, output items, and output example of the class-wise statistical information output by the unused objects statistical functionality in the Tenured area.

Organization of this subsection

(1) Output format and output items

(2) Output example

(1) Output format and output items

The output format of the class-wise statistical information output by the unused objects statistical functionality in the Tenured area is as follows:

Output format

Garbage Profile
-----------------------
________________Size__Instances__Class________________
size number class-name
size number class-name...

Output items

Each item listed in the output format is described as follows.

Table 9-17 Output items (Unused objects statistical functionality in the Tenured area)

Output item | Meaning
Size | The total size of instances is output in bytes.
Number | The number of instances is output.
Class-name | The class name is output.

(2) Output example

The following is an output example of the class-wise statistical information output by the unused objects statistical functionality in the Tenured area:

Garbage Profile
---------------
________________Size__Instances__Class________________
35234568​ 10648 java.util.HashMap
5678900​ 10668 [Ljava.util.HashMap$Entry;
4456788​ 7436 java.util.HashMap$Entry
4321000​ 200 java.util.WeakHashMap
1234568​ 190 [Ljava.util.WeakHashMap$Entry
454400 4 java.util.WeakHashMap$Entry
0 0 java.lang.Class
...

9.8.3 Notes for executing the unused objects statistical functionality in the Tenured area

This subsection describes the notes for executing the unused objects statistical functionality in the Tenured area.

Organization of this subsection

(1) Notes for executing the unused objects statistical functionality in the Tenured area immediately after a full garbage collection

(2) Notes on statistical results

(3) Notes on objects for which the statistics are not to be collected

(4) Notes for reference relationship from multiple objects

(5) Notes for increasing the statistical value

(1) Notes for executing the unused objects statistical functionality in the Tenured area immediately after a full garbage collection

If you execute the unused objects statistical functionality in the Tenured area immediately after a full garbage collection, the statistical processing is executed when the unused objects in the Tenured area for which the statistics are to be collected have been recovered. Therefore, the total instance size within the class-wise statistical information and the number of instances becomes less, and the unused objects cannot be identified effectively. To effectively identify the unused objects, execute the unused objects statistical functionality in the Tenured area. A separate description is provided for executing the unused objects statistical functionality in the Tenured area; when the timing of occurrence of a full garbage collection is known and when the timing is not known.

(a) When the timing of occurrence of a full garbage collection is known

If you execute the unused objects statistical functionality in the Tenured area immediately before a full garbage collection, the statistical processing is executed when the number of unused objects in the Tenured area for which the statistics are to be collected is large. Therefore, the total instance size within the class-wise statistical information and the number of instances becomes large, and the unused objects can be identified effectively.

(b) When the timing of occurrence of a full garbage collection is not known

To increase the total instance size within the class-wise statistical information, the number of instances, and effectively identify the unused objects:

To know the timing of occurrence of a full garbage collection, set the -XX:+HitachiVerboseGC option to output the extended verbosegc information during the JavaVM startup. By specifying the option, you can acquire the information about a garbage collection.

Execute the unused objects statistical functionality in the Tenured area at a fixed interval in JavaVM. As a result, you can acquire the garbage collection information and multiple class-wise statistical information.

You can acquire the date and time of a full garbage collection from the extended verbosegc information, and therefore select a case of class-wise statistical information that is close to the full garbage collection. The class-wise statistical information close to the full garbage collection is information about the statistical processing executed when the number of unused objects in the Tenured area for which statistics are to be collected is large.

(2) Notes on statistical results

The following is an example of reference relationship showing the notes on statistical results.

Figure 9-12 Example of reference relationship (Notes on statistical results)

In this figure, when you assume a1 as the lowest address, the statistical processing is executed with the reference relationship a1 b1 c1 in which a1 is the base object. At this point, if you assume b1 or c1 as the base object, expected results will not be output to the statistical results of the unused objects statistical functionality in the Tenured area and the base object list output functionality for Tenured augmentation factors.

(3) Notes on objects for which the statistics are not to be collected

The following figure shows the objects for which the statistics are not to be collected for a case in which the objects (a1 and c1) of the Tenured area have a reference relationship with the object (b1) of other than the Tenured area.

Figure 9-13 Example of reference relationship (Objects for which the statistics are not to be collected)

In this figure, the statistics are not collected for the object (b1) that belongs to other than the Tenured area. However, the size of the referenced object (c1) of the Tenured area is added to the total instance size of the class B.

(4) Notes for reference relationship from multiple objects

The following figure shows a reference relationship from multiple objects for a case having a reference relationship in which one object (b1) is referenced from multiple reference sources (c1 and d1).

Figure 9-14 Example of reference relationship (For a reference relationship from multiple objects)

In this figure, if you execute the unused objects statistical functionality in the Tenured area, the statistical processing is executed from the base object having the lowest address among the base objects (c1 and a1) of the reference relationship to which the reference source belongs. Therefore, if a1 is the object with the lowest address and c1 is the base object, the expected results will not be output in the statistical results of the unused objects statistical functionality in the Tenured area and the base object list output functionality for Tenured augmentation factors.

(5) Notes for increasing the statistical value

If executing the unused objects statistical functionality in the Tenured area and the base object list output functionality for Tenured augmentation factors in a Java process in which the -XX:+HitachiAutoExplicitMemory option is specified, the following phenomena occurs:

In the class-wise statistical information output by the unused objects statistical functionality in the Tenured area, the total instance size of the float type array type (information in which [F is output in the class name) and the statistical value of the number of instances becomes larger than the original statistical value. An output example of the class-wise statistical information is as follows:

Garbage Profile
---------------
________________Size__Instances__Class________________
43861400​ 473859 [F
0 0 java.util.Collections$EmptyMap
0 0 sun.security.util.Debug
0 0 java.nio.ByteOrder

If you output a float type array type (information in which [F is output in the class name) in the base object list that is output by the base object list output functionality for Tenured augmentation factors, the total statistical value of the instance size becomes larger than the original statistical value. An output example of the base object list for Tenured augmentation factors is as follows:

Garbage Profile Root Object Information
---------------------------------------
*, [F # 43861400​

If you are using versions earlier than 08-70, specify the -XX:-HitachiExplicitMemoryPartialTenuredAreaCollection option to prevent occurrence of this phenomenon.

9.9 Base object list output functionality for Tenured augmentation factors

This section describes the base object list output functionality for Tenured augmentation factors.

The base object list output functionality for Tenured augmentation factors is used to output the class-wise statistical information. You can use the base object list output functionality for Tenured augmentation factors to output the base object information of the unused objects that are identified using the unused objects statistical functionality in the Tenured area.

To use the base object list output functionality for Tenured augmentation factors, specify -rootobjectinfo in the arguments of the jheapprof command. For details on the jheapprof command, see jheapprof (output of an extended thread dump with Hitachi class-wise statistical information) in the uCosminexus Application Server Command Reference Guide.

The following table describes the organization of this section.

Table 9-18 Organization of this section (Base object list output functionality for Tenured augmentation factors)

Category | Title | Reference
Description | An overview of the base object list output functionality for Tenured augmentation factors | 9.9.1
Class-wise statistical information output by the base object list output functionality for Tenured augmentation factors | 9.9.2

Note:

The function-specific explanation is not available for "Implementation", "Settings", "Operations", and "Notes".

Organization of this section

9.9.1 Overview of the base object list output functionality for Tenured augmentation factors

9.9.2 Class-wise statistical information output by the base object list output functionality for Tenured augmentation factors

9.9.1 Overview of the base object list output functionality for Tenured augmentation factors

With the base object list output functionality for Tenured augmentation factors, you can use the unused objects statistical functionality in the Tenured area to list the base object information of unused objects and output to the thread dump file.

The unused objects statistical functionality in the Tenured area is a prerequisite for the base object list output functionality for Tenured augmentation factors.

Hint

You can specify the information acquired using the base object list output functionality for Tenured augmentation factors in the automatic allocation setup file that is specified when you use the Explicit management heap functionality. For details about using the Explicit management heap with the automatic allocation configuration file, see 8.13.2 Using the Explicit Memory Management functionality with the automatic allocation configuration file in the uCosminexus Application Server Expansion Guide.

This subsection describes the mechanism of the base object list output functionality for Tenured augmentation factors.

Organization of this subsection

(1) Output of the base object list

(2) Checking the reference relationship of unused objects

(1) Output of the base object list

The base object list output functionality for Tenured augmentation factors is executed in continuation after the processing of the unused objects statistical functionality in the Tenured area. For details about the processing executed in the unused objects statistical functionality in the Tenured area, see the subsection 9.8.1 Overview of the unused objects statistical functionality in the Tenured area.

In the base object list output functionality for Tenured augmentation factors, search the objects in the ascending order of their address within the Tenured area. Among the searched objects, acquire the class information of objects that are already investigated in a reference relationship, and also the information of unused objects and save in an output options list.

The information saved in the output options list is sorted according to the total instance size, and only the class information in which the total size is more than the value specified in the -rootobjectinfost option of the jheapprof command are output.

(2) Checking the reference relationship of unused objects

The following is an example of the reference relationship based on the unused objects within the Tenured area, when you execute the base object list output functionality for Tenured augmentation factors to acquire the base objects.

Number of instances

classA: One, because of the existence of a1

classB: Two, because of the existence of b1 and b2

classC: Two, because of the existence of c1 and c2

Total instance size

classA: 122, when the size of the instance of classA (a1) and the size of the referenced instances (b1, b2, c1, c2) is totaled

classB: 22, when the size of the instances of classB (b1, b2) and the size of the referenced instances (c1, c2) is totaled

classC: 2, when the instances of classC (c1, c2) are totaled

Figure 9-15 Example of the reference relationship based on the unused objects within the Tenured area

When you execute the unused objects statistical functionality in the Tenured area to acquire information about a reference relationship as is shown in Figure 9-15, the information acquired by the base object list output functionality for Tenured augmentation factors will be as follows:

Base point object: a1

Class of the base point object: A

Total instance size of class A of the base point object: 122

The following is an output example for the case when you execute the base object list output functionality for Tenured augmentation factors to output the information about the reference relationship as shown in Figure 9-15:

Garbage Profile Root Object Information
---------------------------------------
*, A # 122

9.9.2 Class-wise statistical information output by the base object list output functionality for Tenured augmentation factors

This subsection describes the output format and output items of the class-wise statistical information output using the base object list output functionality for Tenured augmentation factors.

Output format

Garbage Profile Root Object Information
---------------------------------------
*, class-name # size
...

Output items

The following table lists each item in the output format.

Table 9-19 Output items (Base object list output functionality for Tenured augmentation factors)

Output item | Meaning
Class-name | The class name of base objects acting as the Tenured augmentation factors is output.
Size | The total instance size acquired from the class-wise statistical information of the unused objects statistical functionality in the Tenured area is output in bytes.

9.10 Class-wise statistical information analysis functionality

This section describes the class-wise statistical information analysis functionality.

If using the class-wise statistical information analysis functionality, you can output the information acquired as class-wise statistical information in the CSV format.

The following table describes the organization of this section.

Table 9-20 Organization of this section (Class-wise statistical information analysis functionality)

Category | Title | Reference
Description | Overview of the class-wise statistical information analysis functionality | 9.10.1
Output example of the class-wise statistical information analysis functionality | 9.10.2
Notes | Notes for the class-wise statistical information analysis functionality | 9.10.3

Note:

The function-specific explanation is not available for "Implementation", "Settings", and "Operations".

Organization of this section

9.10.1 Overview of the class-wise statistical information analysis functionality

9.10.2 Output example of the class-wise statistical information analysis functionality

9.10.3 Notes for the class-wise statistical information analysis functionality

9.10.1 Overview of the class-wise statistical information analysis functionality

Execute the jheapprofanalyzer command (class-wise statistical information analysis functionality) to output the total instance size of each class and the number of instances of each class in the time series, assuming multiple extended thread dump files with class-wise statistical information as input files. The files are output in the CSV format.

The following figure shows the flow execute the class-wise statistical information analysis functionality for the CSV output of the information that is acquired as the class-wise statistical information.

Figure 9-16 Flow of CSV output by executing the class-wise statistical information analysis functionality

Using the class-wise statistical information analysis functionality, you can output the information about the instances with large total size and can check the memory usage of only such instances. To output only the instances with large total size, specify the threshold value in -DJP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.threshold, and then specify in the jheapprofanalyzer command and execute the command. For details about the jheapprofanalyzer command, see jheapprofanalyzer (CSV output of Hitachi class-wise statistical information analysis file) in the uCosminexus Application Server Command Reference Guide.

9.10.2 Output example of the class-wise statistical information analysis functionality

This subsection describes the input files, output files, and output format of the class-wise statistical information analysis functionality.

Organization of this subsection

(1) Input files

(2) Output files

(3) Output format

(1) Input files

The extended thread dump files in which the class-wise statistical information is output are used as the input files in the class-wise statistical information analysis functionality.

(2) Output files

The files output in the class-wise statistical information analysis functionality include two types of files, such as files that output the total instance size of each class and files that output the number of instances of each class. The output files are created in the current directory with the following names.

Table 9-21 Names of output files

Type of output file | Example of output file name
Instance total size file | JheapprofAnalyzer_size_nnn.csv
Instance count file | JheapprofAnalyzer_num_nnn.csv

Legend:

nnn: The file segmentation number is output. The segmentation number is in the range of 001 to 999.

The output file is segmented when the number of columns exceeds 201. When the number of files exceeds 999, the count returns to 001 and files are re-written.

When the number of columns at which segmentation is performed exceeds 201 (1 column for class name + 200 columns for value), the output format is the same for the segmented file as well.

(3) Output format

The following figure shows the output format of the files output in the class-wise statistical information analysis file. Note that the output format of the CSV file in which the total instance size and number of instances are output is also the same.

Figure 9-17 Output format of files output in the class-wise statistical information analysis functionality

Demarcate a class name and value, and a value from another value with a comma. End a line with a value (including a blank).

Class names are output in a random order. Based on the date displayed as the value in the first row of an input file, the input files are arranged side by side starting from the file with the oldest date. If input files with the same date exist, they are connected randomly and arranged side by side.

Reference note

If you execute the class-wise statistical information analysis functionality more than once, classes might be removed or added during processing. Also, 0 will be output as the value when the corresponding class does not exist. The following figure shows the class information.

Figure 9-18 Example of class information

In case with the above class information, the output results when 0 is set as the threshold value for -DJP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.threshold are as shown in Figure 9-17:

Figure 9-19 Output example of the class-wise statistical information analysis functionality

The maximum value of total instance size is 0 to 2⁶³-1, and the maximum value of the number of instances is 0 to 2³¹-1. If the same class name exists in an input file, the total instance size is added. The number of instances is also added. If the respective maximum values are exceeded due to adding up, the specified maximum value is output. Note that if the corresponding class information does not exist in all input files of a class or if the threshold value is not reached, the information of that class is not output.

9.10.3 Notes for the class-wise statistical information analysis functionality

The notes for using the class-wise statistical information analysis functionality are as follows:

You cannot use the class-wise statistical information analysis functionality, when the JDK version is JDK 6.

Do not update and delete an input file during the execution of the jheapprofanalyzer command. The files are opened twice; once during the acquisition of the date and the second time during data reading using the class-wise statistical information analysis functionality. Therefore, the results will not be guaranteed, when you update and delete an input file during the execution of the command.

9.11 Tenuring distribution information output functionality of the Survivor area

This section describes about the tenuring distribution information output functionality of the Survivor area.

You can use the tenuring distribution information output functionality of the Survivor area for investigating the Use Status of the Survivor area when executing the copy garbage collection. You can use this information for tuning the memory size.

The following table describes the organization of this section.

Table 9-22 Organization of this section (tenuring distribution information output functionality of the Survivor area)

Category | Title | Reference
Description | Overview of the tenuring distribution information output functionality of the Survivor area | 9.11.1
Output format and output example of the tenuring distribution information of the Survivor area | 9.11.2
Settings | Settings for execution environment | 9.11.3
Notes | Precautions when using tenuring distribution information output functionality of the Survivor area | 9.11.4

Note:

The function-specific explanation is not available for "Implementation" and "Operations".

Organization of this section

9.11.1 Overview of the tenuring distribution information output functionality of the Survivor area

9.11.2 Output format and output example of the tenuring distribution information of the Survivor area

9.11.3 Settings for execution environment

9.11.4 Precautions when using tenuring distribution information output functionality of the Survivor area

9.11.1 Overview of the tenuring distribution information output functionality of the Survivor area

In product JavaVM, the output contents of the log are expanded more than that of a standard JavaVM, so that you can acquire more troubleshooting information. The product JavaVM log is output to the Hitachi JavaVM log file. The tenuring distribution information output functionality of the Survivor area outputs the tenuring distribution information of the Java object of the Survivor area to the Hitachi JavaVM log file when executing the copy garbage collection. You can use this information for investigating the Use Status of the object of the Survivor area and for tuning the memory size of the Survivor area. For details about the tuning the memory size of the Survivor area, see 7.5.1 Estimating the memory size of the Survivor area in Java heap in the uCosminexus Application Server System Design Guide.

You can output the tenuring distribution information of the Survivor area even if XX:+PrintTenuringDistribution is specified. However, you can use the tenuring distribution information output functionality of the Survivor area, even to output the date and time, in addition to the tenuring distribution information of the Survivor area. Moreover, since the output destination is the Hitachi JavaVM log file, you can obtain synchronization with other logs.

For details about the Hitachi-specific Java VM log file, see 4.10 JavaVM Log (JavaVM Log File). Moreover, for details about the tuning of Java VM, see 7. JavaVM Memory Tuning in the uCosminexus Application Server System Design Guide.

9.11.2 Output format and output example of the tenuring distribution information of the Survivor area

The tenuring distribution information of the Survivor area is output following to the log of the copy garbage collection when the copy garbage collection occurs. The output format and the output example of the tenuring distribution information of the Survivor area are as follows:

Output format

[PTD]<date>[Desired survivor:size bytes][New threshold:value][MaxTenuringThreshold: max_value][age1:total_age1][age2:total_age2]...[agen:total_agen]

Description

PTD: An identifier that indicates the tenuring information of the Survivor area

Date: Date and time when GC occurred (outputs only when -XX:+HitachiVerboseGCPrintDate (extended verbosegc information date output option) is specified)#1

size: Size of the Survivor area (unit: bytes)

value: Tenuring threshold value of the object that migrates to the Tenured area when the garbage collection will occur next time

max_value: Specified value of -XX:MaxTenuringThreshold#2

total_age1: Total of memory size used by the one-year-old object (unit: bytes)

total_age2: Total of memory size used by the one-to-two-year-old object (unit: bytes)

total_agen: Total of memory size used by the object from 1-year-old to n-year-old (unit: bytes)#3

Note:

When -XX:+HitachiCommaVerboseGC is specified, the tenuring

distribution information is output in the following format:

PTD,date,size,value,max_value,total_age1,total_age2,...,total_agen

#1

The time similar to the log of the corresponding copy garbage collection is displayed.

#2

Set the threshold value of the frequency in which the Java object is replaced in the From space and in the To space when executing the copy garbage collection in the specified value of the -XX:MaxTenuringThreshold.

#3

The existing object is displayed in the order from minimum years to the maximum years. If the maximum years of the displayed object are nearer to the value of max_value, then the object with long life exists is indicated.

Example of output

[VGC]<Wed May 28 11:45:23 2008>[GC 648K->136K(1984K), 0.0013020​ secs][DefNew::Eden: 512K->0K(512K)][DefNew::Survivor: 0K->0K(64K)][Tenured: 136K->136K(1408K)][Perm: 1890K->1890K(8192K)][cause:ObjAllocFail][User: 0.0000000​ secs][Sys: 0.0000000​ secs]
[PTD]<Wed May 28 11:45:23 2008>[Desired survivor:5467547​ bytes][New threshold:30][MaxTenuringThreshold:31][age1:1357527​][age2:1539661​]

You can check the following contents in the above output example:

Output trigger is a copy garbage collection occurred on 2008-05-28 (Wednesday) at 11:45:23.

The memory size of the Survivor area is 5,467,547 bytes. The object of the Survivor area is of up to two years old. The memory size used by the one-year-old object is 1,357,527 bytes, and the memory size used by the object from one-year-old to two-year-old, is 1,539,661 bytes.

9.11.3 Settings for execution environment

You must perform the following settings when using the tenuring distribution information output functionality of the Survivor area:

J2EE server

Batch server

Java application

Organization of this subsection

(1) Setting the J2EE server

(2) Setting the batch server

(3) Setting the Java application

(1) Setting the J2EE server

Implement the settings of the J2EE server in the Easy Setup definition file. Specify the definition of the tenuring distribution information output functionality of the Survivor area in the JavaVM start parameter (add.jvm.arg) in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. The parameter value to be specified is as follows:

-XX:+HitachiVerboseGCPrintTenuringDistribution
Output the tenuring distribution information of the Survivor area to the Hitachi JavaVM log file. The default value is -XX:-HitachiVerboseGCPrintTenuringDistribution.

For details on the Easy Setup definition file and parameters, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

(2) Setting the batch server

Implement the settings of the batch server in the Easy Setup definition file. Specify the definition of the tenuring distribution information output functionality of the Survivor area in the JavaVM start parameter (add.jvm.arg) in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. The parameter value to be specified is as follows:

-XX:+HitachiVerboseGCPrintTenuringDistribution
Output the tenuring distribution information of the Survivor area to the Hitachi JavaVM log file. The default value is -XX:-HitachiVerboseGCPrintTenuringDistribution.

For details on the Easy Setup definition file and parameters, see 4.6 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.

(3) Setting the Java application

Implement the settings of the Java application in the usrconf.cfg (option definition file for Java application). Specify the definition of the tenuring distribution information output functionality of the Survivor area in the add.jvm.arg of the usrconf.cfg key. The parameter value to be specified is as follows:

-XX:+HitachiVerboseGCPrintTenuringDistribution
Output the tenuring distribution information of the Survivor area to the Hitachi JavaVM log file. The default value is -XX:-HitachiVerboseGCPrintTenuringDistribution.

For details on usrconf.cfg (option definition file for Java applications), see 14.2 usrconf.cfg (Option definition file for Java applications) in the uCosminexus Application Server Definition Reference Guide.

9.11.4 Precautions when using tenuring distribution information output functionality of the Survivor area

When using the tenuring distribution information output functionality of the Survivor area, the log when executing the copy garbage collection increases as compared to the case when not used. We recommend that this functionality is to be used only for the tuning of the Survivor area.

9.12 hndlwrap functionality

This section describes the hndlwrap functionality.

The hndlwrap functionality can suppress the occurrence of a logoff event of JavaVM during a logoff. Note that you can use this functionality only in Windows.

The following table describes the configuration of this section.

Table 9-23 Configuration of this section (hndlwrap functionality)

Category | Title | Reference
Description | Overview of the hndlwrap functionality | 9.12.1
Notes | Notes for using the hndlwrap functionality | 9.12.2

Note:

The function-specific explanation is not available for "Implementation", "Settings", and "Operations".

Organization of this section

9.12.1 Overview of the hndlwrap functionality

9.12.2 Notes for using the hndlwrap functionality

9.12.1 Overview of the hndlwrap functionality

The hndlwrap functionality prevents the occurrence of a logoff event and closure of the window during a logoff.

This functionality uses Java Virtual Machine Tool Interface (JVMTI). If hndlwrap2.dll is loaded in the JVMTI interface, an event handler that detects the class preparation event and ignores the logoff and window closure events is installed. As a result, when you execute the hndlwrap functionality by specifying the -agentlib:hndlwrap2 option, you can operate the command even after logging off. For details on the options to be specified, see 16.5 Java HotSpot VM options that can be specified in Cosminexus in the uCosminexus Application Server Definition Reference Guide.

9.12.2 Notes for using the hndlwrap functionality

The notes for using the hndlwrap functionality are as follows:

When you specify the -XX:+EagerXrunInit option, the -Xrunhndlwrap option becomes disabled.

When you execute a logoff while a Java application using the hndlwrap functionality on a command prompt is being executed, a pop-up message indicating an error occurs and you cannot perform the logoff.

You cannot execute the -Xrunhndlwrap option simultaneously with another JVMPI program. If you execute this option, the operation will not be guaranteed.

You cannot execute the -agentlib:hndlwrap2 option simultaneously with another JVMTI program. If you execute this option, the operation will not be guaranteed.

You cannot specify the -Xrunhndlwrap option and -agentlib:hndlwrap2 option simultaneously.

9.13 Functionality to set the upper limit of allocation size of C heap during JIT compilation

Use C heap when compiling with Just In Time method (JIT compiler) supported by JavaVM. If you execute JIT compiler for methods with large numbers of processing or for large methods, the C heap size allocated for compilation process becomes larger and might result into insufficient C heap. In such cases, problems like forced termination of JavaVM or abnormal end of J2EE server might occur, which might result into complete suspension of the system.

To prevent the occurrence of such problems, you can set an upper limit to the C heap size used in JIT compilation. When the upper limit is exceeded, JIT compiling will be canceled and the subsequent compilation will be executed by interpreter method. Thus, you can prevent the forced termination of JavaVM and stopping of the system.

Specify the upper limit of allocation size of C heap during JIT compilation by using the -XX:HitachiJITCompileMaxMemorySize option. For details on the -XX:HitachiJITCompileMaxMemorySize option, see -XX:HitachiJITCompileMaxMemorySize (option for specifying upper limit of allocated memory during JIT compilation) in the uCosminexus Application Server Definition Reference Guide.

9.14 Functionality to set the upper limit of the number of threads

The C heap memory usage increases with the increase in the number of threads used in an application. If an increase in the memory usage results in insufficient C heap, problems such as forced termination of JavaVM or abnormal end of J2EE server might occur, which might result into complete suspension of the system.

To prevent the occurrence of such problems, you can set an upper limit to the available number of threads. You can prevent C heap insufficiency by figuring out in advance the upper limit of the number of threads, and based on this you can determine the memory size allocated to C heap. Note that an exception is thrown, if the number of threads generated exceeds the set upper value. You can prevent stopping of the system by catching this exception in the application and taking appropriate measures.

Specify the upper limit of the number of threads by using the -XX:HitachiThreadLimit option. For details on the -XX:HitachiThreadLimit option, see -XX:HitachiThreadLimit (option for specifying upper limit of the number of threads) in the uCosminexus Application Server Definition Reference Guide.

9.15 Notes on using the product JavaVM functionality (in UNIX)

This section describes the notes for using the product JavaVM functionality.

Organization of this section

(1) Common in UNIX

(2) In AIX

(3) In HP-UX

(4) In Linux

(1) Common in UNIX

This subsection describes the common notes in UNIX.

Operations when the SIGXFSZ signal is received
When JavaVM receives the SIGXFSZ signal, the following message is output to the standard output and the processing continues:

Java HotSpot(TM) 64-Bit Server VM warning: File size limit exceeded.

However, if the upper limit of the file size is exceeded, the data is not written to the file.

Operations when the SIGXCPU signal is received
When JavaVM receives the SIGXCPU signal, the following message is output to the standard output and the processing continues:

Java HotSpot(TM) 64-Bit Server VM warning: CPU time limit exceeded.

AWT (in AIX and HP-UX)
In AIX and HP-UX, AWT of Application Server uses XToolkit (sun.awt.X11.XToolkit). Motif-based MToolkit is not supported.

(2) In AIX

This subsection describes the notes in AIX.

Estimating the paging space
When a J2EE server and a Web container server are started, to prevent a program from stopping (SIGKILL) due to insufficient paging while the program is running, set up the environment variable PSALLOC=early that specifies the early paging space allocation for AIX in the start shell. However, if you specify PSALLOC=early in the /etc/environment file, the early paging space allocation is specified for all the processes leading to insufficient paging space. Therefore, specify the environment variable only for the shell that starts the relevant server. Also, specify the environment variable NODISCLAIM=true at the same time. For the points to be considered when you estimate the paging space for the early paging space allocation, see the AIX documentation.

Native library search path

When the java command is used

When you use the java command included in Developer's Kit for Java to execute a Java program, you can specify the directory search path of the system library loaded with System.loadLibrary() in the environment variable LIBPATH, and environment variable LD_LIBRARY_PATH. The search order prioritizes LD_LIBRARY_PATH and then LIBPATH.

When the java command is not used

When you use the JNI to start JavaVM and execute a Java program, the directory search path of the system library loaded with System.loadLibrary() is the path specified only in the environment variable LIBPATH.

Using the JNI to start JavaVM
Note the following points when you use the JNI to start JavaVM:

Make sure the following AIX-specific environment variables are set up:
For csh (C shell)
setenv AIXTHREAD_MUTEX_DEBUG OFF
setenv AIXTHREAD_RWLOCK_DEBUG OFF
setenv AIXTHREAD_COND_DEBUG OFF
For sh (standard shell) and ksh
export AIXTHREAD_MUTEX_DEBUG=OFF
export AIXTHREAD_RWLOCK_DEBUG=OFF
export AIXTHREAD_COND_DEBUG=OFF
For these environment variables, see the relevant page (http://publibn.boulder.ibm.com/doc_link/Ja_JP/a_doc_lib/aixbman/prftungd/prftungd02.htm).

Add the following paths to the environment variable LIBPATH and then execute the start program:
/opt/Cosminexus/jdk/jre/lib/ppc64
/opt/Cosminexus/jdk/jre/lib/ppc64/server
Note that the environment variable LIBPATH need not be set up when these paths are specified as the linkage options for generating the start program.

Font path
The fonts displayed with the GUI are searched from the system font path. If the program for changing the system font path is executed before Developer's Kit for Java starts, the GUIs might be displayed incorrectly. Furthermore, the system font path is also changed by Developer's Kit for Java. Therefore, the GUIs might be incorrectly displayed with the programs such as the ones that search the system font path after Developer's Kit for Java starts.
Specify the following settings before and after starting Developer's Kit for Java, to return the system font path to the default status:

% xset fp default

Program starting time
The server VM (Java HotSpot Server VM) implements the Java virtual machine for Developer's Kit for Java. Compared to the earlier client VM (Java HotSpot Client VM) version, the program execution speed is generally high for the server VM, but the starting of the J2EE server programs might become slow. To start the programs quickly, specify the following option. However, when you specify this option, the execution speed of the program might become slower than normal.

-XX:CompileThreshold=3000

Notes on migrating from the 32-bit JavaVM (Application Server Version 7 and Version 8) to the 64-bit JavaVM (Application Server Version 9)
As compared to the 32-bit JavaVM, the availability of a large address space is an advantage with the 64-bit JavaVM. Also, the pointer value of objects is 32 bits in the 32-bit JavaVM and 64 bits in the 64-bit JavaVM. Therefore, when you migrate from the 32-bit JavaVM to the 64-bit JavaVM, you must review the applications, memory tuning, and the environment. Note the following and then execute the migration process:

Increased object access cost
The pointer value of the object changes from 32 bit to 64 bit, so the access to the object doubles at the maximum. The execution performance of applications that frequently access the objects might be affected with the 64-bit JavaVM.

Increased Java heap memory size
The pointer value of the object changes from 32 bit to 64 bit, so the size per object doubles at the maximum. As a result, the memory size of the Java heap used by the application also increases.

Increase in the memory size used by a process
With 64-bit JavaVM, the memory size used by the processes also increases apart from the Java heap memory size. The method of estimating the memory size used by the processes is the same as the method of estimating the core file size. For details on the estimation method, see 3.3.18(1) Setting the maximum size of core files.

JNI compatibility
A native program created as a 32-bit binary and invoked with the JNI cannot be operated on the 64-bit JavaVM. Also, the 32-bit and 64-bit native programs cannot be operated concurrently in one process. Therefore, when using a native program invoked with the JNI, you must re-compile that program for the 64-bit JavaVM.

(3) In HP-UX

This subsection describes the notes for HP-UX.

JNI library search path

When the java command is used

When you use the java command included in Developer's Kit for Java to execute a Java program, the directory search path of the system library loaded with System.loadLibrary() is the path specified in the environment variables SHLIB_PATH and LD_LIBRARY_PATH. The search order prioritizes SHLIB_PATH and then LD_LIBRARY_PATH.

When the java command is not used

When you use the JNI to start JavaVM and execute a Java program, the directory search path of the system library loaded with System.loadLibrary() is the path specified only in the environment variable SHLIB_PATH.

JVMTI library search path

When the java command is used

When you use the java command included in Developer's Kit for Java to execute a Java program, the directory search path of the system library loaded with System.loadLibrary() is the path specified in the environment variable SHLIB_PATH, environment variable LD_LIBRARY_PATH, and -agentpath. The search order prioritizes SHLIB_PATH, LD_LIBRARY_PATH, and then -agentpath.

When the java command is not used

When you use the JNI to start JavaVM and execute a Java program, the directory search path of the system library loaded with System.loadLibrary() is the path specified in the environment variable SHLIB_PATH and -agentpath. The search order prioritizes SHLIB_PATH and then -agentpath.

(4) In Linux

This subsection describes the notes for Linux.

Font-related messages
When you start a GUI application on a non-console remote terminal such as the X server, the following messages might be output:

Warning: Cannot convert string
"-monotype-arial-regular-r-normal--*-140-*-*-p-*-iso8859-1" to type FontStruct

To avoid this, use the xfs command to start the font server, use the xset command on the X server, and then specify the font server in the font path. At this time, make sure that the missing font path is specified in the font server configuration file.

10. Migrating from Application Server of Earlier Versions (In the J2EE Server Mode) (INTENTIONALLY DELETED)

(INTENTIONALLY DELETED)

Organization of this chapter

10.1 (INTENTIONALLY DELETED)

10.1 (INTENTIONALLY DELETED)

(INTENTIONALLY DELETED)

11. Migrating to the Recommended Functionality

This chapter describes the migration from the functionality that was supported until now by Application Servers to the recommended functionality.

Organization of this chapter

11.1 Migration from Microsoft IIS to Cosminexus HTTP Server

11.2 Migration to In-process Transaction Service

11.3 Notes on migration to a database connection using HiRDB Type4 JDBC Driver

11.4 Migration to a database connection using Oracle JDBC Thin Driver from DABroker Library

11.1 Migration from Microsoft IIS to Cosminexus HTTP Server

The following are the definition files used when migrating from the redirector for Microsoft IIS to the redirector for Cosminexus HTTP Server.

Defined contents | Redirector for Microsoft IIS | Redirector for Cosminexus HTTP Server
Redirector definition | isapi_redirect.conf | mod_jk.conf
URL pattern and worker mapping definition | uriworkermap.properties
Worker definition | workers.properties | workers.properties

When migrating to the environment using the redirector for Cosminexus HTTP Server from the environment using the redirector for Microsoft IIS, you must specify the worker mapping definition and the URL pattern using JkMount key in mod_jk.conf. You can use the same workers.properties that is used in the redirector for Microsoft IIS.

The following points give an overview of the procedure of migrating from the environment using the redirector for Microsoft IIS:

Install Cosminexus HTTP Server.

Specify the URL pattern and the workers mapping definition defined in uriworkermap.properties in mod_jk.conf.

Define the Web server integration.
For details, see 4. Web Server Integration in the uCosminexus Application Server Web Container Functionality Guide.

Start Cosminexus HTTP Server.

11.2 Migration to In-process Transaction Service

When a transaction service is started in the process (out process) other than the J2EE server, make the changes in such a way so that from the version 07-00 onward, the transaction service will start in the in-process when the J2EE server starts.

This section describes the methods of changing the settings when the system is setup by editing the file and executing the commands.

Organization of this section

11.2.1 Migration flow

11.2.2 Migration of the operation

11.2.3 Migration of the acquisition method of the troubleshoot information

11.2.4 Program source code migration

11.2.1 Migration flow

Use the following procedure to migrate the environment:

Unset up of the out process transaction service

Property settings

Change in environment variable

Organization of this subsection

(1) Unset up of the out process transaction service

(2) Property settings

(3) Change in environment variable

(1) Unset up of the out process transaction service

Unset up the out-process transaction service by executing the command for setting up the out process transaction service.

The command to be used differs depending on the timing of executing the command for setting up the out-process transaction service.

When executing after migrating to Application Server version 07-05 onwards

In Windows
tstpbsetup -d command

In UNIX
tssetup -d command

When executing before migrating to Application Server version 07-05 onwards
tssetup -d command

(2) Property settings

Execution of setup command is not required in the in-process transaction service. Furthermore, in the in-process transaction service, the system environment definition is customized using the user property file of the J2EE server, however, in the out-process transaction service the system environment definition is customized using the tsdefvalue command. The following table describes the J2EE server property required to be set in the in-process transaction service.

Table 11-1 J2EE server property required to be set in the in-process transaction service

Key name
Value
Estimated guidelines

ejbserver.distributedtx.enableXidReuseOptimization
false
--

ejbserver.distributedtx.ots.status.directory1
Directory to store the status file of the in-process transaction service.
You must operate such that the partition of the specified path does not deplete.
Furthermore, in out-process transaction service, environment variable TPFS is customized and deployed on the shared disk. When operation is executed by the HA configuration, you must set the path of the shared disk.

ejbserver.distributedtx.ots.status.directory2#

Legend:

--: Not applicable

#

When the status file is operated in one phase by the in-process transaction service no settings are required.

For details on the keys, see 2.4 usrconf.properties (User property file of J2EE server) in the uCosminexus Application Server Definition Reference Guide.

(3) Change in environment variable

In the in-process transaction service and the out-process transaction service the environment variable where the settings are required are different. Delete the unnecessary environment variable. The following table describes the setting requirements of the environment variable of the transaction service. For details on the settings of the environment variables, see the following manuals:

Appendix I.1 System environment variables common to OSs in the uCosminexus Application Server Command Reference Guide

TPBroker Users Guide

Table 11-2 Setting requirement of the environment variable of the transaction service

Environment variable name
Specified contents
Setting requirement

In case of out-process transaction service
In case of in-process transaction service

OSAGENT_PORT
Port number used by the Smart Agent
B
--#1

PATH
Program execution path
A
A

LIBPATH,or LD_LIBRARY_PATH#2
Library search path
A
A

TPDIR
Installation destination of Cosminexus TPBroker
A
A

TZ
Time zone
A
A

VBROKER_ADM
Directory where the definition information of the Smart Agent is stored
A
A

TPFS
Storage destination of the status file of Cosminexus TPBroker
(any directory or character device file)
B
--

TPSPOOL
Save destination of Cosminexus TPBroker operating information
(any directory)
B
--

Legend:

A: Indicates that setting is required.

B: Indicates that setting is required according to the functionality used.

--: Indicates that settings are not required (even if the setting is done, it is ignored).

#1

Smart Agent might be used by CTM functionality. When using by other functionality, do not delete the environment variable OSAGENT_PORT.

#2

The environment variable name to be used differs depending on the OS.

LIBPATH: In AIX

LD_LIBRARY_PATH: In HP-UX (IPF). Linux, or Solaris

11.2.2 Migration of the operation

You must migrate the system operating environment. Change the following contents and then migrate the system operating environment:

Change in the start process

Change in the monitoring methods of the message

Organization of this subsection

(1) Change in the start process

(2) Change in the monitoring methods of the message

(1) Change in the start process

In the in-process transaction service, you are not required to start in the following process.

OTS (start by tsstart command)

TCS (start by trnctxsv command)

Smart Agent (start by osagent command)#

#

Smart Agent might be used by the functionality such as the CTM. When being used by other functionality, start the Smart Agent.

(2) Change in the monitoring methods of the message

When monitoring the message, there is a change in the output and the contents of the message. You must change the message ID that is to be monitored. The following table describes the changes in the message.

Table 11-3 Changes in the message

Changes | In case of out-process transaction service | In case of in-process transaction service
Output destination | Event log or syslog | cjmessage?.log
cjmessage?.log
Range of message ID | KFCB29500 to KFCB32401 | KFCB40000 to KFCB49999
Documents where the message is mentioned. | TPBroker document | Manual uCosminexus Application Server Messages

#

"?" indicates the serial number.

11.2.3 Migration of the acquisition method of the troubleshoot information

When the out-process transaction service is used, you must acquire the trace file and the log file under the directory specified in the environment variable TPSPOOL and TPFS. In the in-process transaction service, the material acquired by the out-process transaction service is not required. The following table describes the troubleshoot information that you must acquire in the in-process transaction service.

Table 11-4 Troubleshoot information to be acquire in the in-process transaction service

Acquisition destination
Acquisition information

Cosminexus Component Container message log

In Windows
working-directory\ejb\server-name\logs\cjmessage?.log

In UNIX
working-directory/ejb/server-name/logs/cjmessage?.log

Cosminexus TPBroker message

Cosminexus Component Container user log

In Windows
working-directory\ejb\server-name\logs\user_out?.log

In UNIX
working-directory/ejb/server-name/logs/user_out?.log

Cosminexus TPBroker message

Cosminexus Component Container maintenance log

In Windows
working-directory\ejb\server-name\logs\cjmeintenance?.log

In UNIX
working-directory/ejb/server-name/logs/cjmeintenance?.log

Cosminexus TPBroker trace information

In-process transaction service status file
(Files under the directory specified by ejbserver.distributedtx.ots.status.directory1 or ejbserver.distributedtx.ots.status.directory2 key of the J2EE server.)
Status files of the in-process transaction service and status file backup.

#

"?" indicates the serial number.

11.2.4 Program source code migration

Change the operating procedure and migrate as shown as follows:

When the in-process transaction service is used, operations are different when compared to the out-process transaction service. You must change the program source code when the occurrence conditions of the operations match.

Table 11-5 Change in the program source code

Contents of operating change
Occurrence condition
Modified contents

beforeCompletion is not invoked when concluding the transaction after SetRollbackOnly (it is called when the out process transaction service is used)
When you implement SessionSynchronization using Stateful Session Bean
Change to the program where beforeCompletion is not invoked when concluding the transaction after SetRollbackOnly.

ejbStore is not invoked when concluding the transaction after SetRollbackOnly (it is called when the out process transaction service is used)
When Entity Bean is used
Change to the program where ejbStore is not invoked when concluding the transaction after SetRollbackOnly.

In case of the out-process transaction service, the determination method of argument (boolean committed) of afterCompletion is applied to processing result of the top root transaction, however, in the case of in-process transaction service, it is decided only by the processing results of the corresponding branch and the subordinate branch.
When all the following conditions are fulfilled.

When transactional EJB is invoked in various processes in multiple J2EE servers.

When Stateful Session Bean is used

When SessionSynchronization is implemented.

Change to the programs where final results of top root transaction are not expected as usage of afterCompletion argument.

11.3 Notes on migration to a database connection using HiRDB Type4 JDBC Driver

To migrate from a database connection using Cosminexus DABroker Library to a database connection using HiRDB Type4 JDBC Driver, see the description on the migration from DABroker for Java in the HiRDB UAP Development Guide.

11.4 Migration to a database connection using Oracle JDBC Thin Driver from DABroker Library

There are differences in specifications for the JDBC drivers of DABroker Library and Oracle JDBC Thin Driver. Therefore, when you change the Oracle connection method from DABroker Library to Oracle JDBC Thin Driver, set up the following properties in the config-property tag of the Hitachi Connector property file in order to ensure compatibility:

appendZero
Set the appendZero property to true in the Hitachi Connector property file.
For details on the appendZero property, see 4.1.10 Properties that can be specified in the <config-property> tag set up in DB Connector in the uCosminexus Application Server Application and Resource Definition Reference Guide.

forceFixedString
Set the forceFixedString property to true in the Hitachi Connector property file.
For details on the forceFixedString property, see 4.1.10 Properties that can be specified in the <config-property> tag set up in DB Connector in the uCosminexus Application Server Application and Resource Definition Reference Guide.

Appendixes

Organization of the appendixes

A. List of Snapshot Logs to Be Collected

B. Identifying the Connection in which an Error Has Occurred When Connecting to a Database

C. Log Information Output for Each Functionality

D. Recovering Tables for a CMR When an Error Occurs

E. Main Functionality Changes in Each Version

F. Glossary

Appendix A. List of Snapshot Logs to Be Collected

This section describes the execution environment directories of the configuration software that are to be collected when you want to collect snapshot logs at the same time. Note that if you expand the collected ZIP file, the directories are extracted in the same directory configuration as that before collection.

When you collect all snapshot logs at the same time, the log files and definition files of the configuration software and libraries of a system built with the application server are collected. You can change the directory paths to be collected by editing the following files. For details about the settings for collecting the snapshot log, see the subsection 3.3.3 Settings for collecting snapshot logs (Systems for executing J2EE applications) or the subsection 3.3.4 Settings for collecting snapshot log (Systems for executing batch applications).

The following table describes the correspondence with the data required for troubleshooting and the snapshot log data type.

Table A-1 Correspondence with the data necessary for troubleshooting and snapshot log data type

Data necessary for troubleshooting | Data type of snapshot log
Application Server log | Message log | Message log
User log | Other logs
Exception log | Other logs
Maintenance log | Maintenance log
EJB client application system log | Message log | Message log
User log | Other logs
Exception log | Other logs
Maintenance log | Maintenance log
Trace based performance analysis | Performance, error analysis trace
Thread dumps of JavaVM | Dump
Garbage collection logs of JavaVM | Other logs
Memory dump | Dump
JavaVM log file | Other logs
Error report files | Dump
OS state or log | Other logs
Statistical information of OS | Other logs
Definition information | Definition information
Operation directory | User data
Resource setting | User data
Web server log | Message log
Other logs
Access log
Internal interface
JavaVM stack trace | Other logs
Event log of specific management heap function | Other logs

Note

The snapshot log is collected for directories created by default during installation of the configuration software in the default state. If the output destination and working directory of the log are changed, customize the collection destination.

Organization of this section

A.1 Overview of the list of the snapshot log to be collected

A.2 Cosminexus Component Container

A.3 Cosminexus Component Transaction Monitor

A.4 Cosminexus DABroker Library

A.5 Cosminexus Developer's Kit for Java

A.6 Cosminexus Performance Tracer

A.7 Cosminexus Web Services - Security

A.8 Cosminexus HTTP Server

A.9 Microsoft Internet Information Service

A.10 HCSC server

A.11 HCSC server (FTP receipt)

A.12 HCSC server (TP1 adapter)

A.13 HCSC server (File adapter)

A.14 HCSC server (Object Access adapter)

A.15 HCSC server (Message Queue adapter)

A.16 HCSC server (FTP adapter)

A.17 HCSC server (file operation adapter)

A.18 HCSC server (FTP inbound adapter)

A.19 HCSC server (mail adapter)

A.20 HCSC server (HTTP adapter)

A.21 Audit log

A.22 Other information

Appendix A.1 Overview of the list of the snapshot log to be collected

This appendix describes the storage location of the snapshot log data and the collection method, directories, and file name described in the list.

Organization of this subsection

(1) Data storage location

(2) Method of collecting snapshot log

(3) Availability of snapshot log collection and changes in settings related to collection

(4) Rules for the coding to be collected

(1) Data storage location

The snapshot log is collected in three files, namely snapshotlog.conf, snapshotlog.2.conf, and snapshotlog.param.conf.

snapshotlog.conf
This is a file that describes the logs to be collected as primary delivery data. The storage location of this file is as follows:

In Windows
Cosminexus-installation-directory\manager\config\snapshotlog.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.conf

snapshotlog.2.conf
This is a file that describes the logs to be collected as secondary delivery data. The storage location of this file is as follows:

In Windows
Cosminexus-installation-directory\manager\config\snapshotlog.2.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.2.conf

snapshotlog.param.conf
This file describes the logs to be collected for the definition sending data. The storage location of the file is as follows:

In Windows
Application-Server-installation-directory\manager\config\snapshotlog.param.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.param.conf

(2) Method of collecting snapshot log

The following types are included in the methods of collecting the snapshot log. The following table describes the method of collecting the snapshot log.

Table A-2 Methods of collecting snapshot log

No. | How to collect | Category
1 | Collecting the log from the Snapshot Log window of the Start/ stop logical server anchor of the management portal | Collection method A
2 | Executing management command (mngsvrutil collect snapshot command) | Collection method A
3 | Auto collecting after detecting the error of the logical server | Collection method A
4 | Execute snapshotlog command using the standard snapshotlog.conf, snapshotlog.2.conf, or snapshotlog.param.conf | Collection method B

(3) Availability of snapshot log collection and changes in settings related to collection

In the tables from Table A-5 to Table A-45, availability of collection and availability of changes in settings for the mngsvrutil command or snapshotlog command are categorized with labels. The following table describes each label.

Table A-3 Definition of label used in Table A-5 to Table A-45

Label used in table | Default collection | Changes in log output destination and storage destination of definition file | Collection when log output destination and storage destination of definition file is changed
A | Collected. | Possible. | Possible.
Y | Collected. | Not possible. | Not possible.
C | Collected. | Possible. | Possible but with some restrictions#¹.
D | Not collected. | Not possible. | Not possible#².

#1

You must edit the definition file (snapshotlog.conf, snapshotlog.2.conf, or snapshotlog.param.conf) for collecting the snapshot log and set the file to the directory targeted for collection.

#2

You cannot change the log output destination or storage destination of a definition file. You must edit the definition file (snapshotlog.conf, snapshotlog.2.conf, or snapshotlog.param.conf) for collecting the snapshot log and set the file to the directory targeted for collection.

Also, the Data column from Table A-5 to Table A-45 indicates the data collected when the mngsvrutil command or snapshotlog command is executed.

If the data is collected using another method, or if mngsvrutil collect snapshot 2 is executed, all the data is collected regardless of the contents of the Data column in the table.

The notations and symbols in the Data column are as follows:

Primary: Primarily sent data
This data is collected when the snapshotlog command specifying snapshotconf.conf, or mngsvrutil collect snapshot 1 is executed.

Secondary: Secondarily sent data
This data is collected when the snapshotlog command specifying snapshotconf.2.conf, or mngsvrutil collect snapshot 2 is executed.

Definition: Definition sending data
This data is collected when the snapshotlog command is executed specifying snapshotlog.param.conf.

Symbols in the table
Y: Collected
--: Not collected

(4) Rules for the coding to be collected

The common method to code the directories and files to be collected is as follows:

The asterisk (*) in the path of the directory or file to be collected indicates any character string of 0 or more characters.

\*\*\* in Windows and /*/*/* in UNIX indicates the hierarchy in which the files are collected. For example, in the case of log\*\* in Windows or log/*/* in UNIX, the files that are two levels below the log directory are to be collected.

The following table describes the significance of the files and directories to be collected.

Table A-4 Significance of files and directories to be collected

Directory or file name
Contents
Default value
Changed Value

Installation-directory-of-Cosminexus
Installation directory path name of the Application Server

In Windows
Decided when installing the Application Server.

In UNIX
/opt/Cosminexus

${cosminexus.home}

CTM-identifier
-CTMID option name of ctmstart command
--
.+

CTM-spool-directory (ctmspool)
Directory path name specified for environment variable CTMSPOOL
Installation-directory-of-Cosminexus/CTM/spool
&{ctmspool}

DABroker-operation-directory (dabroker)
Directory path name set after DABroker installation by dabsetup command
/opt/DABroker
<DABroker_Oparation>

EJB-client-definition-file-storage-directory
Directory path name specified in environment variable CJCLUSRCONFDIR or
directory path name, which executed the cjclstartap command.
--
<ejb.client.definition.file.dir>

EJB-client-log-subdirectory (ejb.client.ejb.log)
Sub directory name specified in ejb.client.ejb.log key of usrconf.cfg for Java application
system
.+

EJB-client-log-subdirectory1 (ejbserver.client.ejb.log)
Directory path name specified in ejbserver.client.ejb.log key of usrconf.properties for Java application
--
.+

EJB-client-log-subdirectory2 (ejb.client.log.appid)
Subdirectory name specified in ejb.client.log.appid key of usrconf.cfg for Java application.
ejbcl
.+

EJB-client-log-subdirectory2 (ejbserver.client.log.appid)
Directory path name specified in ejbserver.client.log.appid key of usrconf.properties for Java application
--
.+

EJB-client-log-output-directory (ejb.client.log.directory)
Directory path name specified in ejb.client.log.directory key of usrconf.cfg for Java application
--
<ejb.client.log.directory>

EJB-client-log-output-directory (ejbserver.client.log.directory)
Directory path name specified in ejbserver.client.log.directory key of usrconf.properties for Java application.
Installation-directory-of- Cosminexus/CC/client/logs
<ejbserver.client.log.directory>

HCSC-server-property (methodtrace-filepath)
Directory path specified in the methodtrace-filepath property with the HCSC server definition command cscsvconfig
Installation-directory-of- Cosminexus/CC/server/public/ejb/server-name/logs/csc/maintenance
<methodtrace-filepath>

HCSC-server-property (requesttrace-filepath)
Directory path specified in the requesttrace-filepath property with the HCSC server definition command cscsvconfig
Installation-directory-of- Cosminexus/CC/server/public/ejb/server-name/logs/csc/maintenance
<requesttrace-filepath>

HCSC-repository-root (cscmng.repository.root)
Repository root specified in the cscmng.repository.root key of HCSC-Manager definition cscmng.properties
Installation-directory-of- Cosminexus/CSC/repository
<cscmng.repository.root>

HCSC-log-output-directory (cscmng.log.dir)
Log directory path specified in the cscmng.log.dir key of HCSC-Manager definition cscmng.properties
Installation-directory-of- Cosminexus/CSC/log/manager
<cscmng.log.dir>

HWS-access-log-directory
(HttpsdCustomLogFileDir)
Directory path name of the file name specified in CustomLog directory of httpsd.conf.
Installation-directory-of- HWS/servers/HWS_server-name/logs
&{hws.logfile.dir}

Installation-directory-of-HWS
Cosminexus HTTP Server installation directory path
In Windows
Installation-directory-of- Cosminexus/httpsd
In UNIX
opt/hitachi/httpsd
${hws.home}

HWS-error-log-directory (HttpsdErrorLogFileDir)
Directory path name of the file name specified in ErrorLogr directory of httpsd.conf.
Installation-directory-of- HWS/servers/HWS_server-name/logs
&{hws.logfile.dir}

HWS-cache-server-run-directory (SSLCacheServerRunDir)>
Directory path name specified in SSLCacheServerRunDir directory of httpsd.conf
HWS-server-root-directory-(ServerRoor)
<SSLCacheServerRunDir>

HWS-core-dump-output-directory (CoreDumpDirectory)
Directory path name specified in CoreDumpDirectory directory of httpsd.conf
Installation-directory-of- HWS/servers/HWS_server-name
&{core.dump.directory}

HWS-server-root-directory (ServerRoot)
Directory path name specified in ServerRoot directory of httpsd.conf
Installation-directory-of- HWS
<ServerRoot>

HWS-trace-directory
(HttpsdTraceLogFileDir)
Directory path name of the file name specified in HWSTraceLogFile directory of httpsd.conf
Installation-directory-of- HWS/servers/HWS_server-name/logs
&{hws.logfile.dir}

HWS-processID-file (PidFile)
File name specified in PidFile directory of httpsd.conf
Installation-directory-of- HWS/servers/HWS_server-name/logs/httpd.pid
<PidFile>

Redirector-log-output-directory-for-HWS (JkLogFileDir)
Directory path specified in the JkLogFileDir key of mod_jk.conf
Installation-directory-of- Cosminexus/CC/web/redirector/servers/server-name/logs
&{jklogfiledir}

Redirector-trace-log-output-directory-for-HWS (JkTraceLogFileDir)
Directory path specified in the JkTraceLogFileDir key of mod_jk.conf.
Installation-directory-of- Cosminexus/CC/web/redirector/servers/server-name/logs
&{jktracelogfiledir}

HWS-request-log-directory (HttpsdRequestLogFileDir)
Directory path name of the file name specified in HWSRequestLog directory of httpsd.conf
Installation-directory-of- HWS /servers/HWS_server-name/logs
&{hws.logfile.dir}

IIS-access-log-directory (IIS_log_dir)
Access log output directory path name of Microsoft IIS
System-root-directory-(systemroot)/system32/LogFiles/W3SVC1
<IIS_log_dir>

Redirector-trace-log-output-directory-for-IIS (trace_log_file_dir)
Directory path name specified in trace_log_file_dir key of isapi_redirect.conf
Installation-directory-of- Cosminexus/CC/web/redirector/servers/server-name/logs
&{jktracelogfiledir}

Redirector-log-output-directory-for-IIS (log_file_dir)
Directory path name specified in log_file_dir key of isapi_redirect.conf
Installation-directory-of- Cosminexus/CC/web/redirector/servers/server-name/logs
&{jklogfiledir}

J2EE server working directory (ejb.public.directory)
Directory path name specified in the ejb.public.directory key of usrconf.cfg for a J2EE server.
Installation-directory-of- Cosminexus/CC/server/public
&{ejb.public.directory}

J2EE-server-log-output-directory (ejb.server.log.directory)
Directory path specified in the ejb.server.log.directory key of usrconf.cfg for a J2EE server
Installation-directory-of- Cosminexus/CC/server/public/ejb/server-name/logs
&{ejb.server.log.directory}

JAXR-trace-file name (com.cosminexus.xml.registry.trace.file_path)
File path name specified in com.cosminexus.xml.registry.trace.file_path key of system property
${cosminexus.home}/c4web/logs/JAXRAPITrace
<com.cosminexus.xml.registry.trace.file_path>

Temporary directory for JSP (webserver.work.directory)
Directory path specified in the webserver.work.directory key of usrconf.properties of a J2EE server
Installation-directory-of- Cosminexus/CC/server/repository/server-name/web
&{webserver.work.directory}

Message-ID-list-file-for-Management-event-publication (manager.mevent.message_id.list)
File path name specified in manager.mevent.message_id.list key of mevent.server-name.properties.
--
<manager.mevent.message_id.list>

Manager-log-output-directory (com.cosminexus.manager.log.dir)
Directory path specified in the com.cosminexus.manager.log.dir key of manager.cfg.
Installation-directory-of- Cosminexus /manager/log
${com.cosminexus.manager.log.dir}

PRF-identifier
-PRFID option name of cprfstart command
--
.+

PRF-spool-directory (prfspool)
Directory path name specified for environment variable PRFSPOOL
Installation-directory-of- Cosminexus/PRF/spool
&{prfspool}

RM-installation-directory
Directory path name specified for environment variable HRMDIR
Installation-directory-of- Cosminexus/RM
<HRMDIR>

TP1-onnector-log-output-directory
(jp.co.hitachi_system.tp1connector.logdestination)
Directory path name specified in jp.co.hitachi_system.tp1connector.logdestination key of system property
user-home-directory-(user.home)
<jp.co.hitachi_system.tp1connector.logdestination>

UNIX-syslog (syslog)
syslog file path name in UNIX

In AIX
/var/adm/ras/syslog*

In HP-UX
/var/adm/syslog/*syslog.log

In Linux
/var/log/messages*

In Solaris
/var/adm/messages*

syslog

VBROKER_ADM directory
(vbroker_adm)
Directory path specified in the environment variable VBROKER_ADM
Installation-directory-of- Cosminexus/TPB/adm
<VBROKER_ADM>

Web container server log output directory (web.server.log.directory)
Directory path specified in the web.server.log.directory key of usrconf.cfg for a J2EE server.
Installation-directory-of- Cosminexus/CC/web/containers/server-name/logs
<web.server.log.directory>

Windows-event-log
(EventLog)
File where event log of Windows is collected using wmic command
--
<EventLog>

Windows-Crash-dump-output-directory (CrashDumpDir)
Windows crash dump output destination directory path name (Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista)
Users Application Data directory
(LOCALAPPDATA)/CrashDumps
<CrashDumpDir>

Windows-crash-dump-file
(CrashDumpFile)
Windows crash dump file path name
(Other than Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista)
system-drive(SystemDrive)/Documents and Settings/All Users/Application Data/Microsoft/Dr Watson/user.dmp
<CrashDumpFile>

Windows-Watson-log-file (DrWtsnLogFile)
Windows Watson log file path name (Other than Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista)
system-drive(SystemDrive)/Documents and Settings/All Users/Application Data/Microsoft/Dr Watson/drwtsn32.log
<DrWtsnLogFile>

XML Security-Core-trace output directory (com.cosminexus.xml.security.logging.trace_dir)
Directory path specified in the com.cosminexus.xml.security.logging.trace_dir key of usrconf.cfg for a J2EE server
Installation-directory-of- Cosminexus/CC/server/public/ejb/server-name
<com.cosminexus.xml.security.logging.trace_dir>

In-process HTTP server-access-log-file (webserver.logger.access_log.inprocess_http.filename)
Directory path specified in the webserver.logger.access_log.inprocess_http.filename key of usrconf.properties for a J2EE server
Installation-directory-of- Cosminexus/CC/server/public/ejb/server-name/logs/http/cjhttp_access.inprocess_http
&{webserver.logger.access_log.inprocess_http.filename}.

statistics-file-output-destination-directory (ejbserver.management.stats_file.dir)
Directory path specified in the ejbserver.management.stats_file.dir key of usrconf.properties for a J2EE server
Installation-directory-of- Cosminexus/CC/server/public/ejb/server-name/stats
&{ejbserver.management.stats_file.dir}

Audit-log-output-directory (auditlog.directory)
Directory path name specified in auditlog.directory key of audit log definition file.
Installation-directory-of- Cosminexus/auditlog
<auditlog.directory>

Audit-log-message-output-directory (auditlog.raslog.message.directory)
Directory path name specified in auditlog.raslog.message.directory key of the Audit log definition file
Installation-directory-of- Cosminexus/auditlog
<auditlog.raslog.message.directory>

Audit-log-exception-output-directory (auditlog.raslog.exception.directory)
Directory path name specified in auditlog.raslog.exception.directory key of Audit log definition file
Installation-directory-of- Cosminexus/auditlog
<auditlog.raslog.exception.directory>

Context root
Root name of the J2EE web application executed on the server
--
.+

Server-management-command-log-output-directory (admin_ejb.server.log.directory)
Directory path name specified in the -Dejbserver.log.directory option of USRCONF_JVM_ARGS key of the option definition file for server management commands
Installation-directory-of- Cosminexus/CC/admin/logs
<admin_ejb.server.log.directory>

Server-name
Logical server name or real server name set by Management Server
--
.+

System-drive
(SystemDrive)
Directory path name specified for environment variable SystemDrive
--
%{SystemDrive}

System-root-directory
(systemroot)
Directory path name specified for environment variable SystemRoot
--
%{SystemRoot}

Status file directory (ejbserver.distributedtx.ots.status.directory1)
Directory path specified in the ejbserver.distributedtx.ots.status.directory1 key of usrconf.properties of a J2EE server
Installation-directory-of- Cosminexus/CC/server/public/ejb/server-name/otsstatus
&{ejbserver.distributedtx.ots.status.directory1}

Trace-file-name-of-integrated-user-management (com.cosminexus.admin.auth.trace.prefix)
File path name specified in com.cosminexus.admin.auth.trace.prefix option of ua.conf
--
<com.cosminexus.admin.auth.trace.prefix>

Batch-application-definition-file-storage-directory
Directory path name specified in environment variable CJBATCHUSRCONFDIR or
directory path name, which executed the cjexecjob, cjkilljob, or cjlistjob commands.
--
<batch.application.definition.file.dir>

Batch-application-log-output-directory (batch.log.directory)
Directory path name specified in batch.log.directory of usrconf.cfg for batch applications
Installation-directory-of- Cosminexus/CC/batch/logs
<batch.log.directory>

User-Application Data-directory
(LOCALAPPDATA)
Directory path name specified for environment variable LOCALAPPDATA
--
%{LOCALAPPDATA}

User-home-directory
(user.home)
Home directory path name of the executing user

In collection method A:
Home directory of operation management agent start user

In collection method B:
Home directory of the user executing snapshotlog command

--
${user.home}and <user.home>

Spare status file directory (ejbserver.distributedtx.ots.status.directory2)
Directory path specified in the ejbserver.distributedtx.ots.status.directory2 key of usrconf.properties of a J2EE server
--
&{ejbserver.distributedtx.ots.status.directory2}

Virtual-server manager-log-directory-of-08-50-mode (vmx.log.dir)
Directory path name specified in the vmx.log.dir key of vmx.properties
Installation-directory-of- Cosminexus /manager/vmx/log
<vmx.log.dir>

Processing-data-storage-directory-of- virtual-server manager-of-08-50-mode (vmx.spool.dir)
Directory path name specified in the vmx.spool.dir key of vmx.properties
Installation-directory-of- Cosminexus /manager/vmx/spool
<vmx.spool.dir>

Processing-data-storage-directory-of- virtual-server manager (vmi.spool.dir)
Directory path name specified in the vmi.spool.dir key of vmx.properties
Installation-directory-of- Cosminexus/manager/vmi/spool
<vmi.spool.dir>

server-communication-agent-log-output-directory(sinaviagent.log.dir)
Directory path name specified in the sinaviagent.log.dir key of sinaviagent.cfg
Installation-directory-of- Cosminexus/sinagent/log
<sinaviagent.log.dir>

server-communication-agent-processing-data-storage-directory(sinaviagent.spool.dir)
Directory path name specified in the sinaviagent.spool.dir key of sinaviagent.cfg
Installation-directory-of- Cosminexus/sinagent/spool
<sinaviagent.spool.dir>

FTP-adapter-installation-directory(ftpadp.home)
Installation directory path name of FTP Adapter
--
<ftpadp.home>

FTP-adapter-command-message-log-output-destination-directory (ftpadp.command.messagelog.filepath)
Directory path name of operation command message log output destination of FTP Adapter
FTP-adapter-installation -directory (ftpadp.home)/log
<ftpadp.command.messagelog.filepath>

HCSC-mail-adapter-operation-command-message-log-output-destination-directory (mailadp.command.messagelog.filepath)
Directory path name of operation command execution log of mail adapter incorporated in Cosminexus Service Coordinator
Installation-directory-of- Cosminexus /CSC/log/adapter/command
<mailadp.command.messagelog.filepath>

HCSC-mail-adapter-maintenance-log-output-destination-directory(mailadp.methodtrace.filepath)
Directory path name specified in the mailadp.methodtrace.filepath property in the execution environment property file of mail adapter
Installation-directory-of- Cosminexus/CC/server/public/ejb/server name/logs/CSCADP/MAILADP/maintenance/
<mailadp.methodtrace.filepath>

CTM-regulator-setup-file-(ctm.RegOption)
Path of the CTM regulator configuration file
--
&{ctm.RegOption}

OTM-gateway-setup-file-(ctm.TSCGwOption)
Path of the OTM gateway configuration file
--
&{ctm.TSCGwOption}

Directory-to-output-temporary-PRF-trace-file-(adminagent.prftrace_dir)
Path of the directory to output the temporary PRF trace file
Application-Server-installation-directory/manager/tmp
${adminagent.prftrace_dir}

Name-of-Explicit-Memory-Management-functionality-exclusion-setup-file-(jvm.exmemexcludeclass.File)
File path specified in the JavaVM extension option -XX:ExplicitMemoryExcludeClassListFile
Application-Server-installation-directory/jdk/usrconf/exmemexcludeclass.cfg
<jvm.exmemexcludeclass.File>

Name-of-Explicit-Memory-Management-functionality-non-exclusion-setup-file-(jvm.exmemnotexcludeclass.File)
File path specified in the JavaVM extension option -XX:ExplicitMemoryNotExcludeClassListFile
Application-Server-installation-directory/jdk/usrconf/exmemnotexcludeclass.cfg
<jvm.exmemnotexcludeclass.File>

Directory-to-output-the-EADs-client-log-for-EADs-session-failover-functionality-(webserver.eadssfo.eads.logger.dir)
Path of the directory to output the EADs client log for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)
<webserver.eadssfo.eads.logger.dir>

Legend:

--: No default value

Appendix A.2 Cosminexus Component Container

The following table describes the logs to be collected in relation to a Cosminexus Component Container.

Table A-5 Collection method related to Cosminexus Component Container (In Windows)

Category
Type of data
File to be collected
Default collection destination
Data
How to collect

Primary
Secondary
Definition
A
B

J2EE server (when executed in the J2EE server mode)
Message log
Operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjmessage*.log
Y
--
--
A
C

Log operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjlogger.log
Y
--
--
A
C

Resource adapter operation log deployed and used as J2EE resource adapter
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

Resource adapter operation log used by including in J2EE application (normal mode)
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/J2EE-application-name/*.log
Y
--
--
A
C

Resource adapter operation log used by including in the J2EE application (test mode)
J2EE-server-log-output-directory-(ejb.server.log.directory)>/connectors/TEST#J2EE-application-name/*.log
Y
--
--
A
C

Web servlet log
J2EE-server-log-output-directory-(ejb.server.log.directory)/web_servlet*.log
Y
--
--
A
C

Other logs
User output log
J2EE-server-log-output-directory-(ejb.server.log.directory)/user_out*.log
Y
--
--
A
C

User error log
J2EE-server-log-output-directory-(ejb.server.log.directory)/user_err*.log
Y
--
--
A
C

JavaVM maintenance information and garbage collection log
J2EE-server-log-output-directory-(ejb.server.log.directory)/javalog*.log
Y
--
--
A
C

JavaVM specific management heap function event log
J2EE-server-log-output-directory-(ejb.server.log.directory)/ehjavalog*.log
Y
--
--
A
C

Check development log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjdevelopment*.log
Y
--
--
A
C

Exception information when an error occurs
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjexception*.log
Y
--
--
A
C

JavaVM event log
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/hs_err*
Y
--
--
A
A

User log of J2EE applications
J2EE-server-log-output-directory-(ejb.server.log.directory)/user/*
Y
--
--
A
C

Maintenance log
Maintenance information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjmaintenance*.log
Y
--
--
A
C

Console message
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjconsole*.log
Y
--
--
A
C

EJB container maintenance information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjejbcontainer*.log
Y
--
--
A
C

Web container maintenance information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjwebcontainer*.log
Y
--
--
A
C

Start process standard output information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjstdout*.log
Y
--
--
A
C

Start process standard error information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjstderr*.log
Y
--
--
A
C

Termination process information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cj_shutdown*.log
Y
--
--
A
C

Dump
Thread dump
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/javacore*
Y
--
--
A
A

Statistical information
Operation information file
statistics-file-output-destination-directory-(ejbserver.management.stats_file.dir)/*
--
Y
--
A
C

Memory monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjmemorywatch*.log
Y
--
--
A
C

Thread monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjthreadwatch*.log
Y
--
--
A
C

Thread dump monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjthreaddumpwatch*.log
Y
--
--
A
C

HTTP request pending queue monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjrequestqueuewatch*.log
Y
--
--
A
C

HTTP session count monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjhttpsessionwatch*.log
Y
--
--
A
C

Connection pool monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjconnectionpoolwatch*.log
Y
--
--
A
C

Others
Log showing J2EE server start, stop or abnormal termination
Windows-event-log (EventLog)
Y
--
--
D
D

Definition information
Option definition file for J2EE servers
Installation-directory-of- Cosminexus/CC/server/usrconf/ejb/server-name/usrconf.cfg
Y
--
Y
Y
Y

User property file for the J2EE server
Installation-directory-of- Cosminexus/CC/server/usrconf/ejb/server-name/usrconf.properties
Y
--
Y
Y
Y

Security policy file for J2EE server
Installation-directory-of- Cosminexus/CC/server/usrconf/ejb/server-name/server.policy
Y
--
Y
Y
Y

Backup of various definition files created with MNG
Installation-directory-of- Cosminexus/CC/server/usrconf/ejb/server-name/*
--
Y
--
Y
Y

Protected area list file
Installation-directory-of- Cosminexus /CC/server/usrconf/criticalList.cfg
Y
--
Y
Y
Y

Resource setting information
J2EE-server-work-directory(ejb.public.directory)/ejb/server-name/import/**
--
Y
--
D
D

J2EE-server-work-directory(ejb.public.directory)/ejb/server-name/rars/**
--
Y
--
D
D

User data
Contents of EJB server working directory
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/**
--
Y
--
D
D

Contents of Web container working directory
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/**
--
Y
--
D
D

Contents of temporary directory for JSP
Temporary-directory-for-JSP-(webserver.work.directory)/**
--
Y
--
D
D

Web container server (When executed in servlet engine mode)
Other logs
JavaVM event log
Installation-directory-of- Cosminexus/CC/web/containers/server-name/hs_err*
Y
--
--
Y
Y

Maintenance log
Logs
Web-container-server-log-output-directory-(web.server.log.directory)/*
Y
--
--
C
C

Web-container-server-log-output-directory-(web.server.log.directory)/*/*
Y
--
--
C
C

Web-container-server-log-output-directory-(web.server.log.directory)/*/*/*
Y
--
--
C
C

Web-container-server-log-output-directory-(web.server.log.directory)/*/*/*/*
Y
--
--
C
C

Dump
Thread dump
Installation-directory-of- Cosminexus/CC/web/containers/server-name/javacore*
Y
--
--
Y
Y

Definition information
Option definition file for the Web container server
Installation-directory-of- Cosminexus/CC/web/containers/server-name/usrconf/usrconf.cfg
Y
--
Y
Y
Y

User property file for the Web container server
Installation-directory-of- Cosminexus/CC/web/containers/server-name/usrconf/usrconf.properties
Y
--
Y
Y
Y

Security policy file for the Web container server
Installation-directory-of- Cosminexus/CC/web/containers/server-name/usrconf/web.policy
Y
--
Y
Y
Y

User authentication information definition file
Installation-directory-of- Cosminexus/CC/web/containers/server-name/usrconf/web-users.xml
Y
--
Y
Y
Y

Definition files
Installation-directory-of- Cosminexus/CC/web/containers/server-name/usrconf/*
--
Y
Y
Y
Y

Server management commands
Message log
Operation log
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/cjmessage*.log
Y
--
--
C
C

Log operation log
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/cjlogger.log
Y
--
--
C
C

Operation log in compatible mode
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/*message*.log
Y
--
--
C
C

Other logs
Exception information when an error occurs
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/cjexception*.log
Y
--
--
C
C

Exception information when an error occurs in compatible mode
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/*exception*.log
Y
--
--
C
C

Maintenance log
Maintenance information
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/CC/maintenance/cjmaintenance*.log
Y
--
--
C
C

Console message
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/CC/maintenance/cjconsole*.log
Y
--
--
C
C

Server management command maintenance information
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/CC/maintenance/cjserveradmin*.log
Y
--
--
C
C

Other logs
server-management-command-log-output-directory-(admin_ejb.server.log.directory)/*/*
Y
--
--
C
C

server-management-command-log-output-directory-(admin_ejb.server.log.directory)/*/*/*
Y
--
--
C
C

server-management-command-log-output-directory-(admin_ejb.server.log.directory)/*/*/*/*
--
Y
--
C
C

Definition information
Definition file for server management command
Installation-directory-of- Cosminexus /CC/admin/usrconf/*
Y
--
Y
Y
Y

Batch application
Message log
Operation log of cjexecjob, cjkilljob, and cjlistjob command
batch-application-log-output-directory (batch.log.directory)/cjmessage*.log
Y
--
--
C
C

Maintenance log
Other logs
batch-application-log-output-directory (batch.log.directory)/*/*
Y
--
--
C
C

Definition information
Option definition file for batch application
Definition-file-storage-directory-of-batch-application/usrconf.cfg
Y
--
--
D
D

User property file for batch application
Definition-file-storage-directory-of-batch-application/usrconf.properties
Y
--
--
D
D

Resource adapter version upgrade command (cjrarupdate)
Message log
Operation log
Installation-directory-of- Cosminexus/CC/logs/cjrarupdatemessage*.log
Y
--
--
Y
Y

Other logs
Exception information when an error occurs
Installation-directory-of- Cosminexus/CC/logs/cjrarupdateexception*.log
Y
--
--
Y
Y

Maintenance log
Maintenance information
Installation-directory-of- Cosminexus/CC/logs/cjrarupdatemaintenance*.log
Y
--
--
Y
Y

In-process HTTP server
Process log
Process result of in-process HTTP server
In-process-HTTP-server-access-log- file (webserver.logger.access_log.inprocess_http.filename) *.log
Y
--
--
A
C

Module trace
Thread trace information
J2EE-server-log-output-directory-(ejb.server.log.directory)/http/maintenance/thr/cjhttp_thr.*.inprocess_http.mm
Y
--
--
A
C

Communication trace
Communication trace information
J2EE-server-log-output-directory-(ejb.server.log.directory)/http/maintenance/comm/cjhttp_comm.*.inprocess_http.mm
Y
--
--
A
C

Migration command (cjenvupdate)
Message log
Operation log of the cjenvupdate command
Installation-directory-of- Cosminexus/CC/logs/cjenvupdatemessage*.log
Y
--
--
Y
Y

Other logs
Exception information of the cjenvupdate command
Installation-directory-of- Cosminexus/CC/logs/cjenvupdateexception*.log
Y
--
--
Y
Y

Maintenance log
Maintenance information of the cjenvupdate command
Installation-directory-of- Cosminexus/CC/logs/cjenvupdatemaintenance*.log
Y
--
--
Y
Y

In-process transaction service
Others
In-process transaction service status file
Status-file-directory-(ejbserver.distributedtx.ots.status.directory1)/*
--
Y
--
A
C

Status-file-directory-(ejbserver.distributedtx.ots.status.directory1)/*/*
--
Y
--
A
C

In-process transaction service spare status file
Spare-status-file-directory-(ejbserver.distributedtx.ots.status.directory2)/*
--
Y
--
A
D

Spare-status-file-directory-(ejbserver.distributedtx.ots.status.directory2)/*/*
--
Y
--
A
D

EJB client
Message log
Operation log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclmessage*.log
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/EJB-client-log-subdirectory-1(ejb.client.ejb.log)/EJB-client-log-subdirectory-2(ejb.client.log.appid)/cjclmessage*.log
Y
--
--
D
D

cjclstartap command operation log
EJB-client-log-output-directory-(ejb.client.log.directory)/cjclstartap*.log
Y
--
--
D
D

cjcldellog command operation log
Installation-directory-of- Cosminexus/CC/client/logs/cjcldellog.log
Y
--
--
Y
Y

Other logs
User output log
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/user_out*.log
Y
--
--
D
D

User error log
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/user_err*.log
Y
--
--
D
D

JavaVM maintenance information, garbage collection log
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/javalog*.log
Y
--
--
D
D

Exception information when an error occurs
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclexception*.log
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/EJB-client-log-subdirectory-1(ejb.client.ejb.log)/EJB-client-log-subdirectory-2(ejb.client.log.appid)/maintenance/cjclmaintenance*.log
Y
--
--
D
D

EJB client application user log
EJB-client-log-output-directory(ejbserver.client.log.directory)/user/*
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/user/*
Y
--
--
D
D

Maintenance log
Maintenance information
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclmaintenance*.log
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/EJB-client-log-subdirectory-1(ejb.client.ejb.log)/EJB-client-log-subdirectory-2(ejb.client.log.appid)/maintenance/cjclmaintenance*.log
Y
--
--
D
D

EJB container maintenance information
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/maintenance/cjejbcontainer*.log
Y
--
--
D
D

Start process standard output information
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/maintenance/cjstdout*.log
Y
--
--
D
D

Start process standard error information
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/maintenance/cjstderr*.log
Y
--
--
D
D

Log operation information
EJB-client-log-output-directory-(ejbserver.client.log.directory)/cjlogger.log
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/cjlogger.log
Y
--
--
D
D

Definition information
Option definition file for EJB client
EJB-client-definition-file-storage-directory/usrconf.cfg
Y
--
--
D
D

User property file for EJB client
EJB-client-definition-file-storage-directory/usrconf.properties
Y
--
--
D
D

Redirector (Web server)
Message log
Redirector message log for HWS
Redirector-log-output-directory-for-HWS (JkLogFileDir)/hws_redirect*.log
Y
--
--
A
C

Redirector message log for previous version compatible HWS
Redirector-log-output-directory-for-HWS (JkLogFileDir)/hws_redirect*.log
Y
--
--
A
C

Redirector message log for previous version compatible IIS
Redirector-log-output-directory-for-IIS-(log_file_dir)/isapi_redirect*.log
Y
--
--
C
C

Maintenance log
Trace log for maintenance of redirector for HWS
Redirector-trace-log-output-directory-for-HWS (JkTraceLogFileDir) /hws_rd_trace*.log
Y
--
--
A
C

Trace log for maintenance of redirector for previous version compatible HWS
Redirector-trace-log-output-directory-for-HWS (JkTraceLogFileDir) /hws_rd_trace*.log
Y
--
--
A
C

Trace log for maintenance of redirector for previous version compatible IIS
Redirector-trace-log-output-directory-for-IIS-(trace_log_file_dir)/iis_rd_trace*.log
Y
--
--
C
C

Definition information
Redirector action definition file for HWS
Installation-directory-of- Cosminexus/CC/web/redirector/servers/server-name/mod_jk.conf
Y
--
Y
Y
Y

Worker definition file
Installation-directory-of- Cosminexus/CC/web/redirector/servers/server-name/workers.properties
Y
--
Y
Y
Y

Redirector action file for previous version compatible HWS
Installation-directory-of- Cosminexus/CC/web/redirector/mod_jk.conf
Y
--
Y
Y
Y

Redirector action definition file for previous version compatible IIS
Application-Server-installation-directory/CC/web/redirector/isapi_redirect.conf
Y
--
Y
Y
Y

Worker definition file for previous version compatibility
Installation-directory-of- Cosminexus/CC/web/redirector/workers.properties
Y
--
Y
Y
Y

Mapping definition file for previous version compatibility
Application-Server-installation-directory/CC/web/redirector/uriworkermap.properties
Y
--
Y
Y
Y

EADs client for the EADs session failover functionality
Message log
Message log of the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/eads_client_message*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/eads_client_message*.log
Y
--
--
C
C

Communication trace
Communication trace of the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/eads_client_comm_trace*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/eads_client_comm_trace*.log
Y
--
--
C
C

Maintenance log
Maintenance log for the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/maintenance/eads_client_maintenance*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/maintenance/eads_client_maintenance*.log
Y
--
--
C
C

Message dump of the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/maintenance/eads_client_comm_dump*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/maintenance/eads_client_comm_dump*.log
Y
--
--
C
C

TP1/Message Queue - Access
Maintenance log
Method trace, message log related to API and Cosminexus interface
J2EE-server-log-output-directory(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

API Trace
API Trace file
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/mqc.api*
Y
--
--
A
A

TP1 Connector
Message log
TP1 Connector operation log deployed and used as J2EE resource adapter
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

TP1 Connector operation log used by including in J2EE application
(Normal mode)
J2EE-server-log-output-directory(ejb.server.log.directory)/connectors/J2EE application name/*.log
Y
--
--
A
C

TP1 Connector operation log used in Non-managed environment
TP1Connector-log-output-directory-(jp.co.hitachi_system.tp1connector.logdestination)/tp1connector*.log
Y
--
--
C
C

TP1/Client/J
Other logs
Debug trace information
user-home-directory-(user.home)/TP1clientJ/dcClt*.dmp
--
Y
--
C
C

Manager
Message log
Administration agent log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent*.log
Y
--
--
A
Y

Administration agent start, stop command log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagentctl.exe.*.log
Y
--
--
A
Y

Integrated message log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/message/mngmessage*.log
Y
--
--
A
Y

Administration agent service log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagentsv.exe.*.log
Y
--
--
A
Y

Management agent log and trace
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngagent*.*.log
Y
--
--
A
Y

Management Server service log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvr.exe.*.log
Y
--
--
A
Y

Management Server service start, stop command log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvrctl.exe.*.log
Y
--
--
A
Y

Management Server log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvr*.log
Y
--
--
A
Y

Other logs
Standard error output of Administration agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent.err.*.log
Y
--
--
A
Y

Standard output of Administration agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent.out.*.log
Y
--
--
A
Y

Standard command line error output of Administration agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent.err
Y
--
--
A
Y

Console log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/processConsole*.log
Y
--
--
A
Y

Administration agent service standard output
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagentsv.exe.out
Y
--
--
A
Y

Administration agent service standard error output
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagentsv.exe.err
Y
--
--
A
Y

Management Server service standard error output
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvr.exe.err
Y
--
--
A
Y

Management Server service standard output
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvr.exe.out
Y
--
--
A
Y

Configuration file for automatic allocation used with the Explicit Memory Management functionality
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/auto_explicit_memory.cfg
Y
--
Y
C
C

User-extended trace based performance analysis configuration file used for user-extended trace based performance analysis
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/userprf.cfg
Y
--
Y
C
C

Definition file for the setup commands of Setup Wizard
Installation-directory-of-Cosminexus/manager/setup/config/*
Y
--
Y
Y
Y

Setup command log for Setup Wizard
Installation-directory-of-Cosminexus/manager/setup/log/*.log
Y
--
--
C
C

Maintenance log
Command maintenance log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/mngcmd*.log
--
Y
--
Y
Y

Administration agent maintenance log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/adminagent*.log
Y
--
--
Y
Y

Maintenance log in RMI process executed by Administration Agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/mngrmi*.log
--
Y
--
Y
Y

Management Server maintenance log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/mngsvr*.log
Y
--
--
Y
Y

Definition information
Administration agent property file
Installation-directory-of- Cosminexus/manager/config/adminagent.properties
Y
--
Y
Y
Y

Administration Agent option definition file
Installation-directory-of- Cosminexus/manager/config/adminagentuser.cfg
Y
--
Y
Y
Y

Administration Agent setup file
Installation-directory-of- Cosminexus/manager/config/adminagent.xml
Y
--
Y
Y
Y

Management agent property file
Installation-directory-of- Cosminexus/manager/config/mngagent.server-name.properties
Y
--
Y
Y
Y

Management Server environment setup file
Installation-directory-of- Cosminexus/manager/config/mserver.properties
Y
--
Y
Y
Y

Option definition file for Management Server
Installation-directory-of- Cosminexus/manager/config/mserver.cfg
Y
--
Y
Y
Y

Environment variable setup file for Management Server
Installation-directory-of- Cosminexus/manager/config/mserverenv.cfg
Y
--
Y
Y
Y

Manager setup file
Installation-directory-of- Cosminexus/manager/config/manager.cfg
Y
--
Y
Y
Y

Property file for Management action execution
Installation-directory-of- Cosminexus/manager/config/maction.properties
Y
--
Y
Y
Y

Property file for Management event issue
Installation-directory-of- Cosminexus/manager/config/mevent.server-name.properties
--
Y
Y
Y
Y

Message ID list file for Management event issue
Message ID list file for Management event issue (manager.mevent.message_id.list)
--
Y
Y
D
D

Client-side definition file of the mngsvrutil command
User-home-directory-(user.home)/.mngsvrutilrc
--
Y
Y
C
C

Server-side definition file of the mngsvrutil command
Installation-directory-of- Cosminexus/manager/config/mngsvrutil.properties
Y
--
Y
Y
Y

Client-side definition file of mngsvrutil command
Installation-directory-of- Cosminexus/manager/config/mngsvrutilcl.properties
Y
--
Y
Y
Y

Monitor start command setup file for JP1/IM linkage
user-home-directory-(user.home)/.mngsvrmonitorrc
--
Y
Y
C
C

System log message mapping file for JP1/IM linkage
Installation-directory-of- Cosminexus/manager/config/mserver.jp1event.system.mapping.properties
Y
--
Y
Y
Y

Installation-directory-of- Cosminexus/manager/config/manager.jp1event.system.mapping.properties
Y
--
Y
Y
Y

Installation-directory-of- Cosminexus/manager/config/manager.server-name.jp1event.system.mapping.properties
Y
--
Y
Y
Y

Performance, error analysis trace
PRF Trace
Directory-to-output-temporary-PRF-trace-file-(adminagent.prftrace_dir)/*.zip
--
Y
--
A
D

Internal interface trace
Integrated trace log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/trace/mngtrace*.log
Y
--
--
Y
Y

Others
OS state information etc
Installation-directory-of-Cosminexus /manager/tmp/*
Y
--
--
Y
Y

Smart Composer
Definition information
Server settings property file
Installation-directory-of-Cosminexus/manager/config/cmxserver.properties
Y
--
Y
Y
Y

Client settings property file
User-home-directory(user.home)/.cmxrc
--
Y
Y
C
C

Client common settings property file
Installation-directory-of-Cosminexus/manager/config/cmxclient.properties
Y
--
Y
Y
Y

Load balancer definition property file
Installation-directory-of- Cosminexus/manager/config/lb.properties
Y
--
Y
Y
Y

Integrated user management
Definition information
JAAS configuration file
Installation-directory-of-Cosminexus/manager/config/jaas.conf
Y
--
Y
Y
Y

Configuration file for integrated user management
Installation-directory-of-Cosminexus/manager/config/ua.conf
Y
--
Y
Y
Y

API Trace
Trace of integrated user management
Integrated-user-management-trace-file-name (com.cosminexus.admin.auth.trace.prefix).*.log
--
Y
--
D
D

Virtual server manager in the 08-50 mode
Definition information
Virtual server manager property file
Installation-directory-of-Cosminexus/manager/vmx/config/vmx.properties
Y
--
Y
D
Y

Client common settings property file of virtual server manager
Installation-directory-of-Cosminexus/manager/vmx/config/vmxclient.properties
Y
--
Y
D
Y

Option definition file for VMware vCenter Server connection processing
Installation-directory-of-Cosminexus/manager/vmx/config/vmx_avcs_usrconf.cfg
Y
--
Y
D
Y

Property file for VMware vCenter Server connection processing
Installation-directory-of-Cosminexus/manager/vmx/config/vmx_avcs_usrconf.properties
Y
--
Y
D
Y

Common definition file for VMware vCenter Server connection processing
Installation-directory-of-Cosminexus/manager/vmx/config/vmx_avcs_cjwconf.properties
Y
--
Y
D
Y

Other log
Log of the cjclstartap command used with the virtual server manager
Manager-log-output-directory (com.cosminexus.manager.log.dir)/vmx_avcs_logs/**
--
Y
--
D
Y

Log information collected from the virtual server
Virtual-server-manager-log-directory-in-08-50-mode(vmx.log.dir)/mngunit/*/*.zip
--
Y
--
D
C

Virtual server manager
Definition information
Virtual server manager property file
Installation-directory-of-Cosminexus/manager/vmi/config/vmi.properties
Y
--
Y
D
Y

Client settings property file of virtual server manager
User-home-directory(user.home)/.vmirc
--
Y
Y
C
C

Client common settings property file of virtual server manager
Installation-directory-of-Cosminexus/manager/vmi/config/vmiclient.properties
Y
--
Y
D
Y

Load balancer connection settings property file
Installation-directory-of-Cosminexus/manager/vmi/config/lb/*.properties
Y
--
Y
D
Y

Server Communication Agent
Message log
Server Communication Agent log
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagent*.log
Y
--
--
D
Y

Service log of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagentsv*.log
Y
--
--
D
C

snactl command log
server-communication-agent-log-output-directory(sinaviagent.log.dir)/snactl*.log
Y
--
--
D
C

Other logs
Error information during Server Communication Agent startup
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagent.err
Y
--
--
D
C

Standard output of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagent.out
Y
--
--
D
C

Console output information of command processes started by Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/processConsole*.log
Y
--
--
D
C

Maintenance log
Maintenance log of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/maintenance/sinaviagent*.log
--
Y
--
D
C

Maintenance log of Server Communication Agent service
server-communication-agent-log-output-directory(sinaviagent.log.dir)/maintenance/sinaviagentsv*.log
--
Y
--
D
C

Maintenance log of snactl command
server-communication-agent-log-output-directory(sinaviagent.log.dir)/maintenance/snactl*.log
--
Y
--
D
C

Javalog of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/maintenance/sinaviagent.javalog*.log
--
Y
--
D
C

Definition information
Option definition file for Server Communication Agent
Installation-directory-of-Cosminexus/sinagent/config/sinaviagent.cfg
Y
--
Y
D
Y

Server Communication Agent property file
Installation-directory-of-Cosminexus/sinagent/config/sinaviagent.properties
Y
--
Y
D
Y

Cosminexus Web Services - Base
Message log
Message log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjmessage*.log
Y
--
--
A
C

Web-container-server-log-output-directory-(web.server.log.directory)/cjweb_message*.log
Y
--
--
C
C

EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclmessage*.log
Y
--
--
C
C

Server trace, client trace, default trace, application log
J2EE-server-log-output-directory-(ejb.server.log.directory)/WS/*.log
Y
--
--
A
C

Web-container-server-log-output-directory (web.server.log.directory) /WS/*.log
Y
--
--
C
Y

Client trace, default trace, provided command trace, application log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/WS/*.log
Y
--
--
C
C

JAXR Trace
JAXR-trace-file-name (com.cosminexus.xml.registry.trace.file_path) *.log
Y
--
--
C
C

Definition information
Common definition file
Installation-directory-of-Cosminexus/c4web/conf/c4webcom.cfg
Y
--
Y
Y
Y

Server definition file
Installation-directory-of-Cosminexus/c4web/conf/c4websv.cfg
Y
--
Y
Y
Y

Service deploy definition
Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/server-config.xml
Y
--
Y
Y
Y

Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/server-config.xml
Y
--
Y
Y
Y

Client definition file
Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/classes/c4webcl.properties
Y
--
Y
Y
Y

Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/c4webcl.properties
Y
--
Y
Y
Y

Cosminexus JAX-WS
Message log
cjwsimport command operation log
Cosminexus-installation-directory/jaxws/logs/cjwsimport*.log
Y
--
--
Y
Y

apt command operation log
Cosminexus-installation-directory/jaxws/logs/cjwapt*.log
Y
--
--
Y
Y

cjwsgen command operation log
Cosminexus-installation-directory/jaxws/logs/cjwsgen*.log
Y
--
--
Y
Y

Service and client operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJW/cjwmessage*.log
Y
--
--
A
C

Client operation log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/CJW/cjwmessage*.log
Y
--
--
C
C

Service and client operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJR/cjrmessage*.log
Y
--
--
A
C

Other logs
Service and client communication log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJW/cjwtransport*.log
Y
--
--
A
C

Client communication log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/CJW/cjwtransport*.log
Y
--
--
C
C

Service and client communication log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJR/cjrtransport*.log
Y
--
--
A
C

Exception log
cjwsimport command exception log
Cosminexus-installation-directory/jaxws/logs/cjwsimportex*.log
Y
--
--
Y
Y

apt command exception log
Cosminexus-installation-directory/jaxws/logs/cjwaptex*.log
Y
--
--
Y
Y

cjwsgen command exception log
Cosminexus-installation-directory/jaxws/logs/cjwsgenex*.log
Y
--
--
Y
Y

Service and client exception log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJW/cjwexception*.lo
Y
--
--
A
C

Client exception log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/CJW/cjwexception*.log
Y
--
--
C
C

Service and client exception log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJR/cjrexception*.log
Y
--
--
A
C

Definition information
Action definition file
Installation-directory-of-Cosminexus/jaxws/conf/*.properties
Y
--
Y
Y
Y

Process wise action definition file
Process-wise-action-definition-file (com.cosminexus.jaxws.confpath)
Y
--
Y
D
D

Action definition file
Installation-directory-of-Cosminexus/jaxrs/conf/*.properties
Y
--
Y
C
C

Process-wise action definition file
Process-wise-action-definition-file-(com.cosminexus.jaxrs.confpath)
Y
--
Y
D
D

Definition file
web.xml
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/web.xml
--
Y
Y
A
A

cosminexus-jaxws.xml
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/cosminexus-jaxws.xml
--
Y
Y
A
A

Handler chain setup file
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/**
--
Y
Y
D
D

WSDL
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/wsdl/*
--
Y
Y
A
A

Catalog file
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/classes/META-INF/jax-ws-catalog.xml
--
Y
Y
A
A

J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/apps/*/*/*/jax-ws-catalog.xml
--
Y
Y
A
A

Cosminexus JPA provider
Message log
Cosminexus JPA provider operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjpa/cjpaoperation*.log
Y
--
--
A
C

PRF daemon and PRF command log
PRF-spool-directory-(prfspool)/log/PRF-identifier/ctmlog*
Y
--
--
A
C

Resource adapter operation log deployed and used as J2EE resource adapter
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

Message log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjmessage*.log
Y
--
--
A
C

Other logs
Exception information when an error occurs
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjexception*.log
Y
--
--
A
C

Definition information
Option definition file for J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/*.cfg
Y
--
Y
Y
Y

User property file for the J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/*.properties
Y
--
Y
Y
Y

Security policy file for J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/*.policy
Y
--
Y
Y
Y

User data
Contents of EJB server working directory
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/**
--
Y
--
D
D

Contents of Web container working directory
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/**
--
Y
--
D
D

Cosminexus JMS provider
Message log
CJMSP Broker log
Installation-directory-of-Cosminexus/CC/cjmsp/var/instances/instance-name/log/*.log
Y
--
--
C
C

Management command log
Installation-directory-of-Cosminexus/CC/cjmsp/var/admin/log/*.log
Y
--
--
C
C

CJMSP resource adapter log
J2EE-server-log-output-directory(ejb.server.log.directory)/cjms/resource-adapter-name/*.log
Y
--
--
A
C

Definition information
CJMSP Broker Common Property File
Installation-directory-of-Cosminexus/CC/cjmsp/lib/props/broker/commonconfig.properties
Y
--
Y
Y
Y

CJMSP Broker Property File
Installation-directory-of-Cosminexus/CC/cjmsp/var/instances/instance-name/props/config.properties
Y
--
Y
C
C

Management command definition file
Installation-directory-of-Cosminexus/CC/cjmsp/var/admin/config/admin.properties
Y
--
Y
C
C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For collection method
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-6 Collection method related to Cosminexus Component Container (In UNIX)

Category
Type of data
File to be collected
Default collection destination
Data
How to collect

Primary
Secondary
Definition
A
B

J2EE server (when executed in the J2EE server mode)
Message log
Operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjmessage*.log
Y
--
--
A
C

Log operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjlogger.log
Y
--
--
A
C

Resource adapter operation log deployed and used as J2EE resource adapter.
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

Resource adapter operation log used by including in J2EE application (normal mode)
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/J2EE-application-name/*.log
Y
--
--
A
C

Resource adapter operation log used by including in J2EE application (test mode)
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/TEST#J2EE-application-name/*.log
Y
--
--
A
C

Web servlet log
J2EE-server-log-output-directory-(ejb.server.log.directory)/web_servlet*.log
Y
--
--
A
C

Other logs
User output log
J2EE-server-log-output-directory-(ejb.server.log.directory)/user_out*.log
Y
--
--
A
C

User error log
J2EE-server-log-output-directory-(ejb.server.log.directory)/user_err*.log
Y
--
--
A
C

JavaVM maintenance information and garbage collection log
J2EE-server-log-output-directory-(ejb.server.log.directory)/javalog*.log
Y
--
--
A
C

JavaVM specific management heap function event log
J2EE-server-log-output-directory-(ejb.server.log.directory)/ehjavalog*.log
Y
--
--
A
C

Development check log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjdevelopment*.log
Y
--
--
A
C

Exception information when an error occurs
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjexception*.log
Y
--
--
A
C

JavaVM event log
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/hs_err*
Y
--
--
A
A

User log of J2EE applications
J2EE-server-log-output-directory-(ejb.server.log.directory)/user/*
Y
--
--
A
C

Maintenance log
Maintenance information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjmaintenance*.log
Y
--
--
A
C

Console message
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjconsole*.log
Y
--
--
A
C

EJB container maintenance information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjejbcontainer*.log
Y
--
--
A
C

Web container maintenance information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjwebcontainer*.log
Y
--
--
A
C

Start process standard output information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjstdout*.log
Y
--
--
A
C

Start process standard error information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cjstderr*.log
Y
--
--
A
C

Termination process information
J2EE-server-log-output-directory-(ejb.server.log.directory)/CC/maintenance/cj_shutdown*.log
Y
--
--
A
C

Dump
Thread dump
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/javacore*
Y
--
--
A
A

core dump
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/core*
--
Y
--
A
A

Statistical information
Operation information file
statistics-file-output-destination-directory-(ejbserver.management.stats_file.dir)/*
--
Y
--
A
C

Memory monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjmemorywatch*.log
Y
--
--
A
C

File descriptor monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjfiledescriptorwatch*.log
Y
--
--
A
C

Thread monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjthreadwatch*.log
Y
--
--
A
C

Thread dump monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjthreaddumpwatch*.log
Y
--
--
A
C

HTTP request pending queue monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjrequestqueuewatch*.log
Y
--
--
A
C

HTTP session count monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjhttpsessionwatch*.log
Y
--
--
A
C

Connection pool monitoring log
J2EE-server-log-output-directory(ejb.server.log.directory)/watch/cjconnectionpoolwatch*.log
Y
--
--
A
C

Definition information
Option definition file for J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/usrconf.cfg
Y
--
Y
Y
Y

User property file for the J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/usrconf.properties
Y
--
Y
Y
Y

Security policy file for J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/server.policy
Y
--
Y
Y
Y

Backup of various definition files created in MNG
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/*
--
Y
--
Y
Y

Protected area list file
Installation-directory-of-Cosminexus /CC/server/usrconf/criticalList.cfg
Y
--
Y
Y
Y

Resource setup information
J2EE-server-work-directory(ejb.public.directory)/ejb/server-name/import/**
--
Y
--
D
D

J2EE-server-work-directory(ejb.public.directory)/ejb/server-name/rars/**
--
Y
--
D
D

Others
Log showing J2EE server start, stop or abnormal termination
UNIX-syslog (syslog)
Y
--
--
C
C

User data
Contents of EJB server working directory
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/**
--
Y
--
D
D

Contents of Web container working directory
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/**
--
Y
--
D
D

Contents of temporary directory for JSP
Temporary-directory-for-JSP-(webserver.work.directory)/**
--
Y
--
D
D

Web container server (When executed in the servlet engine mode)
Other logs
JavaVM event log
Installation-directory-of-Cosminexus/CC/web/containers/server-name/hs_err*
Y
--
--
Y
Y

Maintenance log
Logs
Web-container-server-log-output-directory-(web.server.log.directory)/*
Y
--
--
C
C

Web-container-server-log-output-directory-(web.server.log.directory)/*/*
Y
--
--
C
C

Web-container-server-log-output-directory-(web.server.log.directory)/*/*/*
Y
--
--
C
C

Web-container-server-log-output-directory-(web.server.log.directory)/*/*/*/*
Y
--
--
C
C

Dump
Thread dump
Installation-directory-of-Cosminexus/CC/web/containers/server-name/javacore*
Y
--
--
Y
Y

core dump
Installation-directory-of-Cosminexus/CC/web/containers/server-name/core*
--
Y
--
Y
Y

Definition information
Option definition file for the Web container server
Installation-directory-of-Cosminexus/CC/web/containers/server-name/usrconf/usrconf.cfg
Y
--
Y
Y
Y

User property file for the Web container server
Installation-directory-of-Cosminexus/CC/web/containers/server-name/usrconf/usrconf.properties
Y
--
Y
Y
Y

Security policy file for the Web container server
Installation-directory-of-Cosminexus/CC/web/containers/server-name/usrconf/web.policy
Y
--
Y
Y
Y

User authentication information definition file
Installation-directory-of-Cosminexus/CC/web/containers/server-name/usrconf/web-users.xml
Y
--
Y
Y
Y

Definition files
Cosminexus-installation-directory/CC/web/containers/server-name/usrconf/*
--
Y
Y
Y
Y

Server management commands
Message log
Operation log
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/cjmessage*.log
Y
--
--
C
C

Log operation log
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/cjlogger.log
Y
--
--
C
C

Operation log in compatible mode
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/*message*.log
Y
--
--
C
C

Other logs
Exception information when an error occurs
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/cjexception*.log
Y
--
--
C
C

Exception information when an error occurs in compatible mode
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/*exception*.log
Y
--
--
C
C

Maintenance log
Maintenance information
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/CC/maintenance/cjmaintenance*.log
Y
--
--
C
C

Console message
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/CC/maintenance/cjconsole*.log
Y
--
--
C
C

Server management command maintenance information
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/CC/maintenance/cjserveradmin*.log
Y
--
--
C
C

Other logs
server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/*/*
Y
--
--
C
C

server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/*/*/*
Y
--
--
C
C

server-management-command-log-output-directory-(admin_ejb.server.log.directory)>/*/*/*/*
--
Y
--
C
C

Definition information
Definition file for server management command
Installation-directory-of-Cosminexus/CC/admin/usrconf/*
Y
--
--
Y
Y

Batch application
Message log
Operation log of cjexecjob, cjkilljob, and cjlistjob command
batch-application-log-output-directory-(batch.log.directory)/cjmessage*.log
Y
--
--
C
C

Maintenance log
Other logs
batch-application-log-output-directory-(batch.log.directory)/*/*
Y
--
--
C
C

Definition information
Option definition file for batch application
Definition-file-storage-directory-of-batch-application/usrconf.cfg
Y
--
--
D
D

User property file for batch application
Definition-file-storage-directory-of-batch-application/usrconf.properties
Y
--
--
D
D

Resource adapter version upgrade command (cjrarupdate)
Message log
Operation log
Installation-directory-of-Cosminexus/CC/logs/cjrarupdatemessage*.log
Y
--
--
Y
Y

Other logs
Exception information when an error occurs
Installation-directory-of-Cosminexus/CC/logs/cjrarupdateexception*.log
Y
--
--
Y
Y

Maintenance log
Maintenance information
Installation-directory-of-Cosminexus/CC/logs/cjrarupdatemaintenance*.log
Y
--
--
Y
Y

In-process HTTP server
Access log
Process result of in-process HTTP server
In-process-HTTP-server-access-log-file (webserver.logger.access_log.inprocess_http.filename)*.log
Y
--
--
A
C

Module trace
Thread trace information
J2EE-server-log-output-directory (ejb.server.log.directory)/http/maintenance/thr/cjhttp_thr.*.inprocess_http.mm
Y
--
--
A
C

Communication trace
Communication trace information
J2EE-server-log-output-directory-(ejb.server.log.directory)/http/maintenance/comm/cjhttp_comm.*.inprocess_http.mm
Y
--
--
A
C

Migration command (cjenvupdate)
Message log
Operation log of the cjenvupdate command
Installation-directory-of-Cosminexus/CC/logs/cjenvupdatemessage*.log
Y
--
--
Y
Y

Other logs
Exception information of the cjenvupdate command
Installation-directory-of-Cosminexus/CC/logs/cjenvupdateexception*.log
Y
--
--
Y
Y

Maintenance log
Maintenance information of the cjenvupdate command
Installation-directory-of-Cosminexus/CC/logs/cjenvupdatemaintenance*.log
Y
--
--
Y
Y

Command for changing CC Administrator
Message log
Operation log of the cjenvsetup command
Application-Server-installation-directory/CC/logs/cjenvsetupmessage*.log
Y
--
--
Y
Y

Other
File configuration information before executing the cjenvsetup command
Application-Server-installation-directory/CC/logs/before_cjenvsetup_files*.txt
Y
--
--
Y
Y

File configuration information after executing the cjenvsetup command
Application-Server-installation-directory/CC/logs/after_cjenvsetup_files*.txt
Y
--
--
Y
Y

In-process transaction service
Others
In-process transaction service status file
Status-file-directory-(ejbserver.distributedtx.ots.status.directory1)/*
--
Y
--
A
C

Status-file-directory-(ejbserver.distributedtx.ots.status.directory1)/*/*
--
Y
--
A
C

In-process transaction service spare status file
Spare-status-file-directory-(ejbserver.distributedtx.ots.status.directory2)/*
--
Y
--
A
D

Spare-status-file-directory-(ejbserver.distributedtx.ots.status.directory2)/*/*
--
Y
--
A
D

EJB client
Message log
Operation log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclmessage*.log
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/EJB-client-log-subdirectory-1(ejb.client.ejb.log)/EJB-client-log-subdirectory-2(ejb.client.log.appid)/cjclmessage*.log
Y
--
--
D
D

cjclstartap command operation log
EJB-client-log-output-directory-(ejb.client.log.directory)/cjclstartap*.log
Y
--
--
D
D

cjcldellog command operation log
Installation-directory-of-Cosminexus/CC/client/logs/cjcldellog.log
Y
--
--
Y
Y

Other logs
User output log
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/user_out*.log
Y
--
--
D
D

User error log
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/user_err*.log
Y
--
--
D
D

JavaVM maintenance information, garbage collection log
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/javalog*.log
Y
--
--
D
D

Exception information when an error occurs
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclexception*.log
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/EJB-client-log-subdirectory-1(ejb.client.ejb.log)/EJB-client-log-subdirectory-2(ejb.client.log.appid)/maintenance/cjclmaintenance*.log
Y
--
--
D
D

EJB client application user log
EJB-client-log-output-directory(ejbserver.client.log.directory)/user/*
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/user/*
Y
--
--
D
D

Maintenance log
Maintenance information
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclmaintenance*.log
Y
--
--
C
C

EJB-client-log-output-directory(ejb.client.log.directory)/EJB-client-log-subdirectory-1(ejb.client.ejb.log)/EJB-client-log-subdirectory-2(ejb.client.log.appid)/maintenance/cjclmaintenance*.log
Y
--
--
D
D

EJB container maintenance information
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/maintenance/cjejbcontainer*.log
Y
--
--
D
D

Start process standard output information
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/maintenance/cjstdout*.log
Y
--
--
D
D

Start process standard error information
EJB-client-log-output-directory-(ejb.client.log.directory)/EJB-client-log-subdirectory-(ejb.client.ejb.log)/EJB-client-log-subdirectory2-(ejb.client.log.appid)/maintenance/cjstderr*.log
Y
--
--
D
D

Log operation information
EJB-client-log-output-directory(ejb.client.log.directory)/cjlogger.log
Y
--
--
D
D

Definition information
Option definition file for EJB client
EJB-client-definition-file-storage-directory/usrconf.cfg
Y
--
--
D
D

User property file for EJB client
EJB-client-definition-file-storage-directory/usrconf.properties
Y
--
--
D
D

Redirector (Web server)
Message log
Redirector message log for HWS
Redirector-log-output-directory-for-HWS (JkLogFileDir)/hws_redirect*.log
Y
--
--
A
C

Redirector message log for previous version compatible HWS
Redirector-log-output-directory-for-HWS (JkLogFileDir)/hws_redirect*.log
Y
--
--
A
C

Maintenance log
Trace log for maintenance of redirector for HWS
Redirector-trace-log-output-directory-for-HWS (JkTraceLogFileDir)/hws_rd_trace*.log
Y
--
--
A
C

Trace log for maintenance of redirector for previous version compatible HWS
Redirector-trace-log-output-directory-for-HWS (JkTraceLogFileDir)/hws_rd_trace*.log
Y
--
--
A
C

Definition information
Redirector action definition file for HWS
Installation-directory-of-Cosminexus/CC/web/redirector/servers/server-name/mod_jk.conf
Y
--
Y
Y
Y

Worker definition file
Installation-directory-of-Cosminexus/CC/web/redirector/servers/server-name/workers.properties
Y
--
Y
Y
Y

Redirector action definition file for previous version compatible HWS
Installation-directory-of-Cosminexus/CC/web/redirector/mod_jk.conf
Y
--
--
Y
Y

Worker definition file for previous version compatibility
Installation-directory-of-Cosminexus/CC/web/redirector/workers.properties
Y
--
--
Y
Y

EADs client for the EADs session failover functionality
Message log
Message log of the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/eads_client_message*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/eads_client_message*.log
Y
--
--
C
C

Communication trace
Communication trace of the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/eads_client_comm_trace*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/eads_client_comm_trace*.log
Y
--
--
C
C

Maintenance log
Maintenance log for the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/maintenance/eads_client_maintenance*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/maintenance/eads_client_maintenance*.log
Y
--
--
C
C

Message dump of the EADs client for the EADs session failover functionality
J2EE-server-log-output-directory-(ejb.server.log.directory)/maintenance/eads_client_comm_dump*.log
Y
--
--
C
C

Server-management-command-log-output-directory-(admin_ejb.server.log.directory)/maintenance/eads_client_comm_dump*.log
Y
--
--
C
C

TP1/Message Queue - Access
Maintenance log
Method trace, message log related to API and Cosminexus interface
J2EE-server-log-output-directory(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

API Trace
API Trace file
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/mqc.api*
Y
--
--
A
A

uCosminexus TP1 Connector
Message log
TP1 Connector operation log deployed and used as J2EE resource adapter
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

TP1 Connector operation log used by including in J2EE application
(Normal mode)
J2EE-server-log-output-directory(ejb.server.log.directory)/connectors/J2EE-application-name/*.log
Y
--
--
A
C

TP1 Connector operation log used in Non-managed environment
TP1-Connectorlog-output-directory (jp.co.hitachi_system.tp1connector.logdestination)/tp1connector*.log
Y
--
--
C
C

TP1/Client/J
Other logs
Debug trace information
user-home-directory-(user.home)/TP1clientJ/dcClt*.dmp
--
Y
--
C
C

Cosminexus Manager
Message log
Integrated message log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/message/mngmessage*.log
Y
--
--
A
Y

Administration agent log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent*.log
Y
--
--
A
Y

Administration agent start, stop command log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagentctl.*.log
Y
--
--
A
Y

Management agent log and trace
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngagent*.*.log
Y
--
--
A
Y

Management Server startup command log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvrctlstart.*.log
Y
--
--
A
Y

Management Server stop command log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvrctlstop.*.log
Y
--
--
A
Y

Management Server setup command log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvrctlsetup.*.log
Y
--
--
A
Y

Management Server log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/mngsvr*.log
Y
--
--
A
Y

Other logs
Standard error output of Administration agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent.err.*.log
Y
--
--
A
Y

Standard output of Administration agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent.out.*.log
Y
--
--
A
Y

Standard command line error output of Administration agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/adminagent.err
Y
--
--
A
Y

Console log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/processConsole*.log
Y
--
--
A
Y

Configuration file for automatic allocation used with the Explicit Memory Management functionality
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/auto_explicit_memory.cfg
Y
--
Y
C
C

User-extended trace based performance analysis configuration file used for user-extended trace based performance analysis
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/userprf.cfg
Y
--
Y
C
C

Definition file for the setup commands of Setup Wizard
Installation-directory-of-Cosminexus/manager/setup/config/*
Y
--
Y
Y
Y

Setup command log for Setup Wizard
Installation-directory-of-Cosminexus/manager/setup/log/*.log
Y
--
--
C
C

Maintenance log
Command maintenance log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/mngcmd*.log
--
Y
--
Y
Y

Maintenance log in RMI process executed by Administration Agent
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/mngrmi*.log
--
Y
--
Y
Y

Administration agent maintenance log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/adminagent*.log
Y
--
--
Y
Y

mngenvsetup command execution log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/mngenvsetup*.log
--
Y
--
Y
Y

Management Server maintenance log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/maintenance/mngsvr*.log
Y
--
--
Y
Y

Definition information
Administration agent property file
Installation-directory-of-Cosminexus/manager/config/adminagent.properties
Y
--
Y
Y
Y

Settings file for Administration agent automatic start
Installation-directory-of-Cosminexus/manager/config/AdminAgentrc
Y
--
Y
Y
Y

Option definition file for Administration agent
Installation-directory-of-Cosminexus/manager/config/adminagentuser.cfg
Y
--
Y
Y
Y

Administration agent setup file
Installation-directory-of-Cosminexus/manager/config/adminagent.xml
Y
--
Y
Y
Y

Management agent property file
Installation-directory-of-Cosminexus/manager/config/mngagent.server-name.properties
Y
--
Y
Y
Y

Management Server environment setup file
Installation-directory-of-Cosminexus/manager/config/mserver.properties
Y
--
Y
Y
Y

Option definition file for Management Server
Installation-directory-of-Cosminexus/manager/config/mserver.cfg
Y
--
Y
Y
Y

Environment variable definition file for Management Server
Installation-directory-of-Cosminexus/manager/config/mserverenv.cfg
Y
--
Y
Y
Y

Manager setup file
Installation-directory-of-Cosminexus/manager/config/manager.cfg
Y
--
Y
Y
Y

Property file for Management action execution
Installation-directory-of- Cosminexus/manager/config/maction.properties
Y
--
Y
Y
Y

Property file for Management event issue
Installation-directory-of-Cosminexus/manager/config/mevent.server-name.properties
--
Y
Y
Y
Y

Message ID list file for Management event issue
Message-ID-list-file-for-Management-event-issue (manager.mevent.message_id.list)
--
Y
Y
D
D

Client-side definition file of the mngsvrutil command
user-home-directory-(user.home)/.mngsvrutilrc
--
Y
Y
C
C

Server-side definition file of the mngsvrutil command
Installation-directory-of-Cosminexus/manager/config/mngsvrutil.properties
Y
--
Y
Y
Y

Client-side definition file of mngsvrutil command
Installation-directory-of-Cosminexus/manager/config/mngsvrutilcl.properties
Y
--
Y
Y
Y

System log message mapping file for JP1/IM linkage
Installation-directory-of-Cosminexus/manager/config/mserver.jp1event.system.mapping.properties
Y
--
Y
Y
Y

Installation-directory-of-Cosminexus/manager/config/manager.jp1event.system.mapping.properties
Y
--
Y
Y
Y

Installation-directory-of-Cosminexus/manager/config/manager.server-name.jp1event.system.mapping.properties
Y
--
Y
Y
Y

Performance, error analysis trace
PRF trace
Directory-to-output-temporary-PRF-trace-file-(adminagent.prftrace_dir)/*.zip
--
Y
--
A
D

Internal interface trace
Integrated trace log
Manager-log-output-directory-(com.cosminexus.manager.log.dir)/trace/mngtrace*.log
Y
--
--
Y
Y

Others
OS state information
Installation-directory-of-Cosminexus/manager/tmp/*
Y
--
--
Y
Y

Smart Composer
Definition information
Server settings property file
Installation-directory-of-Cosminexus/manager/config/cmxserver.properties
Y
--
Y
Y
Y

Client settings property file
User-home-directory (user.home)/.cmxrc
--
Y
Y
C
C

Client common settings property file
Installation-directory-of-Cosminexus/manager/config/cmxclient.properties
Y
--
Y
Y
Y

Load balancer definition property file
Installation-directory-of-Cosminexus/manager/config/lb.properties
Y
--
Y
Y
Y

Integrated user management
Definition information
JAAS configuration file
Installation-directory-of-Cosminexus/manager/config/jaas.conf
Y
--
Y
Y
Y

Configuration file for integrated user management
Installation-directory-of-Cosminexus/manager/config/ua.conf
Y
--
Y
Y
Y

API Trace
Trace of integrated user management
Integrated-user-management-trace-file-name (com.cosminexus.admin.auth.trace.prefix).*.log
--
Y
--
D
D

Virtual server manager in the 08-50 mode
Definition information
Virtual server manager property file
Installation-directory-of-Cosminexus/manager/vmx/config/vmx.properties
Y
--
Y
D
Y

Client common settings property file of virtual server manager
Installation-directory-of-Cosminexus/manager/vmx/config/vmxclient.properties
Y
--
Y
D
Y

Option definition file for VMware vCenter Server connection processing
Installation-directory-of-Cosminexus/manager/vmx/config/vmx_avcs_usrconf.cfg
Y
--
Y
D
Y

Property file for VMware vCenter Server connection processing
Installation-directory-of-Cosminexus/manager/vmx/config/vmx_avcs_usrconf.properties
Y
--
Y
D
Y

Common definition file for VMware vCenter Server connection processing
Installation-directory-of-Cosminexus/manager/vmx/config/vmx_avcs_cjwconf.properties
Y
--
Y
D
Y

Other log
Log of the cjclstartap command used with the virtual server manager
Manager-log-output-directory(com.cosminexus.manager.log.dir)/vmx_avcs_logs/**
--
Y
--
D
Y

Log information collected from the virtual server
Virtual-server-manager-log-directory-in-08-50-mode(vmx.log.dir)/mngunit/*/*.zip
--
Y
--
D
C

Virtual server manager
Definition information
Virtual server manager property file
Installation-directory-of-Cosminexus/manager/vmi/config/vmi.properties
Y
--
Y
D
Y

Client settings property file of virtual server manager
User-home-directory(user.home)/.vmirc
--
Y
Y
C
C

Client common settings property file of virtual server manager
Installation-directory-of-Cosminexus/manager/vmi/config/vmiclient.properties
Y
--
Y
D
Y

Load balancer connection settings property file
Installation-directory-of-Cosminexus/manager/vmi/config/lb/*.properties
Y
--
Y
D
Y

Server Communication Agent
Message log
Server Communication Agent log
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagent*.log
Y
--
--
D
Y

Service log of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagentsv*.log
Y
--
--
D
C

snactl command log
server-communication-agent-log-output-directory(sinaviagent.log.dir)/snactl*.log
Y
--
--
D
C

Other logs
Error information during Server Communication Agent startup
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagent.err
Y
--
--
D
C

Standard output of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/sinaviagent.out
Y
--
--
D
C

Console output information of command processes started by Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/processConsole*.log
Y
--
--
D
C

Maintenance log
Maintenance log of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/maintenance/sinaviagent*.log
--
Y
--
D
C

Maintenance log of snactl command
server-communication-agent-log-output-directory(sinaviagent.log.dir)/maintenance/snactl*.log
--
Y
--
D
C

Javalog of Server Communication Agent
server-communication-agent-log-output-directory(sinaviagent.log.dir)/maintenance/sinaviagent.javalog*.log
--
Y
--
D
C

Definition information
Option definition file for Server Communication Agent
Installation-directory-of-Cosminexus/sinagent/config/sinaviagent.cfg
Y
--
Y
D
Y

Server Communication Agent property file
Installation-directory-of-Cosminexus/sinagent/config/sinaviagent.properties
Y
--
Y
D
Y

Cosminexus Web Services - Base
Message log
Message log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjmessage*.log
Y
--
--
A
C

Web-container-server-log-output-directory-(web.server.log.directory)/cjweb_message*.log
Y
--
--
C
C

EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/cjclmessage*.log
Y
--
--
C
C

Server trace, client trace, default trace, application log
J2EE-server-log-output-directory-(ejb.server.log.directory)/WS/*.log
Y
--
--
A
C

Web-container-server-log-output-directory (web.server.log.directory)/WS/*.log
Y
--
--
C
Y

Client trace, default trace, provided command trace, application log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/WS/*.log
Y
--
--
C
C

JAXR Trace
JAXR-Trace-file-name (com.cosminexus.xml.registry.trace.file_path)*.log
Y
--
--
C
C

Definition information
Common definition file
Installation-directory-of-Cosminexus/c4web/conf/c4webcom.cfg
Y
--
Y
Y
Y

Server definition file
Installation-directory-of-Cosminexus/c4web/conf/c4websv.cfg
Y
--
Y
Y
Y

Service deploy definition
Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/server-config.xml
Y
--
Y
Y
Y

Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/server-config.xml
Y
--
Y
Y
Y

Client definition file
Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/classes/c4webcl.properties
Y
--
Y
Y
Y

Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/c4webcl.properties
Y
--
Y
Y
Y

Cosminexus JAX-WS
Message log
Service and client operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJW/cjwmessage*.log
Y
--
--
A
C

Client operation log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/CJW/cjwmessage*.log
Y
--
--
C
C

Service and client operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJR/cjrmessage*.log
Y
--
--
A
C

Other logs
Service and client communication log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJW/cjwtransport*.log
Y
--
--
A
C

Client communication log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/CJW/cjwtransport*.log
Y
--
--
C
C

Service and client communication log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJR/cjrtransport*.log
Y
--
--
A
C

Exception log
Service and client exception log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJW/cjwexception*.lo
Y
--
--
A
C

Client exception log
EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/CJW/cjwexception*.log
Y
--
--
C
C

Service and client exception log
J2EE-server-log-output-directory-(ejb.server.log.directory)/CJR/cjrexception*.log
Y
--
--
A
C

Definition information
Action definition file
Installation-directory-of-Cosminexus/jaxws/conf/*.properties
Y
--
Y
Y
Y

Process wise action definition file
Process-wise-action-definition-file (com.cosminexus.jaxws.confpath)
Y
--
Y
D
D

Action definition file
Installation-directory-of-Cosminexus/jaxrs/conf/*.properties
Y
--
Y
C
C

Process-wise action definition file
Process-wise-action-definition-file-(com.cosminexus.jaxrs.confpath)
Y
--
Y
D
D

Definition file
web.xml
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/web.xml
--
Y
Y
A
A

cosminexus-jaxws.xml
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/cosminexus-jaxws.xml
--
Y
Y
A
A

Handler chain setup file
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/**
--
Y
Y
D
D

WSDL
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/wsdl/*
--
Y
Y
A
A

Catalog file
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/*/WEB-INF/classes/META-INF/jax-ws-catalog.xml
--
Y
Y
A
A

J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/apps/*/*/*/jax-ws-catalog.xml
--
Y
Y
A
A

Cosminexus JPA provider
Message log
Cosminexus JPA provider operation log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjpa/cjpaoperation*.log
Y
--
--
A
C

PRF daemon and PRF command log
PRF-spool-directory-(prfspool)/log/PRF-identifier/ctmlog*
Y
--
--
A
C

Resource adapter operation log deployed and used as J2EE resource adapter
J2EE-server-log-output-directory-(ejb.server.log.directory)/connectors/*.log
Y
--
--
A
C

Message log
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjmessage*.log
Y
--
--
A
C

Other logs
Exception information when an error occurs
J2EE-server-log-output-directory-(ejb.server.log.directory)/cjexception*.log
Y
--
--
A
C

Definition information
Option definition file for J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/*.cfg
Y
--
Y
Y
Y

User property file for the J2EE server
Installation-directory-of-Cosminexus/CC/server/usrconf/ejb/server-name/*.properties
Y
--
Y
Y
Y

Security policy file for J2EE server
Cosminexus-installation-directory/CC/server/usrconf/ejb/server-name/*.policy
Y
--
Y
Y
Y

User data
EJB server working directory contents
J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/**
--
Y
--
D
D

Web container working directory contents
J2EE-server-working-directory-(ejb.public.directory)/web/server-name/**
--
Y
--
D
D

Cosminexus JMS provider
Message log
CJMSP Broker log
Installation-directory-of-Cosminexus/CC/cjmsp/var/instances/instance-name/log/*.log
Y
--
--
C
C

Management command log
Installation-directory-of-Cosminexus/CC/cjmsp/var/admin/log/*.log
Y
--
--
C
C

CJMSP resource adapter log
J2EE-server-log-output-directory(ejb.server.log.directory)/cjms/resource-adapter-name/*.log
Y
--
--
A
C

Definition information
CJMSP Broker Common Property File
Installation-directory-of-Cosminexus/CC/cjmsp/lib/props/broker/commonconfig.properties
Y
--
Y
Y
Y

CJMSP Broker Property File
Installation-directory-of-Cosminexus/CC/cjmsp/var/instances/instance-name/props/config.properties
Y
--
Y
C
C

Management command definition file
Installation-directory-of-Cosminexus/CC/cjmsp/var/admin/config/admin.properties
Y
--
Y
C
C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
N: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.3 Cosminexus Component Transaction Monitor

The following table describes directory paths to be collected in relation to a Cosminexus Component Container Monitor.

Table A-7 Collection target related to Cosminexus Component Transaction Monitor (In Windows)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | CTM daemon and CTM command log | CTM-spool-directory-(ctmspool)/log/CTM-identifier/ctmlog* | Y | -- | -- | A | C
CTM domain manager log | CTM-spool-directory-(ctmspool)/log/ctmdmlog* | Y | -- | -- | A | C
Dump | Thread dump | Installation-directory-of-Cosminexus/TPB/logj/javacore* | Y | -- | -- | B | B
Definition information | CTM regulator configuration file | CTM-regulator-configuration-file-(ctm.RegOption) | Y | -- | -- | A | D
OTM gateway configuration file | OTM-gateway- configuration -file-(ctm.TSCGwOption) | Y | -- | -- | A | D

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-8 Collection target related to Cosminexus Component Transaction Monitor (In UNIX)

Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | CTM daemon and CTM command log | CTM-spool-directory-(ctmspool)/log/CTM-identifier/ctmlog* | Y | -- | -- | A | C
CTM domain manager log | CTM-spool-directory (ctmspool)/log/ctmdmlog* | Y | -- | -- | A | C
Dump | Thread dump | Installation-directory-of-Cosminexus/TPB/logj/javacore * | Y | -- | -- | B | B
core dump | Installation-directory-of-Cosminexus/TPB/logj/javacore * | -- | Y | -- | B | B
Definition information | CTM regulator configuration file | CTM-regulator- configuration -file-(ctm.RegOption) | Y | -- | -- | A | D
OTM gateway configuration file | OTM-gateway- configuration -file-(ctm.TSCGwOption) | Y | -- | -- | A | D

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.4 Cosminexus DABroker Library

The following table describes the collection targets related to Cosminexus DABroker Library.

Table A-9 Collection target related to Cosminexus DABroker Library (In Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Definition information | Operation environment definition file | Installation-directory-of-Cosminexus/DAB/conf/dasysconf | Y | -- | Y | B | B
Connection destination database definition file | Installation-directory-of-Cosminexus/DAB/conf/dadbenv | Y | -- | Y | B | B
Others | Spool information | Installation-directory-of-Cosminexus/DAB/spool/* | Y | -- | -- | B | B
Installation-directory-of-Cosminexus/DAB/spool/*/* | -- | Y | -- | B | B

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the meaning of the directories and files to be collected that are described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-10 Collection target related to Cosminexus DABroker Library (In UNIX)

Type of data | File to be collected | Collection target | Data | Collection method
Primary | Secondary | Definition | A | B
Definition information | Operation environment definition file | DABroker-operation-directory(dabroker)/conf/dasysconf | Y | -- | Y | C | C
Connection destination database definition file | DABroker-operation-directory(dabroker)/conf/dadbenv | Y | -- | Y | C | C
Others | Spool information | DABroker-operation-directory(dabroker)/spool/* | Y | -- | -- | C | C
DABroker-operation-directory(dabroker)/spool/*/* | -- | Y | -- | C | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the meaning of the directories and files to be collected that are described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.5 Cosminexus Developer's Kit for Java

The following table describes the logs to be collected for DABroker Library.

Table A-11 Logs to be collected related to Cosminexus Developer's Kit for Java (In Windows)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Dump | Watson log | Windows-Waston-log-file (DrWtsnLogFile) | Y | -- | -- | C | C
Crash dump | Windows-Crash-dump-file (CrashDumpFile) | -- | Y | -- | C | C
Windows-Crash-Dump-output-directory (CrashDumpDir) /*.dmp | -- | Y | -- | C | C
Definition information | User-extended trace based performance analysis configuration file | Configuration-file-for-user-extended-trace-based-performance-analysis- (jvm.userprf.File) | Y | -- | Y | C | C
Explicit Memory Management functionality exclusion configuration file | Name-of-Explicit-Memory-Management-functionality-exclusion-configuration-file-(jvm.exmemexcludeclass.File) | Y | -- | Y | C | C
Explicit Memory Management functionality non-exclusion configuration file | Name-of-Explicit-Memory-Management-functionality-non-exclusion- configuration -file-(jvm.exmemnotexcludeclass.File) | Y | -- | Y | C | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-12 Logs to be collected for Developer's Kit for Java (in UNIX)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Definition information | User-extended trace based performance analysis configuration file | User-extended-trace-based-performance-analysis-configuration-file-(jvm.userprf.File) | Y | -- | Y | C | C
Explicit Memory Management functionality exclusion configuration file | Name-of-Explicit-Memory-Management-functionality-exclusion-configuration-file-(jvm.exmemexcludeclass.File) | Y | -- | Y | C | C
Explicit Memory Management functionality non-exclusion configuration file | Name-of-Explicit-Memory-Management-functionality-non-exclusion-configuration-file-(jvm.exmemnotexcludeclass.File) | Y | -- | Y | C | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix A.6 Cosminexus Performance Tracer

The following table describes the logs to be collected in relation to Cosminexus Performance Tracer.

Table A-13 Collection target related to Cosminexus Performance Tracer (In Windows)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | PRF daemon and PRF command log | PRF-spool-directory-(prfspool)/log/PRF-identifier/ctmlog* | Y | -- | -- | A | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-14 Collection target related to Cosminexus Performance Tracer (In UNIX)

Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | PRF daemon and PRF command log | PRF-spool-directory-(prfspool)/log/PRF-identifier/ctmlog* | Y | -- | -- | A | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.7 Cosminexus Web Services - Security

The following table describes the logs to be collected in relation to a Cosminexus Web Services - Security.

Table A-15 Collection target related to Cosminexus Web Services - Security (In Windows)

Category | Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Cosminexus Web Services - Security | Message log | Command trace, client trace | EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/WS/*.log | Y | -- | -- | C | C
Server trace, client trace | J2EE-server-log-output-directory-(ejb.server.log.directory)/WS/*.log | Y | -- | -- | A | C
Web-container-server-log-output-directory (web.server.log.directory)/WS/*.log | Y | -- | -- | C | C
Definition information | Environment setup file | Installation-directory-of-Cosminexus/wss/conf/cwsscfg.properties | Y | -- | Y | Y | Y
Client deploy definition | Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/classes/client-config.xml | Y | -- | Y | Y | Y
Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/client-config.xml | Y | -- | Y | Y | Y
Policy definition file | Cosminexus-installation-directory/CC/server/public/web/server-name/context-root/WEB-INF/classes/policy-config.xml | Y | -- | Y | Y | Y
Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/policy-config.xml | Y | -- | Y | Y | Y
Function definition file | Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/classes/security-config.xml | Y | -- | Y | Y | Y
Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/security-config.xml | Y | -- | Y | Y | Y
Cosminexus XML Security - Core | Maintenance log | Trace maintenance information such as method invocation | XML- Security - Core -Trace-output-directory (com.cosminexus.xml.security.logging.trace_dir)/*.log | Y | -- | -- | C | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-16 Collection target related to Cosminexus Web Services - Security (In UNIX)

Category | Type of data | File to be collected | Collection Target | Data | How to collect
Primary | Secondary | Definition | A | B
Cosminexus Web Services - Security | Message log | Command trace, client trace | EJB-client-log-output-directory-(ejbserver.client.log.directory)/subdirectory-1-(ejbserver.client.ejb.log)/subdirectory-2-(ejbserver.client.log.appid)/WS/*.log | Y | -- | -- | C | C
Server trace, client trace | J2EE-server-log-output-directory-(ejb.server.log.directory)/WS/*.log | Y | -- | -- | A | C
Web-container-server-log-output-directory (web.server.log.directory)/WS/*.log | Y | -- | -- | C | C
Cosminexus Web Services - Security | Definition information | Environment setup file | Installation-directory-of-Cosminexus/wss/conf/cwsscfg.properties | Y | -- | Y | Y | Y
Client deploy definition | Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/classes/client-config.xml | Y | -- | Y | Y | Y
Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/client-config.xml | Y | -- | Y | Y | Y
Cosminexus Web Services - Security | Definition information | Policy definition file | Installation-directory-of-Cosminexus/CC/server/public/web/server-name/context-root/WEB-INF/classes/policy-config.xml | Y | -- | Y | Y | Y
Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/policy-config.xml | Y | -- | Y | Y | Y
Function definition file | installation-directory/CC/server/public/web/server-name/context-root/WEB-INF/classes/security-config.xml | Y | -- | Y | Y | Y
Installation-directory-of-Cosminexus/CC/web/containers/server-name/webapps/context-root/WEB-INF/classes/security-config.xml | Y | -- | Y | Y | Y
Cosminexus XML Security - Core | Maintenance log | Trace maintenance information such as method invocation | XML-Security - Core-Trace-output-directory (com.cosminexus.xml.security.logging.trace_dir)/*.log | Y | -- | -- | C | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.8 Cosminexus HTTP Server

The following table describes the logs to be collected in relation to Cosminexus HTTP Server.

Table A-17 Collection target related to Cosminexus HTTP Server (In Windows)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Error log | HWS-error-log-directory-(HttpsdErrorLogFileDir)/error* | Y | -- | -- | A | C
Log set (for previous version compatibility) | Installation-directory-of-HWS/logs/* | Y | -- | -- | Y | Y
Other logs | Request log | HWS-request-log-directory-(HttpsdRequestLogFileDir)/hwsrequest* | -- | Y | -- | A | C
Process ID file | HWS process ID file (PidFile) | Y | -- | -- | C | C
Process log | Access log | HWS access log directory (HttpsdCustomLogFileDir)/access* | -- | Y | -- | A | C
Definition information | Definition file | Installation-directory-of-HWS/servers/HWS_server-name/conf/*.conf | Y | -- | Y | Y | Y
Definition file set (for previous compatibility) | Installation-directory-of-HWS/conf/*.conf | Y | -- | Y | Y | Y
Interface trace | Internal trace | HWS internal trace directory (HttpsdTraceLogFileDir)/hws.trc* | -- | Y | -- | A | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log.. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-18 Collection target related to Cosminexus HTTP Server (In UNIX)

Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Error log | HWS-error-log-directory-(HttpsdErrorLogFileDir)/error* | Y | -- | -- | A | C
Log set (for previous version compatibility) | Installation-directory-of-HWS/logs/* | Y | -- | -- | Y | Y
Other logs | Request log | HWS-request-log-directory-(HttpsdRequestLogFileDir)/hwsrequest* | -- | Y | -- | A | C
Process ID file | HWS-process-ID-file-(PidFile) | Y | -- | -- | C | C
Access log | Access log | HWS-access-log-directory-(HttpsdCustomLogFileDir)/access* | -- | Y | -- | A | C
Dump | core dump | HWS-core-dump-output-directory (CoreDumpDirectory)/core* | -- | Y | -- | A | C
gcache server core dump | Work-directory-of-HWS-cache-server (SSLCacheServerRunDir)/core* | -- | Y | -- | C | C
Definition information | Definition file | Installation-directory-of-HWS/servers/HWS_server-name/conf/*.conf | Y | -- | Y | Y | Y
Definition file set (for previous version compatibility) | Installation-directory-of-HWS/conf/*.conf | Y | -- | Y | Y | Y
Interface trace | Internal trace | HWS-internal-trace-directory (HttpsdTraceLogFileDir)/hws.trc* | -- | Y | -- | A | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.9 Microsoft Internet Information Service

The following table describes the logs to be collected related to the information of Microsoft Internet Information Service.

Table A-19 Collection target related to information of Microsoft Internet Information Service (In Windows)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Access log | IIS-access-log-directory-(IIS_log_dir)/* | -- | Y | -- | C | C

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.10 HCSC server

The following table describes the logs to be collected for the HCSC server information.

Table A-20 Logs to be collected for the HCSC server information (in Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Message log | HCSC-Manager log | HCSC-log-output-directory-(cscmng.log.dir)/* | Y | -- | -- | C | C
Access log | Request trace | HCSC-server-property-(requesttrace-filepath)/* | Y | -- | -- | C | C
Maintenance log | Method trace | HCSC-server-property-(methodtrace-filepath)/* | Y | -- | -- | C | C
Definition information | HCSC server definition information | Application-Server-installation-directory/CSC/system/msg/* | Y | -- | Y | Y | Y
HCSC-Manager definition file | Application-Server-installation-directory/CSC/config/manager/* | Y | -- | Y | Y | Y
HCSC-Messaging definition file | Application-Server-installation-directory/CSC/config/msg/* | Y | -- | Y | Y | Y
Repository | HCSC-repository-root-(cscmng.repository.root)/** | Y | -- | -- | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Table A-21 Logs to be collected for the HCSC server information (in UNIX)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Message log | HCSC-Manager log | HCSC-log-output-directory-(cscmng.log.dir)/* | Y | -- | -- | C | C
Access log | Request trace | HCSC-server-property-(requesttrace-filepath)/* | Y | -- | -- | C | C
Maintenance log | Method trace | HCSC-server-property-(methodtrace-filepath)/* | Y | -- | -- | C | C
Definition information | HCSC server definition information | Application-Server-installation-directory/CSC/system/msg/* | Y | -- | Y | Y | Y
HCSC-Manager definition file | Application-Server-installation-directory/CSC/config/manager/* | Y | -- | Y | Y | Y
HCSC-Messaging definition file | Application-Server-installation-directory/CSC/config/msg/* | Y | -- | Y | Y | Y
Repository | HCSC-repository-root-(cscmng.repository.root)/** | Y | -- | -- | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

Y: Collected

--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix A.11 HCSC server (FTP receipt)

The following table describes the logs to be collected for the HCSC server (FTP receipt) information.

Table A-22 Logs to be collected for the HCSC server (FTP receipt) information (in Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Definition information | FTP receipt definition information | Application-Server-installation-directory/CSC/config/ftprecp/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Table A-23 Logs to be collected for the HCSC server (FTP receipt) information (in UNIX)

Type of data | File to be collected | Collection target | Data | Collection method
Primary | Secondary | Definition | A | B
Definition information | FTP receipt definition information | Application-Server-installation-directory/CSC/config/ftprecp/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

Y: Collected

--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix A.12 HCSC server (TP1 adapter)

The following table describes the logs to be collected related to HCSC server (TP1 adapter) information.

Table A-24 Collection target related to the information of HCSC server (TP1 adapter) (In Window)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/TP1ADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the TP1 adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/TP1/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-25 Collection target related to the information of HCSC server (TP1 adapter) (In UNIX)

Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/TP1ADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the TP1 adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/TP1/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.13 HCSC server (File adapter)

The following table describes the logs to be collected related to the information of HCSC server (file adapter).

Table A-26 Collection target related to the information of HCSC server (file adapter) (In Windows)

Type of data | File to be collected | Default Collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace set | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/FFADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the file adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/File/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-27 Collection target related to the information of HCSC server (file adapter) (In UNIX)

Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace set | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/FFADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the file adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/File/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.14 HCSC server (Object Access adapter)

The following table describes the logs to be collected related to the information of HCSC server (Object Access adapter).

Table A-28 Collection target related to the information of HCSC server (Object Access adapter) (In Windows)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace Set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/OAADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the OA adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/OA/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-29 Collection target related to the information of HCSC server (Object Access adapter) (In UNIX)

Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace Set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/OAADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the OA adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/OA/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.15 HCSC server (Message Queue adapter)

The following table describes the logs to be collected related to the functions of HCSC server (Message Queue adapter).

Table A-30 Collection target related to the information of HCSC server (Message Queue adapter) (In Windows)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace Set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/MQADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the MQ adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/MQ/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.`

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

15,15,30,8,8,8,8,8

Table A-31 Collection target related to the information of HCSC server (Message Queue adapter) (In UNIX)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | Trace set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/MQADP/maintenance/*/* | -- | Y | -- | A | A
Definition information | Definition information for the MQ adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/MQ/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.16 HCSC server (FTP adapter)

The following table describes the logs to be collected related to HCSC server (FTP adapter) information.

Table A-32 Collection target related to the information of HCSC server (FTP adapter) (In Window)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Communication trace | FTP adapter protocol trace | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/FTPADP/*/* | -- | Y | -- | A | C
Maintenance log | FTP adapter maintenance log | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/FTPADP/maintenance/*/* | -- | Y | -- | A | C
Message log | Trace set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/TP1ADP/maintenance/*/* | -- | Y | -- | C | C
Definition information | Definition information for the TP1 adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/TP1/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-33 Collection target related to the information of HCSC server (TP1 adapter) (In UNIX)

Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
Communication trace | FTP adapter protocol trace | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/FTPADP/*/* | -- | Y | -- | A | C
Maintenance log | FTP adapter maintenance log | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/FTPADP/maintenance/*/* | -- | Y | -- | A | C
Message log | Trace set | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/CSCADP/TP1ADP/maintenance/*/* | -- | Y | -- | C | C
Definition information | Definition information for the TP1 adapter | Installation-directory-of-Cosminexus/CSC/custom-adapter/TP1/config/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.17 HCSC server (file operation adapter)

The following table describes the logs to be collected for the HCSC server (file operation adapter) information.

Table A-34 Logs to be collected for the HCSC server (file operation adapter) information (in Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Maintenance log | Maintenance log for the file operation adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPFOP/maintenance/*/cscadpfopmnt_*.log | Y | -- | -- | A | C
Exception log | Exception log for the file operation adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPFOP/maintenance/*/cscadpfopexp_*.log | Y | -- | -- | A | C
Definition information | Definition information for the file operation adapter | Application-Server-installation-directory/CSC/config/adpfop/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Table A-35 Logs to be collected for the HCSC server (file operation adapter) information (in UNIX)

Type of data | File to be collected | Collection target | Data | Collection method
Primary | Secondary | Definition | A | B
Maintenance log | Maintenance log for the file operation adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPFOP/maintenance/*/cscadpfopmnt_*.log | Y | -- | -- | A | C
Exception log | Exception log for the file operation adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPFOP/maintenance/*/cscadpfopexp_*.log | Y | -- | -- | A | C
Definition information | Definition information for the file operation adapter | Application-Server-installation-directory/CSC/config/adpfop/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

Y: Collected

--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix A.18 HCSC server (FTP inbound adapter)

The following table describes the logs to be collected for the HCSC server (FTP inbound adapter) information.

Table A-36 Logs to be collected for the HCSC server (FTP inbound adapter) information (in Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Message log | Message log for the FTP inbound adapter | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/csc/inbound-adapter/ftp/resource-adapter-name/* | Y | -- | -- | A | A
Message log for the operation commands of the FTP inbound adapter | Application-Server-installation-directory/CSC/inbound-adapter/ftp/logs/resource-adapter-name/* | Y | -- | -- | Y | Y
Definition information | FTP inbound adapter definition file | Application-Server-installation-directory/CSC/inbound-adapter/ftp/config/resource-adapter-name/*.xml | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Table A-37 Logs to be collected for the HCSC server (FTP inbound adapter) information (in UNIX)

Type of data | File to be collected | Collection target | Data | Collection method
Primary | Secondary | Definition | A | B
Message log | Message log for the FTP inbound adapter | J2EE-server-working-directory-(ejb.public.directory)/ejb/server-name/logs/csc/inbound-adapter/ftp/resource-adapter-name/* | Y | -- | -- | A | A
Message log for the operation commands of the FTP inbound adapter | Application-Server-installation-directory/CSC/inbound-adapter/ftp/logs/resource-adapter-name/* | Y | -- | -- | Y | Y
Definition information | FTP inbound adapter definition file | Application-Server-installation-directory/CSC/inbound-adapter/ftp/config/resource-adapter-name/*.xml | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

Y: Collected

--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix A.19 HCSC server (mail adapter)

The following table describes the logs to be collected for the HCSC server (mail adapter) information.

Table A-38 Logs to be collected for the HCSC server (mail adapter) information (in Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Message log | Message log for the mail adapter operation commands | Message-log-output-directory-for-the-HCSC-mail-adapter-operation-commands-(mailadp.command.messagelog.filepath)/* | Y | -- | -- | C | C
Maintenance log | Maintenance log for the mail adapter | Maintenance-log-output-directory-for-the-HCSC-mail-adapter-(mailadp.methodtrace.filepath)/*/* | -- | Y | -- | A | C
Definition information | Definition information for the mail adapter | Application-Server-installation-directory/CSC/config/mail/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Table A-39 Logs to be collected for the HCSC server (mail adapter) information (in UNIX)

Type of data | File to be collected | Collection target | Data | Collection method
Primary | Secondary | Definition | A | B
Message log | Message log for the mail adapter operation commands | Message-log-output-directory-for-the-HCSC-mail-adapter-operation-commands-(mailadp.command.messagelog.filepath)/* | Y | -- | -- | C | C
Maintenance log | Maintenance log for the mail adapter | Maintenance-log-output-directory-for-the-HCSC-mail-adapter-(mailadp.methodtrace.filepath)/*/* | -- | Y | -- | A | C
Definition information | Definition information for the mail adapter | Application-Server-installation-directory/CSC/config/mail/* | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

Y: Collected

--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix A.20 HCSC server (HTTP adapter)

The following table describes the logs to be collected for the HCSC server (HTTP adapter) information.

Table A-40 Logs to be collected for the HCSC server (HTTP adapter) information (in Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Maintenance log | Maintenance log for the HTTP adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPHTTP/maintenance/*/cscadphttpmnt_*.log | -- | Y | -- | A | C
Exception log | Exception log for the HTTP adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPHTTP/maintenance/*/cscadphttpexp_*.log | Y | -- | -- | A | C
Definition information | Definition information for the HTTP adapter | Application-Server-installation-directory/CSC/custom-adapter/HTTP/config/** | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Table A-41 Logs to be collected for the HCSC server (HTTP adapter) information (in UNIX)

Type of data | File to be collected | Collection target | Data | Collection method
Primary | Secondary | Definition | A | B
Maintenance log | Maintenance log for the HTTP adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPHTTP/maintenance/*/cscadphttpmnt_*.log | -- | Y | -- | A | C
Exception log | Exception log for the HTTP adapter | J2EE-server-log-output-directory-(ejb.server.log.directory)/CSCADP/ADPHTTP/maintenance/*/cscadphttpexp_*.log | Y | -- | -- | A | C
Definition information | Definition information for the HTTP adapter | Application-Server-installation-directory/CSC/custom-adapter/HTTP/config/** | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

Y: Collected

--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix A.21 Audit log

The following table describes the logs to be collected in relation to audit log information.

Table A-42 Collection target related to audit log information (In Windows)

Category | Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
None | Message log | Message log audit log | Audit-log-message-output-directory(auditlog.raslog.message.directory)/rasmessage*.log | Y | -- | -- | C | C
Other logs | Audit log | Audit-log-output-directory (auditlog.directory)/* | -- | Y | -- | C | C
Audit log exception information | Audit-log-exception-output-directory(auditlog.raslog.exception.directory)/rasexception*.log | Y | -- | -- | C | C
Maintenance log | Other logs | Audit-log-message-output-directory(auditlog.raslog.message.directory)/*/* | Y | -- | -- | C | C
Audit-log-exception-output-directory(auditlog.raslog.exception.directory)/*/* | Y | -- | -- | C | C
Definition information | Audit log definition file | Cosminexus-installation-directory/common/conf/auditlog.properties | Y | -- | Y | C | C
Naming service | Others | Log showing naming service start, stop or abnormal termination | Windows-event-log(EventLog) | Y | -- | -- | D | D
Dump | Thread dump | Cosminexus-installation-directory/TPB/logj/javacore* | Y | -- | -- | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Table A-43 Collection target related to audit log information (In UNIX)

Category | Type of data | File to be collected | Collection target | Data | How to collect
Primary | Secondary | Definition | A | B
None | Message log | Message log of audit log | Audit-log-message-output-directory (auditlog.raslog.message.directory)/rasmessage*.log | Y | -- | -- | C | C
Other logs | Audit log | Audit-log-output-directory (auditlog.directory)/* | -- | Y | -- | C | C
Audit log exception information | Audit-log-exception-output-directory (auditlog.raslog.exception.directory)/rasexception*.log | Y | -- | -- | C | C
Maintenance log | Other logs | Audit-log-message-output-directory (auditlog.raslog.message.directory)/*/* | Y | -- | -- | C | C
Audit-log-exception-output-directory (auditlog.raslog.exception.directory)/*/* | Y | -- | -- | C | C
Definition information | Audit log definition file | Cosminexus-installation-directory/common/conf/auditlog.properties | Y | -- | Y | C | C
Naming service | Others | Log showing naming service start, stop or abnormal termination | < syslog(syslog of UNIX)> | Y | -- | -- | C | C
Dump | Thread dump | Cosminexus-installation-directory/TPB/logj/javacore* | Y | -- | -- | Y | Y
core dump | Cosminexus-installation-directory/TPB/logj/core* | -- | Y | -- | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1 (4) Rules for the coding to be collected.

Appendix A.22 Other information

The following table describes the logs to be collected in relation to other information.

Table A-44 Logs to be collected for the other information (in Windows)

Type of data | File to be collected | Default collection destination | Data | Collection method
Primary | Secondary | Definition | A | B
Message log | cosmienv command log | Application-Server-installation-directory/env/log/* | Y | -- | -- | Y | Y
Definition information | Host definition file (for Windows) | System-root-directory-(systemroot)/system32/drivers/etc/hosts | Y | -- | Y | Y | Y
Other | Program product information | /etc/.hitachi/pplistd/pplistd | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For the collection methods
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details on the collection method A and collection method B, see Appendix A.1(2) Method of collecting snapshot log. For the meanings of the directories and files to be collected and described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Table A-45 Collection target related to other information (In UNIX)

Type of data | File to be collected | Default collection destination | Data | How to collect
Primary | Secondary | Definition | A | B
Message log | cosmienv command log | Cosminexus-installation-directory/env/log/* | Y | -- | -- | Y | Y
Definition information | Host Definition log (for UNIX) | /etc/hosts | Y | -- | Y | Y | Y
Others | Program product information | /etc/.hitachi/pplistd/pplistd | Y | -- | Y | Y | Y

Legend:

Primary: Primary delivery data

Secondary: Secondary delivery data

Definition: Definition sending data

A: mngsvrutil collect snapshot command

B: snapshotlog command

For data
Y: Collected
--: Not collected

For methods of collection
See Appendix A.1(3) Availability of snapshot log collection and changes in settings related to collection.

Note: For details about collection method A and collection method B, see Appendix A.1 (2) Method of collecting snapshot log. For details about the file significance and directory to be collected described in the table, see Appendix A.1(4) Rules for the coding to be collected.

Appendix B. Identifying the Connection in which an Error Has Occurred When Connecting to a Database

To handle a database-related error, it is important to identify the connection used to connect to the database.

This section describes how to identify a connection in which trouble occurred while connecting to the database (HiRDB or Oracle) using the information output from the applications server (trace based performance analysis and logs) and information output from the database (trace information and execution results of the pdls command, and contents of dynamic performance view).

With the application server, the connection information (connection ID) for unique identification of the connection you use in connecting to HiRDB and Oracle is output to a trace based performance analysis. In a series of processing from the J2EE server to the database, and until the processing results are returned from the database to the J2EE server, a connection ID and a connect serial number assigned by the database server are output to the log and trace information of the related configuration software. By comparing and checking this information, you can identify the connection in which an error has occurred.

An overview of output of connection IDs when you use HiRDB, and when you use Oracle, and the information used to identify the connection where an error has occurred is described below:

When you use HiRDB
An overview of output of connection IDs is described below:

Figure B-1 Output overview of connection ID (In HiRDB)

The following table describes the information used to identify the connection where an error has occurred.

Table B-1 Information used to identify the connection where an error has occurred (in HiRDB)

No. | Output source | Information type | Reference
1 | Component Container | Trace based performance analysis file | Appendix B.1
2 | Exception message when SQLException occurs
3 | DABroker Library | Extended database access trace | Appendix B.2
4 | HiRDB client | SQL trace file | Appendix B.3
5 | Error log information
6 | Reconnection trace
7 | HiRDB server | Execution results of the pdls command | Appendix B.4

The connection ID includes the following information:

server-name
The front-end server name (when using HiRDB or a Parallel Server) or single server name (when using HiRDB or a Single Server) is displayed.

connect-serial-number
A connect serial number assigned by the HiRDB server that is displayed in server name is displayed.

server-process-ID
The process ID of the HiRDB server that is displayed in the server name is displayed.

The output format and an output example of a connection ID is described below:

Output format of a connection ID (In HiRDB)

server-name: connect-serial-number: server-process-ID

Output example of a connection ID (In HiRDB)

fes01:15:2351

Reference note

During the processing of a global transaction, if a connection gets broken due to an error, the connection is automatically re-established. This reconnection is, however, not output to the reconnection trace. In such a case, a discrepancy occurs in the connection ID output to the reconnection trace and the actual connection information. Basically, however, a connection does not get broken while processing a global transaction.

When you use Oracle
An overview of output of connection IDs is described below:

Figure B-2 Output overview of Connection ID (In Oracle)

The following table describes the information used to identify the connection where an error has occurred.

Table B-2 Information used to identify the connection where an error has occurred (In Oracle)

No. | Output source | Information type | Reference
1 | Component Container | Trace based performance analysis file | B.1
2 | Exception message when SQLException occurs
3 | DABroker Library | Extended database access trace | B.2
4 | Oracle client | Net client trace | B.5
5 | Oracle server | Alert file | B.6
6 | User trace
7 | Net server trace
8 | Dynamic performance view

The connection ID includes the following information:

instance-name
The instance name of the Oracle server is displayed.

session-ID
The session ID assigned by the Oracle server is displayed.

session-serial-number
The session serial number assigned by the Oracle server is displayed.

OS-process-ID
The OS process ID is displayed.

Output format of a connection ID (In Oracle)

instance-name: session-ID: session-serial-number: OS-process-name

Output example of a connection ID (In Oracle)

ORCL:17:5:920

The dynamic performance view of Oracle is used to generate the connection ID, therefore, a user connecting to Oracle must have permission to view the dynamic performance view. Use either of the following methods to grant viewing permission to a user connecting to Oracle:

Execute GRANT SELECT_CATALOG_ROLE TO user-name;.

Execute GRANT SELECT ON V_$INSTANCE TO user-name;, GRANT SELECT ON V_$PROCESS TO user-name;, and GRANT SELECT ON V_$SESSION TO user-name;.

Also, when using Oracle, if you set true in the value of the property item ConnectionIDUpdate, in property definitions of a DB Connector, you can generate a connection ID when acquiring connection. However, the SQL for generating connection ID is issued when you acquire a connection, as a result, the performance may be affected. Set false in an environment where you do not wish to perform a reconnection. For details about how to set property definitions of a DB Connector, see 4.2.2 Property definition of DB Connector in the uCosminexus Application Server Application Setup Guide.

Note

When you use transparent application failover of Oracle, the connection ID output to the PRF trace and the actual connection ID may be different. This is because the connection is re-established in Oracle. When the connection ID output to the PRF trace and the actual connection ID are different, you cannot track the trace information of Oracle with the connection ID.

Organization of this section

B.1 Cosminexus Component Container

B.2 Cosminexus DABroker Library

B.3 HiRDB Client

B.4 HiRDB Server

B.5 Oracle Client

B.6 Oracle Server

Appendix B.1 Cosminexus Component Container

The output destination of connection IDs output from Cosminexus Component Container differs depending on the status of transaction processing (normal or abnormal).

In the case of normal processing

Output to a trace based performance analysis file.

In the case of abnormal processing

Output in an exception message when SQLException occurs.

In the trace based performance analysis file, connection IDs are output at the following three timings:

When you acquire a connection to the database
When using HiRDB, output the connection ID of the acquired connection immediately before the DataSource.getConnection() method or DataSource.getConnection(String username, String password) method terminates.
When using Oracle, output the connection ID of the acquired connection immediately before the DataSource.getConnection() method terminates.

When you release the database connection
Immediately after starting the Connection.close() method, output the connection ID of the connection acquired with the getConnection method that corresponds to the Connection.close() method.

When you replace a connection to the database with the association function
When you invoke the ManagedConnection.associateConnection() method, the connection ID of the destination connection is output when you replace with the association function.

The connection IDs acquired at the above timings are output to the interface name of the trace information of event IDs described in the following table.

Table B-3 Trace based performance analysis where connection IDs are output

Event ID | Description
0x8C01 | Information output during the processing immediately before the termination of the DataSource.getConnection() method.
0x8C03 | Information output during the processing immediately before the termination of the DataSource.getConnection(String username, String password) method.
0x8C20 | Information output during the processing immediately after starting the Connection.close() method.
0x8C40 | Information output during the invocation of the ManagedConnection.associateConnection() method.

For details about trace collection points and the trace information that you can acquire, see 8.14 Trace collection points of a DB Connector and JCA container.

How to acquire a trace based performance analysis, the exception message when SQLException occurs, and their output format is described below:

Organization of this subsection

(1) Trace based performance analysis file

(2) Exception message when SQLException occurs

(1) Trace based performance analysis file

This is a file that edits and outputs trace information, that is output during a series of processing of requests from the client to an EIS such as databases and until the processing results are returned to the client, to a PRF trace file. The trace information is output in CSV format.

Conditions for output of a connection ID

If all the below-mentioned conditions are fulfilled, the connection ID is output to a trace based performance analysis file:

The database used is either of the following:
HiRDB 07-01 or later version
Oracle9i
Oracle 10g
Oracle 11g

Logical performance tracer is starting

A DB Connector is used as the resource adapter.

(a) Points to be noted

The points to be noted when you view a trace based performance analysis are described below:

Points to be noted for releasing a connection
When you invoke the Connection.close() method multiple times for the same connection, the trace based performance analysis is output only for that many number of times.

Points to be noted when you use the association functionality
When you replace a connection to the database with the association functionality, the connection to the database is established with a physical connection different from the connection ID output with the getConnection() method. In such a case, when you invoke the ManagedConnection.associateConnection() method, the connection ID corresponding to the destination physical connection when you replace with the association functionality, is output to a trace based performance analysis. As a result, to identify the connection ID that is actually connected to the database, you need to track even the connection ID output to a trace based performance analysis with the event ID 0x8C40.
Note that the connection may not be replaced even if you invoke the ManagedConnection.associateConnection() method. In such a case, the connection ID is not output to a trace based performance analysis.

Reference note

The association functionality replaces normal 1:1 correspondence between a logical connection and a physical connection by sharing one physical connection among multiple logical connections.

Points to be noted when you use the automatic reconnection function
When you use the automatic reconnection function of HiRDB, the connection ID output to a trace based performance analysis and the connection ID of the actual connection may be different. In such a case, you also need to reference the reconnection trace of the HiRDB client.

(b) How to acquire

Acquire the trace based performance analysis file by executing the management command (mngsvrutil). The trace based performance analysis file is output to Manager-log-output-directory\prf (in Windows), or to Manager-log-output-directory/prf (in UNIX). For details about how to acquire a trace based performance analysis file, see 7.3.1 How to collect a trace based performance analysis file.

(c) Output format

An output example of a trace based performance analysis is described below. The connection ID is output in the interface name (INT column).

Figure B-3 Trace based performance analysis output example

(2) Exception message when SQLException occurs

This is a message that indicates that SQLException is thrown as an exception, when an error occurs in the database access, Cosminexus DABroker Library, or JDBC driver.

Conditions for output of a connection ID

If the database in use is either of the following, the connection ID is output in the exception message when SQLException occurs:

HiRDB 07-01 or later version

Oracle9i

Oracle 10g

Oracle 11g

(a) Points to be noted

The points to be noted when you view the exception message when SQLException occurs, are described below:

Points to be noted for the output connection ID
The latest connection ID is always output to the exception message when SQLException occurs. When reconnected by the automatic reconnecting functionality of HiRDB, the connection ID after being reconnected is output.

(b) How to acquire

An exception message is output to the following log files when SQLException occurs:

In Windows

working-directory\ejb\server-name\logs\cjexception[n].log

working-directory\ejb\server-name\logs\connectors\display-name-of-resource-adapter[n].log

In UNIX

working-directory/ejb/server-name/logs/cjexception[n].log

working-directory/ejb/server-name/logs/connectors/display-name-of-resource-adapter[n].log

In the part of log file name [n], the file number (From 1 to the total number of files (maximum 16)) is added.

(c) Output format

HiRDB

The connection ID is output at the end of ErrMsg of the message KFDJ00001-E. The example of output is described below. The characters in bold indicate the connection ID.

JP.co.Hitachi.soft.DBPSV_Driver.SQLException: KFDJ00001-E Error occurred at server.
[JdbcDbpsvResultSQLExecute.SQLExecute]
OperationType : 2002
ReturnCode  : -100
ErrorCode   : -404
WarningInfo  : 0
ErrorMsg  : KFPA11404-E Input data too long for column or assignment target in variable 1 [HiRDB_CONNECTION_ID(sds01:7:2988)]

In the case of Oracle

The connection ID is output at the end of ErrMsg of the message ORA-00942. The example of output is described below. The characters in bold indicate the connection ID.

JP.co.Hitachi.soft.DBPSV_Driver.SQLException: KFDJ00001-E Error occurred at server.
[JdbcDbpsvResultSQLExecute.SQLPrepare]
OperationType : 2002
ReturnCode  : -200
ErrorCode   : 942
WarningInfo  : 0
ErrorMsg   : ORA-00942: Table or view does not exist. [ORACLE_CONNECTION_ID(ORCL:17:5:920)]
PreparedSQL  : selectSectionID   : 2

Appendix B.2 Cosminexus DABroker Library

In Cosminexus DABroker Library, the connection ID is output to extended database access trace.

This section describes the how to acquire the extended database access trace and output format of the trace.

Organization of this subsection

(1) Extended database access trace

(1) Extended database access trace

The Extended database access trace is a trace that outputs the access information from the time of database connection until disconnection. The extended database access trace is output each time a connection is established with the database.

The following conditions must be satisfied to output the connection ID to the extended database access trace:

Conditions for output of the connection ID (In HiRDB)

The version of HiRDB client must be 07-01 or later.

0 or a higher value must be specified in DABEXSQL_TRC_LINE of the Cosminexus DABroker Library operation environment definition file.

For details about setting the operation environment of Cosminexus DABroker Library in Windows, see 4.3.1(3) Setting the operation environment of Cosminexus DABroker Library (in Windows) in the uCosminexus Application Server Compatibility Guide, and for UNIX, see 4.3.2(4) Setting the operation environment of Cosminexus DABroker Library (in UNIX) in the uCosminexus Application Server Compatibility Guide. For details about the Cosminexus DABroker Library operation environment definition file, see 4.22 Cosminexus DABroker Library operation environment definition file in the uCosminexus Application Server Compatibility Guide.

Conditions for output of the connection ID (In Oracle)

You must be using Oracle9i or Oracle10g.

-1, 0, or a value in the range of 1024 to 32767 must be specified in DABEXSQL_TRC_LINE E of the Cosminexus DABroker Library operation environment definition file.

In Windows, use the environment settings utility to set the Cosminexus DABroker Library operation environment definition file. For details about setting the operation environment of Cosminexus DABroker Library using the environment settings utility in Windows, see 4.3.1(3) Setting the operation environment of Cosminexus DABroker Library (in Windows) in the uCosminexus Application Server Compatibility Guide, and for UNIX, see 4.3.2(4) Setting the operation environment of Cosminexus DABroker Library (in UNIX) in the uCosminexus Application Server Compatibility Guide. For details about the Cosminexus DABroker Library operation environment definition file, see 4.22 Cosminexus DABroker Library operation environment definition file in the uCosminexus Application Server Compatibility Guide.

(a) How to acquire

The storage location of extended database access trace is as follows:

In Windows
Files under the Cosminexus-DABroker-Library-operation-directory\spool\db_access directory

In UNIX
Files under the /opt/DABroker/spool/db_access directory

(b) Output format

The output format of extended database access trace is as follows:

For details about the output format of extended database access trace, see 4.6.3(2) Extended database access trace in the uCosminexus Application Server Compatibility Guide.

In HiRDB

The connection ID is output to the HiRDB_CONNECTION_ID column.

In Windows

*-------------------------------------------------------*
*- DataBase Access Information (DRV)           -*
*- Date YYYY/MM/DD hh:mm:ss.nnnnnn              -*
*-------------------------------------------------------*
DABroker Connect ID  : AAAA(BBBBB)
Process ID       : CCCCC
UserID         : DDDD
Client Name      : EEEEE
(information-output-for-each-DB)
Lang Mode       : GGGGG

THREAD-ID CID  EVT  START-TIME  END-TIME  RETCODE BLOCKCNT (Windows QueryPerformance Counter) HiRDB_CONNECTION_ID
(trace-information)
(SQL)SS...SS
(trace-information)

In UNIX

*-------------------------------------------------------*
*- DataBase Access Information (DRV)           -*
*- Date YYYY/MM/DD hh:mm:ss.nnnnnn            -*
*-------------------------------------------------------*
DABroker Connect ID  : AAAAA(BBBBB)
Process ID       : CCCCC
UserID         : DDDDD
Client Name      : EEEEE
(information-output-for-each-DB)
Lang Mode       : GGGGG

THREAD-ID CID  EVT  START-TIME  END-TIME  RETCODE
BLOCKCNT  HiRDB_CONNECTION_ID
(trace-information)
(SQL)SS...SS
(trace-information)

In Oracle

The connection ID is output to the ORACLE_CONNECTION_ID column.

*--------------------------------------------------------------------------*
*- DataBase Access Information (ORACLE8i Driver)              -*
*- Date YYYY/MM/DD hh:mm:ss.nnnnnn                    -*
*--------------------------------------------------------------------------*
DABroker Connect ID  : AAAAAAAA(BBBBB)
Process ID       : CCCC
UserID         : DDDDDD
Client Name      : EEEEEE
SQLNET         : FFFFFF
Lang Mode       : GGGG
*--------------------------------------------------------------------------*
THREAD-ID  CID EVT     START-TIME          END-TIME            RETCODE  BLOCKCNT ORACLE_CONNECTION_ID
(trace-information)
(SQL)SS...SS
(trace-information)

Appendix B.3 HiRDB Client

In a HiRDB client, information such as the connection ID and connect serial number is output to the SQL trace file, error log file, and reconnection trace file.

How to acquire the SQL trace file, error log file, and reconnection trace file, and the output format of each one is described below:

Organization of this subsection

(1) SQL trace file

(2) Error log file

(3) Reconnection trace file

(1) SQL trace file

This is a trace file that outputs the SQL trace information of an executed UAP. This trace file is output when the execution of an SQL terminates.

If an SQL error occurs while you are executing a UAP, you can identify the SQL responsible for the error by referencing the SQL trace file.

Conditions for output of a connection ID

If the below-mentioned condition is fulfilled, the connection ID is output to the SQL trace file:

A value is specified in the client environment definitions PDCLTPATH and PDSQLTRACE.

For details about how to set client environment definitions, see the HIRDB UAP Development Guide.

(a) How to acquire

The SQL trace file is stored in the directory specified in the client environment definition PDCLTPATH.

(b) Output format

The server name, connect serial number, and server process ID are output in the format are as follows:

(Omitted)
...
CONNECTION STATUS:
CURHOST(connection destination host name) CURPORT(connect port number) SRVNAME(server name)
CNCTNO(connect serial number) SVRPID(server process ID) CLTPID (UAP process ID) CLTTID (UAP thread serial number)
...
(Omitted)

The SQL statement, SQL execution time, and values set in the variables within the SQL statement are also output to the SQL trace file. For details about the output format, see the HIRDB UAP Development Guide.

(2) Error log file

This is a log file that outputs the error information when an error occurs during the communication between a client and HiRDB server, or in the XA interface defined in X/Open. This log file is output when an error occurs during the execution of an SQL, communication processing, or execution of XA interface functions defined in X/Open.

Conditions for output of a connection ID

If the below-mentioned condition is fulfilled, the connection ID is output to the error log file:

A value is specified in the client environment definitions PDCLTPATH and PDUAPERLOG.

For details about how to set, see the HIRDB UAP Development Guide.

(a) How to acquire

The SQL trace file is stored in the directory specified in the client environment definition PDCLTPATH.

(b) Output format

The server process ID is output to the SQL trace in the format described below:

Error-log-identifier (>> or >) UAP-process-ID UAP-thread-serial-number Server-process-ID Error-log-counter (Rest omitted)

For details about the output format, see the HIRDB UAP Development Guide.

In addition to the connection information, the time of acquiring the error, SQLCODE, and SQL operation code where an error occurred is output to the error log information.

(3) Reconnection trace file

When you reconnect with the automatic reconnection function of HiRDB client, then this trace file outputs the value of the connection handle, connection information before reconnection, connection information after reconnection, and the time of reconnection that HiRDB manages internally. This trace file is output when a connection is executed automatically with the automatic reconnection function.

Conditions for output of a connection ID

If the below-mentioned conditions are fulfilled, the connection ID is output to the reconnection trace file:

A value is specified in the client environment definitions PDCLTPATH and PDSQLTRACE.

The automatic reconnection function of HiRDB is used.

For details about how to set up, see the HIRDB UAP Development Guide.

(a) How to acquire

The reconnection trace file is stored in the directory specified in the client environment definition PDCLTPATH. The stored file names are pdrcnct1.trc and pdrcnct2.trc.

(b) Output format

The reconnection trace is output in the format described below:

Connection-handle-value Reconnection-result(S or F) Reconnection-start-date-and-time -
Reconnection-end-date-and-time Connection-information-before-reconnection => Connection-information-after-reconnection

The connection ID is output as the connection information after reconnection.

For details about the output format, see the HIRDB UAP Development Guide.

An output example of the reconnection trace file is described below. The characters in bold indicate the connection ID.

40004250​ S 2004/04/12 11:10:36.766 - 2004/04/12 11:10:41.846 sds:9:23763 => sds:10:23750
40004250​ S 2004/04/12 11:11:07.491 - 2004/04/12 11:11:12.547 sds:10:23750 => sds:11:23765
40004850​ F 2004/04/12 11:17:58.285 - 2004/04/12 11:18:23.395 sds:14:23751 =>
40005050​ S 2004/04/12 11:27:35.098 - 2004/04/12 11:27:40.152 sds:1:24414 => sds:2:24418

Appendix B.4 HiRDB Server

In HiRDB server, check the server status by referencing the results of executing the pdls command.

Check the status of the connected HiRDB server by comparing the server name and server process ID displayed in the pdls command execution results with the information included in the connection ID.

The execution format of pdls command and the output format of the execution results are described below:

Organization of this subsection

(1) Execution results of the pdls command

(1) Execution results of the pdls command

This is a command that enables the display of exclusive control status, process status, and communication control information of a HiRDB server.

(a) Execution format

Execute the following pdls commands, and check the server status.

To display the exclusive control status of the server

pdls -d lck

To display the server process status

pdls -d prc

To display the server communication control information

pdls -d rpc

For details about the pdls command, see the HiRDB Command Reference.

(b) Output format

The server name is output to the SVID column, while the server process ID is output to the PID column of the execution results.

For details about the output format, see the HiRDB Command Reference.

Appendix B.5 Oracle Client

In Oracle client, the details of the executed network events are output to the Net client trace file. The OS client process ID of the client is included in the file name of the Net client trace file.

A Net client trace file is output to the following locations:

In Windows
location-specified-by-sqlnet.ora-file#\CLI_OS-client-process-ID.trc

In UNIX
location-specified-by-sqlnet.ora-file#/CLI_OS-client-process-ID.trc

# The output destination of the Net client trace file is set with the Oracle sqlnet.ora file. The coding format of the sqlnet.ora file is described below. For details about the sqlnet.ora file, see the documentation on Oracle.

TRACE_LEVEL_CLIENT=16
TRACE_DIRECTORY_CLIENT=directory-name
TRACE_UNIQUE_CLIENT=ON
TRACE_TIMESTAMP_CLIENT=ON

To reference a Net client trace file, you need to specify the desired Net client trace file from the output Net client trace files. To specify the desired Net client trace file:

Execute the following SQL, and acquire the OS client process ID.

SELECT PROCESS FROM V$SESSION WHERE (SID = session-ID) AND (SERIAL# = session-serial-number);

Compare the acquired OS client process ID and the OS client process ID included in the file name of the Net client trace file, and specify the desired Net client trace file.

For details about the output contents of the Net client trace file, see the documentation on Oracle.

Note

The Net client trace consumes a large amount of disk space, as a result, it may lead to a decline in the system performance. Reference the Net client trace only when required.

Appendix B.6 Oracle Server

How to output the error information of the Oracle server, and the server status, in an Oracle server are described below:

Acquiring alert files

Acquiring user traces

Acquiring Net server trace files

Using dynamic performance view

Organization of this subsection

(1) Alert file

(2) User trace

(3) Net server trace file

(4) Dynamic performance view

(1) Alert file

In an alert file, you can confirm the following information with an instance name of a trace based performance analysis as the key.

All internal errors, block corruption errors, and dead lock errors that have occurred

Management and operation of CREATE, ALTER, or DROP statements, STARTUP or SHUTDOWN statements, and ARCHIVELOG statement

Messages and errors related to the shared server and dispatcher process functionality

Errors that occurred during automatic refresh of the dataized view

Values of all initialization parameters during invocation of a database and instances

Alert files are output to the following locations:

In Windows
location-specified-with-BACKGROUND_DUMP_DEST#\ALERT_instance-name.LOG

In UNIX
location-specified-with-BACKGROUND_DUMP_DEST#/ALERT_instance-name.LOG

# Set with the initialization parameter USER_DUMP_DEST of Oracle. For details about USER_DUMP_DEST, see the documentation on Oracle.

Of the output alert files, specify the desired alert file by comparing the instance name output to a trace based performance analysis, and the instance name included in the alert file name.

(2) User trace

In the user trace, you can check the following information with an instance name of a trace based performance analysis, OS process ID, session ID, and session serial number as the key:

Information of error that occurred in a server process

Execution plan and the statistics of an SQL

(3) Net server trace file

In Oracle server, the details of the executed network events are output to a Net server trace file. The OS process ID of the server is included in the file name of the Net server trace file.

Net server trace files are output to the following locations:

In Windows
location-specified-by-sqlnet.ora-file#\CLI_OS-process-ID.TRC

In UNIX
location-specified-by-sqlnet.ora-file#/CLI_OS-process-ID.TRC

# The output destination of the Net server trace file is set with the Oracle sqlnet.ora file. The coding format of the sqlnet.ora file is described below. For details about the sqlnet.ora file, see the documentation on Oracle.

TRACE_LEVEL_CLIENT=16
TRACE_DIRECTORY_CLIENT=directory-name
TRACE_UNIQUE_CLIENT=ON
TRACE_TIMESTAMP_CLIENT=ON

Of the output Net server trace files, specify the desired Net server trace file by comparing the OS process ID of a trace based performance analysis and the OS process ID name included in the Net server trace file name.

For details about the output contents of the Net server trace file, see the documentation on Oracle.

Note

The Net server trace file consumes a large amount of disk space, as a result, it may lead to a decline in the system performance. Reference the Net client trace only when required.

(4) Dynamic performance view

You can reference the details of a process by studying the dynamic performance view or identifying a session. Study the dynamic performance view by comparing it with the connection IDs output to trace based performance analysis files.

The following table describes the relationship between the connection IDs of the dynamic performance view and trace based performance analysis.

Table B-4 Relationship between the connection IDs of dynamic performance view and trace based performance analysis

Item No. | Item displayed in the dynamic performance view | Connection ID item of trace based performance analysis
1 | V$INSTANCE INSTANCE_NAME | instance-name
2 | V$SESSION SID | session-ID
3 | V$SESSION SERIAL# | session-serial-number
4 | V$PROCESS SPID | OS-process-ID

For details about the dynamic performance view, see the documentation on Oracle.

Appendix C. Log Information Output for Each Functionality

This section describes the log information output when you use a specific functionality.

The log information output when you use the following functionality is described below:

Cosminexus JPA provider operation log

Organization of this section

C.1 Cosminexus JPA Provider operation log

Appendix C.1 Cosminexus JPA Provider operation log

This appendix describes the operation log messages that are output by Cosminexus JPA Provider for each category of the log output

Organization of this subsection

(1) When category is SQL

(2) When category is TRANSACTION

(1) When category is SQL

SQL [aa....aa] SQL = bb....bb

aa....aa: Persistence unit name
bb....bb: Issued SQL statement

Description

JPA issues SQL.

SQL [aa....aa] PARAM = bb....bb

aa....aa: Persistence unit name
bb....bb: Set value of ? parameter (place holder)

Description

Sets the value in ? parameter (place holder) of the SQL statement.

Result where the value set to ? parameter (place holder) is converted into a character expression is output in bb....bb. For the character or numeral value the result is output as it is. However, for example, when the binary data is stored in the byte type array of java, the toString method is executed for the byte type array the output is B@f7ba93

SQL [aa....aa] RETURN = bb....bb

aa....aa: Persistence unit name
bb....bb: Return value

Description

Return value of PreparedStatement#executeUpdate(). The return value is the number of lines when the SQL statement is executed. For details, see java.sql.PreparedStatement of Javadoc.

(2) When category is TRANSACTION

TRN [aa....aa] JPA processing was bound to a JTA transaction. (status = bb....bb)

aa....aa: Persistence unit name
bb....bb: Transaction state when bound to JTA transaction

Description

JTA transaction is bounded. Outputs the character string that indicates the transaction state (status). For details about the character string that indicates the status, see javax.transaction.Status of Javadoc.

TRN [aa....aa] A JTA transaction was committed. (status = bb....bb)

aa....aa: Persistence unit name
bb....bb: Transaction state when JTA transaction is concluded

Description

The conclusion of JTA transaction is notified. Outputs the character string that indicates the state (status) where the transaction passed from JTA is concluded. For details about the character string indicating the status, see javax.transaction.Status of Javadoc.

TRN [aa....aa] An EntityTransaction started.

aa....aa: Persistence unit name

Description

EntityTransaction is started.

TRN [aa....aa] An EntityTransaction was committed.

aa....aa: Persistence unit name

Description

EntityTransaction is committed.

TRN [aa....aa] An EntityTransaction was rolled back.

aa....aa: Persistence unit name

Description

EntityTransaction is rolled back.

Appendix D. Recovering Tables for a CMR When an Error Occurs

This section describes how to recover tables for a CMR that you were using before the occurrence of a failure in a J2EE server, after you deploy an application containing a CMR. For details about the table for CMR, see 9.6.3 Database mapping with CMP2.x in the uCosminexus Application Server Application Setup Guide. When you deploy an application containing CMR, and a failure occurs while you start or terminate a J2EE server in a running state for the purpose of maintenance, the application containing the CMR does not start in the state in which you deployed it. If you resolve the error and make an attempt to deploy the application containing a CMR, you cannot deploy if a table with the same name that you want to create already exists in the database (to prevent sharing of tables between applications).

Here, if you regenerate the SQL, an SQL using new table names for a CMR will be generated, and you can deploy the application to enable the use of tables for a new CMR. If, however, you want to use the same relationship that you were using before terminating the J2EE server, you need to deploy in such a way so as to enable the use of tables remaining in the database.

You can specify the table in ejbserver.ejb.cmp20.cmr.use.existing_table parameter in <configuration> tag of the logical J2EE server (j2ee-server) of the Easy Setup definition file. ejbserver.ejb.cmp20.cmr.use.existing_table is an option to recover the related information used till an error occurred when starting the application. If you specify true, you can deploy such that the existing table in the data base can be used. Use this option to use the existing tables:

Use an SQL to confirm that the tables for CMR that you were using before the failure occurred are remaining in the database.

Terminate the J2EE server (take an action against the cause of failure to start the application in the deployed state).

Specify the following in ejbserver.ejb.cmp20.cmr.use.existing_table parameter in <configuration> tag of the logical J2EE server (j2ee-server) of the Easy Setup definition file.

<param-name> tag

ejbserver.ejb.cmp20.cmr.use.existing_table

<param-value> tag

true

Start the J2EE server.

Re-deploy the application containing a CMR that failed to start in the deployed state.

Note

Here, do not regenerate the SQL. If you regenerate, an SQL with new table names will be generated, and you will not be able to use the previous tables.

Stop the J2EE server.

Whether to specify false in the ejbserver.ejb.cmp20.cmr.use.existing_table parameter in <configuration> tag of the logical J2EE server (j2ee-server) of the Easy Setup definition file or return to the state where this option is not set.

Re-start the J2EE server.

Appendix E. Main Functionality Changes in Each Version

This section describes the main functionality changes in Application Server versions prior to version 09-50 and the purpose of each change. For details on the main functionality changes in version 09-50, see 1.4 Main functionality changes in Application Server 09-50.

The contents described in this section are as follows:

This section gives an overview and describes the main changes in the functionality of various Application Server versions. For details on the functionality, see the description in the Section column of the Reference column. The main locations where the functionality is described in the 09-50 manual are described in the Reference and Section columns.

uCosminexus Application Server is omitted from the manual names mentioned in the Reference column.

Organization of this section

E.1 Main functionality changes in 09-00

E.2 Main functionality changes in 08-70

E.3 Main functionality changes in 08-53

E.4 Main functionality changes in 08-50

E.5 Main functionality changes in 08-00

Appendix E.1 Main functionality changes in 09-00

Organization of this subsection

(1) Simplifying implementation and setup

(2) Supporting standard and existing functionality

(3) Maintaining and improving reliability

(4) Maintaining and improving operability

(5) Other purposes

(1) Simplifying implementation and setup

The following table describes the items that are changed to simplify installation and setup.

Table E-1 Changes made for simplifying implementation and setup

Item
Overview of changes
Reference manual
Reference

Changing the units to be set up and operated in the virtual environment
The units to be operated when you set up and operate the virtual environment have been changed from the virtual server to the virtual server group. You can now use the file in which the virtual server group is defined, and register multiple virtual servers to a management unit in a batch.
Virtual System Setup and Operation Guide
1.1.2

Cancelling the restrictions on the environment setup by using Setup Wizard
The restrictions on the environments that can be set up with Setup Wizard have been removed. Even if an environment has been set up with another functionality, you can now unset up the environment and use Setup Wizard for setup.
System Setup and Operation Guide
2.2.7

Simplifying the procedure for deleting the setup environment
The deletion procedure has now been simplified by adding the functionality to delete a system environment setup with Management Server (mngunsetup command).
System Setup and Operation Guide
4.1.37

Management Portal User Guide
3.6, 5.4

Command Reference Guide
mngunsetup (Deleting the Management Server configuration environment
)

(2) Supporting standard and existing functionality

The following table describes the items that are changed to support the standard and existing functionality.

Table E-2 Changes made for supporting the standard and existing functionality

Item | Overview of changes | Reference manual | Reference
Supporting Servlet 3.0 | Servlet 3.0 is now supported. | Web Container Functionality Guide | Chapter 6
Supporting EJB 3.1 | EJB 3.1 is now supported. | EJB Container Functionality Guide | Chapter 2
Supporting JSF 2.1 | JSF 2.1 is now supported. | Web Container Functionality Guide | Chapter 3
Supporting JSTL 1.2 | JSTL 1.2 is now supported. | Web Container Functionality Guide | Chapter 3
Supporting CDI 1.0 | CDI 1.0 is now supported. | Common Container Functionality Guide | Chapter 9
Using Portable Global JNDI names | You can now look up objects for which Portable Global JNDI names are used. | Common Container Functionality Guide | 2.4
Supporting JAX-WS 2.2 | JAX-WS 2.2 is now supported. | Web Service Development Guide | 1.1, 16.1.5, 16.1.7, 16.2.1, 16.2.6, 16.2.10, 16.2.12, 16.2.13, 16.2.14, 16.2.16, 16.2.17, 16.2.18, 16.2.20, 16.2.22, 19.1, 19.2.3, 37.2, 37.6.1, 37.6.2, 37.6.3
Supporting JAX-RS 1.1 | JAX-RS 1.1 is now supported. | Web Service Development Guide | 1.1, 1.2.2, 1.3.2, 1.4.2, 1.5.1, 1.6, 2.3, Chapter 11, Chapter 12, Chapter 13, Chapter 17, Chapter 24, Chapter 39

(3) Maintaining and improving reliability

The following table describes the items that are changed for maintaining and improving reliability.

Table E-3 Changes made for maintaining and improving reliability

Item | Overview of changes | Reference manual | Reference
Using TLSv 1.2 for SSL/TLS communication | You can now use RSA BSAFE SSL-J to execute the SSL/TLS communication with a security protocol containing TLSv 1.2. | Security Management Guide | 7.3

(4) Maintaining and improving operability

The following table describes the items that are changed with the purpose of maintaining and improving operability.

Table E-4 Changes made for maintaining and improving operability

Item
Overview of changes
Reference manual
Reference

Monitoring the total pending queues of the entire Web container
You can now output the total pending queues of the entire Web container in the operation information and monitor the number of queues.
Operation, Monitoring, and Linkage Guide
Chapter 3

Output of trace based performance analysis for applications (user-extended trace)
The trace based performance analysis used for analyzing the processing performance of user-developed applications can now be output without changing the applications.
This manual
Chapter 7

Operations performed by using the user script in a virtual environment
The user-created script (user script) can now be executed on a virtual server at any time.
Virtual System Setup and Operation Guide
7.8

Improving the management portal
Changes have been made so that the messages describing the procedure are now displayed on the following management portal windows:

Deploy Preference Information window

Start windows for the Web server, J2EE server, and SFO server

Batch start, batch restart, and start windows for Web server cluster and J2EE server cluster

Management Portal User Guide
10.11.1, 11.9.2, 11.10.2, 11.11.2, 11.11.4, 11.11.6, 11.12.2, 11.13.2, 11.13.4, 11.13.6

Adding the restart functionality in the management functionality
You can now specify automatic restart for the management functionality (Management Server and Administration Agent), and continue operations even when an error occurs in the management functionality. The procedure for automatic start settings has also been changed.
Operation, Monitoring, and Linkage Guide
2.4.1, 2.4.2, 2.6.3, 2.6.4

Command Reference Guide
mngautorun (Set up/canceling the setup of autostart and autorestart)

(5) Other purposes

The following table describes the items that are changed for other purposes.

Table E-5 Changes due to other purposes

Item
Overview of changes
Reference manual
Reference

Changing the file switching units when log is output
The output destination files are now switched by date when the log is output.
This manual
3.2.1

Changing the Web server name
The name of the Web server included in Application Server is changed to Cosminexus HTTP Server.
HTTP Server User Guide
--

Supporting direct connection by using the BIG-IP APIs (SOAP architecture)
Direct connection is now supported by using APIs (SOAP architecture) in BIG-IP (load balancer).
Also, the procedure for setting up the connection environment of the load balancer has been changed for using a direct connection through APIs.
System Setup and Operation Guide
4.7.3, Appendix K

Virtual System Setup and Operation Guide
2.1, Appendix C

Security Management Guide
8.2, 8.4, 8.5, 8.6, 18.2, 18.3, 18.4

Legend:

--: Reference the entire manual.

Appendix E.2 Main functionality changes in 08-70

Organization of this subsection

(1) Simplifying implementation and setup

(2) Supporting standard and existing functionality

(3) Maintaining and improving reliability

(4) Maintaining and improving operability

(5) Other purposes

(1) Simplifying implementation and setup

The following table describes the items that are changed to simplify installation and setup.

Table E-6 Changes made for simplifying implementation and setup

Item
Overview of changes
Reference
Section

Improving the Management portal
Changes have been made to enable the user to set the property (settings of the Connector property file) for defining the resource adapter attributes and perform the connection test in the management portal window. Also, J2EE applications (ear file and zip file) can now be uploaded on Management Server using the Management portal window.
First Step Guide
3.5

Management Portal Operation Guide
--

Adding functionality for implicitly importing the import property for the page/tag directive
The functionality for implicitly importing the import property of the page/tag directive can now be used.
Web Container Functionality Guide
2.3.7

Support for automating the environment settings corresponding to JP1 products in a virtual environment
Changes have been made so that when Application Server is set up on a virtual server, the environment settings of JP1 products can be automatically set for the virtual server by using the hook script.
Virtual System Setup and Operation Guide
7.7.2

Improving the Integrated user management functionality
When using a database in a user information repository, you can now connect to the database by using the JDBC driver of database products. The database connection through the JDBC driver of Cosminexus DABroker Library is not supported anymore.
You can now set the integrated user management functionality using the Easy Setup definition file and the management portal windows.
Active Directory now supports double byte characters such as Japanese language in DN.
Security Management Guide
Chapter 5, 14.3

Management Portal Operation Guide
3.5, 10.9.1

Enhancing HTTP Server settings
You can now directly set the directive (settings of httpsd.conf) that defines the operation environment of HTTP Server using the Easy Setup definition file and the management portal windows.
System Setup and Operation Guide
4.1.21

Management Portal Operation Guide
10.10.1

Definition Reference Guide
4.13

Legend:

--: Reference the entire manual.

(2) Supporting standard and existing functionality

The following table describes the items that are changed to support standard and existing functionality.

Table E-7 Changes made for supporting standard and existing functionality

Item | Overview of changes | Reference | Section
Adding items to be specified in ejb-jar.xml | A class level interceptor and a method level interceptor can now be specified in ejb-jar.xml. | EJB Container Functionality Guide | 2.15
Supporting the parallel copy garbage collection | The parallel copy garbage collection can now be selected. | Definition Reference Guide | 16.5
Supporting the global transaction of the Inbound resource adapter conforming to Connector 1.5 specifications | Transacted Delivery can now be used in the resource adapters conforming to Connector 1.5 specifications. This enables participation of EIS invoking the Message-driven Bean in the global transaction. | Common Container Functionality Guide | 3.16.3
Supporting MHP of a TP1 inbound adapter | MHP can now be used as the OpenTP1client that invokes Application Server by using the TP1 inbound adapter. | Common Container Functionality Guide | Chapter 4
Supporting the FTP inbound adapter of the cjrarupdate command | An FTP inbound adapter has been added to the resource adapters that can be upgraded by using the cjrarupdate command. | Command Reference Guide | 2.2

(3) Maintaining and improving reliability

The following table describes the items that are changed for maintaining and improving reliability.

Table E-8 Changes for maintaining and improving reliability

Item
Overview of changes
Reference
Section

Improving the database session failover functionality
The user can now select a mode that does not obtain the lock of the database in which the global session information is stored in a performance-centric system. Also, exclusive requests for references can now be defined without updating the database.
Expansion Guide
Chapter 6

Expansion of a process for the
OutOfMemory handling functionality
A process for the OutOfMemory handling functionality has been added.
This manual
2.5.7

Definition Reference Guide
16.2

Adding the memory saving functionality for the Explicit heap used in an HTTP session
A functionality to minimize the amount of the Explicit heap memory used in the HTTP session has been added.
Expansion Guide
8.11

(4) Maintaining and improving operability

The following table describes the items that are changed with the purpose of maintaining and improving operability.

Table E-9 Changes with the purpose of maintaining and improving operability

Item | Overview of changes | Reference | Section
Supporting user authentication using JP1 products in the virtual environment (handling cloud operations) | The administration and authentication of users using a virtual server manager can now be performed by using the authentication server of JP1 products when integrating JP1. | Virtual System Setup and Operation Guide | 1.2.2, Chapter 3, Chapter 4, Chapter 5, Chapter 6, 7.9

(5) Other purposes

The following table describes the items that are changed for other purposes.

Table E-10 Changes due to other purposes

Item
Overview of changes
Reference
Section

Supporting the direct connection using APIs (REST Architecture) to the load balancing functionality
Direct connection using APIs (REST architecture) is now supported as a method to connect to the Load balancing functionality.
ACOS (AX2500) is added in the types of available load balancing functions.
System Setup and Operation Guide
4.7.2, 4.7.3

Virtual System Setup and Operation Guide
2.1

Definition Reference Guide
4.5

Improving response timeout when collecting snapshot logs and collection targets
You can now stop snapshot log collection (timeout) at a specified time. The contents collected as primary delivery data have been changed.
This manual
Appendix A

Appendix E.3 Main functionality changes in 08-53

Organization of this subsection

(1) Simplifying implementation and setup

(2) Supporting standard and existing functionality

(3) Maintaining and improving reliability

(4) Maintaining and improving operability

(5) Other purposes

(1) Simplifying implementation and setup

The following table describes the items that are changed to simplify installation and setup.

Table E-11 Changes made for simplifying implementation and setup

Item
Overview of changes
Reference
Section

Setting up a virtual environment supporting various hypervisors
Application Server can now be set up on a virtual server implemented by using various hypervisors.
An environment in which multiple hypervisors co-exist is also supported now.
Virtual System Setup and Operation Guide
Chapter 2, Chapter 3, Chapter 5

(2) Supporting standard and existing functionality

The following table describes the items that are changed to support standard and existing functionality.

Table E-12 Changes made for supporting standard and existing functionality

Item | Overview of changes | Reference | Section
Invocation from OpenTP1 supporting transaction integration | Transactions can now be integrated when the Message-driven Bean running on Application Server is invoked from OpenTP1 | Common Container Functionality Guide | Chapter 4
JavaMail | The mail receiving functionality, which uses the APIs conforming to JavaMail 1.3 by integrating with the mail server conforming to POP3, is now available. | Common Container Functionality Guide | Chapter 8

(3) Maintaining and improving reliability

The following table describes the items that are changed for maintaining and improving reliability.

Table E-13 Changes made for maintaining and improving reliability

Item
Overview of changes
Reference
Section

Enhancing the JavaVM troubleshooting functionality
The following functionality can now be used as the JavaVM troubleshooting functionality:

The operations when OutOfMemoryError occurs can now be changed.

You can now set up an upper limit for the amount of C heap allocated during JIT compilation.

You can now set up the maximum thread count.

The output items of the extended verbosegc information have been extended.

This manual
Chapter 4, Chapter 5, Chapter 9

(4) Maintaining and improving operability

The following table describes the items that are changed with the purpose of maintaining and improving operability.

Table E-14 Changes made for maintaining and improving operability

Item | Overview of changes | Reference | Section
Supporting JP1/ITRM | JP1/ITRM, a product that uniformly manages the IT resources, is now supported. | Virtual System Setup and Operation Guide | 1.3, 2.1

(5) Other purposes

The following table describes the items that are changed for other purposes.

Table E-15 Changes due to other purposes

Item
Overview of changes
Reference
Section

Supporting Microsoft IIS 7.0 and Microsoft IIS 7.5
Microsoft IIS 7.0 and Microsoft IIS 7.5 are now supported as Web servers.
--
--

Supporting HiRDB Version 9 and SQL Server 2008
The following products are now supported as the database:

HiRDB Server Version 9

HiRDB/Developer's Kit Version 9

HiRDB/Run Time Version 9

SQL Server 2008

Also, SQL Server JDBC Driver is now supported as the JDBC driver corresponding to SQL Server 2008.
Common Container Functionality Guide
Chapter 3

Legend:

--: Not applicable.

Appendix E.4 Main functionality changes in 08-50

Organization of this subsection

(1) Simplifying implementation and setup

(2) Supporting standard and existing functionality

(3) Maintaining and improving reliability

(4) Maintaining and improving operability

(5) Other purposes

(1) Simplifying implementation and setup

The following table describes the items that are changed to simplify installation and setup.

Table E-16 Changes made for simplifying implementation and setup

Item | Overview of changes | Reference | Section
Changing the mandatory tag for specifying web.xml in the Web service provider | The specification of the listener tag, servlet tag, and servlet-mapping tag was changed from mandatory to optional in web.xml in the Web service provider. | Definition Reference Guide | 2.4
Using the network resources of the logical server | The functionality for accessing the network resources and network drive existing on another host from the J2EE applications was added. | Operation, Monitoring, and Linkage Guide | 1.2.3, 5.2, 5.7
Simplifying the execution procedure of the sample program | The procedure of executing the sample program was simplified by providing a part of the sample program in the EAR format. | First Step Guide | 3.5
System Setup and Operation Guide | Appendix M
Improving the operations in the management portal window | The default update interval of the window was changed from "Do not update" to "3 seconds". | Management Portal Operation Guide | 7.4.1
Improving the Setup Wizard completion window | The Easy Setup definition file and Connector property file used for setup are now displayed on the window for Setup Wizard completion. | System Setup and Operation Guide | 2.2.6
Setting up the virtual environment | The procedure of setting up Application Server on the virtual server, implemented by using a hypervisor, has been added.# | Virtual System Setup and Operation Guide | Chapter 3, Chapter 5

#

To set up in the 08-50 mode, see Appendix D Settings to use the virtual server manager in the 08-50 mode in the manual uCosminexus Application Server Virtual System Setup and Operation Guide.

(2) Supporting standard and existing functionality

The following table describes the items that are changed to support standard and existing functionality.

Table E-17 Changes made for supporting standard and existing functionality

Item | Overview of changes | Reference | Section
Supporting invocation from OpenTP1 | The Message-driven Bean running on Application Server can now be invoked from OpenTP1. | Common Container Functionality Guide | Chapter 4
Supporting JMS | The Cosminexus JMS Provider functionality conforming to the JMS 1.1 specifications can now be used. | Common Container Functionality Guide | Chapter 7
Supporting Java SE 6 | The Java SE 6 functionality can now be used. | This manual | 5.5, 5.8.1
Supporting the use of generics | Generics can now be used with EJB. | EJB Container Functionality Guide | 4.2.19

(3) Maintaining and improving reliability

The following table describes the items that are changed for maintaining and improving reliability.

Table E-18 Changes made for maintaining and improving reliability

Item | Overview of changes | Reference | Section
Improving the usability of the Explicit Memory Management functionality | The Explicit Memory Management functionality can now be used easily by using the automatic allocation configuration file. | System Design Guide | 7.1.1, 7.6.3, 7.10.5, 7.11.1
Expansion Guide | Chapter 8
Controlling the database session failover functionality for URIs | When using the database session failover functionality, you can now specify the requests that will be outside the scope of the functionality for URIs. | Expansion Guide | 5.6.1
Monitoring errors in the virtual environment | In a virtual system, the virtual server is now monitored and the occurrence of errors can be detected. | Virtual System Setup and Operation Guide | Appendix D

(4) Maintaining and improving operability

The following table describes the items that are changed with the purpose of maintaining and improving operability.

Table E-19 Changes made for maintaining and improving operability

Item | Overview of changes | Reference | Section
Omitting the management user account | The login ID and password of the user can now be omitted in the management portal, Management Server commands, or Smart Composer functionality commands. | System Setup and Operation Guide | 4.1.15
Management Portal Operation Guide | 2.2, 7.1.1, 7.1.2, 7.1.3, 8.1, 8.2.1, Appendix F.2
Command Reference Guide | 1.4, mngsvrctl (Starting/ stopping/ setting up Management Server), mngsvrutil (Management Server management commands), 8.3, cmx_admin_passwd (Setting up the management user account of Management Server)
Virtual environment operations | The procedure of executing batch start, batch stop, scale in, and scale out for multiple virtual servers has been added in the virtual system. # | Virtual System Setup and Operation Guide | Chapter 4, Chapter 6

#

To operate in the 08-50 mode, see Appendix D Settings to use the virtual server manager in the 08-50 mode in the manual uCosminexus Application Server Virtual System Setup and Operation Guide.

(5) Other purposes

The following table describes the items that are changed for other purposes.

Table E-20 Changes due to other purposes

Item
Overview of changes
Reference
Section

Unused objects statistical functionality in the Tenured area
Only the unused objects can now be identified in the Tenured area.
This manual
9.8

Base object list output functionality for Tenured augmentation factors
The information of the objects that form the base of unused objects, identified by using the unused objects statistical functionality in the Tenured area, can now be output.
9.9

Class-wise statistical information analysis functionality
The class-wise statistical information can now be output in the CSV format.
9.10

Cluster node switching based on the detection of the exceeding of the auto-restart frequency of the logical server
Node switching can now be executed when the logical server is in an abnormally stopped state (state in which the auto-restart count is exceeded, or state in which an error is detected when the auto-restart count is set to 0) in a cluster configuration wherein Management Server is to be monitored for node switching.
Operation, Monitoring, and Linkage Guide
18.4.3, 18.5.3,
20.2.2,
20.3.3, 20.3.4

Node switching system for the host unit management model
Node switching can now be executed for the host unit management model in the system operations integrated with the cluster software.
Chapter 20

Supporting ACOS (AX2000, BS320)
ACOS (AX2000, BS320) was added to the types of load balancers that are available.
System Setup and Operation Guide
4.7.2, 4.7.3, 4.7.5, 4.7.6, Appendix K, Appendix K.2

Definition Reference Guide
4.5, 4.6.2, 4.6.4, 4.6.5, 4.6.6, 4.10.1

Transaction attributes that can be specified in the Stateful Session Bean (SessionSynchronization) when transactions are managed with CMT, have been added
Supports, NotSupported, and Never can now be specified as the transaction attributes in the Stateful Session Bean (SessionSynchronization), when transactions are managed with CMT.
EJB Container Functionality Guide
2.7.3

Forcibly terminating Administration Agent when OutOfMemoryError occurs
Administration Agent is now forcibly terminated when OutOfMemoryError occurs in JavaVM.
This manual
2.5.8

Asynchronous parallel processing of threads
Asynchronous timer processing and asynchronous thread processing can now be implemented by using TimerManager and WorkManager.
Expansion Guide
Chapter 10

Appendix E.5 Main functionality changes in 08-00

This section describes the main functionality changes in Application Server 08-00. These changes are described below with reference to the purpose of change.

The description contents are as follows:

The main functionality that have been changed in Application Server 08-00 and an overview of the changes is described below. For details about the functionality, check the Reference. The Reference column describes the main description locations of the functionality.

Cosminexus Application Server has been omitted from the manual names described in the Reference column.

Organization of this subsection

(1) Improvement of development productivity

(2) Support to standard functionality

(3) Maintenance and improvement of reliability

(4) Maintenance and improvement of operability

(5) Other purposes

(1) Improvement of development productivity

The following table describes the items changed with the purpose of improving the development productivity.

Table E-21 Changes made with the purpose of improving the development productivity

Item
Overview of changes
Reference
Section

Simplification of migration from other Application Server products
Enabled the use of the following functionality for smooth migration from other Application Server products:

Enabled the judgment of upper limit of the HTTP sessions through an exception.

Enabled the inhibition of occurrence of a translation error when the ID of JavaBeans is duplicate, and when the upper-case characters and lower-case characters are different in the attribute name of the custom tag and in the TLD definition.

Web Container Functionality Guide
2.3, 2.7.5

Provision of cosminexus.xml
Enabled the start of J2EE applications without setting the properties after importing them into the J2EE server by describing the properties unique to the Cosminexus Application Server in cosminexus.xml.
Common Container Functionality Guide
11.3

(2) Support to standard functionality

The following table describes the items changed with the purpose of supporting the standard functionality.

Table E-22 Changes made with the purpose of supporting the standard functionality

Item | Overview of changes | Reference | Section
Servlet 2.5 support | Supported Servlet 2.5. | Web Container Functionality Guide | 2.2, 2.5.4, 2.6, Chapter 6
JSP 2.1 support | Supported JSP 2.1. | Web Container Functionality Guide | 2.3.1, 2.3.3, 2.5, 2.6, Chapter 6
JSP debug | Enabled the execution of JSP debugging in the development environment using MyEclipse. # | Web Container Functionality Guide | 2.4
Storage of the tag library in the library JAR, and TLD mapping | Enabled the search of TLD files within the library JAR by the Web container during the start of the Web application, and their subsequent automatic mapping, when the tag libraries are stored in the library JAR. | Web Container Functionality Guide | 2.3.4
Omission of application.xml | Enabled the omission of application.xml in a J2EE application. | Common Container Functionality Guide | 11.4
Combined use of annotations and DDs | Enabled the combined use of annotations and DDs, and also enabled the update of annotation contents in the DD. | Common Container Functionality Guide | 12.5
Conformance of annotations to Java EE 5 standard (default interceptor) | Enabled the storage of the default interceptor in the library JAR. Also enabled the execution of DI from the default interceptor. | Common Container Functionality Guide | 11.4
Reference resolution of @Resource | Enabled the reference resolution of resources with @Resource. | Common Container Functionality Guide | 12.4
JPA support | Supported JPA specifications. | Common Container Functionality Guide | Chapter 5, Chapter 6

#

In 09-00 and later versions, you can use the JSP debug functionality in the development environment using WTP.

(3) Maintenance and improvement of reliability

The following table describes the items changed with the purpose of maintaining or improving reliability.

Table E-23 Changes made with the purpose of maintaining or improving reliability

Item | Overview of changes | Reference | Section
Persistence of session information | Enabled the inheritance of session information of an HTTP session by saving the information in the database. | Expansion Guide | Chapter 5, Chapter 6
Inhibition of a full garbage collection | Enabled the inhibition of occurrence of a full garbage collection by deploying the objects responsible for the full garbage collection outside the Java heap. | Expansion Guide | Chapter 8
Client performance monitor | The time required for client processing can now be checked and analyzed. | -- | --

Legend:

--: This functionality has been deleted in 09-00.

(4) Maintenance and improvement of operability

The following table describes the items that are changed with the purpose of maintaining and improving operability.

Table E-24 Changes made with the purpose of maintaining and improving operability

Item | Overview of changes | Reference | Section
Improving the operability of applications on the management portal | The server management commands and management portal can now be interoperated for application and resource operations. | Management Portal Operation Guide | 1.1.3

(5) Other purposes

The following table describes the items changed with some other purpose.

Table E-25 Changes made with other purposes

Item | Overview of changes | Reference | Section
Deletion if disabled HTTP Cookies | Enabled the deletion of disabled HTTP Cookies. | Web Container Functionality Guide | 2.7.4
Failure detection in the Naming Service | Enabled prompt detection of the error by the EJB client, when a failure occurs in the Naming Service. | Common Container Functionality Guide | 2.9
Connection failure detection timeout | Enabled the specification of the timeout period for a connection failure detection timeout. | Common Container Functionality Guide | 3.15.1
Oracle11g support | Enabled the use of Oracle11g as a database. | Common Container Functionality Guide | Chapter 3
Scheduling of batch processing | Enabled the scheduling of execution of batch applications by CTM. | Expansion Guide | Chapter 4
Batch processing log | The retry frequency and retry interval can now be specified for the size and number of log files of the batch execution command and the failure of exclusive processing of the log. | Definition Reference Guide | 3.6
snapshot log | Changed the collection contents of the snapshot log. | This manual | Appendix A.1, Appendix A.2
Publication of protected area of method cancellation | Published the contents of protected area list that is outside the scope of method cancellation. | Operation, Monitoring, and Linkage Guide | Appendix C
Pre-statistical garbage collection selection functionality | Enabled the selection of whether or not to execute a garbage collection before the output of class-wise statistical information. | This manual | 9.7
Tenuring distribution information output functionality of the Survivor area. | Enabled the output of tenuring distribution information of Java objects of the Survivor area to the JavaVM log file. | This manual | 9.11
Finalize retention cancellation functionality | Enabled the cancellation of retention of the finalize processing of JavaVM after monitoring its status. | -- | --
Change of the maximum heap size of server management commands | Changed the maximum heap size used by server management commands. | Definition Reference Guide | 5.2, 5.3
Action for cases when un-recommended display names are specified | Provided the output of messages when un-recommended display names are specified in J2EE applications. | Messages | KDJE42374-W

Legend:

--: This functionality has been deleted in 09-00.

Appendix F. Glossary

Terminology used in this manual

For the terms used in the manual, see the uCosminexus Application Server and BPM/ESB Platform Terminology Guide.

Index

[Symbols]
[A][B][C][D][E][F][G][H][I][J][K][L][M][N][O][P][R][S][T][U][V][W]

(Symbols)

-XX:+HitachiJavaClassLibTrace

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiVerboseGC

-XX:+JITCompilerContinuation

(A)

acquiring

Administration agent, Management agent, and Management Server

Administration agent, Management agent, and Management Server

application user log

application user log

automatically when problem occurs

by executing command

by executing command created by user

CORBA naming service thread dump

Cosminexus Component Transaction Monitor log

Cosminexus Performance Tracer log

data

EJB client application user log

extended verbosegc information

integrated user management log

J2EE server, redirector, server management command logs

J2EE server memory dump

J2EE server thread dump

OS log

snapshot log

user dump

Acquiring logs of internal setup tool of virtual server manager and Server Communication Agent

action for problem in system linked with JP1/IM

Administration agent, Management agent, and Management Server log

advanced level

analyzing

processing performance

response time of Web server

Analyzing processing performance of Application Server using trace based performance analysis file

Application Server

resource setting information

Application Server log

automatic allocation error in explicit memory management

automatic release processing of explicit memory block

(B)

base object list output functionality for tenured augmentation factors

batch server log

(C)

changing log output destination

CJPA provider

class-wise statistical functionality

class-wise statistical information

class-wise statistical information analysis functionality

class-wise statistical information output by instance statistical functionality

class-wise statistical information output by reference-related information output functionality

class-wise statistical information output by STATIC member statistical functionality

class-wise statistical information output by unused objects statistical functionality in tenured area

classifications of functionality and corresponding manuals describing functionality

client application information

collecting material using command

collecting snapshot logs using management commands

collecting trace information of trace based performance analysis

collecting trace information of user-extended trace based performance analysis

com.cosminexus.manager.cmdtracelog.fnum

com.cosminexus.manager.cmdtracelog.size

com.cosminexus.manager.log.compatible

com.cosminexus.manager.log.dir

com.cosminexus.manager.messagelog.fnum

com.cosminexus.manager.messagelog.size

com.cosminexus.manager.messagelog.style

com.cosminexus.manager.messagelog.time

com.cosminexus.manager.tracelog.fnum

com.cosminexus.manager.tracelog.size

com.cosminexus.manager.tracelog.style

com.cosminexus.manager.tracelog.time

com.cosminexus.mngsvr.log.level

com.cosminexus.mngsvr.log.rotate

com.cosminexus.mngsvr.log.size

com.cosminexus.mngsvr.trace

configuration file for user-extended trace based performance analysis

configuration of user-extended trace based performance analysis

confirmation method of event log of Explicit Heap Memory Management functionality

confirming

validity period of global session

validity period of session

connection-related trace collection points

connection ID

console log

contents of code cache area-related log

contents of J2EE server or batch server working directory

contents output when output level is debug

contents output when output level is normal

contents output when output level is verbose

Cosminexus Component Transaction Monitor log

Cosminexus JPA Provider log

Cosminexus JPA provider log

Cosminexus JPA Provider operation log

Cosminexus Performance Tracer

Cosminexus Performance Tracer log

output destination

type

(D)

data acquisition settings using failure detection time commands (systems for executing batch applications)

data acquisition settings using failure detection time commands (systems for executing J2EE applications)

definition sending data

definition sending data

differences with earlier versions of multi-process trace common library

(E)

ejb.server.corefilenum

ejb.server.log.directory

ejb.server.log.directory

ejb.server.log.directory

EJB client application log

EJB client application system log

output destination

type

ejbserver.connector.logwriter.filenum

ejbserver.connector.logwriter.filesize

ejbserver.logger.channels.define.<channel-name>.filenum (batch server)

ejbserver.logger.channels.define.<channel-name>.filenum (J2EE server)

ejbserver.logger.channels.define.<channel-name>.filenum (SFO server)

ejbserver.logger.channels.define.<channel-name>.filesize (batch server)

ejbserver.logger.channels.define.<channel-name>.filesize (J2EE server)

ejbserver.logger.channels.define.<channel-name>.filesize (SFO server)

ejbserver.logger.enabled.*

ejbserver.logger.enabled.*

ejbserver.logger.enabled.*

ejbserver.logger.rotationStyle

ejbserver.logger.rotationTime

error in opening automatic allocation configuration file for explicit memory management

error in opening configuration file of functionality for specifying classes to be excluded from Explicit Memory Management functionality

error in parsing automatic allocation configuration file for explicit memory management

error in parsing configuration file of functionality for specifying classes to be excluded from Explicit Memory Management functionality

error report file

event log

event log

output format

output item

event log of Explicit Heap Memory Management functionality

event log of Explicit Heap Memory Management functionality

event log of Explicit Memory Management functionality

Example of filtered trace based performance analysis file

Example of the filtered trace based performance analysis file collected in Application Server

Example of the performance analysis file collected in the Web server

Example of Web client configuration

example output

simple output format

standard format

when actual type name of class or array type variable is to be output

when class or array type variable is output as character string

Example of the trace based performance analysis file where the session trace information is output (request part where the session is cancelled)

Example of the trace based performance analysis file where the session trace information is output (request part where is session is used)

Example of the trace based performance analysis file where the session trace information is output (request part where the session is created)

examples of troubleshooting during operations

exception log

exception log

extended thread dump

extended thread dump

(F)

failure detection command

failure detection command created by user

failure detection command provided by system

flow for handling of data when trouble occurs

flow of snapshot log collection

functionality that requires class-wise statistical functionality

function layer

(G)

global session ID

guidelines for selecting garbage collection

(H)

Hitachi Trace Common Library format

Hitachi Trace Common Library format (multi processes)

Hitachi Trace Common Library format (single process)

Hitachi Trace Common Library format log

output format and output item

hndlwrap functionality

HttpsdCustomLogFileDir

HttpsdCustomlogFormat

HttpsdCustomMethod

HttpsdErrorLogFileDir

HttpsdErrorMethod

HttpsdRequestLogFileDir

HttpsdRequestMethod

HWSLogTimeVerbose

HWSRequestLogLevel

(I)

identifying

connection in which error occurred

request in which timeout occurred

transaction for which timeout occurred

identifying connection

occurring error

if administration agent is terminated forcibly when OutOfMemoryError occurs

if problem occurs in node switching system for host unit management model

if problems occurs in N-to-1 recovery systems

If trouble occurs in 1-to-1 node switching system

implementation for collection of root application information of trace based performance analysis

In-process HTTP server log

in-process transaction service

migration

information on execution of Component Container Administrator setup command (in UNIX)

In-process HTTP server log

instance statistical functionality

integrated log

integrated log

internal setup tool of virtual server manager and server communication agent logs

investigating

life cycle of session

log using root application information

processing status of request in application server

investigation about the location of the problem associated to the trace based performance analysis file and thread dump

(J)

J2EE application

acquiring user log

J2EE server and redirector log

javagc command

Java heap overflow in automatic release processing of explicit memory block

JavaVM garbage collection log

JavaVM garbage collection log

JavaVM log (JavaVM log file)

JavaVM log file

JavaVM log file

JavaVM message log

abnormal termination location and signal type

command and VM parameter

command code information

command line of javatrace start command

current thread information

environment variable

information saved from top of stack

insufficient C heap

internal error

Java heap usage status

library

machine information

memory information

registered signal handler

register information

save destination address of signal information

siginfo information

signal information

stack trace

System name, CPU, actual memory, and VM information

thread creation failure

thread information

time information

VM status

JavaVM stack trace information

JavaVM stack trace information

JavaVM stack trace information

JavaVM thread dump

JavaVM thread dump

JIT compiler

(K)

key information

(L)

list of change files for multi-process trace common library format

list of data to be acquired for each type of problem

list of required data to be acquired

local variable

local variable information

LogLevel

log level

changing

changing

log of in-process HTTP Server

log output destination

log output destination

log output destination

log output destination

J2EE server and redirector log

migration command (cjenvupdate) log

migration command (cjenvupdate) log

migration command (cjenvupdate) log

resource adapter version-up command (cjrarupdate) log

resource adapter version-up command (cjrarupdate) log

resource adapter version-up command (cjrarupdate) log

resource depletion monitoring log

resource depletion monitoring log

resource depletion monitoring log

server management command log

server management command log

server management command log

log output to audit log

log output to Cosminexus JPA provider

Logs for application rewriting

Logs for reading of configuration file for user-extended trace based performance analysis

log size

changing

changing

Logs output when user-extended trace based performance analysis is executed

(M)

main functionality changes in 09-00

main functionality changes in Application Server 09-50

main problems occurring during application startup

main problems occurring during installation

main problems occurring during operations

main problems occurring during server/application maintenance

main problems occurring during server setup

main problems occurring during server startup

maintenance level

maintenance level

maintenance log

maintenance log

maintenance personnel

management event published log

management event published log

memory dump

message log

message log

message log output by JavaVM

message log output by JavaVM (standard output and error report file)

migrating from Application Server of earlier versions (in J2EE server mode)

Migrating to the Recommended Functionality

Migration from Microsoft IIS to Cosminexus HTTP Server

(N)

notes for executing unused objects statistical functionality in tenured area

Notes on creating configuration file for user-extended trace based performance analysis

Notes on migration to database connection using HiRDB Type4 JDBC Driver

Notes on using user-extended trace based performance analysis

(O)

options to output JavaVM log file

option to be specified for acquiring extended verbosegc information

option to output local variable information to stack trace

OS commands executed by executing the cjgetsysinfo command

OS log

OS statistical information

OS status information

OS status information and OS log

output contents of message indicating core dump generation

output contents of message log indicating insufficient C heap

output contents of message showing memory insufficiency

output contents of the message indicating whether the Watson log is output correctly

output destination of a batch application user log

output destination of error report file

output destination of error report file

output destination of server management command log (Compatibility mode)

output destination of server management command log (Compatibility mode)

output destinations and output methods of data required for troubleshooting

output format and output example of tenuring distribution information of Survivor area

output format and output items of access log of in-process HTTP Server

output information of trace based performance analysis file

Output information of trace based performance analysis file (for user-extended trace based performance analysis)

output item of message log when C heap is insufficient

output items of access log

output items of Hitachi Trace Common Library format log

output trigger of event log of Explicit Heap Memory Management functionality

overview of pre-statistical garbage collection selection functionality

Overview of product JavaVM functionality

overview of tenuring distribution information output functionality of Survivor area

overview of trace based performance analysis

Overview of trace based performance analysis of applications

overview of trace based performance analysis of Application Server

overview of unused objects statistical functionality in tenured area

(P)

performance tracer

pre-statistical garbage collection selection functionality

precaution

when referencing the Hitachi Trace Common Library format log

precaution when using tenuring distribution information output functionality of Survivor area

Preparing for troubleshooting

prevention level

PRF trace collection levels (CMT and TransactionManager)

PRF daemon

PRF daemon

PRF demon

PrfTraceBufferSize

PRF trace collection level

PRF trace collection level

PRF trace collection levels (TP1 inbound integrated function)

PRF trace collection levels (UserTransaction)

PRF trace collection levels [DB Connector for Cosminexus RM]

PRF trace collection levels [filter trace (when an exception occurs)]

PRF trace collection levels [filter trace (when the processing terminates normally)]

PRF trace collection levels [in-process HTTP server]

PRF trace collection levels [memory session failover functionality]

PRF trace collection levels [Message-driven Bean (EJB2.0)]

PRF trace collection levels [Message-driven Bean (EJB2.1 and later)]

PRF trace collection levels [Session Bean or Entity Bean]

PrfTraceCount

PRF trace file

PrfTraceFileSize

PRF trace get level

PRF trace get level [connection association]

PRF trace get level [DB connector]

PRF trace get level [DB connector]

PRF trace get level [DI]

PRF trace get level [execution functionality of batch application]

PRF trace get level [J2EE server]

PRF trace get level [JNDI]

PRF trace get level [OTS]

PRF trace get level [RMI]

PRF trace get level [transaction timeout]

PRF trace get level [Web container]

PRF trace get level [Web container]

PRF trace get level [when connection automatically close]

PRF trace get level [work management]

PrfTraceLevel

PRF trace output library

primary delivery data

primary delivery data

problem

error message output

hang-up (no response)

slow down

system down

problem analysis

processes that output logs

Product JavaVM Functionality

(R)

recovering table for CMR

occurring error

reference-related information output functionality

reference destination of methods for acquiring and investigating required data to be acquired

required information to be acquired other than log

required information to be acquired other than log

resource depletion monitoring log

resource depletion monitoring log

resource setting information

Application Server

root application information

(S)

secondary delivery data

secondary delivery data

session trace

setting

acquiring batch server log

acquiring core dump

acquiring Cosminexus Manager log

acquiring Cosminexus TPBroker log

acquiring J2EE server log

acquiring JavaVM material

acquiring redirector log

acquiring resource adapter log

acquiring SFO server log

acquiring thread dump of JavaVM

acquiring Web server log

collecting OS statistical information

collecting user dump

setting contents of system monitor

settings for acquiring JavaVM log

settings for acquiring the event log of Explicit Heap Memory Management functionality

settings for acquiring the in-process HTTP server log

settings for collecting Cosminexus JMS provider logs

settings for collecting snapshot log (Systems of executing batch applications)

settings for colllecting snapshot logs (Systems for executing J2EE applications)

Settings for methods to be traced by user-extended trace based performance analysis

Settings for using trace based performance analysis

Settings for using user-extended trace based performance analysis

SFO server (compatibility function)

Shift mode

snapshot log

snapshot log

snapshot log

collecting

snapshotlog.2.conf

snapshotlog.conf

snapshotlog.param.conf

snapshot log list

stack trace

-XX:+HitachiLocalsInThrowable option

standard level

startup dependency

STATIC member statistical functionality

statistic information for each class

output

structure of thread dump information

syslog

syslog

output format

output item

system log of EJB client application

precaution

system monitor setting

(T)

tenuring distribution information output functionality of Survivor area

timing for collecting snapshot log

Trace collection points (CMT and TransactionManager)

trace application information

trace based performance analysis

trace based performance analysis

configuration

that is output when timeout occurs in transaction

that you can use to check request that is timed out

trace get point

working

trace based performance analysis file

trace based performance analysis file

collecting

how to collect

output destination

output destination

output information

trace based performance analysis file name

trace collection point

trace collection point indicated by event ID used in filtering

trace collection points (TP1 inbound integrated function)

trace collection points (UserTransaction)

trace collection points [DB Connector for Cosminexus RM]

trace collection points [filter trace (when an exception occurs)]

trace collection points [filter trace (when the processing terminates normally)]

trace collection points [in-process HTTP server]

trace collection points [memory session failover functionality]

trace collection points [Message-driven Bean (EJB2.0)]

trace collection points [Message-driven Bean (EJB2.1 and later)]

trace collection points [Session Bean or Entity Bean]

trace collection points and PRF trace collection levels (database session failover functionality)

trace collection points and PRF trace collection levels (database session failover functionality)

trace collection points and PRF trace collection levels

trace collection points and PRF trace collection levels (database session failover functionality)

trace collection points and PRF trace collection levels (EADs session failover functionality)

trace collection points and PRF trace collection levels (EADs session failover functionality)

trace collection points and PRF trace collection levels (EADs session failover functionality)

trace collection points and PRF trace collection levels (EADs session failover functionality)

trace collection points and trace information that can be collected during binary conversion of the entity class

trace collection points and trace information that can be collected during the acquisition or release processing of EntityManagerFactory

trace collection points and trace information that can be collected during the acquisition processing of EntityManager

trace collection points and trace information that can be collected during the operation of EntityManager

trace collection points and trace information that can be collected during the operation of EntityTransaction

trace collection points and trace information that can be collected during the operation of Query

trace collection points and trace information that can be collected during the release processing of EntityManager

trace collection points and trace information that can be collected during request processing for creating HTTP session (trace of database session failover functionality)

trace collection points and trace information that can be collected during transaction linkage with the transaction manager

trace collection points and trace information that can be collected in the case of callback method to the user

trace collection points and trace information that can be collected during the connection operation of the DB Connector

trace collection points and trace information that can be collected when the persistent context of application management is used

trace collection points and trace information that can be collected when the persistent context of container management is used

trace collection points in a JPA

trace collection points of a DB Connector and JCA container

trace collection points of a DI

trace collection points of a JNDI

trace collection points of a JTA

trace collection points of an EJB container

trace collection points of an OTS

trace collection points of an RMI

Trace collection points of application

trace collection points of a redirector

trace collection points of a Web container (filter trace)

trace collection points of a Web container (session trace)

trace collection points of a Web container (trace of request processing)

trace collection points of a Web container (trace of the database session failover functionality)

trace collection points of a Web container (trace of the memory session failover functionality)

Trace collection points of CDI

trace collection points of CTM

Trace collection points of JavaMail

Trace collection points of JSF

trace collection points of standard output, standard error output, and user log

trace collection points of the batch application execution functionality

trace collection points of the Cosminexus JPA provider

trace collection points of TP1 inbound integrated function

trace collection points of Web container (trace of EADs session failover functionality)

trace collection points when a J2EE server is started or terminated

trace common library format (multi-process)

trace common library format (single process)

trace get point

trace get point [connection association]

trace get point [DB connector]

trace get point [DB connector]

trace get point [DI]

trace get point [execution functionality of batch application]

trace get point [J2EE server]

trace get point [JNDI]

trace get point [OTS]

trace get point [RMI]

trace get point [transaction timeout]

trace get point [Web container]

trace get point [Web container]

trace get point [when connection automatically close]

trace get point [work management]

trace information that can be collected [filter trace (when the processing terminates normally)]

trace information that can be collected [CMT and TransactionManager]

trace information that can be collected (database session failover functionality)

trace information that can be collected (database session failover functionality)

trace information that can be collected (database session failover functionality)

trace information that can be collected (database session failover functionality)

trace information that can be collected (EADs session failover functionality )

trace information that can be collected (EADs session failover functionality)

trace information that can be collected (EADs session failover functionality)

trace information that can be collected (EADs session failover functionality)

trace information that can be collected (TP1 inbound integrated function)

trace information that can be collected [batch application execution functionality]

trace information that can be collected [connection association]

trace information that can be collected [DB Connector]

trace information that can be collected [DB Connector]

trace information that can be collected [DB Connector for Reliable Messaging]

trace information that can be collected [DI]

trace information that can be collected [filter trace (when an exception occurs)]

trace information that can be collected [J2EE server]

trace information that can be collected [JNDI]

trace information that can be collected [memory session failover functionality]

trace information that can be collected [Message-driven Bean (EJB2.0)]

trace information that can be collected [Message-driven Bean (EJB2.1 and later)]

trace information that can be collected [OTS]

trace information that can be collected [RMI]

trace information that can be collected [Session Bean or Entity Bean]

trace information that can be collected [transaction timeout]

trace information that can be collected [UserTransaction]

trace information that can be collected [Web container]

trace information that can be collected [Web container]

trace information that can be collected [when the connection closes automatically]

trace information that can be collected [work management]

trace information that can be collected [in-process HTTP server]

troubleshooting

acquiring trace information

precaution

troubleshooting and recovery

if configuration software process terminates abnormally

if JavaVM terminates abnormally

if problem occurs in EJB client

If problem occurs in JPA application

if problem occurs in the system linked with JP1

if problem occurs when using database session failover function

if problem occurs when using memory session failover function

troubleshooting during operations

troubleshooting during setup

troubleshooting procedure

troubleshooting server management commands

troubleshooting when process is down

troubleshooting when response is delayed

type of required data

types of data uesd for troubleshooting

(U)

unused objects statistical functionality in tenured area

user definition file to set output destination of log

user definition file to set output destination of log

user log

user log

USRCONF_JVM_ARGS

(V)

vbroker.orb.htc.comt.entryCount

vbroker.orb.htc.comt.entryCount

vbroker.orb.htc.comt.entryCount

vbroker.orb.htc.comt.fileCount

vbroker.orb.htc.comt.fileCount

vbroker.orb.htc.tracePath

vbroker.orb.htc.tracePath

vbroker.orb.htc.tracePath

vbroker.orb.htc.tracePath

vbroker.orb.htc.comt.fileCount

(W)

webserver.logger.access_log.format_list

webserver.logger.access_log.<format-name>

webserver.logger.access_log.inprocess_http.enabled

webserver.logger.access_log.inprocess_http.filename

webserver.logger.access_log.inprocess_http.filenum

webserver.logger.access_log.inprocess_http.filesize

webserver.logger.access_log.inprocess_http.usage_format

webserver.logger.communication_trace.inprocess_http.filenum

webserver.logger.thread_trace.inprocess_http.filenum

Web server log

when error occurs in EADs session failover functionality

when using asynchronous concurrent processing for threads

work directroy

Working of user-extended trace based performance analysis

Wraparound mode

Trademarks

Active Directory is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
AIX is a trademark of International Business Machines Corporation in the United States, other countries, or both.
AMD is a trademark of Advanced Micro Devices, Inc.
AX2000 is a product name of A10 Networks, Inc.
F5, F5 Networks, BIG-IP and iControl are trademarks or registered trademarks of F5 Networks, Inc. in the U.S. and certain other countries.
BSAFE is a registered trademark or a trademark of EMC Corporation in the United States and/or other countries.
CORBA is a registered trademark of Object Management Group, Inc. in the United States.
HP-UX is a product name of Hewlett-Packard Development Company, L.P. in the U.S. and other countries.
Intel is a trademark of Intel Corporation in the U.S. and/or other countries.
Internet Explorer is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
JBoss and Hibernate are the registered trademarks of Red Hat, Inc.
Linux(R) is the registered trademark of Linus Torvalds in the U.S. and other countries.
Microsoft is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
Microsoft Office and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Mozilla is a trademark of the Mozilla Foundation in the U.S and other countries.
OMG, CORBA, IIOP, UML, Unified Modeling Language, MDA, Model Driven Architecture are either registered trademarks or trademarks of Object Management Group, Inc. in the United States and/or other countries.
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Red Hat is a trademark or a registered trademark of Red Hat Inc. in the United States and/or other countries.
RSA is a registered trademark or a trademark of EMC Corporation in the United States and/or other countries.
SOAP is an XML-based protocol for sending messages and making remote procedure calls in a distributed environment.
SQL Server is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
UNIX is a registered trademark of The Open Group in the United States and other countries.
VMware and vCenter Server are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions.
Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Windows NT is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
X/Open is a registered trademark of The Open Group in the U.K. and other countries.
Eclipse is an open development platform for tools integration provided by Eclipse Foundation, Inc., an open source community for development tool providers.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
The other company names and product names are either trademarks or registered trademarks of the respective companies. Throughout this document Hitachi has attempted to distinguish trademarks from descriptive terms by writing the name with the capitalization used by the manufacturer, or by writing the name with initial capital letters. Hitachi cannot attest to the accuracy of this information. Use of a trademark in this document should not be regarded as affecting the validity of the trademark.