log4r 1.1.1 → 1.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (107) hide show
  1. data/README +3 -3
  2. data/Rakefile +3 -3
  3. data/doc/rdoc-log4r.css +696 -0
  4. data/examples/syslogcustom.rb +6 -1
  5. data/src/doc/Log4r.html +392 -0
  6. data/src/doc/Log4r/BasicFormatter.html +370 -0
  7. data/src/doc/Log4r/ConfigError.html +207 -0
  8. data/src/doc/Log4r/Configurator.html +1050 -0
  9. data/src/doc/Log4r/DateFileOutputter.html +454 -0
  10. data/src/doc/Log4r/DefaultFormatter.html +205 -0
  11. data/src/doc/Log4r/EmailOutputter.html +636 -0
  12. data/src/doc/Log4r/FileOutputter.html +321 -0
  13. data/src/doc/Log4r/Formatter.html +291 -0
  14. data/src/doc/Log4r/IOOutputter.html +392 -0
  15. data/src/doc/Log4r/Log4rConfig.html +193 -0
  16. data/src/doc/Log4r/Log4rTools.html +370 -0
  17. data/src/doc/Log4r/LogEvent.html +360 -0
  18. data/src/doc/Log4r/LogServer.html +322 -0
  19. data/src/doc/Log4r/Logger.html +1132 -0
  20. data/src/doc/Log4r/Logger/LoggerFactory.html +200 -0
  21. data/src/doc/Log4r/Logger/Repository.html +207 -0
  22. data/src/doc/Log4r/ObjectFormatter.html +262 -0
  23. data/src/doc/Log4r/Outputter.html +910 -0
  24. data/src/doc/Log4r/Outputter/OutputterFactory.html +200 -0
  25. data/src/doc/Log4r/Outputter/consoleoutputters_rb.html +57 -0
  26. data/src/doc/Log4r/Outputter/datefileoutputter_rb.html +93 -0
  27. data/src/doc/Log4r/Outputter/emailoutputter_rb.html +179 -0
  28. data/src/doc/Log4r/Outputter/fileoutputter_rb.html +64 -0
  29. data/src/doc/Log4r/Outputter/iooutputter_rb.html +59 -0
  30. data/src/doc/Log4r/Outputter/outputter_rb.html +222 -0
  31. data/src/doc/Log4r/Outputter/outputterfactory_rb.html +62 -0
  32. data/src/doc/Log4r/Outputter/remoteoutputter_rb.html +59 -0
  33. data/src/doc/Log4r/Outputter/rollingfileoutputter_rb.html +66 -0
  34. data/src/doc/Log4r/Outputter/staticoutputter_rb.html +55 -0
  35. data/src/doc/Log4r/Outputter/syslogoutputter_rb.html +110 -0
  36. data/src/doc/Log4r/Outputter/tst_rb.html +54 -0
  37. data/src/doc/Log4r/PatternFormatter.html +422 -0
  38. data/src/doc/Log4r/ROMPClient.html +193 -0
  39. data/src/doc/Log4r/ROMPServer.html +193 -0
  40. data/src/doc/Log4r/RemoteOutputter.html +384 -0
  41. data/src/doc/Log4r/RollingFileOutputter.html +528 -0
  42. data/src/doc/Log4r/RootLogger.html +512 -0
  43. data/src/doc/Log4r/SimpleFormatter.html +258 -0
  44. data/src/doc/Log4r/StderrOutputter.html +250 -0
  45. data/src/doc/Log4r/StdoutOutputter.html +250 -0
  46. data/src/doc/Log4r/SyslogOutputter.html +533 -0
  47. data/src/doc/Log4r/YamlConfigurator.html +948 -0
  48. data/src/doc/Log4r/base_rb.html +57 -0
  49. data/src/doc/Log4r/config_rb.html +76 -0
  50. data/src/doc/Log4r/configurator_rb.html +370 -0
  51. data/src/doc/Log4r/formatter/formatter_rb.html +121 -0
  52. data/src/doc/Log4r/formatter/patternformatter_rb.html +233 -0
  53. data/src/doc/Log4r/lib/drbloader_rb.html +57 -0
  54. data/src/doc/Log4r/lib/xmlloader_rb.html +57 -0
  55. data/src/doc/Log4r/logevent_rb.html +55 -0
  56. data/src/doc/Log4r/logger_rb.html +293 -0
  57. data/src/doc/Log4r/loggerfactory_rb.html +66 -0
  58. data/src/doc/Log4r/logserver_rb.html +161 -0
  59. data/src/doc/Log4r/rdoc/configurator.html +444 -0
  60. data/src/doc/Log4r/rdoc/emailoutputter.html +261 -0
  61. data/src/doc/Log4r/rdoc/formatter.html +200 -0
  62. data/src/doc/Log4r/rdoc/log4r.html +268 -0
  63. data/src/doc/Log4r/rdoc/logger.html +364 -0
  64. data/src/doc/Log4r/rdoc/logserver.html +247 -0
  65. data/src/doc/Log4r/rdoc/outputter.html +295 -0
  66. data/src/doc/Log4r/rdoc/patternformatter.html +313 -0
  67. data/src/doc/Log4r/rdoc/syslogoutputter.html +179 -0
  68. data/src/doc/Log4r/rdoc/yamlconfigurator.html +169 -0
  69. data/src/doc/Log4r/repository_rb.html +62 -0
  70. data/src/doc/Log4r/staticlogger_rb.html +55 -0
  71. data/src/doc/Log4r/yamlconfigurator_rb.html +95 -0
  72. data/src/doc/REXML.html +193 -0
  73. data/src/doc/created.rid +1 -0
  74. data/src/doc/images/brick.png +0 -0
  75. data/src/doc/images/brick_link.png +0 -0
  76. data/src/doc/images/bug.png +0 -0
  77. data/src/doc/images/bullet_black.png +0 -0
  78. data/src/doc/images/bullet_toggle_minus.png +0 -0
  79. data/src/doc/images/bullet_toggle_plus.png +0 -0
  80. data/src/doc/images/date.png +0 -0
  81. data/src/doc/images/find.png +0 -0
  82. data/src/doc/images/loadingAnimation.gif +0 -0
  83. data/src/doc/images/macFFBgHack.png +0 -0
  84. data/src/doc/images/package.png +0 -0
  85. data/src/doc/images/page_green.png +0 -0
  86. data/src/doc/images/page_white_text.png +0 -0
  87. data/src/doc/images/page_white_width.png +0 -0
  88. data/src/doc/images/plugin.png +0 -0
  89. data/src/doc/images/ruby.png +0 -0
  90. data/src/doc/images/tag_green.png +0 -0
  91. data/src/doc/images/wrench.png +0 -0
  92. data/src/doc/images/wrench_orange.png +0 -0
  93. data/src/doc/images/zoom.png +0 -0
  94. data/src/doc/index.html +384 -0
  95. data/src/doc/js/darkfish.js +116 -0
  96. data/src/doc/js/jquery.js +32 -0
  97. data/src/doc/js/quicksearch.js +114 -0
  98. data/src/doc/js/thickbox-compressed.js +10 -0
  99. data/src/doc/rdoc.css +696 -0
  100. data/src/log4r.rb +2 -2
  101. data/src/log4r/formatter/patternformatter.rb +18 -2
  102. data/src/log4r/logger.rb +2 -2
  103. data/src/log4r/outputter/emailoutputter.rb +2 -0
  104. data/src/log4r/outputter/syslogoutputter.rb +29 -9
  105. data/src/log4r/outputter/tst.rb +8 -0
  106. metadata +99 -3
  107. data/examples/logs/simple.log +0 -1
data/src/doc/Log4r/rdoc/formatter.html ADDED
@@ -0,0 +1,200 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: formatter [1.1.2 Log4r API Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="../../js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="../../js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="../../js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="../../js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file">
24
+ <div id="metadata">
25
+ <div id="project-metadata">
26
+
27
+
28
+ <div id="fileindex-section" class="section project-section">
29
+ <h3 class="section-header">Files</h3>
30
+ <ul>
31
+
32
+ <li class="file"><a href="../../log4r/rdoc/configurator.html">configurator</a></li>
33
+
34
+ <li class="file"><a href="../../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
35
+
36
+ <li class="file"><a href="../../log4r/rdoc/formatter.html">formatter</a></li>
37
+
38
+ <li class="file"><a href="../../log4r/rdoc/log4r.html">log4r</a></li>
39
+
40
+ <li class="file"><a href="../../log4r/rdoc/logger.html">logger</a></li>
41
+
42
+ <li class="file"><a href="../../log4r/rdoc/logserver.html">logserver</a></li>
43
+
44
+ <li class="file"><a href="../../log4r/rdoc/outputter.html">outputter</a></li>
45
+
46
+ <li class="file"><a href="../../log4r/rdoc/patternformatter.html">patternformatter</a></li>
47
+
48
+ <li class="file"><a href="../../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
49
+
50
+ <li class="file"><a href="../../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
51
+
52
+ </ul>
53
+ </div>
54
+
55
+
56
+ <div id="classindex-section" class="section project-section">
57
+ <h3 class="section-header">Class Index
58
+ <span class="search-toggle"><img src="../../images/find.png"
59
+ height="16" width="16" alt="[+]"
60
+ title="show/hide quicksearch" /></span></h3>
61
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
62
+ <fieldset>
63
+ <legend>Quicksearch</legend>
64
+ <input type="text" name="quicksearch" value=""
65
+ class="quicksearch-field" />
66
+ </fieldset>
67
+ </form>
68
+
69
+ <ul class="link-list">
70
+
71
+ <li><a href="../../Log4r.html">Log4r</a></li>
72
+
73
+ <li><a href="../../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
74
+
75
+ <li><a href="../../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
76
+
77
+ <li><a href="../../Log4r/Configurator.html">Log4r::Configurator</a></li>
78
+
79
+ <li><a href="../../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
80
+
81
+ <li><a href="../../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
82
+
83
+ <li><a href="../../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
84
+
85
+ <li><a href="../../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
86
+
87
+ <li><a href="../../Log4r/Formatter.html">Log4r::Formatter</a></li>
88
+
89
+ <li><a href="../../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
90
+
91
+ <li><a href="../../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
92
+
93
+ <li><a href="../../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
94
+
95
+ <li><a href="../../Log4r/LogServer.html">Log4r::LogServer</a></li>
96
+
97
+ <li><a href="../../Log4r/Logger.html">Log4r::Logger</a></li>
98
+
99
+ <li><a href="../../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
100
+
101
+ <li><a href="../../Log4r/Outputter.html">Log4r::Outputter</a></li>
102
+
103
+ <li><a href="../../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
104
+
105
+ <li><a href="../../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
106
+
107
+ <li><a href="../../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
108
+
109
+ <li><a href="../../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
110
+
111
+ <li><a href="../../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
112
+
113
+ <li><a href="../../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
114
+
115
+ <li><a href="../../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
116
+
117
+ <li><a href="../../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
118
+
119
+ <li><a href="../../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
120
+
121
+ </ul>
122
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
123
+ </div>
124
+
125
+
126
+ </div>
127
+ </div>
128
+
129
+ <div id="documentation">
130
+ <h1>Formatters</h1>
131
+ <p>
132
+ Formatters are responsible for formatting LogEvent data. An Outputter
133
+ owning a Formatter will invoke the <a
134
+ href="../../Log4r/Formatter.html#M000007">Log4r::Formatter#format</a>
135
+ method prior to writing.
136
+ </p>
137
+ <h2>Available Formatters</h2>
138
+ <ul>
139
+ <li><a href="../../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a> -
140
+ default
141
+
142
+ </li>
143
+ <li><a href="../../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a> -
144
+ most flexible. See <a
145
+ href="../formatter/patternformatter_rb.html">log4r/formatter/patternformatter.rb</a>
146
+
147
+ </li>
148
+ <li><a href="../../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a> -
149
+ like BasicFormatter for Strings only (low noise)
150
+
151
+ </li>
152
+ <li><a href="../../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a> - for
153
+ inspecting objects
154
+
155
+ </li>
156
+ <li>Log4r::NullFormatter - twirls on its feet and does nothing
157
+
158
+ </li>
159
+ </ul>
160
+ <h1>XML Configuration</h1>
161
+ <p>
162
+ Specify the Formatter and its class (as <tt>type</tt>) under an
163
+ <tt>&lt;outputter&gt;</tt> directive:
164
+ </p>
165
+ <pre>
166
+ &lt;outputter name=&quot;someout&quot; type=&quot;sometype&quot;&gt;
167
+ &lt;formatter type=&quot;Log4r::BasicFormatter&quot;/&gt;
168
+ &lt;/outputter&gt;
169
+ </pre>
170
+ <p>
171
+ As explained in <a
172
+ href="../configurator_rb.html">log4r/configurator.rb</a>, the hash
173
+ arguments you would normally pass to <tt>new</tt> are specified as <em>XML
174
+ parameters</em>. Only PatternFormatter has any of these.
175
+ </p>
176
+ <h1>Custom Formatting</h1>
177
+ <p>
178
+ Building a custom Formatter is extremely easy. Just define a class that
179
+ extends Formatter and override the Formatter#format method. Then give it to
180
+ any interested Outputters.
181
+ </p>
182
+ <p>
183
+ If you&#8217;re interested in setting up your custom formatters in XML,
184
+ please take a look at log4r/configurator.rb.
185
+ </p>
186
+ <h2>Data Available</h2>
187
+ <p>
188
+ See <a href="../../Log4r/LogEvent.html">Log4r::LogEvent</a>
189
+ </p>
190
+
191
+ </div>
192
+
193
+ <div id="validator-badges">
194
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
195
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
196
+ Rdoc Generator</a> 1.1.6</small>.</p>
197
+ </div>
198
+ </body>
199
+ </html>
200
+
data/src/doc/Log4r/rdoc/log4r.html ADDED
@@ -0,0 +1,268 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: log4r [1.1.2 Log4r API Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="../../js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="../../js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="../../js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="../../js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file">
24
+ <div id="metadata">
25
+ <div id="project-metadata">
26
+
27
+
28
+ <div id="fileindex-section" class="section project-section">
29
+ <h3 class="section-header">Files</h3>
30
+ <ul>
31
+
32
+ <li class="file"><a href="../../log4r/rdoc/configurator.html">configurator</a></li>
33
+
34
+ <li class="file"><a href="../../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
35
+
36
+ <li class="file"><a href="../../log4r/rdoc/formatter.html">formatter</a></li>
37
+
38
+ <li class="file"><a href="../../log4r/rdoc/log4r.html">log4r</a></li>
39
+
40
+ <li class="file"><a href="../../log4r/rdoc/logger.html">logger</a></li>
41
+
42
+ <li class="file"><a href="../../log4r/rdoc/logserver.html">logserver</a></li>
43
+
44
+ <li class="file"><a href="../../log4r/rdoc/outputter.html">outputter</a></li>
45
+
46
+ <li class="file"><a href="../../log4r/rdoc/patternformatter.html">patternformatter</a></li>
47
+
48
+ <li class="file"><a href="../../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
49
+
50
+ <li class="file"><a href="../../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
51
+
52
+ </ul>
53
+ </div>
54
+
55
+
56
+ <div id="classindex-section" class="section project-section">
57
+ <h3 class="section-header">Class Index
58
+ <span class="search-toggle"><img src="../../images/find.png"
59
+ height="16" width="16" alt="[+]"
60
+ title="show/hide quicksearch" /></span></h3>
61
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
62
+ <fieldset>
63
+ <legend>Quicksearch</legend>
64
+ <input type="text" name="quicksearch" value=""
65
+ class="quicksearch-field" />
66
+ </fieldset>
67
+ </form>
68
+
69
+ <ul class="link-list">
70
+
71
+ <li><a href="../../Log4r.html">Log4r</a></li>
72
+
73
+ <li><a href="../../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
74
+
75
+ <li><a href="../../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
76
+
77
+ <li><a href="../../Log4r/Configurator.html">Log4r::Configurator</a></li>
78
+
79
+ <li><a href="../../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
80
+
81
+ <li><a href="../../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
82
+
83
+ <li><a href="../../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
84
+
85
+ <li><a href="../../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
86
+
87
+ <li><a href="../../Log4r/Formatter.html">Log4r::Formatter</a></li>
88
+
89
+ <li><a href="../../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
90
+
91
+ <li><a href="../../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
92
+
93
+ <li><a href="../../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
94
+
95
+ <li><a href="../../Log4r/LogServer.html">Log4r::LogServer</a></li>
96
+
97
+ <li><a href="../../Log4r/Logger.html">Log4r::Logger</a></li>
98
+
99
+ <li><a href="../../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
100
+
101
+ <li><a href="../../Log4r/Outputter.html">Log4r::Outputter</a></li>
102
+
103
+ <li><a href="../../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
104
+
105
+ <li><a href="../../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
106
+
107
+ <li><a href="../../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
108
+
109
+ <li><a href="../../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
110
+
111
+ <li><a href="../../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
112
+
113
+ <li><a href="../../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
114
+
115
+ <li><a href="../../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
116
+
117
+ <li><a href="../../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
118
+
119
+ <li><a href="../../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
120
+
121
+ </ul>
122
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
123
+ </div>
124
+
125
+
126
+ </div>
127
+ </div>
128
+
129
+ <div id="documentation">
130
+ <h1>#{version} <a href="../../Log4r.html">Log4r</a> API Reference</h1>
131
+ <p>
132
+ Welcome to the <a href="../../Log4r.html">Log4r</a> API reference. There
133
+ are two classes of reference, the file overview and the class API. They are
134
+ listed under Files and Classes respectively. File overviews cover the use
135
+ of the <a href="../../Log4r.html">Log4r</a> API and some implementation
136
+ details, whereas class APIs detail the methods available to the various
137
+ objects.
138
+ </p>
139
+ <p>
140
+ The code examples in this API assume:
141
+ </p>
142
+ <pre>
143
+ include Log4r
144
+ </pre>
145
+ <p>
146
+ This file overview covers some of the major concepts in <a
147
+ href="../../Log4r.html">Log4r</a>.
148
+ </p>
149
+ <h2>Log Levels</h2>
150
+ <p>
151
+ <a href="../../Log4r.html">Log4r</a> provides as many levels of logging as
152
+ desired. Logging levels are an ordered set of names ranked by priority. The
153
+ more important a level is, the higher its priority and the more likely we
154
+ want to see any data associated with it. <a
155
+ href="../../Log4r.html">Log4r</a> provides many ways to filter information
156
+ by level.
157
+ </p>
158
+ <p>
159
+ Loggers and Outputters have a level parameter which serves as a level
160
+ threshold. Any data below this threshold will be ignored by the Logger or
161
+ Outputter. Additionally, Outputters can be set to mask out any particular
162
+ level or collection of levels.
163
+ </p>
164
+ <p>
165
+ By combining level thresholds with other <a
166
+ href="../../Log4r.html">Log4r</a> features, one can direct any set of data
167
+ to any destination desired in a way that is easy to visualize and
168
+ configure.
169
+ </p>
170
+ <h3>Default Levels</h3>
171
+ <p>
172
+ The default log levels and their priority rankings are:
173
+ </p>
174
+ <pre>
175
+ DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL
176
+ </pre>
177
+ <h3>Custom Levels</h3>
178
+ <p>
179
+ You can have as many levels as you desire, with any naming scheme. <a
180
+ href="../../Log4r.html">Log4r</a> will automatically define level constants
181
+ and log method names after your custom specification.
182
+ </p>
183
+ <p>
184
+ Please see <a href="../configurator_rb.html">log4r/configurator.rb</a> for
185
+ details.
186
+ </p>
187
+ <h3>Boundary Levels</h3>
188
+ <p>
189
+ There are two special levels, <tt>ALL</tt> and <tt>OFF</tt> which denote
190
+ whether we are logging at all levels or at none. The priority ranks with
191
+ respect to the logging levels are as follows:
192
+ </p>
193
+ <pre>
194
+ ALL &lt; logging levels as defined by user &lt; OFF
195
+ </pre>
196
+ <p>
197
+ Thus, setting the level to <tt>ALL</tt> will enable logging at all levels
198
+ whereas <tt>OFF</tt> will turn off logging completely.
199
+ </p>
200
+ <h2>File Overviews</h2>
201
+ <table>
202
+ <tr><td valign="top">For Loggers:</td><td><a href="../logger_rb.html">log4r/logger.rb</a>
203
+
204
+ </td></tr>
205
+ <tr><td valign="top">For Outputters:</td><td><a href="../outputter/outputter_rb.html">log4r/outputter/outputter.rb</a>
206
+
207
+ </td></tr>
208
+ <tr><td valign="top">For Formatters:</td><td><a href="../formatter/formatter_rb.html">log4r/formatter/formatter.rb</a>
209
+
210
+ </td></tr>
211
+ <tr><td valign="top">For configuration:</td><td><a href="../configurator_rb.html">log4r/configurator.rb</a>
212
+
213
+ </td></tr>
214
+ </table>
215
+ <h2>Principal Classes of <a href="../../Log4r.html">Log4r</a></h2>
216
+ <ul>
217
+ <li><a href="../../Log4r/Logger.html">Log4r::Logger</a> - Interface to logging
218
+
219
+ </li>
220
+ <li><a href="../../Log4r/Outputter.html">Log4r::Outputter</a> - An output
221
+ destination for a logger.
222
+
223
+ </li>
224
+ <li><a href="../../Log4r/Formatter.html">Log4r::Formatter</a> - A means of
225
+ formatting log data.
226
+
227
+ </li>
228
+ <li><a href="../../Log4r/Configurator.html">Log4r::Configurator</a> - A means
229
+ of configuring <a href="../../Log4r.html">Log4r</a>
230
+
231
+ </li>
232
+ </ul>
233
+ <h2>Convenience Classes</h2>
234
+ <p>
235
+ <a href="../../Log4r.html">Log4r</a> provides several convenience
236
+ Outputters and Formatters. Please look at the file overviews of those
237
+ classes for more details.
238
+ </p>
239
+ <h2>Remote Logging</h2>
240
+ <p>
241
+ <a href="../../Log4r.html">Log4r</a> provides a way to send log events over
242
+ a network. See <a href="../logserver_rb.html">log4r/logserver.rb</a> for
243
+ details.
244
+ </p>
245
+ <h2>What&#8217;s Going on Inside?</h2>
246
+ <p>
247
+ <a href="../../Log4r.html">Log4r</a> has an internal logger which records
248
+ much of what goes on inside. To see the output, define a Logger named
249
+ &#8216;log4r&#8217; and give it an Outputter of some sort. It logs only at
250
+ the lowest and highest priorities. That would be DEBUG and FATAL for the
251
+ standard setup.
252
+ </p>
253
+ <p>
254
+ It is essential to view this data when using certain classes, like <a
255
+ href="../../Log4r/LogServer.html">Log4r::LogServer</a> and <a
256
+ href="../../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a>.
257
+ </p>
258
+
259
+ </div>
260
+
261
+ <div id="validator-badges">
262
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
263
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
264
+ Rdoc Generator</a> 1.1.6</small>.</p>
265
+ </div>
266
+ </body>
267
+ </html>
268
+