Skip to content

Commit eb74862

Browse files
committed
Rename level argument to max_log_level
.. for clarity
1 parent b0f4443 commit eb74862

File tree

3 files changed

+38
-28
lines changed

3 files changed

+38
-28
lines changed

bindings/ldk_node.udl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ interface Builder {
6060
void set_gossip_source_rgs(string rgs_server_url);
6161
void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
6262
void set_storage_dir_path(string storage_dir_path);
63-
void set_filesystem_logger(string? log_file_path, LogLevel? log_level);
64-
void set_log_facade_logger(LogLevel log_level);
63+
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
64+
void set_log_facade_logger(LogLevel max_log_level);
6565
void set_custom_logger(LogWriter log_writer);
6666
void set_network(Network network);
6767
[Throws=BuildError]

src/builder.rs

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -111,20 +111,22 @@ impl Default for LiquiditySourceConfig {
111111

112112
#[derive(Clone)]
113113
enum LogWriterConfig {
114-
File { log_file_path: Option<String>, log_level: Option<LogLevel> },
114+
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
115115
Log(LogLevel),
116116
Custom(Arc<dyn LogWriter>),
117117
}
118118

119119
impl std::fmt::Debug for LogWriterConfig {
120120
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
121121
match self {
122-
LogWriterConfig::File { log_level, log_file_path } => f
122+
LogWriterConfig::File { max_log_level, log_file_path } => f
123123
.debug_struct("LogWriterConfig")
124-
.field("log_level", log_level)
124+
.field("max_log_level", max_log_level)
125125
.field("log_file_path", log_file_path)
126126
.finish(),
127-
LogWriterConfig::Log(level) => f.debug_tuple("Log").field(level).finish(),
127+
LogWriterConfig::Log(max_log_level) => {
128+
f.debug_tuple("Log").field(max_log_level).finish()
129+
},
128130
LogWriterConfig::Custom(_) => {
129131
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
130132
},
@@ -331,19 +333,24 @@ impl NodeBuilder {
331333
///
332334
/// The `log_file_path` defaults to [`DEFAULT_LOG_FILENAME`] in the configured
333335
/// [`Config::storage_dir_path`] if set to `None`.
334-
/// The `log_level` defaults to [`DEFAULT_LOG_LEVEL`] if set to `None`.
336+
///
337+
/// If set, The `max_log_level` sets the maximum log level. Otherwise, the latter defaults
338+
/// defaults to [`DEFAULT_LOG_LEVEL`].
335339
///
336340
/// [`DEFAULT_LOG_FILENAME`]: crate::config::DEFAULT_LOG_FILENAME
337341
pub fn set_filesystem_logger(
338-
&mut self, log_file_path: Option<String>, log_level: Option<LogLevel>,
342+
&mut self, log_file_path: Option<String>, max_log_level: Option<LogLevel>,
339343
) -> &mut Self {
340-
self.log_writer_config = Some(LogWriterConfig::File { log_file_path, log_level });
344+
self.log_writer_config = Some(LogWriterConfig::File { log_file_path, max_log_level });
341345
self
342346
}
343347

344348
/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
345-
pub fn set_log_facade_logger(&mut self, log_level: LogLevel) -> &mut Self {
346-
self.log_writer_config = Some(LogWriterConfig::Log(log_level));
349+
///
350+
/// If set, The `max_log_level` sets the maximum log level. Otherwise, the latter defaults
351+
/// defaults to [`DEFAULT_LOG_LEVEL`].
352+
pub fn set_log_facade_logger(&mut self, max_log_level: LogLevel) -> &mut Self {
353+
self.log_writer_config = Some(LogWriterConfig::Log(max_log_level));
347354
self
348355
}
349356

@@ -1305,13 +1312,13 @@ fn setup_logger(
13051312
log_writer_config: &Option<LogWriterConfig>, config: &Config,
13061313
) -> Result<Arc<Logger>, BuildError> {
13071314
let logger = match log_writer_config {
1308-
Some(LogWriterConfig::File { log_file_path, log_level }) => {
1315+
Some(LogWriterConfig::File { log_file_path, max_log_level }) => {
13091316
let log_file_path = log_file_path
13101317
.clone()
13111318
.unwrap_or_else(|| format!("{}/{}", config.storage_dir_path, DEFAULT_LOG_FILENAME));
1312-
let log_level = log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
1319+
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
13131320

1314-
Logger::new_fs_writer(log_file_path, log_level)
1321+
Logger::new_fs_writer(log_file_path, max_log_level)
13151322
.map_err(|_| BuildError::LoggerSetupFailed)?
13161323
},
13171324
Some(LogWriterConfig::Log(log_level)) => Logger::new_log_facade(*log_level),

src/logger.rs

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -106,18 +106,18 @@ pub trait LogWriter: Send + Sync {
106106
/// Defines a writer for [`Logger`].
107107
pub(crate) enum Writer {
108108
/// Writes logs to the file system.
109-
FileWriter { file_path: String, level: LogLevel },
109+
FileWriter { file_path: String, max_log_level: LogLevel },
110110
/// Forwards logs to the `log` facade.
111-
LogFacadeWriter { level: LogLevel },
111+
LogFacadeWriter { max_log_level: LogLevel },
112112
/// Forwards logs to a custom writer.
113113
CustomWriter(Arc<dyn LogWriter>),
114114
}
115115

116116
impl LogWriter for Writer {
117117
fn log(&self, record: LogRecord) {
118118
match self {
119-
Writer::FileWriter { file_path, level } => {
120-
if record.level < *level {
119+
Writer::FileWriter { file_path, max_log_level } => {
120+
if record.level < *max_log_level {
121121
return;
122122
}
123123

@@ -138,7 +138,10 @@ impl LogWriter for Writer {
138138
.write_all(log.as_bytes())
139139
.expect("Failed to write to log file")
140140
},
141-
Writer::LogFacadeWriter { level } => {
141+
Writer::LogFacadeWriter { max_log_level } => {
142+
if record.level < *max_log_level {
143+
return;
144+
}
142145
macro_rules! log_with_level {
143146
($log_level:expr, $($args:tt)*) => {
144147
match $log_level {
@@ -152,7 +155,7 @@ impl LogWriter for Writer {
152155
}
153156

154157
log_with_level!(
155-
level,
158+
max_log_level,
156159
"{} {:<5} [{}:{}] {}",
157160
Utc::now().format("%Y-%m-%d %H:%M:%S"),
158161
record.level,
@@ -174,7 +177,7 @@ pub(crate) struct Logger {
174177
impl Logger {
175178
/// Creates a new logger with a filesystem writer. The parameters to this function
176179
/// are the path to the log file, and the log level.
177-
pub fn new_fs_writer(file_path: String, level: LogLevel) -> Result<Self, ()> {
180+
pub fn new_fs_writer(file_path: String, max_log_level: LogLevel) -> Result<Self, ()> {
178181
if let Some(parent_dir) = Path::new(&file_path).parent() {
179182
fs::create_dir_all(parent_dir)
180183
.map_err(|e| eprintln!("ERROR: Failed to create log parent directory: {}", e))?;
@@ -187,11 +190,11 @@ impl Logger {
187190
.map_err(|e| eprintln!("ERROR: Failed to open log file: {}", e))?;
188191
}
189192

190-
Ok(Self { writer: Writer::FileWriter { file_path, level } })
193+
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
191194
}
192195

193-
pub fn new_log_facade(level: LogLevel) -> Self {
194-
Self { writer: Writer::LogFacadeWriter { level } }
196+
pub fn new_log_facade(max_log_level: LogLevel) -> Self {
197+
Self { writer: Writer::LogFacadeWriter { max_log_level } }
195198
}
196199

197200
pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
@@ -202,14 +205,14 @@ impl Logger {
202205
impl LdkLogger for Logger {
203206
fn log(&self, record: LdkRecord) {
204207
match &self.writer {
205-
Writer::FileWriter { file_path: _, level } => {
206-
if record.level < *level {
208+
Writer::FileWriter { file_path: _, max_log_level } => {
209+
if record.level < *max_log_level {
207210
return;
208211
}
209212
self.writer.log(record.into());
210213
},
211-
Writer::LogFacadeWriter { level } => {
212-
if record.level < *level {
214+
Writer::LogFacadeWriter { max_log_level } => {
215+
if record.level < *max_log_level {
213216
return;
214217
}
215218
self.writer.log(record.into());

0 commit comments

Comments
 (0)