Struct InstrumentedStore

pub(crate) struct InstrumentedStore {
    object_store: ObjectStore,
    write_buffer_size: Option<usize>,
}

A wrapper around [ObjectStore] that adds instrumentation for monitoring metrics such as bytes read, bytes written, and the number of seek operations.

TODO: Consider refactor InstrumentedStore to use async in trait instead of AsyncRead.

Fields

object_store: ObjectStore

The underlying object store.

write_buffer_size: Option<usize>

The size of the write buffer.

Implementations

impl InstrumentedStore

pub fn new(object_store: ObjectStore) -> Self

Create a new InstrumentedStore.

pub fn with_write_buffer_size(self, write_buffer_size: Option<usize>) -> Self

Set the size of the write buffer.

pub async fn range_reader<'a>( &self, path: &str, read_byte_count: &'a IntCounter, read_count: &'a IntCounter, ) -> Result<InstrumentedRangeReader<'a>>

Returns an InstrumentedRangeReader for the given path. Metrics like the number of bytes read are recorded using the provided IntCounter.

pub async fn reader<'a>( &self, path: &str, read_byte_count: &'a IntCounter, read_count: &'a IntCounter, seek_count: &'a IntCounter, ) -> Result<InstrumentedAsyncRead<'a, FuturesAsyncReader>>

Returns an InstrumentedAsyncRead for the given path. Metrics like the number of bytes read, read and seek operations are recorded using the provided IntCounters.

pub async fn writer<'a>( &self, path: &str, write_byte_count: &'a IntCounter, write_count: &'a IntCounter, flush_count: &'a IntCounter, ) -> Result<InstrumentedAsyncWrite<'a, FuturesAsyncWriter>>

Returns an InstrumentedAsyncWrite for the given path. Metrics like the number of bytes written, write and flush operations are recorded using the provided IntCounters.

pub async fn list(&self, path: &str) -> Result<Vec<Entry>>

Proxies to [ObjectStore::list].

pub async fn remove_all(&self, path: &str) -> Result<()>

Proxies to [ObjectStore::remove_all].

Trait Implementations

impl Clone for InstrumentedStore

fn clone(&self) -> InstrumentedStore

Returns a copy of the value.

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

Performs copy-assignment from source.