Skip to content

Commit dbe3719

Browse files
committed
refactor(stackable-telemetry): Prefix builder methods with with_.
I avoided prefixing `enabled()` because it sounds strange.
1 parent 41157cc commit dbe3719

File tree

5 files changed

+24
-18
lines changed

5 files changed

+24
-18
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -447,15 +447,15 @@ mod test {
447447
.service_name("test")
448448
.with_console_output(
449449
Settings::builder()
450-
.environment_variable("ABC_A")
451-
.default_level(LevelFilter::TRACE)
450+
.with_environment_variable("ABC_A")
451+
.with_default_level(LevelFilter::TRACE)
452452
.enabled(true)
453453
.build(),
454454
)
455455
.with_console_output(
456456
Settings::builder()
457-
.environment_variable("ABC_B")
458-
.default_level(LevelFilter::DEBUG)
457+
.with_environment_variable("ABC_B")
458+
.with_default_level(LevelFilter::DEBUG)
459459
.enabled(true)
460460
.build(),
461461
)
@@ -482,8 +482,8 @@ mod test {
482482
.service_name("test")
483483
.with_console_output(
484484
Settings::builder()
485-
.environment_variable("ABC_CONSOLE")
486-
.default_level(LevelFilter::INFO)
485+
.with_environment_variable("ABC_CONSOLE")
486+
.with_default_level(LevelFilter::INFO)
487487
.enabled(true)
488488
.build(),
489489
)

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pub struct ConsoleLogSettingsBuilder {
2222
}
2323

2424
impl ConsoleLogSettingsBuilder {
25-
pub fn log_format(mut self, format: Format) -> Self {
25+
pub fn with_log_format(mut self, format: Format) -> Self {
2626
self.log_format = format;
2727
self
2828
}
@@ -108,11 +108,11 @@ mod test {
108108
log_format: Format::Plain,
109109
};
110110
let result = Settings::builder()
111-
.environment_variable("hello")
112-
.default_level(LevelFilter::DEBUG)
111+
.with_environment_variable("hello")
112+
.with_default_level(LevelFilter::DEBUG)
113113
.enabled(true)
114114
.console_log_settings_builder()
115-
.log_format(Format::Plain)
115+
.with_log_format(Format::Plain)
116116
// color
117117
.build();
118118

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,22 @@ impl Build<Settings> for SettingsBuilder {
5454
}
5555

5656
impl SettingsBuilder {
57-
pub fn environment_variable(mut self, name: &'static str) -> Self {
57+
pub fn with_environment_variable(mut self, name: &'static str) -> Self {
5858
self.environment_variable = name;
5959
self
6060
}
6161

62-
pub fn default_level(mut self, level: impl Into<LevelFilter>) -> Self {
62+
pub fn with_default_level(mut self, level: impl Into<LevelFilter>) -> Self {
6363
self.default_level = level.into();
6464
self
6565
}
6666

67+
// TODO (@NickLarsenNZ): Currently this has to be called to enable the
68+
// subscriber. Eventually it should become optional, and default to on (if
69+
// settings are supplied). Therefore, the fields in TracingBuilder to hold
70+
// the subscriber settings should become Option<T> so that the subscriber is
71+
// disabled when not configured, is enabled when configured, while still
72+
// controllable through this function. Then this can be renamed to `with_enabled`
6773
pub fn enabled(mut self, enabled: bool) -> Self {
6874
self.enabled = enabled;
6975
self
@@ -139,8 +145,8 @@ mod test {
139145
enabled: true,
140146
};
141147
let result = Settings::builder()
142-
.environment_variable("hello")
143-
.default_level(LevelFilter::DEBUG)
148+
.with_environment_variable("hello")
149+
.with_default_level(LevelFilter::DEBUG)
144150
.enabled(true)
145151
.build();
146152

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ mod test {
9090
},
9191
};
9292
let result = Settings::builder()
93-
.environment_variable("hello")
94-
.default_level(LevelFilter::DEBUG)
93+
.with_environment_variable("hello")
94+
.with_default_level(LevelFilter::DEBUG)
9595
.enabled(true)
9696
.otlp_log_settings_builder()
9797
.build();

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ mod test {
9090
},
9191
};
9292
let result = Settings::builder()
93-
.environment_variable("hello")
94-
.default_level(LevelFilter::DEBUG)
93+
.with_environment_variable("hello")
94+
.with_default_level(LevelFilter::DEBUG)
9595
.enabled(true)
9696
.otlp_trace_settings_builder()
9797
.build();

0 commit comments

Comments
 (0)