add shutdown in global logger provider

TommyCpp · TommyCpp · commit 1b4566339990 · 2024-04-07T14:12:39.000-07:00
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.collector.logs.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.collector.logs.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 #[cfg_attr(feature = "with-schemars", derive(schemars::JsonSchema))]
 #[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "with-serde", serde(rename_all = "camelCase"))]
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.collector.metrics.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.collector.metrics.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 #[cfg_attr(feature = "with-schemars", derive(schemars::JsonSchema))]
 #[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "with-serde", serde(rename_all = "camelCase"))]
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.collector.trace.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.collector.trace.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 #[cfg_attr(feature = "with-schemars", derive(schemars::JsonSchema))]
 #[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "with-serde", serde(rename_all = "camelCase"))]
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.common.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.common.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 /// AnyValue is used to represent any type of attribute value. AnyValue may contain a
 /// primitive value such as a string or integer or it may contain an arbitrary nested
 /// object containing arrays, key-value lists and primitives.
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.logs.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.logs.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 /// LogsData represents the logs data that can be stored in a persistent storage,
 /// OR can be embedded by other protocols that transfer OTLP logs data but do not
 /// implement the OTLP protocol.
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.metrics.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.metrics.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 /// MetricsData represents the metrics data that can be stored in a persistent
 /// storage, OR can be embedded by other protocols that transfer OTLP metrics
 /// data but do not implement the OTLP protocol.
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.resource.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.resource.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 /// Resource information.
 #[cfg_attr(feature = "with-schemars", derive(schemars::JsonSchema))]
 #[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.trace.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.trace.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 /// TracesData represents the traces data that can be stored in a persistent storage,
 /// OR can be embedded by other protocols that transfer OTLP traces data but do
 /// not implement the OTLP protocol.
diff --git a/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.tracez.v1.rs b/opentelemetry-proto/src/proto/tonic/opentelemetry.proto.tracez.v1.rs
@@ -1,3 +1,4 @@
+// This file is @generated by prost-build.
 #[cfg_attr(feature = "with-schemars", derive(schemars::JsonSchema))]
 #[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "with-serde", serde(rename_all = "camelCase"))]
diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs
@@ -73,6 +73,20 @@ impl opentelemetry::logs::LoggerProvider for LoggerProvider {
         }
         Logger::new(library, self.clone())
     }
+
+    /// Shuts down this `LoggerProvider`
+    fn shutdown(&self) -> Vec<LogResult<()>> {
+        // mark itself as already shutdown
+        self.is_shutdown
+            .store(true, std::sync::atomic::Ordering::Relaxed);
+        // propagate the shutdown signal to processors
+        // it's up to the processor to properly block new logs after shutdown
+        self.inner
+            .processors
+            .iter()
+            .map(|processor| processor.shutdown())
+            .collect()
+    }
 }
 
 impl LoggerProvider {
@@ -98,27 +112,6 @@ impl LoggerProvider {
             .map(|processor| processor.force_flush())
             .collect()
     }
-
-    /// Shuts down this `LoggerProvider`, panicking on failure.
-    pub fn shutdown(&mut self) -> Vec<LogResult<()>> {
-        // mark itself as already shutdown
-        self.is_shutdown
-            .store(true, std::sync::atomic::Ordering::Relaxed);
-        // propagate the shutdown signal to processors
-        // it's up to the processor to properly block new logs after shutdown
-        self.inner
-            .processors
-            .iter()
-            .map(|processor| processor.shutdown())
-            .collect()
-    }
-
-    /// Attempts to shutdown this `LoggerProvider`, succeeding only when
-    /// all cloned `LoggerProvider` values have been dropped.
-    // todo: remove this
-    pub fn try_shutdown(&mut self) -> Option<Vec<LogResult<()>>> {
-        Some(self.shutdown())
-    }
 }
 
 #[derive(Debug)]
@@ -324,7 +317,7 @@ mod tests {
     #[test]
     fn shutdown_test() {
         let counter = Arc::new(AtomicU64::new(0));
-        let mut logger_provider = LoggerProvider::builder()
+        let logger_provider = LoggerProvider::builder()
             .with_log_processor(ShutdownTestLogProcessor::new(counter.clone()))
             .build();
 
diff --git a/opentelemetry/src/global/logs.rs b/opentelemetry/src/global/logs.rs
@@ -6,6 +6,7 @@ use std::{
 
 use once_cell::sync::Lazy;
 
+use crate::logs::LogResult;
 use crate::{
     logs::{Logger, LoggerProvider, NoopLoggerProvider},
     InstrumentationLibrary,
@@ -25,6 +26,9 @@ pub trait ObjectSafeLoggerProvider {
         &self,
         library: Arc<InstrumentationLibrary>,
     ) -> Box<dyn Logger + Send + Sync + 'static>;
+
+    /// shutdown the logger provider, logs emitted after this will not be processed.
+    fn shutdown(&self) -> Vec<LogResult<()>>;
 }
 
 impl<L, P> ObjectSafeLoggerProvider for P
@@ -38,6 +42,10 @@ where
     ) -> Box<dyn Logger + Send + Sync + 'static> {
         Box::new(self.library_logger(library))
     }
+
+    fn shutdown(&self) -> Vec<LogResult<()>> {
+        self.shutdown()
+    }
 }
 
 pub struct BoxedLogger(Box<dyn Logger + Send + Sync + 'static>);
@@ -132,5 +140,6 @@ where
 
 /// Shut down the current global [`LoggerProvider`].
 pub fn shutdown_logger_provider() {
-    let _ = set_logger_provider(NoopLoggerProvider::new());
+    let logger_provider = set_logger_provider(NoopLoggerProvider::new());
+    let _ = ObjectSafeLoggerProvider::shutdown(&logger_provider);
 }
diff --git a/opentelemetry/src/logs/logger.rs b/opentelemetry/src/logs/logger.rs
@@ -1,5 +1,6 @@
 use std::{borrow::Cow, sync::Arc};
 
+use crate::logs::LogResult;
 use crate::{logs::LogRecord, InstrumentationLibrary, KeyValue};
 
 #[cfg(feature = "logs_level_enabled")]
@@ -72,4 +73,12 @@ pub trait LoggerProvider {
     fn logger(&self, name: impl Into<Cow<'static, str>>) -> Self::Logger {
         self.versioned_logger(name, None, None, None)
     }
+
+    /// Shutdown the logger provider. Noop logger will be returned after shutdown.
+    ///
+    /// Note that `shutdown` doesn't mean `Drop`(though `Drop` can call `shutdown`).
+    /// It simply means the provider will emit anything in the buffer(if applicable) and stop processing
+    fn shutdown(&self) -> Vec<LogResult<()>> {
+        Vec::new() // noop
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// This file is @generated by prost-build.`
`1`	`2`	`#[cfg_attr(feature = "with-schemars", derive(schemars::JsonSchema))]`
`2`	`3`	`#[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]`
`3`	`4`	`#[cfg_attr(feature = "with-serde", serde(rename_all = "camelCase"))]`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// This file is @generated by prost-build.`
`1`	`2`	`/// AnyValue is used to represent any type of attribute value. AnyValue may contain a`
`2`	`3`	`/// primitive value such as a string or integer or it may contain an arbitrary nested`
`3`	`4`	`/// object containing arrays, key-value lists and primitives.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// This file is @generated by prost-build.`
`1`	`2`	`/// LogsData represents the logs data that can be stored in a persistent storage,`
`2`	`3`	`/// OR can be embedded by other protocols that transfer OTLP logs data but do not`
`3`	`4`	`/// implement the OTLP protocol.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// This file is @generated by prost-build.`
`1`	`2`	`/// MetricsData represents the metrics data that can be stored in a persistent`
`2`	`3`	`/// storage, OR can be embedded by other protocols that transfer OTLP metrics`
`3`	`4`	`/// data but do not implement the OTLP protocol.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// This file is @generated by prost-build.`
`1`	`2`	`/// Resource information.`
`2`	`3`	`#[cfg_attr(feature = "with-schemars", derive(schemars::JsonSchema))]`
`3`	`4`	`#[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// This file is @generated by prost-build.`
`1`	`2`	`/// TracesData represents the traces data that can be stored in a persistent storage,`
`2`	`3`	`/// OR can be embedded by other protocols that transfer OTLP traces data but do`
`3`	`4`	`/// not implement the OTLP protocol.`