Feature #21133: [ruby/logger] Add an option to disable writing the header when creating a new log file

• Status: Closed
• Assignee: -
• Target version: -

[viralpraxis (Iaroslav Kurbatov)]

Creating a logger automatically writes a hardcoded header comment ("# Logfile created on ..."):
https://github.com/ruby/logger/blob/0eb10f2d278435899ce9055c98eb5b53caa0092a/lib/logger/log_device.rb#L149-L153

As far as I can see, it helps to verify that logdev is writable as early as possible (rather than on the first log entry) and it also serves as a useful indicator of which program created the logfile.
However, this header can introduce unnecessary complexity is some use-cases -- especially when working with third-party tools that need to ignore these lines.
I think it might make sense to add a new configuration option (skip_header) which will be false by default so the changes are backward-compatible.

Proposed implementation: https://github.com/ruby/logger/pull/119

[viralpraxis (Iaroslav Kurbatov)]

viralpraxis (Iaroslav Kurbatov) wrote:

Creating a logger automatically writes a hardcoded header comment ("# Logfile created on ..."):
https://github.com/ruby/logger/blob/0eb10f2d278435899ce9055c98eb5b53caa0092a/lib/logger/log_device.rb#L149-L153

As far as I can see, it helps to verify that logdev is writable as early as possible (rather than on the first log entry) and it also serves as a useful indicator of which program created the logfile.
However, this header can introduce unnecessary complexity is some use-cases -- especially when working with third-party tools that need to ignore these lines.
I think it might make sense to add a new configuration option (skip_header) which will be false by default so the changes are backward-compatible.

Proposed implementation: https://github.com/ruby/logger/pull/119

This one can be closed since the PR was merged.

[jeremyevans0 (Jeremy Evans)]

• Status changed from Open to Closed