Struct Metrics

pub struct Metrics { /* private fields */ }

The metrics struct is used to initialize the metrics communications channels and access the Histogram data for each named metric.

Implementations

impl Metrics

pub fn for_each_histogram<F>(&self, f: F)

where F: FnMut(&'static str, &Histogram<u64>),

Iterate the histograms created. This function accepts a closure of FnMut(&'static str, &Histogram<u64>) taking the span name and the histogram as arguments.

Examples found in repository

examples/nothread.rs (lines 37-39)

fn main() {
    let metrics = Metrics::new(1);

    (0..2).for_each(|_| long_scoped());
    (0..2).for_each(|_| long());
    (0..2).for_each(|_| short_scoped());
    (0..2).for_each(|_| short());

    (0..2).for_each(|_| long_scoped());
    (0..2).for_each(|_| long());
    (0..2).for_each(|_| short_scoped());
    (0..2).for_each(|_| short());

    metrics.for_each_histogram(|span_name, h| {
        println!("{} -> {:.2}ms", span_name, h.mean() / 1_000_000.0);
    });
}

examples/simple.rs (lines 46-48)

fn main() {
    let metrics = Metrics::new(1);

    let t1 =  std::thread::spawn(|| {
        (0..10).for_each(|_| long_scoped());
        (0..10).for_each(|_| long());
        (0..10).for_each(|_| short_scoped());
        (0..10).for_each(|_| short());
    });

    let t2 =  std::thread::spawn(|| {
        (0..10).for_each(|_| long_scoped());
        (0..10).for_each(|_| long());
        (0..10).for_each(|_| short_scoped());
        (0..10).for_each(|_| short());
    });

    t1.join().unwrap();
    t2.join().unwrap();

    metrics.for_each_histogram(|span_name, h| {
        println!("{} -> {:.2}ms", span_name, h.mean() / 1_000_000.0);
    });
}

pub fn flush(&self)

Blocks the current thread until the worker thread has completed flushing the receiver.

Warning

In high contention situations, this may block indefinitely. This method is meant to be used in the context of a game engine, where execution can be guaranteed to be blocked for metric collection.

pub fn new(sigfig: u8) -> Metrics

Creates a new metrcs instance, initializing metrics and spawning a worker to collect the data.

Warning

Any given instance of Metrics will globally collect a duplicate of the Histgram data. Only one instance should be active at a time.

Examples found in repository

examples/nothread.rs (line 25)

fn main() {
    let metrics = Metrics::new(1);

    (0..2).for_each(|_| long_scoped());
    (0..2).for_each(|_| long());
    (0..2).for_each(|_| short_scoped());
    (0..2).for_each(|_| short());

    (0..2).for_each(|_| long_scoped());
    (0..2).for_each(|_| long());
    (0..2).for_each(|_| short_scoped());
    (0..2).for_each(|_| short());

    metrics.for_each_histogram(|span_name, h| {
        println!("{} -> {:.2}ms", span_name, h.mean() / 1_000_000.0);
    });
}

examples/simple.rs (line 27)

fn main() {
    let metrics = Metrics::new(1);

    let t1 =  std::thread::spawn(|| {
        (0..10).for_each(|_| long_scoped());
        (0..10).for_each(|_| long());
        (0..10).for_each(|_| short_scoped());
        (0..10).for_each(|_| short());
    });

    let t2 =  std::thread::spawn(|| {
        (0..10).for_each(|_| long_scoped());
        (0..10).for_each(|_| long());
        (0..10).for_each(|_| short_scoped());
        (0..10).for_each(|_| short());
    });

    t1.join().unwrap();
    t2.join().unwrap();

    metrics.for_each_histogram(|span_name, h| {
        println!("{} -> {:.2}ms", span_name, h.mean() / 1_000_000.0);
    });
}

Trait Implementations

impl Drop for Metrics

fn drop(&mut self)

Executes the destructor for this type.