From 71ea88af1fb59a2a9f81bc04590ad4c7640dc602 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 26 Nov 2024 10:37:19 -0800 Subject: [PATCH 1/7] initial commit --- opentelemetry-sdk/src/logs/log_emitter.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index 1ebe76de9a..3f777070ee 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -238,11 +238,19 @@ impl Logger { Logger { scope, provider } } + #[deprecated( + since = "0.27.1", + note = "This method is intended for appender developers and has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." + )] /// LoggerProvider associated with this logger. pub fn provider(&self) -> &LoggerProvider { &self.provider } + #[deprecated( + since = "0.27.1", + note = "This method is intended for appender developers and has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." + )] /// Instrumentation scope of this logger. pub fn instrumentation_scope(&self) -> &InstrumentationScope { &self.scope From d0063aba437610d26558553a0d64681157beffc8 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 26 Nov 2024 10:43:06 -0800 Subject: [PATCH 2/7] add changelog --- opentelemetry-sdk/CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index 9b32d9579f..041402c8dc 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -25,6 +25,13 @@ - Bug fix: Empty Logger names are retained as-is instead of replacing with "rust.opentelemetry.io/sdk/logger" [#2316](https://github.com/open-telemetry/opentelemetry-rust/pull/2316) + + - `Logger::provider`: This method is deprecated as of version `0.27.1`. To be removed in `0.28.0`. + - `Logger::instrumentation_scope`: This method is deprecated as of version `0.27.1`. To be removed in `0.28.0` + Migration Guidance: + - These methods are intended for log appenders. Keep the clone of the provider handle, instead of depending + on above methods. + ## 0.27.0 From 13f66a2f0690048584c44cbd4ea882ea1202831b Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 26 Nov 2024 10:43:55 -0800 Subject: [PATCH 3/7] add changelog --- opentelemetry-sdk/CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index 041402c8dc..9c298a2a03 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -29,8 +29,7 @@ - `Logger::provider`: This method is deprecated as of version `0.27.1`. To be removed in `0.28.0`. - `Logger::instrumentation_scope`: This method is deprecated as of version `0.27.1`. To be removed in `0.28.0` Migration Guidance: - - These methods are intended for log appenders. Keep the clone of the provider handle, instead of depending - on above methods. + - These methods are intended for log appenders. Keep the clone of the provider handle, instead of depending on above methods. ## 0.27.0 From c51fc688dfa73f7e26fec2e70db032f9ce9b5632 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 26 Nov 2024 10:54:13 -0800 Subject: [PATCH 4/7] fix test --- opentelemetry-sdk/src/logs/log_emitter.rs | 17 ++++++----------- opentelemetry-sdk/src/logs/mod.rs | 1 + 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index 3f777070ee..de1745129d 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -266,7 +266,7 @@ impl opentelemetry::logs::Logger for Logger { /// Emit a `LogRecord`. fn emit(&self, mut record: Self::LogRecord) { - let provider = self.provider(); + let provider = &self.provider; let processors = provider.log_processors(); //let mut log_record = record; @@ -285,22 +285,17 @@ impl opentelemetry::logs::Logger for Logger { } for p in processors { - p.emit(&mut record, self.instrumentation_scope()); + p.emit(&mut record, &self.scope); } } #[cfg(feature = "spec_unstable_logs_enabled")] fn event_enabled(&self, level: Severity, target: &str) -> bool { - let provider = self.provider(); + let provider = &self.provider; let mut enabled = false; for processor in provider.log_processors() { - enabled = enabled - || processor.event_enabled( - level, - target, - self.instrumentation_scope().name().as_ref(), - ); + enabled = enabled || processor.event_enabled(level, target, self.scope.name().as_ref()); } enabled } @@ -733,14 +728,14 @@ mod tests { emitted_logs[0].clone().record.body, Some(AnyValue::String("Testing empty logger name".into())) ); - assert_eq!(logger.instrumentation_scope().name(), ""); + assert_eq!(logger.scope.name(), ""); // Assert the second log created through the scope assert_eq!( emitted_logs[1].clone().record.body, Some(AnyValue::String("Testing empty logger scope name".into())) ); - assert_eq!(scoped_logger.instrumentation_scope().name(), ""); + assert_eq!(scoped_logger.scope.name(), ""); } #[derive(Debug)] diff --git a/opentelemetry-sdk/src/logs/mod.rs b/opentelemetry-sdk/src/logs/mod.rs index f4f55cd390..d1212bbdeb 100644 --- a/opentelemetry-sdk/src/logs/mod.rs +++ b/opentelemetry-sdk/src/logs/mod.rs @@ -108,6 +108,7 @@ mod tests { } #[test] + #[allow(deprecated)] fn logger_attributes() { let provider = LoggerProvider::builder().build(); let scope = InstrumentationScope::builder("test_logger") From 3cb260e31f908b737b474e7e9fe0d25ecc3f5ae8 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 26 Nov 2024 10:55:34 -0800 Subject: [PATCH 5/7] update note --- opentelemetry-sdk/src/logs/log_emitter.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index de1745129d..5d086786b3 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -240,7 +240,7 @@ impl Logger { #[deprecated( since = "0.27.1", - note = "This method is intended for appender developers and has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." + note = "This method is intended for appender developers, but has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." )] /// LoggerProvider associated with this logger. pub fn provider(&self) -> &LoggerProvider { @@ -249,7 +249,7 @@ impl Logger { #[deprecated( since = "0.27.1", - note = "This method is intended for appender developers and has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." + note = "This method is intended for appender developers, but has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." )] /// Instrumentation scope of this logger. pub fn instrumentation_scope(&self) -> &InstrumentationScope { From 2f462797ecf17ce32ac86d14bbf751577819417d Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 26 Nov 2024 11:13:54 -0800 Subject: [PATCH 6/7] Update opentelemetry-sdk/src/logs/log_emitter.rs Co-authored-by: Cijo Thomas --- opentelemetry-sdk/src/logs/log_emitter.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index 5d086786b3..b3e8acf7c1 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -240,7 +240,7 @@ impl Logger { #[deprecated( since = "0.27.1", - note = "This method is intended for appender developers, but has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." + note = "This method was intended for appender developers, but has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." )] /// LoggerProvider associated with this logger. pub fn provider(&self) -> &LoggerProvider { From bceded9b16cf808a4198a4448668fa1e2c142c00 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 26 Nov 2024 11:14:20 -0800 Subject: [PATCH 7/7] Update log_emitter.rs --- opentelemetry-sdk/src/logs/log_emitter.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index b3e8acf7c1..9b426f1d31 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -249,7 +249,7 @@ impl Logger { #[deprecated( since = "0.27.1", - note = "This method is intended for appender developers, but has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." + note = "This method was intended for appender developers, but has no defined use-case in typical workflows. It is deprecated and will be removed in the next major release." )] /// Instrumentation scope of this logger. pub fn instrumentation_scope(&self) -> &InstrumentationScope {