Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 161
Fix log-facade logging and clarify max level#454
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -106,18 +106,18 @@ pub trait LogWriter: Send + Sync { | ||
| /// Defines a writer for [`Logger`]. | ||
| pub(crate) enum Writer { | ||
| /// Writes logs to the file system. | ||
| FileWriter { file_path: String, level: LogLevel }, | ||
| FileWriter { file_path: String, max_log_level: LogLevel }, | ||
| /// Forwards logs to the `log` facade. | ||
| LogFacadeWriter { level: LogLevel }, | ||
| LogFacadeWriter { max_log_level: LogLevel }, | ||
| /// Forwards logs to a custom writer. | ||
| CustomWriter(Arc<dyn LogWriter>), | ||
| } | ||
| impl LogWriter for Writer { | ||
| fn log(&self, record: LogRecord) { | ||
| match self { | ||
| Writer::FileWriter { file_path, level } => { | ||
| if record.level < *level { | ||
| Writer::FileWriter { file_path, max_log_level } => { | ||
| if record.level < *max_log_level { | ||
tnull marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| return; | ||
| } | ||
| @@ -138,28 +138,24 @@ impl LogWriter for Writer { | ||
| .write_all(log.as_bytes()) | ||
| .expect("Failed to write to log file") | ||
| }, | ||
| Writer::LogFacadeWriter { level } => { | ||
| Writer::LogFacadeWriter { max_log_level } => { | ||
| if record.level < *max_log_level { | ||
| return; | ||
| } | ||
| macro_rules! log_with_level { | ||
| ($log_level:expr, $($args:tt)*) => { | ||
| ($log_level:expr, $target: expr, $($args:tt)*) => { | ||
| match $log_level { | ||
| LogLevel::Gossip | LogLevel::Trace => trace!($($args)*), | ||
| LogLevel::Debug => debug!($($args)*), | ||
| LogLevel::Info => info!($($args)*), | ||
| LogLevel::Warn => warn!($($args)*), | ||
| LogLevel::Error => error!($($args)*), | ||
| LogLevel::Gossip | LogLevel::Trace => trace!(target: $target, $($args)*), | ||
| LogLevel::Debug => debug!(target: $target, $($args)*), | ||
| LogLevel::Info => info!(target: $target, $($args)*), | ||
| LogLevel::Warn => warn!(target: $target, $($args)*), | ||
| LogLevel::Error => error!(target: $target, $($args)*), | ||
| } | ||
| }; | ||
| } | ||
| log_with_level!( | ||
| level, | ||
| "{} {:<5} [{}:{}] {}", | ||
| Utc::now().format("%Y-%m-%d %H:%M:%S"), | ||
| record.level, | ||
| record.module_path, | ||
| record.line, | ||
| record.args | ||
| ) | ||
| let target = format!("[{}:{}]", record.module_path, record.line); | ||
| log_with_level!(record.level, &target, " {}", record.args) | ||
| }, | ||
| Writer::CustomWriter(custom_logger) => custom_logger.log(record), | ||
| } | ||
| @@ -174,7 +170,7 @@ pub(crate) struct Logger { | ||
| impl Logger { | ||
| /// Creates a new logger with a filesystem writer. The parameters to this function | ||
| /// are the path to the log file, and the log level. | ||
| pub fn new_fs_writer(file_path: String, level: LogLevel) -> Result<Self, ()> { | ||
| pub fn new_fs_writer(file_path: String, max_log_level: LogLevel) -> Result<Self, ()> { | ||
| if let Some(parent_dir) = Path::new(&file_path).parent() { | ||
| fs::create_dir_all(parent_dir) | ||
| .map_err(|e| eprintln!("ERROR: Failed to create log parent directory: {}", e))?; | ||
| @@ -187,11 +183,11 @@ impl Logger { | ||
| .map_err(|e| eprintln!("ERROR: Failed to open log file: {}", e))?; | ||
| } | ||
| Ok(Self { writer: Writer::FileWriter { file_path, level } }) | ||
| Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } }) | ||
| } | ||
| pub fn new_log_facade(level: LogLevel) -> Self { | ||
| Self { writer: Writer::LogFacadeWriter { level } } | ||
| pub fn new_log_facade(max_log_level: LogLevel) -> Self { | ||
| Self { writer: Writer::LogFacadeWriter { max_log_level } } | ||
| } | ||
| pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self { | ||
| @@ -202,14 +198,14 @@ impl Logger { | ||
| impl LdkLogger for Logger { | ||
| fn log(&self, record: LdkRecord) { | ||
| match &self.writer { | ||
| Writer::FileWriter { file_path: _, level } => { | ||
| if record.level < *level { | ||
| Writer::FileWriter { file_path: _, max_log_level } => { | ||
| if record.level < *max_log_level { | ||
| return; | ||
| } | ||
| self.writer.log(record.into()); | ||
| }, | ||
| Writer::LogFacadeWriter { level } => { | ||
| if record.level < *level { | ||
| Writer::LogFacadeWriter { max_log_level } => { | ||
| if record.level < *max_log_level { | ||
| return; | ||
| } | ||
| self.writer.log(record.into()); | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing that I noticed about the log facade is that you can set log level GOSSIP, but that isn't visible anymore after this PR. The standard log only knows TRACE of course. Not a problem I think?
And perhaps some explanation on how the
RUST_LOGenv var interacts with this log level would be helpful too. It wasn't very clear to me how that works. Maybe there is a way to setRUST_LOGprogrammatically?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think it's not super important. We could consider adding something special in the
targetor message itself, but I'd wait for a user to complain about it. So far, I assume it's fine to squash TRACE and GOSSIP together in this case.Ah,
RUST_LOGis entirely out-of-scope here, as it's a special behavior ofenv_logger, which is just one of the backends for thelogfacade.env_loggerusers simply need to read their docs and discover that it's mandatory to setRUST_LOG(see https://docs.rs/env_logger/latest/env_logger/#enabling-logging).