Skip to main content

RecordingObserver

Struct RecordingObserver 

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

An observer that keeps everything it was given, for assertions in tests.

It is cheap, thread-safe and never panics: a poisoned lock is recovered rather than propagated, because a telemetry sink must not turn one test failure into a cascade.

use turnframe_core::ids::WorkflowKey;
use turnframe_core::observe::{Observer, Signal, SignalLabels};
use turnframe_telemetry::RecordingObserver;

let observer = RecordingObserver::new();
observer.observe_labeled(
    &Signal::CommandExecuted,
    &SignalLabels::workflow(WorkflowKey::from("trip")),
);

assert_eq!(observer.count(Signal::CommandExecuted), 1);
assert!(observer.contains(Signal::CommandExecuted));
assert_eq!(observer.labels_of(Signal::CommandExecuted).len(), 1);

Implementations§

Source§

impl RecordingObserver

Source

pub fn new() -> Self

An observer with nothing recorded yet.

Source

pub fn records(&self) -> Vec<RecordedSignal>

Everything recorded so far, in arrival order.

Source

pub fn signals(&self) -> Vec<Signal>

The signals recorded so far, in arrival order.

Source

pub fn count(&self, signal: Signal) -> usize

How many times a signal was recorded.

Source

pub fn contains(&self, signal: Signal) -> bool

Whether a signal was recorded at least once.

Source

pub fn labels_of(&self, signal: Signal) -> Vec<SignalLabels>

The label sets a signal was recorded with, in arrival order.

Source

pub fn durations_of(&self, signal: Signal) -> Vec<Duration>

The durations a latency signal was recorded with, in arrival order.

Source

pub fn len(&self) -> usize

How many signals were recorded in total.

Source

pub fn is_empty(&self) -> bool

Whether nothing was recorded.

Source

pub fn clear(&self)

Drops everything recorded so far.

Trait Implementations§

Source§

impl Debug for RecordingObserver

Source§

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

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

impl Default for RecordingObserver

Source§

fn default() -> Self

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

impl Observer for RecordingObserver

Source§

fn observe(&self, signal: &Signal)

Observes a signal without labels.
Source§

fn observe_labeled(&self, signal: &Signal, labels: &SignalLabels)

Observes a signal with labels. The default drops the labels.
Source§

fn observe_duration( &self, signal: &Signal, duration: Duration, labels: &SignalLabels, )

Observes a duration signal (SignalKind::DurationMillis or SignalKind::DurationMicros) with its measured value. The default drops the value and forwards to Observer::observe_labeled.

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<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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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