Trace Output Format

On the Diagnostic Trace Services page there is Trace Format select box that lets you decide what format should be used for generating trace.



As you can see you have three options for what format you want to choose

  1. Basic: The events displayed in the basic format use the following format

    <timestamp><threadId><shortName><eventType>[className][methodName]<textmessage>
    [parameter 1]
    [parameter 2]

    This is sample output generated for basic format

    [7/5/09 21:04:13:984 PDT] 00000025 HttpRequestMe 3 setMethod(v): GET
    [7/5/09 21:04:13:984 PDT] 00000025 HttpRequestMe 3 setRequestURL input [/ibm/console/configSpecDetail.do?EditAction=true&perspective=tab.runtime]
    [7/5/09 21:04:13:984 PDT] 00000025 HttpRequestMe 3 setQueryString(byte[]): set query to [EditAction=true&perspective=tab.runtime]
    [7/5/09 21:04:13:984 PDT] 00000025 HttpRequestMe 3 setRequestURL: set URI to /ibm/console/configSpecDetail.do
    [7/5/09 21:04:13:984 PDT] 00000025 HttpBaseMessa 3 Called setVersion(b): HTTP/1.1
    values

    The Basic format is recommended format that makes it easier to read the trace message. When your submitting trace to IBM Support team you should use Basic format.

  2. Advanced: The Advanced format trace uses little more complex format than the basic format. This is the format used for Advanced format

    <timestamp><threadId><eventType><UOW><source=longName>[className][methodName]
    <Organization><Product><Component>[thread=threadName]
    <textMessage>[parameter 1=parameterValue][parameter 2=parameterValue]

    These are couple of sample trace messages generated for the advanced format

    [7/5/09 21:50:49:031 PDT] 00000029 I UOW=null source=com.ibm.ws.webcontainer.servlet.ServletWrapper org=IBM prod=WebSphere component=Application Server thread=[WebContainer : 1]
    SRVE0242I: [ConnectionLeakEAR] [/connleak] [FormPostServlet]: Initialization successful.
    [7/5/09 21:50:49:046 PDT] 00000029 O UOW= source=SystemOut org=IBM prod=WebSphere component=Application Server thread=[WebContainer : 1]
    Inside FormPostServlet.doPost() Exit


  3. Log Analyzer: If you select the Log Analyzer format then it will generate the trace in the same form as that generated by showlog tool, when it converts the binary activity.log file to text format.


    ---------------------------------------------------------------
    ComponentId: Application Server
    ProcessId: 5368
    ThreadId: 00000029
    ThreadName: WebContainer : 3
    SourceId: com.ibm.ws.http.channel.impl.HttpResponseMessageImpl
    ClassName:
    MethodName:
    Manufacturer: IBM
    Product: WebSphere
    Version: Platform 6.1 [BASE 6.1.0.25 cf250922.06]
    ServerName: sunpatil-wxp02Node01Cell\sunpatil-wxp02Node01\server1
    TimeStamp: 2009-07-05 21:11:24.062000005
    UnitOfWork:
    Severity: 3
    Category: FINEST
    PrimaryMessage: setReasonPhrase(byte[]): set to [OK]
    ExtendedMessage:
    ---------------------------------------------------------------
    ComponentId: Application Server
    ProcessId: 5368
    ThreadId: 00000029
    ThreadName: WebContainer : 3
    SourceId: com.ibm.ws.webcontainer.servlet.ServletWrapper
    ClassName:
    MethodName:
    Manufacturer: IBM
    Product: WebSphere
    Version: Platform 6.1 [BASE 6.1.0.25 cf250922.06]
    ServerName: sunpatil-wxp02Node01Cell\sunpatil-wxp02Node01\server1
    TimeStamp: 2009-07-05 21:11:24.078000000
    UnitOfWork:
    Severity: 3
    Category: INFO
    PrimaryMessage: SRVE0242I: [ConnectionLeakEAR] [/connleak] [FormPostServlet]: Initialization successful.
    ExtendedMessage:
    ---------------------------------------------------------------




Please note that you can read trace in any of these formats using Log ANalyzer tool.

Basic and Advanced Formats use many of the same fields and formatting techniques. The fields that can be used in these formats include:

  • TimeStamp: 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 the time zone.

  • ThreadId: An 8 character hexadecimal value generated from the hash code of the thread that issued the trace event.

  • ThreadName: The name of the Java thread that issued the message or trace event.

  • ShortName :The abbreviated name of the logging component that issued the trace event. This is typically the class name for WebSphere Application Server internal components, but may be some other identifier for user applications.

  • LongName: The full name of the logging component that issued the trace event. This is typically the fully qualified class name for WebSphere Application Server internal components, but may be some other identifier for user applications.

  • EventType: A one character field that indicates the type of the trace event. Trace types are in lower case. Possible values include:

    >
    a trace entry of type method entry.
    <
    a trace entry of type method exit.
    1
    a trace entry of type fine or event.
    2
    a trace entry of type finer.
    3
    a trace entry of type finest, debug or dump.
    Z
    a placeholder to indicate that the trace type was not recognized.

  • ClassName: The class that issued the message or trace event.

  • MethodName:The method that issued the message or trace event.

  • Organization:The organization that owns the application that issued the message or trace event.

  • Product:The product that issued the message or trace event.

  • Component: The component within the product that issued the message or trace event.

No comments: