/lib/apache-log4j/site/apidocs/org/apache/log4j/chainsaw/package-summary.html

https://bitbucket.org/arkban/somersault · HTML · 260 lines · 198 code · 46 blank · 16 comment · 0 complexity · 484c868fd2ec6f27fa1e03e22beec1c5 MD5 · raw file 

    

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

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0_16) -->
    6. 

  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <TITLE>
    8. 

  8. org.apache.log4j.chainsaw (Apache Log4j 1.2.16 API)
    9. 

  9. </TITLE>
    10. 

  10. 

  11. <META NAME="date" CONTENT="2010-03-30">
    12. 

  12. 

  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    14. 

  14. 

  15. <SCRIPT type="text/javascript">
    16. 

  16. function windowTitle()
    17. 

  17. {
    18. 

  18.     if (location.href.indexOf('is-external=true') == -1) {
    19. 

  19.         parent.document.title="org.apache.log4j.chainsaw (Apache Log4j 1.2.16 API)";
    20. 

  20.     }
    21. 

  21. }
    22. 

  22. </SCRIPT>
    23. 

  23. <NOSCRIPT>
    24. 

  24. </NOSCRIPT>
    25. 

  25. 

  26. </HEAD>
    27. 

  27. 

  28. <BODY BGCOLOR="white" onload="windowTitle();">
    29. 

  29. <HR>
    30. 

  30. 

  31. 

  32. <!-- ========= START OF TOP NAVBAR ======= -->
    33. 

  33. <A NAME="navbar_top"><!-- --></A>
    34. 

  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    35. 

  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    36. 

  36. <TR>
    37. 

  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    38. 

  38. <A NAME="navbar_top_firstrow"><!-- --></A>
    39. 

  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    40. 

  40.   <TR ALIGN="center" VALIGN="top">
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    47. 

  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    48. 

  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    49. 

  49.   </TR>
    50. 

  50. </TABLE>
    51. 

  51. </TD>
    52. 

  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    53. 

  53. </EM>
    54. 

  54. </TD>
    55. 

  55. </TR>
    56. 

  56. 

  57. <TR>
    58. 

  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    59. 

  59. &nbsp;<A HREF="../../../../org/apache/log4j/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    60. 

  60. &nbsp;<A HREF="../../../../org/apache/log4j/config/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    61. 

  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    62. 

  62.   <A HREF="../../../../index.html?org/apache/log4j/chainsaw/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    63. 

  63. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    64. 

  64. &nbsp;<SCRIPT type="text/javascript">
    65. 

  65.   <!--
    66. 

  66.   if(window==top) {
    67. 

  67.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    68. 

  68.   }
    69. 

  69.   //-->
    70. 

  70. </SCRIPT>
    71. 

  71. <NOSCRIPT>
    72. 

  72.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    73. 

  73. </NOSCRIPT>
    74. 

  74. 

  75. 

  76. </FONT></TD>
    77. 

  77. </TR>
    78. 

  78. </TABLE>
    79. 

  79. <A NAME="skip-navbar_top"></A>
    80. 

  80. <!-- ========= END OF TOP NAVBAR ========= -->
    81. 

  81. 

  82. <HR>
    83. 

  83. <H2>
    84. 

  84. Package org.apache.log4j.chainsaw
    85. 

  85. </H2>
    86. 

  86. Chainsaw is a GUI log viewer and filter for the log4j
    87. 

  87. package.
    88. 

  88. <P>
    89. 

  89. <B>See:</B>
    90. 

  90. <BR>
    91. 

  91. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
    92. 

  92. <P>
    93. 

  93. 

  94. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    95. 

  95. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    96. 

  96. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    97. 

  97. <B>Class Summary</B></FONT></TH>
    98. 

  98. </TR>
    99. 

  99. <TR BGCOLOR="white" CLASS="TableRowColor">
    100. 

  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. 

  101. <TD>The main application.</TD>
    102. 

  102. </TR>
    103. 

  103. </TABLE>
    104. 

  104. &nbsp;
    105. 

  105. 

  106. <P>
    107. 

  107. <A NAME="package_description"><!-- --></A><H2>
    108. 

  108. Package org.apache.log4j.chainsaw Description
    109. 

  109. </H2>
    110. 

  110. 

  111. <P>
    112. 

  112. <P>Chainsaw is a GUI log viewer and filter for the log4j
    113. 

  113. package. By default it listens for <a
    114. 

  114. href="../spi/LoggingEvent.html">LoggingEvent</A> objects sent using
    115. 

  115. the <A href="../net/SocketAppender.html">SocketAppender</A> and
    116. 

  116. displays them in a table. The events can be filtered based on:</P>
    117. 

  117. 

  118.     <UL>
    119. 

  119.       <LI>Level </li>
    120. 

  120. 

  121.       <LI>Thread name</li>
    122. 

  122. 

  123.       <LI>Logger</li>
    124. 

  124.       <LI>Message</li>
    125. 

  125. 

  126.       <LI>NDC</LI>
    127. 

  127.     </UL>
    128. 

  128. 

  129.     <P>All the details for each event can be displayed by selecting
    130. 

  130.       the event in the table.</P> 
    131. 

  131. 

  132.     <P>Chainsaw also supports loading a events logged to a file using
    133. 

  133.       the <A href="../xml/XMLLayout.html">XMLLayout</A> format. This
    134. 

  134.       is great for analysing log files, and means you do not need to
    135. 

  135.       keep Chainsaw running continously. It is easy to add support
    136. 

  136.       for loading events from other sources like JDBC.</P> 
    137. 

  137. 

  138.     <P>A picture is worth a thousand words: </P>
    139. 

  139. 

  140.     <P align=center><A
    141. 

  141.       href="doc-files/screen_01.png"><IMG
    142. 

  142.       height="50%" alt="Screen shot of chainsaw"
    143. 

  143.       src="doc-files/screen_01.png"
    144. 

  144.       width="50%"></A>.</P> 
    145. 

  145. 

  146.     <P>Finally, why is it called chainsaw?
    147. 

  147.       Because it cuts your log (file) down to size. :-)
    148. 

  148.     </P>
    149. 

  149. 

  150. 

  151.     <H2>Requirements</H2> 
    152. 

  152. 

  153.     <P>Chainsaw is based on the Swing API which requires JDK 1.2 or later.</P>
    154. 

  154. 

  155. 

  156.     <H2>Running chainsaw</H2>
    157. 

  157. 

  158.     <H3>Setup</H3>
    159. 

  159.     <P>You need to include the <code>log4j.jar</code> in the classpath.
    160. 

  160. 

  161.     <H3>Usage</H3>
    162. 

  162. 

  163.     <P>The command line usage is:</P>
    164. 

  164. 

  165.     <PRE>  java -D&lt;property&gt;=&lt;value&gt; org.apache.log4j.chainsaw.Main </PRE>
    166. 

  166. 

  167.     <P>The default behaviour of chainsaw can be changed by setting system properties 
    168. 

  168.       using the <CODE>-D&lt;property&gt;=&lt;value&gt;</CODE> arguments to java. The 
    169. 

  169.       following table describes what properties can be set:</P>
    170. 

  170. 

  171.     <TABLE cellSpacing=0 cellPadding=2 border=1>
    172. 

  172. 

  173.       <TR>
    174. 

  174.         <TD vAlign=top><B>Property</B></TD>
    175. 

  175.         <TD vAlign=top><B>Description</B></TD></TR>
    176. 

  176.       <TR>
    177. 

  177.         <TD vAlign=top>chainsaw.port</TD>
    178. 

  178.         <TD vAlign=top>Indicates which port to listen for connections on. Defaults 
    179. 

  179.           to <SPAN class=default>"4445"</SPAN>.
    180. 

  180.         </TD>
    181. 

  181.       </TR>
    182. 

  182.     </TBODY>
    183. 

  183.     </TABLE>
    184. 

  184. 

  185.     <H2>Configuring Log4J</H2>
    186. 

  186. 

  187.     <P>You will need to configure log4j to send logging events to
    188. 

  188.       Chainsaw.  Here is a sample <CODE>log4j.properties</CODE> file
    189. 

  189.       for sending logging events to Chainsaw.</P>
    190. 

  190. 

  191. <PRE>
    192. 

  192. log4j.rootLogger=DEBUG, CHAINSAW_CLIENT
    193. 

  193. 

  194. log4j.appender.CHAINSAW_CLIENT=org.apache.log4j.net.SocketAppender
    195. 

  195. log4j.appender.CHAINSAW_CLIENT.RemoteHost=localhost
    196. 

  196. log4j.appender.CHAINSAW_CLIENT.Port=4445
    197. 

  197. log4j.appender.CHAINSAW_CLIENT.LocationInfo=true
    198. 

  198. </PRE>
    199. 

  199. <P>
    200. 

  200. 

  201. <P>
    202. 

  202. <DL>
    203. 

  203. </DL>
    204. 

  204. <HR>
    205. 

  205. 

  206. 

  207. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    208. 

  208. <A NAME="navbar_bottom"><!-- --></A>
    209. 

  209. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    210. 

  210. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    211. 

  211. <TR>
    212. 

  212. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    213. 

  213. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    214. 

  214. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    215. 

  215.   <TR ALIGN="center" VALIGN="top">
    216. 

  216.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    217. 

  217.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    218. 

  218.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    219. 

  219.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    220. 

  220.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    221. 

  221.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    222. 

  222.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    223. 

  223.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    224. 

  224.   </TR>
    225. 

  225. </TABLE>
    226. 

  226. </TD>
    227. 

  227. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    228. 

  228. </EM>
    229. 

  229. </TD>
    230. 

  230. </TR>
    231. 

  231. 

  232. <TR>
    233. 

  233. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    234. 

  234. &nbsp;<A HREF="../../../../org/apache/log4j/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    235. 

  235. &nbsp;<A HREF="../../../../org/apache/log4j/config/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    236. 

  236. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    237. 

  237.   <A HREF="../../../../index.html?org/apache/log4j/chainsaw/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    238. 

  238. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    239. 

  239. &nbsp;<SCRIPT type="text/javascript">
    240. 

  240.   <!--
    241. 

  241.   if(window==top) {
    242. 

  242.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    243. 

  243.   }
    244. 

  244.   //-->
    245. 

  245. </SCRIPT>
    246. 

  246. <NOSCRIPT>
    247. 

  247.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    248. 

  248. </NOSCRIPT>
    249. 

  249. 

  250. 

  251. </FONT></TD>
    252. 

  252. </TR>
    253. 

  253. </TABLE>
    254. 

  254. <A NAME="skip-navbar_bottom"></A>
    255. 

  255. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    256. 

  256. 

  257. <HR>
    258. 

  258. Copyright &#169; 1999-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
    259. 

  259. </BODY>
    260. 

  260. </HTML>
    261.