Struct OpenTelemetryConfig

pub struct OpenTelemetryConfig {
    pub grpc_service: Option<GrpcService>,
    pub http_service: Option<HttpService>,
    pub service_name: String,
    pub resource_detectors: Vec<TypedExtensionConfig>,
    pub sampler: Option<TypedExtensionConfig>,
}

Configuration for the OpenTelemetry tracer. [#extension: envoy.tracers.opentelemetry] [#next-free-field: 6]

Fields

grpc_service: Option<GrpcService>

The upstream gRPC cluster that will receive OTLP traces. Note that the tracer drops traces if the server does not read data fast enough. This field can be left empty to disable reporting traces to the gRPC service. Only one of grpc_service, http_service may be used.

http_service: Option<HttpService>

The upstream HTTP cluster that will receive OTLP traces. This field can be left empty to disable reporting traces to the HTTP service. Only one of grpc_service, http_service may be used.

.. note::

Note: The request_headers_to_add property in the OTLP HTTP exporter service does not support the :ref:format specifier <config_access_log_format> as used for :ref:HTTP access logging <config_access_log>. The values configured are added as HTTP headers on the OTLP export request without any formatting applied.

service_name: String

The name for the service. This will be populated in the ResourceSpan Resource attributes. If it is not provided, it will default to “unknown_service:envoy”.

resource_detectors: Vec<TypedExtensionConfig>

An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]

sampler: Option<TypedExtensionConfig>

Specifies the sampler to be used by the OpenTelemetry tracer. The configured sampler implements the Sampler interface defined by the OpenTelemetry specification. This field can be left empty. In this case, the default Envoy sampling decision is used.

See: OpenTelemetry sampler specification <<https://opentelemetry.io/docs/specs/otel/trace/sdk/#sampler>_> [#extension-category: envoy.tracers.opentelemetry.samplers]

Trait Implementations

impl Clone for OpenTelemetryConfig

fn clone(&self) -> OpenTelemetryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenTelemetryConfig

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

Formats the value using the given formatter.

impl Default for OpenTelemetryConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for OpenTelemetryConfig

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 OpenTelemetryConfig

const NAME: &'static str = "OpenTelemetryConfig"

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 OpenTelemetryConfig

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