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