☰
Navigation :

opencensus.proto

Package: solo.io.envoy.config.trace.v3

Types:

Source File: github.com/solo-io/gloo/projects/gloo/api/external/envoy/config/trace/v3/opencensus.proto

OpenCensusConfig

Configuration for the OpenCensus tracer.

The OpenCensus tracer is capable of reporting metadata to a collector using W3C-standard Trace Context: https://www.w3.org/TR/trace-context/ WARNING: users should take care to note that this plugin has a serious limitation that can cause a configuration freeze of Envoy’s dynamic listeners. This plugin can be initialised once after Envoy has started. In order to change this plugin’s configuration, users must first apply the new configuration, and then restart Envoy. Users should also be aware that once the new configuration is applied, Envoy will reject any changes to its dynamic listeners configuration until after it has been restarted. [#extension: envoy.tracers.opencensus]

"traceConfig": .solo.io.envoy.config.trace.v3.TraceConfig
"ocagentExporterEnabled": bool
"httpAddress": string
"grpcAddress": .solo.io.envoy.config.trace.v3.OpenCensusConfig.OcagentGrpcAddress
"incomingTraceContext": []solo.io.envoy.config.trace.v3.OpenCensusConfig.TraceContext
"outgoingTraceContext": []solo.io.envoy.config.trace.v3.OpenCensusConfig.TraceContext
Field Type Description
traceConfig .solo.io.envoy.config.trace.v3.TraceConfig Configuration of when to submit traces to the collector. See https://github.com/census-instrumentation/opencensus-proto/blob/3619b5dda8bff26ff1974714c24de8f6d4953811/src/opencensus/proto/trace/v1/trace_config.proto#L29 for full documentation.
ocagentExporterEnabled bool Enables the OpenCensus agent if set to true.
httpAddress string Send to upstream over http. Only one of httpAddress or grpcAddress can be set.
grpcAddress .solo.io.envoy.config.trace.v3.OpenCensusConfig.OcagentGrpcAddress Send to upstream over GRPC. Only one of grpcAddress or httpAddress can be set.
incomingTraceContext []solo.io.envoy.config.trace.v3.OpenCensusConfig.TraceContext List of incoming trace context headers to accept. First one found wins.
outgoingTraceContext []solo.io.envoy.config.trace.v3.OpenCensusConfig.TraceContext List of outgoing trace context headers we will produce.

OcagentGrpcAddress

"targetUri": string
"statPrefix": string
Field Type Description
targetUri string URI of the target address.
statPrefix string Prefix for statistical measurements.

TraceContext

Name Description
NONE No-op default, no trace context is utilized.
TRACE_CONTEXT W3C Trace-Context format “traceparent:” header.
GRPC_TRACE_BIN Binary “grpc-trace-bin:” header.
CLOUD_TRACE_CONTEXT “X-Cloud-Trace-Context:” header.
B3 X-B3-* headers.

TraceConfig

"probabilitySampler": .solo.io.envoy.config.trace.v3.ProbabilitySampler
"constantSampler": .solo.io.envoy.config.trace.v3.ConstantSampler
"rateLimitingSampler": .solo.io.envoy.config.trace.v3.RateLimitingSampler
"maxNumberOfAttributes": int
"maxNumberOfAnnotations": int
"maxNumberOfMessageEvents": int
"maxNumberOfLinks": int
Field Type Description
probabilitySampler .solo.io.envoy.config.trace.v3.ProbabilitySampler Only one of probabilitySampler, constantSampler, or rateLimitingSampler can be set.
constantSampler .solo.io.envoy.config.trace.v3.ConstantSampler Only one of constantSampler, probabilitySampler, or rateLimitingSampler can be set.
rateLimitingSampler .solo.io.envoy.config.trace.v3.RateLimitingSampler Only one of rateLimitingSampler, probabilitySampler, or constantSampler can be set.
maxNumberOfAttributes int The global default max number of attributes per span.
maxNumberOfAnnotations int The global default max number of annotation events per span.
maxNumberOfMessageEvents int The global default max number of message events per span.
maxNumberOfLinks int The global default max number of link entries per span.

ProbabilitySampler

Sampler that tries to uniformly sample traces with a given probability. The probability of sampling a trace is equal to that of the specified probability.

"samplingProbability": float
Field Type Description
samplingProbability float The desired probability of sampling. Must be within [0.0, 1.0].

ConstantSampler

Sampler that always makes a constant decision on span sampling.

"decision": .solo.io.envoy.config.trace.v3.ConstantSampler.ConstantDecision
Field Type Description
decision .solo.io.envoy.config.trace.v3.ConstantSampler.ConstantDecision

ConstantDecision

How spans should be sampled:

Name Description
ALWAYS_OFF
ALWAYS_ON
ALWAYS_PARENT

RateLimitingSampler

Sampler that tries to sample with a rate per time window.

"qps": int
Field Type Description
qps int Rate per second.