A generic logging class

Methods
#
C
D
E
F
I
L
N
W
Constants
DEBUG = 1, 2, 3, 4, 5
 
Attributes
[RW] level

log-level, messages above this level will be logged
Class Public methods
new(log_file=nil, level=nil)

Initializes a new logger for log_file that outputs messages at level or higher. log_file can be a filename, an IO-like object that responds to << or nil which outputs to $stderr.

If no level is given INFO is chosen by default

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 30
def initialize(log_file=nil, level=nil)
  @level = level || INFO
  case log_file
  when String
    @log = open(log_file, "a+")
    @log.sync = true
    @opened = true
  when NilClass
    @log = $stderr
  else
    @log = log_file  # requires "<<". (see BasicLog#log)
  end
end
Instance Public methods
<<(obj)

Synonym for log(INFO, obj.to_s)

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 64
def <<(obj)
  log(INFO, obj.to_s)
end
close()

Closes the logger (also closes the log device associated to the logger)

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 46
def close
  @log.close if @opened
  @log = nil
end
debug(msg)

Shortcut for logging a DEBUG message

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 77
def debug(msg) log(DEBUG, "DEBUG " << format(msg)); end
debug?()

Will the logger output DEBUG messages?

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 88
def debug?; @level >= DEBUG; end
error(msg)

Shortcut for logging an ERROR message

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 71
def error(msg) log(ERROR, "ERROR " << format(msg)); end
error?()

Will the logger output ERROR messages?

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 82
def error?; @level >= ERROR; end
fatal(msg)

Shortcut for logging a FATAL message

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 69
def fatal(msg) log(FATAL, "FATAL " << format(msg)); end
fatal?()

Will the logger output FATAL messages?

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 80
def fatal?; @level >= FATAL; end
info(msg)

Shortcut for logging an INFO message

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 75
def info(msg)  log(INFO,  "INFO  " << format(msg)); end
info?()

Will the logger output INFO messages?

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 86
def info?;  @level >= INFO; end
log(level, data)

Logs data at level if the given level is above the current log level.

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 55
def log(level, data)
  if @log && level <= @level
    data += "\n" if /\n\Z/ !~ data
    @log << data
  end
end
warn(msg)

Shortcut for logging a WARN message

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 73
def warn(msg)  log(WARN,  "WARN  " << format(msg)); end
warn?()

Will the logger output WARN messages?

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 84
def warn?;  @level >= WARN; end
Instance Private methods
format(arg)

Formats arg for the logger

  • If arg is an Exception, it will format the error message and the back trace.

  • If arg responds to to_str, it will return it.

  • Otherwise it will return arg.inspect.

Source: show | on GitHub 

# File ../ruby/lib/webrick/log.rb, line 99
def format(arg)
  if arg.is_a?(Exception)
    "#{arg.class}: #{arg.message}\n\t" <<
    arg.backtrace.join("\n\t") << "\n"
  elsif arg.respond_to?(:to_str)
    arg.to_str
  else
    arg.inspect
  end
end