log4r.rb
Path: /home/cepheus/projects/prep/log4r-1.0.0/src/log4r.rb
Created: Wed Jan 16 05:21:51 PST 2002
Modified: Tue Jan 15 06:26:09 PST 2002

Log4r API

First things first

The code examples in this API assume:

  include Log4r

Log Levels

The default log levels and their rankings are:

  DEBUG < INFO < WARN < ERROR < FATAL

Ranks imply the importance of a logging event. Think of it this way: the lower the rank, the more noisy the level and the less likely we'd want to see that info in a production release.

Custom Levels

You can customize the number and names of the log levels. Please see log4r/configurator.rb.

Boundary Levels

There are two special levels, ALL and OFF which denote whether we are logging at all levels or at none. The ranks are:

  ALL < log levels < OFF

Thus, setting the level to ALL will enable logging at all levels whereas OFF will turn off logging completely.

Principal Classes

End users need only worry about the following classes:

Usage guidelines are covered in these files:

Other Info

Author:Leon Torres
Version:$Id: log4r.rb,v 1.7 2002/01/15 14:26:09 cepheus Exp $

Required files
"log4r/outputter"    "log4r/outputters"    "log4r/configurator"    "log4r/patternformatter"   
Classes and Modules
Module Log4r
  ::Class Log4r::Outputter
  ::Class Log4r::DefaultFormatter
  ::Class Log4r::NullFormatter
  ::Class Log4r::Logger
  ::Class Log4r::Configurator
  ::Class Log4r::ObjectFormatter
  ::Class Log4r::RootLogger
  ::Class Log4r::StderrOutputter
  ::Class Log4r::Formatter
  ::Class Log4r::StdoutOutputter
  ::Class Log4r::ConfigError
  ::Class Log4r::BasicFormatter
  ::Class Log4r::SimpleFormatter
  ::Class Log4r::PatternFormatter
  ::Class Log4r::FileOutputter
  ::  ::Class Log4r::FileOutputter::RingBuffOutputter