logo

Trait opentelemetry_sdk::export::trace::SpanExporter

source · [−]
pub trait SpanExporter: Send + Debug {
    fn export(
        &mut self,
        batch: Vec<SpanData>
    ) -> BoxFuture<'static, ExportResult>;

    fn shutdown(&mut self) { ... }
    fn force_flush(&mut self) -> BoxFuture<'static, ExportResult> { ... }
}
Available on crate feature trace only.
Expand description

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 goal of the interface is to minimize burden of implementation for protocol-dependent telemetry exporters. The protocol exporter is expected to be primarily a simple telemetry data encoder and transmitter.

Required Methods

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.

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.

Any retry logic that is required by the exporter is the responsibility of the exporter.

Provided Methods

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

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

This function 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 configurable.

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.

This function SHOULD provide a way to let the caller know whether it succeeded, failed or timed out.

This function SHOULD only be called in cases where it is absolutely necessary, such as when using some FaaS providers that may suspend the process after an invocation, but before the exporter exports the completed spans.

This function SHOULD complete or abort within some timeout. This function can be implemented as a blocking API or an asynchronous API which notifies the caller via a callback or an event. OpenTelemetry client authors can decide if they want to make the flush timeout configurable.

Implementors