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
use std::sync::{
atomic::{AtomicU64, Ordering},
Arc,
};
use crate::IntoF64;
/// A counter handler.
pub trait CounterFn {
/// Increments the counter by the given amount.
///
/// Returns the previous value.
fn increment(&self, value: u64);
/// Sets the counter to at least the given amount.
///
/// This is intended to support use cases where multiple callers are attempting to synchronize
/// this counter with an external counter that they have no control over. As multiple callers
/// may read that external counter, and attempt to set it here, there could be reordering issues
/// where a caller attempts to set an older (smaller) value after the counter has been updated to
/// the latest (larger) value.
///
/// This method must cope with those cases. An example of doing so atomically can be found in
/// `AtomicCounter`.
///
/// Returns the previous value.
fn absolute(&self, value: u64);
}
/// A gauge handler.
pub trait GaugeFn {
/// Increments the gauge by the given amount.
///
/// Returns the previous value.
fn increment(&self, value: f64);
/// Decrements the gauge by the given amount.
///
/// Returns the previous value.
fn decrement(&self, value: f64);
/// Sets the gauge to the given amount.
///
/// Returns the previous value.
fn set(&self, value: f64);
}
/// A histogram handler.
pub trait HistogramFn {
/// Records a value into the histogram.
fn record(&self, value: f64);
}
/// A counter.
#[derive(Clone)]
pub struct Counter {
inner: Option<Arc<dyn CounterFn + Send + Sync>>,
}
/// A gauge.
#[derive(Clone)]
pub struct Gauge {
inner: Option<Arc<dyn GaugeFn + Send + Sync>>,
}
/// A histogram.
#[derive(Clone)]
pub struct Histogram {
inner: Option<Arc<dyn HistogramFn + Send + Sync>>,
}
impl Counter {
/// Creates a no-op `Counter` which does nothing.
///
/// Suitable when a handle must be provided that does nothing i.e. a no-op recorder or a layer
/// that disables specific metrics, and so on.
pub fn noop() -> Self {
Self { inner: None }
}
/// Creates a `Counter` based on a shared handler.
pub fn from_arc<F: CounterFn + Send + Sync + 'static>(a: Arc<F>) -> Self {
Self { inner: Some(a) }
}
/// Increments the counter.
pub fn increment(&self, value: u64) {
if let Some(c) = &self.inner {
c.increment(value)
}
}
/// Sets the counter to an absolute value.
pub fn absolute(&self, value: u64) {
if let Some(c) = &self.inner {
c.absolute(value)
}
}
}
impl Gauge {
/// Creates a no-op `Gauge` which does nothing.
///
/// Suitable when a handle must be provided that does nothing i.e. a no-op recorder or a layer
/// that disables specific metrics, and so on.
pub fn noop() -> Self {
Self { inner: None }
}
/// Creates a `Gauge` based on a shared handler.
pub fn from_arc<F: GaugeFn + Send + Sync + 'static>(a: Arc<F>) -> Self {
Self { inner: Some(a) }
}
/// Increments the gauge.
pub fn increment<T: IntoF64>(&self, value: T) {
if let Some(g) = &self.inner {
g.increment(value.into_f64())
}
}
/// Decrements the gauge.
pub fn decrement<T: IntoF64>(&self, value: T) {
if let Some(g) = &self.inner {
g.decrement(value.into_f64())
}
}
/// Sets the gauge.
pub fn set<T: IntoF64>(&self, value: T) {
if let Some(g) = &self.inner {
g.set(value.into_f64())
}
}
}
impl Histogram {
/// Creates a no-op `Histogram` which does nothing.
///
/// Suitable when a handle must be provided that does nothing i.e. a no-op recorder or a layer
/// that disables specific metrics, and so on.
pub fn noop() -> Self {
Self { inner: None }
}
/// Creates a `Histogram` based on a shared handler.
pub fn from_arc<F: HistogramFn + Send + Sync + 'static>(a: Arc<F>) -> Self {
Self { inner: Some(a) }
}
/// Records a value in the histogram.
pub fn record<T: IntoF64>(&self, value: T) {
if let Some(ref inner) = self.inner {
inner.record(value.into_f64())
}
}
}
impl CounterFn for AtomicU64 {
fn increment(&self, value: u64) {
let _ = self.fetch_add(value, Ordering::Release);
}
fn absolute(&self, value: u64) {
let _ = self.fetch_max(value, Ordering::AcqRel);
}
}
impl GaugeFn for AtomicU64 {
fn increment(&self, value: f64) {
loop {
let result = self.fetch_update(Ordering::AcqRel, Ordering::Relaxed, |curr| {
let input = f64::from_bits(curr);
let output = input + value;
Some(output.to_bits())
});
if result.is_ok() {
break;
}
}
}
fn decrement(&self, value: f64) {
loop {
let result = self.fetch_update(Ordering::AcqRel, Ordering::Relaxed, |curr| {
let input = f64::from_bits(curr);
let output = input - value;
Some(output.to_bits())
});
if result.is_ok() {
break;
}
}
}
fn set(&self, value: f64) {
let _ = self.swap(value.to_bits(), Ordering::AcqRel);
}
}
impl<T> CounterFn for Arc<T>
where
T: CounterFn,
{
fn increment(&self, value: u64) {
(**self).increment(value)
}
fn absolute(&self, value: u64) {
(**self).absolute(value)
}
}
impl<T> GaugeFn for Arc<T>
where
T: GaugeFn,
{
fn increment(&self, value: f64) {
(**self).increment(value)
}
fn decrement(&self, value: f64) {
(**self).decrement(value)
}
fn set(&self, value: f64) {
(**self).set(value)
}
}
impl<T> HistogramFn for Arc<T>
where
T: HistogramFn,
{
fn record(&self, value: f64) {
(**self).record(value);
}
}
impl<T> From<Arc<T>> for Counter
where
T: CounterFn + Send + Sync + 'static,
{
fn from(inner: Arc<T>) -> Self {
Counter::from_arc(inner)
}
}
impl<T> From<Arc<T>> for Gauge
where
T: GaugeFn + Send + Sync + 'static,
{
fn from(inner: Arc<T>) -> Self {
Gauge::from_arc(inner)
}
}
impl<T> From<Arc<T>> for Histogram
where
T: HistogramFn + Send + Sync + 'static,
{
fn from(inner: Arc<T>) -> Self {
Histogram::from_arc(inner)
}
}