uCosminexus Service Platform, Setup and Operation Guide
You can acquire the following contents as user message trace in messaging infrastructure of HCSC server:
The contents output in user message trace are configured from following three parts:
The description of each part is as follows:
The following figure shows the output format of user message trace start:
Figure 7-19 Figure Output format of user message trace start
The following table lists and describes contents output to user message trace start.
Table 7-36 Table Contents output to user message trace start
| Item | Content | |
|---|---|---|
| Number | The request identification information (parent ID) is displayed. | |
| Date | The trace record collection date (yyyy/mm/dd format) is output. | |
| Time | The trace record collection time (hh:mm:ss.sss format) in milliseconds in local time is output. | |
| Product ID | An identifier to identify the product is output.
|
|
| pid | The ID to identify the process is output. | |
| tid | The ID to identify the thread is output. | |
| ID | Not displayed. | |
| Message trace start collection point identification information | Message trace start | The character string "telegramtrace started" indicating the user message trace start is output. |
| Collection location | The trace collection point (collection location) is output:
|
|
| Protocol type | The trace collection point information (protocol type) is output.
|
|
| Detailed location | Outputs the trace collection point information (detailed location):
|
|
| Message common ID | The request identification information (parent ID) is output. | |
| Additional information | The following additional information is output:
|
|
| CRLF | Record end code is output. | |
The following figure shows the output format of the user message trace data:
Figure 7-20 Figure Output format of user message trace data
The following table lists and describes the information that is output to the user message trace data.
Table 7-37 Table Contents output to user message trace data
| Item | Content | |
|---|---|---|
| Number | The request identification information (parent ID) is displayed. | |
| Date | The trace record collection date (yyyy/mm/dd format) is output. | |
| Time | The trace record collection time (hh:mm:ss.sss format) in milliseconds in local time is output. | |
| Product ID | An identifier to specify the product is output.
|
|
| pid | The ID to identify the process is output. | |
| tid | The ID to identify the thread is output. | |
| ID | Not displayed. | |
| Message trace data information | Output position (Hexadecimal format) | Offset value (Hexadecimal format) from the beginning of the user message is output. |
| Data (Hexadecimal format) | Contents (Hexadecimal format) of user message are output. | |
| Data (ASCII format) | Contents (ASCII format) of user message are output. ASCII characters are output when the range is 0x20~0x7E. Period (.) is output if out of range. |
|
| CRLF | Record end code is output. | |
The following figure shows the output format of user message trace end:
Figure 7-21 Figure Output format of user message trace end
The following table lists and describes contents output to user message trace end:
Table 7-38 Table Contents output to user message trace end
| Item | Output | |
|---|---|---|
| Number | The request identification information (parent ID) is displayed. | |
| Date | The trace record collection date (yyyy/mm/dd format) is output. | |
| Time | The trace record collection time (hh:mm:ss.sss format) in milliseconds in local time is output. | |
| Product ID | An identifier to specify the product is output.
|
|
| Pid | The ID to identify the process is output. | |
| Tid | The ID to identify the thread is output. | |
| ID | Not displayed. | |
| Message trace end collection point identification information | Message trace end | The character string "telegramtrace ended" indicating user message trace end is output. |
| Collection location | The trace collection point (collection location) is output:
|
|
| Protocol type | The trace collection point information (protocol type) is output.
|
|
| Detailed location | Outputs the trace collection point information (detailed location):
|
|
| Message common ID | The request identification information (parent ID) is output. | |
| Additional information | The length (decimal format) of user message is output as additional information. When there is no user message, "0"or "null" is output. | |
| CRLF | Record end code is output. | |
Specify the timing of user message trace output in the telegramtrace-trigger property of the HCSC server runtime definition file. The following table lists and describes the output timings and combination with messages that can be specified with the telegramtrace-trigger property. Default timing in property is "NORMAL".
Table 7-39 Table Output timings and combination with messages that can be specified in the telegramtrace-trigger property
| Output timing | Timing | Message type | ||
|---|---|---|---|---|
| Request message | Response message | Fault message | ||
| NORMAL | At the time of normal processing | Y | Y | N |
| At the time of detecting system exceptions | N | N | N | |
| At the time of detecting faults (without catch) | N | N | N | |
| At the time of detecting faults (with catch) | N | N | N | |
| SYSERR | At the time of normal processing | N | N | N |
| At the time of detecting system exceptions | Y | N | N | |
| At the time of detecting faults (without catch) | Y | N | N | |
| At the time of detecting faults (with catch) | N | N | N | |
| FAULT | At the time of normal processing | N | N | N |
| At the time of detecting system exceptions | N | N | N | |
| At the time of detecting faults (without catch) | Y | N | Y | |
| At the time of detecting faults (with catch) | Y | N | Y | |
User message traces are output at the following times, and the trace collection point for each time is different:
The following figure shows the collection point of user message trace when executing individual services (when there is no data transformation):
Figure 7-22 Figure Collection point of user message trace (Executing individual services (when there is no data transformation))
The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure7-22 Collection point of user message trace (Executing individual services(when there is no data transformation))".
Table 7-40 Table User message trace collection point (Executing individual services (when there is no data transformation))
| Number in figure | Trace collection point |
|---|---|
| 1 | Entry to standard reception (Web Services) |
| 2 | Exit from standard reception (Web Services) |
| 1 | Entry to standard reception (SessionBean) |
| 2 | Exit from standard reception (SessionBean) |
| 1 | Entry to standard reception (MDB(WS-R)) |
| 2 | Exit from standard reception (MDB(WS-R)) |
| 1 | Entry to standard reception (MDB(DB queue)) |
| 2 | Exit from standard reception (MDB(DB queue)) |
| 3 | Invocation of service components of SOAP adapter |
| 4 | Point for receiving response from service components of SOAP adapter |
| 3 | Invocation of service components of SessionBean adapter |
| 4 | Point for receiving response from service components of SessionBean adapter |
| 3 | Invocation of service components of MDB (WS-R) adapter |
| 4 | Point for receiving response from service components of MDB (WS-R) adapter |
| 3 | Invocation of service components of MDB (DB queue) adapter |
| 4 | Point for receiving response from service components of MDB (DB queue) adapter |
| 3 | Invocation of service components of service adapters(CUSTOM) other than those mentioned above |
| 4 | Point for receiving response from service components of service adapters(CUSTOM) other than those mentioned above |
The following figure shows the trace collection point of user message trace when executing individual services (in case of data transformation):
Figure 7-23 Figure Collection point of user message trace (Executing individual services(in case of data transformation))
The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure7-23 Collection point of user message trace (Executing individual services (in case of data transformation))".
Table 7-41 Table User message trace collection point (executing individual services (in case of data transformation))
| Number in figure | Trace collection point |
|---|---|
| 1 | Entry to standard reception (Web Services) |
| 2 | Exit from standard reception (Web Services) |
| 1 | Entry to standard reception (SessionBean) |
| 2 | Exit from standard reception (SessionBean) |
| 1 | Entry to standard reception (MDB(WS-R)) |
| 2 | Exit from standard reception (MDB(WS-R)) |
| 1 | Entry to standard reception (MDB(DB queue)) |
| 2 | Exit from standard reception (MDB(DB queue)) |
| 3 | Before data transformation when defining the standard message definition of SOAP adapter |
| 4 | After data transformation when defining the standard message definition of SOAP adapter |
| 3 | Before data transformation when defining the standard message definition of SessionBean adapter |
| 4 | After data transformation when defining the standard message definition of SessionBean adapter |
| 3 | Before data transformation when defining the standard message definition of MDB (WS-R) adapter |
| 4 | After data transformation when defining the standard message definition of MDB (WS-R) adapter |
| 3 | Before data transformation when defining the standard message definition of MDB (DB queue) |
| 4 | After data transformation when defining the standard message definition of MDB (DB queue) |
| 3 | Before data transformation when defining the standard message definition of service adapter (CUSTOM) other than those mentioned above |
| 4 | After data transformation when defining the standard message definition of service adapter (CUSTOM) other than those mentioned above |
| 5 | Invocation of service components of SOAP adapter |
| 6 | Point for receiving response from service components of SOAP adapter |
| 5 | Invocation of service components of SessionBean adapter |
| 6 | Point for receiving response from service components of SessionBean adapter |
| 5 | Invocation of service components of MDB (WS-R) adapter |
| 6 | Point for receiving response from service components of MDB (WS-R) adapter |
| 5 | Invocation of service components of MDB (DB queue) adapter |
| 6 | Point for receiving response from service components of MDB (DB queue) adapter |
| 5 | Invocation of service components of service adapters(CUSTOM) other than those mentioned above |
| 6 | Point for receiving response from service components of service adapters(CUSTOM) other than those mentioned above |
The following figure shows the trace collection point of the user message trace when invoking business process:
Figure 7-24 Figure Collection point of user message trace(when invoking a business process)
The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure7-24 Collection point of user message trace (when invoking a business process)".
Table 7-42 Table User message trace collection point (when invoking a business process)
| Number in figure | Trace collection point |
|---|---|
| 1 | Entry to standard reception (Web Services) |
| 2 | Exit from standard reception (Web Services) |
| 1 | Entry to standard reception (SessionBean) |
| 2 | Exit from standard reception (SessionBean) |
| 1 | Entry to standard reception (MDB(WS-R)) |
| 2 | Exit from standard reception (MDB(WS-R)) |
| 1 | Entry to standard reception (MDB(DB queue)) |
| 2 | Exit from standard reception (MDB(DB queue)) |
| 1 | Entry to user-defined reception |
| 2 | Exit from user-defined reception |
| 3 | Invocation of business process services |
| 4 | Point for receiving response from business process services |
The following figure shows the trace collection point of the user message trace when executing business process services:
Figure 7-25 Figure Collection point of user message trace (when executing business process services)
The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure7-25 Collection point of user message trace (when executing business process services)".
Table 7-43 Table User message trace collection point (when executing business process services)
| Number in figure | Trace collection point |
|---|---|
| 1 | Entry to standard reception (Web Services) |
| 2 | Exit from standard reception (Web Services) |
| 1 | Entry to standard reception (SessionBean) |
| 2 | Exit from standard reception (SessionBean) |
| 1 | Entry to standard reception (MDB (WS-R)) |
| 2 | Exit from standard reception (MDB (WS-R)) |
| 1 | Entry to standard reception (MDB (DB queue)) |
| 2 | Exit from standard reception (MDB (DB queue)) |
| 1 | Entry to user-defined reception |
| 2 | Exit from user-defined reception |
| 7 | Invocation of service components of SOAP adapter |
| 8 | Point for receiving response from service components of SOAP adapter |
| 7 | Invocation of service components of SessionBean adapter |
| 8 | Point for receiving response from service components of SessionBean adapter |
| 7 | Invocation of service components of MDB (WS-R) adapter |
| 8 | Point for receiving response from service components of MDB (WS-R) adapter |
| 7 | Invocation of service components of MDB (DB queue) adapter |
| 8 | Point for receiving response from service components of MDB (DB queue) adapter |
| 7 | Invocation of service components of service adapters (CUSTOM) other than those mentioned above |
| 8 | Point for receiving response from service components of service adapters(CUSTOM) other than those mentioned above |
| 3 | Invocation of business process services |
| 4 | Point for receiving response from business process services |
| 5 | Entry to business process reception |
| 6 | Exit from business process reception |
| 9 | Transformation source of data transformation activity#1 |
| 10 | Transformation destination of data transformation activity |
| 11 | Copy source of assign activity#2,#3 |
| 12 | Copy destination of assign activity |
The following figure shows the trace collection point of the user message trace when a system exception (does not include system error such as OutOfMemoryError) is detected:
Figure 7-26 Figure Collection point of user message trace (At the time of detecting system exceptions)
The following table describes the trace collection point. The "Number in figure" in this table corresponds to the numbers in Figure 7-26.Furthermore, standby activity, switch activity, while activity, and link connection is output.
Table 7-44 Table User message trace collection point (At the time of detecting system exceptions)
| Number in figure | Output point | Output message | Details of user message trace start | ||
|---|---|---|---|---|---|
| Collection point | Protocol type | Detailed location | |||
| 1 | Request reception (when invoking a service) | Requester side message | RCP/URCP | SOAP/EJB/ WSR/DBQ/ CUSTM |
ERR |
| 2 | Invoke Java activity | Argument when invoking Java program#1 | BPJAV | - | |
| 3 | Invoke service activity | Request message when invoking services | BPSVC | ||
| 4 | Data transformation activity | Transformation source variable#2 | BPCNV | ||
| 5 | Assign activity | Copy source variable#3 | BPASG | ||
| 6 | Validation activity | Variable to be validated#2 | BPVLD | ||
| 7 | Reply activity | Response message to requester | BPRPL | ||
| 8 | Throw activity | Variable that throws faults | BPFLT | ||
The following figure shows the trace collection point of the user message trace when a fault is detected:
Figure 7-27 Figure Collection point of user message trace (at the time of detecting faults)
The following table describes the trace collection point. The "Number in figure" in this table corresponds to the numbers in Figure 7-27.
Table 7-45 Table User message trace collection point (at the time of detecting faults)
| Number in figure | Output point | Output message | Details of user message trace start | ||
|---|---|---|---|---|---|
| Collection point | Protocol type | Detailed location | |||
| 1 | Request reception (when invoking a service) | Request message | RCP/URCP | SOAP/EJB/ WSR/DBQ |
ERR |
| Fault message | - | ||||
| 2 | Invoke Java activity | Argument when invoking Java program#1 | BPJAV | ||
| Fault message | |||||
| 3 | Invoke service activity | Request message when invoking services | BPSVC | ||
| Fault message | |||||
| 4 | Validation activity | Variable to be validated#2 | BPVLD | ||
| Fault message | |||||
| 5 | Throw activity | Variable that throws faults#3 | BPFLT | ||
| 6 | Data transformation activity | Transformation source variable#2 | BPCNV | ||
| Fault message | |||||
| 7 | Assign activity | Copy source variable#4 | BPASG | ||
| Fault message | |||||
| 8 | Switch activity | Fault message | BPSWT | ||
Settings are required to acquire the user message trace. For details, see "7.3.1 How to acquire log or trace output by Cosminexus Service Platform".
The following is the output destination of the user message trace.
Path specified in telegramtrace-filepath property of the HCSC server runtime definition file.
Furthermore, 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.
The following table shows the trace file name of the user message trace:
| Output mode of trace file | Trace file name |
|---|---|
| For Wrap around mode | csctelegram_<HCSC server name>_<number of files>.log |
| For Shift mode | csctelegram_<HCSC server name>_.log |
All Rights Reserved. Copyright (C) 2015, Hitachi, Ltd.