Struct hotmic::Configuration

pub struct Configuration<T> { /* fields omitted */ }

A configuration builder for Receiver.

Methods

impl<T: Send + Eq + Hash + Display + Clone> Configuration<T>

pub fn new() -> Configuration<T>

Creates a new Configuration with default values.

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

Sets the buffer capacity.

Defaults to 4096.

This controls the size of the channel used to send metrics. This channel is shared amongst all active sinks. If this channel is full when sending a metric, that send will be blocked until the channel has free space.

Tweaking this value allows for a trade-off between low memory consumption and throughput burst capabilities. By default, we expect samples to occupy approximately 64 bytes. Thus, at our default value, we preallocate roughly ~232kB.

Generally speaking, sending and processing metrics is fast enough that the default value of 4096 supports millions of samples per second.

pub fn build(self) -> Receiver<T>

Create a Receiver based on this configuration.

Trait Implementations

impl<T> Default for Configuration<T>

fn default() -> Configuration<T>

Returns the "default value" for a type.

impl<T: Clone> Clone for Configuration<T>

fn clone(&self) -> Configuration<T>

Returns a copy of the value.

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

Performs copy-assignment from source.