OpenCensus tracer

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/trace/v2/opencensus.proto

config.trace.v3.OpenCensusConfig

[config.trace.v3.OpenCensusConfig proto]

Configuration for the OpenCensus tracer.

This extension may be referenced by the qualified name envoy.tracers.opencensus

Note

This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

Tip

This extension extends and can be used with the following extension category:

  1. {
  2.   "trace_config": "{...}",
  3.   "stdout_exporter_enabled": "...",
  4.   "stackdriver_exporter_enabled": "...",
  5.   "stackdriver_project_id": "...",
  6.   "stackdriver_address": "...",
  7.   "stackdriver_grpc_service": "{...}",
  8.   "zipkin_exporter_enabled": "...",
  9.   "zipkin_url": "...",
  10.   "ocagent_exporter_enabled": "...",
  11.   "ocagent_address": "...",
  12.   "ocagent_grpc_service": "{...}",
  13.   "incoming_trace_context": [],
  14.   "outgoing_trace_context": []
  15. }

trace_config

(.opencensus.proto.trace.v1.TraceConfig) Configures tracing, e.g. the sampler, max number of annotations, etc.

stdout_exporter_enabled

(bool) Enables the stdout exporter if set to true. This is intended for debugging purposes.

stackdriver_exporter_enabled

(bool) Enables the Stackdriver exporter if set to true. The project_id must also be set.

stackdriver_project_id

(string) The Cloud project_id to use for Stackdriver tracing.

stackdriver_address

(string) (optional) By default, the Stackdriver exporter will connect to production Stackdriver. If stackdriver_address is non-empty, it will instead connect to this address, which is in the gRPC format: https://github.com/grpc/grpc/blob/master/doc/naming.md

stackdriver_grpc_service

(config.core.v3.GrpcService) (optional) The gRPC server that hosts Stackdriver tracing service. Only Google gRPC is supported. If target_uri is not provided, the default production Stackdriver address will be used.

zipkin_exporter_enabled

(bool) Enables the Zipkin exporter if set to true. The url and service name must also be set. This is deprecated, prefer to use Envoy’s native Zipkin tracer.

zipkin_url

(string) The URL to Zipkin, e.g. “http://127.0.0.1:9411/api/v2/spans”. This is deprecated, prefer to use Envoy’s native Zipkin tracer.

ocagent_exporter_enabled

(bool) Enables the OpenCensus Agent exporter if set to true. The ocagent_address or ocagent_grpc_service must also be set.

ocagent_address

(string) The address of the OpenCensus Agent, if its exporter is enabled, in gRPC format: https://github.com/grpc/grpc/blob/master/doc/naming.md

ocagent_grpc_service

(config.core.v3.GrpcService) (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported. This is only used if the ocagent_address is left empty.

incoming_trace_context

(repeated config.trace.v3.OpenCensusConfig.TraceContext) List of incoming trace context headers we will accept. First one found wins.

outgoing_trace_context

(repeated config.trace.v3.OpenCensusConfig.TraceContext) List of outgoing trace context headers we will produce.

Enum config.trace.v3.OpenCensusConfig.TraceContext

[config.trace.v3.OpenCensusConfig.TraceContext proto]

NONE

(DEFAULT) ⁣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.