avoid reexport old periodicreader asis but now under different module

Author: cijothomas

opentelemetry-otlp/examples/basic-otlp-http/Cargo.toml

@@ -9,6 +9,7 @@ publish = false
 default = ["reqwest"]
 reqwest = ["opentelemetry-otlp/reqwest-client"]
 hyper = ["opentelemetry-otlp/hyper-client"]
+experimental_metrics_periodicreader_with_async_runtime = ["opentelemetry_sdk/experimental_metrics_periodicreader_with_async_runtime"]
 
 
 [dependencies]

opentelemetry-otlp/examples/basic-otlp-http/src/main.rs

@@ -63,8 +63,13 @@ fn init_metrics() -> Result<opentelemetry_sdk::metrics::SdkMeterProvider, Metric
         .with_endpoint("http://localhost:4318/v1/metrics")
         .build()?;
 
+    #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
+    let reader = opentelemetry_sdk::metrics::periodic_reader_with_async_runtime::PeriodicReader::builder(exporter, runtime::Tokio).build();
+    #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
+    let reader = PeriodicReader::builder(exporter).build();
+
     Ok(SdkMeterProvider::builder()
-        .with_reader(PeriodicReader::builder(exporter, runtime::Tokio).build())
+        .with_reader(reader)
         .with_resource(RESOURCE.clone())
         .build())
 }

opentelemetry-otlp/examples/basic-otlp/Cargo.toml

@@ -5,9 +5,6 @@ edition = "2021"
 license = "Apache-2.0"
 publish = false
 
-[features]
-experimental_metrics_periodicreader_with_async_runtime = ["opentelemetry_sdk/experimental_metrics_periodicreader_with_async_runtime"]
-
 [dependencies]
 once_cell = { workspace = true }
 opentelemetry = { path = "../../../opentelemetry", features = ["metrics", "logs"] }

opentelemetry-otlp/examples/basic-otlp/src/main.rs

@@ -34,10 +34,6 @@ fn init_traces() -> Result<sdktrace::TracerProvider, TraceError> {
 
 fn init_metrics() -> Result<opentelemetry_sdk::metrics::SdkMeterProvider, MetricError> {
     let exporter = MetricExporter::builder().with_tonic().build()?;
-
-    #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-    let reader = PeriodicReader::builder(exporter, runtime::Tokio).build();
-    #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
     let reader = PeriodicReader::builder(exporter).build();
 
     Ok(SdkMeterProvider::builder()

opentelemetry-sdk/CHANGELOG.md

@@ -53,14 +53,21 @@
       ```
 
  2. *Async Runtime Support*
-    If your application cannot spin up new thread or you prefer using async
-    runtimes, enable the "experimental_metrics_periodicreader_with_async_runtime" feature flag.  
+    If your application cannot spin up new threads or you prefer using async
+    runtimes, enable the
+    "experimental_metrics_periodicreader_with_async_runtime" feature flag and
+    adjust code as below.  
 
-    - *Code requires no change*
+    - *Before:*
       ```rust
       let reader = opentelemetry_sdk::metrics::PeriodicReader::builder(exporter, runtime::Tokio).build();
       ```
 
+    - *After:*
+      ```rust
+      let reader = opentelemetry_sdk::metrics::periodic_reader_with_async_runtime::PeriodicReader::builder(exporter, runtime::Tokio).build();
+      ```      
+
     *Requirements:*
     - Enable the feature flag:
       `experimental_metrics_periodicreader_with_async_runtime`.  

opentelemetry-sdk/src/metrics/mod.rs

@@ -49,10 +49,10 @@ pub(crate) mod manual_reader;
 pub(crate) mod meter;
 mod meter_provider;
 pub(crate) mod noop;
-#[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
 pub(crate) mod periodic_reader;
 #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-pub(crate) mod periodic_reader_with_async_runtime;
+/// Module for periodic reader with async runtime.
+pub mod periodic_reader_with_async_runtime;
 pub(crate) mod pipeline;
 pub mod reader;
 pub(crate) mod view;
@@ -61,10 +61,7 @@ pub use aggregation::*;
 pub use error::{MetricError, MetricResult};
 pub use manual_reader::*;
 pub use meter_provider::*;
-#[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
 pub use periodic_reader::*;
-#[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-pub use periodic_reader_with_async_runtime::*;
 pub use pipeline::Pipeline;
 
 pub use instrument::InstrumentKind;
@@ -515,9 +512,6 @@ mod tests {
         }
 
         let exporter = InMemoryMetricExporter::default();
-        #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-        let reader = PeriodicReader::builder(exporter.clone(), runtime::Tokio).build();
-        #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
         let reader = PeriodicReader::builder(exporter.clone()).build();
         let meter_provider = SdkMeterProvider::builder().with_reader(reader).build();
 
@@ -534,9 +528,6 @@ mod tests {
     async fn counter_duplicate_instrument_merge() {
         // Arrange
         let exporter = InMemoryMetricExporter::default();
-        #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-        let reader = PeriodicReader::builder(exporter.clone(), runtime::Tokio).build();
-        #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
         let reader = PeriodicReader::builder(exporter.clone()).build();
         let meter_provider = SdkMeterProvider::builder().with_reader(reader).build();
 
@@ -588,9 +579,6 @@ mod tests {
     async fn counter_duplicate_instrument_different_meter_no_merge() {
         // Arrange
         let exporter = InMemoryMetricExporter::default();
-        #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-        let reader = PeriodicReader::builder(exporter.clone(), runtime::Tokio).build();
-        #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
         let reader = PeriodicReader::builder(exporter.clone()).build();
         let meter_provider = SdkMeterProvider::builder().with_reader(reader).build();
 
@@ -680,9 +668,6 @@ mod tests {
     async fn instrumentation_scope_identity_test() {
         // Arrange
         let exporter = InMemoryMetricExporter::default();
-        #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-        let reader = PeriodicReader::builder(exporter.clone(), runtime::Tokio).build();
-        #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
         let reader = PeriodicReader::builder(exporter.clone()).build();
         let meter_provider = SdkMeterProvider::builder().with_reader(reader).build();
 
@@ -820,9 +805,6 @@ mod tests {
 
         // Arrange
         let exporter = InMemoryMetricExporter::default();
-        #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-        let reader = PeriodicReader::builder(exporter.clone(), runtime::Tokio).build();
-        #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
         let reader = PeriodicReader::builder(exporter.clone()).build();
         let criteria = Instrument::new().name("my_observable_counter");
         // View drops all attributes.
@@ -898,9 +880,6 @@ mod tests {
 
         // Arrange
         let exporter = InMemoryMetricExporter::default();
-        #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-        let reader = PeriodicReader::builder(exporter.clone(), runtime::Tokio).build();
-        #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
         let reader = PeriodicReader::builder(exporter.clone()).build();
         let criteria = Instrument::new().name("my_counter");
         // View drops all attributes.

opentelemetry-stdout/Cargo.toml

@@ -25,7 +25,6 @@ trace = ["opentelemetry/trace", "opentelemetry_sdk/trace", "futures-util"]
 metrics = ["async-trait", "opentelemetry/metrics", "opentelemetry_sdk/metrics"]
 logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/spec_unstable_logs_enabled"]
 populate-logs-event-name = []
-experimental_metrics_periodicreader_with_async_runtime = ["opentelemetry_sdk/experimental_metrics_periodicreader_with_async_runtime", "opentelemetry_sdk/metrics"]
 
 [dependencies]
 async-trait = { workspace = true, optional = true }

opentelemetry-stdout/examples/basic.rs

@@ -9,9 +9,6 @@ use opentelemetry::trace::{Span, Tracer};
 #[cfg(feature = "metrics")]
 use opentelemetry_sdk::metrics::{PeriodicReader, SdkMeterProvider};
 
-#[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-use opentelemetry_sdk::runtime;
-
 #[cfg(feature = "trace")]
 use opentelemetry_sdk::trace::TracerProvider;
 use opentelemetry_sdk::Resource;
@@ -37,9 +34,6 @@ fn init_trace() -> TracerProvider {
 #[cfg(feature = "metrics")]
 fn init_metrics() -> opentelemetry_sdk::metrics::SdkMeterProvider {
     let exporter = opentelemetry_stdout::MetricExporter::default();
-    #[cfg(feature = "experimental_metrics_periodicreader_with_async_runtime")]
-    let reader = PeriodicReader::builder(exporter, runtime::Tokio).build();
-    #[cfg(not(feature = "experimental_metrics_periodicreader_with_async_runtime"))]
     let reader = PeriodicReader::builder(exporter).build();
     let provider = SdkMeterProvider::builder()
         .with_reader(reader)