Struct opentelemetry_sdk::logs::BatchConfigBuilder

pub struct BatchConfigBuilder { /* private fields */ }

A builder for creating BatchConfig instances.

Implementations

impl BatchConfigBuilder

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

Set max_queue_size for BatchConfigBuilder. It’s the maximum queue size to buffer logs for delayed processing. If the queue gets full it will drop the logs. The default value of is 2048.

pub fn with_scheduled_delay(self, scheduled_delay: Duration) -> Self

Set scheduled_delay for BatchConfigBuilder. It’s the delay interval in milliseconds between two consecutive processing of batches. The default value is 1000 milliseconds.

pub fn with_max_export_timeout(self, max_export_timeout: Duration) -> Self

Set max_export_timeout for BatchConfigBuilder. It’s the maximum duration to export a batch of data. The default value is 30000 milliseconds.

pub fn with_max_export_batch_size(self, max_export_batch_size: usize) -> Self

Set max_export_batch_size for BatchConfigBuilder. It’s the maximum number of logs to process in a single batch. If there are more than one batch worth of logs then it processes multiple batches of logs one batch after the other without any delay. The default value is 512.

pub fn build(self) -> BatchConfig

Builds a BatchConfig enforcing the following invariants:

• max_export_batch_size must be less than or equal to max_queue_size.

Trait Implementations

impl Debug for BatchConfigBuilder

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

Formats the value using the given formatter.

impl Default for BatchConfigBuilder

fn default() -> Self

Create a new BatchConfigBuilder initialized with default batch config values as per the specs. The values are overriden by environment variables if set. The supported environment variables are:

• OTEL_BLRP_MAX_QUEUE_SIZE
• OTEL_BLRP_SCHEDULE_DELAY
• OTEL_BLRP_MAX_EXPORT_BATCH_SIZE
• OTEL_BLRP_EXPORT_TIMEOUT