Re-export ShutdownError from common location

Author: scottgerring

examples/tracing-grpc/src/server.rs

@@ -5,9 +5,7 @@ use opentelemetry::{
     propagation::Extractor,
     trace::{Span, SpanKind, Tracer},
 };
-use opentelemetry_sdk::{
-    propagation::TraceContextPropagator, trace::TracerProvider,
-};
+use opentelemetry_sdk::{propagation::TraceContextPropagator, trace::TracerProvider};
 use opentelemetry_stdout::SpanExporter;
 use tonic::{transport::Server, Request, Response, Status};
 

opentelemetry-sdk/src/error.rs

@@ -1,15 +1,18 @@
 //! Wrapper for error from trace, logs and metrics part of open telemetry.
-use std::sync::PoisonError;
-
 #[cfg(feature = "logs")]
 use crate::logs::LogError;
 #[cfg(feature = "metrics")]
 use crate::metrics::MetricError;
 use opentelemetry::propagation::PropagationError;
 #[cfg(feature = "trace")]
 use opentelemetry::trace::TraceError;
+use std::sync::PoisonError;
+use std::time::Duration;
+use thiserror::Error;
 
-/// Wrapper for error from both tracing and metrics part of open telemetry.
+/// Wrapper for error from both tracing and metrics part of open telemetry. This
+/// gives us a common error type where we _need_ to return errors that may come
+/// from various components.
 #[derive(thiserror::Error, Debug)]
 #[non_exhaustive]
 pub enum Error {
@@ -34,6 +37,10 @@ pub enum Error {
     /// Error happens when injecting and extracting information using propagators.
     Propagation(#[from] PropagationError),
 
+    /// Failed to shutdown an exporter
+    #[error(transparent)]
+    Shutdown(#[from] ShutdownError),
+
     #[error("{0}")]
     /// Other types of failures not covered by the variants above.
     Other(String),
@@ -44,3 +51,28 @@ impl<T> From<PoisonError<T>> for Error {
         Error::Other(err.to_string())
     }
 }
+
+/// Errors returned by shutdown operations in the Export API.
+#[derive(Error, Debug)]
+#[non_exhaustive]
+pub enum ShutdownError {
+    /// Shutdown timed out before completing.
+    #[error("Shutdown timed out after {0:?}")]
+    Timeout(Duration),
+
+    /// The export client failed while holding the client lock. It is not
+    /// possible to complete the shutdown and a retry will not help.
+    /// This is something that should not happen and should likely emit some diagnostic.
+    #[error("export client failed while holding lock; cannot retry.")]
+    ClientFailed(String),
+
+    /// An unexpected error occurred during shutdown.
+    #[error(transparent)]
+    Other(#[from] Box<dyn std::error::Error + Send + Sync + 'static>),
+}
+
+impl<T> From<PoisonError<T>> for ShutdownError {
+    fn from(err: PoisonError<T>) -> Self {
+        ShutdownError::ClientFailed(format!("Mutex poisoned during shutdown: {}", err))
+    }
+}

opentelemetry-sdk/src/export/logs/mod.rs

@@ -1,12 +1,15 @@
 //! Log exporters
+use crate::logs::LogError;
 use crate::logs::LogRecord;
-use crate::logs::{LogError, ShutdownError};
 use crate::Resource;
 #[cfg(feature = "spec_unstable_logs_enabled")]
 use opentelemetry::logs::Severity;
 use opentelemetry::InstrumentationScope;
 use std::fmt::Debug;
 
+// Re-export ShutdownError
+pub use crate::error::ShutdownError;
+
 /// A batch of log records to be exported by a `LogExporter`.
 ///
 /// The `LogBatch` struct holds a collection of log records along with their associated

opentelemetry-sdk/src/export/trace.rs

@@ -5,9 +5,10 @@ use opentelemetry::trace::{SpanContext, SpanId, SpanKind, Status, TraceError};
 use opentelemetry::{InstrumentationScope, KeyValue};
 use std::borrow::Cow;
 use std::fmt::Debug;
-use std::sync::PoisonError;
-use std::time::{Duration, SystemTime};
-use thiserror::Error;
+use std::time::SystemTime;
+
+// Re-export ShutdownError
+pub use crate::error::ShutdownError;
 
 /// Results of an export operation
 pub type ExportResult = Result<(), TraceError>;
@@ -105,28 +106,3 @@ pub struct SpanData {
     /// Instrumentation scope that produced this span
     pub instrumentation_scope: InstrumentationScope,
 }
-
-/// Errors returned by shutdown operations in the Export API.
-#[derive(Error, Debug)]
-#[non_exhaustive]
-pub enum ShutdownError {
-    /// Shutdown timed out before completing.
-    #[error("Shutdown timed out after {0:?}")]
-    Timeout(Duration),
-
-    /// The export client failed while holding the client lock. It is not
-    /// possible to complete the shutdown and a retry will not help.
-    /// This is something that should not happen and should likely emit some diagnostic.
-    #[error("export client failed while holding lock; cannot retry.")]
-    ClientFailed(String),
-
-    /// An unexpected error occurred during shutdown.
-    #[error(transparent)]
-    Other(#[from] Box<dyn std::error::Error + Send + Sync + 'static>),
-}
-
-impl<T> From<PoisonError<T>> for ShutdownError {
-    fn from(err: PoisonError<T>) -> Self {
-        ShutdownError::ClientFailed(format!("Mutex poisoned during shutdown: {}", err))
-    }
-}

opentelemetry-sdk/src/logs/error.rs

@@ -1,6 +1,9 @@
+// Re-export ShutdownError
+pub use crate::error::ShutdownError;
+
 use crate::export::ExportError;
 
-use std::{sync::PoisonError, time::Duration};
+use std::time::Duration;
 use thiserror::Error;
 
 /// Describe the result of operations in log SDK.
@@ -58,24 +61,3 @@ impl From<&'static str> for LogError {
 #[derive(Error, Debug)]
 #[error("{0}")]
 struct Custom(String);
-
-/// Errors returned during shutdown
-#[derive(Error, Debug)]
-#[non_exhaustive]
-pub enum ShutdownError {
-    /// The export client failed while holding the client lock. It is not
-    /// possible to complete the shutdown and a retry will not help.
-    /// This is something that should not happen and should likely emit some diagnostic.
-    #[error("export client failed while holding lock; cannot retry.")]
-    ClientFailed(String),
-
-    /// Other errors propagated from log SDK that weren't covered above.
-    #[error(transparent)]
-    Other(#[from] Box<dyn std::error::Error + Send + Sync + 'static>),
-}
-
-impl<T> From<PoisonError<T>> for ShutdownError {
-    fn from(err: PoisonError<T>) -> Self {
-        ShutdownError::ClientFailed(format!("Mutex poisoned during shutdown: {}", err))
-    }
-}