Make a common Error enum for export shutdown and flush operations

Author: cijothomas

examples/metrics-basic/src/main.rs

@@ -1,5 +1,5 @@
 use opentelemetry::{global, KeyValue};
-use opentelemetry_sdk::error::ShutdownError;
+use opentelemetry_sdk::error::OTelSdkError;
 use opentelemetry_sdk::metrics::{PeriodicReader, SdkMeterProvider};
 use opentelemetry_sdk::Resource;
 use std::error::Error;

opentelemetry-otlp/src/exporter/http/metrics.rs

@@ -3,7 +3,7 @@ use std::sync::Arc;
 use async_trait::async_trait;
 use http::{header::CONTENT_TYPE, Method};
 use opentelemetry::otel_debug;
-use opentelemetry_sdk::error::{ShutdownError, ShutdownResult};
+use opentelemetry_sdk::error::{OTelSdkError, ShutdownResult};
 use opentelemetry_sdk::metrics::data::ResourceMetrics;
 use opentelemetry_sdk::metrics::{MetricError, MetricResult};
 
@@ -47,7 +47,7 @@ impl MetricsClient for OtlpHttpClient {
     fn shutdown(&self) -> ShutdownResult {
         self.client
             .lock()
-            .map_err(|e| ShutdownError::InternalFailure(format!("Failed to acquire lock: {}", e)))?
+            .map_err(|e| OTelSdkError::InternalFailure(format!("Failed to acquire lock: {}", e)))?
             .take();
 
         Ok(())

opentelemetry-otlp/src/exporter/tonic/metrics.rs

@@ -6,7 +6,7 @@ use opentelemetry::otel_debug;
 use opentelemetry_proto::tonic::collector::metrics::v1::{
     metrics_service_client::MetricsServiceClient, ExportMetricsServiceRequest,
 };
-use opentelemetry_sdk::error::{ShutdownError, ShutdownResult};
+use opentelemetry_sdk::error::{OTelSdkError, ShutdownResult};
 use opentelemetry_sdk::metrics::data::ResourceMetrics;
 use opentelemetry_sdk::metrics::{MetricError, MetricResult};
 use tonic::{codegen::CompressionEncoding, service::Interceptor, transport::Channel, Request};
@@ -93,7 +93,7 @@ impl MetricsClient for TonicMetricsClient {
     fn shutdown(&self) -> ShutdownResult {
         self.inner
             .lock()
-            .map_err(|e| ShutdownError::InternalFailure(format!("Failed to acquire lock: {}", e)))?
+            .map_err(|e| OTelSdkError::InternalFailure(format!("Failed to acquire lock: {}", e)))?
             .take();
 
         Ok(())

opentelemetry-sdk/src/error.rs

@@ -11,8 +11,8 @@ pub trait ExportError: std::error::Error + Send + Sync + 'static {
 }
 
 #[derive(Error, Debug)]
-/// Errors that can occur during shutdown.
-pub enum ShutdownError {
+/// Errors that can occur during SDK operations export(), force_flush() and shutdown().
+pub enum OTelSdkError {
     /// Shutdown has already been invoked.
     ///
     /// While shutdown is idempotent and calling it multiple times has no
@@ -42,4 +42,4 @@ pub enum ShutdownError {
 }
 
 /// A specialized `Result` type for Shutdown operations.
-pub type ShutdownResult = Result<(), ShutdownError>;
+pub type ShutdownResult = Result<(), OTelSdkError>;

opentelemetry-sdk/src/metrics/manual_reader.rs

@@ -6,7 +6,7 @@ use std::{
 use opentelemetry::otel_debug;
 
 use crate::{
-    error::{ShutdownError, ShutdownResult},
+    error::{OTelSdkError, ShutdownResult},
     metrics::{MetricError, MetricResult, Temporality},
 };
 
@@ -112,7 +112,7 @@ impl MetricReader for ManualReader {
     /// Closes any connections and frees any resources used by the reader.
     fn shutdown(&self) -> ShutdownResult {
         let mut inner = self.inner.lock().map_err(|e| {
-            ShutdownError::InternalFailure(format!("Failed to acquire lock: {}", e))
+            OTelSdkError::InternalFailure(format!("Failed to acquire lock: {}", e))
         })?;
 
         // Any future call to collect will now return an error.

opentelemetry-sdk/src/metrics/meter_provider.rs

@@ -141,7 +141,7 @@ impl SdkMeterProviderInner {
             .swap(true, std::sync::atomic::Ordering::SeqCst)
         {
             // If the previous value was true, shutdown was already invoked.
-            Err(crate::error::ShutdownError::AlreadyShutdown)
+            Err(crate::error::OTelSdkError::AlreadyShutdown)
         } else {
             self.pipes.shutdown()
         }

opentelemetry-sdk/src/metrics/periodic_reader.rs

@@ -11,7 +11,7 @@ use std::{
 use opentelemetry::{otel_debug, otel_error, otel_info, otel_warn};
 
 use crate::{
-    error::{ShutdownError, ShutdownResult},
+    error::{OTelSdkError, ShutdownResult},
     metrics::{exporter::PushMetricExporter, reader::SdkProducer, MetricError, MetricResult},
     Resource,
 };
@@ -479,22 +479,22 @@ impl PeriodicReaderInner {
         let (response_tx, response_rx) = mpsc::channel();
         self.message_sender
             .send(Message::Shutdown(response_tx))
-            .map_err(|e| ShutdownError::InternalFailure(e.to_string()))?;
+            .map_err(|e| OTelSdkError::InternalFailure(e.to_string()))?;
 
         // TODO: Make this timeout configurable.
         match response_rx.recv_timeout(Duration::from_secs(5)) {
             Ok(response) => {
                 if response {
                     Ok(())
                 } else {
-                    Err(ShutdownError::InternalFailure("Failed to shutdown".into()))
+                    Err(OTelSdkError::InternalFailure("Failed to shutdown".into()))
                 }
             }
             Err(mpsc::RecvTimeoutError::Timeout) => {
-                Err(ShutdownError::Timeout(Duration::from_secs(5)))
+                Err(OTelSdkError::Timeout(Duration::from_secs(5)))
             }
             Err(mpsc::RecvTimeoutError::Disconnected) => {
-                Err(ShutdownError::InternalFailure("Failed to shutdown".into()))
+                Err(OTelSdkError::InternalFailure("Failed to shutdown".into()))
             }
         }
     }
@@ -543,7 +543,7 @@ impl MetricReader for PeriodicReader {
 mod tests {
     use super::PeriodicReader;
     use crate::{
-        error::{ShutdownError, ShutdownResult},
+        error::{OTelSdkError, ShutdownResult},
         metrics::{
             data::ResourceMetrics, exporter::PushMetricExporter, reader::MetricReader,
             InMemoryMetricExporter, MetricError, MetricResult, SdkMeterProvider, Temporality,
@@ -675,12 +675,12 @@ mod tests {
         // calling shutdown again should return Err
         let result = meter_provider.shutdown();
         assert!(result.is_err());
-        assert!(matches!(result, Err(ShutdownError::AlreadyShutdown)));
+        assert!(matches!(result, Err(OTelSdkError::AlreadyShutdown)));
 
         // calling shutdown again should return Err
         let result = meter_provider.shutdown();
         assert!(result.is_err());
-        assert!(matches!(result, Err(ShutdownError::AlreadyShutdown)));
+        assert!(matches!(result, Err(OTelSdkError::AlreadyShutdown)));
     }
 
     #[test]

opentelemetry-sdk/src/metrics/pipeline.rs

@@ -661,7 +661,7 @@ impl Pipelines {
         if errs.is_empty() {
             Ok(())
         } else {
-            Err(crate::error::ShutdownError::InternalFailure(format!(
+            Err(crate::error::OTelSdkError::InternalFailure(format!(
                 "{errs:?}"
             )))
         }

opentelemetry-sdk/src/testing/metrics/metric_reader.rs

@@ -1,6 +1,6 @@
 use std::sync::{Arc, Mutex, Weak};
 
-use crate::error::{ShutdownError, ShutdownResult};
+use crate::error::{OTelSdkError, ShutdownResult};
 use crate::metrics::{
     data::ResourceMetrics, pipeline::Pipeline, reader::MetricReader, InstrumentKind,
 };
@@ -48,7 +48,7 @@ impl MetricReader for TestMetricReader {
             let mut is_shutdown = self.is_shutdown.lock().unwrap();
             *is_shutdown = true;
         }
-        result.map_err(|e| ShutdownError::InternalFailure(e.to_string()))
+        result.map_err(|e| OTelSdkError::InternalFailure(e.to_string()))
     }
 
     fn temporality(&self, _kind: InstrumentKind) -> Temporality {