Expired
Milestone
Feb 20, 2023–May 5, 2023
Better Log Engine
Milestone ID: 2996678
Pipelining
Depends on: %Better node logs
Motivation
Objective: Refactoring log engine and remove deprecated libraries Key Result: lwt_log is removed from octez, colors are added to logs
Scope
The goal of this milestone is to refactor the log engine by
- removing of concurrent implementation of similar behaviors (lwt_log and sinks) ;
- removing lwt_log, a deprecated library ;
- improve UX by adding colors to logs thanks to the newly refactored engine.
Design
https://codimd.nomadic-labs.com/KV7p9WPOTI6AUenb1xINnQ
Work Breakdown
-
Follow XDG convention, e.g. $XDG_STATE_HOME/octez/logs/node/YYYY-MM-DD.log
(ornode-
) (#5155 (closed) !7849 (merged)) -
(days) Generate file with all event definitions and add guidelines (identifier and message with placeholders) (#5201 !7962) -
(days) Daily logs in the baker (#5259 (closed) !8232 (merged)) - (weeks) Lwt log removal (final MR !8073)
- (weeks) Replace lwt_log features
-
(days) Syslog (#5202 (closed) !8172 (merged)) -
(days) Nicer printer for sinks (#5203 !8173 (merged)) -
(days) URI typed builder (!8177 (merged)) -
(days) Config rules (#5204 (closed) !8178 (merged)) -
(days) Handle syslog in sinks (!8592 (merged))
-
-
(days) Design new stdout sink and set it by default + remove lwt_log library (#4900 !8073)
- (weeks) Replace lwt_log features
-
(days) Introduce colors into logs (#4583 !8685)
Future work:
-
fix external validator log files #4837 -
Homogenize between logs between node and external validator (!7837 (merged)) -
(days) Use different output files for external validator -
(days) make tezt read both files
-