Tracing

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/trace/v2/http_tracer.proto

Tracing architecture overview.

config.trace.v3.Tracing

[config.trace.v3.Tracing proto]

The tracing configuration specifies settings for an HTTP tracer provider used by Envoy.

Envoy may support other tracers in the future, but right now the HTTP tracer is the only one supported.

Attention

Use of this message type has been deprecated in favor of direct use of Tracing.Http.

  1. {
  2.   "http": "{...}"
  3. }

http

(config.trace.v3.Tracing.Http) Provides configuration for the HTTP tracer.

config.trace.v3.Tracing.Http

[config.trace.v3.Tracing.Http proto]

Configuration for an HTTP tracer provider used by Envoy.

The configuration is defined by the HttpConnectionManager.Tracing provider field.

  1. {
  2.   "name": "...",
  3.   "typed_config": "{...}"
  4. }

name

(string, REQUIRED) The name of the HTTP trace driver to instantiate. The name must match a supported HTTP trace driver. See the extensions listed in typed_config below for the default list of the HTTP trace driver.

typed_config

(Any) Trace driver specific configuration which must be set according to the driver being instantiated.

Tip

This extension category has the following known extensions: