psmith 2003/12/15 13:59:31
Modified: src/xdocs/stylesheets project.xml
src/xdocs download.xml chainsaw.xml
Added: src/xdocs install-chainsaw.xml
Log:
Added more details to the website about Chainsaw v2.
Added the temporary install-chainsaw.xml script with links.
Added Chainsaw page to main navigation.
This is still WIP, not ready for upload to website as yet.
Scott is kindly doing some screen grabbing under w2k
for us today, which I will add to the bottom section.
Revision Changes Path
1.16 +1 -0 jakarta-log4j/src/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/xdocs/stylesheets/project.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- project.xml 7 Jul 2003 13:55:17 -0000 1.15
+++ project.xml 15 Dec 2003 21:59:31 -0000 1.16
@@ -11,6 +11,7 @@
<item name="Introduction" href="/index.html"/>
<item name="Download" href="/download.html"/>
<item name="Documentation" href="/documentation.html"/>
+ <item name="Chainsaw" href="/chainsaw.html"/>
<item name="Plan" href="/plan.html"/>
<item name="Wiki"
href="http://nagoya.apache.org/wiki/apachewiki.cgi?Log4JProjectPages"/>
<item name="Contact us" href="/contactUs.html"/>
1.67 +6 -0 jakarta-log4j/src/xdocs/download.xml
Index: download.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/xdocs/download.xml,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -r1.66 -r1.67
--- download.xml 15 Dec 2003 01:51:46 -0000 1.66
+++ download.xml 15 Dec 2003 21:59:31 -0000 1.67
@@ -80,6 +80,12 @@
and displays them in a table. Chainsaw also supports loading
events from files in <code>XMLLayout</code> format.
</dd>
+ <!--
============================================================================== -->
+ <dt><a
+ href="chainsaw.html"><b>Chainsaw v2 (NEW!)</b></a></dt>
+ <dd>A new and improved version of the venerable Chainsaw utility, now being
written by the log4j development team is getting closer to release. You can see
screen shots of it
+ and install it and run over <A href="chainsaw.html">here</A>
+ </dd>
<!--
============================================================================== -->
1.2 +37 -25 jakarta-log4j/src/xdocs/chainsaw.xml
Index: chainsaw.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/xdocs/chainsaw.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- chainsaw.xml 12 Sep 2003 03:39:47 -0000 1.1
+++ chainsaw.xml 15 Dec 2003 21:59:31 -0000 1.2
@@ -19,14 +19,15 @@
<li><a href="#WhatIsIt">So what is it really?</a></li>
<li><a href="#QuickTour">Quick Tour of Chainsaw features</a></li>
<li><a href="#ProjectStatus">Project Status/Support/Feedback</a></li>
+ <li><a href="#Installation">Installation</a></li>
<li><a href="#GettingStarted">Getting Started</a></li>
<li><a href="#Tutorial">Tutorial and User Manual</a></li>
- </ul>
-
-
+ <li><a href="#Screenshots">Screenshots</a></li>
+ </ul>
</section>
- <section name="So what is it really?">
- <p><a name="WhatIsIt"/>It's a GUI-based Log viewer. Pictures tell a thousand
words...</p>
+
+<section name="So what is it really?">
+ <p><a name="WhatIsIt"/>It's a GUI-based Log viewer. A picture tells a
thousand words...</p>
<p><img src="api/org/apache/log4j/chainsaw/doc-files/Chainsawv2.gif"
width="873" height="492"/></p>
@@ -35,46 +36,57 @@
<p>Rather than rely on a combination of tail/grep/vi or equivalent to
view/query/trace-through
a huge trail of logging events, you can use Chainsaw. Chainsaw can read log
files formatted in Log4j's XMLLayout, receive
events from remote locations, read events from a DB, it can even work with
the JDK 1.4 logging events.</p>
+ <p>You can see some more screenshots <a href="#Screenshots">here</a>.</p>
</section>
- <section name="Project Status/Support/Feedback">
- <p><a name="ProjectStatus"/>Currently Chainsaw v2 is not in official release
status, more
- Alpha level, but a number of developers
- are actively using it to assist in the management of production environments.
A number
- of changes and features are still being added at this time, but it is
scheduled to be officially
- released with the Log4j 1.3 release in the very near future.</p>
-
- <p>Feel free to monitor and participate in discussing Chainsaw on the <a
href="mailto:[EMAIL PROTECTED]">Log4j User</a> mailing list.
-
- Support for the product will also be provided through this forum.</p>
-
- </section>
-
-
<section name="Quick Tour of Chainsaw features">
- <p><a name="QuickTour"/></p>
+ <p><a name="QuickTour"/> Heres just a <b>brief</b> run down of
some of the features of Chainsaw v2:</p>
<ul>
- <li><b>View remote events</b> - Remote events are "received" by Chainsaw
using Log4j's new Receiver concept.</li>
+ <li><b>View remote events</b> - Remote events are "received" by Chainsaw
using Log4j 1.3's new Receiver concept.</li>
+ <li><b>Saved Preferences</b> - You can fully customize each Tab the way you
want it, and it will restore it's state the next time.</li>
+
<li><b>Responsive</b> - When events are screaming in, you don't want the GUI
to meltdown. You can control
how responsive the GUI is and determine the frequency of updates.</li>
<li><b>Tabs/Docking</b> - Chainsaw routes separate applications/remote
hosts' events to a unique Tab within the GUI.
These tabs can be undocked from the main window. Using these features you
can manage multiple application logs using the one GUI.</li>
<li><b>Coloring</b> - You can specify your own rules to color each event row
depending on the attributes of a LoggingEvent to
help you locate important events.</li>
- <li><b>Dynamic and powerful filtering</b> - Helps you locate stuff. There's
support for quick-and-dirty filtering, right through to advanced expression-based
filtering.</li>
+ <li><b>Dynamic and powerful filtering</b> - Helps you locate stuff. There's
support for quick-and-dirty filtering, right through to advanced expression-based
filtering (e.g. <code> "LOGGER == 'com.mycompany' && LEVEL == ERROR"
</code>).</li>
<li><b>Cyclic</b> - A tab view can support a Cyclic-based model, which
constrains it's view to the last
X events, ensuring you don't hog memory. This is great for monitoring live
applications.</li>
<li><b>Built-in documentation and tutorial</b> - HTML-based documentation
included in the package.</li>
</ul>
</section>
+ <section name="Installation">
+ <p><a name="Installation"/>Currently you need to check out the
jakarta-log4j module from the Apache CVS server
+ to build and run Chainsaw v2. To make this easier, we have
created a temporary installation Ant script, you can download this
+ by <a href="install-chainsaw.xml">clicking here</a>.</p>
+ <P>You will need the following installed to utilise this
installation script:</P>
+ <UL>
+ <li>JDK 1.3+</li>
+ <li>Ant 1.5+</li>
+ <li>CVS</li>
+ </UL>
+ <P>Once you have downloaded and placed this script in a
directory where you want Chainsaw v2 installed, you can type:</P>
+ <pre>ant</pre>
+ <P>This will download everything you need to build and run
Chainsaw v2.</P>
+ <P>When finally released, we plan to have Chainsaw v2
available via Java WebStart.</P>
+ </section>
+
<section name="Getting Started">
- <p><a name="GettingStarted"/> </p>
+ <p><a name="GettingStarted"/>Once you have used the above
installer, you can <code>cd</code> to tho <code>jakarta-log4j</code> sub-directory and
+ type:</p>
+ <pre>ant chainsaw</pre>
+ <P>Chainsaw v2 will be built and run!</P>
</section>
<section name="Tutorial and User Manual">
- <p><a name="ExtraDocs"/>Chainsaw includes help with
- with a Quick Reference, Tutorial, and User Manual, all viewable from within
the GUI. </p>
+ <p><a name="ExtraDocs"/>Chainsaw already includes help with
+ with a Quick Reference and a Tutorial to get you started, all viewable from
<b>within the GUI</b>. A User Manual will be made available around release time. </p>
+ </section>
+ <section name="Screenshots">
+ <p><a name="Screenshots"/>Here's a few more screenshots to
whet your appetite:</p>
</section>
</body>
1.1 jakarta-log4j/src/xdocs/install-chainsaw.xml
Index: install-chainsaw.xml
===================================================================
<project name="install-chainsaw" default="install" basedir="." >
<property name="module.dir" location="${basedir}"/>
<property name="oro.file.name" value="jakarta-oro-2.0.7.zip" />
<property name="oro.location" location="${module.dir}/${oro.file.name}" />
<property name="oro.unzip.location" location="${module.dir}/" />
<target name="install" depends="confirm,cvs,get-oro,create-build-properties,
success-msg"/>
<target name="confirm" depends="">
<echo>
============================================================
CHAINSAW v2 installer
============================================================
This Ant build script will perform the following:
* Download the jakarta-log4j module from the Apache CVS
* Dowload the latest binary version of the Jakarta ORO project from
www.ibiblio.org
It will create the following artifacts in the current directory (whereever this Ant
script is)
* a jarkarta-log4j directory, containing the log4j source tree
* a jakarta-oro-2.0.7.zip file
* a jakarta-oro-2.0.7 directory containing the unpacked ORO jar from the
aforementioned zip file
</echo>
<input
message="Are you OK with all of this?"
validargs="y,n"
addproperty="confirm"
/>
<condition property="do.abort">
<equals arg1="n" arg2="${confirm}"/>
</condition>
<fail if="do.abort">Installation aborted by user.</fail>
</target>
<target name="cvs" depends="">
<cvs cvsRoot=":pserver:[EMAIL PROTECTED]:/home/cvspublic"
package="jakarta-log4j"
dest="${module.dir}"
quiet="true"
/>
</target>
<target name="get-oro" depends="">
<!-- <echo>${oro.location}</echo> -->
<get
src="http://www.ibiblio.org/pub/mirrors/apache/jakarta/oro/${oro.file.name}";
dest="${oro.location}"
verbose="true"
usetimestamp="true"/>
<unzip src="${oro.location}"
dest="${oro.unzip.location}">
<patternset>
<include name="jakarta-oro-2.0.7/jakarta-oro-2.0.7.jar"/>
</patternset>
</unzip>
</target>
<target name="create-build-properties" depends="">
<copy file="${module.dir}/jakarta-log4j/build.properties.sample"
tofile="${module.dir}/jakarta-log4j/build.properties">
</copy>
<replace file="${module.dir}/jakarta-log4j/build.properties">
<replacetoken><![CDATA[#regexp.oro.jar=../oro/jakarta-oro-2.0.6.jar]]></replacetoken>
<replacevalue><![CDATA[regexp.oro.jar=../jakarta-oro-2.0.7/jakarta-oro-2.0.7.jar]]>
</replacevalue>
</replace>
</target>
<!--<target name="clean" depends="">
</target>-->
<target name="success-msg" depends="">
<echo>
Installation completed successfully.
You should now be able to do the following to run Chainsaw v2:
cd jakarta-log4j
ant chainsaw
GOOD LUCK!
</echo>
</target>
</project>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
