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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
//! Foundational traits for interoperable metrics libraries in Rust. //! //! # Common Ground //! Most libraries, under the hood, are all based around a core set of data types: counters, //! gauges, and histograms. While the API surface may differ, the underlying data is the same. //! //! # Metric Types //! //! ## Counters //! Counters represent a single value that can only ever be incremented over time, or reset to //! zero. //! //! Counters are useful for tracking things like operations completed, or errors raised, where //! the value naturally begins at zero when a process or service is started or restarted. //! //! ## Gauges //! Gauges represent a single value that can go up _or_ down over time. //! //! Gauges are useful for tracking things like the current number of connected users, or a stock //! price, or the temperature outside. //! //! ## Histograms //! Histograms measure the distribution of values for a given set of measurements. //! //! Histograms are generally used to derive statistics about a particular measurement from an //! operation or event that happens over and over, such as the duration of a request, or number of //! rows returned by a particular database query. //! //! Histograms allow you to answer questions of these measurements, such as: //! - "What were the fastest and slowest requests in this window?" //! - "What is the slowest request we've seen out of 90% of the requests measured? 99%?" //! //! Histograms are a convenient way to measure behavior not only at the median, but at the edges of //! normal operating behavior. #![deny(missing_docs)] use std::{borrow::Cow, fmt, slice::Iter, time::Duration}; /// An allocation-optimized string. /// /// We specify `ScopedString` to attempt to get the best of both worlds: flexibility to provide a /// static or dynamic (owned) string, while retaining the performance benefits of being able to /// take ownership of owned strings and borrows of completely static strings. pub type ScopedString = Cow<'static, str>; /// A key/value pair used to further describe a metric. #[derive(PartialEq, Eq, Hash, Clone, Debug)] pub struct Label(ScopedString, ScopedString); impl Label { /// Creates a `Label` from a key and value. pub fn new<K, V>(key: K, value: V) -> Self where K: Into<ScopedString>, V: Into<ScopedString>, { Label(key.into(), value.into()) } /// The key of this label. pub fn key(&self) -> &str { self.0.as_ref() } /// The value of this label. pub fn value(&self) -> &str { self.1.as_ref() } /// Consumes this `Label`, returning the key and value. pub fn into_parts(self) -> (ScopedString, ScopedString) { (self.0, self.1) } } /// A metric key. /// /// A key always includes a name, but can optional include multiple labels used to further describe /// the metric. #[derive(PartialEq, Eq, Hash, Clone, Debug)] pub struct Key { name: ScopedString, labels: Vec<Label>, } impl Key { /// Creates a `Key` from a name. pub fn from_name<N>(name: N) -> Self where N: Into<ScopedString>, { Key { name: name.into(), labels: Vec::new(), } } /// Creates a `Key` from a name and vector of `Label`s. pub fn from_name_and_labels<N, L>(name: N, labels: L) -> Self where N: Into<ScopedString>, L: IntoLabels, { Key { name: name.into(), labels: labels.into_labels(), } } /// Adds a new set of labels to this key. /// /// New labels will be appended to any existing labels. pub fn add_labels<L>(&mut self, new_labels: L) where L: IntoLabels, { self.labels.extend(new_labels.into_labels()); } /// Name of this key. pub fn name(&self) -> ScopedString { self.name.clone() } /// Labels of this key, if they exist. pub fn labels(&self) -> Iter<Label> { self.labels.iter() } /// Maps the name of this `Key` to a new name. pub fn map_name<F, S>(self, f: F) -> Self where F: FnOnce(ScopedString) -> S, S: Into<ScopedString>, { Key { name: f(self.name).into(), labels: self.labels, } } /// Consumes this `Key`, returning the name and any labels. pub fn into_parts(self) -> (ScopedString, Vec<Label>) { (self.name, self.labels) } } impl fmt::Display for Key { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { if self.labels.is_empty() { write!(f, "Key({})", self.name) } else { let kv_pairs = self .labels .iter() .map(|label| format!("{} = {}", label.0, label.1)) .collect::<Vec<_>>(); write!(f, "Key({}, [{}])", self.name, kv_pairs.join(", ")) } } } impl From<String> for Key { fn from(name: String) -> Key { Key::from_name(name) } } impl From<&'static str> for Key { fn from(name: &'static str) -> Key { Key::from_name(name) } } impl From<ScopedString> for Key { fn from(name: ScopedString) -> Key { Key::from_name(name) } } impl<K, L> From<(K, L)> for Key where K: Into<ScopedString>, L: IntoLabels, { fn from(parts: (K, L)) -> Key { Key::from_name_and_labels(parts.0, parts.1) } } impl<K, V> From<(K, V)> for Label where K: Into<ScopedString>, V: Into<ScopedString>, { fn from(pair: (K, V)) -> Label { Label::new(pair.0, pair.1) } } impl<K, V> From<&(K, V)> for Label where K: Into<ScopedString> + Clone, V: Into<ScopedString> + Clone, { fn from(pair: &(K, V)) -> Label { Label::new(pair.0.clone(), pair.1.clone()) } } /// A value that can be converted to `Label`s. pub trait IntoLabels { /// Consumes this value, turning it into a vector of `Label`s. fn into_labels(self) -> Vec<Label>; } impl IntoLabels for Vec<Label> { fn into_labels(self) -> Vec<Label> { self } } impl<T, L> IntoLabels for &T where Self: IntoIterator<Item = L>, L: Into<Label>, { fn into_labels(self) -> Vec<Label> { self.into_iter().map(|l| l.into()).collect() } } /// Used to do a nanosecond conversion. /// /// This trait allows us to interchangably accept raw integer time values, ones already in /// nanoseconds, as well as the more conventional [`Duration`] which is a result of getting the /// difference between two [`Instant`](std::time::Instant)s. pub trait AsNanoseconds { /// Performs the conversion. fn as_nanos(&self) -> u64; } impl AsNanoseconds for u64 { fn as_nanos(&self) -> u64 { *self } } impl AsNanoseconds for Duration { fn as_nanos(&self) -> u64 { self.as_nanos() as u64 } } /// A value that observes metrics. pub trait Observer { /// The method called when a counter is observed. /// /// From the perspective of an observer, a counter and gauge are essentially identical, insofar /// as they are both a single value tied to a key. From the perspective of a collector, /// counters and gauges usually have slightly different modes of operation. /// /// For the sake of flexibility on the exporter side, both are provided. fn observe_counter(&mut self, key: Key, value: u64); /// The method called when a gauge is observed. /// /// From the perspective of a observer, a counter and gauge are essentially identical, insofar /// as they are both a single value tied to a key. From the perspective of a collector, /// counters and gauges usually have slightly different modes of operation. /// /// For the sake of flexibility on the exporter side, both are provided. fn observe_gauge(&mut self, key: Key, value: i64); /// The method called when an histogram is observed. /// /// Observers are expected to tally their own histogram views, so this will be called with all /// of the underlying observed values, and callers will need to process them accordingly. /// /// There is no guarantee that this method will not be called multiple times for the same key. fn observe_histogram(&mut self, key: Key, values: &[u64]); } /// A value that can build an observer. /// /// Observers are containers used for rendering a snapshot in a particular format. /// As many systems are multi-threaded, we can't easily share a single recorder amongst /// multiple threads, and so we create a recorder per observation, tying them together. /// /// A builder allows us to generate an observer on demand, giving each specific recorder an /// interface by which they can do any necessary configuration, initialization, etc of the /// observer before handing it over to the exporter. pub trait Builder { /// The observer created by this builder. type Output: Observer; /// Creates a new recorder. fn build(&self) -> Self::Output; } /// A value that can produce a `T` by draining its content. /// /// After being drained, the value should be ready to be reused. pub trait Drain<T> { /// Drain the `Observer`, producing a `T`. fn drain(&mut self) -> T; } /// A value whose metrics can be observed by an `Observer`. pub trait Observe { /// Observe point-in-time view of the collected metrics. fn observe<O: Observer>(&self, observer: &mut O); } /// Helper macro for generating a set of labels. /// /// While a `Label` can be generated manually, most users will tend towards the key => value format /// commonly used for defining hashes/maps in many programming languages. This macro allows users /// to do the exact same thing in calls that depend on [`metrics_core::IntoLabels`]. /// /// # Examples /// ```rust /// # #[macro_use] extern crate metrics_core; /// # use metrics_core::IntoLabels; /// fn takes_labels<L: IntoLabels>(name: &str, labels: L) { /// println!("name: {} labels: {:?}", name, labels.into_labels()); /// } /// /// takes_labels("requests_processed", labels!("request_type" => "admin")); /// ``` #[macro_export] macro_rules! labels { (@ { $($out:expr),* $(,)* } $(,)*) => { std::vec![ $($out),* ] }; (@ { } $k:expr => $v:expr, $($rest:tt)*) => { $crate::labels!(@ { $crate::Label::new($k, $v) } $($rest)*) }; (@ { $($out:expr),+ } $k:expr => $v:expr, $($rest:tt)*) => { $crate::labels!(@ { $($out),+, $crate::Label::new($k, $v) } $($rest)*) }; ($($args:tt)*) => { $crate::labels!(@ { } $($args)*, ) }; }