Struct InMemoryMetricExporter

pub struct InMemoryMetricExporter { /* private fields */ }

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

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

Panics

This exporter may panic

• if there’s an issue with locking the metrics Mutex, such as if the Mutex is poisoned.
• the data point recorded is not one of [i64, u64, f64]. This shouldn’t happen if used with OpenTelemetry API.

Example

// Create an InMemoryMetricExporter
 let exporter = InMemoryMetricExporter::default();

 // Create a MeterProvider and register the exporter
 let meter_provider = metrics::SdkMeterProvider::builder()
     .with_reader(PeriodicReader::builder(exporter.clone()).build())
     .build();

 // Create and record metrics using the MeterProvider
 let meter = meter_provider.meter("example");
 let counter = meter.u64_counter("my_counter").build();
 counter.add(1, &[KeyValue::new("key", "value")]);

 meter_provider.force_flush().unwrap();

 // Retrieve the finished metrics from the exporter
 let finished_metrics = exporter.get_finished_metrics().unwrap();

 // Print the finished metrics
for resource_metrics in finished_metrics {
     println!("{:?}", resource_metrics);
 }

Implementations

impl InMemoryMetricExporter

pub fn get_finished_metrics( &self, ) -> Result<Vec<ResourceMetrics>, InMemoryExporterError>

Returns the finished metrics as a vector of ResourceMetrics.

Errors

Returns a MetricError if the internal lock cannot be acquired.

Example

let exporter = InMemoryMetricExporter::default();
let finished_metrics = exporter.get_finished_metrics().unwrap();

pub fn reset(&self)

Clears the internal storage of finished metrics.

Example

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

Trait Implementations

impl Clone for InMemoryMetricExporter

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InMemoryMetricExporter

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

Formats the value using the given formatter.

impl Default for InMemoryMetricExporter

fn default() -> Self

Returns the “default value” for a type.

impl PushMetricExporter for InMemoryMetricExporter

async fn export(&self, metrics: &ResourceMetrics) -> OTelSdkResult

Export serializes and transmits metric data to a receiver.

fn force_flush(&self) -> OTelSdkResult

Flushes any metric data held by an exporter.

fn shutdown(&self) -> OTelSdkResult

Shutdown with the default timeout of 5 seconds.

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

Releases any held computational resources.

fn temporality(&self) -> Temporality

Access the Temporality of the MetricExporter.