formatter.rb
Path: /home/cepheus/projects/prep/log4r-1.0.0/src/log4r/formatter.rb
Created: Wed Jan 16 05:21:51 PST 2002
Modified: Wed Jan 16 05:13:57 PST 2002

Formatters

Formatters are responsible for formatting log event data. An Outputter owning a Formatter will invoke the Log4r::Formatter#format method prior to writing.

Available Formatters

XML Configuration

Specify the Formatter and its class (as type) under an <outputter> directive:

  <outputter name="someout" type="sometype">
    <formatter type="Log4r::BasicFormatter"/>
  </outputter>

As explained in log4r/configurator.rb, the hash arguments you would normally pass to new are specified as XML parameters. Only PatternFormatter has any of these.

custom Formatting

Building a custom Formatter is extremely easy. Just define a class that extends Formatter and override the Formatter#format method. Then give it to any interested Outputters.

If you're interested in setting up your custom formatters in XML, please take a look at log4r/configurator.rb.

Data Available

The following data is passed to the format method:

level:The integer level of the log event.
logger:The logger which was invoked.
tracer:The execution stack at the log event, nil if logger not tracing.
data:The object passed to the log method.

Within the logger is some extra data about the logger. Please see the section Inheritance in log4r/logger.rb

Version:$Id: formatter.rb,v 1.11 2002/01/16 13:13:57 cepheus Exp $

Required files
"singleton"    "log4r/base"   
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