7.7.7 Troubleshooting when executing file adapter

When failure occurs in the file adapter, information necessary for troubleshooting is output to log file and trace file. The following table lists type of logs and traces that you can acquire in the file adapter:

Table 7‒72: Type of logs/traces (For file adapter)
Log/trace	Output information	Description
Message log	Each type of information in file adapter is output as message.	You can check operation information (Start/Stop/Error) as message. You can check operational status of system in batch since the output destination of the message log is common for entire Application Server and Service Platform.
Method trace	The following information is output when you start or end an internal method of the file adapter: Date Time Execution class name Internal method name Exception occurred Information of specified argument	You can check the publication time and sequence of internal method.
Performance analysis trace (PRF trace)	The following information is output to the performance analysis trace collection point of the entire Application Server and Service Platform: Date Time Request information Trace collection source information The file adapter specific information is output in performance analysis trace collection point of file adapter.	You can validate the performance of Service Platform system on the basis of the performance analysis information output in the series of process starting from when you receive request from the service requester till the execution result is returned.

For details on points to be considered while outputting logs and traces, see "7.3.1(3) Notes on acquisition of log and trace data: General notes".

You can acquire the log and the trace of file adapter using the troubleshooting functionality of Application Server. The methods for acquiring logs and traces are as follows:

Use the management command (mngsvrutil).

For details, see "Application Server Command Reference Guide ".
Using the management portal

For details, see "Application Server Management Portal User Guide".
Using the snapshotlog command

For details, see "Application Server Command Reference Guide ".
Using the cprf command (Performance analysis trace only)

For details, see "Application Server Command Reference Guide ".

Furthermore, if you acquire trace of HCSC server, troubleshooting of the entire Application Server becomes easy. The following table describes trace information that you can acquire in HCSC server. For details, see contents regarding collection of failure information in "Application Server Maintenance and Migration Guide".

Table 7‒73: Trace information that you can acquire in HCSC server
Trace functionality	Description
Request trace	You can acquire information necessary to hold business process of requests received in standard reception, business process reception, or transfer reception between servers on messaging board, invocation destination of service adapter or its result.
Method trace	You can acquire method trace information provided by HCSC server.
Performance analysis trace	You can acquire information to analyze performance bottleneck of entire Application Server which includes J2EE application and entire Service Platform System

Organization of this subsection

(1) Failure handling
(2) Message log
(3) Method trace
(4) Performance analysis trace (PRF trace)

(1) Failure handling

When failure occurs in file adapter, exception is notified for the HCSC server excluding failure in stop process.

(a) Failure in start process

When start process of the file adapter fails, exception is notified to the HCSC server and process ends. Cause of failure in start process can be failure in analyzing file adapter execution environment property file.

Figure 7‒84: Failure in start process

(b) Failure in file control process

When failure in file control process of file adapter is detected, exception is notified to the HCSC server and process ends.

Figure 7‒85: Failure in file control process

(c) Failure in stop process

When failure in stop process of file adapter is detected, stop process is continued till process ends. Exception is not notified for HCSC server. However, when an unexpected failure occurs, in some cases exception is notified.

To Page Top

(2) Message log

You can acquire information of start and stop of service and error information at the time of failure as message log, you can detect occurrence of failure and analyze cause of failure.

(a) Output destination

Output destination of the message log is as follows:

Path specified in output destination of J2EE server operation log

Specify the output destination of J2EE server operation log in the ejb.server.log.directory key of option definition file (usrconf.cfg) for the J2EE server on which the HCSC server is running. For details, see "2.2.2 usrconf.cfg (Option definition file for J2EE servers)" and "2.2.3 usrconf.properties (User property file for J2EE servers)" in "Application Server Definition Reference Guide".

The following table lists log file name of message log:

Table 7‒74: Log file name of message log
Output mode of log file	Log file name
For wraparound mode	cjmessage<Count>.log^#
For shift mode	cjmessage.log^#

#: Log file is common across entire Application Server and Service Platform. Message log of operational information and failure information of all the products on The HCSC server is to be output.

(b) Number of files

Specify the count of output files in the ejbserver.logger.channels.define.<Channel name>.filenum key of the user property file(usrconf.properties) for J2EE server on which the HCSC server is running. For details, see "2.2.3 usrconf.properties (User property file for J2EE servers)" in "Application Server Definition Reference Guide" or "11.1.1 usrconf.properties (User property file for J2EE servers)" in "uCosminexus Application Server Compatibility Guide".

(c) File size

Specify the output file size in the ejbserver.logger.channels.define.<channel name>.filesize key of the user property file (usrconf.properties) for J2EE server on which the HCSC server is running. For details, see "2.2.3 usrconf.properties (User property file for J2EE servers)" in "Application Server Definition Reference Guide" or "11.1.1 usrconf.properties (User property file for J2EE servers)" in "uCosminexus Application Server Compatibility Guide".

To Page Top

(3) Method trace

You can validate the time and sequence of the internal method publication. Maintainance service uses method trace to analyze failure.

(a) Output destination

Output destination of method trace is as follows:

<Path specified in output destination of activity log of J2EE server>\CSCADP\FFADP\maintenance\<Service adapter name>

Specify the output destination of J2EE server operation log in the ejb.server.log.directory key of the option definition file (usrconf.cfg) for J2EE server on which the HCSC server is running. For details, see "2.2.2 usrconf.cfg (Option definition file for J2EE servers)" in "Application Server Definition Reference Guide".

The following table describes the trace file name of method trace.

Table 7‒75: Trace file name of method trace
Output mode of trace file name	Trace file name
For wraparound mode	mtdtrace<Count>.log
For shift mode	mtdtrace.log

(b) Number of files

The default number of output files is 4. You can change number of output files using the methodtracefile.num key of file adapter execution environment property file.

For details on how to change, see description for creating the file adapter execution environment property file in "3.3.7 Defining file adapters " in "Service Platform Reception and Adapter Definition Guide".

(c) File size

The default size of the output file is 4MB. You can change the size of the output file with methodtracefile.size of file adapter execution environment property file.

For details on how to change, see description for creating the file adapter execution environment property file of "3.3.7 Defining file adapters " in "Service Platform Reception and Adapter Definition Guide".

To Page Top

(4) Performance analysis trace (PRF trace)

You can validate the performance of Application Server and Service Platform system on the basis of the performance analysis information output in the series of processes starting from when you receive a request from the service requester till the execution result is returned. File adapter specific information is output in performance analysis trace collection point of file adapter. Maintainance Service uses the information to analyze performance bottlenecks.

(a) Output destination

The following table describes the output destination of performance analysis trace and trace file name.

Table 7‒76: Output destination of performance analysis trace and trace file name
Output destination path of trace	Trace file name
<Setting directory of environment variable PRFSPOOL>`\`utt`\`prf`\`<PRF Identifier>`\`dcopltrc^#	prf_<n>

Legend:: N: Enter integar from 001 to maximum value of number of files.
Note#: The output destination of performance analysis trace is common for entire Application Server and Service Platform. For details, see "7.3 Collecting the trace based performance analysis file by using Management Server" in "Application Server Maintenance and Migration Guide".

(b) Number of files

The default number of output files is 4. You can change the number of output files with the management portal or cprf command. For details on the management portal , see "Application Server Management Portal User Guide", For details on the cprf command, see "Application Server Command Reference Guide".

(c) File size

When file size is set in the management portal, the default file size is 32MB. When file size is set with the cprf command, the default file size is 8MB. You can change file size with the management portal of cprf command. For details on the management portal, see "Application Server Management Portal User Guide ", For details on the cprf command, see "Application Server Command Reference Guide".

(d) Output format

The format which is output to the performance analysis trace is same as the performance analysis trace of J2EE server. For details, see "7.3 Collecting the trace based performance analysis file by using Management Server" in "Application Server Maintenance and Migration Guide".

(e) Performance analysis trace collection point

In the performance analysis trace collection point of the file adapter, file adapter specific information is output.

Overview

The following figure shows the performance analysis trace collection point of the file adapter:

Figure 7‒86: Performance analysis trace collection point of the file adapter

A point specific event ID is assigned in collection point of the performance analysis trace. Trace event ID output to file adapter is 0xA000~0xA0FF. The following table describes event ID, trace collection point, and performance analysis trace collection level. "Numbers in the figure" in the table correspond to numbers in "Figure 7-86 Performance analysis trace collection point of the file adapter"

Table 7‒77: Performance analysis trace collection point
Event ID	Numbers in figure	Trace collection point	Level^#1
0xA000	1	At the time of request reception	Details
0xA002	2	When invoking file operation process	Standard
0xA003	3	When file operation process ends.^#2	Standard
0xA001	4	When sending response	Details

#1: For details on how to change level of performance analysis trace, see "Changing trace collection level", "Application Server Command Reference Guide", and "Application Server Maintenance and Migration Guide".
#2: Even when exception occurs during file operation process, trace collection point is same as when file operation process ends.

Changing trace collection level

When you change PRF trace collection level, specify hexadecimal value (8 digits) of 4 bytes in -PrfChangeLevel option of the cprflevel command. Index number (Index 1, Index 2) is assigned in their respective hexadecimal values. The following table describes specified location when acquiring trace information:

Table 7‒78: Specified location of trace collection level
Index	Digit	Upper layer	Lower layer
Index 1	1^st digit	Redirect	Web container
	2^nd digit	EJB container	JNDI
	3^rd digit	JTA	JCA container
	4^th digit	DB Connector	RMI
	5^th digit	Web Services - Base	TP1 Connector, TP1/Client/J
	6^th digit	TP1/Message Queue - Access	Reliable Messaging
	7^th digit	OTS	-
	8^th digit	CTM	-
Index 2	1^st digit	HCSC server	Standard output/standard error output/User log
	2^nd digit	DI	-
	3^rd digit^#	-	File adapter

Legend:: -: Not applicable.
#: When you change the trace collection level of the file adapter, value in lower layer of 3^rd digit of Index 2 changes. The following table describes specified value:

Table 7‒79: Specified value of trace collection level of file adapter
Specified value^#	Trace collection level
0	Standard
1	Details

Note#: Convert in hexadecimal when specifying in -PrfChangeLevel option.

For details on the cprflevel command, see in "Application Server Command Reference Guide".

To Page Top