1syntax = "proto3";
2
3package envoy.config.trace.v4alpha;
4
5import "google/protobuf/any.proto";
6import "google/protobuf/struct.proto";
7
8import "udpa/annotations/status.proto";
9import "udpa/annotations/versioning.proto";
10import "validate/validate.proto";
11
12option java_package = "io.envoyproxy.envoy.config.trace.v4alpha";
13option java_outer_classname = "HttpTracerProto";
14option java_multiple_files = true;
15option (udpa.annotations.file_status).package_version_status = NEXT_MAJOR_VERSION_CANDIDATE;
16
17// [#protodoc-title: Tracing]
18// Tracing :ref:`architecture overview <arch_overview_tracing>`.
19
20// The tracing configuration specifies settings for an HTTP tracer provider used by Envoy.
21//
22// Envoy may support other tracers in the future, but right now the HTTP tracer is the only one
23// supported.
24//
25// .. attention::
26//
27// Use of this message type has been deprecated in favor of direct use of
28// :ref:`Tracing.Http <envoy_api_msg_config.trace.v4alpha.Tracing.Http>`.
29message Tracing {
30 option (udpa.annotations.versioning).previous_message_type = "envoy.config.trace.v3.Tracing";
31
32 // Configuration for an HTTP tracer provider used by Envoy.
33 //
34 // The configuration is defined by the
35 // :ref:`HttpConnectionManager.Tracing <envoy_api_msg_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.Tracing>`
36 // :ref:`provider <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.Tracing.provider>`
37 // field.
38 message Http {
39 option (udpa.annotations.versioning).previous_message_type =
40 "envoy.config.trace.v3.Tracing.Http";
41
42 reserved 2;
43
44 reserved "config";
45
46 // The name of the HTTP trace driver to instantiate. The name must match a
47 // supported HTTP trace driver. Built-in trace drivers:
48 //
49 // - *envoy.tracers.lightstep*
50 // - *envoy.tracers.zipkin*
51 // - *envoy.tracers.dynamic_ot*
52 // - *envoy.tracers.datadog*
53 // - *envoy.tracers.opencensus*
54 // - *envoy.tracers.xray*
55 string name = 1 [(validate.rules).string = {min_len: 1}];
56
57 // Trace driver specific configuration which depends on the driver being instantiated.
58 // See the trace drivers for examples:
59 //
60 // - :ref:`LightstepConfig <envoy_api_msg_extensions.tracers.lightstep.v4alpha.LightstepConfig>`
61 // - :ref:`ZipkinConfig <envoy_api_msg_extensions.tracers.zipkin.v4alpha.ZipkinConfig>`
62 // - :ref:`DynamicOtConfig <envoy_api_msg_extensions.tracers.dynamic_ot.v4alpha.DynamicOtConfig>`
63 // - :ref:`DatadogConfig <envoy_api_msg_extensions.tracers.datadog.v4alpha.DatadogConfig>`
64 // - :ref:`OpenCensusConfig <envoy_api_msg_extensions.tracers.opencensus.v4alpha.OpenCensusConfig>`
65 // - :ref:`AWS X-Ray <envoy_api_msg_extensions.tracers.xray.v4alpha.XRayConfig>`
66 oneof config_type {
67 google.protobuf.Any typed_config = 3;
68 }
69 }
70
71 // Provides configuration for the HTTP tracer.
72 Http http = 1;
73}
View as plain text