Class: Kitchen::Logger::DeviceFactory

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

Overview

Internal factory for building the concrete logger devices.

Instance Method Summary collapse

Instance Method Details

#logdev_logger(filepath_or_logdev, log_overwrite) ⇒ LogdevLogger

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Construct a new logdev logger.

Parameters:

  • filepath_or_logdev (String, IO) —

    a filepath String or IO object

  • log_overwrite (Boolean) —

    apply log overwriting if filepath_or_logdev is a file path

Returns:



433
434
435
 
# File 'lib/kitchen/logger.rb', line 433

def logdev_logger(filepath_or_logdev, log_overwrite)
  LogdevLogger.new(resolve_logdev(filepath_or_logdev, log_overwrite))
end

#stdout_logger(stdout, color, colorize) ⇒ StdoutLogger

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Construct a new standard out logger.

Parameters:

  • stdout (IO) —

    the IO object that represents stdout (or similar)

  • color (Symbol) —

    color to use when outputting messages

  • colorize (Boolean) —

    whether to enable color

Returns:



420
421
422
423
424
 
# File 'lib/kitchen/logger.rb', line 420

def stdout_logger(stdout, color, colorize)
  logger = StdoutLogger.new(stdout)
  logger.formatter = stdout_formatter(color, colorize)
  logger
end

#structured_logdev_logger(filepath_or_logdev, log_overwrite, metadata_provider) ⇒ StructuredLogdevLogger

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Construct a new structured logdev logger.

Parameters:

  • filepath_or_logdev (String, IO) —

    a filepath String or IO object

  • log_overwrite (Boolean) —

    apply log overwriting if filepath_or_logdev is a file path

  • metadata_provider (Proc) —

    callable returning structured metadata

Returns:



445
446
447
448
449
450
 
# File 'lib/kitchen/logger.rb', line 445

def structured_logdev_logger(filepath_or_logdev, log_overwrite, metadata_provider)
  StructuredLogdevLogger.new(
    resolve_logdev(filepath_or_logdev, log_overwrite),
    metadata_provider
  )
end