1syntax = "proto3";
2
3package envoy.config.trace.v3;
4
5import "envoy/config/core/v3/grpc_service.proto";
6
7import "opencensus/proto/trace/v1/trace_config.proto";
8
9import "udpa/annotations/migrate.proto";
10import "udpa/annotations/status.proto";
11import "udpa/annotations/versioning.proto";
12import "validate/validate.proto";
13
14option java_package = "io.envoyproxy.envoy.config.trace.v3";
15option java_outer_classname = "OpencensusProto";
16option java_multiple_files = true;
17option (udpa.annotations.file_migrate).move_to_package =
18 "envoy.extensions.tracers.opencensus.v4alpha";
19option (udpa.annotations.file_status).package_version_status = ACTIVE;
20
21// [#protodoc-title: OpenCensus tracer]
22
23// Configuration for the OpenCensus tracer.
24// [#next-free-field: 15]
25// [#extension: envoy.tracers.opencensus]
26message OpenCensusConfig {
27 option (udpa.annotations.versioning).previous_message_type =
28 "envoy.config.trace.v2.OpenCensusConfig";
29
30 enum TraceContext {
31 // No-op default, no trace context is utilized.
32 NONE = 0;
33
34 // W3C Trace-Context format "traceparent:" header.
35 TRACE_CONTEXT = 1;
36
37 // Binary "grpc-trace-bin:" header.
38 GRPC_TRACE_BIN = 2;
39
40 // "X-Cloud-Trace-Context:" header.
41 CLOUD_TRACE_CONTEXT = 3;
42
43 // X-B3-* headers.
44 B3 = 4;
45 }
46
47 reserved 7;
48
49 // Configures tracing, e.g. the sampler, max number of annotations, etc.
50 opencensus.proto.trace.v1.TraceConfig trace_config = 1;
51
52 // Enables the stdout exporter if set to true. This is intended for debugging
53 // purposes.
54 bool stdout_exporter_enabled = 2;
55
56 // Enables the Stackdriver exporter if set to true. The project_id must also
57 // be set.
58 bool stackdriver_exporter_enabled = 3;
59
60 // The Cloud project_id to use for Stackdriver tracing.
61 string stackdriver_project_id = 4;
62
63 // (optional) By default, the Stackdriver exporter will connect to production
64 // Stackdriver. If stackdriver_address is non-empty, it will instead connect
65 // to this address, which is in the gRPC format:
66 // https://github.com/grpc/grpc/blob/master/doc/naming.md
67 string stackdriver_address = 10;
68
69 // (optional) The gRPC server that hosts Stackdriver tracing service. Only
70 // Google gRPC is supported. If :ref:`target_uri <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.target_uri>`
71 // is not provided, the default production Stackdriver address will be used.
72 core.v3.GrpcService stackdriver_grpc_service = 13;
73
74 // Enables the Zipkin exporter if set to true. The url and service name must
75 // also be set. This is deprecated, prefer to use Envoy's :ref:`native Zipkin
76 // tracer <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
77 bool zipkin_exporter_enabled = 5 [deprecated = true];
78
79 // The URL to Zipkin, e.g. "http://127.0.0.1:9411/api/v2/spans". This is
80 // deprecated, prefer to use Envoy's :ref:`native Zipkin tracer
81 // <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
82 string zipkin_url = 6 [deprecated = true];
83
84 // Enables the OpenCensus Agent exporter if set to true. The ocagent_address or
85 // ocagent_grpc_service must also be set.
86 bool ocagent_exporter_enabled = 11;
87
88 // The address of the OpenCensus Agent, if its exporter is enabled, in gRPC
89 // format: https://github.com/grpc/grpc/blob/master/doc/naming.md
90 // [#comment:TODO: deprecate this field]
91 string ocagent_address = 12;
92
93 // (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported.
94 // This is only used if the ocagent_address is left empty.
95 core.v3.GrpcService ocagent_grpc_service = 14;
96
97 // List of incoming trace context headers we will accept. First one found
98 // wins.
99 repeated TraceContext incoming_trace_context = 8;
100
101 // List of outgoing trace context headers we will produce.
102 repeated TraceContext outgoing_trace_context = 9;
103}
View as plain text