IBM Support

Collecting "Service Level" Trace for an IIB Integration Server

How To


Summary

IBM Integration Bus (IIB) provides a trace facility for capturing runtime behavior.
Use this process to capture a "service level" trace of a particular Integration Server for the purpose of providing to IBM Support for analysis.

Steps

  1. Start trace:
    mqsichangetrace <Int.Node> -t -e <Int.Server> -l debug -r -c 200000 
  2. Recreate the runtime behavior or problem.
  3. Stop trace:
    mqsichangetrace <Int.Node> -t -e <Int.Server> -l none 
  4. Retrieve the trace log for the specified component:
    mqsireadlog <Int.Node> -t -e <Int.Server> -f -o <filename>.xml 
  5. Format the XML trace file:
    mqsiformatlog -i <filename>.xml -o <filename>.txt 
  1. Start trace:
    F <Int.Node>,ct t=yes, e='<Int.Server>', l='debug', r=yes, c=500000
  2. Recreate the runtime behavior or problem.
  3. Stop trace:
    F <Int.Node>,ct t=yes, e='<Int.Server>', l='none'
  4. Retrieve the trace log for the specified component by editing and submitting the BIPRELG job:
    -t -e <Int.Server> -f -o <output_directory>/<filename>.xml
  5. Format the XML trace file by editing and submitting the BIPFMLG job:
    -i <output_directory>/<filename>.xml
    -o <output_directory>/<filename>.txt

Additional Information

Performance Impact
A "service level" trace logs the internal function calls within Int.Server processing and therefore can have a significant impact to performance.
Take care when enabling trace in production and other high throughput environments.
Concerned that trace might be running? Use this command to confirm: mqsireporttrace <Int.Node>
Maximum file size
IIB component traces have a maximum file size.
When the maximum file size is reached, the tracing mechanism will begin to overwrite the oldest trace data.
The '-c' flag on the mqsichangetrace command overrides the maximum size for the trace, in KB.
The maximum allowable trace size is 2 GB (set with the override '-c 2000000').
Capturing startup events
The mqsichangetrace command can be run with the Int.Node and/or Int.Server stopped.
Enabling trace in this way will trace startup activities.
Capturing abends and errors
IIB 9.0.0.3 introduced programmatic stops to tracing with the '-m temp' flag.
This flag is set on the first mqsichangetrace command (when enabling the trace) and removes the need to run the command to stop the trace.
 - Use '-m temp' to stop tracing when an Int.Server stops (eg. to capture an abend).
 - Use '-m temp=####' top stop tracing when a particular BIP message is written (eg. to capture a specific error message).
Note that the Int.Server must be running for this flag to be allowed!
Output location
If fully qualified file paths are not used, the mqsireadlog and mqsiformatlog commands will output their resulting txt files to the directory in which the command was run.

Document Location

Worldwide

[{"Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSNQK6","label":"IBM Integration Bus"},"ARM Category":[{"code":"a8m50000000CiDgAAK","label":"IIB2->Runtime"}],"ARM Case Number":"","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF035","label":"z\/OS"}],"Version":"All Version(s)"}]

Document Information

Modified date:
05 January 2021

UID

ibm10880647