Class: Kafo::Logger

Inherits:
Object
  • Object
show all
Defined in:
lib/kafo/logger.rb

Constant Summary collapse

PATTERN = 
"[%5l %d %c] %m\n"
COLOR_LAYOUT = 
Logging::Layouts::Pattern.new(:pattern => PATTERN, :color_scheme => 'bright')
NOCOLOR_LAYOUT = 
Logging::Layouts::Pattern.new(:pattern => PATTERN, :color_scheme => nil)

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.loggers ⇒ Object 



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

def loggers
  @loggers ||= []
end

Class Method Details

.buffer ⇒ Object 



14
15
16
 
# File 'lib/kafo/logger.rb', line 14

def buffer
  @buffer ||= []
end

.buffering? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/kafo/logger.rb', line 79

def self.buffering?
  KafoConfigure.verbose.nil? || ((KafoConfigure.verbose && !loggers.detect {|l| l.name == 'verbose'}) || self.loggers.empty?)
end

.dump_buffer(buffer) ⇒ Object 



102
103
104
105
106
107
 
# File 'lib/kafo/logger.rb', line 102

def self.dump_buffer(buffer)
  buffer.each do |log|
    self.loggers.each { |logger| logger.send log[0], *log[1], &log[2] }
  end
  buffer.clear
end

.dump_errors ⇒ Object 



91
92
93
94
95
96
 
# File 'lib/kafo/logger.rb', line 91

def self.dump_errors
  unless self.error_buffer.empty?
    loggers.each { |logger| logger.error 'Repeating errors encountered during run:' }
    self.dump_buffer(self.error_buffer)
  end
end

.dump_needed? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/kafo/logger.rb', line 83

def self.dump_needed?
  !self.buffer.empty?
end

.error_buffer ⇒ Object 



18
19
20
 
# File 'lib/kafo/logger.rb', line 18

def error_buffer
  @error_buffer ||= []
end

.setup ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/kafo/logger.rb', line 40

def self.setup
  begin
    FileUtils.mkdir_p(KafoConfigure.config.app[:log_dir], :mode => 0750)
  rescue Errno::EACCES => e
    puts "No permissions to create log dir #{KafoConfigure.config.app[:log_dir]}"
  end

  logger   = Logging.logger['main']
  filename = "#{KafoConfigure.config.app[:log_dir]}/#{KafoConfigure.config.app[:log_name] || 'configure.log'}"
  begin
    logger.appenders = ::Logging.appenders.rolling_file('configure',
                                                        :filename => filename,
                                                        :layout   => NOCOLOR_LAYOUT,
                                                        :truncate => true
    )
    # set owner and group (it's ignored if attribute is nil)
    FileUtils.chown KafoConfigure.config.app[:log_owner], KafoConfigure.config.app[:log_group], filename
  rescue ArgumentError => e
    puts "File #{filename} not writeable, won't log anything to file!"
  end

  logger.level = KafoConfigure.config.app[:log_level]

  fatal_logger           = Logging.logger['fatal']
  fatal_logger.level     = 'fatal'
  layout                 = KafoConfigure.config.app[:colors] ? COLOR_LAYOUT : NOCOLOR_LAYOUT
  fatal_logger.appenders = [::Logging.appenders.stderr(:layout => layout)]
  
  self.loggers = [logger, fatal_logger]
end

.setup_verbose ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/kafo/logger.rb', line 71

def self.setup_verbose
  logger           = Logging.logger['verbose']
  logger.level     = KafoConfigure.config.app[:verbose_log_level]
  layout           = KafoConfigure.config.app[:colors] ? COLOR_LAYOUT : NOCOLOR_LAYOUT
  logger.appenders = [::Logging.appenders.stdout(:layout => layout)]
  self.loggers<< logger
end

.to_buffer(buffer, *args) ⇒ Object 



87
88
89
 
# File 'lib/kafo/logger.rb', line 87

def self.to_buffer(buffer, *args)
  buffer << args
end

Instance Method Details

#dump_errors ⇒ Object 



98
99
100
 
# File 'lib/kafo/logger.rb', line 98

def dump_errors
  self.class.dump_errors
end

#log(name, *args, &block) ⇒ Object 



109
110
111
112
113
114
115
116
 
# File 'lib/kafo/logger.rb', line 109

def log(name, *args, &block)
  if self.class.buffering?
    self.class.to_buffer(self.class.buffer, name, args, &block)
  else
    self.class.dump_buffer(self.class.buffer) if self.class.dump_needed?
    self.class.loggers.each { |logger| logger.send name, *args, &block }
  end
end