Remove duplicate InstrumentationScope/Scope re-exports in SDK

Author: stormshield-fabs

opentelemetry-proto/src/transform/common.rs

@@ -42,18 +42,8 @@ pub mod tonic {
     #[cfg(any(feature = "trace", feature = "logs"))]
     use opentelemetry_sdk::Resource;
 
-    impl
-        From<(
-            opentelemetry_sdk::InstrumentationScope,
-            Option<Cow<'static, str>>,
-        )> for InstrumentationScope
-    {
-        fn from(
-            data: (
-                opentelemetry_sdk::InstrumentationScope,
-                Option<Cow<'static, str>>,
-            ),
-        ) -> Self {
+    impl From<(opentelemetry_sdk::Scope, Option<Cow<'static, str>>)> for InstrumentationScope {
+        fn from(data: (opentelemetry_sdk::Scope, Option<Cow<'static, str>>)) -> Self {
             let (library, target) = data;
             if let Some(t) = target {
                 InstrumentationScope {
@@ -73,18 +63,8 @@ pub mod tonic {
         }
     }
 
-    impl
-        From<(
-            &opentelemetry_sdk::InstrumentationScope,
-            Option<Cow<'static, str>>,
-        )> for InstrumentationScope
-    {
-        fn from(
-            data: (
-                &opentelemetry_sdk::InstrumentationScope,
-                Option<Cow<'static, str>>,
-            ),
-        ) -> Self {
+    impl From<(&opentelemetry_sdk::Scope, Option<Cow<'static, str>>)> for InstrumentationScope {
+        fn from(data: (&opentelemetry_sdk::Scope, Option<Cow<'static, str>>)) -> Self {
             let (library, target) = data;
             if let Some(t) = target {
                 InstrumentationScope {

opentelemetry-proto/src/transform/trace.rs

@@ -158,8 +158,7 @@ pub mod tonic {
         // Group spans by their instrumentation library
         let scope_map = spans.iter().fold(
             HashMap::new(),
-            |mut scope_map: HashMap<&opentelemetry_sdk::InstrumentationScope, Vec<&SpanData>>,
-             span| {
+            |mut scope_map: HashMap<&opentelemetry_sdk::Scope, Vec<&SpanData>>, span| {
                 let instrumentation = &span.instrumentation_scope;
                 scope_map.entry(instrumentation).or_default().push(span);
                 scope_map
@@ -202,7 +201,7 @@ mod tests {
     use opentelemetry_sdk::export::trace::SpanData;
     use opentelemetry_sdk::resource::Resource;
     use opentelemetry_sdk::trace::{SpanEvents, SpanLinks};
-    use opentelemetry_sdk::InstrumentationScope;
+    use opentelemetry_sdk::Scope;
     use std::borrow::Cow;
     use std::time::{Duration, SystemTime};
 
@@ -227,7 +226,7 @@ mod tests {
             events: SpanEvents::default(),
             links: SpanLinks::default(),
             status: Status::Unset,
-            instrumentation_scope: InstrumentationScope::builder(instrumentation_name).build(),
+            instrumentation_scope: Scope::builder(instrumentation_name).build(),
         }
     }
 

opentelemetry-sdk/benches/log.rs

@@ -25,16 +25,17 @@ use opentelemetry::logs::{
 };
 use opentelemetry::trace::Tracer;
 use opentelemetry::trace::TracerProvider as _;
-use opentelemetry::{InstrumentationScope, Key};
+use opentelemetry::Key;
 use opentelemetry_sdk::logs::{LogProcessor, LogRecord, Logger, LoggerProvider};
 use opentelemetry_sdk::trace;
 use opentelemetry_sdk::trace::{Sampler, TracerProvider};
+use opentelemetry_sdk::Scope;
 
 #[derive(Debug)]
 struct NoopProcessor;
 
 impl LogProcessor for NoopProcessor {
-    fn emit(&self, _data: &mut LogRecord, _scope: &InstrumentationScope) {}
+    fn emit(&self, _data: &mut LogRecord, _scope: &Scope) {}
 
     fn force_flush(&self) -> LogResult<()> {
         Ok(())

opentelemetry-sdk/benches/log_exporter.rs

@@ -18,11 +18,11 @@ use criterion::{criterion_group, criterion_main, Criterion};
 
 use opentelemetry::logs::{LogRecord as _, LogResult, Logger as _, LoggerProvider as _, Severity};
 
-use opentelemetry::InstrumentationScope;
 use opentelemetry_sdk::export::logs::LogBatch;
 use opentelemetry_sdk::logs::LogProcessor;
 use opentelemetry_sdk::logs::LogRecord;
 use opentelemetry_sdk::logs::LoggerProvider;
+use opentelemetry_sdk::Scope;
 use pprof::criterion::{Output, PProfProfiler};
 use std::fmt::Debug;
 
@@ -65,7 +65,7 @@ impl ExportingProcessorWithFuture {
 }
 
 impl LogProcessor for ExportingProcessorWithFuture {
-    fn emit(&self, record: &mut LogRecord, scope: &InstrumentationScope) {
+    fn emit(&self, record: &mut LogRecord, scope: &Scope) {
         let mut exporter = self.exporter.lock().expect("lock error");
         let logs = [(record as &LogRecord, scope)];
         futures_executor::block_on(exporter.export(LogBatch::new(&logs)));
@@ -94,7 +94,7 @@ impl ExportingProcessorWithoutFuture {
 }
 
 impl LogProcessor for ExportingProcessorWithoutFuture {
-    fn emit(&self, record: &mut LogRecord, scope: &InstrumentationScope) {
+    fn emit(&self, record: &mut LogRecord, scope: &Scope) {
         let logs = [(record as &LogRecord, scope)];
         self.exporter
             .lock()

opentelemetry-sdk/benches/log_processor.rs

@@ -19,8 +19,8 @@ use std::{
 
 use criterion::{criterion_group, criterion_main, Criterion};
 use opentelemetry::logs::{LogRecord as _, LogResult, Logger as _, LoggerProvider as _, Severity};
-use opentelemetry::InstrumentationScope;
 use opentelemetry_sdk::logs::{LogProcessor, LogRecord, Logger, LoggerProvider};
+use opentelemetry_sdk::Scope;
 
 // Run this benchmark with:
 // cargo bench --bench log_processor
@@ -43,7 +43,7 @@ fn create_log_record(logger: &Logger) -> LogRecord {
 struct NoopProcessor;
 
 impl LogProcessor for NoopProcessor {
-    fn emit(&self, _data: &mut LogRecord, _scope: &InstrumentationScope) {}
+    fn emit(&self, _data: &mut LogRecord, _scope: &Scope) {}
 
     fn force_flush(&self) -> LogResult<()> {
         Ok(())
@@ -58,7 +58,7 @@ impl LogProcessor for NoopProcessor {
 struct CloningProcessor;
 
 impl LogProcessor for CloningProcessor {
-    fn emit(&self, data: &mut LogRecord, _scope: &InstrumentationScope) {
+    fn emit(&self, data: &mut LogRecord, _scope: &Scope) {
         let _data_cloned = data.clone();
     }
 
@@ -73,8 +73,8 @@ impl LogProcessor for CloningProcessor {
 
 #[derive(Debug)]
 struct SendToChannelProcessor {
-    sender: std::sync::mpsc::Sender<(LogRecord, InstrumentationScope)>,
-    receiver: Arc<Mutex<std::sync::mpsc::Receiver<(LogRecord, InstrumentationScope)>>>,
+    sender: std::sync::mpsc::Sender<(LogRecord, Scope)>,
+    receiver: Arc<Mutex<std::sync::mpsc::Receiver<(LogRecord, Scope)>>>,
 }
 
 impl SendToChannelProcessor {
@@ -101,7 +101,7 @@ impl SendToChannelProcessor {
 }
 
 impl LogProcessor for SendToChannelProcessor {
-    fn emit(&self, record: &mut LogRecord, scope: &InstrumentationScope) {
+    fn emit(&self, record: &mut LogRecord, scope: &Scope) {
         let res = self.sender.send((record.clone(), scope.clone()));
         if res.is_err() {
             println!("Error sending log data to channel {0}", res.err().unwrap());

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

@@ -1,13 +1,11 @@
 //! Log exporters
 use crate::logs::LogRecord;
 use crate::Resource;
+use crate::Scope;
 use async_trait::async_trait;
 #[cfg(feature = "logs_level_enabled")]
 use opentelemetry::logs::Severity;
-use opentelemetry::{
-    logs::{LogError, LogResult},
-    InstrumentationScope,
-};
+use opentelemetry::logs::{LogError, LogResult};
 use std::fmt::Debug;
 
 /// A batch of log records to be exported by a `LogExporter`.
@@ -22,8 +20,8 @@ use std::fmt::Debug;
 #[derive(Debug)]
 pub struct LogBatch<'a> {
     /// The data field contains a slice of tuples, where each tuple consists of a reference to
-    /// a `LogRecord` and a reference to an `InstrumentationScope`.
-    data: &'a [(&'a LogRecord, &'a InstrumentationScope)],
+    /// a `LogRecord` and a reference to an `Scope`.
+    data: &'a [(&'a LogRecord, &'a Scope)],
 }
 
 impl<'a> LogBatch<'a> {
@@ -32,7 +30,7 @@ impl<'a> LogBatch<'a> {
     /// # Arguments
     ///
     /// * `data` - A slice of tuples, where each tuple consists of a reference to a `LogRecord`
-    ///   and a reference to an `InstrumentationScope`. These tuples represent the log records
+    ///   and a reference to an `Scope`. These tuples represent the log records
     ///   and their associated instrumentation libraries to be exported.
     ///
     /// # Returns
@@ -42,7 +40,7 @@ impl<'a> LogBatch<'a> {
     /// Note - this is not a public function, and should not be used directly. This would be
     /// made private in the future.
 
-    pub fn new(data: &'a [(&'a LogRecord, &'a InstrumentationScope)]) -> LogBatch<'a> {
+    pub fn new(data: &'a [(&'a LogRecord, &'a Scope)]) -> LogBatch<'a> {
         LogBatch { data }
     }
 }
@@ -51,13 +49,13 @@ impl LogBatch<'_> {
     /// Returns an iterator over the log records and instrumentation libraries in the batch.
     ///
     /// Each item yielded by the iterator is a tuple containing references to a `LogRecord`
-    /// and an `InstrumentationScope`.
+    /// and an `Scope`.
     ///
     /// # Returns
     ///
-    /// An iterator that yields references to the `LogRecord` and `InstrumentationScope` in the batch.
+    /// An iterator that yields references to the `LogRecord` and `Scope` in the batch.
     ///
-    pub fn iter(&self) -> impl Iterator<Item = (&LogRecord, &InstrumentationScope)> {
+    pub fn iter(&self) -> impl Iterator<Item = (&LogRecord, &Scope)> {
         self.data
             .iter()
             .map(|(record, library)| (*record, *library))

opentelemetry-sdk/src/export/trace.rs

@@ -96,5 +96,5 @@ pub struct SpanData {
     /// Span status
     pub status: Status,
     /// Instrumentation library that produced this span
-    pub instrumentation_scope: crate::InstrumentationScope,
+    pub instrumentation_scope: crate::Scope,
 }

opentelemetry-sdk/src/instrumentation.rs

@@ -122,7 +122,7 @@
 
 pub mod export;
 pub(crate) mod growable_array;
-mod instrumentation;
+
 #[cfg(feature = "logs")]
 #[cfg_attr(docsrs, doc(cfg(feature = "logs")))]
 pub mod logs;
@@ -146,6 +146,7 @@ pub mod trace;
 #[doc(hidden)]
 pub mod util;
 
-pub use instrumentation::{InstrumentationScope, Scope};
+#[doc(inline)]
+pub use opentelemetry::InstrumentationScope as Scope;
 #[doc(inline)]
 pub use resource::Resource;

opentelemetry-sdk/src/lib.rs

@@ -1,10 +1,10 @@
 use super::{BatchLogProcessor, LogProcessor, LogRecord, SimpleLogProcessor, TraceContext};
-use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource};
+use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource, Scope};
 use opentelemetry::{
     logs::{LogError, LogResult},
     otel_debug,
     trace::TraceContextExt,
-    Context, InstrumentationScope,
+    Context,
 };
 
 #[cfg(feature = "logs_level_enabled")]
@@ -48,7 +48,7 @@ pub struct LoggerProvider {
 impl opentelemetry::logs::LoggerProvider for LoggerProvider {
     type Logger = Logger;
 
-    fn logger_with_scope(&self, scope: InstrumentationScope) -> Self::Logger {
+    fn logger_with_scope(&self, scope: Scope) -> Self::Logger {
         // If the provider is shutdown, new logger will refer a no-op logger provider.
         if self.inner.is_shutdown.load(Ordering::Relaxed) {
             return Logger::new(scope, NOOP_LOGGER_PROVIDER.clone());
@@ -217,12 +217,12 @@ impl Builder {
 ///
 /// [`LogRecord`]: opentelemetry::logs::LogRecord
 pub struct Logger {
-    scope: InstrumentationScope,
+    scope: Scope,
     provider: LoggerProvider,
 }
 
 impl Logger {
-    pub(crate) fn new(scope: InstrumentationScope, provider: LoggerProvider) -> Self {
+    pub(crate) fn new(scope: Scope, provider: LoggerProvider) -> Self {
         Logger { scope, provider }
     }
 
@@ -232,7 +232,7 @@ impl Logger {
     }
 
     /// Instrumentation library information of this logger.
-    pub fn instrumentation_scope(&self) -> &InstrumentationScope {
+    pub fn instrumentation_scope(&self) -> &Scope {
         &self.scope
     }
 }
@@ -327,7 +327,7 @@ mod tests {
     }
 
     impl LogProcessor for ShutdownTestLogProcessor {
-        fn emit(&self, _data: &mut LogRecord, _scope: &InstrumentationScope) {
+        fn emit(&self, _data: &mut LogRecord, _scope: &Scope) {
             self.is_shutdown
                 .lock()
                 .map(|is_shutdown| {
@@ -706,7 +706,7 @@ mod tests {
     }
 
     impl LogProcessor for LazyLogProcessor {
-        fn emit(&self, _data: &mut LogRecord, _scope: &InstrumentationScope) {
+        fn emit(&self, _data: &mut LogRecord, _scope: &Scope) {
             // nothing to do.
         }
 
@@ -737,7 +737,7 @@ mod tests {
     }
 
     impl LogProcessor for CountingShutdownProcessor {
-        fn emit(&self, _data: &mut LogRecord, _scope: &InstrumentationScope) {
+        fn emit(&self, _data: &mut LogRecord, _scope: &Scope) {
             // nothing to do
         }