|
Formatters are responsible for formatting log event data. An Outputter owning a Formatter will invoke the Log4r::Formatter#format method prior to writing.
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.
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.
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 |
Classes and Modules |