feat(stackable-telemetry): Add a settings builder for the otlp trace exporter

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;
+use settings::{ConsoleLogSettings, OtlpTraceSettings};
 use snafu::{ResultExt as _, Snafu};
 use tracing::{level_filters::LevelFilter, subscriber::SetGlobalDefaultError};
 use tracing_subscriber::{filter::Directive, layer::SubscriberExt, EnvFilter, Layer, Registry};
@@ -407,17 +407,16 @@ impl TracingBuilder<builder_state::Config> {
     /// in the opentelemetry crates. See [`Tracing`].
     pub fn with_otlp_trace_exporter(
         self,
-        env_var: &'static str,
-        default_level_filter: LevelFilter,
+        settings: OtlpTraceSettings,
     ) -> TracingBuilder<builder_state::Config> {
         TracingBuilder {
             service_name: self.service_name,
             console_log_config: self.console_log_config,
             otlp_log_config: self.otlp_log_config,
             otlp_trace_config: SubscriberConfig {
-                enabled: true,
-                env_var,
-                default_level_filter,
+                enabled: settings.common_settings.enabled,
+                env_var: settings.common_settings.environment_variable,
+                default_level_filter: settings.common_settings.default_level,
             },
             _marker: self._marker,
         }
@@ -505,7 +504,13 @@ mod test {
                     .build(),
             )
             .with_otlp_log_exporter("ABC_OTLP_LOG", LevelFilter::DEBUG)
-            .with_otlp_trace_exporter("ABC_OTLP_TRACE", LevelFilter::TRACE)
+            .with_otlp_trace_exporter(
+                Settings::builder()
+                    .env_var("ABC_OTLP_TRACE")
+                    .default_level(LevelFilter::TRACE)
+                    .enabled(true)
+                    .build(),
+            )
             .build();
 
         assert_eq!(

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

@@ -3,6 +3,9 @@ use tracing::level_filters::LevelFilter;
 pub mod console_log;
 pub use console_log::*;
 
+pub mod otlp_trace;
+pub use otlp_trace::*;
+
 #[derive(Debug, PartialEq)]
 pub struct Settings {
     pub environment_variable: &'static str,
@@ -49,6 +52,15 @@ impl Build<ConsoleLogSettings> for SettingsBuilder {
     }
 }
 
+impl Build<OtlpTraceSettings> for SettingsBuilder {
+    fn build(self) -> OtlpTraceSettings {
+        OtlpTraceSettings {
+            common_settings: self.into(),
+            ..Default::default()
+        }
+    }
+}
+
 impl SettingsBuilder {
     pub fn env_var(mut self, name: &'static str) -> Self {
         self.environment_variable = name;
@@ -70,13 +82,13 @@ impl SettingsBuilder {
     //     self.into()
     // }
 
-    pub fn console_builder(self) -> ConsoleLogSettingsBuilder {
+    pub fn console_log_builder(self) -> ConsoleLogSettingsBuilder {
         self.into()
     }
 
-    // pub fn xxx_builder(self) -> XxxSettingsBuilder {
-    //     self.into()
-    // }
+    pub fn otlp_trace_builder(self) -> OtlpTraceSettingsBuilder {
+        self.into()
+    }
 }
 
 impl Default for SettingsBuilder {
@@ -108,6 +120,14 @@ impl From<SettingsBuilder> for ConsoleLogSettingsBuilder {
     }
 }
 
+impl From<SettingsBuilder> for OtlpTraceSettingsBuilder {
+    fn from(value: SettingsBuilder) -> Self {
+        Self {
+            common_settings: value.into(),
+        }
+    }
+}
+
 #[derive(Debug, Default, PartialEq)]
 pub enum Format {
     #[default]
@@ -134,11 +154,30 @@ mod test {
             .enabled(true)
             .env_var("hello")
             .default_level(LevelFilter::DEBUG)
-            .console_builder()
+            .console_log_builder()
             .log_format(Format::Plain)
             // color
             .build();
 
         assert_eq!(expected, result);
     }
+
+    #[test]
+    fn builds_otlp_trace_settings() {
+        let expected = OtlpTraceSettings {
+            common_settings: Settings {
+                environment_variable: "hello",
+                enabled: true,
+                default_level: LevelFilter::DEBUG,
+            },
+        };
+        let result: OtlpTraceSettings = Settings::builder()
+            .enabled(true)
+            .env_var("hello")
+            .default_level(LevelFilter::DEBUG)
+            .otlp_trace_builder()
+            .build();
+
+        assert_eq!(expected, result);
+    }
 }

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

@@ -0,0 +1,24 @@
+use super::Settings;
+
+#[derive(Debug, Default, PartialEq)]
+pub struct OtlpTraceSettings {
+    pub common_settings: Settings,
+}
+
+pub struct OtlpTraceSettingsBuilder {
+    pub(crate) common_settings: Settings,
+}
+
+impl OtlpTraceSettingsBuilder {
+    pub fn build(self) -> OtlpTraceSettings {
+        self.into()
+    }
+}
+
+impl From<OtlpTraceSettingsBuilder> for OtlpTraceSettings {
+    fn from(value: OtlpTraceSettingsBuilder) -> Self {
+        Self {
+            common_settings: value.common_settings,
+        }
+    }
+}