chore(stackable-telemetry): Introduce the CommonSettings trait for quicker access to common settings from subscriber specific settings

Author: NickLarsenNZ

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

@@ -14,7 +14,7 @@ use opentelemetry_sdk::{
     trace, Resource,
 };
 use opentelemetry_semantic_conventions::resource;
-use settings::{ConsoleLogSettings, OtlpLogSettings, OtlpTraceSettings};
+use settings::{CommonSettings as _, ConsoleLogSettings, OtlpLogSettings, OtlpTraceSettings};
 use snafu::{ResultExt as _, Snafu};
 use tracing::subscriber::SetGlobalDefaultError;
 use tracing_subscriber::{filter::Directive, layer::SubscriberExt, EnvFilter, Layer, Registry};
@@ -146,23 +146,23 @@ 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.common_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.common_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.common_settings.enabled {
+        if self.otlp_log_settings.enabled() {
             let env_filter_layer = env_filter_builder(
-                &self.otlp_log_settings.common_settings.environment_variable,
-                self.otlp_log_settings.common_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"));
@@ -187,13 +187,13 @@ impl Tracing {
             self.logger_provider = Some(otel_log);
         }
 
-        if self.otlp_trace_settings.common_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.common_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"));
@@ -241,12 +241,12 @@ impl Tracing {
 impl Drop for Tracing {
     fn drop(&mut self) {
         tracing::debug!(
-            opentelemetry.tracing.enabled = self.otlp_trace_settings.common_settings.enabled,
-            opentelemetry.logger.enabled = self.otlp_log_settings.common_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.common_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
@@ -468,8 +468,8 @@ mod test {
                 log_format: Default::default()
             }
         );
-        assert!(!trace_guard.otlp_log_settings.common_settings.enabled);
-        assert!(!trace_guard.otlp_trace_settings.common_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,4 +1,6 @@
-use super::{Build, Settings, SettingsBuilder};
+use tracing::level_filters::LevelFilter;
+
+use super::{Build, CommonSettings, Settings, SettingsBuilder};
 
 #[derive(Debug, Default, PartialEq)]
 pub struct ConsoleLogSettings {
@@ -57,6 +59,20 @@ impl Build<ConsoleLogSettings> for SettingsBuilder {
     }
 }
 
+impl CommonSettings for ConsoleLogSettings {
+    fn environment_variable(&self) -> &'static str {
+        self.common_settings.environment_variable
+    }
+
+    fn enabled(&self) -> bool {
+        self.common_settings.enabled
+    }
+
+    fn default_level(&self) -> LevelFilter {
+        self.common_settings.default_level
+    }
+}
+
 #[cfg(test)]
 mod test {
     use tracing::level_filters::LevelFilter;

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

@@ -9,6 +9,13 @@ pub use otlp_log::*;
 pub mod otlp_trace;
 pub use otlp_trace::*;
 
+// this trait is to make it simpler to access common settings from specific settings.
+pub trait CommonSettings {
+    fn environment_variable(&self) -> &'static str;
+    fn enabled(&self) -> bool;
+    fn default_level(&self) -> LevelFilter;
+}
+
 #[derive(Debug, PartialEq)]
 pub struct Settings {
     pub environment_variable: &'static str,

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

@@ -1,4 +1,6 @@
-use super::{Build, Settings, SettingsBuilder};
+use tracing::level_filters::LevelFilter;
+
+use super::{Build, CommonSettings, Settings, SettingsBuilder};
 
 #[derive(Debug, Default, PartialEq)]
 pub struct OtlpLogSettings {
@@ -39,6 +41,21 @@ impl Build<OtlpLogSettings> for SettingsBuilder {
         }
     }
 }
+
+impl CommonSettings for OtlpLogSettings {
+    fn environment_variable(&self) -> &'static str {
+        self.common_settings.environment_variable
+    }
+
+    fn enabled(&self) -> bool {
+        self.common_settings.enabled
+    }
+
+    fn default_level(&self) -> LevelFilter {
+        self.common_settings.default_level
+    }
+}
+
 #[cfg(test)]
 mod test {
     use tracing::level_filters::LevelFilter;

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

@@ -1,4 +1,6 @@
-use super::{Build, Settings, SettingsBuilder};
+use tracing::level_filters::LevelFilter;
+
+use super::{Build, CommonSettings, Settings, SettingsBuilder};
 
 #[derive(Debug, Default, PartialEq)]
 pub struct OtlpTraceSettings {
@@ -40,6 +42,20 @@ impl Build<OtlpTraceSettings> for SettingsBuilder {
     }
 }
 
+impl CommonSettings for OtlpTraceSettings {
+    fn environment_variable(&self) -> &'static str {
+        self.common_settings.environment_variable
+    }
+
+    fn enabled(&self) -> bool {
+        self.common_settings.enabled
+    }
+
+    fn default_level(&self) -> LevelFilter {
+        self.common_settings.default_level
+    }
+}
+
 #[cfg(test)]
 mod test {
     use tracing::level_filters::LevelFilter;