Class: Logger::LogDevice

Inherits:
Object
  • Object
show all
Includes:
Period, MonitorMixin
Defined in:
lib/logger/log_device.rb

Overview

Device used for logging messages.

Constant Summary

Constants included from Period

Period::SiD

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Period

next_rotate_time, previous_period_end

Constructor Details

#initialize(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false, reraise_write_errors: []) ⇒ LogDevice

Returns a new instance of LogDevice.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/logger/log_device.rb', line 14

def initialize(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false, reraise_write_errors: [])
  @dev = @filename = @shift_age = @shift_size = @shift_period_suffix = nil
  @binmode = binmode
  @reraise_write_errors = reraise_write_errors
  mon_initialize
  set_dev(log)
  if @filename
    @shift_age = shift_age || 7
    @shift_size = shift_size || 1048576
    @shift_period_suffix = shift_period_suffix || '%Y%m%d'

    unless @shift_age.is_a?(Integer)
      base_time = @dev.respond_to?(:stat) ? @dev.stat.mtime : Time.now
      @next_rotate_time = next_rotate_time(base_time, @shift_age)
    end
  end
end

Instance Attribute Details

#dev ⇒ Object (readonly)

Returns the value of attribute dev.



10
11
12
 
# File 'lib/logger/log_device.rb', line 10

def dev
  @dev
end

#filename ⇒ Object (readonly)

Returns the value of attribute filename.



11
12
13
 
# File 'lib/logger/log_device.rb', line 11

def filename
  @filename
end

Instance Method Details

#close ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/logger/log_device.rb', line 43

def close
  begin
    synchronize do
      @dev.close rescue nil
    end
  rescue Exception
    @dev.close rescue nil
  end
end

#reopen(log = nil) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/logger/log_device.rb', line 53

def reopen(log = nil)
  # reopen the same filename if no argument, do nothing for IO
  log ||= @filename if @filename
  if log
    synchronize do
      if @filename and @dev
        @dev.close rescue nil # close only file opened by Logger
        @filename = nil
      end
      set_dev(log)
    end
  end
  self
end

#write(message) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/logger/log_device.rb', line 32

def write(message)
  handle_write_errors("writing") do
    synchronize do
      if @shift_age and @dev.respond_to?(:stat)
        handle_write_errors("shifting") {check_shift_log}
      end
      handle_write_errors("writing") {@dev.write(message)}
    end
  end
end