Module: Mixlib::Log

Includes:
Logging
Defined in:
lib/mixlib/log.rb,
lib/mixlib/log/child.rb,
lib/mixlib/log/logger.rb,
lib/mixlib/log/logging.rb,
lib/mixlib/log/version.rb,
lib/mixlib/log/formatter.rb

Defined Under Namespace

Modules: Logging Classes: Child, Formatter, Logger

Constant Summary collapse

VERSION = 
"2.0.1"

Constants included from Logging

Logging::LEVELS, Logging::LEVEL_NAMES, Logging::SEV_LABEL, Logging::TRACE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

#pass, #to_label

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_symbol, *args, &block) ⇒ Object

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.



164
165
166
 
# File 'lib/mixlib/log.rb', line 164

def method_missing(method_symbol, *args, &block)
  loggers.each { |l| l.send(method_symbol, *args, &block) }
end

Instance Attribute Details

#metadata ⇒ Object

Returns the value of attribute metadata.



96
97
98
 
# File 'lib/mixlib/log.rb', line 96

def metadata
  @metadata
end

Instance Method Details

#<<(msg) ⇒ Object 



132
133
134
 
# File 'lib/mixlib/log.rb', line 132

def <<(msg)
  loggers.each { |l| l << msg }
end

#add(severity, message = nil, progname = nil, data: {}, &block) ⇒ Object Also known as: log 



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/mixlib/log.rb', line 136

def add(severity, message = nil, progname = nil, data: {}, &block)
  message, progname, data = yield if block_given?
  data = metadata.merge(data) if metadata.kind_of?(Hash) && data.kind_of?(Hash)
  loggers.each do |l|
    # if we don't have any metadata, let's not do the potentially expensive
    # merging and managing that this call requires
    if l.respond_to?(:add_data) && !data.nil? && !data.empty?
      l.add_data(severity, message, progname, data: data)
    else
      l.add(severity, message, progname)
    end
  end
end

#configured? ⇒ Boolean

Let the application query if logging objects have been set up

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/mixlib/log.rb', line 92

def configured?
  @configured
end

#init(*opts) ⇒ Object

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.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/mixlib/log.rb', line 80

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
  @parent = nil
  @metadata = {}
  @logger
end

#level(new_level = nil) ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/mixlib/log.rb', line 114

def level(new_level = nil)
  if new_level.nil?
    LEVEL_NAMES[logger.level]
  else
    self.level = (new_level)
  end
end

#level=(new_level) ⇒ Object

Sets the level for the Logger object by symbol. Valid arguments are:

:trace
:debug
:info
:warn
:error
:fatal

Throws an ArgumentError if you feed it a bogus log level.

Raises:

  • (ArgumentError) 


108
109
110
111
112
 
# File 'lib/mixlib/log.rb', line 108

def level=(new_level)
  level_int = LEVEL_NAMES.key?(new_level) ? new_level : LEVELS[new_level]
  raise ArgumentError, "Log level must be one of :trace, :debug, :info, :warn, :error, or :fatal" if level_int.nil?
  loggers.each { |l| l.level = level_int }
end

#logger ⇒ Object

init always returns a configured logger and creates a new one if it doesn’t yet exist



47
48
49
 
# File 'lib/mixlib/log.rb', line 47

def logger
  @logger || init
end

#logger=(new_log_device) ⇒ Object

Sets the log device to new_log_device. Any additional loggers that had been added to the loggers array will be cleared.



53
54
55
56
 
# File 'lib/mixlib/log.rb', line 53

def logger=(new_log_device)
  reset!
  @logger = new_log_device
end

#loggers ⇒ Object

An Array of log devices that will be logged to. Defaults to just the default



39
40
41
 
# File 'lib/mixlib/log.rb', line 39

def loggers
  @loggers ||= [logger]
end

#reset! ⇒ Object 



31
32
33
34
35
 
# File 'lib/mixlib/log.rb', line 31

def reset!
  close!
  @logger, @loggers = nil, nil
  @metadata = {}
end

#use_log_devices(other) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/mixlib/log.rb', line 58

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

#with_child(metadata = {}) ⇒ Object 



152
153
154
155
156
157
158
159
 
# File 'lib/mixlib/log.rb', line 152

def with_child(metadata = {})
  child = Child.new(self, metadata)
  if block_given?
    yield child
  else
    child
  end
end