Struct 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) -> BatchConfigBuilder

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

Corresponding environment variable: OTEL_BSP_MAX_QUEUE_SIZE.

Note: Programmatically setting this will override any value set via the environment variable.

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

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

Corresponding environment variable: OTEL_BSP_MAX_EXPORT_BATCH_SIZE.

Note: Programmatically setting this will override any value set via the environment variable.

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

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

Corresponding environment variable: OTEL_BSP_SCHEDULE_DELAY.

Note: Programmatically setting this will override any value set via the environment variable.

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<(), Error>

Formats the value using the given formatter.

impl Default for BatchConfigBuilder

fn default() -> BatchConfigBuilder

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_BSP_MAX_QUEUE_SIZE
• OTEL_BSP_SCHEDULE_DELAY
• OTEL_BSP_MAX_EXPORT_BATCH_SIZE
• OTEL_BSP_EXPORT_TIMEOUT
• OTEL_BSP_MAX_CONCURRENT_EXPORTS

Note: Programmatic configuration overrides any value set via the environment variable.