Struct ZipkinConfig

pub struct ZipkinConfig {
    pub collector_cluster: String,
    pub collector_endpoint: String,
    pub trace_id_128bit: bool,
    pub shared_span_context: Option<BoolValue>,
    pub collector_endpoint_version: i32,
    pub collector_hostname: String,
    pub split_spans_for_request: bool,
}

Configuration for the Zipkin tracer. [#extension: envoy.tracers.zipkin] [#next-free-field: 8]

Fields

collector_cluster: String

The cluster manager cluster that hosts the Zipkin collectors.

collector_endpoint: String

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: Option<BoolValue>

Determines whether client and server spans will share the same span context. The default value is true.

collector_endpoint_version: i32

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 :ref:collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster> above.

split_spans_for_request: bool

👎Deprecated

If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases:

• The Envoy Proxy is used as gateway or ingress.
• The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled.
• Any case that the :ref:start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span> is set to true.

.. attention::

If this is set to true, then the :ref:start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span> SHOULD be set to true also to ensure the correctness of trace chain.

Both this field and start_child_span are deprecated by the :ref:spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>. Please use that spawn_upstream_span field to control the span creation.

Implementations

impl ZipkinConfig

pub fn collector_endpoint_version(&self) -> CollectorEndpointVersion

Returns the enum value of collector_endpoint_version, or the default if the field is set to an invalid enum value.

pub fn set_collector_endpoint_version( &mut self, value: CollectorEndpointVersion, )

Sets collector_endpoint_version to the provided enum value.

Trait Implementations

impl Clone for ZipkinConfig

fn clone(&self) -> ZipkinConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZipkinConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ZipkinConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for ZipkinConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for ZipkinConfig

const NAME: &'static str = "ZipkinConfig"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.config.trace.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for ZipkinConfig

fn eq(&self, other: &ZipkinConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ZipkinConfig