Class: Yell::Formatter

Inherits:

Object

• Object
• Yell::Formatter

Defined in:

lib/yell/formatter.rb

Overview

The Formatter provides a handle to configure your log message style.

Constant Summary

PatternTable =

{
  "m" => "event.message",              # Message
  "l" => "event.level[0,1]",           # Level (short), e.g.'I', 'W'
  "L" => "event.level",                # Level, e.g. 'INFO', 'WARN'
  "d" => "date(event)",                # ISO8601 Timestamp
  "h" => "event.hostname",             # Hostname
  "p" => "event.pid",                  # PID
  "t" => "event.thread_id",            # Thread ID
  "F" => "event.file",                 # Path with filename where the logger was called
  "f" => "File.basename(event.file)",  # Filename where the loger was called
  "M" => "event.method",               # Method name where the logger was called
  "n" => "event.line"                  # Line where the logger was called
}

PatternRegexp =

/([^%]*)(%\d*)?(#{PatternTable.keys.join('|')})?(.*)/

Instance Method Summary

• #initialize(pattern = nil, date_pattern = nil) ⇒ Formatter constructor

  Initializes a new Yell::Formatter.

Constructor Details

#initialize(pattern = nil, date_pattern = nil) ⇒ Formatter

Initializes a new Yell::Formatter.

Upon initialization it defines a format method. ‘format` takes a Event instance as agument in order to apply for desired log message formatting.

# File 'lib/yell/formatter.rb', line 70

def initialize( pattern = nil, date_pattern = nil )
  @pattern      = pattern || Yell::DefaultFormat
  @date_pattern = date_pattern

  define!
end