Struct BetterStackDrainBuilder 

pub struct BetterStackDrainBuilder<F = AcceptAll> { /* private fields */ }

Available on crate feature better-stack only.

Builder for the Better Stack log drain.

Implementations

impl BetterStackDrainBuilder

pub const fn new() -> Self

Create a new drain builder.

impl<F> BetterStackDrainBuilder<F>

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

Set the log message queue capacity or None for unlimited (the default is None).

pub fn max_concurrency(self, max_concurrency: usize) -> Self

Set the maximum number of concurrent message sends (the default is 16).

pub fn request_timeout(self, timeout: Duration) -> Self

Set the request timeout (the default is 60 seconds).

pub fn initial_retry_delay(self, initial_retry_delay: Duration) -> Self

Set the initial retry delay (the default is 1 second).

pub fn max_retry_delay(self, max_retry_delay: Duration) -> Self

Set the maximum retry delay (the default is 60 seconds).

pub fn max_retries(self, max_retries: Option<u32>) -> Self

Set the maximum number of retries or None for unlimited (the default is unlimited).

pub fn kv_filter<K, T>( self, fallback_field: K, filter: T, ) -> BetterStackDrainBuilder<T>

where K: Into<Key>,

Use a given key-value pair filter.

All key-value pairs rejected by the filter will be serialized under a given fallback field.

This feature can be used if you want Better Stack to index only a given subset of fields.

pub fn debug_mode(self, enable: bool) -> Self

Enable or disable debug mode (the default is disabled).

In the debug mode you’ll be able to see some runtime info on stderr that will help you with setting up the drain (e.g. failed requests). With debug mode disabled, all errors will be silently ignored.

pub fn build( self, ingesting_host: &str, source_token: &str, ) -> Result<(BetterStackDrain<F>, CloudDrainTask, BetterStackDrainHandle), Error>

Build the drain.

pub fn spawn_task( self, ingesting_host: &str, source_token: &str, ) -> Result<(BetterStackDrain<F>, BetterStackDrainHandle), Error>

Build the drain and spawn a tokio task responsible for sending log messages.

pub fn spawn_thread( self, ingesting_host: &str, source_token: &str, ) -> Result<(BetterStackDrain<F>, BetterStackDrainHandle), Error>

Build the drain and spawn a thread responsible for sending log messages.

Trait Implementations

impl Default for BetterStackDrainBuilder

fn default() -> Self

Returns the “default value” for a type.