Struct cadence::SpyMetricSink

pub struct SpyMetricSink { /* private fields */ }

MetricSink implementation that writes all metrics to the Sender half of a channel while callers are given ownership of the Receiver half.

This is not a general purpose sink, rather it’s a sink meant for verifying metrics written during the course of integration tests. By default, the channel used is unbounded. The channel size can be limited using the with_capacity method.

Each metric is sent to the underlying channel when the .emit() method is called, in the thread of the caller.

Implementations

impl SpyMetricSink

pub fn new() -> (Receiver<Vec<u8>>, Self)

pub fn with_capacity(queue: usize) -> (Receiver<Vec<u8>>, Self)

Trait Implementations

impl Debug for SpyMetricSink

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

Formats the value using the given formatter.

impl MetricSink for SpyMetricSink

fn emit(&self, metric: &str) -> Result<usize>

Send the Statsd metric using this sink and return the number of bytes written or an I/O error.

fn flush(&self) -> Result<()>

Flush any currently buffered metrics to the underlying backend, returning an I/O error if they could not be written for some reason.

fn stats(&self) -> SinkStats

Return I/O telemetry like bytes / packets sent or dropped.