Skip to content

Commit 848874d

Browse files
TechassiTechassi
committed
wip: Make builder functions take Option
1 parent b8fe43f commit 848874d

File tree

6 files changed

+227
-197
lines changed

6 files changed

+227
-197
lines changed

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

Lines changed: 112 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -218,9 +218,9 @@ pub enum Error {
218218
pub struct Tracing {
219219
service_name: &'static str,
220220
console_log_settings: ConsoleLogSettings,
221-
file_log_settings: FileLogSettings,
222-
otlp_log_settings: OtlpLogSettings,
223-
otlp_trace_settings: OtlpTraceSettings,
221+
file_log_settings: Option<FileLogSettings>,
222+
otlp_log_settings: Option<OtlpLogSettings>,
223+
otlp_trace_settings: Option<OtlpTraceSettings>,
224224
logger_provider: Option<LoggerProvider>,
225225
}
226226

@@ -239,30 +239,32 @@ impl Tracing {
239239
pub fn init(mut self) -> Result<Tracing> {
240240
let mut layers: Vec<Box<dyn Layer<Registry> + Sync + Send>> = Vec::new();
241241

242-
if self.console_log_settings.enabled {
242+
if let ConsoleLogSettings::Enabled {
243+
common_settings,
244+
log_format: _,
245+
} = &self.console_log_settings
246+
{
243247
let env_filter_layer = env_filter_builder(
244-
self.console_log_settings
245-
.common_settings
246-
.environment_variable,
247-
self.console_log_settings.default_level,
248+
common_settings.environment_variable,
249+
common_settings.default_level,
248250
);
249251
let console_output_layer =
250252
tracing_subscriber::fmt::layer().with_filter(env_filter_layer);
251253
layers.push(console_output_layer.boxed());
252254
}
253255

254-
if self.file_log_settings.enabled {
256+
if let Some(file_log_settings) = &self.file_log_settings {
255257
let env_filter_layer = env_filter_builder(
256-
self.file_log_settings.common_settings.environment_variable,
257-
self.file_log_settings.default_level,
258+
file_log_settings.common_settings.environment_variable,
259+
file_log_settings.default_level,
258260
);
259261

260262
let file_appender = RollingFileAppender::builder()
261263
.rotation(Rotation::HOURLY)
262264
.filename_prefix(self.service_name.to_string())
263265
.filename_suffix("tracing-rs.json")
264266
.max_log_files(6)
265-
.build(&self.file_log_settings.file_log_dir)
267+
.build(&file_log_settings.file_log_dir)
266268
.context(InitRollingFileAppenderSnafu)?;
267269

268270
layers.push(
@@ -274,10 +276,10 @@ impl Tracing {
274276
);
275277
}
276278

277-
if self.otlp_log_settings.enabled {
279+
if let Some(otlp_log_settings) = &self.otlp_log_settings {
278280
let env_filter_layer = env_filter_builder(
279-
self.otlp_log_settings.environment_variable,
280-
self.otlp_log_settings.default_level,
281+
otlp_log_settings.environment_variable,
282+
otlp_log_settings.default_level,
281283
)
282284
// TODO (@NickLarsenNZ): Remove this directive once https://github.com/open-telemetry/opentelemetry-rust/issues/761 is resolved
283285
.add_directive("h2=off".parse().expect("invalid directive"));
@@ -302,12 +304,10 @@ impl Tracing {
302304
self.logger_provider = Some(otel_log);
303305
}
304306

305-
if self.otlp_trace_settings.enabled {
307+
if let Some(otlp_trace_settings) = &self.otlp_trace_settings {
306308
let env_filter_layer = env_filter_builder(
307-
self.otlp_trace_settings
308-
.common_settings
309-
.environment_variable,
310-
self.otlp_trace_settings.default_level,
309+
otlp_trace_settings.common_settings.environment_variable,
310+
otlp_trace_settings.default_level,
311311
)
312312
// TODO (@NickLarsenNZ): Remove this directive once https://github.com/open-telemetry/opentelemetry-rust/issues/761 is resolved
313313
.add_directive("h2=off".parse().expect("invalid directive"));
@@ -355,12 +355,12 @@ impl Tracing {
355355
impl Drop for Tracing {
356356
fn drop(&mut self) {
357357
tracing::debug!(
358-
opentelemetry.tracing.enabled = self.otlp_trace_settings.enabled,
359-
opentelemetry.logger.enabled = self.otlp_log_settings.enabled,
358+
opentelemetry.tracing.enabled = self.otlp_trace_settings.is_some(),
359+
opentelemetry.logger.enabled = self.otlp_log_settings.is_some(),
360360
"shutting down opentelemetry OTLP providers"
361361
);
362362

363-
if self.otlp_trace_settings.enabled {
363+
if self.otlp_trace_settings.is_some() {
364364
// NOTE (@NickLarsenNZ): This might eventually be replaced with something like SdkMeterProvider::shutdown(&self)
365365
// as has been done with the LoggerProvider (further below)
366366
// see: https://github.com/open-telemetry/opentelemetry-rust/pull/1412/files#r1409608679
@@ -434,9 +434,9 @@ impl BuilderState for builder_state::Config {}
434434
pub struct TracingBuilder<S: BuilderState> {
435435
service_name: Option<&'static str>,
436436
console_log_settings: ConsoleLogSettings,
437-
otlp_log_settings: OtlpLogSettings,
438-
otlp_trace_settings: OtlpTraceSettings,
439-
file_log_settings: FileLogSettings,
437+
otlp_log_settings: Option<OtlpLogSettings>,
438+
otlp_trace_settings: Option<OtlpTraceSettings>,
439+
file_log_settings: Option<FileLogSettings>,
440440

441441
/// Allow the generic to be used (needed for impls).
442442
_marker: std::marker::PhantomData<S>,
@@ -486,7 +486,7 @@ impl TracingBuilder<builder_state::Config> {
486486
TracingBuilder {
487487
service_name: self.service_name,
488488
console_log_settings: self.console_log_settings,
489-
file_log_settings: file_log_settings.into(),
489+
file_log_settings: Some(file_log_settings.into()),
490490
otlp_log_settings: self.otlp_log_settings,
491491
otlp_trace_settings: self.otlp_trace_settings,
492492
_marker: self._marker,
@@ -507,7 +507,7 @@ impl TracingBuilder<builder_state::Config> {
507507
TracingBuilder {
508508
service_name: self.service_name,
509509
console_log_settings: self.console_log_settings,
510-
otlp_log_settings: otlp_log_settings.into(),
510+
otlp_log_settings: Some(otlp_log_settings.into()),
511511
otlp_trace_settings: self.otlp_trace_settings,
512512
file_log_settings: self.file_log_settings,
513513
_marker: self._marker,
@@ -529,7 +529,7 @@ impl TracingBuilder<builder_state::Config> {
529529
service_name: self.service_name,
530530
console_log_settings: self.console_log_settings,
531531
otlp_log_settings: self.otlp_log_settings,
532-
otlp_trace_settings: otlp_trace_settings.into(),
532+
otlp_trace_settings: Some(otlp_trace_settings.into()),
533533
file_log_settings: self.file_log_settings,
534534
_marker: self._marker,
535535
}
@@ -586,74 +586,71 @@ mod test {
586586
Settings::builder()
587587
.with_environment_variable("ABC_A")
588588
.with_default_level(LevelFilter::TRACE)
589-
.enabled(true)
590589
.build(),
591590
)
592591
.with_console_output(
593592
Settings::builder()
594593
.with_environment_variable("ABC_B")
595594
.with_default_level(LevelFilter::DEBUG)
596-
.enabled(true)
597595
.build(),
598596
)
599597
.build();
600598

601599
assert_eq!(
602600
trace_guard.console_log_settings,
603-
ConsoleLogSettings {
601+
ConsoleLogSettings::Enabled {
604602
common_settings: Settings {
605-
enabled: true,
606603
environment_variable: "ABC_B",
607604
default_level: LevelFilter::DEBUG
608605
},
609606
log_format: Default::default()
610607
}
611608
);
612-
assert!(!trace_guard.otlp_log_settings.enabled);
613-
assert!(!trace_guard.otlp_trace_settings.enabled);
614-
}
615-
616-
#[test]
617-
fn builder_with_console_output_double() {
618-
let trace_guard = Tracing::builder()
619-
.service_name("test")
620-
.with_console_output(("ABC_A", LevelFilter::TRACE))
621-
.build();
622609

623-
assert_eq!(
624-
trace_guard.console_log_settings,
625-
ConsoleLogSettings {
626-
common_settings: Settings {
627-
environment_variable: "ABC_A",
628-
default_level: LevelFilter::TRACE,
629-
enabled: true
630-
},
631-
log_format: Default::default()
632-
}
633-
)
610+
assert!(trace_guard.otlp_log_settings.is_none());
611+
assert!(trace_guard.otlp_trace_settings.is_none());
634612
}
635613

636-
#[rstest]
637-
#[case(false)]
638-
#[case(true)]
639-
fn builder_with_console_output_triple(#[case] enabled: bool) {
640-
let trace_guard = Tracing::builder()
641-
.service_name("test")
642-
.with_console_output(("ABC_A", LevelFilter::TRACE, enabled))
643-
.build();
644-
645-
assert_eq!(
646-
trace_guard.console_log_settings,
647-
ConsoleLogSettings {
648-
common_settings: Settings {
649-
environment_variable: "ABC_A",
650-
default_level: LevelFilter::TRACE,
651-
enabled
652-
},
653-
log_format: Default::default()
654-
}
655-
)
656-
}
614+
// #[test]
615+
// fn builder_with_console_output_double() {
616+
// let trace_guard = Tracing::builder()
617+
// .service_name("test")
618+
// .with_console_output(("ABC_A", LevelFilter::TRACE))
619+
// .build();
620+
621+
// assert_eq!(
622+
// trace_guard.console_log_settings,
623+
// ConsoleLogSettings {
624+
// common_settings: Settings {
625+
// environment_variable: "ABC_A",
626+
// default_level: LevelFilter::TRACE,
627+
// },
628+
// log_format: Default::default()
629+
// }
630+
// )
631+
// }
632+
633+
// #[rstest]
634+
// #[case(false)]
635+
// #[case(true)]
636+
// fn builder_with_console_output_triple(#[case] enabled: bool) {
637+
// let trace_guard = Tracing::builder()
638+
// .service_name("test")
639+
// .with_console_output(("ABC_A", LevelFilter::TRACE, enabled))
640+
// .build();
641+
642+
// assert_eq!(
643+
// trace_guard.console_log_settings,
644+
// ConsoleLogSettings {
645+
// common_settings: Settings {
646+
// environment_variable: "ABC_A",
647+
// default_level: LevelFilter::TRACE,
648+
// enabled
649+
// },
650+
// log_format: Default::default()
651+
// }
652+
// )
653+
// }
657654

658655
#[test]
659656
fn builder_with_all() {
@@ -663,38 +660,33 @@ mod test {
663660
Settings::builder()
664661
.with_environment_variable("ABC_CONSOLE")
665662
.with_default_level(LevelFilter::INFO)
666-
.enabled(true)
667663
.build(),
668664
)
669665
.with_file_output(
670666
Settings::builder()
671667
.with_environment_variable("ABC_FILE")
672668
.with_default_level(LevelFilter::INFO)
673-
.enabled(true)
674669
.file_log_settings_builder(PathBuf::from("/abc_file_dir"))
675670
.build(),
676671
)
677672
.with_otlp_log_exporter(
678673
Settings::builder()
679674
.with_environment_variable("ABC_OTLP_LOG")
680675
.with_default_level(LevelFilter::DEBUG)
681-
.enabled(true)
682676
.build(),
683677
)
684678
.with_otlp_trace_exporter(
685679
Settings::builder()
686680
.with_environment_variable("ABC_OTLP_TRACE")
687681
.with_default_level(LevelFilter::TRACE)
688-
.enabled(true)
689682
.build(),
690683
)
691684
.build();
692685

693686
assert_eq!(
694687
trace_guard.console_log_settings,
695-
ConsoleLogSettings {
688+
ConsoleLogSettings::Enabled {
696689
common_settings: Settings {
697-
enabled: true,
698690
environment_variable: "ABC_CONSOLE",
699691
default_level: LevelFilter::INFO
700692
},
@@ -703,34 +695,64 @@ mod test {
703695
);
704696
assert_eq!(
705697
trace_guard.file_log_settings,
706-
FileLogSettings {
698+
Some(FileLogSettings {
707699
common_settings: Settings {
708-
enabled: true,
709700
environment_variable: "ABC_FILE",
710701
default_level: LevelFilter::INFO
711702
},
712703
file_log_dir: PathBuf::from("/abc_file_dir")
713-
}
704+
})
714705
);
715706
assert_eq!(
716707
trace_guard.otlp_log_settings,
717-
OtlpLogSettings {
708+
Some(OtlpLogSettings {
718709
common_settings: Settings {
719-
enabled: true,
720710
environment_variable: "ABC_OTLP_LOG",
721711
default_level: LevelFilter::DEBUG
722712
},
723-
}
713+
})
724714
);
725715
assert_eq!(
726716
trace_guard.otlp_trace_settings,
727-
OtlpTraceSettings {
717+
Some(OtlpTraceSettings {
728718
common_settings: Settings {
729-
enabled: true,
730719
environment_variable: "ABC_OTLP_TRACE",
731720
default_level: LevelFilter::TRACE
732721
}
733-
}
722+
})
723+
);
724+
}
725+
726+
#[test]
727+
fn builder_with_options() {
728+
let enable_console_output = true;
729+
let enable_otlp_trace = true;
730+
let enable_otlp_log = false;
731+
732+
let tracing_builder = Tracing::builder()
733+
.service_name("test")
734+
.with_console_output(enable_console_output.then(|| {
735+
Settings::builder()
736+
.with_environment_variable("ABC_CONSOLE")
737+
.build()
738+
}))
739+
.with_otlp_trace_exporter(enable_otlp_trace.then(|| {
740+
Settings::builder()
741+
.with_environment_variable("ABC_OTLP_TRACE")
742+
.build()
743+
}))
744+
.with_otlp_log_exporter(enable_otlp_log.then(|| {
745+
Settings::builder()
746+
.with_environment_variable("ABC_OTLP_LOG")
747+
.build()
748+
}))
749+
.build();
750+
751+
matches!(
752+
tracing_builder.console_log_settings,
753+
ConsoleLogSettings::Enabled { .. }
734754
);
755+
assert!(tracing_builder.otlp_trace_settings.is_some());
756+
// assert!(tracing_builder.otlp_log_settings.is_none());
735757
}
736758
}

0 commit comments

Comments
 (0)