Merge branch 'main' into feat/otel_0.26_promo

Author: lalitb

examples/metrics-advanced/Cargo.toml

@@ -8,6 +8,6 @@ publish = false
 [dependencies]
 opentelemetry = { path = "../../opentelemetry", features = ["metrics"] }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["metrics", "rt-tokio"] }
-opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["metrics"]}
+opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["metrics"] }
 tokio = { workspace = true, features = ["full"] }
 serde_json = { workspace = true }

examples/metrics-advanced/src/main.rs

@@ -1,6 +1,7 @@
 use opentelemetry::global;
 use opentelemetry::Key;
 use opentelemetry::KeyValue;
+use opentelemetry_sdk::metrics::reader::DeltaTemporalitySelector;
 use opentelemetry_sdk::metrics::{
     Aggregation, Instrument, PeriodicReader, SdkMeterProvider, Stream,
 };
@@ -44,7 +45,11 @@ fn init_meter_provider() -> opentelemetry_sdk::metrics::SdkMeterProvider {
         }
     };
 
-    let exporter = opentelemetry_stdout::MetricsExporterBuilder::default().build();
+    // Build exporter using Delta Temporality.
+    let exporter = opentelemetry_stdout::MetricsExporterBuilder::default()
+        .with_temporality_selector(DeltaTemporalitySelector::new())
+        .build();
+
     let reader = PeriodicReader::builder(exporter, runtime::Tokio).build();
     let provider = SdkMeterProvider::builder()
         .with_reader(reader)

opentelemetry-appender-log/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## vNext
 
 - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179)
+- [2193](https://github.com/open-telemetry/opentelemetry-rust/pull/2193) `opentelemetry-appender-log`: Output experimental code attributes 
 
 ## v0.26.0
 Released 2024-Sep-30

opentelemetry-appender-log/Cargo.toml

@@ -11,17 +11,26 @@ rust-version = "1.70"
 edition = "2021"
 
 [dependencies]
-opentelemetry = { version = "0.26", path = "../opentelemetry", features = ["logs"]}
-log = { workspace = true, features = ["kv", "std"]}
+opentelemetry = { version = "0.26", path = "../opentelemetry", features = [
+  "logs",
+] }
+log = { workspace = true, features = ["kv", "std"] }
 serde = { workspace = true, optional = true, features = ["std"] }
+opentelemetry-semantic-conventions = { path = "../opentelemetry-semantic-conventions", optional = true, features = [
+  "semconv_experimental",
+] }
 
 [features]
 logs_level_enabled = ["opentelemetry/logs_level_enabled"]
 with-serde = ["log/kv_serde", "serde"]
+experimental_metadata_attributes = ["dep:opentelemetry-semantic-conventions"]
 
 [dev-dependencies]
-opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [ "testing", "logs_level_enabled" ] }
-opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"]}
+opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [
+  "testing",
+  "logs_level_enabled",
+] }
+opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"] }
 log = { workspace = true, features = ["kv_serde"] }
 tokio = { workspace = true }
 serde = { workspace = true, features = ["std", "derive"] }

opentelemetry-appender-log/src/lib.rs

@@ -99,6 +99,8 @@ use opentelemetry::{
     logs::{AnyValue, LogRecord, Logger, LoggerProvider, Severity},
     Key,
 };
+#[cfg(feature = "experimental_metadata_attributes")]
+use opentelemetry_semantic_conventions::attribute::{CODE_FILEPATH, CODE_LINENO, CODE_NAMESPACE};
 use std::borrow::Cow;
 
 pub struct OpenTelemetryLogBridge<P, L>
@@ -130,6 +132,28 @@ where
             log_record.set_severity_number(severity_of_level(record.level()));
             log_record.set_severity_text(record.level().as_str());
             log_record.set_body(AnyValue::from(record.args().to_string()));
+
+            #[cfg(feature = "experimental_metadata_attributes")]
+            {
+                if let Some(filepath) = record.file() {
+                    log_record.add_attribute(
+                        Key::new(CODE_FILEPATH),
+                        AnyValue::from(filepath.to_string()),
+                    );
+                }
+
+                if let Some(line_no) = record.line() {
+                    log_record.add_attribute(Key::new(CODE_LINENO), AnyValue::from(line_no));
+                }
+
+                if let Some(module) = record.module_path() {
+                    log_record.add_attribute(
+                        Key::new(CODE_NAMESPACE),
+                        AnyValue::from(module.to_string()),
+                    );
+                }
+            }
+
             log_record.add_attributes(log_attributes(record.key_values()));
             log_record.set_target(record.metadata().target().to_string());
 
@@ -1127,6 +1151,54 @@ mod tests {
         }
     }
 
+    #[cfg(feature = "experimental_metadata_attributes")]
+    #[test]
+    fn logbridge_code_attributes() {
+        use opentelemetry_semantic_conventions::attribute::{
+            CODE_FILEPATH, CODE_LINENO, CODE_NAMESPACE,
+        };
+
+        let exporter = InMemoryLogsExporter::default();
+
+        let logger_provider = LoggerProvider::builder()
+            .with_simple_exporter(exporter.clone())
+            .build();
+
+        let otel_log_appender = OpenTelemetryLogBridge::new(&logger_provider);
+
+        otel_log_appender.log(
+            &log::RecordBuilder::new()
+                .level(log::Level::Warn)
+                .args(format_args!("WARN"))
+                .file(Some("src/main.rs"))
+                .module_path(Some("service"))
+                .line(Some(101))
+                .build(),
+        );
+
+        let logs = exporter.get_emitted_logs().unwrap();
+
+        let get = |needle: &str| -> Option<AnyValue> {
+            logs[0].record.attributes_iter().find_map(|(k, v)| {
+                if k.as_str() == needle {
+                    Some(v.clone())
+                } else {
+                    None
+                }
+            })
+        };
+
+        assert_eq!(
+            Some(AnyValue::String(StringValue::from("src/main.rs"))),
+            get(CODE_FILEPATH)
+        );
+        assert_eq!(
+            Some(AnyValue::String(StringValue::from("service"))),
+            get(CODE_NAMESPACE)
+        );
+        assert_eq!(Some(AnyValue::Int(101)), get(CODE_LINENO));
+    }
+
     #[test]
     fn test_flush() {
         let exporter = InMemoryLogsExporter::default();

opentelemetry-otlp/src/metric.rs

@@ -14,7 +14,7 @@ use opentelemetry_sdk::{
     metrics::{
         data::{ResourceMetrics, Temporality},
         exporter::PushMetricsExporter,
-        reader::{DefaultTemporalitySelector, TemporalitySelector},
+        reader::{DefaultTemporalitySelector, DeltaTemporalitySelector, TemporalitySelector},
         InstrumentKind, PeriodicReader, SdkMeterProvider,
     },
     runtime::Runtime,
@@ -169,7 +169,7 @@ where
     ///
     /// [exporter-docs]: https://github.com/open-telemetry/opentelemetry-specification/blob/a1c13d59bb7d0fb086df2b3e1eaec9df9efef6cc/specification/metrics/sdk_exporters/otlp.md#additional-configuration
     pub fn with_delta_temporality(self) -> Self {
-        self.with_temporality_selector(DeltaTemporalitySelector)
+        self.with_temporality_selector(DeltaTemporalitySelector::new())
     }
 }
 
@@ -237,35 +237,6 @@ impl<RT, EB: Debug> Debug for OtlpMetricPipeline<RT, EB> {
     }
 }
 
-/// A temporality selector that returns [`Delta`][Temporality::Delta] for all
-/// instruments except `UpDownCounter` and `ObservableUpDownCounter`.
-///
-/// This temporality selector is equivalent to OTLP Metrics Exporter's
-/// `Delta` temporality preference (see [its documentation][exporter-docs]).
-///
-/// [exporter-docs]: https://github.com/open-telemetry/opentelemetry-specification/blob/a1c13d59bb7d0fb086df2b3e1eaec9df9efef6cc/specification/metrics/sdk_exporters/otlp.md#additional-configuration
-#[derive(Debug)]
-struct DeltaTemporalitySelector;
-
-impl TemporalitySelector for DeltaTemporalitySelector {
-    #[rustfmt::skip]
-    fn temporality(&self, kind: InstrumentKind) -> Temporality {
-        match kind {
-            InstrumentKind::Counter
-            | InstrumentKind::Histogram
-            | InstrumentKind::ObservableCounter
-            | InstrumentKind::Gauge
-            | InstrumentKind::ObservableGauge => {
-                Temporality::Delta
-            }
-            InstrumentKind::UpDownCounter
-            | InstrumentKind::ObservableUpDownCounter => {
-                Temporality::Cumulative
-            }
-        }
-    }
-}
-
 /// An interface for OTLP metrics clients
 #[async_trait]
 pub trait MetricsClient: fmt::Debug + Send + Sync + 'static {

opentelemetry-sdk/benches/metric.rs

@@ -10,7 +10,7 @@ use opentelemetry_sdk::{
     metrics::{
         data::{ResourceMetrics, Temporality},
         new_view,
-        reader::{MetricReader, TemporalitySelector},
+        reader::{DeltaTemporalitySelector, MetricReader, TemporalitySelector},
         Aggregation, Instrument, InstrumentKind, ManualReader, Pipeline, SdkMeterProvider, Stream,
         View,
     },
@@ -44,28 +44,6 @@ impl MetricReader for SharedReader {
     }
 }
 
-/// Configure delta temporality for all [InstrumentKind]
-///
-/// [Temporality::Delta] will be used for all instrument kinds if this
-/// [TemporalitySelector] is used.
-#[derive(Clone, Default, Debug)]
-pub struct DeltaTemporalitySelector {
-    pub(crate) _private: (),
-}
-
-impl DeltaTemporalitySelector {
-    /// Create a new default temporality selector.
-    pub fn new() -> Self {
-        Self::default()
-    }
-}
-
-impl TemporalitySelector for DeltaTemporalitySelector {
-    fn temporality(&self, _kind: InstrumentKind) -> Temporality {
-        Temporality::Delta
-    }
-}
-
 // * Summary *
 
 // rustc 1.68.0 (2c8cc3432 2023-03-06)

opentelemetry-sdk/src/logs/log_emitter.rs

@@ -1,9 +1,8 @@
 use super::{BatchLogProcessor, LogProcessor, LogRecord, SimpleLogProcessor, TraceContext};
 use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource};
-use opentelemetry::otel_warn;
 use opentelemetry::{
-    global,
     logs::{LogError, LogResult},
+    otel_debug,
     trace::TraceContextExt,
     Context, InstrumentationLibrary,
 };
@@ -126,17 +125,10 @@ impl LoggerProvider {
             if errs.is_empty() {
                 Ok(())
             } else {
-                otel_warn!(
-                    name: "logger_provider_shutdown_error",
-                    error = format!("{:?}", errs)
-                );
-                Err(LogError::Other(format!("{:?}", errs).into()))
+                Err(LogError::Other(format!("{errs:?}").into()))
             }
         } else {
-            otel_warn!(
-                name: "logger_provider_already_shutdown"
-            );
-            Err(LogError::Other("logger provider already shut down".into()))
+            Err(LogError::AlreadyShutdown("LoggerProvider".to_string()))
         }
     }
 }
@@ -154,6 +146,24 @@ impl LoggerProviderInner {
         let mut errs = vec![];
         for processor in &self.processors {
             if let Err(err) = processor.shutdown() {
+                // Log at debug level because:
+                //  - The error is also returned to the user for handling (if applicable)
+                //  - Or the error occurs during `LoggerProviderInner::Drop` as part of telemetry shutdown,
+                //    which is non-actionable by the user
+                match err {
+                    // specific handling for mutex poisioning
+                    LogError::MutexPoisoned(_) => {
+                        otel_debug!(
+                            name: "LoggerProvider.Drop.ShutdownMutexPoisoned",
+                        );
+                    }
+                    _ => {
+                        otel_debug!(
+                            name: "LoggerProvider.Drop.ShutdownError",
+                            error = format!("{err}")
+                        );
+                    }
+                }
                 errs.push(err);
             }
         }
@@ -164,10 +174,11 @@ impl LoggerProviderInner {
 impl Drop for LoggerProviderInner {
     fn drop(&mut self) {
         if !self.is_shutdown.load(Ordering::Relaxed) {
-            let errs = self.shutdown();
-            if !errs.is_empty() {
-                global::handle_error(LogError::Other(format!("{:?}", errs).into()));
-            }
+            let _ = self.shutdown(); // errors are handled within shutdown
+        } else {
+            otel_debug!(
+                name: "LoggerProvider.Drop.AlreadyShutdown"
+            );
         }
     }
 }