Zipkin 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/zipkin.proto

config.trace.v3.ZipkinConfig¶

[config.trace.v3.ZipkinConfig proto]

Configuration for the Zipkin tracer.

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

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:

envoy.tracers

{
  "collector_cluster": "...",
  "collector_endpoint": "...",
  "trace_id_128bit": "...",
  "shared_span_context": "{...}",
  "collector_endpoint_version": "...",
  "collector_hostname": "..."
}

collector_cluster: (string, REQUIRED) The cluster manager cluster that hosts the Zipkin collectors.

collector_endpoint: (string, REQUIRED) The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation.

trace_id_128bit: (bool) Determines whether a 128bit trace id will be used when creating a new trace instance. The default value is false, which will result in a 64 bit trace id being used.

shared_span_context: (BoolValue) Determines whether client and server spans will share the same span context. The default value is true.

collector_endpoint_version: (config.trace.v3.ZipkinConfig.CollectorEndpointVersion) Determines the selected collector endpoint version.

collector_hostname: (string) Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to collector_cluster above.

Enum config.trace.v3.ZipkinConfig.CollectorEndpointVersion¶

[config.trace.v3.ZipkinConfig.CollectorEndpointVersion proto]

Available Zipkin collector endpoint versions.

DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE: (DEFAULT) ⁣Zipkin API v1, JSON over HTTP.

HTTP_JSON: ⁣Zipkin API v2, JSON over HTTP.

HTTP_PROTO: ⁣Zipkin API v2, protobuf over HTTP.