Skip to main content

RecordingSink

Struct RecordingSink 

Source
pub struct RecordingSink { /* private fields */ }
Expand description

Append-only in-memory sink for assertions in unit and integration tests.

Clones share the same captured data. Use the typed accessors to inspect all emits or the matching helpers to select one metric name, label subset, or event table.

§Examples

use spectra_core::{RecordingSink, SpectraSink};

let sink = RecordingSink::new();
sink.record_counter("cache_hits", &[("region", "us")], 2);

let hits = sink.recorded_counters_matching("cache_hits", &[("region", "us")]);
assert_eq!(hits.len(), 1);
assert_eq!(hits[0].delta, 2);

sink.clear();
assert!(sink.counters().is_empty());

Implementations§

Source§

impl RecordingSink

Source

pub fn new() -> RecordingSink

Creates an empty recording sink.

Source

pub fn clear(&self)

Clears all recorded emits.

Source

pub fn counters(&self) -> Vec<RecordedCounter>

Returns all recorded counter increments.

Source

pub fn gauges(&self) -> Vec<RecordedGauge>

Returns all recorded gauge samples.

Source

pub fn events(&self) -> Vec<RecordedEvent>

Returns all recorded events.

Source

pub fn recorded_counters_matching( &self, name: &str, label_subset: &[(&str, &str)], ) -> Vec<RecordedCounter>

Returns counters matching a name and label subset.

Source

pub fn recorded_events_for(&self, table: &str) -> Vec<RecordedEvent>

Returns events recorded for a specific table.

Trait Implementations§

Source§

impl Clone for RecordingSink

Source§

fn clone(&self) -> RecordingSink

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecordingSink

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RecordingSink

Source§

fn default() -> RecordingSink

Returns the “default value” for a type. Read more
Source§

impl SpectraSink for RecordingSink

Source§

fn record_counter(&self, name: &str, labels: &[(&str, &str)], delta: i64)

Increment (or decrement) a counter.
Source§

fn record_gauge(&self, name: &str, labels: &[(&str, &str)], value: f64)

Set a gauge value.
Source§

fn log_event(&self, table: &str, fields: &Value)

Append a structured event row.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<U> As for U

Source§

fn as_<T>(self) -> T
where T: CastFrom<U>, U: Sized,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Is for T
where T: ?Sized,

Source§

type EqTo = T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more