Crate witchcraft_metrics
source · [−]Expand description
A general-purpose metrics library.
The design of the crate is based fairly closely off of the Dropwizard Metrics library from the Java ecosystem.
Examples
use witchcraft_metrics::{MetricRegistry, MetricId, Metric};
use std::time::Duration;
// A `MetricRegistry` stores metrics.
let registry = MetricRegistry::new();
// Metrics are identified by an ID, which consists of a name and set of "tags"
let yaks_shaved = registry.counter(MetricId::new("shavings").with_tag("animal", "yak"));
// You can also pass a string directly for metric IDs that don't have tags
let request_timer = registry.timer("server.requests");
// do some work and record some values.
for yak in find_some_yaks() {
shave_yak(yak);
yaks_shaved.inc();
}
// Grab a snapshot of the metrics currently registered and print their values:
for (id, metric) in ®istry.metrics() {
match metric {
Metric::Counter(counter) => println!("{:?} is a counter with value {}", id, counter.count()),
Metric::Timer(timer) => {
let nanos = timer.snapshot().value(0.99);
let duration = Duration::from_nanos(nanos as u64);
println!("{:?} is a timer with 99th percentile {:?}", id, duration);
}
_ => {}
}
}
Structs
A metric which counts a value.
A reservoir which exponentially weights in favor of recent values.
A metric tracking a statistical distribution of values.
A metric tracking the rate of occurrence of an event.
An identifier of a metric.
A collection of metrics.
A snapshot of the metrics in a registry.
An iterator over metrics and their IDs.
A Clock
implementation which uses the system clock.
The tags associated with a metric ID.
An iterator over the key-value pairs of a metric ID’s tags.
A guard type which reports the time elapsed since its creation to a timer when it drops.
A metric tracking the duration and rate of events.
Enums
An enum of all metric types.