Struct cadence::SpyMetricSink

pub struct SpyMetricSink { /* fields omitted */ }

MetricSink implementation that writes all metrics to a shared Write instance that callers retain a reference to.

This is not a general purpose sink, rather it's a sink meant for verifying metrics written during the course of integration tests. Due to the requirement that callers retain a shared reference to the underlying Write implementation, this sink uses more locking (mutexes) than other sinks in Cadence. Thus, it should not be used in production, only testing.

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

Implementations

impl SpyMetricSink

pub fn from(
    writer: Arc<Mutex<dyn Write + Send + RefUnwindSafe + 'static>>
) -> 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.