1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

// Copyright 2019 Palantir Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! 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 &registry.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);
//!         }
//!         _ => {}
//!     }
//! }
//!
//! # fn find_some_yaks() -> &'static [()] { &[] }
//! # fn shave_yak(_: &()) {}
//! ```
//!
//! [Dropwizard Metrics]: https://github.com/dropwizard/metrics
#![doc(html_root_url = "https://docs.rs/witchcraft-metrics/0.2")]
#![warn(missing_docs)]

pub use crate::clock::*;
pub use crate::counter::*;
pub use crate::gauge::*;
pub use crate::histogram::*;
pub use crate::meter::*;
pub use crate::metric_id::*;
pub use crate::registry::*;
pub use crate::reservoir::*;
pub use crate::timer::*;

mod clock;
mod counter;
mod gauge;
mod histogram;
mod meter;
mod metric_id;
mod registry;
mod reservoir;
mod timer;