Struct TonicExporterBuilder

pub struct TonicExporterBuilder { /* private fields */ }

Available on crate feature grpc-tonic only.

Configuration for the tonic OTLP GRPC exporter.

It allows you to

• add additional metadata
• set tls config (via the tls feature)
• specify custom channels

Examples

use opentelemetry_sdk::metrics::reader::{
    DefaultTemporalitySelector,
};

// Create a span exporter you can use to when configuring tracer providers
let span_exporter = opentelemetry_otlp::new_exporter().tonic().build_span_exporter()?;

// Create a metrics exporter you can use when configuring meter providers
let metrics_exporter = opentelemetry_otlp::new_exporter()
    .tonic()
    .build_metrics_exporter(
        Box::new(DefaultTemporalitySelector::new()),
    )?;

// Create a log exporter you can use when configuring logger providers
let log_exporter = opentelemetry_otlp::new_exporter().tonic().build_log_exporter()?;

Implementations

impl TonicExporterBuilder

pub fn with_tls_config(self, tls_config: ClientTlsConfig) -> Self

Available on crate feature tls only.

Set the TLS settings for the collector endpoint.

pub fn with_metadata(self, metadata: MetadataMap) -> Self

Set custom metadata entries to send to the collector.

pub fn with_compression(self, compression: Compression) -> Self

Set the compression algorithm to use when communicating with the collector.

pub fn with_channel(self, channel: Channel) -> Self

Use channel as tonic’s transport channel. this will override tls config and should only be used when working with non-HTTP transports.

Users MUST make sure the ExportConfig::timeout is the same as the channel’s timeout.

pub fn with_interceptor<I>(self, interceptor: I) -> Self

where I: Interceptor + Clone + Send + Sync + 'static,

Use a custom interceptor to modify each outbound request. this can be used to modify the grpc metadata, for example to inject auth tokens.

pub fn build_log_exporter(self) -> Result<LogExporter, LogError>

Available on crate feature logs only.

Build a new tonic log exporter

pub fn build_metrics_exporter( self, temporality_selector: Box<dyn TemporalitySelector>, ) -> Result<MetricsExporter>

Available on crate feature metrics only.

Build a new tonic metrics exporter

pub fn build_span_exporter(self) -> Result<SpanExporter, TraceError>

Available on crate feature trace only.

Build a new tonic span exporter

Trait Implementations

impl Debug for TonicExporterBuilder

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

Formats the value using the given formatter.

impl Default for TonicExporterBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<TonicExporterBuilder> for LogExporterBuilder

Available on crate feature logs only.

fn from(exporter: TonicExporterBuilder) -> Self

Converts to this type from the input type.

impl From<TonicExporterBuilder> for MetricsExporterBuilder

Available on crate feature metrics only.

fn from(exporter: TonicExporterBuilder) -> Self

Converts to this type from the input type.

impl From<TonicExporterBuilder> for SpanExporterBuilder

Available on crate feature trace only.

fn from(exporter: TonicExporterBuilder) -> Self

Converts to this type from the input type.

impl HasExportConfig for TonicExporterBuilder

fn export_config(&mut self) -> &mut ExportConfig

Return a mutable reference to the export config within the exporter builders.