Try using a builder pattern for all signal providers

Author: izquierdo

opentelemetry-sdk/src/logs/log_emitter.rs

@@ -43,12 +43,18 @@ impl opentelemetry::logs::LoggerProvider for LoggerProvider {
             name
         };
 
-        self.library_logger(Arc::new(InstrumentationLibrary::new(
-            component_name,
-            version,
-            schema_url,
-            attributes,
-        )))
+        let mut builder = InstrumentationLibrary::builder(component_name);
+        if let Some(v) = version {
+            builder = builder.with_version(v);
+        }
+        if let Some(s) = schema_url {
+            builder = builder.with_schema_url(s);
+        }
+        if let Some(a) = attributes {
+            builder = builder.with_attributes(a);
+        }
+
+        self.library_logger(Arc::new(builder.build()))
     }
 
     fn library_logger(&self, library: Arc<InstrumentationLibrary>) -> Self::Logger {

opentelemetry-sdk/src/metrics/meter_provider.rs

@@ -125,7 +125,19 @@ impl MeterProvider for SdkMeterProvider {
             return Meter::new(Arc::new(NoopMeterCore::new()));
         }
 
-        let scope = Scope::new(name, version, schema_url, attributes);
+        let mut builder = Scope::builder(name);
+
+        if let Some(v) = version {
+            builder = builder.with_version(v);
+        }
+        if let Some(s) = schema_url {
+            builder = builder.with_schema_url(s);
+        }
+        if let Some(a) = attributes {
+            builder = builder.with_attributes(a);
+        }
+
+        let scope = builder.build();
 
         if let Ok(mut meters) = self.meters.lock() {
             let meter = meters

opentelemetry-sdk/src/trace/provider.rs

@@ -136,12 +136,19 @@ impl opentelemetry::trace::TracerProvider for TracerProvider {
             name
         };
 
-        self.library_tracer(Arc::new(InstrumentationLibrary::new(
-            component_name,
-            version,
-            schema_url,
-            attributes,
-        )))
+        let mut builder = InstrumentationLibrary::builder(component_name);
+
+        if let Some(v) = version {
+            builder = builder.with_version(v);
+        }
+        if let Some(s) = schema_url {
+            builder = builder.with_schema_url(s);
+        }
+        if let Some(a) = attributes {
+            builder = builder.with_attributes(a);
+        }
+
+        self.library_tracer(Arc::new(builder.build()))
     }
 
     fn library_tracer(&self, library: Arc<InstrumentationLibrary>) -> Self::Tracer {

opentelemetry/src/common.rs

@@ -487,7 +487,10 @@ impl hash::Hash for InstrumentationLibrary {
 }
 
 impl InstrumentationLibrary {
+    /// Deprecated, use [`InstrumentationLibrary::builder()`]
+    ///
     /// Create an new instrumentation library.
+    #[deprecated]
     pub fn new(
         name: impl Into<Cow<'static, str>>,
         version: Option<impl Into<Cow<'static, str>>>,
@@ -501,4 +504,66 @@ impl InstrumentationLibrary {
             attributes: attributes.unwrap_or_default(),
         }
     }
+
+    /// Create a new builder to create an [InstrumentationLibrary]
+    pub fn builder(name: impl Into<Cow<'static, str>>) -> InstrumentationLibraryBuilder {
+        InstrumentationLibraryBuilder::new(name)
+    }
+}
+
+/// Configuration options for [InstrumentationLibrary].
+///
+/// An instrumentation library is a library or crate providing instrumentation.
+/// It should be named to follow any naming conventions of the instrumented
+/// library (e.g. 'middleware' for a web framework).
+///
+/// Apart from the name, all other fields are optional.
+///
+/// See the [instrumentation libraries] spec for more information.
+///
+/// [instrumentation libraries]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.9.0/specification/overview.md#instrumentation-libraries
+#[derive(Debug)]
+pub struct InstrumentationLibraryBuilder {
+    name: Cow<'static, str>,
+
+    version: Option<Cow<'static, str>>,
+
+    schema_url: Option<Cow<'static, str>>,
+
+    attributes: Option<Vec<KeyValue>>,
+}
+
+impl InstrumentationLibraryBuilder {
+    pub fn new(name: impl Into<Cow<'static, str>>) -> Self {
+        InstrumentationLibraryBuilder {
+            name: name.into(),
+            version: None,
+            schema_url: None,
+            attributes: None,
+        }
+    }
+
+    pub fn with_version(mut self, version: impl Into<Cow<'static, str>>) -> Self {
+        self.version = Some(version.into());
+        self
+    }
+
+    pub fn with_schema_url(mut self, schema_url: impl Into<Cow<'static, str>>) -> Self {
+        self.schema_url = Some(schema_url.into());
+        self
+    }
+
+    pub fn with_attributes(mut self, attributes: impl Into<Vec<KeyValue>>) -> Self {
+        self.attributes = Some(attributes.into());
+        self
+    }
+
+    pub fn build(self) -> InstrumentationLibrary {
+        InstrumentationLibrary {
+            name: self.name,
+            version: self.version,
+            schema_url: self.schema_url,
+            attributes: self.attributes.unwrap_or_default(),
+        }
+    }
 }

opentelemetry/src/lib.rs

@@ -222,7 +222,10 @@ mod common;
 #[doc(hidden)]
 pub mod testing;
 
-pub use common::{Array, ExportError, InstrumentationLibrary, Key, KeyValue, StringValue, Value};
+pub use common::{
+    Array, ExportError, InstrumentationLibrary, InstrumentationLibraryBuilder, Key, KeyValue,
+    StringValue, Value,
+};
 
 #[cfg(feature = "metrics")]
 #[cfg_attr(docsrs, doc(cfg(feature = "metrics")))]

opentelemetry/src/logs/logger.rs

@@ -37,9 +37,17 @@ pub trait LoggerProvider {
         schema_url: Option<Cow<'static, str>>,
         attributes: Option<Vec<KeyValue>>,
     ) -> Self::Logger {
-        self.library_logger(Arc::new(InstrumentationLibrary::new(
-            name, version, schema_url, attributes,
-        )))
+        let mut builder = InstrumentationLibrary::builder(name);
+        if let Some(v) = version {
+            builder = builder.with_version(v);
+        }
+        if let Some(s) = schema_url {
+            builder = builder.with_schema_url(s);
+        }
+        if let Some(a) = attributes {
+            builder = builder.with_attributes(a);
+        }
+        self.library_logger(Arc::new(builder.build()))
     }
 
     /// Returns a new versioned logger with the given instrumentation library.

opentelemetry/src/trace/tracer_provider.rs

@@ -1,4 +1,4 @@
-use crate::{trace::Tracer, InstrumentationLibrary, KeyValue};
+use crate::{trace::Tracer, InstrumentationLibrary, InstrumentationLibraryBuilder, KeyValue};
 use std::{borrow::Cow, sync::Arc};
 
 /// Types that can create instances of [`Tracer`].
@@ -76,9 +76,47 @@ pub trait TracerProvider {
         schema_url: Option<impl Into<Cow<'static, str>>>,
         attributes: Option<Vec<KeyValue>>,
     ) -> Self::Tracer {
-        self.library_tracer(Arc::new(InstrumentationLibrary::new(
-            name, version, schema_url, attributes,
-        )))
+        let mut builder = InstrumentationLibrary::builder(name);
+        if let Some(v) = version {
+            builder = builder.with_version(v);
+        }
+        if let Some(s) = schema_url {
+            builder = builder.with_version(s);
+        }
+        if let Some(a) = attributes {
+            builder = builder.with_attributes(a);
+        }
+
+        self.library_tracer(Arc::new(builder.build()))
+    }
+
+    /// Returns a new builder for creating a [`Tracer`] instance
+    ///
+    /// The `name` should be the application name or the name of the library
+    /// providing instrumentation. If the name is empty, then an
+    /// implementation-defined default name may be used instead.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use opentelemetry::{global, trace::TracerProvider};
+    ///
+    /// let provider = global::tracer_provider();
+    ///
+    /// // tracer used in applications/binaries
+    /// let tracer = provider::tracer_builder("my_app").build();
+    ///
+    /// // tracer used in libraries/crates that optionally includes version and schema url
+    /// let tracer = provider::tracer_builder("my_library")
+    ///     .with_version(env!("CARGO_PKG_VERSION"))
+    ///     .with_schema_url("https://opentelemetry.io/schema/1.0.0")
+    ///     .build();
+    /// ```
+    fn tracer_builder(&self, name: impl Into<Cow<'static, str>>) -> TracerBuilder<'_, Self> {
+        TracerBuilder {
+            provider: self,
+            library_builder: InstrumentationLibraryBuilder::new(name),
+        }
     }
 
     /// Returns a new versioned tracer with the given instrumentation library.
@@ -104,3 +142,31 @@ pub trait TracerProvider {
     /// ```
     fn library_tracer(&self, library: Arc<InstrumentationLibrary>) -> Self::Tracer;
 }
+
+#[derive(Debug)]
+pub struct TracerBuilder<'a, T: TracerProvider + ?Sized> {
+    provider: &'a T,
+    library_builder: InstrumentationLibraryBuilder,
+}
+
+impl<'a, T: TracerProvider + ?Sized> TracerBuilder<'a, T> {
+    pub fn with_version(mut self, version: impl Into<Cow<'static, str>>) -> Self {
+        self.library_builder = self.library_builder.with_version(version);
+        self
+    }
+
+    pub fn with_schema_url(mut self, schema_url: impl Into<Cow<'static, str>>) -> Self {
+        self.library_builder = self.library_builder.with_schema_url(schema_url);
+        self
+    }
+
+    pub fn with_attributes(mut self, attributes: impl Into<Vec<KeyValue>>) -> Self {
+        self.library_builder = self.library_builder.with_attributes(attributes);
+        self
+    }
+
+    pub fn build(self) -> T::Tracer {
+        self.provider
+            .library_tracer(Arc::new(self.library_builder.build()))
+    }
+}