Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 56 additions & 9 deletions src/spanner/src/observability/metrics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ use {
gaxi::options::ClientConfig,
google_cloud_monitoring_v3::client::MetricService,
opentelemetry::metrics::{Counter, Histogram, Meter, MeterProvider},
opentelemetry_sdk::metrics::{PeriodicReader, SdkMeterProvider},
opentelemetry_sdk::{
error::OTelSdkError,
metrics::{PeriodicReader, SdkMeterProvider},
},
};

#[cfg(not(feature = "_experimental-builtin-metrics"))]
Expand Down Expand Up @@ -76,15 +79,15 @@ impl SpannerMetrics {
#[derive(Debug)]
pub(crate) struct Observability {
pub(crate) metrics: Option<SpannerMetrics>,
_meter_provider: Option<SdkMeterProvider>,
meter_provider: Option<SdkMeterProvider>,
}

#[cfg(feature = "_experimental-builtin-metrics")]
impl Observability {
pub(crate) fn disabled() -> Self {
Self {
metrics: None,
_meter_provider: None,
meter_provider: None,
}
}

Expand Down Expand Up @@ -138,7 +141,7 @@ impl Observability {

Self {
metrics: Some(metrics),
_meter_provider: Some(meter_provider),
meter_provider: Some(meter_provider),
}
}

Expand Down Expand Up @@ -228,6 +231,25 @@ impl Observability {
.record(duration.as_secs_f64() * 1000.0, &attributes);
metrics.operation_count.add(1, &attributes);
}

pub(crate) fn shutdown(&self) {
if let Some(ref provider) = self.meter_provider
&& let Err(err) = provider.shutdown()
&& !matches!(err, OTelSdkError::AlreadyShutdown)
{
tracing::warn!(
"Error shutting down OpenTelemetry SdkMeterProvider: {:?}",
err
);
}
}
}

#[cfg(feature = "_experimental-builtin-metrics")]
impl Drop for Observability {
fn drop(&mut self) {
self.shutdown();
}
}

#[cfg(feature = "_experimental-builtin-metrics")]
Expand Down Expand Up @@ -307,38 +329,63 @@ impl Observability {
{
f().await
}

#[allow(dead_code)]
pub(crate) fn shutdown(&self) {}
}

#[cfg(all(test, feature = "_experimental-builtin-metrics"))]
mod tests {
use super::*;

#[test]
fn test_parse_server_timing() {
fn parse_server_timing() {
assert_eq!(
parse_server_timing("gfet4t7;dur=12.5"),
super::parse_server_timing("gfet4t7;dur=12.5"),
ServerTimings {
gfe_latency: Some(12.5),
afe_latency: None,
}
);
assert_eq!(
parse_server_timing("gfet4t7;desc=\"test\";dur=12.5,afe;dur=5;desc=\"other\""),
super::parse_server_timing("gfet4t7;desc=\"test\";dur=12.5,afe;dur=5;desc=\"other\""),
ServerTimings {
gfe_latency: Some(12.5),
afe_latency: Some(5.0),
}
);
assert_eq!(
parse_server_timing("afe;dur=3,some-other;dur=10"),
super::parse_server_timing("afe;dur=3,some-other;dur=10"),
ServerTimings {
gfe_latency: None,
afe_latency: Some(3.0),
}
);
assert_eq!(
parse_server_timing("invalid_format"),
super::parse_server_timing("invalid_format"),
ServerTimings::default()
);
}

#[test]
fn observability_disabled_shutdown_and_drop() {
let o11y = Observability::disabled();
o11y.shutdown();
o11y.shutdown();
// Dropping o11y should invoke Drop and shutdown without panic.
}

#[cfg(feature = "_experimental-builtin-metrics")]
#[test]
fn observability_double_shutdown_ignores_already_shutdown() {
let meter_provider = SdkMeterProvider::builder().build();
let o11y = Observability {
metrics: None,
meter_provider: Some(meter_provider),
};
// Calling shutdown twice should cleanly handle AlreadyShutdown on the second call.
o11y.shutdown();
o11y.shutdown();
// Dropping o11y invokes Drop and calls shutdown a third time without panic or warning.
}
}
Loading