Title: Log4r - Manual
Template: main.html
Id: $Id: index.html,v 1.5 2002/08/20 05:59:04 cepheus Exp $
Log4r is a comprehensive and flexible logging library written in Ruby
for use in Ruby programs. It features a heiarchial logging system
of any number of levels, custom level names, logger inheritance,
multiple output destinations, execution tracing, custom formatting, thread
safteyness and more.
Log4r is an adherent to the philosophy of logging using simple print
statements. What Log4r adds to this philosophy is a flexible way of
controling the information being logged. Log information can be sent to
any kind of destination and with varying degrees of importance. Log4r is
designed so that logging statements can remain in production code at
almost no extra cost, all that's needed is a switch to turn logging off.
Log4r intends to be easy to use and configure, no matter the complexity.
Casual scripts can use Log4r right away with minimal configuration, while
complicated applications can set up an XML configuration using a concise XML
schema. Log4r comes with comprehensive documentation and plenty of examples,
making it a breeze to learn. Furthermore, Log4r attempts to abide by the
Principle of Least Surprise, which means that it works as intended at all
points.
While Log4r is interpreted, it attempts to achieve optimal performance and
scale well. Already, plans are being made to write the performance-critical
components as a C extension to Ruby.
Log4r was inspired by and provides much of the features of the
Apache Log4j
project, but is not a direct implementation or clone. Aside from superficial
similarities, the projects are not related in any way and the code base is
completely distinct. Log4r was developed without even looking at the
Apache Log4j code.
Log4r is an Open Source project and intends to remain that way. The Log4r
license is similar to the Ruby Language license. It resides on
this page and in the distribution in a file
named LICENSE.
Follow these steps:
- Download the latest version from
this page
- Try out the examples in the examples directory of the distribution
- Install by running ruby install.rb
- Read the nice manual
- Use Log4r
- Consult the Log4r RDoc API for reference
-
Get REXML to take advantage of the XML config
- Contribute!
Have fun!
|