module Mixlib::Log
Constants
- LEVELS
- LEVEL_NAMES
- VERSION
Public Instance Methods
# File lib/mixlib/log.rb, line 138 def <<(msg) loggers.each { |l| l << msg } end
# File lib/mixlib/log.rb, line 142 def add(severity, message = nil, progname = nil, &block) loggers.each { |l| l.add(severity, message, progname, &block) } end
Let the application query if logging objects have been set up
# File lib/mixlib/log.rb, line 89 def configured? @configured end
Use Mixlib::Log.init
when you want to set up the logger manually. Arguments to this method get passed directly to Logger.new, so check out the documentation for the standard Logger class to understand what to do here.
If this method is called with no arguments, it will log to STDOUT at the :warn level.
It also configures the Logger instance it creates to use the custom Mixlib::Log::Formatter
class.
# File lib/mixlib/log.rb, line 79 def init(*opts) reset! @logger = logger_for(*opts) @logger.formatter = Mixlib::Log::Formatter.new() if @logger.respond_to?(:formatter=) @logger.level = Logger::WARN @configured = true @logger end
# File lib/mixlib/log.rb, line 108 def level(new_level = nil) if new_level.nil? LEVEL_NAMES[logger.level] else self.level = (new_level) end end
Sets the level for the Logger object by symbol. Valid arguments are:
:debug :info :warn :error :fatal
Throws an ArgumentError if you feed it a bogus log level.
# File lib/mixlib/log.rb, line 102 def level=(new_level) level_int = LEVEL_NAMES.key?(new_level) ? new_level : LEVELS[new_level] raise ArgumentError, "Log level must be one of :debug, :info, :warn, :error, or :fatal" if level_int.nil? loggers.each { |l| l.level = level_int } end
init always returns a configured logger and creates a new one if it doesn't yet exist
# File lib/mixlib/log.rb, line 46 def logger @logger || init end
Sets the log device to new_log_device
. Any additional loggers that had been added to the loggers
array will be cleared.
# File lib/mixlib/log.rb, line 52 def logger=(new_log_device) reset! @logger = new_log_device end
An Array of log devices that will be logged to. Defaults to just the default @logger log device, but you can push to this array to add more devices.
# File lib/mixlib/log.rb, line 38 def loggers @loggers ||= [logger] end
Passes any other method calls on directly to the underlying Logger object created with init. If this method gets hit before a call to Mixlib::Logger.init has been made, it will call Mixlib::Logger.init() with no arguments.
# File lib/mixlib/log.rb, line 151 def method_missing(method_symbol, *args, &block) loggers.each { |l| l.send(method_symbol, *args, &block) } end
# File lib/mixlib/log.rb, line 31 def reset! close! @logger, @loggers = nil, nil end
# File lib/mixlib/log.rb, line 57 def use_log_devices(other) if other.respond_to?(:loggers) && other.respond_to?(:logger) @loggers = other.loggers @logger = other.logger elsif other.kind_of?(Array) @loggers = other @logger = other.first else msg = "#use_log_devices takes a Mixlib::Log object or array of log devices. " << "You gave: #{other.inspect}" raise ArgumentError, msg end @configured = true end
Private Instance Methods
# File lib/mixlib/log.rb, line 167 def all_loggers [@logger, *@loggers].uniq end
# File lib/mixlib/log.rb, line 185 def close! # try to close all file loggers loggers_to_close.each do |l| l.close rescue nil end end
# File lib/mixlib/log.rb, line 157 def logger_for(*opts) if opts.empty? Logger.new(STDOUT) elsif LEVELS.keys.inject(true) { |quacks, level| quacks && opts.first.respond_to?(level) } opts.first else Logger.new(*opts) end end
select all loggers with File log devices
# File lib/mixlib/log.rb, line 172 def loggers_to_close loggers_to_close = [] all_loggers.each do |logger| # unfortunately Logger does not provide access to the logdev # via public API. In order to reduce amount of impact and # handle only File type log devices I had to use this method # to get access to it. next unless logdev = logger.instance_variable_get(:"@logdev") loggers_to_close << logger if logdev.filename end loggers_to_close end