7.7.18 Troubleshooting when the SFTP adapter is executed

The types of failure information related to the SFTP adapter are as follows:

Message log
Maintenance log
Performance analysis trace
SFTP protocol trace
Exception log
Message log for user-authentication information management commands

The following describes the preceding types of failure information.

Organization of this subsection

(1) Message log
(2) Maintenance log
(3) Performance analysis trace
(4) SFTP protocol trace
(5) Exception log
(6) Message log for user-authentication information management commands

(1) Message log

For details about the output items and output destination of message log data, see 7.4.1 Message log.

To Page Top

(2) Maintenance log

The following describes the maintenance log for the SFTP adapter.

Output format of maintenance log data

The following figure shows the output format of maintenance log data.

Figure 7‒131: Output format of maintenance log data (for the SFTP adapter)

Output items

The following table shows the items of data that is output to the maintenance log.

Table 7‒170: Items of data output to the maintenance log (for the SFTP adapter)
Item	Contents
Number	The sequence number of each maintenance log record is output.
Date	The date on which the maintenance log record was collected is output in `YYYY/MM/DD` format.
Time	The time at which the maintenance log record was collected is output in `hh:mm:ss.SSS` format.
Product ID	The string `SFTPADP`, which indicates the SFTP adapter, is output as a product identifier. Version information is also output.
pid	The identifier of each process is output.
tid	The identifier of each thread is output.
ID and type	These items are not output.
Output type	The information about the point (position) from which the maintenance log record was collected is output: `BGN`: Beginning of a method `END`: End of a method `CAL`: Calling of a method `RET`: Return of a method `THR`: Throwing of an exception `CTH`: Catching of an exception `DBG`: Debug information
Class name	The name of the class that contains the method for which maintenance log data was collected is output.
Method name	The name of the class that contains the method for which maintenance log data was collected is output.
I/O information	The I/O information (such as argument values, the return value, and the exception name) for the method for which maintenance log data was collected is output.
CRLF	The record end code is output.

Output destination of maintenance log data

log-data-output-directory-on-the-J2EE-server\CSCADP\SFTPADP\maintenance\service-ID

The following table shows the log file name of the maintenance log.

Table 7‒171: Log file name of the maintenance log (for the SFTP adapter)
Log file output mode	Log file name
Wraparound mode	`cscsftpadpmtd_HCSC-server-name_N.log`
Shift mode	`cscsftpadpmtd_HCSC-server-name_.log`

You can specify the number of log files by using the sftpadp.methodtrace.filenum property in the SFTP-adapter runtime-environment properties file. You can specify the log file size by using the sftpadp.methodtrace.filesize property in the SFTP-adapter runtime-environment properties file.

For details about the SFTP-adapter runtime-environment properties file, see 6.16.1 SFTP-adapter runtime-environment properties file in the manual Service Platform Reference Guide.

To Page Top

(3) Performance analysis trace

Before you can collect performance analysis traces, you must specify the necessary settings. For details about the necessary settings, see 7. Performance Analysis by Using Trace Based Performance Analysis in the Application Server Maintenance and Migration Guide.

(a) Output format of performance analysis traces

Performance analysis traces are output to files that are in the same format as the performance analysis trace files for the J2EE server. For details, see 7.3 Collecting the trace based performance analysis file by using Management Server in the Application Server Maintenance and Migration Guide.

(b) Output items

The following table shows the items of data that is output to performance analysis trace files.

Table 7‒172: Items of data that is output to performance analysis trace files (for the SFTP adapter)
Item		Contents
Event ID		The event ID of a collection point is output. For details about collection points, see (c) Collection points for performance analysis traces.
Return code		The collection point type is output: `0`: Normal termination `1`: Abnormal termination
Interface name		The class name is output.
Operation name		The method name is output.
Optional information	Service ID	The service ID of the HCSC component is output.
	Operation	One of the following strings is output: PUT GET GETINFO
	SFTP command name	`cd`, `get`, `ls`, or another command name is output.
	Transfer file name or path	For the `PUT` operation, a local file name is output. For the `GET` operation, a remote file name is output. For the `GETINFO` operation, remote path is output.
	Transfer size	The size of a transfer file is output in bytes. This item is not output for pre-transfer and post-transfer commands and for the `GETINFO` operation.
	Number of nanoseconds from a certain point of time	The value returned by the `nanoTime` method of the `java.lang.System` class is output.
	Exception class name	The name of a class in which an exception occurred is output.

(c) Collection points for performance analysis traces

The following figure shows the collection points for performance analysis traces.

Figure 7‒132: Collection points for performance analysis traces (for the SFTP adapter)

The following table lists event IDs, trace collection points, and collection levels of performance analysis traces. The numbers in the Number in figure column correspond to the circled numbers in the preceding figure.

Table 7‒173: Collection points for performance analysis traces (for the SFTP adapter)
Event ID	Number in figure	Trace collection point	Level
0xAB0A	1	When a request is received	B
0xAB0C	2	When an SFTP command (other than transfer and list commands) is executed	A
0xAB0D	3	When a reply to an SFTP command (other than transfer and list commands) is returned	A
0xAB0E	4	When a transfer or list command is executed	A
0xAB0F	5	When a reply to a transfer or list command is returned	A
0xAB0B	6	When a response is sent	B

Legend:

A: Indicates the Standard level.

B: Indicates the Advance level.

To Page Top

(4) SFTP protocol trace

SFTP protocol traces are the traces of SFTP communication between the SFTP adapter and SFTP server. Output of SFTP protocol traces cannot be disabled. These traces provide the information about the following operations:

Connection to the SFTP server
Pre-transfer command
Transfer command
Post-transfer command
Disconnection from the SFTP server

The following describes SFTP protocol traces.

(a) Output format

The following figure shows the output format of SFTP protocol traces.

Figure 7‒133: Output format of SFTP protocol traces

(b) Output items

The following table shows the items of data that is output in SFTP protocol traces.

Table 7‒174: Items of data that is output in SFTP protocol traces
Item	Contents
Number	The sequence number of each SFTP protocol trace is output.
Date	The date on which the SFTP protocol trace was collected is output in `YYYY/MM/DD` format.
Time	The time at which the SFTP protocol trace was collected is output in `hh:mm:ss.SSS` format.
Product ID	The string `SFTPADP`, which indicates the SFTP adapter, is output as a product identifier.
pid	The identifier of each process is output.
tid	The identifier of each thread is output.
ID	This item is not output.
Type	The type of the SFTP protocol trace is output: `CON`: Connection or disconnection `CMD`: Command execution `REP`: Reply line `EXP`: Error response line (output only if an abnormal termination occurs)
Request ID	A request ID that was created by the reception is output. If a common folder is used, no request ID is created. In this case, four asterisks `(****`) are output. An IPv4-based request ID is a maximum of 49 characters long, including halfwidth spaces that are embedded at the end.
Trace information	The following SFTP protocol trace information is output: If the type is `CON` For connection: `Connected` `to` `destination` `Port` `port-number` For disconnection: `Disconnected` `to` `destination` `Port` `port-number` If the type is `CMD` SFTP command and arguments If the type is `REP` `command-name` `command` `successful` If the type is `EXP` Error message
CRLF	The record end code is output.

(c) Output destination

The output destination of SFTP protocol traces is as follows:

log-data-output-directory-on-the-J2EE-server\CSCADP\SFTPADP\service-ID

The following table shows the trace file name of SFTP protocol traces.

Table 7‒175: Trace file name of SFTP protocol traces
Trace file output mode	Trace file name
Wraparound mode	`sftpprotocoltrace_N.log`
Shift mode	`sftpprotocoltrace_.log`

You can specify log-data-output-directory-on-the-J2EE-server by using the ejb.server.log.directory key in the option definition file (usrconf.cfg) for the J2EE server on which the HCSC server operates. For details about the usrconf.cfg file, see 2.2.2 usrconf.cfg (Option definition file for J2EE servers) in the manual Application Server Definition Reference Guide.

You can specify the number of trace files by using the sftpadp.sftpprotocoltrace.filenum property in the SFTP-adapter runtime-environment properties file. You can specify the trace file size by using the sftpadp.sftpprotocoltrace.filesize property in the SFTP-adapter runtime-environment properties file.

For details, see 6.16.1 SFTP-adapter runtime-environment properties file in the manual Service Platform Reference Guide.

To Page Top

(5) Exception log

The information about exceptions that occur after the tracing starts (stack traces) is output separately to files as the exception log. For the exception log, you can set the output file size and the number of output files but cannot set the output file path and output level. Exception log files are output to the same directory that is used for the maintenance log.

The following describes the exception log for the SFTP adapter.

(a) Output format

The following figure shows the format of data that is output to the exception log.

Figure 7‒134: Format of data that is output to the exception log

(b) Output items

The following table shows the items of data that is output to the exception log.

Table 7‒176: Items of data that is output to the exception log (for the SFTP adapter)
Item	Contents
Number	The sequence number of each exception log record is output.
Date	The date on which the exception log record was collected is output in `YYYY/MM/DD` format.
Time	The time at which the exception log record was collected is output in `hh:mm:ss.SSS` format.
Product ID	The string `SFTPADP`, which indicates the SFTP adapter, is output as a product identifier.
pid	The identifier of each process is output.
tid	The identifier of each thread is output.
ID	Blank
Stack trace information	Stack trace information is output.
CRLF	The record end code is output.

(c) Output destination

The output destination of exception log data is as follows. This output destination has the same path as the maintenance log.

log-data-output-directory-on-the-J2EE-server\CSCADP\SFTPADP\maintenance\service-ID

The following table shows the log file name of the exception log.

Table 7‒177: Log file name of the exception log
Log file output mode	Log file name
Wraparound mode	`cscsftpadpexp_HCSC-server-name_N.log`
Shift mode	`cscsftpadpexp_HCSC-server-name_.log`

You can specify the number of log files by using the sftpadp.exptrace.filenum property in the SFTP-adapter runtime-environment properties file. You can specify the log file size by using the sftpadp.exptrace.filesize property in the SFTP-adapter runtime-environment properties file.

For details about the SFTP-adapter runtime-environment properties file, see 6.16.1 SFTP-adapter runtime-environment properties file in the manual Service Platform Reference Guide.

To Page Top

(6) Message log for user-authentication information management commands

The runtime information (such as cautions and errors) for user-authentication information management commands is output in the form of messages to the message log for user-authentication information management commands. You can use this log to view the information about failures and operations for the commands that were executed in the past.

For details about the message log for user-authentication information management commands, see 7.4.8 Message log for user-authentication information management commands.

To Page Top