Skip to content
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

[Feature #21133] Add skip_header option #119

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions lib/logger.rb
Original file line number Diff line number Diff line change
Expand Up @@ -577,11 +577,14 @@ def fatal!; self.level = FATAL; end
# - +reraise_write_errors+: An array of exception classes, which will
# be reraised if there is an error when writing to the log device.
# The default is to swallow all exceptions raised.
# - +skip_header+: If +true+, prevents the logger from writing a header
# when creating a new log file. The default is +false+, meaning
# the header will be written as usual.
#
def initialize(logdev, shift_age = 0, shift_size = 1048576, level: DEBUG,
progname: nil, formatter: nil, datetime_format: nil,
binmode: false, shift_period_suffix: '%Y%m%d',
reraise_write_errors: [])
reraise_write_errors: [], skip_header: false)
self.level = level
self.progname = progname
@default_formatter = Formatter.new
Expand All @@ -594,7 +597,8 @@ def initialize(logdev, shift_age = 0, shift_size = 1048576, level: DEBUG,
shift_size: shift_size,
shift_period_suffix: shift_period_suffix,
binmode: binmode,
reraise_write_errors: reraise_write_errors)
reraise_write_errors: reraise_write_errors,
skip_header: skip_header)
end
end

Expand Down
8 changes: 6 additions & 2 deletions lib/logger/log_device.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ class LogDevice
attr_reader :filename
include MonitorMixin

def initialize(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false, reraise_write_errors: [])
def initialize(
log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil,
binmode: false, reraise_write_errors: [], skip_header: false
)
@dev = @filename = @shift_age = @shift_size = @shift_period_suffix = nil
@binmode = binmode
@reraise_write_errors = reraise_write_errors
@skip_header = skip_header
mon_initialize
set_dev(log)
set_file(shift_age, shift_size, shift_period_suffix) if @filename
Expand Down Expand Up @@ -132,7 +136,7 @@ def create_logfile(filename)
logdev = fixup_mode(logdev)
logdev.sync = true
logdev.binmode if @binmode
add_log_header(logdev)
add_log_header(logdev) unless @skip_header
logdev.flock(File::LOCK_UN)
logdev
rescue Errno::EEXIST
Expand Down
6 changes: 6 additions & 0 deletions test/logger/test_logdevice.rb
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,12 @@ def test_shifting_age_in_multiprocess
end
end

def test_open_without_header
d(@filename, skip_header: true)

assert_equal("", File.read(@filename))
end

def test_open_logfile_in_multiprocess
tmpfile = Tempfile.new([File.basename(__FILE__, '.*'), '_1.log'])
logfile = tmpfile.path
Expand Down