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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
//! Layers are composable helpers that can be "layered" on top of an existing `Recorder` to enhance
//! or alter its behavior as desired, without having to change the recorder implementation itself.
//!
//! As well, [`Stack`] can be used to easily compose multiple layers together and provides a
//! convenience method for installing it as the global recorder, providing a smooth transition from
//! working directly with installing exporters to installing stacks.
//!
//! Here's an example of a layer that filters out all metrics that start with a specific string:
//!
//! ```rust
//! # use metrics::{Counter, Gauge, Histogram, Key, KeyName, Recorder, Unit};
//! # use metrics::NoopRecorder as BasicRecorder;
//! # use metrics_util::layers::{Layer, Stack, PrefixLayer};
//! // A simple layer that denies any metrics that have "stairway" or "heaven" in their name.
//! #[derive(Default)]
//! pub struct StairwayDeny<R>(pub(crate) R);
//!
//! impl<R> StairwayDeny<R> {
//!     fn is_invalid_key(&self, key: &str) -> bool {
//!         key.contains("stairway") || key.contains("heaven")
//!     }
//! }
//!
//! impl<R: Recorder> Recorder for StairwayDeny<R> {
//!     fn describe_counter(
//!         &self,
//!         key_name: KeyName,
//!         unit: Option<Unit>,
//!         description: &'static str,
//!     ) {
//!         if self.is_invalid_key(key_name.as_str()) {
//!             return;
//!         }
//!         self.0.describe_counter(key_name, unit, description)
//!     }
//!
//!     fn describe_gauge(&self, key_name: KeyName, unit: Option<Unit>, description: &'static str) {
//!         if self.is_invalid_key(key_name.as_str()) {
//!             return;
//!         }
//!         self.0.describe_gauge(key_name, unit, description)
//!     }
//!
//!     fn describe_histogram(
//!         &self,
//!         key_name: KeyName,
//!         unit: Option<Unit>,
//!         description: &'static str,
//!     ) {
//!         if self.is_invalid_key(key_name.as_str()) {
//!             return;
//!         }
//!         self.0.describe_histogram(key_name, unit, description)
//!     }
//!
//!     fn register_counter(&self, key: &Key) -> Counter {
//!         if self.is_invalid_key(key.name()) {
//!             return Counter::noop();
//!         }
//!         self.0.register_counter(key)
//!     }
//!
//!     fn register_gauge(&self, key: &Key) -> Gauge {
//!         if self.is_invalid_key(key.name()) {
//!             return Gauge::noop();
//!         }
//!         self.0.register_gauge(key)
//!     }
//!
//!     fn register_histogram(&self, key: &Key) -> Histogram {
//!         if self.is_invalid_key(key.name()) {
//!             return Histogram::noop();
//!         }
//!         self.0.register_histogram(key)
//!     }
//! }
//!
//! #[derive(Default)]
//! pub struct StairwayDenyLayer;
//!
//! impl<R> Layer<R> for StairwayDenyLayer {
//!     type Output = StairwayDeny<R>;
//!
//!     fn layer(&self, inner: R) -> Self::Output {
//!         StairwayDeny(inner)
//!     }
//! }
//!
//! // Now you can construct an instance of it to use it.  The layer will be wrapped around
//! // our base recorder, which is a debugging recorder also supplied by `metrics_util`.
//! # fn main() {
//! let recorder = BasicRecorder;
//! let layer = StairwayDenyLayer::default();
//! let layered = layer.layer(recorder);
//! metrics::set_boxed_recorder(Box::new(layered)).expect("failed to install recorder");
//!
//! # unsafe { metrics::clear_recorder() };
//!
//! // Working with layers directly is a bit cumbersome, though, so let's use a `Stack`.
//! let stack = Stack::new(BasicRecorder);
//! stack.push(StairwayDenyLayer::default()).install().expect("failed to install stack");
//!
//! # unsafe { metrics::clear_recorder() };
//!
//! // `Stack` makes it easy to chain layers together, as well.
//! let stack = Stack::new(BasicRecorder);
//! stack
//!     .push(PrefixLayer::new("app_name"))
//!     .push(StairwayDenyLayer::default())
//!     .install()
//!     .expect("failed to install stack");
//! # }
//! ```
use metrics::{Counter, Gauge, Histogram, Key, KeyName, Recorder, Unit};

use metrics::SetRecorderError;

mod fanout;
pub use fanout::{Fanout, FanoutBuilder};

#[cfg(feature = "layer-filter")]
mod filter;
#[cfg(feature = "layer-filter")]
pub use filter::{Filter, FilterLayer};

mod prefix;
pub use prefix::{Prefix, PrefixLayer};

#[cfg(feature = "layer-router")]
mod router;
#[cfg(feature = "layer-router")]
pub use router::{Router, RouterBuilder};

/// Decorates an object by wrapping it within another type.
pub trait Layer<R> {
    /// The output type after wrapping.
    type Output;

    /// Wraps `inner` based on this layer.
    fn layer(&self, inner: R) -> Self::Output;
}

/// Builder for composing layers together in a top-down/inside-out order.
pub struct Stack<R> {
    inner: R,
}

impl<R> Stack<R> {
    /// Creates a new `Stack` around the given object.
    pub fn new(inner: R) -> Self {
        Stack { inner }
    }

    /// Pushes the given layer on to the stack, wrapping the existing stack.
    pub fn push<L: Layer<R>>(self, layer: L) -> Stack<L::Output> {
        Stack::new(layer.layer(self.inner))
    }
}

impl<R: Recorder + 'static> Stack<R> {
    /// Installs this stack as the global recorder.
    ///
    /// An error will be returned if there's an issue with installing the stack as the global recorder.
    pub fn install(self) -> Result<(), SetRecorderError> {
        metrics::set_boxed_recorder(Box::new(self))
    }
}

impl<R: Recorder> Recorder for Stack<R> {
    fn describe_counter(&self, key_name: KeyName, unit: Option<Unit>, description: &'static str) {
        self.inner.describe_counter(key_name, unit, description);
    }

    fn describe_gauge(&self, key_name: KeyName, unit: Option<Unit>, description: &'static str) {
        self.inner.describe_gauge(key_name, unit, description);
    }

    fn describe_histogram(&self, key_name: KeyName, unit: Option<Unit>, description: &'static str) {
        self.inner.describe_histogram(key_name, unit, description);
    }

    fn register_counter(&self, key: &Key) -> Counter {
        self.inner.register_counter(key)
    }

    fn register_gauge(&self, key: &Key) -> Gauge {
        self.inner.register_gauge(key)
    }

    fn register_histogram(&self, key: &Key) -> Histogram {
        self.inner.register_histogram(key)
    }
}