Observability support
Available in versions: 25.3 and later
You can configure OpenText Enterprise Performance Engineering to push observability metrics and data from performance test runs to an OpenTelemetry Collector. The observability data can be sent for scripts of all protocols.
Note: Observability metrics can also be sent during script replay in VuGen. For details, see Observability metrics in the OpenText Virtual User Generator Help Center.
Add an OpenTelemetry Collector
To enable observability support, you need to add OpenTelemetry Collectors and assign them to different projects.
Note: You can assign only one OpenTelemetry Collector per project.
To add an OpenTelemetry Collector:
-
In Administration, go to Configuration > Integrations > Observability.
-
In the Observability pane, expand OpenTelemetry, and click the Add button
to open the New Collector page.
-
Configure the OpenTelemetry Collector settings.
UI Elements Description Name Logical name for the OpenTelemetry Collector.
Note: The logical name must not already exist, and cannot contain empty spaces or the following special characters: \ / : " ? ' < > | * % "
Full URL Name and port number of the collector, beginning with grpc://, http://, or https://.
Authentication Header Authorization header to send data to the collector (if required).
There are two types:
-
Basic followed by a Base-64 encoded username and password. For example:
Basic dXNlcjpwYXNz
-
Bearer followed by a token. For example:
Bearer randomtoken1234
TLS CA certificate The public key value of the TLS CA certificate to connect to the collector (if required).
Note: Not required for non-TLS users.
-
-
Assign an OpenTelemetry Collector to projects.
-
In the Linked Projects area, click the Assign Projects button
to open the Assign Projects dialog box.
-
Select the projects you want to assign to the OpenTelemetry Collector, and click Assign. The selected projects are added to the Linked Projects grid.
-
In the Linked Projects grid, you can view project details, including project ID, name, and domain, and add or remove linked projects as needed.
-
Push data to an OpenTelemetry Collector
Configure performance test run data to be pushed to an OpenTelemetry Collector.
To push data to an OpenTelemetry Collector:
-
Prerequisite. An OpenTelemetry Collector must be added and assigned to the project. For details, see Add an OpenTelemetry Collector.
-
In Test Management > Tests & Scripts, select the test for which you want to push data and click Edit Test.
-
In the Groups and Workload tab, click the Test Options button
, and configure the following.
-
In the General tab, select Enable OpenTelemetry.
-
In For % of all relevant Vusers in the test, enter the percentage of Vusers whose data should be sent to the collector.
Note:
-
Data is sent from at least 1 Vuser. If the specified percentage is equal to less than 1 Vuser in the current test, then data is sent from 1 Vuser.
-
Setting a high percentage may impact load generator performance.
-
-
When the performance test is run, telemetry data is sent per transaction to the collector. Transactions are tagged with details such as the transaction name, Vuser number, and other information.
For Web - HTTP/HTML scripts, a traceparent
HTTP header is also added automatically. For details, see Traceparent header in Web - HTTP/HTML scripts.
Note: Telemetry data is collected only for tests running scripts on instrumented applications under test (AUTs). Data is not collected for non-instrumented web applications.
Traceparent header in Web - HTTP/HTML scripts
When you run a Web - HTTP/HTML script with observability metrics enabled, each HTTP request is reported to the collector as a transaction. A traceparent
header is automatically added to each request, enabling you to track the request's flow and correlate related observability data.
Note: If your script already includes custom traceparent
headers, they may conflict with the automatically generated headers used for observability. We recommend removing any existing traceparent
headers from the script before running it.