nits

Author: cijothomas

examples/metrics-basic/src/main.rs

@@ -1,4 +1,5 @@
 use opentelemetry::{global, KeyValue};
+use opentelemetry_sdk::error::ShutdownError;
 use opentelemetry_sdk::metrics::{PeriodicReader, SdkMeterProvider};
 use opentelemetry_sdk::Resource;
 use std::error::Error;
@@ -23,7 +24,7 @@ fn init_meter_provider() -> opentelemetry_sdk::metrics::SdkMeterProvider {
 }
 
 #[tokio::main]
-async fn main() {
+async fn main() -> Result<(), Box<dyn Error>> {
     // Initialize the MeterProvider with the stdout Exporter.
     let meter_provider = init_meter_provider();
 
@@ -137,35 +138,41 @@ async fn main() {
         })
         .build();
 
-    // Metrics are exported by default every 30 seconds when using stdout exporter,
-    // however shutting down the MeterProvider here instantly flushes
-    // the metrics, instead of waiting for the 30 sec interval.
-    let shutdown_result = meter_provider.shutdown();
-
-    // Demonstrate handling the shutdown result.
-    match shutdown_result {
-        Ok(_) => println!("MeterProvider shutdown successfully"),
-        Err(e) => {
-            match e {
-                opentelemetry_sdk::error::ShutdownError::InternalFailure(e) => {
-                    // This indicates some failure during shutdown.
-                    // Not much to do here, but log the error.
-                    // So users at least know something went wrong,
-                    // and possibly explain why some metrics were not exported.
-                    println!("MeterProvider shutdown failed: {}", e)
-                }
-                opentelemetry_sdk::error::ShutdownError::AlreadyShutdown => {
-                    // This indicates some user code tried to shutdown elsewhere.
-                    // user need to review their code to ensure shutdown is called only once.
-                    println!("MeterProvider already shutdown")
-                }
-                opentelemetry_sdk::error::ShutdownError::Timeout(e) => {
-                    // This indicates the shutdown timed out, and a good
-                    // hint to user to increase the timeout or even retry.
-                    // (Shutdown method does not allow custom timeout today, but that is temporary)
-                    println!("MeterProvider shutdown timed out after {:?}", e)
-                }
-            }
-        }
-    }
+    // Metrics are exported by default every 30 seconds when using stdout
+    // exporter, however shutting down the MeterProvider here instantly flushes
+    // the metrics, instead of waiting for the 30 sec interval. Shutdown returns
+    // a result, which is bubbled up to the caller The commented code below
+    // demonstrates handling the shutdown result, instead of bubbling up the
+    // error.
+    meter_provider.shutdown()?;
+
+    // let shutdown_result = meter_provider.shutdown();
+
+    // Handle the shutdown result.
+    // match shutdown_result {
+    //     Ok(_) => println!("MeterProvider shutdown successfully"),
+    //     Err(e) => {
+    //         match e {
+    //             opentelemetry_sdk::error::ShutdownError::InternalFailure(message) => {
+    //                 // This indicates some internal failure during shutdown. The
+    //                 // error message is intended for logging purposes only and
+    //                 // should not be used to make programmatic decisions.
+    //                 println!("MeterProvider shutdown failed: {}", message)
+    //             }
+    //             opentelemetry_sdk::error::ShutdownError::AlreadyShutdown => {
+    //                 // This indicates some user code tried to shutdown
+    //                 // elsewhere. user need to review their code to ensure
+    //                 // shutdown is called only once.
+    //                 println!("MeterProvider already shutdown")
+    //             }
+    //             opentelemetry_sdk::error::ShutdownError::Timeout(e) => {
+    //                 // This indicates the shutdown timed out, and a good hint to
+    //                 // user to increase the timeout. (Shutdown method does not
+    //                 // allow custom timeout today, but that is temporary)
+    //                 println!("MeterProvider shutdown timed out after {:?}", e)
+    //             }
+    //         }
+    //     }
+    // }
+    Ok(())
 }

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

@@ -47,12 +47,7 @@ impl MetricsClient for OtlpHttpClient {
     fn shutdown(&self) -> ShutdownResult {
         self.client
             .lock()
-            .map_err(|e| {
-                ShutdownError::InternalFailure(format!(
-                    "Internal Error. Failed to acquire lock: {}",
-                    e
-                ))
-            })?
+            .map_err(|e| ShutdownError::InternalFailure(format!("Failed to acquire lock: {}", e)))?
             .take();
 
         Ok(())

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

@@ -93,12 +93,7 @@ impl MetricsClient for TonicMetricsClient {
     fn shutdown(&self) -> ShutdownResult {
         self.inner
             .lock()
-            .map_err(|e| {
-                ShutdownError::InternalFailure(format!(
-                    "Internal Error. Failed to acquire lock: {}",
-                    e
-                ))
-            })?
+            .map_err(|e| ShutdownError::InternalFailure(format!("Failed to acquire lock: {}", e)))?
             .take();
 
         Ok(())

opentelemetry-sdk/src/metrics/manual_reader.rs

@@ -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!("Internal Error. Failed to acquire lock: {}", e))
+            ShutdownError::InternalFailure(format!("Failed to acquire lock: {}", e))
         })?;
 
         // Any future call to collect will now return an error.