refactor(stackable-telemetry): Rename env_var() for consistency, reorder fields

Author: NickLarsenNZ

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

@@ -443,14 +443,14 @@ mod test {
             .service_name("test")
             .with_console_output(
                 Settings::builder()
-                    .env_var("ABC_A")
+                    .environment_variable("ABC_A")
                     .default_level(LevelFilter::TRACE)
                     .enabled(true)
                     .build(),
             )
             .with_console_output(
                 Settings::builder()
-                    .env_var("ABC_B")
+                    .environment_variable("ABC_B")
                     .default_level(LevelFilter::DEBUG)
                     .enabled(true)
                     .build(),
@@ -478,7 +478,7 @@ mod test {
             .service_name("test")
             .with_console_output(
                 Settings::builder()
-                    .env_var("ABC_CONSOLE")
+                    .environment_variable("ABC_CONSOLE")
                     .default_level(LevelFilter::INFO)
                     .enabled(true)
                     .build(),

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

@@ -64,13 +64,13 @@ impl CommonSettings for ConsoleLogSettings {
         self.common_settings.environment_variable
     }
 
-    fn enabled(&self) -> bool {
-        self.common_settings.enabled
-    }
-
     fn default_level(&self) -> LevelFilter {
         self.common_settings.default_level
     }
+
+    fn enabled(&self) -> bool {
+        self.common_settings.enabled
+    }
 }
 
 #[cfg(test)]
@@ -84,15 +84,15 @@ mod test {
         let expected = ConsoleLogSettings {
             common_settings: Settings {
                 environment_variable: "hello",
-                enabled: true,
                 default_level: LevelFilter::DEBUG,
+                enabled: true,
             },
             log_format: Format::Plain,
         };
         let result = Settings::builder()
-            .enabled(true)
-            .env_var("hello")
+            .environment_variable("hello")
             .default_level(LevelFilter::DEBUG)
+            .enabled(true)
             .console_log_settings_builder()
             .log_format(Format::Plain)
             // color

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

@@ -12,17 +12,17 @@ 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;
+    fn enabled(&self) -> bool;
 }
 
 #[derive(Debug, PartialEq)]
 pub struct Settings {
     pub environment_variable: &'static str,
 
-    pub enabled: bool,
-
     pub default_level: LevelFilter,
+
+    pub enabled: bool,
 }
 
 impl Settings {
@@ -54,18 +54,18 @@ impl Build<Settings> for SettingsBuilder {
 }
 
 impl SettingsBuilder {
-    pub fn env_var(mut self, name: &'static str) -> Self {
+    pub fn environment_variable(mut self, name: &'static str) -> Self {
         self.environment_variable = name;
         self
     }
 
-    pub fn enabled(mut self, enabled: bool) -> Self {
-        self.enabled = enabled;
+    pub fn default_level(mut self, level: impl Into<LevelFilter>) -> Self {
+        self.default_level = level.into();
         self
     }
 
-    pub fn default_level(mut self, level: impl Into<LevelFilter>) -> Self {
-        self.default_level = level.into();
+    pub fn enabled(mut self, enabled: bool) -> Self {
+        self.enabled = enabled;
         self
     }
 
@@ -86,8 +86,8 @@ impl Default for SettingsBuilder {
     fn default() -> Self {
         Self {
             environment_variable: "RUST_LOG",
-            enabled: false,
             default_level: LevelFilter::OFF,
+            enabled: false,
         }
     }
 }
@@ -96,8 +96,8 @@ impl From<SettingsBuilder> for Settings {
     fn from(value: SettingsBuilder) -> Self {
         Self {
             environment_variable: value.environment_variable,
-            enabled: value.enabled,
             default_level: value.default_level,
+            enabled: value.enabled,
         }
     }
 }
@@ -110,13 +110,13 @@ mod test {
     fn builds_settings() {
         let expected = Settings {
             environment_variable: "hello",
-            enabled: true,
             default_level: LevelFilter::DEBUG,
+            enabled: true,
         };
         let result = Settings::builder()
-            .enabled(true)
-            .env_var("hello")
+            .environment_variable("hello")
             .default_level(LevelFilter::DEBUG)
+            .enabled(true)
             .build();
 
         assert_eq!(expected, result);

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

@@ -47,13 +47,13 @@ impl CommonSettings for OtlpLogSettings {
         self.common_settings.environment_variable
     }
 
-    fn enabled(&self) -> bool {
-        self.common_settings.enabled
-    }
-
     fn default_level(&self) -> LevelFilter {
         self.common_settings.default_level
     }
+
+    fn enabled(&self) -> bool {
+        self.common_settings.enabled
+    }
 }
 
 #[cfg(test)]
@@ -67,14 +67,14 @@ mod test {
         let expected = OtlpLogSettings {
             common_settings: Settings {
                 environment_variable: "hello",
-                enabled: true,
                 default_level: LevelFilter::DEBUG,
+                enabled: true,
             },
         };
         let result = Settings::builder()
-            .enabled(true)
-            .env_var("hello")
+            .environment_variable("hello")
             .default_level(LevelFilter::DEBUG)
+            .enabled(true)
             .otlp_log_settings_builder()
             .build();
 

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

@@ -47,13 +47,13 @@ impl CommonSettings for OtlpTraceSettings {
         self.common_settings.environment_variable
     }
 
-    fn enabled(&self) -> bool {
-        self.common_settings.enabled
-    }
-
     fn default_level(&self) -> LevelFilter {
         self.common_settings.default_level
     }
+
+    fn enabled(&self) -> bool {
+        self.common_settings.enabled
+    }
 }
 
 #[cfg(test)]
@@ -67,14 +67,14 @@ mod test {
         let expected = OtlpTraceSettings {
             common_settings: Settings {
                 environment_variable: "hello",
-                enabled: true,
                 default_level: LevelFilter::DEBUG,
+                enabled: true,
             },
         };
         let result = Settings::builder()
-            .enabled(true)
-            .env_var("hello")
+            .environment_variable("hello")
             .default_level(LevelFilter::DEBUG)
+            .enabled(true)
             .otlp_trace_settings_builder()
             .build();