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.
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.
Import the Service Description
To trace through a service, you must first import the service characteristics. This is done by Importing the Service Description as generated by the Designer.
This guide uses the RESTAPI_SupportManager_Example as an example. The repository file can be downloaded from our documentation.
Connect to the Running Service
After having imported the service description, all service resources are listed in the asynchronous part of the Trace Analyzer. You need to connect each resource you want to inspect to the deployed service as described on Connecting to an xUML Service, and enable trace.
That done, calls to any of the connected resources are traced and their execution path can be inspected afterwards.
Trace Through Service Calls
Once trace has been activated, all calls to the configured resources are tracked. You can download these traces with the Trace Analyzer and browse through the execution path of a Designer Service of the related calls.
Deactivate Trace
Trace is enabled on the service, trace data is stored to the service context. This is completely independent from the Analyzer running or not. So, do not forget to disable trace after collecting the needed information with the Analyzer.
Keeping trace running on multiple services may lead to file storage issues on your server.
Refer to Connecting to an xUML Service for more information on how to disable trace.