Struct InMemorySpanExporter

pub struct InMemorySpanExporter { /* private fields */ }

An in-memory span exporter that stores span data in memory.

This exporter is useful for testing and debugging purposes. It stores metric data in a Vec<SpanData>. Metrics can be retrieved using the get_finished_spans method.

Example

    let exporter = InMemorySpanExporterBuilder::new().build();
    let provider = SdkTracerProvider::builder()
        .with_span_processor(BatchSpanProcessor::builder(exporter.clone()).build())
        .build();

    global::set_tracer_provider(provider.clone());

    let tracer = global::tracer("example/in_memory_exporter");
    let span = tracer
        .span_builder("say hello")
        .with_kind(SpanKind::Server)
        .start(&tracer);

    let cx = Context::current_with_span(span);
    cx.span().add_event("handling this...", Vec::new());
    cx.span().end();

    if let Err(e) = provider.force_flush() {
        println!("{:?}", e)
    }
    let spans = exporter.get_finished_spans().unwrap();
    for span in spans {
        println!("{:?}", span)
    }

Implementations

impl InMemorySpanExporter

pub fn get_finished_spans(&self) -> Result<Vec<SpanData>, InMemoryExporterError>

Returns the finished span as a vector of SpanData.

Errors

Returns a TraceError if the internal lock cannot be acquired.

Example

let exporter = InMemorySpanExporter::default();
let finished_spans = exporter.get_finished_spans().unwrap();

pub fn reset(&self)

Clears the internal storage of finished spans.

Example

let exporter = InMemorySpanExporter::default();
exporter.reset();

Trait Implementations

impl Clone for InMemorySpanExporter

fn clone(&self) -> InMemorySpanExporter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InMemorySpanExporter

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

Formats the value using the given formatter.

impl Default for InMemorySpanExporter

fn default() -> Self

Returns the “default value” for a type.

impl SpanExporter for InMemorySpanExporter

async fn export(&self, batch: Vec<SpanData>) -> OTelSdkResult

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_with_timeout(&mut self, _timeout: Duration) -> OTelSdkResult

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

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

Set the resource for the exporter.

fn shutdown(&mut self) -> OTelSdkResult

Shuts down the exporter with default timeout.

fn force_flush(&mut self) -> OTelSdkResult

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.