Docs

Author: izquierdo

opentelemetry/src/common.rs

@@ -507,7 +507,12 @@ impl InstrumentationLibrary {
 
     /// Create a new builder to create an [InstrumentationLibrary]
     pub fn builder(name: impl Into<Cow<'static, str>>) -> InstrumentationLibraryBuilder {
-        InstrumentationLibraryBuilder::new(name)
+        InstrumentationLibraryBuilder {
+            name: name.into(),
+            version: None,
+            schema_url: None,
+            attributes: None,
+        }
     }
 }
 
@@ -534,30 +539,49 @@ pub struct InstrumentationLibraryBuilder {
 }
 
 impl InstrumentationLibraryBuilder {
-    pub fn new(name: impl Into<Cow<'static, str>>) -> Self {
-        InstrumentationLibraryBuilder {
-            name: name.into(),
-            version: None,
-            schema_url: None,
-            attributes: None,
-        }
-    }
-
+    /// Configure the version for the instrumentation library
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// let library = opentelemetry::InstrumentationLibrary::builder()
+    ///     .with_version("v0.1.0")
+    ///     .build();
+    /// ```
     pub fn with_version(mut self, version: impl Into<Cow<'static, str>>) -> Self {
         self.version = Some(version.into());
         self
     }
 
+    /// Configure the Schema URL for the instrumentation library
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// let library = opentelemetry::InstrumentationLibrary::builder()
+    ///     .with_schema_url("https://opentelemetry.io/schemas/1.17.0")
+    ///     .build();
+    /// ```
     pub fn with_schema_url(mut self, schema_url: impl Into<Cow<'static, str>>) -> Self {
         self.schema_url = Some(schema_url.into());
         self
     }
 
+    /// Configure the attributes for the instrumentation library
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// let library = opentelemetry::InstrumentationLibrary::builder()
+    ///     .with_attributes(vec![KeyValue::new("k", "v"))
+    ///     .build();
+    /// ```
     pub fn with_attributes(mut self, attributes: impl Into<Vec<KeyValue>>) -> Self {
         self.attributes = Some(attributes.into());
         self
     }
 
+    /// Create a new [InstrumentationLibrary] from this configuration
     pub fn build(self) -> InstrumentationLibrary {
         InstrumentationLibrary {
             name: self.name,

opentelemetry/src/trace/tracer_provider.rs

@@ -115,7 +115,7 @@ pub trait TracerProvider {
     fn tracer_builder(&self, name: impl Into<Cow<'static, str>>) -> TracerBuilder<'_, Self> {
         TracerBuilder {
             provider: self,
-            library_builder: InstrumentationLibraryBuilder::new(name),
+            library_builder: InstrumentationLibrary::builder(name),
         }
     }