Using the Service Diagnostics Tool

The Service Diagnostics Tool can be used to help diagnose problems with Web services. The Tool allows the ipmDump and wireDump functionality to be turned on in a Service Definition at runtime, without modifying the Service Definition File. The Tool also helps locate and manage the diagnostic dump files. The Service Diagnostics tool can be accessed from the Development Tools menu on the SOAP/AM Server Control Panel.

The Service Diagnostics Catalog

The Service Diagnostics Catalog displays all of the Service Definitions that are installed on your Server, organized by folder. Select a service to manage by clicking the service name.

Diagnostic Logs Settings

Select the level of logging that you want to enable for the service.

Log SOAP messages as formatted XML - Log the HTTP headers and SOAP envelopes in the log as easily readable XML.

Log SOAP messages as hex dump - Log the SOAP envelopes as a hex dump.

Log server interprocess messages as hex dump - Log the IPM request and responses as a hex dump.

HTTP Status Code Range - Select which messages appear in the log by specifying an HTTP Status Code range. If the Status Code Range is not supplied all messages will be logged. The range can be supplied as a comma separated list of status codes and/or a status code range separated by a colon. For example:

201,202,400:500 - Selects status codes 201, 202, and 400 through 500.

Supply an optional log file prefix. The prefix can help distinguish log files for different services that may have the same service name. If not supplied DUMP- will be used. When log files are created, the default file name is "DUMP-<service-name>-<method name>". This can cause two different services which happen to have the same service name produce the same dump file name. The prefix can be used to uniquely identify the logs for these services.

Diagnostic Logs

List the currently available diagnostic logs for the service. Select the log name to view the log or select individual logs using the checkboxes and select Delete to delete the logs from the VFS.

Note that all diagnostic logs are stored in the VFS /logs/diagnostics folder and may be accessed from the folder using any WebDAV browser.