Author: psmith
Date: Sun Jun 10 23:58:43 2007
New Revision: 546026
URL: http://svn.apache.org/viewvc?view=rev&rev=546026
Log:
Converted the chainsaw documentation from the log4j project into sub-documents
in the maven format so that mvn site looks nice.
Added:
logging/chainsaw/trunk/src/site/
logging/chainsaw/trunk/src/site/apt/
logging/chainsaw/trunk/src/site/apt/distributionnotes.apt
logging/chainsaw/trunk/src/site/apt/download.apt
logging/chainsaw/trunk/src/site/apt/intro.apt
logging/chainsaw/trunk/src/site/apt/quicktour.apt
logging/chainsaw/trunk/src/site/apt/zeroconf.apt
logging/chainsaw/trunk/src/site/resources/
logging/chainsaw/trunk/src/site/resources/images/
logging/chainsaw/trunk/src/site/resources/images/chainsaw-1.jpg
- copied unchanged from r533459, logging/log4j/trunk/docs/chainsaw-1.jpg
logging/chainsaw/trunk/src/site/site.xml
Added: logging/chainsaw/trunk/src/site/apt/distributionnotes.apt
URL:
http://svn.apache.org/viewvc/logging/chainsaw/trunk/src/site/apt/distributionnotes.apt?view=auto&rev=546026
==============================================================================
--- logging/chainsaw/trunk/src/site/apt/distributionnotes.apt (added)
+++ logging/chainsaw/trunk/src/site/apt/distributionnotes.apt Sun Jun 10
23:58:43 2007
@@ -0,0 +1,24 @@
+Important Distribution Notes
+
+ Due to Java classloading rules, it is impossible to ship the Jakarta
Commons VFS extension to Chainsaw OR have DBReceiver or JMSReceiver bundled
with Chainsaw.
+
+ Several VFS filestore implementation jars cannot be shipped with
Chainsaw because of licensing issues, and for JMSReceiver and DBReceiver you
are required
+ to have proprietary driver jars locally which we obviously can't ship.
You can follow these steps to enable the DB, JMS and/or VFS components inside
Chainsaw.
+
+ * [DBReceiver] Download the DB extension to Chainsaw
+
+ * [JMSReceiver] Download the JMS extension to Chainsaw
+
+ * [VFS] Download the VFS extension to Chainsaw
+
+ * [VFS] Download VFS
+
+ * [VFS] Download Commons Logging Jars
+
+ * [VFS] Download the VFS filestore implementation jars you wish
to use
+
+
+ Place all these jars in your .chainsaw/plugins directory (the .chainsaw
directory is in your home directory)
+ Start Chainsaw, which should now recognize the existence of these
components and allow you to use them.
+
+ This applies to all distributions.
Added: logging/chainsaw/trunk/src/site/apt/download.apt
URL:
http://svn.apache.org/viewvc/logging/chainsaw/trunk/src/site/apt/download.apt?view=auto&rev=546026
==============================================================================
--- logging/chainsaw/trunk/src/site/apt/download.apt (added)
+++ logging/chainsaw/trunk/src/site/apt/download.apt Sun Jun 10 23:58:43 2007
@@ -0,0 +1,9 @@
+Download
+
+ *
{{{http://logging.apache.org/log4j/docs/webstart/chainsaw/chainsawWebStart.jnlp}Java
Web Start}}
+
+ *
{{{http://logging.apache.org/log4j/docs/webstart/chainsaw/chainsaw.dmg}OSX}} -
.dmg bundled distribution. Drag to your /Applications folder
+
+ *
{{{http://logging.apache.org/log4j/docs/webstart/chainsaw/chainsaw-bundle.zip}Unix/Dos
Standalone}} (.bat/.sh)
+
+ Please check the {{{distributionnotes.html}Important Distribution
Notes}} for more information about some of the extended feature sets.
\ No newline at end of file
Added: logging/chainsaw/trunk/src/site/apt/intro.apt
URL:
http://svn.apache.org/viewvc/logging/chainsaw/trunk/src/site/apt/intro.apt?view=auto&rev=546026
==============================================================================
--- logging/chainsaw/trunk/src/site/apt/intro.apt (added)
+++ logging/chainsaw/trunk/src/site/apt/intro.apt Sun Jun 10 23:58:43 2007
@@ -0,0 +1,39 @@
+
+Introduction
+
+ Welcome to the home of Chainsaw v2!
+
+ Chainsaw v2 is a companion application to Log4j written by members of
the Log4j development
+ community. Like a number of Open Source
+ projects, this new version was built upon inspirations, ideas and
creations of others.
+ Chainsaw v2 has it's roots from the original Chainsaw utility written by
Oliver Burn,
+ and with inspiration from the Log Factor 5 utility contributed by
ThoughtWorks Inc.
+
+
+
+Available Distributions
+
+ * Java Web Start
+
+ * Standalone -.sh/.bat
+
+ * OS X 'native' distribution (uses Java still, but looks like a real
OSX application)
+
+
+ Click {{{download.html}Download}} link for more information.
+
+So what is it really?
+
+ It's a GUI-based Log viewer. A picture tells a thousand words...
+
+[images/chainsaw-1.jpg] Screenshot
+
+ These screen shots were taken on Windows 2000, running Sun JDK 1.4.2.
+ 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.
+
+
+Tutorial and User Manual
+
+ Chainsaw already includes help with with a Quick Reference and a
Tutorial to get you started, all viewable from within the GUI!. A User Manual
will be made available around release time.
Added: logging/chainsaw/trunk/src/site/apt/quicktour.apt
URL:
http://svn.apache.org/viewvc/logging/chainsaw/trunk/src/site/apt/quicktour.apt?view=auto&rev=546026
==============================================================================
--- logging/chainsaw/trunk/src/site/apt/quicktour.apt (added)
+++ logging/chainsaw/trunk/src/site/apt/quicktour.apt Sun Jun 10 23:58:43 2007
@@ -0,0 +1,19 @@
+Quick Tour of Chainsaw features
+
+ Heres just a brief run down of some of the features of Chainsaw v2:
+
+ * <<View remote events>> - Remote events are "received" by Chainsaw
using Log4j 1.3's new Receiver concept.
+
+ * <<Saved Preferences>> - You can fully customize each Tab the way you
want it, and it will restore it's state the next time.
+
+ * <<Responsive>> - 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.
+
+ * <<Tabs/Docking>> - 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.
+
+ * <<Coloring>> - You can specify your own rules to color each event row
depending on the attributes of a LoggingEvent to help you locate important
events.
+
+ * <<Dynamic and powerful filtering>> - Helps you locate stuff. There's
support for quick-and-dirty filtering, right through to advanced
expression-based filtering (e.g. "LOGGER == 'com.mycompany' && LEVEL
== ERROR" ).
+
+ * <<Cyclic>> - 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.
+
+ * <<Built-in documentation and tutorial>> - HTML-based documentation
included in the package.
Added: logging/chainsaw/trunk/src/site/apt/zeroconf.apt
URL:
http://svn.apache.org/viewvc/logging/chainsaw/trunk/src/site/apt/zeroconf.apt?view=auto&rev=546026
==============================================================================
--- logging/chainsaw/trunk/src/site/apt/zeroconf.apt (added)
+++ logging/chainsaw/trunk/src/site/apt/zeroconf.apt Sun Jun 10 23:58:43 2007
@@ -0,0 +1,38 @@
+ZeroConf - Zero Configuration
+
+ Chainsaw has ZeroConf elements embedded within it, but you'll need to
add a few things to your application to enable your application for ZeroConf.
+
+ Download:
+
+ * log4j ZeroConf extension
+
+ * {{{http://sourceforge.net/projects/jmdns/}JmDNS}}
+
+ * Add the <log4j-zeroconf.jar> and the <jmdns.jar> from these
bundles and add them to your application's classpath.
+
+ * Modify your log4j configuration so that it use the
ZeroConfSocketHubAppender.
+
+ Here is a complete log4j.xml file that you can use as a base:
+
++-------------------------------+
+<log4j:configuration debug="false" threshold="debug"
xmlns:log4j="http://jakarta.apache.org/log4j/>
+ <appender name="zeroconf"
class="org.apache.log4j.net.ZeroConfSocketHubAppender">
+ <param name="Name" value="MyZeroConfSockeHubAppender" />
+ </appender>
+ <!--ROOT Logger-->
+ <root>
+ <level value="INFO" />
+ <appender-ref ref="zeroconf" />
+ </root>
+</log4j:configuration>
++-------------------------------+
+
+ Once configured and your applicatiion started, you should be able to
click on the Zeroconf tab inside Chainsaw, and see the
"MyZeroConfSocketHubAppender" listed. If you double click on the row, Chainsaw
will automatically connect to your application and start receiving events. You
can tick the 'auto-connect' option to have Chainsaw immediately connect as soon
as it sees your application started. Great for Dev/QA environment.
+
+ The Zeroconf-enabled SocketHubAppender broadcasts it's existence via a
multicast protocol, passing enough information for Chainsaw to be able to
connect to it.
+
+Firewalls
+
+ Multicast protocols generally don't pass through firewall, so in a
production environment Zeroconf won't work.
+
+
\ No newline at end of file
Added: logging/chainsaw/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/logging/chainsaw/trunk/src/site/site.xml?view=auto&rev=546026
==============================================================================
--- logging/chainsaw/trunk/src/site/site.xml (added)
+++ logging/chainsaw/trunk/src/site/site.xml Sun Jun 10 23:58:43 2007
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="${project.name}">
+ <bannerLeft>
+ <name>Chainsaw</name>
+ <src>http://logging.apache.org/log4j/docs/images/logo.jpg</src>
+ <href>http://logging.apache.org/log4j/docs/chainsaw.html</href>
+ </bannerLeft>
+<!-- <bannerRight>
+ <src>http://logging.apache.org/log4j/docs/chainsaw.html</src>
+ </bannerRight>
+-->
+ <body>
+ <links>
+ <item name="Apache" href="http://www.apache.org/"; />
+ </links>
+
+ <menu name="">
+ <item name="Introduction" href="intro.html"/>
+ <item name="Download" href="download.html"/>
+ <item name="Quick Tour" href="quicktour.html" />
+ <item name="Zeroconf" href="zeroconf.html" />
+ <item name="Important Distribution Notes"
href="distributionnotes.html" />
+ </menu>
+
+ <menu ref="reports"/>
+
+ </body>
+</project>
\ No newline at end of file
