Class: Macmillan::Utils::Logger::Formatter

Inherits:

Logger::Formatter

• Object
• Logger::Formatter
• Macmillan::Utils::Logger::Formatter

Defined in:

lib/macmillan/utils/logger/formatter.rb

Overview

A log formatter class for Logger objects. This formatter is used automatically when you use the Factory class.

Usage:

require 'macmillan/utils/logger'

logger = Macmillan::Utils::Logger::Factory.build_logger(type, options)

Instance Method Summary

• #call(severity, _time, _progname, msg) ⇒ Object

  Returns the log message formatted as desired.

• #initialize(prefix = nil) ⇒ Formatter constructor

  Builds a new instance of Formatter.

Constructor Details

#initialize(prefix = nil) ⇒ Formatter

Builds a new instance of Formatter

Parameters:

• prefix (String) (defaults to: nil) —

  a string to prepend to all log lines

# File 'lib/macmillan/utils/logger/formatter.rb', line 21

def initialize(prefix = nil)
  @format = '[%5s]: %s'
  @format = "#{prefix} #{@format}" if prefix
end

Instance Method Details

#call(severity, _time, _progname, msg) ⇒ Object

Returns the log message formatted as desired

# File 'lib/macmillan/utils/logger/formatter.rb', line 29

def call(severity, _time, _progname, msg)
  @format % [severity, msg2str(msg)]
end