Class: Kitchen::Logger

Inherits:
Object
  • Object
show all
Includes:
Logger::Severity
Defined in:
lib/kitchen/logger.rb

Overview

Logging implementation for Kitchen. By default the console/stdout output will be displayed differently than the file log output. Therefor, this class wraps multiple loggers that conform to the stdlib Logger class behavior.

Author:

Defined Under Namespace

Classes: LogdevLogger, StdoutLogger

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Logger

Constructs a new logger.

Parameters:

  • options (Hash) (defaults to: {}) —

    configuration for a new logger

Options Hash (options):

  • :color (Symbol) —

    color to use when when outputting messages

  • :level (Integer) —

    the logging severity threshold (default: Kitchen::DEFAULT_LOG_LEVEL)

  • :logdev (String, IO) —

    filepath String or IO object to be used for logging (default: nil)

  • :progname (String) —

    program name to include in log messages (default: "Kitchen")

  • :stdout (IO) —

    a standard out IO object to use (default: $stdout)



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/kitchen/logger.rb', line 50

def initialize(options = {})
  color = options[:color]

  @loggers = []
  @loggers << @logdev = logdev_logger(options[:logdev]) if options[:logdev]
  @loggers << stdout_logger(options[:stdout], color) if options[:stdout]
  @loggers << stdout_logger($stdout, color) if @loggers.empty?

  self.progname = options[:progname] || "Kitchen"
  self.level = options[:level] || default_log_level
end

Instance Attribute Details

#logdev ⇒ IO (readonly)

Returns the log device.

Returns:

  • (IO) —

    the log device



35
36
37
 
# File 'lib/kitchen/logger.rb', line 35

def logdev
  @logdev
end

Instance Method Details

#:<<(: <<()) ⇒ Object

Dump one or more messages to info.

Parameters:

  • message (#to_s) —

    the message to log

See Also:



124
 
# File 'lib/kitchen/logger.rb', line 124

delegate_to_all_loggers :<<

#add ⇒ Object

Log a message if the given severity is high enough.

See Also:



118
 
# File 'lib/kitchen/logger.rb', line 118

delegate_to_all_loggers :add

Log a message with severity of banner (high level).

Parameters:

  • message_or_progname (#to_s) —

    the message to log. In the block form, this is the progname to use in the log message.

Yields:

  • evaluates to the message to log. This is not evaluated unless the logger's level is sufficient to log the message. This allows you to create potentially expensive logging messages that are only called when the logger is configured to show them.

Returns:

  • (nil, true) —

    when the given severity is not high enough (for this particular logger), log no message, and return true

See Also:



137
 
# File 'lib/kitchen/logger.rb', line 137

delegate_to_all_loggers :banner

#close ⇒ Object

Close the logging devices.

See Also:



245
 
# File 'lib/kitchen/logger.rb', line 245

delegate_to_all_loggers :close

#datetime_format ⇒ String

Returns the date format being used.

Returns:

  • (String) —

    the date format being used

See Also:



107
 
# File 'lib/kitchen/logger.rb', line 107

delegate_to_first_logger :datetime_format

#datetime_format= ⇒ Object

Sets the date format being used.

Parameters:

  • format (String) —

    the date format

See Also:



113
 
# File 'lib/kitchen/logger.rb', line 113

delegate_to_all_loggers :datetime_format=

#debug { ... } ⇒ nil, true

Log a message with severity of debug.

Parameters:

  • message_or_progname (#to_s) —

    the message to log. In the block form, this is the progname to use in the log message.

Yields:

  • evaluates to the message to log. This is not evaluated unless the logger's level is sufficient to log the message. This allows you to create potentially expensive logging messages that are only called when the logger is configured to show them.

Returns:

  • (nil, true) —

    when the given severity is not high enough (for this particular logger), log no message, and return true

See Also:



150
 
# File 'lib/kitchen/logger.rb', line 150

delegate_to_all_loggers :debug

#debug? ⇒ true, false

Returns whether or not the current severity level allows for the printing of debug messages.

Returns:

  • (true, false) —

    whether or not the current severity level allows for the printing of debug messages

See Also:



155
 
# File 'lib/kitchen/logger.rb', line 155

delegate_to_first_logger :debug?

#error { ... } ⇒ nil, true

Log a message with severity of error.

Parameters:

  • message_or_progname (#to_s) —

    the message to log. In the block form, this is the progname to use in the log message.

Yields:

  • evaluates to the message to log. This is not evaluated unless the logger's level is sufficient to log the message. This allows you to create potentially expensive logging messages that are only called when the logger is configured to show them.

Returns:

  • (nil, true) —

    when the given severity is not high enough (for this particular logger), log no message, and return true

See Also:



186
 
# File 'lib/kitchen/logger.rb', line 186

delegate_to_all_loggers :error

#error? ⇒ true, false

Returns whether or not the current severity level allows for the printing of error messages.

Returns:

  • (true, false) —

    whether or not the current severity level allows for the printing of error messages

See Also:



191
 
# File 'lib/kitchen/logger.rb', line 191

delegate_to_first_logger :error?

#fatal { ... } ⇒ nil, true

Log a message with severity of fatal.

Parameters:

  • message_or_progname (#to_s) —

    the message to log. In the block form, this is the progname to use in the log message.

Yields:

  • evaluates to the message to log. This is not evaluated unless the logger's level is sufficient to log the message. This allows you to create potentially expensive logging messages that are only called when the logger is configured to show them.

Returns:

  • (nil, true) —

    when the given severity is not high enough (for this particular logger), log no message, and return true

See Also:



222
 
# File 'lib/kitchen/logger.rb', line 222

delegate_to_all_loggers :fatal

#fatal? ⇒ true, false

Returns whether or not the current severity level allows for the printing of fatal messages.

Returns:

  • (true, false) —

    whether or not the current severity level allows for the printing of fatal messages

See Also:



227
 
# File 'lib/kitchen/logger.rb', line 227

delegate_to_first_logger :fatal?

#info { ... } ⇒ nil, true

Log a message with severity of info.

Parameters:

  • message_or_progname (#to_s) —

    the message to log. In the block form, this is the progname to use in the log message.

Yields:

  • evaluates to the message to log. This is not evaluated unless the logger's level is sufficient to log the message. This allows you to create potentially expensive logging messages that are only called when the logger is configured to show them.

Returns:

  • (nil, true) —

    when the given severity is not high enough (for this particular logger), log no message, and return true

See Also:



168
 
# File 'lib/kitchen/logger.rb', line 168

delegate_to_all_loggers :info

#info? ⇒ true, false

Returns whether or not the current severity level allows for the printing of info messages.

Returns:

  • (true, false) —

    whether or not the current severity level allows for the printing of info messages

See Also:



173
 
# File 'lib/kitchen/logger.rb', line 173

delegate_to_first_logger :info?

#level ⇒ Integer

Returns the logging severity threshold.

Returns:

  • (Integer) —

    the logging severity threshold

See Also:



87
 
# File 'lib/kitchen/logger.rb', line 87

delegate_to_first_logger :level

#level= ⇒ Object

Sets the logging severity threshold.

Parameters:

  • level (Integer) —

    the logging severity threshold

See Also:



93
 
# File 'lib/kitchen/logger.rb', line 93

delegate_to_all_loggers :level=

#progname ⇒ String

Returns program name to include in log messages.

Returns:

  • (String) —

    program name to include in log messages

See Also:



97
 
# File 'lib/kitchen/logger.rb', line 97

delegate_to_first_logger :progname

#progname= ⇒ Object

Sets the program name to include in log messages.

Parameters:

  • progname (String) —

    the program name to include in log messages

See Also:



103
 
# File 'lib/kitchen/logger.rb', line 103

delegate_to_all_loggers :progname=

#unknown { ... } ⇒ nil, true

Log a message with severity of unknown.

Parameters:

  • message_or_progname (#to_s) —

    the message to log. In the block form, this is the progname to use in the log message.

Yields:

  • evaluates to the message to log. This is not evaluated unless the logger's level is sufficient to log the message. This allows you to create potentially expensive logging messages that are only called when the logger is configured to show them.

Returns:

  • (nil, true) —

    when the given severity is not high enough (for this particular logger), log no message, and return true

See Also:



240
 
# File 'lib/kitchen/logger.rb', line 240

delegate_to_all_loggers :unknown

#warn { ... } ⇒ nil, true

Log a message with severity of warn.

Parameters:

  • message_or_progname (#to_s) —

    the message to log. In the block form, this is the progname to use in the log message.

Yields:

  • evaluates to the message to log. This is not evaluated unless the logger's level is sufficient to log the message. This allows you to create potentially expensive logging messages that are only called when the logger is configured to show them.

Returns:

  • (nil, true) —

    when the given severity is not high enough (for this particular logger), log no message, and return true

See Also:



204
 
# File 'lib/kitchen/logger.rb', line 204

delegate_to_all_loggers :warn

#warn? ⇒ true, false

Returns whether or not the current severity level allows for the printing of warn messages.

Returns:

  • (true, false) —

    whether or not the current severity level allows for the printing of warn messages

See Also:



209
 
# File 'lib/kitchen/logger.rb', line 209

delegate_to_first_logger :warn?