Struct cadence::QueuingMetricSinkBuilder

pub struct QueuingMetricSinkBuilder { /* private fields */ }

Implementation of a builder pattern for QueuingMetricSink.

The builder can be used to set an error handler for the sink being wrapped by a QueuingMetricSink as well as setting the capacity of the QueuingMetricSink.

Example

use cadence::{MetricSink, QueuingMetricSinkBuilder, NopMetricSink};

let queue_size = 64 * 1024;
let wrapped = NopMetricSink;

let queuing = QueuingMetricSinkBuilder::new()
    .with_capacity(queue_size)
    .with_error_handler(|e| {
        eprintln!("Error while sending metrics: {:?}", e);
    })
    .build(wrapped);

queuing.emit("foo.counter:4|c");

Implementations

impl QueuingMetricSinkBuilder

pub fn new() -> Self

Construct a new builder.

pub fn build<T>(self, sink: T) -> QueuingMetricSink

where T: MetricSink + Sync + Send + RefUnwindSafe + 'static,

Construct a new QueuingMetricSink instance wrapping another sink based on the builder configuration.

pub fn with_error_handler<F>(self, error_handler: F) -> Self

where F: Fn(Error) + Sync + Send + RefUnwindSafe + 'static,

Set error handler called when the wrapped sink fails to emit a metric.

The error handler will be run in the same thread as the wrapped sink and must not panic.

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

Set queue size used to send metrics to the wrapped sink.

See QueuingMetricSink::with_capacity for more information.

Trait Implementations

impl Default for QueuingMetricSinkBuilder

fn default() -> QueuingMetricSinkBuilder

Returns the “default value” for a type.