Merge branch 'main' into main

Author: cijothomas

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -28,7 +28,7 @@ body:
   - type: textarea
     id: sdk-version
     attributes:
-      label: label: OpenTelemetry SDK Version (i.e version of `opentelemetry_sdk` crate)
+      label: OpenTelemetry SDK Version (i.e version of `opentelemetry_sdk` crate)
       description: What version of the `opentelemetry_sdk` crate are you using?
       placeholder: 0.x, 1.x, etc.
     validations:

README.md

@@ -30,6 +30,9 @@ documentation.
 
 | Signal/Component      | Overall Status     |
 | --------------------  | ------------------ |
+| Context               | Beta               |
+| Baggage               | Beta               |
+| Propagators           | Beta               |
 | Logs-API              | Stable*            |
 | Logs-SDK              | RC                 |
 | Logs-OTLP Exporter    | RC                 |

examples/tracing-jaeger/Cargo.toml

@@ -8,5 +8,5 @@ publish = false
 [dependencies]
 opentelemetry = { path = "../../opentelemetry" }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["rt-tokio"] }
-opentelemetry-otlp = { workspace = true, features = ["tonic"] }
+opentelemetry-otlp = { workspace = true, features = ["grpc-tonic"] }
 tokio = { workspace = true, features = ["full"] }

examples/tracing-jaeger/src/main.rs

@@ -3,12 +3,14 @@ use opentelemetry::{
     trace::{TraceContextExt, Tracer},
     KeyValue,
 };
-use opentelemetry_sdk::trace::{SdkTracerProvider, TraceError};
+use opentelemetry_otlp::ExporterBuildError;
+use opentelemetry_sdk::trace::SdkTracerProvider;
 use opentelemetry_sdk::Resource;
 
 use std::error::Error;
 
-fn init_tracer_provider() -> Result<opentelemetry_sdk::trace::SdkTracerProvider, TraceError> {
+fn init_tracer_provider() -> Result<opentelemetry_sdk::trace::SdkTracerProvider, ExporterBuildError>
+{
     let exporter = opentelemetry_otlp::SpanExporter::builder()
         .with_tonic()
         .build()?;

opentelemetry-appender-log/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## vNext
 
+- Similar to the `opentelemetry-appender-tracing` fix [2658](https://github.com/open-telemetry/opentelemetry-rust/issues/2658)
+  InstrumentationScope(Logger) used by the appender now uses an empty ("") named Logger.
+  Previously, a Logger with name and version of the crate was used.
+  Receivers (processors, exporters) are expected to use `LogRecord.target()` as scope name.
+  This is already done in OTLP Exporters, so this change should be transparent to most users.
+
 ## 0.28.0
 
 Released 2025-Feb-10

opentelemetry-appender-log/src/lib.rs

@@ -113,7 +113,7 @@
 use log::{Level, Metadata, Record};
 use opentelemetry::{
     logs::{AnyValue, LogRecord, Logger, LoggerProvider, Severity},
-    InstrumentationScope, Key,
+    Key,
 };
 #[cfg(feature = "experimental_metadata_attributes")]
 use opentelemetry_semantic_conventions::attribute::{
@@ -189,12 +189,13 @@ where
     L: Logger + Send + Sync,
 {
     pub fn new(provider: &P) -> Self {
-        let scope = InstrumentationScope::builder("opentelemetry-log-appender")
-            .with_version(env!("CARGO_PKG_VERSION"))
-            .build();
-
-        OpenTelemetryLogBridge {
-            logger: provider.logger_with_scope(scope),
+        Self {
+            // Using empty scope name.
+            // The name/version of this library itself can be added
+            // as a Scope attribute once a semantic convention is
+            // defined for the same.
+            // See https://github.com/open-telemetry/semantic-conventions/issues/1550
+            logger: provider.logger(""),
             _phantom: Default::default(),
         }
     }
@@ -985,9 +986,13 @@ mod tests {
         );
 
         let logs = exporter.get_emitted_logs().unwrap();
+        assert_eq!(logs.len(), 1);
+
+        let log = logs.first().unwrap();
+        assert_eq!(log.instrumentation.name(), "");
 
         let get = |needle: &str| -> Option<AnyValue> {
-            logs[0].record.attributes_iter().find_map(|(k, v)| {
+            log.record.attributes_iter().find_map(|(k, v)| {
                 if k.as_str() == needle {
                     Some(v.clone())
                 } else {
@@ -1197,9 +1202,13 @@ mod tests {
         );
 
         let logs = exporter.get_emitted_logs().unwrap();
+        assert_eq!(logs.len(), 1);
+
+        let log = logs.first().unwrap();
+        assert_eq!(log.instrumentation.name(), "");
 
         let get = |needle: &str| -> Option<AnyValue> {
-            logs[0].record.attributes_iter().find_map(|(k, v)| {
+            log.record.attributes_iter().find_map(|(k, v)| {
                 if k.as_str() == needle {
                     Some(v.clone())
                 } else {

opentelemetry-appender-tracing/CHANGELOG.md

@@ -42,6 +42,14 @@ transparent to most users.
   implementations (SDK, processor, exporters) to leverage this additional
   information to determine if an event is enabled.
 
+- `u64` and `usize` values are stored as `opentelemetry::logs::AnyValue::Int`
+when conversion is feasible. Otherwise stored as
+`opentelemetry::logs::AnyValue::String`. This avoids unnecessary string
+allocation when values can be represented in their original types.
+- Byte arrays are stored as `opentelemetry::logs::AnyValue::Bytes` instead
+of string.
+- perf - small perf improvement by avoiding string allocation of `target`
+
 ## 0.28.1
 
 Released 2025-Feb-12

opentelemetry-appender-tracing/benches/logs.rs

@@ -10,7 +10,7 @@
     | noop_layer_disabled         | 12 ns       |
     | noop_layer_enabled          | 25 ns       |
     | ot_layer_disabled           | 19 ns       |
-    | ot_layer_enabled            | 167 ns      |
+    | ot_layer_enabled            | 155 ns      |
 
     Hardware: Apple M4 Pro
     Total Number of Cores:	14 (10 performance and 4 efficiency)
@@ -20,7 +20,7 @@
     | noop_layer_disabled         | 8 ns       |
     | noop_layer_enabled          | 14 ns       |
     | ot_layer_disabled           | 12 ns       |
-    | ot_layer_enabled            | 186 ns      |
+    | ot_layer_enabled            | 130 ns      |
 */
 
 use criterion::{criterion_group, criterion_main, Criterion};

opentelemetry-appender-tracing/src/layer.rs

@@ -80,6 +80,11 @@ impl<LR: LogRecord> tracing::field::Visit for EventVisitor<'_, LR> {
         }
     }
 
+    fn record_bytes(&mut self, field: &tracing_core::Field, value: &[u8]) {
+        self.log_record
+            .add_attribute(Key::new(field.name()), AnyValue::from(value));
+    }
+
     fn record_str(&mut self, field: &tracing_core::Field, value: &str) {
         #[cfg(feature = "experimental_metadata_attributes")]
         if is_duplicated_metadata(field.name()) {
@@ -114,6 +119,22 @@ impl<LR: LogRecord> tracing::field::Visit for EventVisitor<'_, LR> {
             .add_attribute(Key::new(field.name()), AnyValue::from(value));
     }
 
+    // TODO: We might need to do similar for record_i128,record_u128 too
+    // to avoid stringification, unless needed.
+    fn record_u64(&mut self, field: &tracing::field::Field, value: u64) {
+        #[cfg(feature = "experimental_metadata_attributes")]
+        if is_duplicated_metadata(field.name()) {
+            return;
+        }
+        if let Ok(signed) = i64::try_from(value) {
+            self.log_record
+                .add_attribute(Key::new(field.name()), AnyValue::from(signed));
+        } else {
+            self.log_record
+                .add_attribute(Key::new(field.name()), AnyValue::from(format!("{value:?}")));
+        }
+    }
+
     // TODO: Remaining field types from AnyValue : Bytes, ListAny, Boolean
 }
 
@@ -173,8 +194,7 @@ where
 
         let mut log_record = self.logger.create_log_record();
 
-        // TODO: Fix heap allocation
-        log_record.set_target(target.to_string());
+        log_record.set_target(target);
         log_record.set_event_name(name);
         log_record.set_severity_number(severity);
         log_record.set_severity_text(metadata.level().as_str());
@@ -331,7 +351,11 @@ mod tests {
         let _guard = tracing::subscriber::set_default(subscriber);
 
         // Act
-        error!(name: "my-event-name", target: "my-system", event_id = 20, user_name = "otel", user_email = "[email protected]");
+        let small_u64value: u64 = 42;
+        let big_u64value: u64 = u64::MAX;
+        let small_usizevalue: usize = 42;
+        let big_usizevalue: usize = usize::MAX;
+        error!(name: "my-event-name", target: "my-system", event_id = 20, bytes = &b"abc"[..], small_u64value, big_u64value, small_usizevalue, big_usizevalue, user_name = "otel", user_email = "[email protected]");
         assert!(logger_provider.force_flush().is_ok());
 
         // Assert TODO: move to helper methods
@@ -362,9 +386,9 @@ mod tests {
 
         // Validate attributes
         #[cfg(not(feature = "experimental_metadata_attributes"))]
-        assert_eq!(log.record.attributes_iter().count(), 3);
+        assert_eq!(log.record.attributes_iter().count(), 8);
         #[cfg(feature = "experimental_metadata_attributes")]
-        assert_eq!(log.record.attributes_iter().count(), 7);
+        assert_eq!(log.record.attributes_iter().count(), 12);
         assert!(attributes_contains(
             &log.record,
             &Key::new("event_id"),
@@ -380,6 +404,31 @@ mod tests {
             &Key::new("user_email"),
             &AnyValue::String("[email protected]".into())
         ));
+        assert!(attributes_contains(
+            &log.record,
+            &Key::new("small_u64value"),
+            &AnyValue::Int(42.into())
+        ));
+        assert!(attributes_contains(
+            &log.record,
+            &Key::new("big_u64value"),
+            &AnyValue::String(format!("{}", u64::MAX).into())
+        ));
+        assert!(attributes_contains(
+            &log.record,
+            &Key::new("small_usizevalue"),
+            &AnyValue::Int(42.into())
+        ));
+        assert!(attributes_contains(
+            &log.record,
+            &Key::new("big_usizevalue"),
+            &AnyValue::String(format!("{}", u64::MAX).into())
+        ));
+        assert!(attributes_contains(
+            &log.record,
+            &Key::new("bytes"),
+            &AnyValue::Bytes(Box::new(b"abc".to_vec()))
+        ));
         #[cfg(feature = "experimental_metadata_attributes")]
         {
             assert!(attributes_contains(
@@ -753,6 +802,10 @@ mod tests {
             TraceFlags::SAMPLED
         );
 
+        for attribute in log.record.attributes_iter() {
+            println!("key: {:?}, value: {:?}", attribute.0, attribute.1);
+        }
+
         // Attributes can be polluted when we don't use this feature.
         #[cfg(feature = "experimental_metadata_attributes")]
         assert_eq!(log.record.attributes_iter().count(), 4);

opentelemetry-otlp/CHANGELOG.md

@@ -8,6 +8,15 @@
   [#2770](https://github.com/open-telemetry/opentelemetry-rust/issues/2770)
   partially to properly handle `shutdown()` when using `http`. (`tonic` still
   does not do proper shutdown)
+- *Breaking*
+ ExporterBuilder's build() method now Result with `ExporterBuildError` being the
+ Error variant. Previously it returned signal specific errors like `LogError`
+ from the `opentelemetry_sdk`, which are no longer part of the sdk. No changes
+ required if you were using unwrap/expect. If you were matching on the returning
+ Error enum, replace with the enum `ExporterBuildError`. Unlike the previous
+ `Error` which contained many variants unrelated to building an exporter, the
+ new one returns specific variants applicable to building an exporter. Some
+ variants might be applicable only on select features.
 
 ## 0.28.0