Module: Yell

Defined in:
lib/yell.rb,
lib/yell/event.rb,
lib/yell/level.rb,
lib/yell/logger.rb,
lib/yell/version.rb,
lib/yell/adapters.rb,
lib/yell/formatter.rb,
lib/yell/adapters/io.rb,
lib/yell/adapters/base.rb,
lib/yell/adapters/file.rb,
lib/yell/adapters/streams.rb,
lib/yell/adapters/datefile.rb

Overview

:nodoc:

Defined Under Namespace

Modules: Adapters Classes: Event, Formatter, Level, Logger, NoSuchAdapter

Constant Summary collapse

Severities = 
[ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN' ]
VERSION = 
"0.5.1"
NoFormat =

No format on the log message

Examples:

logger = Yell.new STDOUT, :format => false
logger.info "Hello World!"
#=> "Hello World!"
"%m"
DefaultFormat =

Default Format

Examples:

logger = Yell.new STDOUT, :format => Yell::DefaultFormat
logger.info "Hello World!"
#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World!"
#    ^                         ^       ^       ^
#    ISO8601 Timestamp         Level   Pid     Message
"%d [%5L] %p : %m"
BasicFormat =

Basic Format

Examples:

logger = Yell.new STDOUT, :format => Yell::BasicFormat
logger.info "Hello World!"
#=> "I, 2012-02-29T09:30:00+01:00 : Hello World!"
#    ^  ^                          ^
#    ^  ISO8601 Timestamp          Message
#    Level (short)
"%l, %d : %m"
ExtendedFormat =

Extended Format

Examples:

logger = Yell.new STDOUT, :format => Yell::ExtendedFormat
logger.info "Hello World!"
#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 localhost : Hello World!"
#    ^                          ^      ^     ^           ^
#    ISO8601 Timestamp          Level  Pid   Hostname    Message
"%d [%5L] %p %h : %m"

Class Method Summary collapse

Class Method Details

._deprecate(version, message, options = {}) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/yell.rb', line 64

def _deprecate( version, message, options = {} )
  warning = ["Deprecation Warning (since v#{version}): #{message}" ]
  warning << "  before: #{options[:before]}" if options[:before]
  warning << "  after:  #{options[:after]}" if options[:after]

  $stderr.puts warning.join( "\n" )
end

.env ⇒ Object

:nodoc:



60
61
62
 
# File 'lib/yell.rb', line 60

def env #:nodoc:
  ENV['YELL_ENV'] || ENV['RACK_ENV'] || 'development'
end

.format(pattern, date_pattern = nil) ⇒ Yell::Formatter

Shortcut to Yell::Fomatter.new

Returns:



56
57
58
 
# File 'lib/yell.rb', line 56

def format( pattern, date_pattern = nil )
  Yell::Formatter.new( pattern, date_pattern )
end

.level(val = nil) ⇒ Yell::Level

Shortcut to Yell::Level.new

Returns:



49
50
51
 
# File 'lib/yell.rb', line 49

def level( val = nil )
  Yell::Level.new( val )
end

.new(*args, &block) ⇒ Yell::Logger

Creates a new logger instance.

Refer to #Yell::Loggger for usage.

Returns:



42
43
44
 
# File 'lib/yell.rb', line 42

def new( *args, &block )
  Yell::Logger.new( *args, &block )
end