Struct BatchSpanProcessor 

pub struct BatchSpanProcessor { /* private fields */ }

The BatchSpanProcessor collects finished spans in a buffer and exports them in batches to the configured SpanExporter. This processor is ideal for high-throughput environments, as it minimizes the overhead of exporting spans individually. It uses a dedicated background thread to manage and export spans asynchronously, ensuring that the application’s main execution flow is not blocked.

This processor supports the following configurations:

• Queue size: Maximum number of spans that can be buffered.
• Batch size: Maximum number of spans to include in a single export.
• Scheduled delay: Frequency at which the batch is exported.

When using this processor with the OTLP Exporter, the following exporter features are supported:

• grpc-tonic: Requires TracerProvider to be created within a tokio runtime.
• reqwest-blocking-client: Works with a regular main or tokio::main.

In other words, async HTTP clients like reqwest-client and hyper-client are not supported by this default processor. The OTLP HTTP exporter chooses its default HTTP client from enabled crate features and cannot tell which processor will drive it. If your dependency graph enables async HTTP client features, either pass an explicit blocking client for this processor or use the experimental async-runtime batch span processor.

BatchSpanProcessor buffers spans in memory and exports them in batches. An export is triggered when max_export_batch_size is reached or every scheduled_delay milliseconds. Users can explicitly trigger an export using the force_flush method. Shutdown also triggers an export of all buffered spans and is recommended to be called before the application exits to ensure all buffered spans are exported.

Warning: When using tokio’s current-thread runtime, shutdown(), which is a blocking call ,should not be called from your main thread. This can cause deadlock. Instead, call shutdown() from a separate thread or use tokio’s spawn_blocking.

Implementations

impl BatchSpanProcessor

pub fn new<E>(exporter: E, config: BatchConfig) -> Self

where E: SpanExporter + Send + 'static,

Creates a new instance of BatchSpanProcessor.

pub fn builder<E>(exporter: E) -> BatchSpanProcessorBuilder<E>

where E: SpanExporter + Send + 'static,

builder

Trait Implementations

impl Debug for BatchSpanProcessor

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

Formats the value using the given formatter.

impl SpanProcessor for BatchSpanProcessor

fn on_start(&self, _span: &mut Span, _cx: &Context)

Handles span start.

fn on_end(&self, span: SpanData)

Handles span end.

fn force_flush(&self) -> OTelSdkResult

Flushes all pending spans.

fn shutdown_with_timeout(&self, timeout: Duration) -> OTelSdkResult

Shuts down the processor.

fn set_resource(&mut self, resource: &Resource)

Set the resource for the processor.

fn shutdown(&self) -> OTelSdkResult

shutdown the processor with a default timeout.