Struct SpanExporterFile 

pub struct SpanExporterFile { /* private fields */ }

An OpenTelemetry exporter that writes Spans to a file on export.

Implementations

impl SpanExporterFile

pub fn new(path: PathBuf) -> Result<Self, OTelSdkError>

Creates a new SpanExporterFile that writes Spans to a file on export.

Arguments

• path - The path where metrics will be written. This can be either a file or directory path.

Behavior

• If the path points to a directory:
  • The directory must exist
  • Metrics will be written to a file named “signals.json” within that directory
• If the path points to a file:
  • If the file exists, new metrics will be appended to it (existing data is preserved)
  • If the file doesn’t exist, it will be created
  • The parent directory must exist

Errors

Returns an error if:

• The parent directory doesn’t exist
• The path points to a directory that doesn’t exist
• The user doesn’t have write permissions for the target location

Trait Implementations

impl Debug for SpanExporterFile

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

Formats the value using the given formatter.

impl SpanExporter for SpanExporterFile

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

Write Spans to JSON file

fn shutdown(&self) -> OTelSdkResult

Shuts down the exporter with default timeout.

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

Set the resource for the exporter.

fn shutdown_with_timeout(&self, _timeout: Duration) -> Result<(), OTelSdkError>

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

fn force_flush(&self) -> Result<(), OTelSdkError>

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.