log4r 1.1.1 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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/StdoutOutputter.html ADDED
@@ -0,0 +1,250 @@
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
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Log4r::StdoutOutputter</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="file-metadata">
26
+ <div id="file-list-section" class="section">
27
+ <h3 class="section-header">In Files</h3>
28
+ <div class="section-body">
29
+ <ul>
30
+
31
+ <li><a href="../log4r/outputter/consoleoutputters_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/outputter/consoleoutputters.rb">log4r/outputter/consoleoutputters.rb</a></li>
33
+
34
+ </ul>
35
+ </div>
36
+ </div>
37
+
38
+
39
+ </div>
40
+
41
+ <div id="class-metadata">
42
+
43
+ <!-- Parent Class -->
44
+
45
+ <div id="parent-class-section" class="section">
46
+ <h3 class="section-header">Parent</h3>
47
+
48
+ <p class="link">IOOutputter</p>
49
+
50
+ </div>
51
+
52
+
53
+ <!-- Namespace Contents -->
54
+
55
+
56
+ <!-- Method Quickref -->
57
+
58
+ <div id="method-list-section" class="section">
59
+ <h3 class="section-header">Methods</h3>
60
+ <ul class="link-list">
61
+
62
+ <li><a href="#M000059">::new</a></li>
63
+
64
+ </ul>
65
+ </div>
66
+
67
+
68
+ <!-- Included Modules -->
69
+
70
+ </div>
71
+
72
+ <div id="project-metadata">
73
+
74
+
75
+ <div id="fileindex-section" class="section project-section">
76
+ <h3 class="section-header">Files</h3>
77
+ <ul>
78
+
79
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
80
+
81
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
82
+
83
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
84
+
85
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
86
+
87
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
88
+
89
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
90
+
91
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
92
+
93
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
94
+
95
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
96
+
97
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
98
+
99
+ </ul>
100
+ </div>
101
+
102
+
103
+ <div id="classindex-section" class="section project-section">
104
+ <h3 class="section-header">Class Index
105
+ <span class="search-toggle"><img src="../images/find.png"
106
+ height="16" width="16" alt="[+]"
107
+ title="show/hide quicksearch" /></span></h3>
108
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
109
+ <fieldset>
110
+ <legend>Quicksearch</legend>
111
+ <input type="text" name="quicksearch" value=""
112
+ class="quicksearch-field" />
113
+ </fieldset>
114
+ </form>
115
+
116
+ <ul class="link-list">
117
+
118
+ <li><a href="../Log4r.html">Log4r</a></li>
119
+
120
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
121
+
122
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
123
+
124
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
125
+
126
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
127
+
128
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
129
+
130
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
131
+
132
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
133
+
134
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
135
+
136
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
137
+
138
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
139
+
140
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
141
+
142
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
143
+
144
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
145
+
146
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
147
+
148
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
149
+
150
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
151
+
152
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
153
+
154
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
155
+
156
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
157
+
158
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
159
+
160
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
161
+
162
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
163
+
164
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
165
+
166
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
167
+
168
+ </ul>
169
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
170
+ </div>
171
+
172
+
173
+ </div>
174
+ </div>
175
+
176
+ <div id="documentation">
177
+ <h1 class="class">Log4r::StdoutOutputter</h1>
178
+
179
+ <div id="description">
180
+ <p>
181
+ Same as IOOutputter(name, $stdout)
182
+ </p>
183
+
184
+ </div>
185
+
186
+ <!-- Constants -->
187
+
188
+
189
+ <!-- Attributes -->
190
+
191
+
192
+ <!-- Methods -->
193
+
194
+ <div id="public-class-method-details" class="method-section section">
195
+ <h3 class="section-header">Public Class Methods</h3>
196
+
197
+
198
+ <div id="new-method" class="method-detail ">
199
+ <a name="M000059"></a>
200
+
201
+ <div class="method-heading">
202
+
203
+ <span class="method-name">new</span><span
204
+ class="method-args">(_name, hash={})</span>
205
+ <span class="method-click-advice">click to toggle source</span>
206
+
207
+ </div>
208
+
209
+ <div class="method-description">
210
+
211
+ <p class="missing-docs">(Not documented)</p>
212
+
213
+
214
+
215
+ <div class="method-source-code"
216
+ id="new-source">
217
+ <pre>
218
+ <span class="ruby-comment cmt"># File log4r/outputter/consoleoutputters.rb, line 7</span>
219
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>={})
220
+ <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">$stdout</span>, <span class="ruby-identifier">hash</span>)
221
+ <span class="ruby-keyword kw">end</span></pre>
222
+ </div>
223
+
224
+ </div>
225
+
226
+
227
+ </div>
228
+
229
+
230
+ </div>
231
+
232
+
233
+ </div>
234
+
235
+
236
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
237
+
238
+ <p>Disabled; run with --debug to generate this.</p>
239
+
240
+ </div>
241
+
242
+ <div id="validator-badges">
243
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
244
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
245
+ Rdoc Generator</a> 1.1.6</small>.</p>
246
+ </div>
247
+
248
+ </body>
249
+ </html>
250
+
data/src/doc/Log4r/SyslogOutputter.html ADDED
@@ -0,0 +1,533 @@
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
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Log4r::SyslogOutputter</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="file-metadata">
26
+ <div id="file-list-section" class="section">
27
+ <h3 class="section-header">In Files</h3>
28
+ <div class="section-body">
29
+ <ul>
30
+
31
+ <li><a href="../log4r/outputter/syslogoutputter_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/outputter/syslogoutputter.rb">log4r/outputter/syslogoutputter.rb</a></li>
33
+
34
+ </ul>
35
+ </div>
36
+ </div>
37
+
38
+
39
+ </div>
40
+
41
+ <div id="class-metadata">
42
+
43
+ <!-- Parent Class -->
44
+
45
+ <div id="parent-class-section" class="section">
46
+ <h3 class="section-header">Parent</h3>
47
+
48
+ <p class="link">Outputter</p>
49
+
50
+ </div>
51
+
52
+
53
+ <!-- Namespace Contents -->
54
+
55
+
56
+ <!-- Method Quickref -->
57
+
58
+ <div id="method-list-section" class="section">
59
+ <h3 class="section-header">Methods</h3>
60
+ <ul class="link-list">
61
+
62
+ <li><a href="#M000103">::new</a></li>
63
+
64
+ <li><a href="#M000108">#canonical_log</a></li>
65
+
66
+ <li><a href="#M000105">#close</a></li>
67
+
68
+ <li><a href="#M000104">#closed?</a></li>
69
+
70
+ <li><a href="#M000107">#get_levels_map</a></li>
71
+
72
+ <li><a href="#M000106">#map_levels_by_name_to_syslog</a></li>
73
+
74
+ </ul>
75
+ </div>
76
+
77
+
78
+ <!-- Included Modules -->
79
+
80
+ <div id="includes-section" class="section">
81
+ <h3 class="section-header">Included Modules</h3>
82
+ <ul class="link-list">
83
+
84
+
85
+ <li><span class="include">Syslog::Constants</span></li>
86
+
87
+
88
+ </ul>
89
+ </div>
90
+
91
+ </div>
92
+
93
+ <div id="project-metadata">
94
+
95
+
96
+ <div id="fileindex-section" class="section project-section">
97
+ <h3 class="section-header">Files</h3>
98
+ <ul>
99
+
100
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
101
+
102
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
103
+
104
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
105
+
106
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
107
+
108
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
109
+
110
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
111
+
112
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
113
+
114
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
115
+
116
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
117
+
118
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
119
+
120
+ </ul>
121
+ </div>
122
+
123
+
124
+ <div id="classindex-section" class="section project-section">
125
+ <h3 class="section-header">Class Index
126
+ <span class="search-toggle"><img src="../images/find.png"
127
+ height="16" width="16" alt="[+]"
128
+ title="show/hide quicksearch" /></span></h3>
129
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
130
+ <fieldset>
131
+ <legend>Quicksearch</legend>
132
+ <input type="text" name="quicksearch" value=""
133
+ class="quicksearch-field" />
134
+ </fieldset>
135
+ </form>
136
+
137
+ <ul class="link-list">
138
+
139
+ <li><a href="../Log4r.html">Log4r</a></li>
140
+
141
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
142
+
143
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
144
+
145
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
146
+
147
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
148
+
149
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
150
+
151
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
152
+
153
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
154
+
155
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
156
+
157
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
158
+
159
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
160
+
161
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
162
+
163
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
164
+
165
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
166
+
167
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
168
+
169
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
170
+
171
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
172
+
173
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
174
+
175
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
176
+
177
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
178
+
179
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
180
+
181
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
182
+
183
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
184
+
185
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
186
+
187
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
188
+
189
+ </ul>
190
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
191
+ </div>
192
+
193
+
194
+ </div>
195
+ </div>
196
+
197
+ <div id="documentation">
198
+ <h1 class="class">Log4r::SyslogOutputter</h1>
199
+
200
+ <div id="description">
201
+
202
+ </div>
203
+
204
+ <!-- Constants -->
205
+
206
+ <div id="constants-list" class="section">
207
+ <h3 class="section-header">Constants</h3>
208
+ <dl>
209
+
210
+ <dt><a name="SYSLOG_LEVELS_MAP">SYSLOG_LEVELS_MAP</a></dt>
211
+
212
+ <dd class="description"><p>
213
+ maps default log4r levels to syslog priorities (logevents never see ALL and
214
+ OFF) SYSLOG Levels are:
215
+ </p>
216
+ <pre>
217
+ &quot;DEBUG&quot; =&gt; Syslog::LOG_DEBUG
218
+ &quot;INFO&quot; =&gt; Syslog::LOG_INFO
219
+ &quot;NOTICE&quot; =&gt; Syslog::LOG_NOTICE
220
+ &quot;WARN&quot; =&gt; Syslog::LOG_WARN
221
+ &quot;ERROR&quot; =&gt; Syslog::LOG_ERROR
222
+ &quot;FATAL&quot; =&gt; Syslog::LOG_FATAL
223
+ &quot;ALERT&quot; =&gt; Syslog::LOG_ALERT
224
+ &quot;EMERG&quot; =&gt; Syslog::LOG_EMERG
225
+ </pre></dd>
226
+
227
+
228
+ <dt><a name="SYSLOG_LOG4R_MAP">SYSLOG_LOG4R_MAP</a></dt>
229
+
230
+ <dd class="description"><p>
231
+ mapping from <a href="../Log4r.html">Log4r</a> default levels to syslog, by
232
+ string name &#8220;DEBUG&#8221; => &#8220;DEBUG&#8220;
233
+ </p>
234
+ <pre>
235
+ &quot;INFO&quot; =&gt; &quot;INFO&quot;
236
+ &quot;WARN&quot; =&gt; &quot;WARN&quot;
237
+ &quot;ERROR&quot; =&gt; &quot;ERROR&quot;
238
+ &quot;FATAL&quot; =&gt; &quot;FATAL&quot;
239
+ </pre></dd>
240
+
241
+
242
+ </dl>
243
+ </div>
244
+
245
+
246
+ <!-- Attributes -->
247
+
248
+
249
+ <!-- Methods -->
250
+
251
+ <div id="public-class-method-details" class="method-section section">
252
+ <h3 class="section-header">Public Class Methods</h3>
253
+
254
+
255
+ <div id="new-method" class="method-detail ">
256
+ <a name="M000103"></a>
257
+
258
+ <div class="method-heading">
259
+
260
+ <span class="method-name">new</span><span
261
+ class="method-args">(_name, hash={})</span>
262
+ <span class="method-click-advice">click to toggle source</span>
263
+
264
+ </div>
265
+
266
+ <div class="method-description">
267
+
268
+ <p>
269
+ There are 3 hash arguments
270
+ </p>
271
+ <dl>
272
+ <dt><tt>:ident</tt></dt><dd>syslog ident, defaults to _name
273
+
274
+ </dd>
275
+ <dt><tt>:logopt</tt></dt><dd>syslog logopt, defaults to LOG_PID | LOG_CONS
276
+
277
+ </dd>
278
+ <dt><tt>:facility</tt></dt><dd>syslog facility, defaults to LOG_USER
279
+
280
+ </dd>
281
+ </dl>
282
+
283
+
284
+
285
+ <div class="method-source-code"
286
+ id="new-source">
287
+ <pre>
288
+ <span class="ruby-comment cmt"># File log4r/outputter/syslogoutputter.rb, line 64</span>
289
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>={})
290
+ <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>)
291
+ <span class="ruby-identifier">ident</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:ident</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'ident'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">_name</span>)
292
+ <span class="ruby-identifier">logopt</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:logopt</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'logopt'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-constant">LOG_PID</span> <span class="ruby-operator">|</span> <span class="ruby-constant">LOG_CONS</span>).<span class="ruby-identifier">to_i</span>
293
+ <span class="ruby-identifier">facility</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:facility</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'facility'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-constant">LOG_USER</span>).<span class="ruby-identifier">to_i</span>
294
+ <span class="ruby-identifier">map_levels_by_name_to_syslog</span>()
295
+ <span class="ruby-keyword kw">if</span> ( <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">opened?</span> ) <span class="ruby-keyword kw">then</span>
296
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> { <span class="ruby-value str">&quot;Syslog already initialized, to alter, &quot;</span> <span class="ruby-operator">+</span>
297
+ <span class="ruby-value str">&quot;you must close first&quot;</span>}
298
+ <span class="ruby-keyword kw">end</span>
299
+ <span class="ruby-ivar">@syslog</span> = ( <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">opened?</span> ) <span class="ruby-operator">?</span> <span class="ruby-constant">Syslog</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">ident</span>, <span class="ruby-identifier">logopt</span>, <span class="ruby-identifier">facility</span>)
300
+ <span class="ruby-keyword kw">end</span></pre>
301
+ </div>
302
+
303
+ </div>
304
+
305
+
306
+ </div>
307
+
308
+
309
+ </div>
310
+
311
+ <div id="public-instance-method-details" class="method-section section">
312
+ <h3 class="section-header">Public Instance Methods</h3>
313
+
314
+
315
+ <div id="close-method" class="method-detail ">
316
+ <a name="M000105"></a>
317
+
318
+ <div class="method-heading">
319
+
320
+ <span class="method-name">close</span><span
321
+ class="method-args">()</span>
322
+ <span class="method-click-advice">click to toggle source</span>
323
+
324
+ </div>
325
+
326
+ <div class="method-description">
327
+
328
+ <p class="missing-docs">(Not documented)</p>
329
+
330
+
331
+
332
+ <div class="method-source-code"
333
+ id="close-source">
334
+ <pre>
335
+ <span class="ruby-comment cmt"># File log4r/outputter/syslogoutputter.rb, line 81</span>
336
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
337
+ <span class="ruby-ivar">@syslog</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@syslog</span>.<span class="ruby-identifier">nil?</span>
338
+ <span class="ruby-ivar">@level</span> = <span class="ruby-constant">OFF</span>
339
+ <span class="ruby-constant">OutputterFactory</span>.<span class="ruby-identifier">create_methods</span>(<span class="ruby-keyword kw">self</span>)
340
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;Outputter '#{@name}' closed Syslog and set to OFF&quot;</span>}
341
+ <span class="ruby-keyword kw">end</span></pre>
342
+ </div>
343
+
344
+ </div>
345
+
346
+
347
+ </div>
348
+
349
+
350
+ <div id="closed--method" class="method-detail ">
351
+ <a name="M000104"></a>
352
+
353
+ <div class="method-heading">
354
+
355
+ <span class="method-name">closed?</span><span
356
+ class="method-args">()</span>
357
+ <span class="method-click-advice">click to toggle source</span>
358
+
359
+ </div>
360
+
361
+ <div class="method-description">
362
+
363
+ <p class="missing-docs">(Not documented)</p>
364
+
365
+
366
+
367
+ <div class="method-source-code"
368
+ id="closed--source">
369
+ <pre>
370
+ <span class="ruby-comment cmt"># File log4r/outputter/syslogoutputter.rb, line 77</span>
371
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">closed?</span>
372
+ <span class="ruby-keyword kw">return</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@syslog</span>.<span class="ruby-identifier">opened?</span>
373
+ <span class="ruby-keyword kw">end</span></pre>
374
+ </div>
375
+
376
+ </div>
377
+
378
+
379
+ </div>
380
+
381
+
382
+ <div id="get-levels-map-method" class="method-detail ">
383
+ <a name="M000107"></a>
384
+
385
+ <div class="method-heading">
386
+
387
+ <span class="method-name">get_levels_map</span><span
388
+ class="method-args">()</span>
389
+ <span class="method-click-advice">click to toggle source</span>
390
+
391
+ </div>
392
+
393
+ <div class="method-description">
394
+
395
+ <p class="missing-docs">(Not documented)</p>
396
+
397
+
398
+
399
+ <div class="method-source-code"
400
+ id="get-levels-map-source">
401
+ <pre>
402
+ <span class="ruby-comment cmt"># File log4r/outputter/syslogoutputter.rb, line 110</span>
403
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_levels_map</span>()
404
+ <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@levels_map</span>
405
+ <span class="ruby-keyword kw">end</span></pre>
406
+ </div>
407
+
408
+ </div>
409
+
410
+
411
+ </div>
412
+
413
+
414
+ <div id="map-levels-by-name-to-syslog-method" class="method-detail ">
415
+ <a name="M000106"></a>
416
+
417
+ <div class="method-heading">
418
+
419
+ <span class="method-name">map_levels_by_name_to_syslog</span><span
420
+ class="method-args">( lmap = SYSLOG_LOG4R_MAP )</span>
421
+ <span class="method-click-advice">click to toggle source</span>
422
+
423
+ </div>
424
+
425
+ <div class="method-description">
426
+
427
+ <p>
428
+ A single hash argument that maps custom names to syslog names
429
+ </p>
430
+ <dl>
431
+ <dt><tt>levels_map</tt></dt><dd>A map that will create a linkage between levels in a hash and underlying
432
+ syslog levels. By default, these are direct mapping of the log4r levels
433
+ (e.g. &#8220;DEBUG&#8221; => &#8220;DEBUG&#8221;) If you have defined your
434
+ own custom levels, you should provide this underlying mapping, otherwise
435
+ all messages will be mapped to the underlying syslog level of INFO by
436
+ default. e.g. You have created custom levels called: <tt><a
437
+ href="Configurator.html#M000014">Configurator.custom_levels</a>
438
+ &quot;HIGH&quot;, &quot;MEDIUM&quot;, &quot;LOW&quot;</tt> To map these to
439
+ &#8216;equivilent&#8217; syslog levels, after instantiatin a
440
+ syslogoutputter: <tt><a
441
+ href="SyslogOutputter.html#M000106">SyslogOutputter.map_levels_by_name_to_syslog</a>(
442
+ { &quot;HIGH&quot; =&gt; &quot;ALERT&quot;, &quot;MEDIUM&quot; =&gt;
443
+ &quot;WARN&quot;, &quot;LOW&quot; =&gt; &quot;INFO&quot; } )</tt>
444
+
445
+ </dd>
446
+ </dl>
447
+
448
+
449
+
450
+ <div class="method-source-code"
451
+ id="map-levels-by-name-to-syslog-source">
452
+ <pre>
453
+ <span class="ruby-comment cmt"># File log4r/outputter/syslogoutputter.rb, line 106</span>
454
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">map_levels_by_name_to_syslog</span>( <span class="ruby-identifier">lmap</span> = <span class="ruby-constant">SYSLOG_LOG4R_MAP</span> )
455
+ <span class="ruby-ivar">@levels_map</span> = <span class="ruby-identifier">lmap</span>
456
+ <span class="ruby-keyword kw">end</span></pre>
457
+ </div>
458
+
459
+ </div>
460
+
461
+
462
+ </div>
463
+
464
+
465
+ </div>
466
+
467
+ <div id="private-instance-method-details" class="method-section section">
468
+ <h3 class="section-header">Private Instance Methods</h3>
469
+
470
+
471
+ <div id="canonical-log-method" class="method-detail ">
472
+ <a name="M000108"></a>
473
+
474
+ <div class="method-heading">
475
+
476
+ <span class="method-name">canonical_log</span><span
477
+ class="method-args">(logevent)</span>
478
+ <span class="method-click-advice">click to toggle source</span>
479
+
480
+ </div>
481
+
482
+ <div class="method-description">
483
+
484
+ <p class="missing-docs">(Not documented)</p>
485
+
486
+
487
+
488
+ <div class="method-source-code"
489
+ id="canonical-log-source">
490
+ <pre>
491
+ <span class="ruby-comment cmt"># File log4r/outputter/syslogoutputter.rb, line 116</span>
492
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">canonical_log</span>(<span class="ruby-identifier">logevent</span>)
493
+ <span class="ruby-identifier">pri</span> = <span class="ruby-constant">SYSLOG_LEVELS_MAP</span>[<span class="ruby-ivar">@levels_map</span>[<span class="ruby-constant">LNAMES</span>[<span class="ruby-identifier">logevent</span>.<span class="ruby-identifier">level</span>]]] <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">pri</span> = <span class="ruby-constant">LOG_INFO</span>
494
+ <span class="ruby-identifier">o</span> = <span class="ruby-identifier">format</span>(<span class="ruby-identifier">logevent</span>)
495
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Exception</span> <span class="ruby-keyword kw">then</span>
496
+ <span class="ruby-identifier">msg</span> = <span class="ruby-node">&quot;#{o.class} at (#{o.backtrace[0]}): #{o.message}&quot;</span>
497
+ <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">:to_str</span> <span class="ruby-keyword kw">then</span>
498
+ <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_str</span>
499
+ <span class="ruby-keyword kw">else</span>
500
+ <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">inspect</span>
501
+ <span class="ruby-keyword kw">end</span>
502
+
503
+ <span class="ruby-ivar">@syslog</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">pri</span>, <span class="ruby-value str">'%s'</span>, <span class="ruby-identifier">msg</span>)
504
+ <span class="ruby-keyword kw">end</span></pre>
505
+ </div>
506
+
507
+ </div>
508
+
509
+
510
+ </div>
511
+
512
+
513
+ </div>
514
+
515
+
516
+ </div>
517
+
518
+
519
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
520
+
521
+ <p>Disabled; run with --debug to generate this.</p>
522
+
523
+ </div>
524
+
525
+ <div id="validator-badges">
526
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
527
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
528
+ Rdoc Generator</a> 1.1.6</small>.</p>
529
+ </div>
530
+
531
+ </body>
532
+ </html>
533
+