uCosminexus Service Platform, Reception and Adapter Definition Guide

[Contents][Glossary][Index][Back][Next]

Appendix A.8 Acquiring the failure information (Custom reception)

If an error occurs during operation of a custom reception, the following information is output for troubleshooting purposes:

This section describes how to acquire this log data and trace information.

Organization of this subsection
(1) Message log data (custom reception)
(2) Request trace information (custom reception)
(3) Performance analysis trace information (custom reception)
(4) User message trace (custom reception)

(1) Message log data (custom reception)

Message log data is output to the following logs:

For details on how to acquire message log data and its output destination, see 7.4.1 Message log in the manual Service Platform Setup and Operation Guide. For further details, see Chapter 2. List of Messages in the manual Service Platform Messages.

(2) Request trace information (custom reception)

You can use request trace information to analyze the cause of an error in a request.

(a) Request trace information collection points

The following figure shows the collection points for request trace information:

Figure A-11 Request trace information collection points

[Figure]

The table below describes each trace information collection point and its detailed location. The number in the leftmost column of the table corresponds to the number in the figure.

Table A-5 Request trace collection points

Number in figure Detailed location Trace collection point
1 IN Entry point of custom reception framework
2 OUT Exit point of custom reception framework
(b) Format and contents of request trace output

Output format
For details on the output format of request trace information, see 7.4.2 Request trace in the manual Service Platform Setup and Operation Guide.

Output contents
The following table lists the items output in request trace information.

Table A-6 Items output in request trace information

Item Description
No. The output serial number of the trace record
Date The date on which the trace record was acquired, in the format yyyy/mm/dd
Time The time at which the trace record was acquired in local time, in the format hh:mm:ss.sss
Product ID An ID that identifies the product.
  • CSCMSG: Messaging infrastructure
pid An ID that identifies the process
tid An ID that identifies the thread
ID --
Common message ID Information that identifies the request (parent ID)
Service requester ID Information that identifies the request (child ID)
Collection point identification information Collection point Information about the collection point of the trace information.
  • URCP: User-defined reception
Protocol type Information about the collection point of the trace information (protocol type).
  • CUSTM: Custom reception
Detailed location Information about the collection point of the trace information (detailed location).
  • IN: Reception
  • OUT: Response
Name --
Adapter type --
Result Outputs the response result type. This item is not output when the detailed location is IN.
  • NORMAL: Normal termination
  • ERROR: Abnormal termination
Additional information Outputs the information appended to the response result.
  • Reception name
  • Reception ID
  • Client correlation ID
  • Service name
  • Service operation name
CRLF The end of record code

Legend:
--: Nothing is output.

(c) Method of request trace information collection and output destination of request traces

For details on how to collect request trace information and the output destination of request trace information, see 7.4.2 Request trace in the manual Service Platform Setup and Operation Guide.

(3) Performance analysis trace information (custom reception)

A performance analysis trace (PRF trace) is information that can be used to analyze the performance of the Service Platform system. A performance analysis trace file is a text file containing this information in CSV format. Performance analysis trace information is useful for analyzing performance bottlenecks across the entire system, including J2EE applications. You can use it to identify and troubleshoot performance issues. For details on the performance analysis trace functionality, see Chapter 7. Performance Analysis by Using Trace based Performance Analysis in the manual Application Server Maintenance and Migration Guide.

(a) Trace information collection points

The following figure shows the collection points for performance analysis trace information.

Figure A-12 Collection points for performance analysis trace information

[Figure]

The table below shows the event IDs, trace information collection points, and performance analysis trace information collection levels. The number in the Number in figure column of the table corresponds to the number in the figure.

Table A-7 Collection points of performance analysis trace information

Event ID Number in figure Trace information collection point Level
0x9860 1 Entry point of custom reception framework A
0x9861 2 Exit point of custom reception framework A
0x9862 3 Invocation of data transformation (request message) B
0x9863 4 Reception of data transformation response (request message) B
0x9864 5 Invocation of HCSC message delivery control A
0x9865 6 Reception of HCSC message delivery control response A
0x9866 7 Invocation of data transformation (response message) B
0x9867 8 Reception of data transformation response (response message) B

Legend:
A: Indicates that the acquisition level is Standard.
B: Indicates that the acquisition level is Detailed.

(b) Format and contents of performance analysis trace information output

Output format
The output format of the performance analysis trace file is the same as that of a performance analysis trace for a J2EE server. For details on performance analysis trace files, see 7.3 Collecting the trace based performance analysis file by using Management Server in the manual Application Server Maintenance and Migration Guide.

Output contents
The following table lists the information output in a performance analysis trace file.

Table A-8 Information output to a performance analysis trace file

Item Description
Event ID The event ID associated with the collection point
Return code The collection point type.
  • 0: Normal termination.
  • 1: Abnormal termination.
Interface name The class name is output.
The package name is not shown.
Operation name The method name
Optional information The following optional information is output:
  • Request ID information (parent ID)
  • Request ID information (child ID)
  • Reception name
  • Reception ID
  • Client correlation ID
  • Service name
  • Service operation name
  • Exception class name (abnormal termination only)
(c) Method of performance analysis trace information collection and output destination of request trace information

The acquisition method and output destination for performance analysis trace files is common to the entire Service Platform. For details, see 7.3 Collecting the trace based performance analysis file by using Management Server in the manual Application Server Maintenance and Migration Guide.

(4) User message trace (custom reception)

You can use user message trace information to check the status of a message.

(a) User message trace information collection points

The following figure shows the collection points for user message trace information.

Figure A-13 User message trace information collection points

[Figure]

The table below shows the detailed location and collection points for user message trace information. The number in the leftmost column of the table corresponds to the number in the figure.

Table A-9 User message trace information collection points

Number in figure Detailed location Trace collection point
1 IN Entry point of custom reception framework
2 OUT Exit point of custom reception framework
3 RQA#1 Response to data transformation (request message)
4 RSB#1 Invocation of data transformation (response message)
5 ERR#2 Service invocation of custom reception framework

#1
Trace information is acquired only if the message is subject to data transformation.

#2
Request message trace information is acquired only if an error (system exception or fault) is detected in the service invocation.

(b) Format and contents of performance user message trace information output

Output format
For details on the output format of user message trace information, see 7.4.4 User message trace in the manual Service Platform Setup and Operation Guide.

Output contents
The following table lists the items output in user message trace information.

Table A-10 Items output in user message trace information (trace start)

Item Description
No. The output serial number of the trace record
Date The date on which the trace record was acquired, in the format yyyy/mm/dd
Time The time at which the trace record was acquired in local time, in the format hh:mm:ss.sss
Product ID An ID that identifies the product.
  • CSCMSG: Messaging infrastructure
pid An ID that identifies the process
tid An ID that identifies the thread
ID --
Collection point identification information for message trace start Message trace start The string telegramtrace started which indicates the start of the user message trace is output.
Collection point Information about the collection point of the trace information.
  • URCP: User-defined reception
Protocol type Information about the collection point of the trace information (protocol type).
  • CUSTM: Custom reception
Detailed location Information about the collection point of the trace information (detailed location).
  • IN: Reception
  • OUT: Response
  • RQA: After data transformation of request in custom reception
  • RSB: Before data transformation of response in custom reception
Common message ID Information that identifies the request (parent ID)
Additional information The following additional information is output:
  • Request ID information (child ID) (Service Request ID)
  • Reception name
  • Reception ID
  • Client correlation ID (Client ID)
  • Service name
  • Service operation name (OP)
  • PRF root application information (RootApInfo)
CRLF The end of record code

Legend:
--: Nothing is output.

Table A-11 Items output in user message trace information (trace data)

Item Description
No. The output serial number of the trace record
Date The date on which the trace record was acquired, in the format yyyy/mm/dd
Time The time at which the trace record was acquired in local time, in the format hh:mm:ss.sss
Product ID An ID that identifies the product.
  • CSCMSG: Messaging infrastructure
pid An ID that identifies the process
tid An ID that identifies the thread
ID --
Message trace data Output position The offset (hexadecimal format) from the start of the user message is output.
Data
(hexadecimal format)
The content of the user message (hexadecimal format) is output.
Data
(ASCII format)
The content of the user message (ASCII format) is output.
ASCII characters are output for characters in the range from 0x20 to 0x7E.
Periods (.) are output for values outside this range.
CRLF The end of record code

Legend:
--: Nothing is output.

Table A-12 Items output in user message trace information (trace end)

Item Description
No. The output serial number of the trace record
Date The date on which the trace record was acquired, in the format yyyy/mm/dd
Time The time at which the trace record was acquired in local time, in the format hh:mm:ss.sss
Product ID An ID that identifies the product.
  • CSCMSG: Messaging infrastructure
pid An ID that identifies the process
tid An ID that identifies the thread
ID --
Collection point identification information for message trace end Message trace end The string telegramtrace sended which indicates the end of the user message trace is output.
Collection point Information about the collection point of the trace information.
  • URCP: User-defined reception
Protocol type Information about the collection point of the trace information (protocol type).
  • CUSTM: Custom reception
Detailed location Information about the collection point of the trace information (detailed location).
  • IN: Reception
  • OUT: Response
  • RQA: After data transformation of request in custom reception
  • RSB: Before data transformation of response in custom reception
Common message ID Information that identifies the request (parent ID)
Additional information The length of the user message (decimal format) is output. If there is no user message, null is output.
CRLF The end of record code

Legend:
--: Nothing is output.

(c) Method of user message trace information collection and output destination of user message trace information

For details on the collection method and output destination of user message trace information, see 7.4.4 User message trace in the manual Service Platform Setup and Operation Guide.