Documentation updates (#12)
* Added some quickstart information and updated the skin
* Update depenendencies to make site work better
* Site renders better now
* Update logo
diff --git a/pom.xml b/pom.xml
index bad9591..c947f3b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -207,7 +207,7 @@
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
- <version>1.18.0</version>
+ <version>1.18.22</version>
<scope>provided</scope>
</dependency>
<dependency>
diff --git a/src/site/apt/configuration-library.apt b/src/site/apt/configuration-library.apt
new file mode 100644
index 0000000..28a4522
--- /dev/null
+++ b/src/site/apt/configuration-library.apt
@@ -0,0 +1,41 @@
+~~ Licensed to the Apache Software Foundation (ASF) under one or more
+~~ contributor license agreements. See the NOTICE file distributed with
+~~ this work for additional information regarding copyright ownership.
+~~ The ASF licenses this file to You under the Apache License, Version 2.0
+~~ (the "License"); you may not use this file except in compliance with
+~~ the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+Configuration Library
+
+ This page contains a selection of different ways that you can configure
+ Chainsaw to load in log events, as well as configurations for your
+ log configuration files.
+
+Log4j2 - TCP Connection
+
+ The following XML config file for Log4j2 will send JSON data to localhost
+ on port 4449.
+
++--
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration>
+ <Appenders>
+ <Socket name="socket" host="localhost" port="4449">
+ <JsonTemplateLayout></JsonTemplateLayout>
+ </Socket>
+ </Appenders>
+ <Loggers>
+ <Root level="trace">
+ <AppenderRef ref="socket"/>
+ </Root>
+ </Loggers>
+</Configuration>
++--
diff --git a/src/site/apt/quicktour.apt b/src/site/apt/quicktour.apt
index a7cdbec..dc303a4 100644
--- a/src/site/apt/quicktour.apt
+++ b/src/site/apt/quicktour.apt
@@ -16,8 +16,6 @@
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.
@@ -26,8 +24,54 @@
* <<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" ).
+ * <<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.
+
+Quick Start
+
+ When Chainsaw first starts up, it will look something like this:
+
+[images/chainsaw-overview.png] Overview
+
+ There's a fair amount of complexity with the GUI, but we'll go over it one apsect at a time.
+
+ The first thing we want to do is to open up our 'Receivers' panel so that we can
+ get log events from a source. To do this, click the radar dish icon on our
+ toolbar to open up the receivers panel. Chainsaw should now look something
+ like this
+
+[images/chainsaw-with-receivers.png] Chainsaw with Receivers
+
+ Now let's connect an application to Chainsaw in order to view its log events. There are multiple
+ ways to connect an application to Chainsaw, but for this illustration we will
+ connect an application that uses Log4j2 to Chainsaw. Whithin Chainsaw, the
+ Receivers are configured to receive log events fom a source.
+
+ Using the configuration from our configuration library for a TCP connection,
+ we need to make a reciever that will receive the log events. This new reciever
+ should be made by clicking the 'new reciever' button on the receivers pane.
+ In this case, since we want to get JSON data, we will select the 'New JsonReceiver'
+ option.
+
+[images/chainsaw-new-receiver.png] New Receiver
+
+ We can now configure the receiver with its options. For now, let's call it
+ 'Log4j2-JSON' so that we know where this data is coming from.
+
+[images/chainsaw-configure-json.png] Configure JSON receiver
+
+ Once we create the new recevier, we can now see that we have both a new tab
+ and a new recevier defined in our receivers panel:
+
+[images/chainsaw-with-receiver.png] Chainsaw with Receiver
+
+ Running an application that logs JSON data now lets us to see the log
+ message that come through
+
+[images/chainsaw-with-events.png] Chainsaw with events
+
+ Now that we have events in Chainsaw, we can now investigate events and view
+ more information about them.
diff --git a/src/site/resources/images/chainsaw-configure-json.png b/src/site/resources/images/chainsaw-configure-json.png
new file mode 100644
index 0000000..ea6d933
--- /dev/null
+++ b/src/site/resources/images/chainsaw-configure-json.png
Binary files differ
diff --git a/src/site/resources/images/chainsaw-new-receiver.png b/src/site/resources/images/chainsaw-new-receiver.png
new file mode 100644
index 0000000..85ed503
--- /dev/null
+++ b/src/site/resources/images/chainsaw-new-receiver.png
Binary files differ
diff --git a/src/site/resources/images/chainsaw-overview.png b/src/site/resources/images/chainsaw-overview.png
new file mode 100644
index 0000000..27f1c15
--- /dev/null
+++ b/src/site/resources/images/chainsaw-overview.png
Binary files differ
diff --git a/src/site/resources/images/chainsaw-with-events.png b/src/site/resources/images/chainsaw-with-events.png
new file mode 100644
index 0000000..0ae20b8
--- /dev/null
+++ b/src/site/resources/images/chainsaw-with-events.png
Binary files differ
diff --git a/src/site/resources/images/chainsaw-with-receiver.png b/src/site/resources/images/chainsaw-with-receiver.png
new file mode 100644
index 0000000..634b226
--- /dev/null
+++ b/src/site/resources/images/chainsaw-with-receiver.png
Binary files differ
diff --git a/src/site/resources/images/chainsaw-with-receivers.png b/src/site/resources/images/chainsaw-with-receivers.png
new file mode 100644
index 0000000..10ba99a
--- /dev/null
+++ b/src/site/resources/images/chainsaw-with-receivers.png
Binary files differ
diff --git a/src/site/resources/images/logo.jpg b/src/site/resources/images/logo.jpg
deleted file mode 100644
index 9824c1a..0000000
--- a/src/site/resources/images/logo.jpg
+++ /dev/null
Binary files differ
diff --git a/src/site/resources/images/logo.png b/src/site/resources/images/logo.png
new file mode 100644
index 0000000..d84126b
--- /dev/null
+++ b/src/site/resources/images/logo.png
Binary files differ
diff --git a/src/site/site.xml b/src/site/site.xml
index d2e3994..ceea8c7 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -24,8 +24,8 @@
</bannerLeft>
<bannerRight>
<name>Apache log4j</name>
- <src>images/logo.jpg</src>
- <href>http://logging.apache.org/log4j</href>
+ <src>images/logo.png</src>
+ <href>https://logging.apache.org/log4j/2.x/</href>
</bannerRight>
<body>
<breadcrumbs>
@@ -49,6 +49,10 @@
<item name="JavaDoc" href="/apidocs/index.html"/>
</menu>
+ <menu name="Manual">
+ <item name="Configuration Library" href="/configuration-library.html"/>
+ </menu>
+
<menu name="Community">
<item name="Mailing Lists" href="/mail-lists.html"/>
<item name="Issue Tracking" href="/issue-tracking.html"/>
@@ -72,4 +76,9 @@
</menu>
</body>
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.8</version>
+ </skin>
</project>
