The Service Diagnostics Tool can be used to help diagnose problems with Web services. The Tool allows diagnostics dumping for a service to be configured at runtime. 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 Catalog
The Service Catalog displays all of the Service Definitions that are installed on your Server, organized by folder. Select a service to manage by clicking the icon adjacent to the desired service.
Diagnostic Logs
Lists 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. Selecting Search will refresh the list of logs.
Note that all diagnostic logs are stored in the VFS /logs/diagnostics folder and may be accessed from the folder using any WebDAV browser.
Log Information Filter
These settings determine the amount of information included in the log. The available categories are:
Basic message information |
Includes basic information about the service location, when it was called, and basic statistics for the request |
HTTP protocol information |
Includes HTTP request and response headers |
RAW HTTP request and response body |
Includes the HTTP request and response headers and unformatted request and response bodies. |
Format request and response body |
If the request and/or response body types are xml, format the XML for readability. |
Interprocess request and reply message |
Includes th request and response IPM 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.
Log File Prefix
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.
Log File Retention
Specify the maximum log file size and the number of log files that should be retained. If no values are specified then a single log file will be created.