WAS v8.5 > Troubleshoot > Troubleshooting web services > Troubleshooting web services

Tracing web services

We can trace the web services runtime components, including an unmanaged client, a managed client and a server application. The procedure entry and exit, as well as the processing actions are traceable in the runtime components. We can also trace user-defined exceptions and SOAP messages that use JMS or HTTP to request web services.

The specification...

...traces the web services run time only. See step 4 for settings used to trace user-defined exceptions and SOAP messages or review the tracing SOAP messages with tcpmon documentation to learn about tracing SOAP messages with the tcpmon process.

The following tasks describe how we can enable trace for web services:

  1. Enable trace for a web services unmanaged client.

    1. Create a trace properties file by copying...

        %install_root\properties\TraceSettings.properties

      ...to the same directory as the client application JAR file.

    2. Edit file and change traceFileName to output the trace data. For example...

        traceFileName=c:\\temp\\myAppClient.trc

    3. Edit the properties file to remove...

      • com.ibm.ejs.ras.*=all=enabled

      ...and com.ibm.ws.webservices.engine.*=all=enabled

    4. Add the option...

        -DtraceSettingsFile=<trace_properties_file>

      ...to the java command line used to run the client, where trace_properties_file represents the name of the properties file created in the substeps a through c. For example...

        java -DtraceSettingsFile=TraceSettings.properties myApp.myAppMainClass

  2. Enable trace for a web services-managed client by invoking the launchClient command-line tool with the following options:

      -CCtrace=com.ibm.ws.webservices.engine.*=all=enabled
      -CCtracefile=traceFileName

    For example:

      %install_root%\bin\launchClient MyAppClient.ear

      -CCtrace=com.ibm.ws.webservices.engine.*=all=enabled -CCtracefile=myAppClient.trc

  3. Enable trace for a Web Services for Java EE server application.

    1. From the dmgr console...

        Servers | appservers | server | Change Log Detail Levels

    2. Add or delete the trace string in the text box.

      For this task, delete the trace string *=info and add the trace string...

        com.ibm.ws.webservices.engine.*=all=enabled

      We can specify the trace string in the text box in one of two ways:

      • Type the trace string directly into the text box. Separate each trace string by a colon (:) with no spaces. For example:

          com.ibm.ws.webservices.trace.MessageTrace=finest:com.ibm.ws.webservices.engine.Message=finest

      • Choose a predefined trace string from the section that is listed. The predefined section starts with *[All Components]. The predefined tracing strings web services component are listed under the com.ibm..ws.* section.

        • Click the plus (+) sign to expand the com.ibm.ws.* section.

        • Click the predefined trace string. For example, to add a predefined trace string for the SOAP messaging trace, we can click: com.ibm.ws.webservices.trace.MessageTrace.

        • Click the trace option from the drop-down list.

          For example, we can choose off, fatal, severe, warning, audit, info, config, detail, fine, finer, finest, and all. The option, finest, is recommended. When you click on the option, the option is added to the end of the trace string. For example:

            com.ibm.ws.webservices.trace.MessageTrace=finest

    3. Click Save and Apply.

  4. Enable trace for SOAP messages, user-defined exceptions, or both. The following trace specifications are used to trace SOAP messages:

    • com.ibm.ws.webservices.trace.MessageTrace=all

    This specification traces the contents of a SOAP message, including the binary attachment data.

    When the context-type of the SOAP message is not text and xml, the message probably contains attachments. In this case, the message is displayed in the trace file in the hex dump format. The following example illustrates a line in the hex dump format for non-text SOAP messages:

      0000: 0D 0A 2D 2D 2D 2D 2D 2D - 3D 5F 50 61 72 74 5F 36 ..------=_Part_6

    • In each trace file line, 16 bytes of the message are displayed

    • The first four digits are a hex number whose value is the byte offset into the SOAP message of the first byte on the line.

    • The next 16 two-digit hex numbers are the contents of each of the consecutive bytes in the message.

    • The ASCII representation of the bytes is displayed in the last 16 characters of the line, with unprintable characters that are represented by a period.

  5. *=off:com.ibm.ws.webservices.*=all

    We can trace all web services information, including the SOAP messages and the user-defined exceptions, with this setting.

    We can enable logging of user-defined exceptions by specifying the com.ibm.ws.webservices.trace.UserExceptionTrace=all trace string. The user-defined exceptions are not logged by default. A user-defined exception is an exception defined in the WSDL file for an operation.

    A user-defined exception often indicates an error-free condition. For example, the user-defined OverdrawnException exception, can occur for the service endpoint implementation of the makeWithdrawl method. This exception indicates an expected condition and does not indicate an error in the service endpoint implementation. Because these types of exceptions can occur during normal processing, they are not logged by default. When a user-defined exception is logged, the information is sent to the trace.log file and not to the SystemOut.log file.

    IBM recommends using the HPEL log and trace infrastructure. With HPEL, one views logs using the LogViewer command-line tool in PROFILE/bin.

    We can also use the following trace strings to enable tracing for user-defined exceptions, as well as other trace points:

    • com.ibm.ws.webservices.*=all

      Turns on all web services run-time trace logs.

    • com.ibm.ws.webservices.trace.*=all

      Turns on MessageTrace and UserExceptionTrace.


Results

You have enabled trace for the unmanaged clients, managed clients, and the server applications. Depending on the trace string specification, the trace can include runtime components, user-defined exceptions and SOAP messages.

Analyze the message data.


Related

Troubleshooting web services
Tracing SOAP messages with tcpmon
Troubleshoot applications with HPEL
launchClient tool


+

Search Tips   |   Advanced Search