OpenTelemetry tracer (proto)

config.trace.v3.OpenTelemetryConfig

[config.trace.v3.OpenTelemetryConfig proto]

Configuration for the OpenTelemetry tracer.

This extension has the qualified name envoy.tracers.opentelemetry

Note

This extension is work-in-progress. Functionality is incomplete and it is not intended for production use.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

envoy.tracers

This extension must be configured with one of the following type URLs:

type.googleapis.com/envoy.config.trace.v3.OpenTelemetryConfig

{
  "grpc_service": {...},
  "http_service": {...},
  "service_name": ...,
  "resource_detectors": [],
  "sampler": {...}
}

grpc_service: (config.core.v3.GrpcService) The upstream gRPC cluster that will receive OTLP traces. Note that the tracer drops traces if the server does not read data fast enough. This field can be left empty to disable reporting traces to the gRPC service. Only one of grpc_service, http_service may be used.

http_service: (config.core.v3.HttpService) The upstream HTTP cluster that will receive OTLP traces. This field can be left empty to disable reporting traces to the HTTP service. Only one of grpc_service, http_service may be used.

Note

Note: The request_headers_to_add property in the OTLP HTTP exporter service does not support the format specifier as used for HTTP access logging. The values configured are added as HTTP headers on the OTLP export request without any formatting applied.

service_name: (string) The name for the service. This will be populated in the ResourceSpan Resource attributes. If it is not provided, it will default to “unknown_service:envoy”.

resource_detectors

(repeated config.core.v3.TypedExtensionConfig) An ordered list of resource detectors

Tip

This extension category has the following known extensions:

sampler

(config.core.v3.TypedExtensionConfig) Specifies the sampler to be used by the OpenTelemetry tracer. The configured sampler implements the Sampler interface defined by the OpenTelemetry specification. This field can be left empty. In this case, the default Envoy sampling decision is used.

See: OpenTelemetry sampler specification

Tip

This extension category has the following known extensions: