Skip to main content

BatchOptions

Struct BatchOptions 

Source
pub struct BatchOptions {
    pub max_queue_size: usize,
    pub max_batch_size: usize,
    pub max_batch_bytes: usize,
    pub flush_interval: Duration,
    pub export_timeout: Duration,
    pub drop_policy: DropPolicy,
    pub gzip: bool,
    pub max_export_retries: u32,
    pub retry_backoff: Duration,
    pub on_drop: Option<DropCallback>,
    pub on_error: Option<ErrorCallback>,
}
Expand description

Batch processor options (SPEC §4 BatchOptions).

Fields§

§max_queue_size: usize

Maximum queued records (default 2048).

§max_batch_size: usize

Maximum records per export (default 512).

§max_batch_bytes: usize

Maximum UTF-8 JSON bytes per export (default 1 MiB). A single larger record is sent alone.

§flush_interval: Duration

Export at least this often (default 1 s).

§export_timeout: Duration

Deadline per export attempt (default 30 s); also the Block wait limit.

§drop_policy: DropPolicy

Queue-full behaviour (default DropPolicy::DropNewest).

§gzip: bool

Ask the exporter to gzip payloads (default true).

§max_export_retries: u32

Extra attempts for a batch whose export failed with a retryable error (default 2).

§retry_backoff: Duration

Wait before retry n (1-based) is retry_backoff * 2^(n-1) (default 200 ms).

§on_drop: Option<DropCallback>

Called with records that were dropped.

§on_error: Option<ErrorCallback>

Called when an export fails or partially fails.

Implementations§

Source§

impl BatchOptions

Source

pub fn max_queue_size(self, n: usize) -> Self

Sets max_queue_size.

Source

pub fn max_batch_size(self, n: usize) -> Self

Sets max_batch_size.

Source

pub fn max_batch_bytes(self, n: usize) -> Self

Sets max_batch_bytes.

Source

pub fn flush_interval(self, d: Duration) -> Self

Sets flush_interval.

Source

pub fn export_timeout(self, d: Duration) -> Self

Sets export_timeout.

Source

pub fn drop_policy(self, p: DropPolicy) -> Self

Sets drop_policy.

Source

pub fn gzip(self, on: bool) -> Self

Sets gzip.

Source

pub fn max_export_retries(self, n: u32) -> Self

Sets max_export_retries.

Source

pub fn retry_backoff(self, d: Duration) -> Self

Sets retry_backoff.

Source

pub fn on_drop( self, f: impl Fn(&[LogRecord], DropReason) + Send + Sync + 'static, ) -> Self

Sets the drop callback.

Source

pub fn on_error( self, f: impl Fn(&Error, &[LogRecord]) + Send + Sync + 'static, ) -> Self

Sets the error callback.

Source

pub fn validate(&self) -> Result<()>

Checks that every limit and duration is positive.

Trait Implementations§

Source§

impl Clone for BatchOptions

Source§

fn clone(&self) -> Self

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 BatchOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BatchOptions

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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