Extract logger setup into it's own module and implement `ShortTargetFormatter` by luisschwab · Pull Request #902 · getfloresta/Floresta

luisschwab · 2026-03-18T18:46:05Z

Closes #561

This PR extracts the logger setup function into it's own module, does some minor logging-related cleanup on main.rs, and implements a custom log formatter that replaces the full module path with a custom alias when the log level is Level::INFO or higher.

Logs on the default log level go from

2026-04-07 16:24:38  INFO floresta_wire::p2p_wire::node::chain_selector_ctx: Downloading headers from peer=9 at height=1 hash=00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048

to

2026-04-07 16:22:30  INFO wire: Downloading headers from peer=10 at height=1 hash=00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048

Changelog

- Move the logger setup function into it's own module
- Rename it from `init_logging` to `start_logger`
- Minor logging-related cleanup on `main.rs`
- Implement a `ShortTargetFormatter` for formatting module paths
- Log milliseconds when level `>= Level::DEBUG`

luisschwab · 2026-03-31T15:40:28Z

I'll update this so we only log a short module identifier when RUST_LOG >= debug.

- Move the logger setup function into it's own module. - Rename it from `init_logging` to `start_logger`

bin/florestad/src/logger.rs

luisschwab · 2026-04-06T16:42:57Z

Pushed a340696 addressing @Davidson-Souza's reviews.

Also moves the exit on error on logger init from main.rs to logger.rs.

Vedd-Patel

also test for ShortTargetFormatter is not there
should i add a unit test for short_target mapping and formatter-level behavior under different verbosity\filter setups?

Vedd-Patel · 2026-04-07T13:20:12Z

bin/florestad/src/logger.rs

+        let file_path = format!("{}/{}", data_directory, LOG_FILE);
+
+        // Validate the log file path (`<data_directory>/<LOG_FILE>`).
+        let _ = fs::OpenOptions::new()


start_logger exits the process inside .map_err(...) instead of returning io::Error despite exposing a Result API
this mixes concerns and makes the signature misleading
not getting if its correct or not as iam not getting the correct way to handle this pls let me know about this one!

Vedd-Patel · 2026-04-07T13:20:23Z

bin/florestad/src/main.rs

-            });
-    }
+    // The guard must stay alive until the end of `main` to flush file logs when dropped.
+    let _logger_guard = start_logger(


start_logger(...) returns Result<Option<WorkerGuard>, io::Error> but the result is not handled
assigned to _logger_guard and dropped
any future recoverable errors would be silently ignored!
handling the results of thes explicitly will help ig
something like -

let _logger_guard = start_logger(...).unwrap_or_else(|e| { eprintln!(...); exit(1); });

keep _logger_guard as Option<WorkerGuard>

Davidson-Souza

last nit

bin/florestad/src/logger.rs

The `ShortTargetFormatter` will match and replace the full module paths with short prefixes, when the log level is `Level::INFO` or higher. Otherwise, the full module path is kept.

luisschwab · 2026-04-07T17:17:00Z

@Davidson-Souza fixed!

Davidson-Souza

ACK 8d292ab

jaoleal · 2026-04-07T18:16:00Z

ACK 8d292ab

luisschwab · 2026-04-08T14:06:42Z

We should also log milliseconds when in debug

Davidson-Souza · 2026-04-08T16:22:18Z

Since you're touching logs, what about making log to file default on? This is the standard between implementations afaik

luisschwab · 2026-04-08T16:36:10Z

Since you're touching logs, what about making log to file default on? This is the standard between implementations afaik

Agreed, but this can be a follow up. We should also allow specifying a log path, like Bitcoin Core:

-debuglogfile=<file>
    Specify location of debug log file (default: debug.log). Relative paths
    will be prefixed by a net-specific datadir location. Pass
    -nodebuglogfile to disable writing the log to a file.

Opened #947 for this

luisschwab · 2026-04-08T20:09:17Z

@Davidson-Souza can you retrigger the no-std job? It's stuck

Davidson-Souza

ACK 78692d3

luisschwab self-assigned this Mar 18, 2026

luisschwab added the code quality Generally improves code readability and maintainability label Mar 18, 2026

luisschwab added this to the Q2/2026 milestone Mar 18, 2026

luisschwab requested a review from csgui March 20, 2026 18:37

chore(florestad)!: extract the logger into a module

e327507

- Move the logger setup function into it's own module. - Rename it from `init_logging` to `start_logger`

luisschwab force-pushed the chore/extract-logger-into-a-module branch from 72cebb1 to eed6c95 Compare April 4, 2026 00:21

luisschwab requested review from jaoleal and moisesPompilio April 4, 2026 00:41

Davidson-Souza reviewed Apr 6, 2026

View reviewed changes

luisschwab changed the title ~~Extract logger setup into it's own module~~ Extract logger setup into it's own module and implement ShortTargetFormatter Apr 6, 2026

luisschwab mentioned this pull request Apr 6, 2026

[Enhancement] Logs: Only log the module name #561

Open

luisschwab force-pushed the chore/extract-logger-into-a-module branch from eed6c95 to a340696 Compare April 6, 2026 16:34

luisschwab requested a review from Davidson-Souza April 6, 2026 16:35

luisschwab force-pushed the chore/extract-logger-into-a-module branch from a340696 to 8a45586 Compare April 6, 2026 16:45

Vedd-Patel reviewed Apr 7, 2026

View reviewed changes

Davidson-Souza added this to Floresta Apr 7, 2026

github-project-automation bot moved this to Backlog in Floresta Apr 7, 2026

Davidson-Souza moved this from Backlog to Needs review in Floresta Apr 7, 2026

Davidson-Souza requested changes Apr 7, 2026

View reviewed changes

bin/florestad/src/logger.rs Show resolved Hide resolved

feat(florestad): implement a short log formatter

8d292ab

The `ShortTargetFormatter` will match and replace the full module paths with short prefixes, when the log level is `Level::INFO` or higher. Otherwise, the full module path is kept.

luisschwab force-pushed the chore/extract-logger-into-a-module branch from 8a45586 to 8d292ab Compare April 7, 2026 16:15

luisschwab requested a review from Davidson-Souza April 7, 2026 16:15

Davidson-Souza approved these changes Apr 7, 2026

View reviewed changes

jaoleal approved these changes Apr 7, 2026

View reviewed changes

luisschwab requested a review from Davidson-Souza April 8, 2026 14:28

luisschwab requested a review from jaoleal April 8, 2026 14:28

feat(florestad): log milliseconds when level is debug or higher

78692d3

luisschwab force-pushed the chore/extract-logger-into-a-module branch from a499b4a to 78692d3 Compare April 8, 2026 14:45

Davidson-Souza approved these changes Apr 8, 2026

View reviewed changes

luisschwab requested review from JoseSK999 and jaoleal and removed request for csgui, jaoleal and moisesPompilio April 10, 2026 01:07

Conversation

luisschwab commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Uh oh!

luisschwab commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

luisschwab commented Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Vedd-Patel left a comment

Choose a reason for hiding this comment

Uh oh!

Vedd-Patel Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Vedd-Patel Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Davidson-Souza left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

luisschwab commented Apr 7, 2026

Uh oh!

Davidson-Souza left a comment

Choose a reason for hiding this comment

Uh oh!

jaoleal commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

luisschwab commented Apr 8, 2026

Uh oh!

Davidson-Souza commented Apr 8, 2026

Uh oh!

luisschwab commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

luisschwab commented Apr 8, 2026

Uh oh!

Davidson-Souza left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

luisschwab commented Mar 18, 2026 •

edited

Loading

luisschwab commented Mar 31, 2026 •

edited

Loading

luisschwab commented Apr 6, 2026 •

edited

Loading

jaoleal commented Apr 7, 2026 •

edited

Loading

luisschwab commented Apr 8, 2026 •

edited

Loading