Breadcrumbs

Synchronous Tracing with the xUML Trace Analyzer

The Analyzer allows you to test all exposed operations of an xUML service on the fly via a SOAP interface and to work with any backends (for example, databases or web services). It traces the execution path of a deployed xUML service, and you can review this trace graphically in order to debug your service or verify its correct functionality.

The xUML Trace Analyzer is the interface to the tracing feature. With the Trace Analyzer you can test

  • each operation defined on a port type of an xUML service

  • class operations of classes that have been marked as to be testable

The tracing data can be collected synchronously or asynchronously and is stored per test run into a separate XML file.

:info:

Kubernetes Setup

In this setup, the trace files are stored to MinIO (S3):

  • The maximum storage space for tracing information is 10 GB. If this limit is exceeded, no traces can be stored anymore, and errors are reported in the Analyzer.
    This ensures that sufficient free memory space is available for the correct operation of PAS at any time.

  • By default, the trace files expire after 14 days. Files that are older than 14 days are automatically removed from MinIO (S3).

  • The trace file retention time can be configured on your PAS instance. Please contact our support if you want to change the default configuration.

Docker Setup

In this setup, the trace files are stored to the file system.

  • By default, the trace files expire after 7 days. Files that are older than 7 days are automatically removed from the file system.

  • The trace file retention time can be configured on your PAS instance. Please contact our support if you want to change the default configuration.

1 one square blue Import the Service Description

To test a service, you must first import its characteristics from a repository file or a bundle service export. These files contain a WSDL (Web Service Definition Language) file that describes the public API of a the service, including the parameters for calling services and the types of return values.

The Trace Analyzer supports both SOAP RPC (remote procedure call) encoding and SOAP document-style encoding.

2 two square blue Define the Test Data

Each operation defined on a port type of an xUML service can be tested with the Trace Analyzer. In order to test an operation, you must define a test case, which will also be used to store the last request and response.

For each test case, you need to specify a custom location where the endpoint can be found as described on Connecting to an xUML Service.

It is possible to create multiple test cases for a single operation. Each test case runs with specific input data that you enter in the Trace Analyzer. The SOAP request and the SOAP response will be saved to disk together with the test case, so they are not lost when you close the Trace Analyzer.

3 three square blue Run the Test

A test case can be run. When a test case is run, its response is updated and a graphical view of the service execution is generated.

If you wish to compare the results of two tests (e.g. before and after a bugfix), copy the test case and run it again. Both request and response are copied as well.

📗
📘

Related Documentation: