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
use std::{any::Any, borrow::Cow, collections::HashSet, hash::Hash, marker, sync::Arc};
use opentelemetry::{
metrics::{
AsyncInstrument, MetricsError, Result, SyncCounter, SyncGauge, SyncHistogram,
SyncUpDownCounter,
},
Key, KeyValue,
};
use crate::{
instrumentation::Scope,
metrics::AttributeSet,
metrics::{aggregation::Aggregation, internal::Measure},
};
pub(crate) const EMPTY_MEASURE_MSG: &str = "no aggregators for observable instrument";
/// The identifier of a group of instruments that all perform the same function.
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
pub enum InstrumentKind {
/// Identifies a group of instruments that record increasing values synchronously
/// with the code path they are measuring.
Counter,
/// A group of instruments that record increasing and decreasing values
/// synchronously with the code path they are measuring.
UpDownCounter,
/// A group of instruments that record a distribution of values synchronously with
/// the code path they are measuring.
Histogram,
/// A group of instruments that record increasing values in an asynchronous
/// callback.
ObservableCounter,
/// A group of instruments that record increasing and decreasing values in an
/// asynchronous callback.
ObservableUpDownCounter,
/// a group of instruments that record current value synchronously with
/// the code path they are measuring.
Gauge,
///
/// a group of instruments that record current values in an asynchronous callback.
ObservableGauge,
}
/// Describes properties an instrument is created with, also used for filtering
/// in [View](crate::metrics::View)s.
///
/// # Example
///
/// Instruments can be used as criteria for views.
///
/// ```
/// use opentelemetry_sdk::metrics::{new_view, Aggregation, Instrument, Stream};
///
/// let criteria = Instrument::new().name("counter_*");
/// let mask = Stream::new().aggregation(Aggregation::Sum);
///
/// let view = new_view(criteria, mask);
/// # drop(view);
/// ```
#[derive(Clone, Default, Debug, PartialEq)]
#[non_exhaustive]
pub struct Instrument {
/// The human-readable identifier of the instrument.
pub name: Cow<'static, str>,
/// describes the purpose of the instrument.
pub description: Cow<'static, str>,
/// The functional group of the instrument.
pub kind: Option<InstrumentKind>,
/// Unit is the unit of measurement recorded by the instrument.
pub unit: Cow<'static, str>,
/// The instrumentation that created the instrument.
pub scope: Scope,
}
impl Instrument {
/// Create a new instrument with default values
pub fn new() -> Self {
Instrument::default()
}
/// Set the instrument name.
pub fn name(mut self, name: impl Into<Cow<'static, str>>) -> Self {
self.name = name.into();
self
}
/// Set the instrument description.
pub fn description(mut self, description: impl Into<Cow<'static, str>>) -> Self {
self.description = description.into();
self
}
/// Set the instrument unit.
pub fn unit(mut self, unit: impl Into<Cow<'static, str>>) -> Self {
self.unit = unit.into();
self
}
/// Set the instrument scope.
pub fn scope(mut self, scope: Scope) -> Self {
self.scope = scope;
self
}
/// empty returns if all fields of i are their default-value.
pub(crate) fn is_empty(&self) -> bool {
self.name == ""
&& self.description == ""
&& self.kind.is_none()
&& self.unit == ""
&& self.scope == Scope::default()
}
pub(crate) fn matches(&self, other: &Instrument) -> bool {
self.matches_name(other)
&& self.matches_description(other)
&& self.matches_kind(other)
&& self.matches_unit(other)
&& self.matches_scope(other)
}
pub(crate) fn matches_name(&self, other: &Instrument) -> bool {
self.name.is_empty() || self.name.as_ref() == other.name.as_ref()
}
pub(crate) fn matches_description(&self, other: &Instrument) -> bool {
self.description.is_empty() || self.description.as_ref() == other.description.as_ref()
}
pub(crate) fn matches_kind(&self, other: &Instrument) -> bool {
self.kind.is_none() || self.kind == other.kind
}
pub(crate) fn matches_unit(&self, other: &Instrument) -> bool {
self.unit.is_empty() || self.unit.as_ref() == other.unit.as_ref()
}
pub(crate) fn matches_scope(&self, other: &Instrument) -> bool {
(self.scope.name.is_empty() || self.scope.name.as_ref() == other.scope.name.as_ref())
&& (self.scope.version.is_none()
|| self.scope.version.as_ref().map(AsRef::as_ref)
== other.scope.version.as_ref().map(AsRef::as_ref))
&& (self.scope.schema_url.is_none()
|| self.scope.schema_url.as_ref().map(AsRef::as_ref)
== other.scope.schema_url.as_ref().map(AsRef::as_ref))
}
}
/// Describes the stream of data an instrument produces.
///
/// # Example
///
/// Streams can be used as masks in views.
///
/// ```
/// use opentelemetry_sdk::metrics::{new_view, Aggregation, Instrument, Stream};
///
/// let criteria = Instrument::new().name("counter_*");
/// let mask = Stream::new().aggregation(Aggregation::Sum);
///
/// let view = new_view(criteria, mask);
/// # drop(view);
/// ```
#[derive(Default, Debug)]
#[non_exhaustive]
pub struct Stream {
/// The human-readable identifier of the stream.
pub name: Cow<'static, str>,
/// Describes the purpose of the data.
pub description: Cow<'static, str>,
/// the unit of measurement recorded.
pub unit: Cow<'static, str>,
/// Aggregation the stream uses for an instrument.
pub aggregation: Option<Aggregation>,
/// An allow-list of attribute keys that will be preserved for the stream.
///
/// Any attribute recorded for the stream with a key not in this set will be
/// dropped. If the set is empty, all attributes will be dropped, if `None` all
/// attributes will be kept.
pub allowed_attribute_keys: Option<Arc<HashSet<Key>>>,
}
impl Stream {
/// Create a new stream with empty values.
pub fn new() -> Self {
Stream::default()
}
/// Set the stream name.
pub fn name(mut self, name: impl Into<Cow<'static, str>>) -> Self {
self.name = name.into();
self
}
/// Set the stream description.
pub fn description(mut self, description: impl Into<Cow<'static, str>>) -> Self {
self.description = description.into();
self
}
/// Set the stream unit.
pub fn unit(mut self, unit: impl Into<Cow<'static, str>>) -> Self {
self.unit = unit.into();
self
}
/// Set the stream aggregation.
pub fn aggregation(mut self, aggregation: Aggregation) -> Self {
self.aggregation = Some(aggregation);
self
}
/// Set the stream allowed attribute keys.
///
/// Any attribute recorded for the stream with a key not in this set will be
/// dropped. If this set is empty all attributes will be dropped.
pub fn allowed_attribute_keys(mut self, attribute_keys: impl IntoIterator<Item = Key>) -> Self {
self.allowed_attribute_keys = Some(Arc::new(attribute_keys.into_iter().collect()));
self
}
}
/// The identifying properties of an instrument.
#[derive(Debug, PartialEq, Eq, Hash)]
pub(crate) struct InstrumentId {
/// The human-readable identifier of the instrument.
pub(crate) name: Cow<'static, str>,
/// Describes the purpose of the data.
pub(crate) description: Cow<'static, str>,
/// Defines the functional group of the instrument.
pub(crate) kind: InstrumentKind,
/// The unit of measurement recorded.
pub(crate) unit: Cow<'static, str>,
/// Number is the underlying data type of the instrument.
pub(crate) number: Cow<'static, str>,
}
impl InstrumentId {
/// Instrument names are considered case-insensitive ASCII.
///
/// Standardize the instrument name to always be lowercase so it can be compared
/// via hash.
///
/// See [naming syntax] for full requirements.
///
/// [naming syntax]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/metrics/api.md#instrument-name-syntax
pub(crate) fn normalize(&mut self) {
if self.name.chars().any(|c| c.is_ascii_uppercase()) {
self.name = self.name.to_ascii_lowercase().into();
}
}
}
pub(crate) struct ResolvedMeasures<T> {
pub(crate) measures: Vec<Arc<dyn Measure<T>>>,
}
impl<T: Copy + 'static> SyncCounter<T> for ResolvedMeasures<T> {
fn add(&self, val: T, attrs: &[KeyValue]) {
for measure in &self.measures {
measure.call(val, AttributeSet::from(attrs))
}
}
}
impl<T: Copy + 'static> SyncUpDownCounter<T> for ResolvedMeasures<T> {
fn add(&self, val: T, attrs: &[KeyValue]) {
for measure in &self.measures {
measure.call(val, AttributeSet::from(attrs))
}
}
}
impl<T: Copy + 'static> SyncGauge<T> for ResolvedMeasures<T> {
fn record(&self, val: T, attrs: &[KeyValue]) {
for measure in &self.measures {
measure.call(val, AttributeSet::from(attrs))
}
}
}
impl<T: Copy + 'static> SyncHistogram<T> for ResolvedMeasures<T> {
fn record(&self, val: T, attrs: &[KeyValue]) {
for measure in &self.measures {
measure.call(val, AttributeSet::from(attrs))
}
}
}
/// A comparable unique identifier of an observable.
#[derive(Clone, Debug)]
pub(crate) struct ObservableId<T> {
pub(crate) inner: IdInner,
_marker: marker::PhantomData<T>,
}
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
pub(crate) struct IdInner {
/// The human-readable identifier of the instrument.
pub(crate) name: Cow<'static, str>,
/// describes the purpose of the instrument.
pub(crate) description: Cow<'static, str>,
/// The functional group of the instrument.
kind: InstrumentKind,
/// The unit of measurement recorded by the instrument.
pub(crate) unit: Cow<'static, str>,
/// The instrumentation that created the instrument.
scope: Scope,
}
impl<T> Hash for ObservableId<T> {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
self.inner.hash(state)
}
}
impl<T> PartialEq for ObservableId<T> {
fn eq(&self, other: &Self) -> bool {
self.inner == other.inner
}
}
impl<T> Eq for ObservableId<T> {}
#[derive(Clone)]
pub(crate) struct Observable<T> {
pub(crate) id: ObservableId<T>,
measures: Vec<Arc<dyn Measure<T>>>,
}
impl<T> Observable<T> {
pub(crate) fn new(
scope: Scope,
kind: InstrumentKind,
name: Cow<'static, str>,
description: Cow<'static, str>,
unit: Cow<'static, str>,
measures: Vec<Arc<dyn Measure<T>>>,
) -> Self {
Self {
id: ObservableId {
inner: IdInner {
name,
description,
kind,
unit,
scope,
},
_marker: marker::PhantomData,
},
measures,
}
}
/// Returns `Err` if the observable should not be registered, and `Ok` if it
/// should.
///
/// An error is returned if this observable is effectively a no-op because it does not have
/// any aggregators. Also, an error is returned if scope defines a Meter other
/// than the observable it was created by.
pub(crate) fn registerable(&self, scope: &Scope) -> Result<()> {
if self.measures.is_empty() {
return Err(MetricsError::Other(EMPTY_MEASURE_MSG.into()));
}
if &self.id.inner.scope != scope {
return Err(MetricsError::Other(format!(
"invalid registration: observable {} from Meter {:?}, registered with Meter {}",
self.id.inner.name, self.id.inner.scope, scope.name,
)));
}
Ok(())
}
}
impl<T: Copy + Send + Sync + 'static> AsyncInstrument<T> for Observable<T> {
fn observe(&self, measurement: T, attrs: &[KeyValue]) {
for measure in &self.measures {
measure.call(measurement, AttributeSet::from(attrs))
}
}
fn as_any(&self) -> Arc<dyn Any> {
Arc::new(self.clone())
}
}