Class Extlib::Logger
In: lib/extlib/logger.rb
Parent: Object

Methods

<<   close   flush   new   push   set_log  

Constants

Levels = { :fatal => 7, :error => 6, :warn => 4, :info => 3, :debug => 0  

Notes

Ruby (standard) logger levels:
:fatal:An unhandleable error that results in a program crash
:error:A handleable error condition
:warn:A warning
:info:generic (useful) information about system operation
:debug:low-level information for developers

Attributes

auto_flush  [RW] 
buffer  [R] 
delimiter  [RW] 
init_args  [R] 
level  [RW] 
log  [R] 

Public Class methods

To initialize the logger you create a new object, proxies to set_log.

Parameters

*args:Arguments to create the log from. See set_logs for specifics.

Public Instance methods

Appends a message to the log. The methods yield to an optional block and the output of this block will be appended to the message.

Parameters

string<String>:The message to be logged. Defaults to nil.

Returns

String:The resulting message added to the log file.

Close and remove the current log object.

Flush the entire buffer to the log object.

push(string = nil)

Alias for #<<

Replaces an existing logger with a new one.

Parameters

log<IO, String>:Either an IO object or a name of a logfile.
log_level<~to_sym>:The log level from, e.g. :fatal or :info. Defaults to :error in the production environment and :debug otherwise.
delimiter<String>:Delimiter to use between message sections. Defaults to " ~ ".
auto_flush<Boolean>:Whether the log should automatically flush after new messages are added. Defaults to false.

[Validate]