// [#protodoc-title: Tracing] // Tracing :ref:`architecture overview `. syntax = "proto3"; package envoy.config.trace.v2; option java_outer_classname = "TraceProto"; option java_multiple_files = true; option java_package = "io.envoyproxy.envoy.config.trace.v2"; option go_package = "v2"; import "envoy/api/v2/core/grpc_service.proto"; import "google/protobuf/any.proto"; import "google/protobuf/struct.proto"; import "google/protobuf/wrappers.proto"; import "validate/validate.proto"; // The tracing configuration specifies global // settings for the HTTP tracer used by Envoy. The configuration is defined by // the :ref:`Bootstrap ` :ref:`tracing // ` field. Envoy may support other tracers // in the future, but right now the HTTP tracer is the only one supported. message Tracing { message Http { // The name of the HTTP trace driver to instantiate. The name must match a // supported HTTP trace driver. Built-in trace drivers: // // - *envoy.lightstep* // - *envoy.zipkin* // - *envoy.dynamic.ot* // - *envoy.tracers.datadog* string name = 1 [(validate.rules).string.min_bytes = 1]; // Trace driver specific configuration which depends on the driver being instantiated. // See the trace drivers for examples: // // - :ref:`LightstepConfig ` // - :ref:`ZipkinConfig ` // - :ref:`DynamicOtConfig ` // - :ref:`DatadogConfig ` oneof config_type { google.protobuf.Struct config = 2 [deprecated = true]; google.protobuf.Any typed_config = 3; } } // Provides configuration for the HTTP tracer. Http http = 1; } // Configuration for the LightStep tracer. message LightstepConfig { // The cluster manager cluster that hosts the LightStep collectors. string collector_cluster = 1 [(validate.rules).string.min_bytes = 1]; // File containing the access token to the `LightStep // `_ API. string access_token_file = 2 [(validate.rules).string.min_bytes = 1]; } message ZipkinConfig { // The cluster manager cluster that hosts the Zipkin collectors. Note that the // Zipkin cluster must be defined in the :ref:`Bootstrap static cluster // resources `. string collector_cluster = 1 [(validate.rules).string.min_bytes = 1]; // 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. string collector_endpoint = 2 [(validate.rules).string.min_bytes = 1]; // 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. bool trace_id_128bit = 3; // Determines whether client and server spans will shared the same span id. // The default value is true. google.protobuf.BoolValue shared_span_context = 4; } // DynamicOtConfig is used to dynamically load a tracer from a shared library // that implements the `OpenTracing dynamic loading API // `_. message DynamicOtConfig { // Dynamic library implementing the `OpenTracing API // `_. string library = 1 [(validate.rules).string.min_bytes = 1]; // The configuration to use when creating a tracer from the given dynamic // library. google.protobuf.Struct config = 2; } // Configuration for the Datadog tracer. message DatadogConfig { // The cluster to use for submitting traces to the Datadog agent. string collector_cluster = 1 [(validate.rules).string.min_bytes = 1]; // The name used for the service when traces are generated by envoy. string service_name = 2 [(validate.rules).string.min_bytes = 1]; } // Configuration structure. message TraceServiceConfig { // The upstream gRPC cluster that hosts the metrics service. envoy.api.v2.core.GrpcService grpc_service = 1 [(validate.rules).message.required = true]; }