forked from incubus/log4r
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
95 lines (65 loc) · 3.1 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
Log4r - A flexible logging library for Ruby
This release: 1.1.11
Release date: 04/Jan/2014
License: BSD
Maintainer: Colby Gutierrez-Kraybill
Contributors: Leon Torres Original Maintainer
Martain Stannard RollingFileOutputter
Steve Lumos SyslogOutputter
Mark Lewandowski ScribeOutputter
Andreas Hund YamlConfigurator
Jamis Buck log4r.gemspec
Charles Strahan log4jxml/chainsaw integration
Nitay Joffe STARTTLS
David Siegal Smart updates to RollingFileOutputter
Homepage: http://log4r.rubyforge.org/
Download: http://rubyforge.org/frs/?group_id=203
Summary
-------
Log4r is a comprehensive and flexible logging library written in Ruby for use
in Ruby programs. It features a hierarchical logging system of any number of
levels, custom level names, logger inheritance, multiple output destinations
per log event, execution tracing, custom formatting, thread safteyness, XML
and YAML configuration, and more.
Requirements
------------
* (required) Ruby >= 1.7.0 (use log4r 1.0.2 for Ruby 1.6)
* (optional) RubyGems for installing Log4r as a gem
* (optional) Ruby syslog library for SyslogOutputter
* (optional) XML configuration requires REXML
* (optional) log4j chainsaw integration requires 'builder' >= 2.0
* (optional) STARTTLS email login, requires 'smtp_tls" if Ruby <= 1.8.6
More Info
---------
* Installation instructions are in the file INSTALL
* Comprehensive examples are provided in examples/ and can be run right away
* Log4r homepage: doc/index.html
Online: http://log4r.rubyforge.org/
* Manual: doc/manual.html
Online: http://log4r.rubyforge.org/manual.html
* RDoc API reference: doc/rdoc/index.html
Online: http://log4r.rubyforge.org/rdoc/index.html
* The changelog
* Log4r is hosted by RubyForge, which provides news, bug tracking and a forum
* Feel free to bug the maintainer with any questions (listed at top of file)
Usability
---------
Log4r works really well, so please take advantage of it right away! :)
All versions since 0.9.2 have been stable and backward-compatible. The
code is stable enough that updates are infrequent and usually only for
adding features or keeping the code up to date with Ruby.
Platform Issues
---------------
Log4r is known to work on Linux and WindowsXP. It's safe to assume that Log4r
will work on any Ruby-supported platform.
When Trouble Strikes
--------------------
Log4r comes with an internal logger. To see its output, create a logger
named 'log4r' before any others and give it a suitable outputter,
trouble = Logger.new['log4r']
trouble.add Outputter.stdout
Try running the unit tests provided (run the file tests/runtest.rb). Let
the maintainer know what's up and feel free to explore and fix the
code yourself. It's well documented and written in Ruby. :)
Also, try out the bug/request tracking system at
http://rubyforge.org/tracker/?group_id=203