Distributed Tracing Properties

Tracing Configuration Properties describes the properties for configuring SBA Gateway distributed tracing.

Table 1. Tracing Configuration Properties
Property Description
gateway.tracing.openTelemetry.enabled When set to true, the OpenTelemetry tracing library is configured in Vertx. Set this property with the Helm global.tracing.enabled property in your Helm values file. The default value is true.
gateway.tracing.openTelemetry.policy The policy for tracing incoming requests. Valid values are:
  • IGNORE — Any traces are not propagated. Tracing is effectively disabled.
  • PROPOGATE — Existing traces are propagated. If no trace exists, a new trace is not created.
  • ALWAYS — Existing traces are propagated. If no trace exists, a new trace is created.
The default value is PROPOGATE. Set this property in your nf.yaml file.
Note: Trace information is propagated to downstream services by HTTP headers in the B3 format. Only the B3 format is supported. For more information see the discussion about B3 propagation at the openzipkin/b3-propogation website.
gateway.tracing.openTelemetry.traces.ratio The sampling probability. This is a number in the [0..1] range, for example, 0.25. The default value is 1.0.
gateway.tracing.openTelemetry.endpointUrl The URL of the OpenTelemetry Collector gRPC endpoint. Set this property with the Helm global.tracing.openTelemetry.endpoint.host and global.tracing.openTelemetry.endpoint.grpcPort properties in your Helm values file. The default value is http://localhost:4317.
gateway.tracing.openTelemetry.serviceName The name identifying network function tracing in the traces. The default value is chf. Set this property in your nf.yaml file.
gateway.tracing.openTelemetry.traces.sampler The default for this property is parentbased_always_on. For a list of other options for this property, refer to the OpenTelemetry documentation.

For more information about distributed tracing, see the discussion about distributed tracing configuration in MATRIXX Configuration.