7.4.7 Maintenance log and trace
Capture the log and trace for maintenance as information required for failure investigation.
- Organization of this subsection
(1) Exception log
The internal error information and the failure information of the business process when there is a failure while operating HCSC server is captured as exception log. Maintenance Service uses the exception log for analyzing the failure. The following table describes the contents output as exception log of Service Platform and the output destination:
|
Type of exception log |
Output contents |
Output destination path of exception log file |
Log file name |
|---|---|---|---|
|
Exception log of HCSC-Manager |
Acquires the internal exception information of HCSC-Manager. |
Path specified in cscmng.log.dir parameter of HCSC-Manager definition file#1 |
exception<number of files>.log#1 |
|
Exception information when a J2EE server failure occurs |
Acquires the internal exception information when a failure has occurred in the HCSC server. |
Path specified in the output destination #2 of exception log of J2EE server (exception information at the time of failure occurrence) |
|
|
Exception log of HCSC server |
Acquires the information of the exception (stack trace) that has occurred at the following locations:
|
Path specified in the methodtrace-filepath property of the HCSC server runtime definition file#3 |
|
|
Exception log of DB adapter |
Acquires the stack trace when a failure has occurred in DBadapter |
Path specified in the methodtrace-filepath property of the HCSC server runtime definition file#3 |
|
|
Exception log of TP1 adapter |
Acquires the stack trace when a failure has occurred in TP1 adapter |
<Log output directory of J2EE server>\CSCADP\TP1ADP\maintenance\<Service ID> |
|
|
Exception log of Object Access adapter |
Acquires the stack trace when a failure has occurred in Object Access adapter |
<Log output directory of J2EE server>\CSCADP\OAADP\maintenance\<Service ID> |
|
|
Exception log of Message Queue adapter |
Acquires the stack trace when a failure has occurred in Message Queue adapter |
<Log output directory of J2EE server>\CSCADP\MQADP\maintenance\<Service ID> |
|
|
Exception log of FTP adapter |
Acquires the stack trace when a failure has occurred in FTP adapter |
Path specified in FTP adapter runtime-environment property file#7 |
|
|
Exception log of file operations adapter |
Acquires the stack trace when a failure has occurred in file operations adapter |
<Log output directory of J2EE server>\CSCADP\ADPFOP\maintenance\<Service ID> |
|
|
Exception log of mail adapter |
Acquires the stack trace when a failure has occurred in mail adapter |
Path specified in mail adapter runtime-environment property file#9 |
|
|
Exception log for the HTTP adapter |
Stack traces are collected to this log if a failure occurs in the HTTP adapter. |
>\CSCADP\ADPHTTP\maintenance\<Service ID> in the path specified for the adphttp.config.trace.path property#10 |
|
|
Exception log for the command adapter |
Stack traces are collected to this log if a failure occurs in the command adapter. |
<Log output directory of J2EE server>\CSCADP\ADPCMD\maintenance\<Service ID> |
|
|
Exception log for the SFTP adapter |
Stack traces are collected to this log if a failure occurs in the SFTP adapter. |
<Log output directory of J2EE server>\CSCADP\SFTPADP\maintenance\<Service ID> |
|
|
Exception log of business process |
Acquires the stack trace when a failure has occurred in business process |
Path specified in the methodtrace-filepath property of the HCSC server runtime definition file#3 |
|
- Note#1
-
Specify the following parameters in the HCSC-Manager definition file:
cscmng.log.exception.filesize=Exception log file size
cscmng.log.exception.filenum= Exception log file numbers
cscmng.log.dir= Exception log output destination directory path
For details on the HCSC-Manager definition file, see 6.5.3 HCSC-Manager definition file in the manual Service Platform Reference Guide.
- Note#2
-
Specify the output destination of exception log (exception information when a failure occurs) of J2EE server to usrconf.cfg (option definition file for J2EE server). Default output destination is<Installation directory of Service Platform>\CC\server\public\ejb\<J2EE server name>\logs.
For details on usrconf.cfg,see 2.2.2 usrconf.cfg (Option definition file for J2EE servers) in the manual Application Server Definition Reference Guide.
Specify the size and number of exception log files in usrconf.properties (user property file for J2EE server). For details about usrconf.properties, see the following sections: 2.2.3 usrconf.properties (User property file for J2EE servers) in the manual Application Server Definition Reference Guide or 11.1.1 usrconf.properties (User property file for J2EE servers) in the manual uCosminexus Application Server Compatibility Guide. For the details on settings of the rotation method of log files, see the manual Application Server Definition Reference Guide.
- Note#3
-
For details on the specification of output destination path and numbers of the HCSC server runtime definition file, see 6.5.6 HCSC server runtime definition file in the manual Service Platform Reference Guide.
- Note#4
-
For details on the specification of numbers of the TP1-adapter runtime-environment property file TP1, see 6.7.1 TP1-adapter runtime-environment property file in the manual Service Platform Reference Guide.
- Note#5
-
For details on the specification of numbers of the Object Access adapter runtime-environment property file, see 6.11.1 Object Access adapter runtime-environment property file in the manual Service Platform Reference Guide.
- Note#6
-
For details on the specification of numbers of the Message Queue adapter runtime-environment property file, see 6.12.1 Message Queue adapter runtime-environment property file in the manual Service Platform Reference Guide.
- Note#7
-
Exception log files are output to the same directory that is used for the maintenance log. For details on the output destination path and numbers of the FTP-adapter runtime-environment property file, see 6.8.3 FTP-adapter runtime-environment property file in the manual Service Platform Reference Guide.
- Note#8
-
Exception log files are output to the same directory that is used for the maintenance log. For details on the numbers of File operations adapter runtime-environment property file, see 6.8.7 File operations adapter runtime-environment property file in the manual Service Platform Reference Guide.
- Note#9
-
Exception log files are output to the same directory that is used for the maintenance log. For details on the output destination path and numbers of the Mail adapter runtime environment property file, see 6.13.3 Mail adapter runtime environment property file in the manual Service Platform Reference Guide.
- Note#10
-
Exception log files are output to the same directory that is used for the maintenance log. For details about how to specify the output destination path and the number of log files in the HTTP-adapter runtime-environment property file, see 6.14.1 HTTP-adapter runtime-environment property file in the manual Service Platform Reference Guide.
- Note#11
-
Exception log files are output to the same directory that is used for the maintenance log. For details about how to specify the number of log files in the command-adapter runtime-environment properties file, see 6.15.3 Command-adapter runtime-environment properties file in the manual Service Platform Reference Guide.
- Note#12
-
Exception log files are output to the same directory that is used for the maintenance log. For details about how to specify the number of log files in the SFTP-adapter runtime-environment properties file, see 6.16.1 SFTP-adapter runtime-environment properties file in the manual Service Platform Reference Guide.
(2) Maintenance log
You can acquire the internal maintenance information of the HCSC-Manager internal as a maintenance log. The maintenance log is also used as a communication trace and message log between HCSC-Manager and external elements (such as Manager, HCSC management MBean, and the repository). The Maintenance Service uses the maintenance log for analyzing failures.
The following table lists and describes the content and the output destination that is output as the maintenance log:
|
Output content |
Output destination path of the Maintenance log file |
Log file name |
|---|---|---|
|
Acquire the internal maintenance information of HCSC-Manager |
Path specified in the cscmng.log.dir parameter of the HCSC-Manager definition file |
maintenance<number of files>.log |
(3) Method trace
If a failure occurs on a HCSC server and the cause is difficult to determine, you can acquire the required information as method trace. The Maintenance Service uses the method trace for analyzing failures.
The following table describes the output content and output destination of method traces.
|
Method trace type |
Output content |
Output destination path of method trace |
Trace file name |
|---|---|---|---|
|
Method trace of HCSC server (messaging infrastructure) |
Acquires the internal maintenance information of the HCSC server (messaging infrastructure). |
Path specified in the methodtrace-filepath property of the HCSC server runtime-definition file. If the specified path does not exist, or if there is an error in the path, trace is output in the output destination of the omitted value. |
|
|
Method trace of the HCSC server(business process infrastructure) |
Acquires the internal maintenance information of the HCSC server(business process infrastructure). In the business process infrastructure, a trace is present when executing the trace and process instance related commands, when you execute the business process. This manual describes the trace when executing business processes. The trace at the time of executing process instance related commands is same as the trace output in Management Server. For details, see "Application Server Maintenance and Migration Guide". |
|
|
|
Method trace of the HCSC server (DB adapter) |
Acquires the internal maintenance information of the HCSC server (DB adapter). For details on the method trace of a service adapter other than DB adapter, see the description of each service adapter in "7.7 Troubleshooting during service component invocation request". |
|