Skip to main content

BatchWriter

Struct BatchWriter 

Source
pub struct BatchWriter { /* private fields */ }
Expand description

Async batch writer that buffers telemetry items and flushes them to the underlying store in batches.

Items are added to an in-memory buffer on submit. A background task periodically flushes the buffer to the store. Call flush() for immediate persistence, or shutdown() to drain all remaining items before process exit.

Implementations§

Source§

impl BatchWriter

Source

pub fn new(store: Arc<dyn TraceStore>) -> Self

Create a new batch writer with default configuration.

Starts a background flush task that runs until shutdown() is called.

Source

pub fn with_config( store: Arc<dyn TraceStore>, batch_size: usize, flush_interval_ms: u64, ) -> Self

Create a batch writer with custom batch size and flush interval.

Source

pub fn with_config_and_langfuse( store: Arc<dyn TraceStore>, langfuse: Option<LangfuseExporter>, batch_size: usize, flush_interval_ms: u64, ) -> Self

Create a batch writer with optional Langfuse cloud export.

Source

pub async fn submit(&self, item: TelemetryItem) -> Result<(), StoreError>

Submit a telemetry item for async writing.

The item is added to an in-memory buffer. The buffer is flushed to the store either when it reaches batch_size or on the next periodic flush tick.

§Errors

Returns StoreError::Storage if the store write fails (only when batch size is exceeded and an immediate flush is triggered).

Source

pub async fn submit_trace(&self, trace: Trace) -> Result<(), StoreError>

Submit a trace for async writing.

§Errors

Returns StoreError::Storage if the store write fails.

Source

pub async fn submit_observation( &self, observation: Observation, ) -> Result<(), StoreError>

Submit an observation for async writing.

§Errors

Returns StoreError::Storage if the store write fails.

Source

pub async fn submit_session(&self, session: Session) -> Result<(), StoreError>

Submit a session for async writing.

§Errors

Returns StoreError::Storage if the store write fails.

Source

pub async fn flush(&self) -> Result<(), StoreError>

Flush all buffered items to the store immediately.

Drains the buffer and writes all items to the store. This guarantees all previously submitted items are persisted.

§Errors

Returns StoreError::Storage if any write fails.

Source

pub async fn shutdown(self) -> Result<(), StoreError>

Shutdown the writer, flushing all remaining items.

Signals the background task to stop, then flushes any items still in the buffer.

§Errors

Returns StoreError::Storage if any write fails.

Trait Implementations§

Source§

impl Clone for BatchWriter

Source§

fn clone(&self) -> BatchWriter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BatchWriter

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more