ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzamy_5.4.0.1/50/trb/trbinterptrace.htm

112 lines
4.8 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<LINK rel="stylesheet" type="text/css" href="../../../rzahg/ic.css">
<title>Interpret the trace service output</title>
</head>
<BODY>
<!-- Java sync-link -->
<SCRIPT LANGUAGE="Javascript" SRC="../../../rzahg/synch.js" TYPE="text/javascript"></SCRIPT>
<h3>Interpret the trace service output</h3>
<p>On an application server, trace output can be directed either to a file or
to an in memory circular buffer. If trace output is directed to the in memory
circular buffer, it must be dumped to a file before it can be viewed.</p>
<p>On a standalone process, trace output can be directed either to a file or
to the process console window.</p>
<p>In all cases, trace output is generated as plain text in either basic or advanced
format as specified by the user when enabling the trace service.</p>
<p><strong>Trace output formats</strong></p>
<p>Formatted trace events may be written to the trace file in one of three formats:</p>
<dl>
<dt><strong>Basic format</strong></dt>
<dd>The format used in WebSphere Application Server - Express.</dd>
</dl>
<dl>
<dt><strong>Advanced format</strong></dt>
<dd>Extends the basic format by adding information about an event.</dd>
</dl>
<p><strong>Basic and advanced format fields</strong></p>
<p>Basic and advanced formats use many of the same fields and formatting techniques.
The various fields that may be found in these formats include:</p>
<dl>
<dt><strong>TimeStamp</strong></dt>
<dd>The timestamp is formatted using the locale of the process where it is
formatted. It includes a fully qualified date (YYMMDD), 24 hour time with
millisecond precision and a Time zone.</dd>
</dl>
<dl>
<dt><strong>ThreadID</strong></dt>
<dd>An 8 character hexadecimal value generated from the hash code of the thread
that issued the trace event.</dd>
</dl>
<dl>
<dt><strong>ShortName</strong></dt>
<dd>The abbreviation name of the logging component that issued the trace event.
This is typically the class name for application server internal components,
but may be some other identifier for user applications.</dd>
</dl>
<dl>
<dt><strong>LongName</strong></dt>
<dd>The full name of the logging component that issued the trace event. This
is typically the fully qualified class name for application server internal
components, but may be some other identifier for user applications.</dd>
</dl>
<dl>
<dt><strong>EventType</strong></dt>
<dd>A one character field that indicates the type of the trace event. Trace
types are in lower case. Possible values include:
<ul>
<li><strong>&gt;</strong> - A trace entry of type method entry. </li>
<li><strong>&lt;</strong> - A trace entry of type method exit. </li>
<li><strong>e</strong> - A trace entry of type event. </li>
<li><strong>d</strong> - A trace entry of type debug. </li>
<li><strong>m</strong> - A trace entry of type dump. </li>
<li><strong>u</strong> - A trace entry of type unconditional. </li>
<li><strong>Z</strong> - A placeholder to indicate that the trace type
was not recognized.</li>
</ul>
</dd>
</dl>
<dl>
<dt><strong>ClassName</strong></dt>
<dd>The class that issued the message or trace event.</dd>
</dl>
<dl>
<dt><strong>MethodName</strong></dt>
<dd>The method that issued the message or trace event.</dd>
</dl>
<dl>
<dt><strong>Organization</strong></dt>
<dd>The organization that owns the application that issued the message or trace
event.</dd>
</dl>
<dl>
<dt><strong>Product</strong></dt>
<dd>The product that issued the message or trace event.</dd>
</dl>
<dl>
<dt><strong>Component</strong></dt>
<dd>The component within the product that issued the message or trace event.</dd>
</dl>
<dl>
<dt><strong>UOW</strong></dt>
<dd>The unit of work identifier for the event. This field is not currently
used.</dd>
</dl>
<p><strong>Basic format</strong></p>
<p>Trace events displayed in basic format use this format, where <em>name</em> indicates
mandatory fields that are always displayed in the formatted message and [name]
indicates optional fields that are displayed if they can be determined.</p>
<pre><em>TimeStamp ThreadId ShortName EventType</em> [ClassName] [MethodName]
<em>textmessage</em>[parameter 1] [parameter 2]</pre>
<p><strong>Advanced format</strong></p>
<p>Trace events displayed in advanced format use this format, where <em>name</em> indicates
mandatory fields that are always displayed in the formatted message and [name]
indicates optional fields that are displayed if they can be determined.</p>
<pre><em>TimeStamp ThreadId EventType UOWsource=LongName</em> [ClassName] [MethodName]
<em>Organization Product Component textMessage</em> [parameter 1=paremterValue]
[parameter 2=paremterValue]</pre>
</body>
</html>