Logs API/SDK - few perf improvements (#1134)

* initial commit

* fix unit test

* fix doctest

* fix doctest

Author: lalitb

opentelemetry-api/src/global/logs.rs

@@ -8,7 +8,7 @@ use once_cell::sync::Lazy;
 
 use crate::{
     logs::{Logger, LoggerProvider, NoopLoggerProvider},
-    KeyValue,
+    InstrumentationLibrary,
 };
 
 /// Allows a specific [`LoggerProvider`] to be used generically, by mirroring
@@ -21,12 +21,9 @@ pub trait ObjectSafeLoggerProvider {
     ///
     /// [`Logger`]: crate::logs::Logger
     /// [`LoggerProvider`]: crate::logs::LoggerProvider
-    fn versioned_logger_boxed(
+    fn boxed_logger(
         &self,
-        name: Cow<'static, str>,
-        version: Option<Cow<'static, str>>,
-        schema_url: Option<Cow<'static, str>>,
-        attributes: Option<Vec<KeyValue>>,
+        library: Arc<InstrumentationLibrary>,
         include_trace_context: bool,
     ) -> Box<dyn Logger + Send + Sync + 'static>;
 }
@@ -36,21 +33,12 @@ where
     L: Logger + Send + Sync + 'static,
     P: LoggerProvider<Logger = L>,
 {
-    fn versioned_logger_boxed(
+    fn boxed_logger(
         &self,
-        name: Cow<'static, str>,
-        version: Option<Cow<'static, str>>,
-        schema_url: Option<Cow<'static, str>>,
-        attributes: Option<Vec<KeyValue>>,
+        library: Arc<InstrumentationLibrary>,
         include_trace_context: bool,
     ) -> Box<dyn Logger + Send + Sync + 'static> {
-        Box::new(self.versioned_logger(
-            name,
-            version,
-            schema_url,
-            attributes,
-            include_trace_context,
-        ))
+        Box::new(self.library_logger(library, include_trace_context))
     }
 }
 
@@ -96,21 +84,12 @@ impl GlobalLoggerProvider {
 impl LoggerProvider for GlobalLoggerProvider {
     type Logger = BoxedLogger;
 
-    fn versioned_logger(
+    fn library_logger(
         &self,
-        name: impl Into<Cow<'static, str>>,
-        version: Option<Cow<'static, str>>,
-        schema_url: Option<Cow<'static, str>>,
-        attributes: Option<Vec<KeyValue>>,
+        library: Arc<InstrumentationLibrary>,
         include_trace_context: bool,
     ) -> Self::Logger {
-        BoxedLogger(self.provider.versioned_logger_boxed(
-            name.into(),
-            version,
-            schema_url,
-            attributes,
-            include_trace_context,
-        ))
+        BoxedLogger(self.provider.boxed_logger(library, include_trace_context))
     }
 }
 

opentelemetry-api/src/logs/logger.rs

@@ -1,6 +1,6 @@
-use std::borrow::Cow;
+use std::{borrow::Cow, sync::Arc};
 
-use crate::{logs::LogRecord, KeyValue};
+use crate::{logs::LogRecord, InstrumentationLibrary, KeyValue};
 
 /// The interface for emitting [`LogRecord`]s.
 pub trait Logger {
@@ -39,6 +39,39 @@ pub trait LoggerProvider {
         schema_url: Option<Cow<'static, str>>,
         attributes: Option<Vec<KeyValue>>,
         include_trace_context: bool,
+    ) -> Self::Logger {
+        self.library_logger(
+            Arc::new(InstrumentationLibrary::new(
+                name, version, schema_url, attributes,
+            )),
+            include_trace_context,
+        )
+    }
+
+    /// Returns a new versioned logger with the given instrumentation library.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use opentelemetry_api::{global, InstrumentationLibrary, logs::LoggerProvider};
+    ///
+    /// let provider = global::logger_provider();
+    ///
+    /// // logger used in applications/binaries
+    /// let logger = provider.logger("my_app");
+    /// // logger used in libraries/crates that optionally includes version and schema url
+    /// let library = std::sync::Arc::new(InstrumentationLibrary::new(
+    ///     env!("CARGO_PKG_NAME"),
+    ///     Some(env!("CARGO_PKG_VERSION")),
+    ///     Some("https://opentelemetry.io/schema/1.0.0"),
+    ///     None,
+    /// ));
+    /// let logger = provider.library_logger(library, true);
+    /// ```
+    fn library_logger(
+        &self,
+        library: Arc<InstrumentationLibrary>,
+        include_trace_context: bool,
     ) -> Self::Logger;
 
     /// Returns a new logger with the given name.

opentelemetry-api/src/logs/noop.rs

@@ -1,8 +1,8 @@
-use std::borrow::Cow;
+use std::{borrow::Cow, sync::Arc};
 
 use crate::{
     logs::{LogRecord, Logger, LoggerProvider},
-    KeyValue,
+    InstrumentationLibrary, KeyValue,
 };
 
 /// A no-op implementation of a [`LoggerProvider`].
@@ -19,6 +19,14 @@ impl NoopLoggerProvider {
 impl LoggerProvider for NoopLoggerProvider {
     type Logger = NoopLogger;
 
+    fn library_logger(
+        &self,
+        _library: Arc<InstrumentationLibrary>,
+        _include_trace_context: bool,
+    ) -> Self::Logger {
+        NoopLogger(())
+    }
+
     fn versioned_logger(
         &self,
         _name: impl Into<Cow<'static, str>>,

opentelemetry-sdk/src/logs/log_emitter.rs

@@ -43,12 +43,24 @@ impl opentelemetry_api::logs::LoggerProvider for LoggerProvider {
             name
         };
 
-        Logger::new(
-            InstrumentationLibrary::new(component_name, version, schema_url, attributes),
-            Arc::downgrade(&self.inner),
+        self.library_logger(
+            Arc::new(InstrumentationLibrary::new(
+                component_name,
+                version,
+                schema_url,
+                attributes,
+            )),
             include_trace_context,
         )
     }
+
+    fn library_logger(
+        &self,
+        library: Arc<InstrumentationLibrary>,
+        include_trace_context: bool,
+    ) -> Self::Logger {
+        Logger::new(library, Arc::downgrade(&self.inner), include_trace_context)
+    }
 }
 
 impl LoggerProvider {
@@ -171,13 +183,13 @@ impl Builder {
 /// [`LogRecord`]: opentelemetry_api::logs::LogRecord
 pub struct Logger {
     include_trace_context: bool,
-    instrumentation_lib: InstrumentationLibrary,
+    instrumentation_lib: Arc<InstrumentationLibrary>,
     provider: Weak<LoggerProviderInner>,
 }
 
 impl Logger {
     pub(crate) fn new(
-        instrumentation_lib: InstrumentationLibrary,
+        instrumentation_lib: Arc<InstrumentationLibrary>,
         provider: Weak<LoggerProviderInner>,
         include_trace_context: bool,
     ) -> Self {
@@ -223,7 +235,7 @@ impl opentelemetry_api::logs::Logger for Logger {
             let data = LogData {
                 record,
                 resource: config.resource.clone(),
-                instrumentation: self.instrumentation_lib.clone(),
+                instrumentation: self.instrumentation_library().clone(),
             };
             processor.emit(data);
         }