Struct metrics_printer::PrintRecorder

pub struct PrintRecorder<P> where
    P: Printer + Send + Sync + 'static,  { /* fields omitted */ }

A metrics recorder that collects metrics and regularly tried to print them.

Implementations

impl<P> PrintRecorder<P> where
    P: Printer + Send + Sync + 'static, 

pub fn new(printer: P) -> Self

New PrinterRecorder with 1s interval no metadata printing.

pub fn set_print_interval(&mut self, interval: Duration) -> &mut Self

Set how often metrics should be printed (roughly)

pub fn do_print_medata(&mut self) -> &mut Self

Print units and descriptions together with the metrics

pub fn skip_print_medata(&mut self) -> &mut Self

Do not print units and descriptions together with the metrics

pub fn select_quantiles(&mut self, quantiles: Box<[Quantile]>) -> &mut Self

Select which quantiles should be printed

pub fn install_if_free(self)

Register this recorder as the global recorder, if no other recorder is already registered.

If another recorder is registered, this will fail silently. This method is recommended to be used when you are trying to set the exact same recorder from multiple places and don’t know/care which will get executed first. This is often the case for unit tests, for example.

Also starts the background thread for printing.

pub fn install(self) -> Result<(), SetRecorderError>

Register this recorder as the global recorder, if no other recorder is already registered.

If another recorder is registered, this will return an error.

Also starts the background thread for printing.

Trait Implementations

impl Default for PrintRecorder<StdoutPrinter>

fn default() -> Self

New PrinterRecorder to stdout with 1s interval no metadata printing.