Struct OpenCensusConfig

pub struct OpenCensusConfig {

    pub trace_config: Option<TraceConfig>,
    pub stdout_exporter_enabled: bool,
    pub stackdriver_exporter_enabled: bool,
    pub stackdriver_project_id: String,
    pub stackdriver_address: String,
    pub stackdriver_grpc_service: Option<GrpcService>,
    pub zipkin_exporter_enabled: bool,
    pub zipkin_url: String,
    pub ocagent_exporter_enabled: bool,
    pub ocagent_address: String,
    pub ocagent_grpc_service: Option<GrpcService>,
    pub incoming_trace_context: Vec<i32>,
    pub outgoing_trace_context: Vec<i32>,
}

Configuration for the OpenCensus tracer. [#next-free-field: 15] [#extension: envoy.tracers.opencensus]

Fields

trace_config: Option<TraceConfig>

👎Deprecated

Configures tracing, e.g. the sampler, max number of annotations, etc.

stdout_exporter_enabled: bool

👎Deprecated

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

stackdriver_exporter_enabled: bool

👎Deprecated

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

stackdriver_project_id: String

👎Deprecated

The Cloud project_id to use for Stackdriver tracing.

stackdriver_address: String

👎Deprecated

(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: Option<GrpcService>

👎Deprecated

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

zipkin_exporter_enabled: bool

👎Deprecated

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 :ref:native Zipkin tracer <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>.

zipkin_url: String

👎Deprecated

The URL to Zipkin, e.g. “http://127.0.0.1:9411/api/v2/spans". This is deprecated, prefer to use Envoy’s :ref:native Zipkin tracer <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>.

ocagent_exporter_enabled: bool

👎Deprecated

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

ocagent_address: String

👎Deprecated

The address of the OpenCensus Agent, if its exporter is enabled, in gRPC format: https://github.com/grpc/grpc/blob/master/doc/naming.md [#comment:TODO: deprecate this field]

ocagent_grpc_service: Option<GrpcService>

👎Deprecated

(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: Vec<i32>

👎Deprecated

List of incoming trace context headers we will accept. First one found wins.

outgoing_trace_context: Vec<i32>

👎Deprecated

List of outgoing trace context headers we will produce.

Implementations

impl OpenCensusConfig

pub fn incoming_trace_context( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<TraceContext>>

Returns an iterator which yields the valid enum values contained in incoming_trace_context.

pub fn push_incoming_trace_context(&mut self, value: TraceContext)

Appends the provided enum value to incoming_trace_context.

pub fn outgoing_trace_context( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<TraceContext>>

Returns an iterator which yields the valid enum values contained in outgoing_trace_context.

pub fn push_outgoing_trace_context(&mut self, value: TraceContext)

Appends the provided enum value to outgoing_trace_context.

Trait Implementations

impl Clone for OpenCensusConfig

fn clone(&self) -> OpenCensusConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenCensusConfig

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

Formats the value using the given formatter.

impl Default for OpenCensusConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for OpenCensusConfig

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 OpenCensusConfig

const NAME: &'static str = "OpenCensusConfig"

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 OpenCensusConfig

fn eq(&self, other: &OpenCensusConfig) -> 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 OpenCensusConfig