You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2004/02/21 16:20:20 UTC
cvs commit: avalon/logging/site/xdocs/spec navigation.xml
mcconnell 2004/02/21 07:20:20
Modified: logging/logkit/plugins/datagram/src/java/org/apache/avalon/logging/logkit/factory/datagram
DatagramTargetFactory.java
logging/logkit/plugins/socket/src/java/org/apache/avalon/logging/logkit/factory/socket
SocketTargetFactory.java
logging/site/xdocs index.xml navigation.xml
logging/site/xdocs/impl index.xml navigation.xml
logging/site/xdocs/impl/logkit index.xml navigation.xml
logging/site/xdocs/spec navigation.xml
Added: logging/site/xdocs/examples code.xml index.xml logkit.xml
navigation.xml
logging/site/xdocs/impl/logkit file.xml formatter.xml
multicast.xml stream.xml
logging/site/xdocs/impl/logkit/plugin datagram.xml index.xml
navigation.xml smtp.xml socket.xml syslog.xml
Log:
Doc completion.
Revision Changes Path
1.2 +2 -2 avalon/logging/logkit/plugins/datagram/src/java/org/apache/avalon/logging/logkit/factory/datagram/DatagramTargetFactory.java
Index: DatagramTargetFactory.java
===================================================================
RCS file: /home/cvs/avalon/logging/logkit/plugins/datagram/src/java/org/apache/avalon/logging/logkit/factory/datagram/DatagramTargetFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DatagramTargetFactory.java 4 Feb 2004 20:49:11 -0000 1.1
+++ DatagramTargetFactory.java 21 Feb 2004 15:20:19 -0000 1.2
@@ -55,7 +55,7 @@
* <p>
* This factory creates a DatagramOutputTarget object which will
* sends datagrams to the specified address. The name of the target is specified by the hostname attribute
- * of the <address> element and the port by the port attribute.The <address> element
+ * of the <address> element and the port by the port attribute.The <format> element
* wraps the format to output the log.
* </p>
*
1.2 +2 -2 avalon/logging/logkit/plugins/socket/src/java/org/apache/avalon/logging/logkit/factory/socket/SocketTargetFactory.java
Index: SocketTargetFactory.java
===================================================================
RCS file: /home/cvs/avalon/logging/logkit/plugins/socket/src/java/org/apache/avalon/logging/logkit/factory/socket/SocketTargetFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SocketTargetFactory.java 4 Feb 2004 20:49:12 -0000 1.1
+++ SocketTargetFactory.java 21 Feb 2004 15:20:19 -0000 1.2
@@ -48,7 +48,7 @@
* TCP/IP socket to communicate with the server. The name of the target is specified by the
* hostname attribute of the <address> element and the port by the port attribute.
* In the config file above the formatting for the log messages is not embedded as it should
- * be specified on the server side
+ * be specified on the server side.
* </p>
*
*
1.3 +9 -9 avalon/logging/site/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/logging/site/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 13 Feb 2004 10:25:44 -0000 1.2
+++ index.xml 21 Feb 2004 15:20:19 -0000 1.3
@@ -28,6 +28,14 @@
<section name="Avalon Logging">
<subsection name="Overview">
<p>
+ The Avalon Logging system is a container-side service that defines
+ a framework for the logging system plugins. The framework is
+ primarily defined by the <a href="api/index.html">Avalon Logging API</a>
+ and the plugin-in model defined by the
+ <a href="http://avalon.apache.org/repository">Avalon Repository</a>
+ system.
+ </p>
+ <p>
The avalon-logging package is a open logging platform suitable for
use by container implementators. It is based largely on the original
excalibur logging system but with some important changes. Firstly
@@ -35,15 +43,7 @@
loading of implementation strategies, secondly, it simplies the
overall approach to target configuration, and thirdly, it applies
a formal logging category meta-data model that is consitent with
- model-driven container solutions.
- </p>
- <p>
- The Avalon Logging system is a container-side service that defines
- a framework for the logging system plugins. The framework is
- primarily defined by the <a href="api/index.html">Avalon Logging API</a>
- and the plugin-in model defined by the
- <a href="http://avalon.apache.org/repository">Avalon Repository</a>
- system.
+ avalon model-driven container solutions.
</p>
</subsection>
</section>
1.6 +1 -0 avalon/logging/site/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/logging/site/xdocs/navigation.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- navigation.xml 21 Feb 2004 00:44:00 -0000 1.5
+++ navigation.xml 21 Feb 2004 15:20:19 -0000 1.6
@@ -35,6 +35,7 @@
<item name="Overview" href="/index.html"/>
<item name="Specification" href="/spec/index.html"/>
<item name="Implementations" href="/impl/index.html"/>
+ <item name="Examples" href="/examples/index.html"/>
</menu>
<menu name="Resources">
1.1 avalon/logging/site/xdocs/examples/code.xml
Index: code.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging</title>
</properties>
<body>
<section name="Avalon Logging">
<subsection name="Code Example">
<p>
The following code is an example of a application loading
and instantiating the Avalon Logging LogKit pluging.
</p>
<source>
File dir = new File( System.getProperty( "user.dir" ) );
//
// create an initial context
//
DefaultInitialContextFactory initial =
new DefaultInitialContextFactory( "avalon", dir );
initial.setCacheDirectory( getRepositoryDirectory() );
InitialContext context = initial.createInitialContext();
//
// get the plugin reference
//
Artifact artifact = Artifact.createArtifact(
"artifact:avalon-logging/avalon-logkit-impl#1.0-SNAPSHOT" );
//
// build the plugin
//
Builder builder = context.newBuilder( artifact );
Factory factory = builder.getFactory();
//
// customize the plugin to you environment
//
File file = new File( dir, "logging.xml" );
Map criteria = factory.createDefaultCriteria();
criteria.put( "avalon.logging.configuration", file );
criteria.put( "avalon.logging.basedir", dir );
//
// create the logging manager
//
LoggingManager manager = (LoggingManager) factory.create( criteria );
</source>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/examples/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging</title>
</properties>
<body>
<section name="Avalon Logging">
<subsection name="Examples">
<table>
<tr><th>Topic</th><th>Description</th></tr>
<tr>
<td><a href="code.html">Code Example</a></td>
<td>
The example shows how to setup a logging manager using
Avalon Repository bootstrapping system.
</td>
</tr>
<tr>
<td><a href="logkit.html">LogKit Example</a></td>
<td>
An example of a logging configuration the combines a
console target and a rotating file target under a
mutiplex target.
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/examples/logkit.xml
Index: logkit.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging</title>
</properties>
<body>
<section name="Avalon Logging">
<subsection name="Logkit Configuration Example">
<p>
The following is an example of a LogKit configuration. The example
establishes three target, a file target, a console stream target,
and a multicast target. Logging events are assigned to the multicast
target resulting in event delivery to both the file and console. The
formats of the respective targets are selected for the relative roles.
The file target handles full reporting with stack trace information.
The console target handles a more consolidated error reporting scheme.
</p>
</subsection>
<subsection name="XML">
<source><![CDATA[
<logging>
<!--
Declaration of a set of logging targets.
-->
<targets>
<!--
This target establishes output to the the System.out stream.
The format argument ensures that we don't get stack traces -
but just the error report.
-->
<stream id="standard">
<name>System.out</name>
<format type="console"/>
</stream>
<!--
This target logs to a rotating file located in
target/simple-XXX.log
-->
<file id="simple">
<filename>simple.log</filename>
<append>true</append>
<rotation type="revolving" init="1" max="10">
<size>100k</size>
</rotation>
</file>
<!--
The multicast target redirects log event to a set of
named targets.
-->
<multicast id="multicast">
<targetref id="standard"/>
<targetref id="simple"/>
</multicast>
</targets>
<!--
Declaration of the initial logging categories. These categories
and the respective priorities and assigned targets are used by the
testcase to validate that the logging system is functioning properly.
-->
<categories priority="info" target="multicast">
<categories name="kernel">
<categories name="logger" priority="warn">
<category name="test" priority="fatal_error"/>
</categories>
<category name="roger-ramjet" priority="debug"/>
</categories>
</categories>
<!--
Selection of the logging channel for use by the logging
system following establishment of inital targets and categories.
-->
<logger name="kernel.logger"/>
</logging>
]]></source>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/examples/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<project>
<title>Merlin</title>
<body>
<links>
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/product/framework/"/>
<item name="Containers" href="http://avalon.apache.org/product/containers/"/>
<item name="Components" href="http://avalon.apache.org/product/components/"/>
</links>
<menu name="About Avalon Logging">
<item name="Overview" href="/index.html"/>
<item name="Specification" href="/spec/index.html"/>
<item name="Implementations" href="/impl/index.html"/>
<item name="Examples" href="/examples/index.html">
<item name="Code Example" href="/examples/code.html"/>
<item name="LogKit Example" href="/examples/logkit.html"/>
</item>
</menu>
<menu name="Resources">
<item name="Javadoc" href="/api/index.html"/>
<item name="Download" href="/download.html"/>
</menu>
<menu name="Related Projects">
<item name="Merlin" href="http://avalon.apache.org/merlin"/>
<item name="Repository" href="http://avalon.apache.org/repository"/>
<item name="Utilities" href="http://avalon.apache.org/util"/>
</menu>
</body>
</project>
1.4 +0 -48 avalon/logging/site/xdocs/impl/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/logging/site/xdocs/impl/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 21 Feb 2004 00:44:00 -0000 1.3
+++ index.xml 21 Feb 2004 15:20:20 -0000 1.4
@@ -47,54 +47,6 @@
</tr>
</table>
</subsection>
- <subsection name="Code Example">
- <p>
- The following code is an example of a application loading
- and instantiating the Avalon Logging LogKit pluging.
- </p>
- <source>
-
- File dir = new File( System.getProperty( "user.dir" ) );
-
- //
- // create an initial context
- //
-
- DefaultInitialContextFactory initial =
- new DefaultInitialContextFactory( "avalon", dir );
- initial.setCacheDirectory( getRepositoryDirectory() );
- InitialContext context = initial.createInitialContext();
-
- //
- // get the plugin reference
- //
-
- Artifact artifact = Artifact.createArtifact(
- "artifact:avalon-logging/avalon-logkit-impl#1.0-SNAPSHOT" );
-
- //
- // build the plugin
- //
-
- Builder builder = context.newBuilder( artifact );
- Factory factory = builder.getFactory();
-
- //
- // customize the plugin to you environment
- //
-
- File file = new File( dir, "logging.xml" );
- Map criteria = factory.createDefaultCriteria();
- criteria.put( "avalon.logging.configuration", file );
- criteria.put( "avalon.logging.basedir", dir );
-
- //
- // create the logging manager
- //
-
- LoggingManager manager = (LoggingManager) factory.create( criteria );
- </source>
- </subsection>
</section>
</body>
</document>
1.5 +1 -0 avalon/logging/site/xdocs/impl/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/logging/site/xdocs/impl/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 19 Feb 2004 08:58:04 -0000 1.4
+++ navigation.xml 21 Feb 2004 15:20:20 -0000 1.5
@@ -37,6 +37,7 @@
<item name="Implementations" href="/impl/index.html">
<item name="LogKit" href="/impl/logkit/index.html"/>
</item>
+ <item name="Examples" href="/examples/index.html"/>
</menu>
<menu name="Resources">
1.5 +14 -98 avalon/logging/site/xdocs/impl/logkit/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/logging/site/xdocs/impl/logkit/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 21 Feb 2004 10:28:15 -0000 1.4
+++ index.xml 21 Feb 2004 15:20:20 -0000 1.5
@@ -24,127 +24,43 @@
</properties>
<body>
<section name="Avalon LogKit Plugin">
- <subsection name="Avalon Logging Logkit API">
- The LogKit plugin defines an local API for LogKit related
+ <subsection name="Overview">
+ <p>The LogKit plugin defines an local API for LogKit related
log target factories and log targets. Through this API the
LogKit implementation manages a set of standard targets and
- a target plugin framework.
+ a target plugin framework.</p>
</subsection>
<subsection name="Standard LogTarget">
<table>
<tr><th>Factory</th><th>Description</th></tr>
<tr>
- <td>Console</td>
+ <td><a href="stream.html">Stream</a></td>
<td>
- <p>The Console LogTarget provides support for the logging
+ The <stream> log target provides support for the logging
of message to a console via System.out or System.err. If
no logging targets are defined, the implementation will
- establish a default console target.</p>
- <p>Example</p>
-<source><![CDATA[
- <stream id="standard">
- <name>System.out</name>
- <format type="console"/>
- </stream>
-]]></source>
+ establish a default console target.
</td>
</tr>
<tr>
- <td>Rotating File</td>
+ <td><a href="file.html">File</a></td>
<td>
- <p>The rotating file target provides support for a set of
+ The rotating <file> target provides support for a set of
rotation strategies including rotation by size, rotation
- on data, and combined date/size rotation scenarios.</p>
- <p>Example</p>
-<source><![CDATA[
- <file id="simple">
- <filename>simple.log</filename>
- <append>true</append>
- <rotation type="revolving" init="1" max="10">
- <size>100k</size>
- </rotation>
- </file>
-]]></source>
+ on data, and combined date/size rotation scenarios.
</td>
</tr>
<tr>
- <td>Multlipex</td>
+ <td><a href="multicast.html">Multicast</a></td>
<td>
- <p>The multiplex target is a target that handles the redirection
- of a logging event to one or more log targets. This target is
- typically used in conjuction with different filters to control
- and qualify the information presented to different targets.
- For example, an application my configure a console target with
- summary warning and error reports to console, and a detailed
- error logg with full stack trace to a rotating file target.
- The multiplex target enabled the declaration of a single logical
- target and the subsequent formatting and generation of log message
- appropriate for the relative targets.</p>
- <p>Example</p>
-<source><![CDATA[
- <multicast id="multicast">
- <targetref id="standard"/>
- <targetref id="simple"/>
- </multicast>
-]]></source>
+ The <multicast> target is a target that handles the redirection
+ of a logging event to one or more log targets.
</td>
</tr>
<tr>
- <td>Plugin</td>
+ <td><a href="plugin/index.html">Plugin</a></td>
<td>
- <p>The plugin target provides support for plugable log targets. A
- typical plugin log target is defined using <target> element.</p>
- <p>Several plugable log targets are currently available.</p>
- <table>
- <tr><th>Plugin</th><th>Description</th></tr>
- <tr>
- <td>DataGram</td>
- <td><p>A datagram log target.<br/>
- avalon-logging/avalon-logkit-datagram#1.0-SNAPSHOT</p>
-<source><![CDATA[
- <target id="datagram"
- artifact="avalon-logging/avalon-logkit-datagram#1.0-SNAPSHOT">
- <address hostname="localhost" port="0"/>
- </target>
-]]></source>
- </td>
- </tr>
- <tr>
- <td>Socket</td>
- <td><p>A socket log target.<br/>
- avalon-logging/avalon-logkit-socket#1.0-SNAPSHOT</p></td>
- </tr>
- <tr>
- <td>Syslog</td>
- <td><p>A syslog log target.<br/>
- avalon-logging/avalon-logkit-syslog#1.0-SNAPSHOT</p>
-<source><![CDATA[
- <target id="syslog"
- artifact="avalon-logging/avalon-logkit-syslog#1.0-SNAPSHOT">
- <address hostname="localhost" port="514" facility="USER"/>
- <format type="avalon"/>
- </target>
-]]></source>
- </td>
- </tr>
- <tr>
- <td>SMTP</td>
- <td><p>An SMTP log target (available on request).<br/>
- avalon-logging/avalon-logkit-smtp#1.0-SNAPSHOT</p>
-<source><![CDATA[
- <target id="smtp"
- artifact="avalon-logging/avalon-logkit-smtp#1.0-SNAPSHOT">
- <to>mcconnell@osm.net</to>
- <from>info@dpml.net</from>
- <subject>logging target test</subject>
- <maximum-size>1</maximum-size>
- <session>
- </session>
- </target>
-]]></source>
- </td>
- </tr>
- </table>
+ The plugin <target> provides support for plugable log target factories.
</td>
</tr>
</table>
1.5 +8 -1 avalon/logging/site/xdocs/impl/logkit/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/logging/site/xdocs/impl/logkit/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 21 Feb 2004 10:21:45 -0000 1.4
+++ navigation.xml 21 Feb 2004 15:20:20 -0000 1.5
@@ -35,8 +35,15 @@
<item name="Overview" href="/index.html"/>
<item name="Specification" href="/spec/index.html"/>
<item name="Implementations" href="/impl/index.html">
- <item name="LogKit" href="/impl/logkit/index.html"/>
+ <item name="LogKit" href="/impl/logkit/index.html">
+ <item name="Stream Target" href="/impl/logkit/stream.html"/>
+ <item name="File Target" href="/impl/logkit/file.html"/>
+ <item name="Multicast Target" href="/impl/logkit/multicast.html"/>
+ <item name="Plugin Target" href="/impl/logkit/plugin/index.html"/>
+ <item name="Formatter" href="/impl/logkit/formatter.html"/>
+ </item>
</item>
+ <item name="Examples" href="/examples/index.html"/>
</menu>
<menu name="Resources">
1.1 avalon/logging/site/xdocs/impl/logkit/file.xml
Index: file.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging - File Log Target</title>
</properties>
<body>
<section name="File Log Target">
<subsection name="Description">
<p>
The rotating file target provides support for a set of
rotation strategies including rotation by size, rotation
on data, and combined date/size rotation scenarios.
</p>
</subsection>
<subsection name="Example 1">
<source><![CDATA[
<file id="simple">
<filename>logging.log</filename>
</file>
]]></source>
</subsection>
<subsection name="Example 2">
<source><![CDATA[
<file id="simple">
<filename>logging.log</filename>
<append>true</append>
<rotation type="revolving" init="1" max="10">
<size>100k</size>
</rotation>
</file>
]]></source>
</subsection>
<subsection name="XML">
<table>
<tr><th>Attributes</th><th>Description</th></tr>
<tr>
<td>id</td>
<td>The log target identifier.</td>
</tr>
</table>
<table>
<tr><th>Nested Element</th><th>Description</th></tr>
<tr>
<td>filename</td>
<td>The filename to assign to the log file.</td>
</tr>
<tr>
<td>append</td>
<td>Optional element to control file appending policy on the
startup of a new session. May contain 'true' or 'false'. If 'true'
messages will be appended to the logging file otherwise a new file
will be created.</td>
</tr>
<tr>
<td>rotation</td>
<td>The <rotation> element holds a single child element that
defines the rotation strategy. See Rotation Strategy Table for the
set of available rotation strategies. A rotation element contains a
type attribute that can be set to 'revolving' or 'unique'. If the
type is set to 'revolving' then the 'init' and 'max' attributes will
be assessed to determine the initial secquence number of the revolving
file set, and max indicating the maximum number of files in the set.</td>
</tr>
<tr>
<td>format</td>
<td>A standard <a href="formatter.html">formatter</a> statement.</td>
</tr>
</table>
</subsection>
<subsection name="Rotation Strategy Elements">
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
<td>size</td>
<td>Rotate on size strategy. The default value is 2m (two megabytes).
File size may be abrieviated with the 'm' for megabytes and 'k' for
kilobytes.
</td>
</tr>
<tr>
<td>date</td>
<td>Rotate on date strategy. The value of the date element is a string
in the date format YYYYMMDD.
</td>
</tr>
<tr>
<td>interval</td>
<td>Rotate on time interval strategy. The value of the interval element
is a string in the format DDD:HH:MM:SS where the default value is 24:00:00.
</td>
</tr>
<tr>
<td>time</td>
<td>Rotate on time of day strategy. The value of the time element
is a string in the format HH:MM:SS where the default value is 24:00:00.
If you want to rotate a logfile more than once a day put an <or>
element as the first element withing a <rotation> element and
specify the times and a size element inside the <or> element.
</td>
</tr>
<tr>
<td>or</td>
<td>A composite strategy than combines any rotation strategy element
declared as a chilkd of the <or> element.
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/formatter.xml
Index: formatter.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging</title>
</properties>
<body>
<section name="Log Formatter">
<subsection name="Description">
<p>The <formatter> element provides a mechanism to select a
formatting type and optionally declare a custom format pattern.</p>
</subsection>
<subsection name="Example 1">
<source><![CDATA[
<format type="console"/>
]]></source>
</subsection>
<subsection name="Example 2">
<source><![CDATA[
<format type="extended">
%7.7{priority} %23.23{time:yyyy-MM-dd HH:mm:ss:SSS}
[%25.25{category}] : %{message}\n%{throwable}
</format>
]]></source>
</subsection>
<subsection name="XML Specification">
<table>
<tr><th>Attributes</th><th>Description</th></tr>
<tr>
<td>type</td>
<td>A keyword that identifies a format type (see Format
Type Table). Format instances are constructed relative to
to requested type and may take an element value as an argument.
A formatter element value (if recognized by the format type) is
a logkit format specification.
</td>
</tr>
</table>
</subsection>
<subsection name="Format Type Table">
<table>
<tr>
<th>Type</th><th>Description</th><th>Value</th></tr>
<tr>
<td>avalon</td>
<td>Simple logging format with error reporting and stack trace listing enabled.</td>
<td>yes</td>
</tr>
<tr>
<td>console</td>
<td>Simple logging format with error reporting enabled and stack trace listing disabled.</td>
<td>yes</td>
</tr>
<tr>
<td>extended</td>
<td>Extended patttern formatter using a depth-offset of 1.</td>
<td>yes</td>
</tr>
<tr>
<td>pattern</td>
<td>Constructs a new pattern formatter.</td>
<td>yes</td>
</tr>
<tr>
<td>xml</td>
<td>Constructs an XML formatter.</td>
<td>no</td>
</tr>
<tr>
<td>raw</td>
<td>Constructs a formatter using the LogKit RawFormatter class.</td>
<td>no</td>
</tr>
<tr>
<td>syslog</td>
<td>Constructs a formatter using the LogKit SyslogFormatter class.</td>
<td>no</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/multicast.xml
Index: multicast.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging - Multicast Log Target</title>
</properties>
<body>
<section name="Multicast Log Target">
<subsection name="Description">
<p>
The multicast target is a target that handles the redirection
of a logging event to one or more log targets. This target is
typically used in conjuction with different filters to control
and qualify the information presented to different targets.
For example, an application my configure a console target with
summary warning and error reports to console, and a detailed
error logg with full stack trace to a rotating file target.
The multiplex target enabled the declaration of a single logical
target and the subsequent formatting and generation of log message
appropriate for the relative targets.
</p>
</subsection>
<subsection name="Example">
<source><![CDATA[
<multicast id="multicast">
<targetref id="standard"/>
<targetref id="simple"/>
</multicast>
]]></source>
</subsection>
<subsection name="XML">
<table>
<tr><th>Attributes</th><th>Description</th></tr>
<tr>
<td>id</td>
<td>The log target identifier.</td>
</tr>
</table>
<table>
<tr><th>Nested Element</th><th>Description</th></tr>
<tr>
<td>targetref</td>
<td>A reference to an existing log target. The element contains an
id attribute whos value is the id of an existing logging target. Log
events directed to the multiplex target will be redirected to the logging
target identified by the taargetref id attribute value. Multiple
targetref elements may be contained within a multicast element.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/stream.xml
Index: stream.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging - Stream Log Target</title>
</properties>
<body>
<section name="Stream Log Target">
<subsection name="Description">
<p>The Console LogTarget provides support for the logging
of message to a console via System.out or System.err. If
no logging targets are defined, the implementation will
establish a default console target.</p>
</subsection>
<subsection name="Example">
<source><![CDATA[
<stream id="standard">
<name>System.out</name>
<format type="console"/>
</stream>
]]></source>
</subsection>
<subsection name="XML">
<table>
<tr><th>Attributes</th><th>Description</th></tr>
<tr>
<td>id</td>
<td>The log target identifier.</td>
</tr>
</table>
<table>
<tr><th>Nested Element</th><th>Description</th></tr>
<tr>
<td>name</td>
<td>The keyword 'System.out' or 'System.err'. The 'System.out' keyword will result in the
streaming of events to System.out. The 'System.err' keyword will result in the
streaming of events to System.err.</td>
</tr>
<tr>
<td>format</td>
<td>A standard <a href="formatter.html">formatter</a> statement.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/plugin/datagram.xml
Index: datagram.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging - Datagram Log Target Plugin</title>
</properties>
<body>
<section name="Datagram Log Target Plugin">
<subsection name="Description">
<p>This factory creates a DatagramOutputTarget object which will
sends datagrams to the specified address. The name of the target
is specified by the hostname attribute of the <address>
element and the port by the port attribute. The <format>
element wraps the format to output the log.</p>
</subsection>
<subsection name="Example">
<source><![CDATA[
<target id="syslog"
artifact="avalon-logging/avalon-logkit-syslog#1.0-SNAPSHOT">
<address hostname="localhost" port="514" facility="USER"/>
<format type="avalon"/>
</target>
]]></source>
</subsection>
<subsection name="XML">
<table>
<tr><th>Nested Element</th><th>Description</th></tr>
<tr>
<td>address</td>
<td>The address element holds two attributes - hostname and port
and facility. The hostname is the host to which events shall
be directed. The port identifies the port on the host machine.</td>
</tr>
<tr>
<td>format</td>
<td>A standard <a href="../formatter.html">formatter</a> statement.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/plugin/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging - Plugin Log Target</title>
</properties>
<body>
<section name="Plugin Log Target">
<subsection name="Description">
<p>The plugin target provides support for plugable log targets. A
typical plugin log target is defined using <target> element.</p>
</subsection>
<subsection name="Example">
<source><![CDATA[
<target id="datagram"
artifact="avalon-logging/avalon-logkit-datagram#1.0-SNAPSHOT">
<address hostname="localhost" port="0"/>
</target>
]]></source>
</subsection>
<subsection name="XML">
<table>
<tr><th>Attributes</th><th>Description</th></tr>
<tr>
<td>id</td>
<td>The log target identifier.</td>
</tr>
<tr>
<td>artifact</td>
<td>An artifact specifier.</td>
</tr>
</table>
<p>Nested element content is specific to the target factory established
by the plugin.</p>
</subsection>
<subsection name="Plugins">
<table>
<tr><th>Plugin</th><th>Description</th></tr>
<tr>
<td><a href="datagram.html">datagram</a></td>
<td>A datagram log target.</td>
</tr>
<tr>
<td><a href="socket.html">socket</a></td>
<td>A socket log target.</td>
</tr>
<tr>
<td><a href="syslog.html">syslog</a></td>
<td>A syslog log target.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/plugin/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<project>
<title>Merlin</title>
<body>
<links>
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/product/framework/"/>
<item name="Containers" href="http://avalon.apache.org/product/containers/"/>
<item name="Components" href="http://avalon.apache.org/product/components/"/>
</links>
<menu name="About Avalon Logging">
<item name="Overview" href="/index.html"/>
<item name="Specification" href="/spec/index.html"/>
<item name="Implementations" href="/impl/index.html">
<item name="LogKit" href="/impl/logkit/index.html">
<item name="Stream Target" href="/impl/logkit/stream.html"/>
<item name="File Target" href="/impl/logkit/file.html"/>
<item name="Multicast Target" href="/impl/logkit/multicast.html"/>
<item name="Plugin Target" href="/impl/logkit/plugin/index.html">
<item name="DataGram" href="/impl/logkit/plugin/datagram.html"/>
<item name="Socket" href="/impl/logkit/plugin/socket.html"/>
<item name="SysLog" href="/impl/logkit/plugin/syslog.html"/>
</item>
<item name="Formatter" href="/impl/logkit/formatter.html"/>
</item>
</item>
<item name="Examples" href="/examples/index.html"/>
</menu>
<menu name="Resources">
<item name="Javadoc" href="/api/index.html"/>
<item name="Download" href="/download.html"/>
</menu>
<menu name="Related Projects">
<item name="Merlin" href="http://avalon.apache.org/merlin"/>
<item name="Repository" href="http://avalon.apache.org/repository"/>
<item name="Utilities" href="http://avalon.apache.org/util"/>
</menu>
</body>
</project>
1.1 avalon/logging/site/xdocs/impl/logkit/plugin/smtp.xml
Index: smtp.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging</title>
</properties>
<body>
<section name="Avalon LogKit Plugin">
<subsection name="Avalon Logging Logkit API">
The LogKit plugin defines an local API for LogKit related
log target factories and log targets. Through this API the
LogKit implementation manages a set of standard targets and
a target plugin framework.
</subsection>
<subsection name="Standard LogTarget">
<table>
<tr><th>Factory</th><th>Description</th></tr>
<tr>
<td>Console</td>
<td>
<p>The Console LogTarget provides support for the logging
of message to a console via System.out or System.err. If
no logging targets are defined, the implementation will
establish a default console target.</p>
<p>Example</p>
<source><![CDATA[
<stream id="standard">
<name>System.out</name>
<format type="console"/>
</stream>
]]></source>
</td>
</tr>
<tr>
<td>Rotating File</td>
<td>
<p>The rotating file target provides support for a set of
rotation strategies including rotation by size, rotation
on data, and combined date/size rotation scenarios.</p>
<p>Example</p>
<source><![CDATA[
<file id="simple">
<filename>simple.log</filename>
<append>true</append>
<rotation type="revolving" init="1" max="10">
<size>100k</size>
</rotation>
</file>
]]></source>
</td>
</tr>
<tr>
<td>Multlipex</td>
<td>
<p>The multiplex target is a target that handles the redirection
of a logging event to one or more log targets. This target is
typically used in conjuction with different filters to control
and qualify the information presented to different targets.
For example, an application my configure a console target with
summary warning and error reports to console, and a detailed
error logg with full stack trace to a rotating file target.
The multiplex target enabled the declaration of a single logical
target and the subsequent formatting and generation of log message
appropriate for the relative targets.</p>
<p>Example</p>
<source><![CDATA[
<multicast id="multicast">
<targetref id="standard"/>
<targetref id="simple"/>
</multicast>
]]></source>
</td>
</tr>
<tr>
<td>Plugin</td>
<td>
<p>The plugin target provides support for plugable log targets. A
typical plugin log target is defined using <target> element.</p>
<p>Several plugable log targets are currently available.</p>
<table>
<tr><th>Plugin</th><th>Description</th></tr>
<tr>
<td>DataGram</td>
<td><p>A datagram log target.<br/>
avalon-logging/avalon-logkit-datagram#1.0-SNAPSHOT</p>
<source><![CDATA[
<target id="datagram"
artifact="avalon-logging/avalon-logkit-datagram#1.0-SNAPSHOT">
<address hostname="localhost" port="0"/>
</target>
]]></source>
</td>
</tr>
<tr>
<td>Socket</td>
<td><p>A socket log target.<br/>
avalon-logging/avalon-logkit-socket#1.0-SNAPSHOT</p></td>
</tr>
<tr>
<td>Syslog</td>
<td><p>A syslog log target.<br/>
avalon-logging/avalon-logkit-syslog#1.0-SNAPSHOT</p>
<source><![CDATA[
<target id="syslog"
artifact="avalon-logging/avalon-logkit-syslog#1.0-SNAPSHOT">
<address hostname="localhost" port="514" facility="USER"/>
<format type="avalon"/>
</target>
]]></source>
</td>
</tr>
<tr>
<td>SMTP</td>
<td><p>An SMTP log target (available on request).<br/>
avalon-logging/avalon-logkit-smtp#1.0-SNAPSHOT</p>
<source><![CDATA[
<target id="smtp"
artifact="avalon-logging/avalon-logkit-smtp#1.0-SNAPSHOT">
<to>mcconnell@osm.net</to>
<from>info@dpml.net</from>
<subject>logging target test</subject>
<maximum-size>1</maximum-size>
<session>
</session>
</target>
]]></source>
</td>
</tr>
</table>
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/plugin/socket.xml
Index: socket.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging - Socket Log Target Plugin</title>
</properties>
<body>
<section name="Socket Log Target Plugin">
<subsection name="Description">
<p>This factory creates a SocketOutputTarget object which will
use TCP/IP socket to communicate with the server. The name of the
target is specified by the hostname attribute of the <address>
element and the port by the port attribute.</p>
</subsection>
<subsection name="Example">
<source><![CDATA[
<target id="socket"
artifact="avalon-logging/avalon-logkit-socket#1.0-SNAPSHOT">
<address hostname="localhost" port="514"/>
</target>
]]></source>
</subsection>
<subsection name="XML">
<table>
<tr><th>Nested Element</th><th>Description</th></tr>
<tr>
<td>address</td>
<td>The address element holds two attributes - hostname and port
and facility. The hostname is the host to which events shall
be directed. The port identifies the port on the host machine.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon/logging/site/xdocs/impl/logkit/plugin/syslog.xml
Index: syslog.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Avalon Logging - Stream Log Target</title>
</properties>
<body>
<section name="Syslog Log Target Plugin">
<subsection name="Description">
<p>The syslog target constructs a log target for a syslog.</p>
</subsection>
<subsection name="Example">
<source><![CDATA[
<target id="syslog"
artifact="avalon-logging/avalon-logkit-syslog#1.0-SNAPSHOT">
<address hostname="localhost" port="514" facility="USER"/>
<format type="avalon"/>
</target>
]]></source>
</subsection>
<subsection name="XML">
<table>
<tr><th>Nested Element</th><th>Description</th></tr>
<tr>
<td>address</td>
<td>The address element holds three attributes - hostname, port
and facility. The hostname is the host to which syslog events shall
be directed. The port identifies the port on the host machine. The
facility attribute is a keyword described in the Facility Keys Table.</td>
</tr>
<tr>
<td>format</td>
<td>A standard <a href="../formatter.html">formatter</a> statement.</td>
</tr>
</table>
</subsection>
<subsection name="Facility Keyword Table">
<table>
<tr>
<th>Keyword</th><th>Description</th></tr>
<tr>
<td>kern</td>
<td></td>
</tr>
<tr>
<td>user</td>
<td></td>
</tr>
<tr>
<td>mail</td>
<td></td>
</tr>
<tr>
<td>daemon</td>
<td></td>
</tr>
<tr>
<td>auth</td>
<td></td>
</tr>
<tr>
<td>syslog</td>
<td></td>
</tr>
<tr>
<td>lpr</td>
<td></td>
</tr>
<tr>
<td>news</td>
<td></td>
</tr>
<tr>
<td>uucp</td>
<td></td>
</tr>
<tr>
<td>cron</td>
<td></td>
</tr>
<tr>
<td>authpriv</td>
<td></td>
</tr>
<tr>
<td>ftp</td>
<td></td>
</tr>
<tr>
<td>local0</td>
<td></td>
</tr>
<tr>
<td>local1</td>
<td></td>
</tr>
<tr>
<td>local2</td>
<td></td>
</tr>
<tr>
<td>local3</td>
<td></td>
</tr>
<tr>
<td>local4</td>
<td></td>
</tr>
<tr>
<td>local5</td>
<td></td>
</tr>
<tr>
<td>local6</td>
<td></td>
</tr>
<tr>
<td>local7</td>
<td></td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.2 +1 -0 avalon/logging/site/xdocs/spec/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon/logging/site/xdocs/spec/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 21 Feb 2004 10:21:46 -0000 1.1
+++ navigation.xml 21 Feb 2004 15:20:20 -0000 1.2
@@ -35,6 +35,7 @@
<item name="Overview" href="/index.html"/>
<item name="Specification" href="/spec/index.html"/>
<item name="Implementations" href="/impl/index.html"/>
+ <item name="Examples" href="/examples/index.html"/>
</menu>
<menu name="Resources">
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org