Struct background_jobs::metrics::StatsRecorder

pub struct StatsRecorder { /* private fields */ }

Recorder type for recording background jobs metrics

Implementations

impl StatsRecorder

pub fn install() -> Result<StatsHandle, SetRecorderError<StatsRecorder>>

Install the stats recorder into the process

StatsRecorder::install().expect("Failed to install recorder");

pub fn build() -> (StatsRecorder, StatsHandle)

Build the stats recorder and fetch the handle.

This can be used in conjunction with metrics_util::layers::FanoutBuilder to add it in addition to another recorder

let (jobs_recorder, handle) = StatsRecorder::build();

let recorder = metrics_util::layers::FanoutBuilder::default()
    .add_recorder(jobs_recorder)
    .build();

metrics::set_global_recorder(recorder).expect("Failed to set recorder");

println!("{:?}", handle.get());

Trait Implementations

impl Recorder for StatsRecorder

fn describe_counter(&self, _: KeyName, _: Option<Unit>, _: Cow<'static, str>)

Describes a counter.

fn describe_gauge(&self, _: KeyName, _: Option<Unit>, _: Cow<'static, str>)

Describes a gauge.

fn describe_histogram(&self, _: KeyName, _: Option<Unit>, _: Cow<'static, str>)

Describes a histogram.

fn register_counter(&self, key: &Key, _: &Metadata<'_>) -> Counter

Registers a counter.

fn register_gauge(&self, key: &Key, _: &Metadata<'_>) -> Gauge

Registers a gauge.

fn register_histogram(&self, key: &Key, _: &Metadata<'_>) -> Histogram

Registers a histogram.