Class: ActiveSupport::BufferedLogger

Inherits:
Object
  • Object
show all
Includes:
Severity
Defined in:
lib/active_support/buffered_logger.rb

Overview

Inspired by the buffered logger idea by Ezra

Defined Under Namespace

Modules: Severity

Constant Summary collapse

MAX_BUFFER_SIZE =
1000

Constants included from Severity

Severity::DEBUG, Severity::ERROR, Severity::FATAL, Severity::INFO, Severity::UNKNOWN, Severity::WARN

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(log, level = DEBUG) ⇒ BufferedLogger

Returns a new instance of BufferedLogger.


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/active_support/buffered_logger.rb', line 41

def initialize(log, level = DEBUG)
  @level         = level
  @buffer        = {}
  @auto_flushing = 1
  @guard = Mutex.new

  if log.respond_to?(:write)
    @log = log
  elsif File.exist?(log)
    @log = open(log, (File::WRONLY | File::APPEND))
    @log.sync = true
  else
    FileUtils.mkdir_p(File.dirname(log))
    @log = open(log, (File::WRONLY | File::APPEND | File::CREAT))
    @log.sync = true
  end
end

Instance Attribute Details

#auto_flushingObject

Returns the value of attribute auto_flushing


39
40
41
# File 'lib/active_support/buffered_logger.rb', line 39

def auto_flushing
  @auto_flushing
end

#levelObject

Returns the value of attribute level


38
39
40
# File 'lib/active_support/buffered_logger.rb', line 38

def level
  @level
end

Instance Method Details

#add(severity, message = nil, progname = nil, &block) ⇒ Object


59
60
61
62
63
64
65
66
67
68
# File 'lib/active_support/buffered_logger.rb', line 59

def add(severity, message = nil, progname = nil, &block)
  return if @level > severity
  message = (message || (block && block.call) || progname).to_s  # If a newline is necessary then create a new message ending with a newline.
  # Ensures that the original message is not mutated.

  message = "#{message}\n" unless message[-1] == ?\n
  buffer << message
  auto_flush
  message
end

#closeObject


117
118
119
120
121
# File 'lib/active_support/buffered_logger.rb', line 117

def close
  flush
  @log.close if @log.respond_to?(:close)
  @log = nil
end

#flushObject


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/active_support/buffered_logger.rb', line 100

def flush
  @guard.synchronize do
    unless buffer.empty?
      old_buffer = buffer
      all_content = StringIO.new
      old_buffer.each do |content|
        all_content << content
      end
      @log.write(all_content.string)
    end

    # Important to do this even if buffer was empty or else @buffer will
    # accumulate empty arrays for each request where nothing was logged.
    clear_buffer
  end
end

#silence(temporary_level = ERROR) ⇒ Object

Silences the logger for the duration of the block.


25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/active_support/buffered_logger.rb', line 25

def silence(temporary_level = ERROR)
  if silencer
    begin
      old_logger_level, self.level = level, temporary_level
      yield self
    ensure
      self.level = old_logger_level
    end
  else
    yield self
  end
end

#silencerObject

:singleton-method: Set to false to disable the silencer


21
# File 'lib/active_support/buffered_logger.rb', line 21

cattr_accessor :silencer