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
use core::fmt;
use std::any::Any;
use std::borrow::Cow;
use std::sync::Arc;
use crate::metrics::{
AsyncInstrumentBuilder, Counter, Histogram, InstrumentBuilder, InstrumentProvider,
ObservableCounter, ObservableGauge, ObservableUpDownCounter, Result, UpDownCounter,
};
use crate::KeyValue;
use super::AsyncInstrument;
/// Provides access to named [Meter] instances, for instrumenting an application
/// or crate.
pub trait MeterProvider {
/// Returns a new [Meter] with the provided name and default configuration.
///
/// A [Meter] should be scoped at most to a single application or crate. The
/// name needs to be unique so it does not collide with other names used by
/// an application, nor other applications.
///
/// If the name is empty, then an implementation defined default name will
/// be used instead.
fn meter(&self, name: impl Into<Cow<'static, str>>) -> Meter {
self.versioned_meter(
name,
None::<Cow<'static, str>>,
None::<Cow<'static, str>>,
None,
)
}
/// Creates an implementation of the [`Meter`] interface.
///
/// The instrumentation name must be the name of the library providing instrumentation. This
/// name may be the same as the instrumented code only if that code provides built-in
/// instrumentation. If the instrumentation name is empty, then a implementation defined
/// default name will be used instead.
fn versioned_meter(
&self,
name: impl Into<Cow<'static, str>>,
version: Option<impl Into<Cow<'static, str>>>,
schema_url: Option<impl Into<Cow<'static, str>>>,
attributes: Option<Vec<KeyValue>>,
) -> Meter;
}
/// Provides access to instrument instances for recording metrics.
#[derive(Clone)]
pub struct Meter {
pub(crate) instrument_provider: Arc<dyn InstrumentProvider + Send + Sync>,
}
impl Meter {
/// Create a new named meter from an instrumentation provider
#[doc(hidden)]
pub fn new(instrument_provider: Arc<dyn InstrumentProvider + Send + Sync>) -> Self {
Meter {
instrument_provider,
}
}
/// creates an instrument builder for recording increasing values.
pub fn u64_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Counter<u64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording increasing values.
pub fn f64_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Counter<f64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording increasing values via callback.
pub fn u64_observable_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64> {
AsyncInstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording increasing values via callback.
pub fn f64_observable_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64> {
AsyncInstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording changes of a value.
pub fn i64_up_down_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, UpDownCounter<i64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording changes of a value.
pub fn f64_up_down_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, UpDownCounter<f64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording changes of a value via callback.
pub fn i64_observable_up_down_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64> {
AsyncInstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording changes of a value via callback.
pub fn f64_observable_up_down_counter(
&self,
name: impl Into<Cow<'static, str>>,
) -> AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64> {
AsyncInstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording the current value via callback.
pub fn u64_observable_gauge(
&self,
name: impl Into<Cow<'static, str>>,
) -> AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64> {
AsyncInstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording the current value via callback.
pub fn i64_observable_gauge(
&self,
name: impl Into<Cow<'static, str>>,
) -> AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64> {
AsyncInstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording the current value via callback.
pub fn f64_observable_gauge(
&self,
name: impl Into<Cow<'static, str>>,
) -> AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64> {
AsyncInstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording a distribution of values.
pub fn f64_histogram(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Histogram<f64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording a distribution of values.
pub fn u64_histogram(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Histogram<u64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording a distribution of values.
pub fn i64_histogram(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Histogram<i64>> {
InstrumentBuilder::new(self, name.into())
}
/// Registers a callback to be called during the collection of a measurement
/// cycle.
///
/// The instruments passed as arguments to be registered are the only
/// instruments that may observe values.
///
/// If no instruments are passed, the callback will not be registered.
pub fn register_callback<F>(
&self,
instruments: &[Arc<dyn Any>],
callback: F,
) -> Result<Box<dyn CallbackRegistration>>
where
F: Fn(&dyn Observer) + Send + Sync + 'static,
{
self.instrument_provider
.register_callback(instruments, Box::new(callback))
}
}
/// A token representing the unique registration of a callback for a set of
/// instruments with a [Meter].
pub trait CallbackRegistration: Send + Sync {
/// Removes the callback registration from its associated [Meter].
fn unregister(&mut self) -> Result<()>;
}
/// Records measurements for multiple instruments in a callback.
pub trait Observer {
/// Records the f64 value with attributes for the observable.
fn observe_f64(&self, inst: &dyn AsyncInstrument<f64>, measurement: f64, attrs: &[KeyValue]);
/// Records the u64 value with attributes for the observable.
fn observe_u64(&self, inst: &dyn AsyncInstrument<u64>, measurement: u64, attrs: &[KeyValue]);
/// Records the i64 value with attributes for the observable.
fn observe_i64(&self, inst: &dyn AsyncInstrument<i64>, measurement: i64, attrs: &[KeyValue]);
}
impl fmt::Debug for Meter {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("Meter")
}
}