opentelemetry/metrics/meter.rs
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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
use core::fmt;
use std::any::Any;
use std::borrow::Cow;
use std::sync::Arc;
use crate::metrics::{
AsyncInstrumentBuilder, Counter, Gauge, 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.
///
/// # Examples
///
/// ```
/// use opentelemetry::{global, metrics::MeterProvider};
/// use opentelemetry::KeyValue;
///
/// let provider = global::meter_provider();
///
/// // meter used in applications
/// let meter = provider.meter("my_app");
///
/// // meter used in libraries/crates that optionally includes version and schema url
/// let meter = provider.versioned_meter(
/// "my_library",
/// Some(env!("CARGO_PKG_VERSION")),
/// Some("https://opentelemetry.io/schema/1.0.0"),
/// Some(vec![KeyValue::new("key", "value")]),
/// );
/// ```
fn meter(&self, name: impl Into<Cow<'static, str>>) -> Meter {
self.versioned_meter(
name,
None::<Cow<'static, str>>,
None::<Cow<'static, str>>,
None,
)
}
/// Returns a new versioned meter with a given name.
///
/// 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 measurements.
///
/// ```
/// use opentelemetry::{global, KeyValue};
///
/// let meter = global::meter("my-meter");
///
/// // Meters can create metric instruments that can record values of type u64 and f64
///
/// // u64 Counter
/// let u64_counter = meter.u64_counter("my_u64_counter").init();
///
/// // Record measurements using the counter instrument add()
/// u64_counter.add(
/// 10,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ]
/// );
///
/// // f64 Counter
/// let f64_counter = meter.f64_counter("my_f64_counter").init();
///
/// // Record measurements using the counter instrument add()
/// f64_counter.add(
/// 3.15,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// );
///
/// // u6 observable counter
/// let observable_u4_counter = meter.u64_observable_counter("my_observable_u64_counter").init();
///
/// // Register a callback to this meter for an asynchronous instrument to record measurements
/// meter.register_callback(&[observable_u4_counter.as_any()], move |observer| {
/// observer.observe_u64(
/// &observable_u4_counter,
/// 1,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// )
/// });
///
/// // f64 observable counter
/// let observable_f64_counter = meter.f64_observable_counter("my_observable_f64_counter").init();
///
/// // Register a callback to this meter for an asynchronous instrument to record measurements
/// meter.register_callback(&[observable_f64_counter.as_any()], move |observer| {
/// observer.observe_f64(
/// &observable_f64_counter,
/// 1.55,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// )
/// });
///
/// // i64 updown counter
/// let updown_i64_counter = meter.i64_up_down_counter("my_updown_i64_counter").init();
///
/// // Record measurements using the updown counter instrument add()
/// updown_i64_counter.add(
/// -10,
/// &
/// [
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// );
///
/// // f64 updown counter
/// let updown_f64_counter = meter.f64_up_down_counter("my_updown_f64_counter").init();
///
/// // Record measurements using the updown counter instrument add()
/// updown_f64_counter.add(
/// -10.67,
/// &
/// [
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// );
///
/// // i64 observable updown counter
/// let observable_i64_up_down_counter = meter.i64_observable_up_down_counter("my_observable_i64_updown_counter").init();
///
/// // Register a callback to this meter for an asynchronous instrument to record measurements
/// meter.register_callback(&[observable_i64_up_down_counter.as_any()], move |observer| {
/// observer.observe_i64(
/// &observable_i64_up_down_counter,
/// 1,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// )
/// });
///
/// // f64 observable updown counter
/// let observable_f64_up_down_counter = meter.f64_observable_up_down_counter("my_observable_f64_updown_counter").init();
///
/// // Register a callback to this meter for an asynchronous instrument to record measurements
/// meter.register_callback(&[observable_f64_up_down_counter.as_any()], move |observer| {
/// observer.observe_f64(
/// &observable_f64_up_down_counter,
/// 1.16,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// )
/// });
///
/// // Observable f64 gauge
/// let f64_gauge = meter.f64_observable_gauge("my_f64_gauge").init();
///
/// // Register a callback to this meter for an asynchronous instrument to record measurements
/// meter.register_callback(&[f64_gauge.as_any()], move |observer| {
/// observer.observe_f64(
/// &f64_gauge,
/// 2.32,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// )
/// });
///
/// // Observable i64 gauge
/// let i64_gauge = meter.i64_observable_gauge("my_i64_gauge").init();
///
/// // Register a callback to this meter for an asynchronous instrument to record measurements
/// meter.register_callback(&[i64_gauge.as_any()], move |observer| {
/// observer.observe_i64(
/// &i64_gauge,
/// 12,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// )
/// });
///
/// // Observable u64 gauge
/// let u64_gauge = meter.u64_observable_gauge("my_u64_gauge").init();
///
/// // Register a callback to this meter for an asynchronous instrument to record measurements
/// meter.register_callback(&[u64_gauge.as_any()], move |observer| {
/// observer.observe_u64(
/// &u64_gauge,
/// 1,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// )
/// });
///
/// // f64 histogram
/// let f64_histogram = meter.f64_histogram("my_f64_histogram").init();
///
/// // Record measurements using the histogram instrument record()
/// f64_histogram.record(
/// 10.5,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// );
///
/// // u64 histogram
/// let u64_histogram = meter.u64_histogram("my_u64_histogram").init();
///
/// // Record measurements using the histogram instrument record()
/// u64_histogram.record(
/// 12,
/// &[
/// KeyValue::new("mykey1", "myvalue1"),
/// KeyValue::new("mykey2", "myvalue2"),
/// ],
/// );
///
/// ```
#[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 independent values.
pub fn u64_gauge(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Gauge<u64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording independent values.
pub fn f64_gauge(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Gauge<f64>> {
InstrumentBuilder::new(self, name.into())
}
/// creates an instrument builder for recording independent values.
pub fn i64_gauge(
&self,
name: impl Into<Cow<'static, str>>,
) -> InstrumentBuilder<'_, Gauge<i64>> {
InstrumentBuilder::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())
}
/// 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")
}
}