package envoy.config.trace.v3

Get desktop application:
View/edit binary Protocol Buffers messages

Client config for SkyWalking tracer.

Used in: SkyWalkingConfig

• string service_name = 1

  Service name for SkyWalking tracer. If this field is empty, then local service cluster name that configured by :ref:`Bootstrap node <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.node>` message's :ref:`cluster <envoy_v3_api_field_config.core.v3.Node.cluster>` field or command line option :option:`--service-cluster` will be used. If both this field and local service cluster name are empty, ``EnvoyProxy`` is used as the service name by default.

• string instance_name = 2

  Service instance name for SkyWalking tracer. If this field is empty, then local service node that configured by :ref:`Bootstrap node <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.node>` message's :ref:`id <envoy_v3_api_field_config.core.v3.Node.id>` field or command line option :option:`--service-node` will be used. If both this field and local service node are empty, ``EnvoyProxy`` is used as the instance name by default.

• oneof backend_token_specifier

  Authentication token config for SkyWalking. SkyWalking can use token authentication to secure that monitoring application data can be trusted. In current version, Token is considered as a simple string. [#comment:TODO(wbpcode): Get backend token through the SDS API.]

  • string backend_token = 3

    Inline authentication token string.

• optional google.protobuf.UInt32Value max_cache_size = 4

  Envoy caches the segment in memory when the SkyWalking backend service is temporarily unavailable. This field specifies the maximum number of segments that can be cached. If not specified, the default is 1024.

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.

• string collector_hostname = 3

  Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.DatadogConfig.collector_cluster>` above.

• optional DatadogRemoteConfig remote_config = 4

  Enables and configures remote configuration. Remote Configuration allows to configure the tracer from Datadog's user interface. This feature can drastically increase the number of connections to the Datadog Agent. Each tracer regularly polls for configuration updates, and the number of tracers is the product of the number of listeners and worker threads.

Configuration for the Remote Configuration feature.

Used in: DatadogConfig

• optional google.protobuf.Duration polling_interval = 1

  Frequency at which new configuration updates are queried. If no value is provided, the default value is delegated to the Datadog tracing library.

DynamicOtConfig was used to dynamically load a tracer from a shared library that implements the `OpenTracing dynamic loading API <https://github.com/opentracing/opentracing-cpp>`_. [#not-implemented-hide:]

• 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] [#not-implemented-hide:]

• 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.

• optional core.v3.DataSource access_token = 4

  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 for the OpenTelemetry tracer. [#extension: envoy.tracers.opentelemetry] [#next-free-field: 6]

• optional core.v3.GrpcService grpc_service = 1

  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.

• optional core.v3.HttpService http_service = 3

  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 :ref:`format specifier <config_access_log_format>` as used for :ref:`HTTP access logging <config_access_log>`. The values configured are added as HTTP headers on the OTLP export request without any formatting applied.

• string service_name = 2

  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".

• repeated core.v3.TypedExtensionConfig resource_detectors = 4

  An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]

• optional core.v3.TypedExtensionConfig sampler = 5

  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 <https://opentelemetry.io/docs/specs/otel/trace/sdk/#sampler>`_ [#extension-category: envoy.tracers.opentelemetry.samplers]

Configuration for the SkyWalking tracer. Please note that if SkyWalking tracer is used as the provider of tracing, then :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>` in the tracing config must be set to true to get the correct topology and tracing data. Moreover, SkyWalking Tracer does not support SkyWalking extension header (``sw8-x``) temporarily. [#extension: envoy.tracers.skywalking]

• optional core.v3.GrpcService grpc_service = 1

  SkyWalking collector service.

• optional ClientConfig client_config = 2

Configuration structure.

• optional core.v3.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_v3_api_msg_config.trace.v3.Tracing.Http>`.

Used in: bootstrap.v3.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_v3_api_msg_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing>` :ref:`provider <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>` field.

Used in: Tracing, extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing

• string name = 1

  The name of the HTTP trace driver to instantiate. The name must match a supported HTTP trace driver. See the :ref:`extensions listed in typed_config below <extension_category_envoy.tracers>` for the default list of the HTTP trace driver.

• oneof config_type

  Trace driver specific configuration which must be set according to the driver being instantiated. [#extension-category: envoy.tracers]

  • google.protobuf.Any typed_config = 3

[#extension: envoy.tracers.xray]

• optional core.v3.SocketAddress daemon_endpoint = 1

  The UDP endpoint of the X-Ray Daemon where the spans will be sent. If this value is not set, the default value of 127.0.0.1:2000 will be used.

• string segment_name = 2

  The name of the X-Ray segment.

• optional core.v3.DataSource sampling_rule_manifest = 3

  The location of a local custom sampling rules JSON file. For an example of the sampling rules see: `X-Ray SDK documentation <https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-configuration.html#xray-sdk-go-configuration-sampling>`_

• optional XRayConfig.SegmentFields segment_fields = 4

  Optional custom fields to be added to each trace segment. see: `X-Ray Segment Document documentation <https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html>`__

Used in: XRayConfig

• string origin = 1

  The type of AWS resource, e.g. "AWS::AppMesh::Proxy".

• optional google.protobuf.Struct aws = 2

  AWS resource metadata dictionary. See: `X-Ray Segment Document documentation <https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html#api-segmentdocuments-aws>`__

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

• string collector_cluster = 1

  The cluster manager cluster that hosts the Zipkin collectors.

• string collector_endpoint = 2

  The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation.

• 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.

• string collector_hostname = 6

  Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.

• bool split_spans_for_request = 7

  If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases: * The Envoy Proxy is used as gateway or ingress. * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled. * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true. .. attention:: If this is set to true, then the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` SHOULD be set to true also to ensure the correctness of trace chain. Both this field and ``start_child_span`` are deprecated by the :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`. Please use that ``spawn_upstream_span`` field to control the span creation.

Available Zipkin collector endpoint versions.

Used in: ZipkinConfig

• DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE = 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:]