Enum opentelemetry_otlp::SpanExporter

pub enum SpanExporter {
    Tonic {
        timeout: Duration,
        metadata: Option<MetadataMap>,
        trace_exporter: TonicTraceServiceClient<TonicChannel>,
    },
    Grpcio {
        timeout: Duration,
        headers: Option<HashMap<String, String>>,
        trace_exporter: GrpcioTraceServiceClient,
    },
    Http {
        timeout: Duration,
        headers: Option<HashMap<String, String>>,
        collector_endpoint: Uri,
        trace_exporter: Option<Arc<dyn HttpClient>>,
    },
}

Available on crate feature trace only.

OTLP exporter that sends tracing information

Variants

Tonic

Fields

timeout: Duration

Duration of timeout when sending spans to backend.

metadata: Option<MetadataMap>

Additional headers of the outbound requests.

trace_exporter: TonicTraceServiceClient<TonicChannel>

The Grpc trace exporter

Available on crate feature grpc-tonic only.

Trace Exporter using tonic as grpc layer.

Grpcio

Fields

timeout: Duration

Duration of timeout when sending spans to backend.

headers: Option<HashMap<String, String>>

Additional headers of the outbound requests.

trace_exporter: GrpcioTraceServiceClient

The Grpc trace exporter

Available on crate feature grpc-sys only.

Trace Exporter using grpcio as grpc layer

Http

Fields

timeout: Duration

Duration of timeout when sending spans to backend.

headers: Option<HashMap<String, String>>

Additional headers of the outbound requests.

collector_endpoint: Uri

The Collector URL

trace_exporter: Option<Arc<dyn HttpClient>>

The HTTP trace exporter

Available on crate feature http-proto only.

Trace Exporter using HTTP transport

Implementations

impl SpanExporter

pub fn new_tonic(
    config: ExportConfig,
    tonic_config: TonicConfig
) -> Result<Self, Error>

Available on crate feature grpc-tonic only.

Builds a new span exporter with the given configuration.

pub fn from_tonic_channel(
    config: ExportConfig,
    tonic_config: TonicConfig,
    channel: Channel
) -> Result<Self, Error>

Available on crate feature grpc-tonic only.

Builds a new span exporter with given tonic channel.

This allows users to bring their own custom channel like UDS. However, users MUST make sure the ExportConfig::timeout is the same as the channel’s timeout.

pub fn new_grpcio(config: ExportConfig, grpcio_config: GrpcioConfig) -> Self

Available on crate feature grpc-sys only.

Builds a new span exporter with the given configuration

pub fn new_http(
    config: ExportConfig,
    http_config: HttpConfig
) -> Result<Self, Error>

Available on crate feature http-proto only.

Builds a new span exporter with the given configuration

Trait Implementations

impl Debug for SpanExporter

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

Formats the value using the given formatter.

impl SpanExporter for SpanExporter

fn export(&mut self, batch: Vec<SpanData>) -> BoxFuture<'static, ExportResult>

Exports a batch of readable spans. Protocol exporters that will implement this function are typically expected to serialize and transmit the data to the destination.

fn shutdown(&mut self)

Shuts down the exporter. Called when SDK is shut down. This is an opportunity for exporter to do any cleanup required.

fn force_flush(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), TraceError>> + Send + 'static, Global>>

This is a hint to ensure that the export of any Spans the exporter has received prior to the call to this function SHOULD be completed as soon as possible, preferably before returning from this method.