package envoy.config.trace.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Configuration for the Datadog tracer. [#extension: envoy.tracers.datadog]

• string collector_cluster = 1

  The cluster to use for submitting traces to the Datadog agent.

• string service_name = 2

  The name used for the service when traces are generated by envoy.

DynamicOtConfig is used to dynamically load a tracer from a shared library that implements the `OpenTracing dynamic loading API <https://github.com/opentracing/opentracing-cpp>`_. [#extension: envoy.tracers.dynamic_ot]

• string library = 1

  Dynamic library implementing the `OpenTracing API <https://github.com/opentracing/opentracing-cpp>`_.

• optional google.protobuf.Struct config = 2

  The configuration to use when creating a tracer from the given dynamic library.

Configuration for the LightStep tracer. [#extension: envoy.tracers.lightstep]

• string collector_cluster = 1

  The cluster manager cluster that hosts the LightStep collectors.

• string access_token_file = 2

  File containing the access token to the `LightStep <https://lightstep.com/>`_ API.

• repeated LightstepConfig.PropagationMode propagation_modes = 3

  Propagation modes to use by LightStep's tracer.

Available propagation modes

Used in: LightstepConfig

• ENVOY = 0

  Propagate trace context in the single header x-ot-span-context.

• LIGHTSTEP = 1

  Propagate trace context using LightStep's native format.

• B3 = 2

  Propagate trace context using the b3 format.

• TRACE_CONTEXT = 3

  Propagation trace context using the w3 trace-context standard.

Configuration structure.

• optional api.v2.core.GrpcService grpc_service = 1

  The upstream gRPC cluster that hosts the metrics service.

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 :ref:`Tracing.Http <envoy_api_msg_config.trace.v2.Tracing.Http>`.

Used in: bootstrap.v2.Bootstrap

• optional Tracing.Http http = 1

  Provides configuration for the HTTP tracer.

Configuration for an HTTP tracer provider used by Envoy. The configuration is defined by the :ref:`HttpConnectionManager.Tracing <envoy_api_msg_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing>` :ref:`provider <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>` field.

Used in: filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing, Tracing

• string name = 1

  The name of the HTTP trace driver to instantiate. The name must match a supported HTTP trace driver. Built-in trace drivers: - *envoy.tracers.lightstep* - *envoy.tracers.zipkin* - *envoy.tracers.dynamic_ot* - *envoy.tracers.datadog* - *envoy.tracers.xray*

• oneof config_type

  Trace driver specific configuration which depends on the driver being instantiated. See the trace drivers for examples: - :ref:`LightstepConfig <envoy_api_msg_config.trace.v2.LightstepConfig>` - :ref:`ZipkinConfig <envoy_api_msg_config.trace.v2.ZipkinConfig>` - :ref:`DynamicOtConfig <envoy_api_msg_config.trace.v2.DynamicOtConfig>` - :ref:`DatadogConfig <envoy_api_msg_config.trace.v2.DatadogConfig>` - :ref:`AWS X-Ray <envoy_api_msg_config.trace.v2alpha.XRayConfig>`

  • google.protobuf.Struct config = 2

  • google.protobuf.Any typed_config = 3

Configuration for the Zipkin tracer. [#extension: envoy.tracers.zipkin] [#next-free-field: 6]

• string collector_cluster = 1

  The cluster manager cluster that hosts the Zipkin collectors. Note that the Zipkin cluster must be defined in the :ref:`Bootstrap static cluster resources <envoy_api_field_config.bootstrap.v2.Bootstrap.StaticResources.clusters>`.

• string collector_endpoint = 2

  The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation, the API endpoint is typically /api/v1/spans, which is the default value.

• bool trace_id_128bit = 3

  Determines whether a 128bit trace id will be used when creating a new trace instance. The default value is false, which will result in a 64 bit trace id being used.

• optional google.protobuf.BoolValue shared_span_context = 4

  Determines whether client and server spans will share the same span context. The default value is true.

• ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5

  Determines the selected collector endpoint version. By default, the ``HTTP_JSON_V1`` will be used.

Available Zipkin collector endpoint versions.

Used in: ZipkinConfig

• HTTP_JSON_V1 = 0

  Zipkin API v1, JSON over HTTP. [#comment: The default implementation of Zipkin client before this field is added was only v1 and the way user configure this was by not explicitly specifying the version. Consequently, before this is added, the corresponding Zipkin collector expected to receive v1 payload. Hence the motivation of adding HTTP_JSON_V1 as the default is to avoid a breaking change when user upgrading Envoy with this change. Furthermore, we also immediately deprecate this field, since in Zipkin realm this v1 version is considered to be not preferable anymore.]

• HTTP_JSON = 1

  Zipkin API v2, JSON over HTTP.

• HTTP_PROTO = 2

  Zipkin API v2, protobuf over HTTP.

• GRPC = 3

  [#not-implemented-hide:]