Trait opentelemetry::exporter::trace::SpanExporter

pub trait SpanExporter: Send + Sync + Debug {
#[must_use]    fn export<'life0, 'async_trait>(
        &'life0 self, 
        batch: Vec<SpanData>
    ) -> Pin<Box<dyn Future<Output = ExportResult> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;

    fn shutdown(&mut self) { ... }
}

SpanExporter defines the interface that protocol-specific exporters must implement so that they can be plugged into OpenTelemetry SDK and support sending of telemetry data.

The goals of the interface are:

• Minimize burden of implementation for protocol-dependent telemetry exporters. The protocol exporter is expected to be primarily a simple telemetry data encoder and transmitter.
• Allow implementing helpers as composable components that use the same chainable Exporter interface. SDK authors are encouraged to implement common functionality such as queuing, batching, tagging, etc. as helpers. This functionality will be applicable regardless of what protocol exporter is used.

Required methods

#[must_use]fn export<'life0, 'async_trait>(
    &'life0 self,
    batch: Vec<SpanData>
) -> Pin<Box<dyn Future<Output = ExportResult> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

This function will never be called concurrently for the same exporter instance. It can be called again only after the current call returns.

This function must not block indefinitely, there must be a reasonable upper limit after which the call must time out with an error result.

Loading content...

Provided methods

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.

shutdown should be called only once for each Exporter instance. After the call to shutdown, subsequent calls to SpanExport are not allowed and should return an error.

Shutdown should not block indefinitely (e.g. if it attempts to flush the data and the destination is unavailable). SDK authors can decide if they want to make the shutdown timeout to be configurable.

Loading content...

Implementors

impl SpanExporter for NoopSpanExporter

fn export<'life0, 'async_trait>(
    &'life0 self,
    _batch: Vec<SpanData>
) -> Pin<Box<dyn Future<Output = ExportResult> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

impl<W> SpanExporter for Exporter<W> where
    W: Write + Debug + Send + 'static, 

fn export<'life0, 'async_trait>(
    &'life0 self,
    batch: Vec<SpanData>
) -> Pin<Box<dyn Future<Output = ExportResult> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Export spans to stdout

Loading content...