refactor: Use Deref instead of CommonSettings trait

Author: Techassi

crates/stackable-telemetry/src/tracing/mod.rs

@@ -14,7 +14,7 @@ use opentelemetry_sdk::{
     trace, Resource,
 };
 use opentelemetry_semantic_conventions::resource;
-use settings::{CommonSettings as _, ConsoleLogSettings, OtlpLogSettings, OtlpTraceSettings};
+use settings::{ConsoleLogSettings, OtlpLogSettings, OtlpTraceSettings};
 use snafu::{ResultExt as _, Snafu};
 use tracing::subscriber::SetGlobalDefaultError;
 use tracing_subscriber::{filter::Directive, layer::SubscriberExt, EnvFilter, Layer, Registry};
@@ -169,22 +169,22 @@ impl Tracing {
     pub fn init(mut self) -> Result<Tracing> {
         let mut layers: Vec<Box<dyn Layer<Registry> + Sync + Send>> = Vec::new();
 
-        if self.console_log_settings.enabled() {
+        if self.console_log_settings.enabled {
             let env_filter_layer = env_filter_builder(
                 self.console_log_settings
                     .common_settings
                     .environment_variable,
-                self.console_log_settings.default_level(),
+                self.console_log_settings.default_level,
             );
             let console_output_layer =
                 tracing_subscriber::fmt::layer().with_filter(env_filter_layer);
             layers.push(console_output_layer.boxed());
         }
 
-        if self.otlp_log_settings.enabled() {
+        if self.otlp_log_settings.enabled {
             let env_filter_layer = env_filter_builder(
-                self.otlp_log_settings.environment_variable(),
-                self.otlp_log_settings.default_level(),
+                self.otlp_log_settings.environment_variable,
+                self.otlp_log_settings.default_level,
             )
             // TODO (@NickLarsenNZ): Remove this directive once https://github.com/open-telemetry/opentelemetry-rust/issues/761 is resolved
             .add_directive("h2=off".parse().expect("invalid directive"));
@@ -209,12 +209,12 @@ impl Tracing {
             self.logger_provider = Some(otel_log);
         }
 
-        if self.otlp_trace_settings.enabled() {
+        if self.otlp_trace_settings.enabled {
             let env_filter_layer = env_filter_builder(
                 self.otlp_trace_settings
                     .common_settings
                     .environment_variable,
-                self.otlp_trace_settings.default_level(),
+                self.otlp_trace_settings.default_level,
             )
             // TODO (@NickLarsenNZ): Remove this directive once https://github.com/open-telemetry/opentelemetry-rust/issues/761 is resolved
             .add_directive("h2=off".parse().expect("invalid directive"));
@@ -262,12 +262,12 @@ impl Tracing {
 impl Drop for Tracing {
     fn drop(&mut self) {
         tracing::debug!(
-            opentelemetry.tracing.enabled = self.otlp_trace_settings.enabled(),
-            opentelemetry.logger.enabled = self.otlp_log_settings.enabled(),
+            opentelemetry.tracing.enabled = self.otlp_trace_settings.enabled,
+            opentelemetry.logger.enabled = self.otlp_log_settings.enabled,
             "shutting down opentelemetry OTLP providers"
         );
 
-        if self.otlp_trace_settings.enabled() {
+        if self.otlp_trace_settings.enabled {
             // NOTE (@NickLarsenNZ): This might eventually be replaced with something like SdkMeterProvider::shutdown(&self)
             // as has been done with the LoggerProvider (further below)
             // see: https://github.com/open-telemetry/opentelemetry-rust/pull/1412/files#r1409608679
@@ -495,8 +495,8 @@ mod test {
                 log_format: Default::default()
             }
         );
-        assert!(!trace_guard.otlp_log_settings.enabled());
-        assert!(!trace_guard.otlp_trace_settings.enabled());
+        assert!(!trace_guard.otlp_log_settings.enabled);
+        assert!(!trace_guard.otlp_trace_settings.enabled);
     }
 
     #[test]

crates/stackable-telemetry/src/tracing/settings/console_log.rs

@@ -1,6 +1,8 @@
 //! Console Log Subscriber Settings.
 
-use super::{Build, CommonSettings, Settings, SettingsBuilder};
+use std::ops::Deref;
+
+use super::{Build, Settings, SettingsBuilder};
 
 /// Configure specific settings for the Console Log subscriber.
 #[derive(Debug, Default, PartialEq)]
@@ -12,6 +14,14 @@ pub struct ConsoleLogSettings {
     pub log_format: Format,
 }
 
+impl Deref for ConsoleLogSettings {
+    type Target = Settings;
+
+    fn deref(&self) -> &Self::Target {
+        &self.common_settings
+    }
+}
+
 /// Console Subscriber log event output formats.
 ///
 /// Currently, only [Plain][Format::Plain] is supported.
@@ -75,12 +85,6 @@ impl Build<ConsoleLogSettings> for SettingsBuilder {
     }
 }
 
-impl CommonSettings for ConsoleLogSettings {
-    fn common(&self) -> &Settings {
-        &self.common_settings
-    }
-}
-
 #[cfg(test)]
 mod test {
     use tracing::level_filters::LevelFilter;

crates/stackable-telemetry/src/tracing/settings/mod.rs

@@ -11,27 +11,6 @@ pub use otlp_log::*;
 pub mod otlp_trace;
 pub use otlp_trace::*;
 
-/// Simplifies access common settings from subscriber specific settings.
-pub trait CommonSettings {
-    /// Access to common settings.
-    fn common(&self) -> &Settings;
-
-    /// Access to the [`Settings::environment_variable`] field.
-    fn environment_variable(&self) -> &'static str {
-        self.common().environment_variable
-    }
-
-    /// Access to the [`Settings::default_level`] field.
-    fn default_level(&self) -> LevelFilter {
-        self.common().default_level
-    }
-
-    /// Access to the [`Settings::enabled`] field.
-    fn enabled(&self) -> bool {
-        self.common().enabled
-    }
-}
-
 /// General settings that apply to any subscriber.
 #[derive(Debug, PartialEq)]
 pub struct Settings {

crates/stackable-telemetry/src/tracing/settings/otlp_log.rs

@@ -1,12 +1,22 @@
 //! OTLP Log Subscriber Settings.
 
-use super::{Build, CommonSettings, Settings, SettingsBuilder};
+use std::ops::Deref;
+
+use super::{Build, Settings, SettingsBuilder};
 
 #[derive(Debug, Default, PartialEq)]
 pub struct OtlpLogSettings {
     pub common_settings: Settings,
 }
 
+impl Deref for OtlpLogSettings {
+    type Target = Settings;
+
+    fn deref(&self) -> &Self::Target {
+        &self.common_settings
+    }
+}
+
 pub struct OtlpLogSettingsBuilder {
     pub(crate) common_settings: Settings,
 }
@@ -40,12 +50,6 @@ impl Build<OtlpLogSettings> for SettingsBuilder {
     }
 }
 
-impl CommonSettings for OtlpLogSettings {
-    fn common(&self) -> &Settings {
-        &self.common_settings
-    }
-}
-
 #[cfg(test)]
 mod test {
     use tracing::level_filters::LevelFilter;

crates/stackable-telemetry/src/tracing/settings/otlp_trace.rs

@@ -1,12 +1,22 @@
 //! OTLP Trace Subscriber Settings.
 
-use super::{Build, CommonSettings, Settings, SettingsBuilder};
+use std::ops::Deref;
+
+use super::{Build, Settings, SettingsBuilder};
 
 #[derive(Debug, Default, PartialEq)]
 pub struct OtlpTraceSettings {
     pub common_settings: Settings,
 }
 
+impl Deref for OtlpTraceSettings {
+    type Target = Settings;
+
+    fn deref(&self) -> &Self::Target {
+        &self.common_settings
+    }
+}
+
 pub struct OtlpTraceSettingsBuilder {
     pub(crate) common_settings: Settings,
 }
@@ -40,12 +50,6 @@ impl Build<OtlpTraceSettings> for SettingsBuilder {
     }
 }
 
-impl CommonSettings for OtlpTraceSettings {
-    fn common(&self) -> &Settings {
-        &self.common_settings
-    }
-}
-
 #[cfg(test)]
 mod test {
     use tracing::level_filters::LevelFilter;