Struct Options

pub struct Options {
    pub max_batch_size: usize,
    pub max_concurrent_batches: usize,
    pub batch_timeout: Duration,
    pub pending_work_capacity: usize,
    pub user_agent_addition: Option<String>,
}

Options includes various options to tweak the behavious of the sender.

Fields

max_batch_size: usize

how many events to collect into a batch before sending. Overrides DEFAULT_MAX_BATCH_SIZE.

max_concurrent_batches: usize

how many batches can be inflight simultaneously. Overrides DEFAULT_MAX_CONCURRENT_BATCHES.

batch_timeout: Duration

how often to send off batches. Overrides DEFAULT_BATCH_TIMEOUT.

pending_work_capacity: usize

how many events to allow to pile up. Overrides DEFAULT_PENDING_WORK_CAPACITY

user_agent_addition: Option<String>

user_agent_addition is an option that allows you to augment the “User-Agent” header that libhoney sends along with each event. The default User-Agent is “libhoney-go/”. If you set this variable, its contents will be appended to the User-Agent string, separated by a space. The expected format is product-name/version, eg “myapp/1.0”

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.