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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
use core::fmt;
use std::{
borrow::Cow,
collections::HashMap,
sync::{
atomic::{AtomicBool, Ordering},
Arc, Mutex,
},
};
use opentelemetry::{
global,
metrics::{noop::NoopMeterCore, Meter, MeterProvider, MetricsError, Result},
KeyValue,
};
use crate::{instrumentation::Scope, Resource};
use super::{meter::SdkMeter, pipeline::Pipelines, reader::MetricReader, view::View};
/// Handles the creation and coordination of [Meter]s.
///
/// All `Meter`s created by a `MeterProvider` will be associated with the same
/// [Resource], have the same [View]s applied to them, and have their produced
/// metric telemetry passed to the configured [MetricReader]s.
///
/// [Meter]: opentelemetry::metrics::Meter
#[derive(Clone, Debug)]
pub struct SdkMeterProvider {
inner: Arc<SdkMeterProviderInner>,
}
#[derive(Clone, Debug)]
struct SdkMeterProviderInner {
pipes: Arc<Pipelines>,
meters: Arc<Mutex<HashMap<Scope, Arc<SdkMeter>>>>,
is_shutdown: Arc<AtomicBool>,
}
impl Default for SdkMeterProvider {
fn default() -> Self {
SdkMeterProvider::builder().build()
}
}
impl SdkMeterProvider {
/// Return default [MeterProviderBuilder]
pub fn builder() -> MeterProviderBuilder {
MeterProviderBuilder::default()
}
/// Flushes all pending telemetry.
///
/// There is no guaranteed that all telemetry be flushed or all resources have
/// been released on error.
///
/// # Examples
///
/// ```
/// use opentelemetry::{global, Context};
/// use opentelemetry_sdk::metrics::SdkMeterProvider;
///
/// fn init_metrics() -> SdkMeterProvider {
/// // Setup metric pipelines with readers + views, default has no
/// // readers so nothing is exported.
/// let provider = SdkMeterProvider::default();
///
/// // Set provider to be used as global meter provider
/// let _ = global::set_meter_provider(provider.clone());
///
/// provider
/// }
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let provider = init_metrics();
///
/// // create instruments + record measurements
///
/// // force all instruments to flush
/// provider.force_flush()?;
///
/// // record more measurements..
///
/// // shutdown ensures any cleanup required by the provider is done,
/// // and also invokes shutdown on the readers.
/// provider.shutdown()?;
///
/// Ok(())
/// }
/// ```
pub fn force_flush(&self) -> Result<()> {
self.inner.force_flush()
}
/// Shuts down the meter provider flushing all pending telemetry and releasing
/// any held computational resources.
///
/// This call is idempotent. The first call will perform all flush and releasing
/// operations. Subsequent calls will perform no action and will return an error
/// stating this.
///
/// Measurements made by instruments from meters this MeterProvider created will
/// not be exported after Shutdown is called.
///
/// There is no guaranteed that all telemetry be flushed or all resources have
/// been released on error.
pub fn shutdown(&self) -> Result<()> {
self.inner.shutdown()
}
}
impl SdkMeterProviderInner {
fn force_flush(&self) -> Result<()> {
self.pipes.force_flush()
}
fn shutdown(&self) -> Result<()> {
if self
.is_shutdown
.compare_exchange(false, true, Ordering::SeqCst, Ordering::SeqCst)
.is_ok()
{
self.pipes.shutdown()
} else {
Err(MetricsError::Other(
"metrics provider already shut down".into(),
))
}
}
}
impl Drop for SdkMeterProviderInner {
fn drop(&mut self) {
if let Err(err) = self.shutdown() {
global::handle_error(err);
}
}
}
impl MeterProvider for SdkMeterProvider {
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 {
if self.inner.is_shutdown.load(Ordering::Relaxed) {
return Meter::new(Arc::new(NoopMeterCore::new()));
}
let mut builder = Scope::builder(name);
if let Some(v) = version {
builder = builder.with_version(v);
}
if let Some(s) = schema_url {
builder = builder.with_schema_url(s);
}
if let Some(a) = attributes {
builder = builder.with_attributes(a);
}
let scope = builder.build();
if let Ok(mut meters) = self.inner.meters.lock() {
let meter = meters
.entry(scope)
.or_insert_with_key(|scope| {
Arc::new(SdkMeter::new(scope.clone(), self.inner.pipes.clone()))
})
.clone();
Meter::new(meter)
} else {
Meter::new(Arc::new(NoopMeterCore::new()))
}
}
}
/// Configuration options for a [MeterProvider].
#[derive(Default)]
pub struct MeterProviderBuilder {
resource: Option<Resource>,
readers: Vec<Box<dyn MetricReader>>,
views: Vec<Arc<dyn View>>,
}
impl MeterProviderBuilder {
/// Associates a [Resource] with a [MeterProvider].
///
/// This [Resource] represents the entity producing telemetry and is associated
/// with all [Meter]s the [MeterProvider] will create.
///
/// By default, if this option is not used, the default [Resource] will be used.
///
/// [Meter]: opentelemetry::metrics::Meter
pub fn with_resource(mut self, resource: Resource) -> Self {
self.resource = Some(resource);
self
}
/// Associates a [MetricReader] with a [MeterProvider].
///
/// By default, if this option is not used, the [MeterProvider] will perform no
/// operations; no data will be exported without a [MetricReader].
pub fn with_reader<T: MetricReader>(mut self, reader: T) -> Self {
self.readers.push(Box::new(reader));
self
}
/// Associates a [View] with a [MeterProvider].
///
/// [View]s are appended to existing ones in a [MeterProvider] if this option is
/// used multiple times.
///
/// By default, if this option is not used, the [MeterProvider] will use the
/// default view.
pub fn with_view<T: View>(mut self, view: T) -> Self {
self.views.push(Arc::new(view));
self
}
/// Construct a new [MeterProvider] with this configuration.
pub fn build(self) -> SdkMeterProvider {
SdkMeterProvider {
inner: Arc::new(SdkMeterProviderInner {
pipes: Arc::new(Pipelines::new(
self.resource.unwrap_or_default(),
self.readers,
self.views,
)),
meters: Default::default(),
is_shutdown: Arc::new(AtomicBool::new(false)),
}),
}
}
}
impl fmt::Debug for MeterProviderBuilder {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("MeterProviderBuilder")
.field("resource", &self.resource)
.field("readers", &self.readers)
.field("views", &self.views.len())
.finish()
}
}
#[cfg(test)]
mod tests {
use crate::resource::{
SERVICE_NAME, TELEMETRY_SDK_LANGUAGE, TELEMETRY_SDK_NAME, TELEMETRY_SDK_VERSION,
};
use crate::testing::metrics::metric_reader::TestMetricReader;
use crate::Resource;
use opentelemetry::global;
use opentelemetry::metrics::MeterProvider;
use opentelemetry::{Key, KeyValue, Value};
use std::env;
#[test]
fn test_meter_provider_resource() {
let assert_resource = |provider: &super::SdkMeterProvider,
resource_key: &'static str,
expect: Option<&'static str>| {
assert_eq!(
provider.inner.pipes.0[0]
.resource
.get(Key::from_static_str(resource_key))
.map(|v| v.to_string()),
expect.map(|s| s.to_string())
);
};
let assert_telemetry_resource = |provider: &super::SdkMeterProvider| {
assert_eq!(
provider.inner.pipes.0[0]
.resource
.get(TELEMETRY_SDK_LANGUAGE.into()),
Some(Value::from("rust"))
);
assert_eq!(
provider.inner.pipes.0[0]
.resource
.get(TELEMETRY_SDK_NAME.into()),
Some(Value::from("opentelemetry"))
);
assert_eq!(
provider.inner.pipes.0[0]
.resource
.get(TELEMETRY_SDK_VERSION.into()),
Some(Value::from(env!("CARGO_PKG_VERSION")))
);
};
// If users didn't provide a resource and there isn't a env var set. Use default one.
temp_env::with_var_unset("OTEL_RESOURCE_ATTRIBUTES", || {
let reader = TestMetricReader::new();
let default_meter_provider = super::SdkMeterProvider::builder()
.with_reader(reader)
.build();
assert_resource(
&default_meter_provider,
SERVICE_NAME,
Some("unknown_service"),
);
assert_telemetry_resource(&default_meter_provider);
});
// If user provided a resource, use that.
let reader2 = TestMetricReader::new();
let custom_meter_provider = super::SdkMeterProvider::builder()
.with_reader(reader2)
.with_resource(Resource::new(vec![KeyValue::new(
SERVICE_NAME,
"test_service",
)]))
.build();
assert_resource(&custom_meter_provider, SERVICE_NAME, Some("test_service"));
assert_eq!(custom_meter_provider.inner.pipes.0[0].resource.len(), 1);
temp_env::with_var(
"OTEL_RESOURCE_ATTRIBUTES",
Some("key1=value1, k2, k3=value2"),
|| {
// If `OTEL_RESOURCE_ATTRIBUTES` is set, read them automatically
let reader3 = TestMetricReader::new();
let env_resource_provider = super::SdkMeterProvider::builder()
.with_reader(reader3)
.build();
assert_resource(
&env_resource_provider,
SERVICE_NAME,
Some("unknown_service"),
);
assert_resource(&env_resource_provider, "key1", Some("value1"));
assert_resource(&env_resource_provider, "k3", Some("value2"));
assert_telemetry_resource(&env_resource_provider);
assert_eq!(env_resource_provider.inner.pipes.0[0].resource.len(), 6);
},
);
// When `OTEL_RESOURCE_ATTRIBUTES` is set and also user provided config
temp_env::with_var(
"OTEL_RESOURCE_ATTRIBUTES",
Some("my-custom-key=env-val,k2=value2"),
|| {
let reader4 = TestMetricReader::new();
let user_provided_resource_config_provider = super::SdkMeterProvider::builder()
.with_reader(reader4)
.with_resource(Resource::default().merge(&mut Resource::new(vec![
KeyValue::new("my-custom-key", "my-custom-value"),
KeyValue::new("my-custom-key2", "my-custom-value2"),
])))
.build();
assert_resource(
&user_provided_resource_config_provider,
SERVICE_NAME,
Some("unknown_service"),
);
assert_resource(
&user_provided_resource_config_provider,
"my-custom-key",
Some("my-custom-value"),
);
assert_resource(
&user_provided_resource_config_provider,
"my-custom-key2",
Some("my-custom-value2"),
);
assert_resource(
&user_provided_resource_config_provider,
"k2",
Some("value2"),
);
assert_telemetry_resource(&user_provided_resource_config_provider);
assert_eq!(
user_provided_resource_config_provider.inner.pipes.0[0]
.resource
.len(),
7
);
},
);
// If user provided a resource, it takes priority during collision.
let reader5 = TestMetricReader::new();
let no_service_name = super::SdkMeterProvider::builder()
.with_reader(reader5)
.with_resource(Resource::empty())
.build();
assert_eq!(no_service_name.inner.pipes.0[0].resource.len(), 0)
}
#[test]
fn test_meter_provider_shutdown() {
let reader = TestMetricReader::new();
let provider = super::SdkMeterProvider::builder()
.with_reader(reader.clone())
.build();
global::set_meter_provider(provider.clone());
assert!(!reader.is_shutdown());
// create a meter and an instrument
let meter = global::meter("test");
let counter = meter.u64_counter("test_counter").init();
// no need to drop a meter for meter_provider shutdown
let shutdown_res = provider.shutdown();
assert!(shutdown_res.is_ok());
// shutdown once more should return an error
let shutdown_res = provider.shutdown();
assert!(shutdown_res.is_err());
assert!(reader.is_shutdown());
// TODO Fix: the instrument is still available, and can be used.
// While the reader is shutdown, and no collect is happening
counter.add(1, &[]);
}
#[test]
fn test_shutdown_invoked_on_last_drop() {
let reader = TestMetricReader::new();
let provider = super::SdkMeterProvider::builder()
.with_reader(reader.clone())
.build();
let clone1 = provider.clone();
let clone2 = provider.clone();
// Initially, shutdown should not be called
assert!(!reader.is_shutdown());
// Drop the first clone
drop(clone1);
assert!(!reader.is_shutdown());
// Drop the second clone
drop(clone2);
assert!(!reader.is_shutdown());
// Drop the last original provider
drop(provider);
// Now the shutdown should be invoked
assert!(reader.is_shutdown());
}
#[test]
fn same_meter_reused_same_scope() {
let provider = super::SdkMeterProvider::builder().build();
let _meter1 = provider.meter("test");
let _meter2 = provider.meter("test");
assert_eq!(provider.inner.meters.lock().unwrap().len(), 1);
let _meter3 =
provider.versioned_meter("test", Some("1.0.0"), Some("http://example.com"), None);
let _meter4 =
provider.versioned_meter("test", Some("1.0.0"), Some("http://example.com"), None);
let _meter5 =
provider.versioned_meter("test", Some("1.0.0"), Some("http://example.com"), None);
assert_eq!(provider.inner.meters.lock().unwrap().len(), 2);
// the below are different meters, as meter names are case sensitive
let _meter6 =
provider.versioned_meter("ABC", Some("1.0.0"), Some("http://example.com"), None);
let _meter7 =
provider.versioned_meter("Abc", Some("1.0.0"), Some("http://example.com"), None);
let _meter8 =
provider.versioned_meter("abc", Some("1.0.0"), Some("http://example.com"), None);
assert_eq!(provider.inner.meters.lock().unwrap().len(), 5);
}
}