/lib/apache-log4j/site/apidocs/org/apache/log4j/chainsaw/package-summary.html
HTML | 260 lines | 198 code | 46 blank | 16 comment | 0 complexity | 484c868fd2ec6f27fa1e03e22beec1c5 MD5 | raw file
Possible License(s): LGPL-2.1, BSD-3-Clause, Apache-2.0
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_16) -->
6<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<TITLE>
8org.apache.log4j.chainsaw (Apache Log4j 1.2.16 API)
9</TITLE>
10
11<META NAME="date" CONTENT="2010-03-30">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18 if (location.href.indexOf('is-external=true') == -1) {
19 parent.document.title="org.apache.log4j.chainsaw (Apache Log4j 1.2.16 API)";
20 }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40 <TR ALIGN="center" VALIGN="top">
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
49 </TR>
50</TABLE>
51</TD>
52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53</EM>
54</TD>
55</TR>
56
57<TR>
58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59 <A HREF="../../../../org/apache/log4j/package-summary.html"><B>PREV PACKAGE</B></A>
60 <A HREF="../../../../org/apache/log4j/config/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62 <A HREF="../../../../index.html?org/apache/log4j/chainsaw/package-summary.html" target="_top"><B>FRAMES</B></A>
63 <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
64 <SCRIPT type="text/javascript">
65 <!--
66 if(window==top) {
67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68 }
69 //-->
70</SCRIPT>
71<NOSCRIPT>
72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
73</NOSCRIPT>
74
75
76</FONT></TD>
77</TR>
78</TABLE>
79<A NAME="skip-navbar_top"></A>
80<!-- ========= END OF TOP NAVBAR ========= -->
81
82<HR>
83<H2>
84Package org.apache.log4j.chainsaw
85</H2>
86Chainsaw is a GUI log viewer and filter for the log4j
87package.
88<P>
89<B>See:</B>
90<BR>
91 <A HREF="#package_description"><B>Description</B></A>
92<P>
93
94<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
95<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
96<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
97<B>Class Summary</B></FONT></TH>
98</TR>
99<TR BGCOLOR="white" CLASS="TableRowColor">
100<TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/chainsaw/Main.html" title="class in org.apache.log4j.chainsaw">Main</A></B></TD>
101<TD>The main application.</TD>
102</TR>
103</TABLE>
104
105
106<P>
107<A NAME="package_description"><!-- --></A><H2>
108Package org.apache.log4j.chainsaw Description
109</H2>
110
111<P>
112<P>Chainsaw is a GUI log viewer and filter for the log4j
113package. By default it listens for <a
114href="../spi/LoggingEvent.html">LoggingEvent</A> objects sent using
115the <A href="../net/SocketAppender.html">SocketAppender</A> and
116displays them in a table. The events can be filtered based on:</P>
117
118 <UL>
119 <LI>Level </li>
120
121 <LI>Thread name</li>
122
123 <LI>Logger</li>
124 <LI>Message</li>
125
126 <LI>NDC</LI>
127 </UL>
128
129 <P>All the details for each event can be displayed by selecting
130 the event in the table.</P>
131
132 <P>Chainsaw also supports loading a events logged to a file using
133 the <A href="../xml/XMLLayout.html">XMLLayout</A> format. This
134 is great for analysing log files, and means you do not need to
135 keep Chainsaw running continously. It is easy to add support
136 for loading events from other sources like JDBC.</P>
137
138 <P>A picture is worth a thousand words: </P>
139
140 <P align=center><A
141 href="doc-files/screen_01.png"><IMG
142 height="50%" alt="Screen shot of chainsaw"
143 src="doc-files/screen_01.png"
144 width="50%"></A>.</P>
145
146 <P>Finally, why is it called chainsaw?
147 Because it cuts your log (file) down to size. :-)
148 </P>
149
150
151 <H2>Requirements</H2>
152
153 <P>Chainsaw is based on the Swing API which requires JDK 1.2 or later.</P>
154
155
156 <H2>Running chainsaw</H2>
157
158 <H3>Setup</H3>
159 <P>You need to include the <code>log4j.jar</code> in the classpath.
160
161 <H3>Usage</H3>
162
163 <P>The command line usage is:</P>
164
165 <PRE> java -D<property>=<value> org.apache.log4j.chainsaw.Main </PRE>
166
167 <P>The default behaviour of chainsaw can be changed by setting system properties
168 using the <CODE>-D<property>=<value></CODE> arguments to java. The
169 following table describes what properties can be set:</P>
170
171 <TABLE cellSpacing=0 cellPadding=2 border=1>
172
173 <TR>
174 <TD vAlign=top><B>Property</B></TD>
175 <TD vAlign=top><B>Description</B></TD></TR>
176 <TR>
177 <TD vAlign=top>chainsaw.port</TD>
178 <TD vAlign=top>Indicates which port to listen for connections on. Defaults
179 to <SPAN class=default>"4445"</SPAN>.
180 </TD>
181 </TR>
182 </TBODY>
183 </TABLE>
184
185 <H2>Configuring Log4J</H2>
186
187 <P>You will need to configure log4j to send logging events to
188 Chainsaw. Here is a sample <CODE>log4j.properties</CODE> file
189 for sending logging events to Chainsaw.</P>
190
191<PRE>
192log4j.rootLogger=DEBUG, CHAINSAW_CLIENT
193
194log4j.appender.CHAINSAW_CLIENT=org.apache.log4j.net.SocketAppender
195log4j.appender.CHAINSAW_CLIENT.RemoteHost=localhost
196log4j.appender.CHAINSAW_CLIENT.Port=4445
197log4j.appender.CHAINSAW_CLIENT.LocationInfo=true
198</PRE>
199<P>
200
201<P>
202<DL>
203</DL>
204<HR>
205
206
207<!-- ======= START OF BOTTOM NAVBAR ====== -->
208<A NAME="navbar_bottom"><!-- --></A>
209<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
210<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
211<TR>
212<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
213<A NAME="navbar_bottom_firstrow"><!-- --></A>
214<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
215 <TR ALIGN="center" VALIGN="top">
216 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
217 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
218 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
219 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
220 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
221 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
222 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
223 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
224 </TR>
225</TABLE>
226</TD>
227<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
228</EM>
229</TD>
230</TR>
231
232<TR>
233<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
234 <A HREF="../../../../org/apache/log4j/package-summary.html"><B>PREV PACKAGE</B></A>
235 <A HREF="../../../../org/apache/log4j/config/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
236<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
237 <A HREF="../../../../index.html?org/apache/log4j/chainsaw/package-summary.html" target="_top"><B>FRAMES</B></A>
238 <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
239 <SCRIPT type="text/javascript">
240 <!--
241 if(window==top) {
242 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
243 }
244 //-->
245</SCRIPT>
246<NOSCRIPT>
247 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
248</NOSCRIPT>
249
250
251</FONT></TD>
252</TR>
253</TABLE>
254<A NAME="skip-navbar_bottom"></A>
255<!-- ======== END OF BOTTOM NAVBAR ======= -->
256
257<HR>
258Copyright © 1999-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
259</BODY>
260</HTML>