add shutdown with timeout for log exporter

mohammadVatandoost · mohammadVatandoost · commit 4c2ed453f50a · 2025-04-07T21:19:24.000+02:00
diff --git a/opentelemetry-appender-log/Cargo.toml b/opentelemetry-appender-log/Cargo.toml
@@ -29,15 +29,5 @@ spec_unstable_logs_enabled = ["opentelemetry/spec_unstable_logs_enabled"]
 with-serde = ["log/kv_serde", "serde"]
 experimental_metadata_attributes = ["dep:opentelemetry-semantic-conventions"]
 
-[dev-dependencies]
-opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [
-  "testing",
-  "spec_unstable_logs_enabled",
-] }
-opentelemetry-stdout = { workspace = true, features = ["logs"] }
-log = { workspace = true, features = ["kv_serde"] }
-tokio = { workspace = true }
-serde = { workspace = true, features = ["std", "derive"] }
-
 [lints]
 workspace = true
diff --git a/opentelemetry-appender-tracing/Cargo.toml b/opentelemetry-appender-tracing/Cargo.toml
@@ -20,19 +20,6 @@ tracing-log = { workspace = true, optional = true }
 tracing-subscriber = { workspace = true, features = ["registry", "std"] }
 tracing-opentelemetry = { workspace = true, optional = true }
 
-[dev-dependencies]
-log = { workspace = true }
-opentelemetry-stdout = { workspace = true, features = ["logs"] }
-opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["logs", "testing"]  }
-tracing = { workspace = true, features = ["std"]}
-tracing-subscriber = { workspace = true, features = ["env-filter","registry", "std", "fmt"] }
-tracing-log = { workspace = true }
-criterion = { workspace = true }
-tokio = { workspace = true, features = ["full"]}
-
-[target.'cfg(not(target_os = "windows"))'.dev-dependencies]
-pprof = { version = "0.14", features = ["flamegraph", "criterion"] }
-
 [features]
 default = []
 experimental_metadata_attributes = ["dep:tracing-log"]
diff --git a/opentelemetry-jaeger-propagator/Cargo.toml b/opentelemetry-jaeger-propagator/Cargo.toml
@@ -25,9 +25,6 @@ opentelemetry = { version = "0.29", default-features = false, features = [
     "trace",
 ], path = "../opentelemetry" }
 
-[dev-dependencies]
-opentelemetry = { features = ["testing"], path = "../opentelemetry" }
-
 [features]
 default = ["internal-logs"]
 internal-logs = ["opentelemetry/internal-logs"]
diff --git a/opentelemetry-otlp/Cargo.toml b/opentelemetry-otlp/Cargo.toml
@@ -43,15 +43,6 @@ serde = { workspace = true, features = ["derive"], optional = true }
 thiserror = { workspace = true }
 serde_json = { workspace = true, optional = true }
 
-[dev-dependencies]
-tokio-stream = { workspace = true, features = ["net"] }
-# need tokio runtime to run smoke tests.
-opentelemetry_sdk = { features = ["trace", "rt-tokio", "testing"], path = "../opentelemetry-sdk" }
-tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
-futures-util = { workspace = true }
-temp-env = { workspace = true }
-tonic = { workspace = true, features = ["router", "server"] }
-
 [features]
 # telemetry pillars and functions
 trace = ["opentelemetry/trace", "opentelemetry_sdk/trace", "opentelemetry-proto/trace"]
diff --git a/opentelemetry-otlp/src/exporter/http/logs.rs b/opentelemetry-otlp/src/exporter/http/logs.rs
@@ -1,3 +1,4 @@
+use std::time;
 use super::OtlpHttpClient;
 use http::{header::CONTENT_TYPE, Method};
 use opentelemetry::otel_debug;
@@ -46,7 +47,7 @@ impl LogExporter for OtlpHttpClient {
         Ok(())
     }
 
-    fn shutdown(&self) -> OTelSdkResult {
+    fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
         let mut client_guard = self.client.lock().map_err(|e| {
             OTelSdkError::InternalFailure(format!("Failed to acquire client lock: {}", e))
         })?;
@@ -58,6 +59,10 @@ impl LogExporter for OtlpHttpClient {
         Ok(())
     }
 
+    fn shutdown(&self) -> OTelSdkResult {
+        self.shutdown_with_timeout(time::Duration::from_secs(5))
+    }
+
     fn set_resource(&mut self, resource: &opentelemetry_sdk::Resource) {
         self.resource = resource.into();
     }
diff --git a/opentelemetry-otlp/src/exporter/tonic/logs.rs b/opentelemetry-otlp/src/exporter/tonic/logs.rs
@@ -1,4 +1,5 @@
 use core::fmt;
+use std::time;
 use opentelemetry::otel_debug;
 use opentelemetry_proto::tonic::collector::logs::v1::{
     logs_service_client::LogsServiceClient, ExportLogsServiceRequest,
@@ -84,7 +85,7 @@ impl LogExporter for TonicLogsClient {
         Ok(())
     }
 
-    fn shutdown(&self) -> OTelSdkResult {
+    fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
         // TODO: Implement actual shutdown
         // Due to the use of tokio::sync::Mutex to guard
         // the inner client, we need to await the call to lock the mutex
diff --git a/opentelemetry-otlp/src/logs.rs b/opentelemetry-otlp/src/logs.rs
@@ -5,7 +5,7 @@
 #[cfg(feature = "grpc-tonic")]
 use opentelemetry::otel_debug;
 use std::fmt::Debug;
-
+use std::time;
 use opentelemetry_sdk::{error::OTelSdkResult, logs::LogBatch};
 
 use crate::{ExporterBuildError, HasExportConfig, NoExporterBuilderSet};
@@ -157,7 +157,7 @@ impl opentelemetry_sdk::logs::LogExporter for LogExporter {
         }
     }
 
-    fn shutdown(&self) -> OTelSdkResult {
+    fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
         match &self.client {
             #[cfg(feature = "grpc-tonic")]
             SupportedTransportClient::Tonic(client) => client.shutdown(),
diff --git a/opentelemetry-proto/Cargo.toml b/opentelemetry-proto/Cargo.toml
@@ -60,12 +60,5 @@ serde = { workspace = true, optional = true, features = ["serde_derive"] }
 hex = { workspace = true, optional = true }
 base64 = { workspace = true, optional = true }
 
-[dev-dependencies]
-opentelemetry = { features = ["testing"], path = "../opentelemetry" }
-tonic-build = { workspace = true }
-prost-build = { workspace = true }
-tempfile = { workspace = true }
-serde_json = { workspace = true }
-
 [lints]
 workspace = true
diff --git a/opentelemetry-sdk/Cargo.toml b/opentelemetry-sdk/Cargo.toml
@@ -31,14 +31,6 @@ http = { workspace = true, optional = true }
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
 
-[dev-dependencies]
-criterion = { workspace = true, features = ["html_reports"] }
-rstest = { workspace = true }
-temp-env = { workspace = true }
-
-[target.'cfg(not(target_os = "windows"))'.dev-dependencies]
-pprof = { version = "0.14", features = ["flamegraph", "criterion"] }
-
 [features]
 default = ["trace", "metrics", "logs", "internal-logs"]
 trace = ["opentelemetry/trace", "rand", "percent-encoding"]
diff --git a/opentelemetry-sdk/benches/log_enabled.rs b/opentelemetry-sdk/benches/log_enabled.rs
@@ -11,6 +11,7 @@
 
 // cargo bench --bench log_enabled --features="spec_unstable_logs_enabled,experimental_logs_concurrent_log_processor"
 
+use std::time;
 use criterion::{criterion_group, criterion_main, Criterion};
 use opentelemetry::logs::{Logger, LoggerProvider};
 use opentelemetry_sdk::error::OTelSdkResult;
@@ -29,7 +30,7 @@ impl LogExporter for NoopExporter {
         Ok(())
     }
 
-    fn shutdown(&self) -> OTelSdkResult {
+    fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
         Ok(())
     }
 
diff --git a/opentelemetry-sdk/src/logs/export.rs b/opentelemetry-sdk/src/logs/export.rs
@@ -6,6 +6,7 @@ use crate::Resource;
 use opentelemetry::logs::Severity;
 use opentelemetry::InstrumentationScope;
 use std::fmt::Debug;
+use std::time;
 
 /// A batch of log records to be exported by a `LogExporter`.
 ///
@@ -134,10 +135,11 @@ pub trait LogExporter: Send + Sync + Debug {
         &self,
         batch: LogBatch<'_>,
     ) -> impl std::future::Future<Output = OTelSdkResult> + Send;
-
     /// Shuts down the exporter.
+    fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult;
+    /// Shuts down the exporter with a default timeout.
     fn shutdown(&self) -> OTelSdkResult {
-        Ok(())
+        self.shutdown_with_timeout(time::Duration::from_secs(5))
     }
     #[cfg(feature = "spec_unstable_logs_enabled")]
     /// Check if logs are enabled.
diff --git a/opentelemetry-sdk/src/logs/in_memory_exporter.rs b/opentelemetry-sdk/src/logs/in_memory_exporter.rs
@@ -7,6 +7,7 @@ use opentelemetry::InstrumentationScope;
 use std::borrow::Cow;
 use std::sync::atomic::AtomicBool;
 use std::sync::{Arc, Mutex};
+use std::time;
 
 /// An in-memory logs exporter that stores logs data in memory..
 ///
@@ -205,7 +206,7 @@ impl LogExporter for InMemoryLogExporter {
         Ok(())
     }
 
-    fn shutdown(&self) -> OTelSdkResult {
+    fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
         self.shutdown_called
             .store(true, std::sync::atomic::Ordering::Relaxed);
         if self.should_reset_on_shutdown {
@@ -214,6 +215,11 @@ impl LogExporter for InMemoryLogExporter {
         Ok(())
     }
 
+    fn shutdown(&self) -> OTelSdkResult {
+        self.shutdown_with_timeout(time::Duration::from_secs(5))
+    }
+
+
     fn set_resource(&mut self, resource: &Resource) {
         let mut res_guard = self.resource.lock().expect("Resource lock poisoned");
         *res_guard = resource.clone();
diff --git a/opentelemetry-sdk/src/logs/log_processor.rs b/opentelemetry-sdk/src/logs/log_processor.rs
@@ -81,6 +81,7 @@ pub(crate) mod tests {
     use opentelemetry::logs::{Logger, LoggerProvider};
     use opentelemetry::{InstrumentationScope, Key};
     use std::sync::{Arc, Mutex};
+    use std::time;
 
     #[derive(Debug, Clone)]
     pub(crate) struct MockLogExporter {
@@ -92,7 +93,7 @@ pub(crate) mod tests {
             Ok(())
         }
 
-        fn shutdown(&self) -> OTelSdkResult {
+        fn shutdown_with_timeout(&self, _timeout: time::Duration)-> OTelSdkResult {
             Ok(())
         }
 
diff --git a/opentelemetry-sdk/src/logs/log_processor_with_async_runtime.rs b/opentelemetry-sdk/src/logs/log_processor_with_async_runtime.rs
@@ -309,6 +309,7 @@ mod tests {
     use opentelemetry::KeyValue;
     use opentelemetry::{InstrumentationScope, Key};
     use std::sync::{Arc, Mutex};
+    use std::time;
     use std::time::Duration;
 
     #[derive(Debug, Clone)]
@@ -321,10 +322,14 @@ mod tests {
             Ok(())
         }
 
-        fn shutdown(&self) -> OTelSdkResult {
+        fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
             Ok(())
         }
 
+        fn shutdown(&self) -> OTelSdkResult {
+            self.shutdown_with_timeout(time::Duration::from_secs(5))
+        }
+
         fn set_resource(&mut self, resource: &Resource) {
             self.resource
                 .lock()
diff --git a/opentelemetry-sdk/src/logs/logger_provider.rs b/opentelemetry-sdk/src/logs/logger_provider.rs
@@ -291,7 +291,7 @@ mod tests {
     use std::fmt::{Debug, Formatter};
     use std::sync::atomic::AtomicU64;
     use std::sync::Mutex;
-    use std::thread;
+    use std::{thread, time};
 
     struct ShutdownTestLogProcessor {
         is_shutdown: Arc<Mutex<bool>>,
@@ -364,7 +364,7 @@ mod tests {
             *res = resource.clone();
         }
 
-        fn shutdown(&self) -> OTelSdkResult {
+        fn shutdown_with_timeout(&self, _timeout: time::Duration)-> OTelSdkResult {
             Ok(())
         }
     }
diff --git a/opentelemetry-sdk/src/logs/simple_log_processor.rs b/opentelemetry-sdk/src/logs/simple_log_processor.rs
@@ -164,6 +164,7 @@ mod tests {
     use opentelemetry::KeyValue;
     use std::sync::atomic::{AtomicUsize, Ordering};
     use std::sync::{Arc, Mutex};
+    use std::time;
     use std::time::Duration;
 
     #[derive(Debug, Clone)]
@@ -195,6 +196,9 @@ mod tests {
             }
             Ok(())
         }
+        fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
+            Ok(())
+        }
     }
 
     #[test]
@@ -460,7 +464,8 @@ mod tests {
     }
 
     impl LogExporter for ReentrantLogExporter {
-        fn shutdown(&self) -> OTelSdkResult {
+
+        fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
             Ok(())
         }
 
diff --git a/opentelemetry-semantic-conventions/Cargo.toml b/opentelemetry-semantic-conventions/Cargo.toml
@@ -24,10 +24,6 @@ rustdoc-args = ["--cfg", "docsrs"]
 default = []
 semconv_experimental = []
 
-[dev-dependencies]
-opentelemetry = { default-features = false, path = "../opentelemetry" } # for doctests
-opentelemetry_sdk = { features = ["trace"], path = "../opentelemetry-sdk" } # for doctests
-
 [lints]
 workspace = true
 
diff --git a/opentelemetry-stdout/Cargo.toml b/opentelemetry-stdout/Cargo.toml
@@ -31,15 +31,6 @@ chrono = { workspace = true, features = ["now"] }
 opentelemetry = { version = "0.29", path = "../opentelemetry" }
 opentelemetry_sdk = { version = "0.29", path = "../opentelemetry-sdk" }
 
-[dev-dependencies]
-opentelemetry = { path = "../opentelemetry", features = ["metrics"] }
-opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["rt-tokio", "metrics"] }
-opentelemetry-appender-tracing = { workspace = true }
-tracing = { workspace = true, features = ["std"]}
-tracing-subscriber = { workspace = true, features = ["registry", "std"] }
-tokio = { workspace = true, features = ["full"] }
-once_cell = { workspace = true }
-
 [lints]
 workspace = true
 
diff --git a/opentelemetry-stdout/src/logs/exporter.rs b/opentelemetry-stdout/src/logs/exporter.rs
@@ -5,6 +5,7 @@ use opentelemetry_sdk::logs::LogBatch;
 use opentelemetry_sdk::Resource;
 use std::sync::atomic;
 use std::sync::atomic::Ordering;
+use std::time;
 
 /// An OpenTelemetry exporter that writes Logs to stdout on export.
 pub struct LogExporter {
@@ -57,7 +58,7 @@ impl opentelemetry_sdk::logs::LogExporter for LogExporter {
         }
     }
 
-    fn shutdown(&self) -> OTelSdkResult {
+    fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {
         self.is_shutdown.store(true, atomic::Ordering::SeqCst);
         Ok(())
     }
diff --git a/opentelemetry-zipkin/Cargo.toml b/opentelemetry-zipkin/Cargo.toml
@@ -38,15 +38,6 @@ http = { workspace = true }
 reqwest = { workspace = true, optional = true }
 thiserror = { workspace = true }
 
-[dev-dependencies]
-async-trait = { workspace = true }
-bytes = { workspace = true }
-futures-util = { workspace = true, features = ["io"] }
-http-body-util = { workspace = true }
-hyper-util = { workspace = true, features = ["client-legacy", "http1", "tokio"] }
-opentelemetry_sdk = { default-features = false, features = ["trace", "testing"], path = "../opentelemetry-sdk" }
-temp-env = { workspace = true }
-
 [lints]
 workspace = true
 
diff --git a/opentelemetry/Cargo.toml b/opentelemetry/Cargo.toml
@@ -41,13 +41,6 @@ logs = []
 spec_unstable_logs_enabled = ["logs"]
 internal-logs = ["tracing"]
 
-[dev-dependencies]
-opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["spec_unstable_logs_enabled"]} # for documentation tests
-criterion = { workspace = true }
-rand = { workspace = true, features = ["os_rng", "thread_rng"] }
-tokio = { version = "1.0", features = ["full"] }
-futures = "0.3"
-
 [[bench]]
 name = "metrics"
 harness = false
diff --git a/stress/src/logs.rs b/stress/src/logs.rs
@@ -17,6 +17,7 @@
      3 M/sec (when enabled)  (.with_log_processor(SimpleLogProcessor::new(NoopExporter::new(true))))
     26 M/sec (when disabled) (.with_log_processor(SimpleLogProcessor::new(NoopExporter::new(false)))
 */
+use std::time;
 use opentelemetry::Key;
 use opentelemetry_appender_tracing::layer;
 use opentelemetry_sdk::error::OTelSdkResult;
@@ -52,7 +53,7 @@ impl LogExporter for NoopExporter {
         Ok(())
     }
 
-    fn shutdown(&self) -> OTelSdkResult {
+    fn shutdown_with_timeout(&self, _timeout: time::Duration)-> OTelSdkResult {
         Ok(())
     }
 

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`// cargo bench --bench log_enabled --features="spec_unstable_logs_enabled,experimental_logs_concurrent_log_processor"`
`13`	`13`
	`14`	`+use std::time;`
`14`	`15`	`use criterion::{criterion_group, criterion_main, Criterion};`
`15`	`16`	`use opentelemetry::logs::{Logger, LoggerProvider};`
`16`	`17`	`use opentelemetry_sdk::error::OTelSdkResult;`
`@@ -29,7 +30,7 @@ impl LogExporter for NoopExporter {`
`29`	`30`	`Ok(())`
`30`	`31`	`}`
`31`	`32`
`32`		`- fn shutdown(&self) -> OTelSdkResult {`
	`33`	`+ fn shutdown_with_timeout(&self, _timeout: time::Duration) -> OTelSdkResult {`
`33`	`34`	`Ok(())`
`34`	`35`	`}`
`35`	`36`