Struct ringlog::SamplingLogBuilder

pub struct SamplingLogBuilder { /* private fields */ }

A type to construct a basic RingLog which routes 1 in N log messages to a single Output.

Implementations

impl SamplingLogBuilder

pub fn new() -> Self

Create a new log builder.

pub fn log_queue_depth(self, messages: usize) -> Self

Sets the depth of the log queue. Deeper queues are less likely to drop messages, but come at the cost of additional memory utilization.

pub fn single_message_size(self, bytes: usize) -> Self

Sets the buffer size for a single message. Oversized messages will result in an extra allocation, but keeping this small allows deeper queues for the same total buffer size without dropping log messages.

pub fn output(self, output: Box<dyn Output>) -> Self

Sets the output for the logger.

pub fn format(self, format: FormatFunction) -> Self

Sets the format function to be used to format messages to this log.

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

Sets the sampling to 1 in N requests

pub fn build(self) -> Result<RingLog, &'static str>

Consumes the builder and returns an RingLog.

Trait Implementations

impl Default for SamplingLogBuilder

fn default() -> Self

Returns the “default value” for a type.