Expose the Error type to allow users to set custom error handlers (#…

…551) Expose the `Error` type in the `global` module to allow users to define their own error handlers. This is currently impossible because `Error` is private and therefore users cannot provide a function that satisfies the constraints of `set_error_handler`.
open-telemetry · May 13, 2021 · 88e779d · 88e779d
1 parent 133ab27
commit 88e779d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/opentelemetry/src/global/error_handler.rs b/opentelemetry/src/global/error_handler.rs
@@ -18,12 +18,15 @@ pub enum Error {
     #[cfg(feature = "trace")]
     #[cfg_attr(docsrs, doc(cfg(feature = "trace")))]
     #[error(transparent)]
+    /// Failed to export traces.
     Trace(#[from] TraceError),
     #[cfg(feature = "metrics")]
     #[cfg_attr(docsrs, doc(cfg(feature = "metrics")))]
     #[error(transparent)]
+    /// An issue raised by the metrics module.
     Metric(#[from] MetricsError),
     #[error("{0}")]
+    /// Other types of failures not covered by the variants above.
     Other(String),
 }
 

diff --git a/opentelemetry/src/global/mod.rs b/opentelemetry/src/global/mod.rs
@@ -144,7 +144,7 @@ mod propagation;
 #[cfg(feature = "trace")]
 mod trace;
 
-pub use error_handler::{handle_error, set_error_handler};
+pub use error_handler::{handle_error, set_error_handler, Error};
 #[cfg(feature = "metrics")]
 #[cfg_attr(docsrs, doc(cfg(feature = "metrics")))]
 pub use metrics::{