Tracing web services
You 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. You can also trace user-defined exceptions and SOAP messages that use Java™ Message Service (JMS) or HTTP to request web services.
Before you begin
About this task
The following tasks describe how you can enable trace for web services:
Procedure
- Enable trace for a web services unmanaged client.
Create a trace properties file by copying the %install_root\properties\TraceSettings.properties file to the same directory as your client application Java archive (JAR) file.
Create a trace properties file by copying the app_server_root/properties/TraceSettings.properties file to the same directory as your client application Java archive (JAR) file.
Edit the properties file and change the traceFileName value to output the trace data. For example, traceFileName=c:\\temp\\myAppClient.trc.
Edit the properties file and change the traceFileName value to output the trace data. For example, traceFileName=/myDir/myAppClient.trc.
- Edit the properties file to remove com.ibm.ejs.ras.*=all=enabled and add com.ibm.ws.webservices.engine.*=all=enabled.
- Add the -DtraceSettingsFile=<trace_properties_file> option to the java command line that is used to run the client, where trace_properties_file represents the name of the properties file that you created in the substeps a through c. For example, java -DtraceSettingsFile=TraceSettings.properties myApp.myAppMainClass.
- 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
To learn more about this tool, see the launchClient tool information.app_server_root/bin/launchClient MyAppClient.ear
-CCtrace=com.ibm.ws.webservices.engine.*=all=enabled -CCtracefile=myAppClient.trc
- Enable trace for a Web Services for Java Platform,
Enterprise Edition (Java EE)
server application.
- Start WebSphere® Application Server.
- Open the administrative console.
- Click Servers > Application Servers > server.
- Click Change Log Detail Levels.
- 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. You can specify the trace string in the text box in one of two
ways:
- Type the trace string directly into the text box. You must 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, if you want to add a predefined trace string for the SOAP messaging trace, you can click: com.ibm.ws.webservices.trace.MessageTrace.
- Click the trace option from the drop-down list. For example, you
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
- Type the trace string directly into the text box. You must separate
each trace string by a colon (:) with no spaces. For example:
- Click Save and Apply.
- 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.
- *=off:com.ibm.ws.webservices.*=all
You can trace all web services information, including the SOAP messages and the user-defined exceptions, with this setting.
You 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 that is defined in the Web Services Description Language (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.
Note: Cette rubrique fait référence à un ou plusieurs des fichiers journaux de serveur d'applications. Il est recommandé de configurer le serveur de telle sorte qu'il utilise l'infrastructure de journalisation et de trace HPEL (High Performance Extensible Logging) à la place des fichiers SystemOut.log, SystemErr.log, trace.log et activity.log sur les systèmes distribués et IBM® i. Vous pouvez également utiliser HPEL conjointement avec vos fonctions de journalisation z/OS® natives. Si vous utilisez l'infrastructure HPEL, vous pouvez accéder à toutes les informations de journalisation et de trace en utilisant l'outil de ligne de commande LogViewer à partir de votre répertoire bin de profil de serveur. Pour plus d'informations sur l'utilisation de HPEL, voir les informations sur l'utilisation de HPEL en vue du traitement des incidents liés aux applications.You 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.
Eviter les incidents: Please note once this trace is turned on, the whole SOAP message payload will be written into trace file. If there is any confidential information (such as user ID or password) in the SOAP message as part of the payload, they will be output as plain text as well. Please properly plan to protect the security of your information.gotcha
Note: For JAX-WS web service, there are two ways (normal level and minimal level) to print out both the Outbound HTTP SOAP message and the Inbound HTTP SOAP message in the trace file.- Normal level by setting
- com.ibm.ws.websvcs.trace.*=all
- Minimal level by setting
- com.ibm.ws.websvcs.trace.MessageTrace=all:com.ibm.ws.websvcs.trace.LogFilterInputStream=all
- com.ibm.ws.webservices.trace.MessageTrace=all
Results
What to do next


http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_tracewbscomp
Nom du fichier : twbs_tracewbscomp.html