File: logging.html

package info (click to toggle)
libproxool-java 0.9.0~rc3-2
  • links: PTS, VCS
  • area: contrib
  • in suites: lenny
  • size: 2,416 kB
  • ctags: 2,446
  • sloc: java: 13,891; xml: 802; makefile: 12; sh: 10
file content (319 lines) | stat: -rw-r--r-- 11,073 bytes parent folder | download
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319






<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">





<html>
  <head>
    <meta http-equiv="Content-Language" content="en-gb">
    <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
    <meta http-equiv="Expires" content="-1">
    <meta http-equiv="Pragma" content="no-cache">
    <title>Proxool 0.9.0RC3</title>
    <link href="proxool.css" type="text/css" rel="stylesheet">
  </head>

  <body>

 <div style="max-width: 1200px;">
    <table border="0" style="min-height: 100%;" cellpadding="0" cellspacing="0" width="100%">
      <tbody>

        <tr>
          <td valign="bottom" width="150">
            &nbsp;
          </td>

          <td colspan="2" height="50">
            
              <div class="bannerFinal">
            
            
            <table cellpadding="0" cellspacing="0" border="0" width="100%">
                <tr>
                  <td height="50">
                    <span class="titleCaption" style="font-size: 110%; padding: 4px;">
                        Logging
                    </span>
                    
                  </td>
                  <td valign="middle" height="50">
                    <div>
                      

<div style="float: right; margin-right: 8px;">
    <img src="images/dots.gif" width="80" height="20" border="0" alt="...">

    <a href="http://sourceforge.net/projects/proxool"><img src="images/sflogo.png" width="88" height="31" border="0" alt="SourceForge.net Logo"></a>

</div>

                    </div>
                  </td>
                </tr>
            </table>
            </div>
          <td width="10">&nbsp;</td>
        </tr>

        <tr>
          <td valign="top" width="150">
            &nbsp;<br/>
            &nbsp;<br/>
            <table
              cellpadding="0"
              cellspacing="0"
              border="0"
              width="100%"
            >
              <tbody>

                <tr>
                  <td valign="top">
                    
                    
                    
                    
                    



<div class="menuBox" >
    <div class="menu-inactive"><a class="menu-inactive" href="index.html">Home</a></div>
    <div class="menu-inactive"><a class="menu-inactive" href="news.html">News</a></div>
    <div class="menu-inactive"><a class="menu-inactive" href="faq.html">FAQ</a></div>
    <div class="menu-inactive"><a class="menu-inactive" href="tips.html">Tips</a></div>
    <div class="menu-inactive"><a class="menu-inactive" href="changelog.html">Changes</a></div>
    <div class="menu-inactive"><a class="menu-inactive" href="future.html">The Future</a></div>
    
    <div class="menu-active"><a class="menu-active" href="user.html">User&nbsp;Guide</a></div>
    
        <div class="menu-inactive"><a class="menu-inactive" href="dev.html">Developer&nbsp;Guide</a></div>
    
    <div class="menu-inactive"><a class="menu-inactive" href="licence.html">Licence</a></div>
    <div class="menu-inactive"><a class="menu-inactive" href="credits.html">Credits</a></div>
    <div class="menu-separater">User Guide:</div>
    <div style="margin-left: 8px">
        <div class="menu-inactive"><a class="menu-inactive" href="user.html">Introduction</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="quickStart.html">Quick start</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="properties.html">Properties</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="configure.html">Configuration</a></div>
        <div class="menu-active"><a class="menu-active" href="logging.html">Logging</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="admin.html">Admin</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="adminServlet.html">AdminServlet</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="listen.html">Events</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="servlets.html">Servlets</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="api/index.html">Simple API</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="howitworks.html">How it works</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="datasource.html">DataSource</a></div>
        <div class="menu-inactive"><a class="menu-inactive" href="injectableInterfaces.html">Injectable Interfaces</a></div>
    </div>
</div>
                  </td>
                  <td>&nbsp;</td>
                </tr>

                <tr>
                  <td>
                    

                    <table cellpadding="0" cellspacing="0" border="0" summary="">
                      <tbody>

                    <tr><td>







    <div class="rightItem">
        <div class="rightItemHeader">Version 0.9.0RC3</div>
        <div class="rightItemContent">
            The latest version of this documentation and software is available on our web site:
            <br/><a href="http://proxool.sf.net">proxool.sf.net</a>
        </div>
    </div>

<div class="rightItem">
    <div class="rightItemHeader">Donations</div>
    <div class="rightItemContent">
        You can donate to Proxool in the usual way:
        <br/><a href="http://sourceforge.net/project/project_donations.php?group_id=53958">sourceforge.net</a>
    </div>
</div>
</td></tr>

                <tr>
                    <td>
                        
<div class="footer">
                last&nbsp;updated: 10-Jan-2007
</div>



                    </td>
                </tr>
        </tbody>
      </table>

                  </td>
                  <td>&nbsp;</td>
                </tr>

              </tbody>
            </table>
          </td>

          <td valign="top" colspan="2">
            <table cellpadding="0" cellspacing="0" border="0" width="100%" summary="">
              <tbody>
                <tr>
                  <td class="contents" valign="top">
                    <p>By default, all logging is done to stdout. This probably isn't what
you want so it is wise to configure your logging to do something more
sensible.</p>

<p>Proxool uses Jakarta's Commons'
<a href="http://jakarta.apache.org/commons/logging.html">Logging</a>
component.</p>

<p>"There are many logging APIs
out there and it is difficult to choose among them. The Logging package is an ultra-thin
bridge between different logging libraries.
This removes compile-time and
run-time dependencies on any particular logging package, and contributors may
write Log implementations for the library of their choice."</p>

<p>The following logging libraries are supported directly:</p>

<div style="margin-left: 8px">

    <p><a href="http://jakarta.apache.org/log4j">Log4J</a></p>

    <p><a href="http://jakarta.apache.org/avalon/logkit/">LogKit</a></p>

    <p><a href="http://java.sun.com/j2se/1.4/docs/api/java/util/logging/package-summary.html">JDK 1.4</a></p>

</div>

<p>However, there is no reason why you shouldn't write your own implementation of
<a href="api/org/logicalcobwebs/proxool/logging/Log.html">Log</a> and log
wherever you wish.</p>

<hr/>

<!--
<p><b>Very simple configuration</b></p>

<p>By default, everything is written to stdout (or is it stderr?) at a logging level of
INFO (which means DEBUG messages are ignored). You can change the level
without having to setup something like Log4J by setting a System property:</p>

<div class="codeSample">
System.setProperty("org.apache.commons.logging.simplelog.defaultlog", "debug");
</div>

<p>But I would highly recommend choosing something like Log4J (I have no experience
of LogKit) for better flexibility and setup. It doesn't take long.</p>

<hr/>

-->
<p><b>Log4J Configuration</b></p>

<p>As an example, this is how we configure Log4J for use when we run Proxool's
unit tests.</p>

<p>First, create your configuration file (which we have called log4j.xml):</p>

<div class="codeSample">
&lt;?xml version="1.0" encoding="UTF-8" ?&gt;<br/>
&lt;!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"&gt;<br/>
<br/>
&lt;log4j:configuration&gt;<br/>
<br/>
&lt;appender name="general" class="org.apache.log4j.DailyRollingFileAppender"&gt;<br/>
&nbsp;&nbsp;&lt;param name="File" value="/var/log/proxool/general.log"/&gt;<br/>
&nbsp;&nbsp;&lt;param name="DatePattern" value="'.'yyyy-MM-dd"/&gt;<br/>
&nbsp;&nbsp;&lt;layout class="org.apache.log4j.PatternLayout"&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;param name="ConversionPattern" value="%d{DATE} [%-5p] %c {%F:%L} - %m%n"/&gt;<br/>
&nbsp;&nbsp;&lt;/layout&gt;<br/>
&lt;/appender&gt;<br/>
<br/>
&lt;root&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;priority value="DEBUG"/&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;appender-ref ref="general"/&gt;<br/>
&lt;/root&gt;<br/>
<br/>
&lt;/log4j:configuration&gt;
</div>

<p>This will log to /var/log/proxool/general.log and then archive the log every day to a new file.</p>

<p>You can easily log each pool to a different file. Just configure an appender for each pool and then
add the following &lt;category&gt; element <b>just before</b> the &lt;root&gt; element. For
example, to set up the log for the 'test' pool:</p>

<div class="codeSample">
&lt;category name="org.logicalcobwebs.proxool.test"&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;appender-ref ref="test-appender"/&gt;<br/>
&lt;/category&gt;
</div>

<p>And then you just need to point Log4J to that file:</p>

<div class="codeSample">
org.apache.log4j.xml.DOMConfigurator.configureAndWatch(log4jPath);
</div>

<p><b>Using Log4J's Chainsaw GUI log viewer</b></p>

<p>You might find it really useful to use Chainsaw (part of Log4J). It's a Java Swing application that will listen
to log events. You can even set it up to work on a different machine. All you have to do is setup
a special appender:</p>

<div class="codeSample">
&lt;appender name="chainsaw" class="org.apache.log4j.net.SocketAppender"&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;param name="remoteHost" value="localhost"/&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;param name="port" value="4445"/&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;param name="locationInfo" value="true"/&gt;<br/>
&lt;/appender&gt;
</div>

<p>And then you just startup Chainsaw:</p>

<div class="codeSample">
    java -classpath log4j.jar org.apache.log4j.chainsaw.Main
</div>

<p>Obviously, you should include the correct path to your log4j.jar.</p>
                  </td>
                </tr>
              </tbody>
            </table>
          </td>
        </tr>

      </tbody>
    </table>
  </div>
  </body>

  <head>
    <meta http-equiv="Expires" content="-1">
    <meta http-equiv="Pragma" content="no-cache">
  </head>

</html>