User trace example

You can start, stop, and reset user trace to control tracing of an integration node or server. Use the mqsichangetrace command, the IBM® App Connect Enterprise web user interface, or the administrative REST API to control user trace.

Before you begin

Before you start to trace an integration server, the integration server must be running.

About this task

User trace enables you to trace activity in the integration server. User trace is written in plain text format; there is no need to format it before reading it.

To start user tracing of the integration server, use one of the following methods:
  • In the IBM App Connect Enterprise web user interface, navigate to the top level of the integration server, then select Start user trace from the menu at the top-right corner of the page.
  • Use the mqsichangetrace command.
  • Use the REST API provided by IBM App Connect Enterprise.
To stop user tracing of the integration server, use one of the following methods:
  • In the IBM App Connect Enterprise web user interface, navigate to the top level of the integration server, then select Stop user trace from the menu at the top-right corner of the page.
  • Use the mqsichangetrace command.
  • Use the REST API provided by IBM App Connect Enterprise.
To reset user tracing of the integration server, which results in any user trace data that has already been written to the user trace log files being erased, use one of the following methods:
  • In the IBM App Connect Enterprise web user interface, navigate to the top level of the integration server, then select Reset user trace from the menu at the top-right corner of the page.
  • Use the mqsichangetrace command.
  • Use the REST API provided by IBM App Connect Enterprise.

Trace logs:

For independent integration servers, the trace logs are written to workpath/config/common/log, where workpath is the work directory of the integration server as specified on the IntegrationServer command.

For integration servers that are managed by an integration node, the trace logs are written to MQSI_WORKPATH/Common/log/integration_node_name.integration_server_name.userTrace.0.txt

Example

The following example user trace shows a message that was received by an HTTPInput node being passed to a Mapping node and theMapping node starting to process the data:
2018-04-27 09:55:37.845248    12276  UserTrace   BIP3122I: Message received and propagated to 'out' 
terminal of HTTP input node 'Transformation_Map.HTTP Input'.
2018-04-27 09:55:37.845608    12276  UserTrace   BIP3904I: Invoking the evaluate() method of node 
(class=ComIbmMSLMappingNode, name=FCMComposite_1_3, label=Map).  About to pass a message to the 
evaluate() method of  the specified node.  No user action required.
2018-04-27 09:55:37.850016    12276  UserTrace   BIP3964I: The Mapping node 'Map' in message flow 
'Transformation_Map' is about to process the mapping routine '{default}:Transformation_Map'.  The Mapping 
node is about to process the named mapping routine.  Check the following messages to see the progression of 
the mapping process.
2018-04-27 09:55:37.851412    12276  UserTrace   BIP11306I: A Parser of type 'WSPROPERTYPARSER' has 
been created at address '0x248db510'. 
2018-04-27 09:55:37.851752    12276  UserTrace   BIP6060I: Node 'Transformation_Map.HTTP Input' used 
parser type 'Properties' to process a portion of the incoming message of length '0' bytes beginning at offset '0'.
2018-04-27 09:55:37.958100    12276  UserTrace   BIP4142I: Evaluating cniElementSetName. Changing value 
from 'Root' to 'LocalEnvironment'.  Element 'Name' has been changed to 'LocalEnvironment'.  No user action 
required. 
2018-04-27 09:55:37.980888    12276  UserTrace   BIP3963I: The Mapping node is performing a deep copy of 
the input tree element 'MbElement( type: 1000000 name: Properties )' into the output tree.  The Mapping node 
is copying the named input tree element, and all its descendents, into the output tree.  Check the following 
messages to see the progression of the mapping process.
2018-04-27 09:55:37.981508    12276  UserTrace   BIP4145I: Exiting function cniAddBefore with result: 
CCI_SUCCESS(0).  About to exit the specified the function with the specified result.  No user action required.
2018-04-27 09:55:37.984728    12276  UserTrace   BIP3960I: The Mapping node is adding a new element with 
name 'SaleEnvelopeA' into the output tree.  The Mapping node is adding a new element to the output tree, as 
defined in the transform that is being processed.  If this element is assigned a value, then this assignment will be 
reported in an additional message.  Check the following messages to see the progression of the mapping process.
2018-04-27 09:55:37.984864    12276  UserTrace   BIP11306I: A Parser of type 'XMLNSC' has been created at 
address '0x32c2490'.
2018-04-27 09:55:37.984932    12276  UserTrace   BIP4144I: Entered function 
cniCreateElementAsLastChild(TRUE, TRUE, N/A, N/A, N/A, N/A, N/A, N/A, N/A, N/A, N/A).  Entered the 
specified function with the specified parameters.  No user action required.
2018-04-27 09:55:37.984972    12276  UserTrace   BIP4145I: Exiting function cniCreateElementAsLastChild 
with result: CCI_SUCCESS(0).  About to exit the specified the function with the specified result.  No user action 
required.