Class: WEBrick::BasicLog
- Inherits:
-
Object
- Object
- WEBrick::BasicLog
- Defined in:
- lib/webrick/log.rb
Overview
A generic logging class
Direct Known Subclasses
Instance Attribute Summary collapse
-
#level ⇒ Object
log-level, messages above this level will be logged.
Instance Method Summary collapse
-
#<<(obj) ⇒ Object
Synonym for log(INFO, obj.to_s).
-
#close ⇒ Object
Closes the logger (also closes the log device associated to the logger).
-
#debug(msg) ⇒ Object
Shortcut for logging a DEBUG message.
-
#debug? ⇒ Boolean
Will the logger output DEBUG messages?.
-
#error(msg) ⇒ Object
Shortcut for logging an ERROR message.
-
#error? ⇒ Boolean
Will the logger output ERROR messages?.
-
#fatal(msg) ⇒ Object
Shortcut for logging a FATAL message.
-
#fatal? ⇒ Boolean
Will the logger output FATAL messages?.
-
#info(msg) ⇒ Object
Shortcut for logging an INFO message.
-
#info? ⇒ Boolean
Will the logger output INFO messages?.
-
#initialize(log_file = nil, level = nil) ⇒ BasicLog
constructor
Initializes a new logger for
log_file
that outputs messages atlevel
or higher. -
#log(level, data) ⇒ Object
Logs
data
atlevel
if the given level is above the current log level. -
#warn(msg) ⇒ Object
Shortcut for logging a WARN message.
-
#warn? ⇒ Boolean
Will the logger output WARN messages?.
Constructor Details
#initialize(log_file = nil, level = nil) ⇒ BasicLog
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
30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File '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 Attribute Details
#level ⇒ Object
log-level, messages above this level will be logged
21 22 23 |
# File 'lib/webrick/log.rb', line 21 def level @level end |
Instance Method Details
#<<(obj) ⇒ Object
Synonym for log(INFO, obj.to_s)
64 65 66 |
# File 'lib/webrick/log.rb', line 64 def <<(obj) log(INFO, obj.to_s) end |
#close ⇒ Object
Closes the logger (also closes the log device associated to the logger)
46 47 48 49 |
# File 'lib/webrick/log.rb', line 46 def close @log.close if @opened @log = nil end |
#debug(msg) ⇒ Object
Shortcut for logging a DEBUG message
77 |
# File 'lib/webrick/log.rb', line 77 def debug(msg) log(DEBUG, "DEBUG " << format(msg)); end |
#debug? ⇒ Boolean
Will the logger output DEBUG messages?
88 |
# File 'lib/webrick/log.rb', line 88 def debug?; @level >= DEBUG; end |
#error(msg) ⇒ Object
Shortcut for logging an ERROR message
71 |
# File 'lib/webrick/log.rb', line 71 def error(msg) log(ERROR, "ERROR " << format(msg)); end |
#error? ⇒ Boolean
Will the logger output ERROR messages?
82 |
# File 'lib/webrick/log.rb', line 82 def error?; @level >= ERROR; end |
#fatal(msg) ⇒ Object
Shortcut for logging a FATAL message
69 |
# File 'lib/webrick/log.rb', line 69 def fatal(msg) log(FATAL, "FATAL " << format(msg)); end |
#fatal? ⇒ Boolean
Will the logger output FATAL messages?
80 |
# File 'lib/webrick/log.rb', line 80 def fatal?; @level >= FATAL; end |
#info(msg) ⇒ Object
Shortcut for logging an INFO message
75 |
# File 'lib/webrick/log.rb', line 75 def info(msg) log(INFO, "INFO " << format(msg)); end |
#info? ⇒ Boolean
Will the logger output INFO messages?
86 |
# File 'lib/webrick/log.rb', line 86 def info?; @level >= INFO; end |
#log(level, data) ⇒ Object
Logs data
at level
if the given level is above the current log level.
55 56 57 58 59 60 |
# File '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) ⇒ Object
Shortcut for logging a WARN message
73 |
# File 'lib/webrick/log.rb', line 73 def warn(msg) log(WARN, "WARN " << format(msg)); end |
#warn? ⇒ Boolean
Will the logger output WARN messages?
84 |
# File 'lib/webrick/log.rb', line 84 def warn?; @level >= WARN; end |