psmith 2003/06/18 20:37:49
Modified: src/java/org/apache/log4j/chainsaw WelcomePanel.html
Log:
Beginnings of better documentation in Welcome panel.
added discussion of Receivers, and and what you could do with a
SocketAppender. added links to SocketAppender javadoc on Jakarta
Apache site.
Revision Changes Path
1.12 +29 -1
jakarta-log4j-sandbox/src/java/org/apache/log4j/chainsaw/WelcomePanel.html
Index: WelcomePanel.html
===================================================================
RCS file:
/home/cvs/jakarta-log4j-sandbox/src/java/org/apache/log4j/chainsaw/WelcomePanel.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- WelcomePanel.html 18 Jun 2003 23:03:35 -0000 1.11
+++ WelcomePanel.html 19 Jun 2003 03:37:49 -0000 1.12
@@ -3,7 +3,7 @@
<HEAD>
<style>
BODY, TABLE, TD, {
- font-size: 12px;
+ font-size: 10px;
color: #000000;
font-family: Arial, Tahoma, Helvetica, sans-serif;
}
@@ -99,6 +99,34 @@
</tr>
</table></P>
<!--<p><a href="#TheTop">Back to top</a></p>-->
+<a name="Receivers"></a>
+<h2>Receivers</h2>
+<p>Log4j has a concept of a 'Receiver', an object that receives events
+from some source, and deposits them into the Log4j framework in the local JVM.
+It useful to think of Log4j's engine as a 'bus' much like the PCI bus in a computer,
+with events being the data placed on the bus.</p>
+
+<p>Since Chainsaw acts just like a Log4j Appender, using a Receiver allows\
+you to receive events from, say, a remote location, and view them within the
+Chainsaw GUI.</p>
+
+<p>Receivers are the complimentary 'sibling' if you will of Log4j Appenders.
+Appenders take an event from the Log4j bus, and output them to some location.
+A Receiver is just the opposite, it takes an external event and
+places it in the local Log4j bus. A Receiver can be a 'sink' for event
+data, while the Appender is the 'source'.
+</p>
+<a name="UsefulConfigs"></a>
+<h2>Useful Configuration</h2>
+<p>We'll discuss a very useful and common configuration. If you have
+an application that is using Log4j to log events, you are able to
+configure a series of appenders, and often this is just a simple FileAppender.
+An alternative is to configure a SocketAppender that transmits the event
+to a remote location. In this case, Chainsaw becomes this remote location.
+</p>
+<p>Click <a
href="http://jakarta.apache.org/log4j/docs/api/org/apache/log4j/net/SocketAppender.html";>here</a>
to learn more about <a
href="http://jakarta.apache.org/log4j/docs/api/org/apache/log4j/net/SocketAppender.html";>SocketAppenders</a>.</p>
+<p>Click here to learn more about Receivers (and SocketReceiver in particular).
+</P>
<a name="FAQ"></a>
<h2>FAQ</h2>
<p></p>@todo<p></p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
