Observability metrics

You can configure Controller to push observability metrics and data from scenario runs to an OpenTelemetry Collector. The observability data can be sent for scripts of all protocols.

Tip: Observability metrics can also be sent during script replay in VuGen. For details, see Observability metrics in the VuGen Help Center.

Push data to an OpenTelemetry Collector

Configure Controller to push data to an OpenTelemetry Collector.

To configure Controller to push data to an OpenTelemetry Collector:

  1. In the Controller toolbar, select Tools > External metrics > Observability configuration.
  2. In the Observability Options dialog box, select Enable Observability during the load test.

  3. Enter the following information.

    Field Details
    % of all relevant Vusers in the current scenario

    Percentage of Vusers in the scenario whose data is sent to the observability collector.

    Note:

    • Data is sent from at least 1 Vuser. If the specified percentage is equal to less than 1 Vuser in the current scenario, then data is sent from 1 Vuser.
    • Setting a high percentage may impact load generator performance.
    Observability collector Name and port number of the collector, beginning with grpc://
    TLS CA certificate

    File path of the TLS CA certificate to connect to the collector (if required).

    Tip: You can use a relative file path to indicate the certificate. If the certificate is saved in the same folder as the script, you only need to indicate the file name of the certificate.

    Authorization header

    Authorization header to send data to the collector (if required).

    When the scenario is run, telemetry data is sent per transaction to the collector. Transactions are tagged with 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.

Back to top

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, which enables you to track the flow of the request and correlate related observability data.

If a Web - HTTP/HTML script has existing traceparent headers included in its HTTP requests, these headers might conflict with the traceparent headers created to be sent with the observability data. We recommend deleting any existing traceparent headers from the script before running the script.

Back to top

See also: