November 2006 - logback-dev

svn commit: r863 - logback/trunk/logback-examples
by noreply.ceki＠qos.ch 03 Nov '06

03 Nov '06

Author: ceki Date: Fri Nov 3 10:39:54 2006 New Revision: 863 Modified: logback/trunk/logback-examples/pom.xml Log: removed core-test dependency Modified: logback/trunk/logback-examples/pom.xml ============================================================================== --- logback/trunk/logback-examples/pom.xml (original) +++ logback/trunk/logback-examples/pom.xml Fri Nov 3 10:39:54 2006 @@ -40,7 +40,6 @@ <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> - <classifier>tests</classifier> </dependency> <dependency>

1 0

svn commit: r862 - in logback/trunk: logback-examples/src/main/java/chapter1 logback-site/src/site/xdocTemplates
by noreply.ceki＠qos.ch 02 Nov '06

02 Nov '06

Author: ceki Date: Thu Nov 2 22:57:04 2006 New Revision: 862 Modified: logback/trunk/logback-examples/src/main/java/chapter1/Bar.java logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld1.java logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld2.java logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld3.java logback/trunk/logback-examples/src/main/java/chapter1/MyApp.java logback/trunk/logback-examples/src/main/java/chapter1/MyAppWithConfigFile.java logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Log: ongoing work Modified: logback/trunk/logback-examples/src/main/java/chapter1/Bar.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter1/Bar.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter1/Bar.java Thu Nov 2 22:57:04 2006 @@ -1,11 +1,21 @@ +/** + * Logback: the generic, reliable, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ package chapter1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class Bar { - Logger logger = LoggerFactory.getLogger(Bar.class); - public void doIt() { - logger.debug("doing my job"); - } + Logger logger = LoggerFactory.getLogger(Bar.class); + + public void doIt() { + logger.debug("doing my job"); + } } \ No newline at end of file Modified: logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld1.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld1.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld1.java Thu Nov 2 22:57:04 2006 @@ -1,3 +1,12 @@ +/** + * Logback: the generic, reliable, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ package chapter1; import org.slf4j.Logger; @@ -5,9 +14,9 @@ public class HelloWorld1 { - public static void main(String[] args) { + public static void main(String[] args) { Logger logger = LoggerFactory.getLogger("chapter1.HelloWorld1"); - logger.debug("Hello world."); - } + logger.debug("Hello world."); + } } Modified: logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld2.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld2.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld2.java Thu Nov 2 22:57:04 2006 @@ -1,3 +1,12 @@ +/** + * Logback: the generic, reliable, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ package chapter1; import org.slf4j.Logger; @@ -7,9 +16,9 @@ public class HelloWorld2 { - public static void main(String[] args) { + public static void main(String[] args) { Logger logger = LoggerFactory.getLogger("chapter1.HelloWorld2"); - logger.debug("Hello world."); - LoggerStatusPrinter.printStatusInDefaultContext(); - } + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + } } Modified: logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld3.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld3.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter1/HelloWorld3.java Thu Nov 2 22:57:04 2006 @@ -1,3 +1,12 @@ +/** + * Logback: the generic, reliable, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ package chapter1; import org.slf4j.Logger; @@ -11,8 +20,8 @@ public static void main(String[] args) { Logger logger = LoggerFactory.getLogger("chapter1.HelloWorld3"); - BasicConfigurator.configureDefaultContext(); - logger.debug("Hello world."); - LoggerStatusPrinter.printStatusInDefaultContext(); - } + BasicConfigurator.configureDefaultContext(); + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + } } Modified: logback/trunk/logback-examples/src/main/java/chapter1/MyApp.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter1/MyApp.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter1/MyApp.java Thu Nov 2 22:57:04 2006 @@ -1,3 +1,12 @@ +/** + * Logback: the generic, reliable, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ package chapter1; // Import SLF4J classes. @@ -8,15 +17,15 @@ public class MyApp { - public static void main(String[] args) { - // Set up a simple configuration that logs on the console. - BasicConfigurator.configureDefaultContext(); - - Logger logger = LoggerFactory.getLogger(MyApp.class); - - logger.info("Entering application."); - Bar bar = new Bar(); - bar.doIt(); - logger.info("Exiting application."); - } + public static void main(String[] args) { + // Set up a simple configuration that logs on the console. + BasicConfigurator.configureDefaultContext(); + + Logger logger = LoggerFactory.getLogger(MyApp.class); + + logger.info("Entering application."); + Bar bar = new Bar(); + bar.doIt(); + logger.info("Exiting application."); + } } Modified: logback/trunk/logback-examples/src/main/java/chapter1/MyAppWithConfigFile.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter1/MyAppWithConfigFile.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter1/MyAppWithConfigFile.java Thu Nov 2 22:57:04 2006 @@ -1,3 +1,12 @@ +/** + * Logback: the generic, reliable, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ package chapter1; //Import SLF4J classes. Modified: logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Thu Nov 2 22:57:04 2006 @@ -107,21 +107,6 @@ <p>Let us now begin experimenting with logback.</p> - <p>In order to facilitate running the the examples in this - introduction, we have placed the required jar files in the - <em>$LOGBACK_HOME/logback-examples/lib</em> directory. Assuming - your current directory is $LOGBACK_HOME/logback-examples, where - $LOGBACK_HOME is the directory you've installed logback, you can - start launch the first example application, - <em>chapter1.HelloWord1</em> with the following command: - </p> - <div class="source"><pre>java -cp lib/slf4j-api-1.1.0-beta0.jar;../logback-core-${version}.jar;\ - ../logback-classic-${version}.jar;logback-examples-${version}.jar\ - chapter1.HelloWorld1</pre></div> - - - - <em>Example 1.1: Basic template for logging (<a href="xref/chapter1/HelloWorld1.html">logback-examples/src/main/java/chapter1/HelloWorld1.java</a>)</em> <div class="source"><pre>package chapter1; @@ -169,11 +154,17 @@ </p> - <p> - Once you're in the <em>logback-examples/classes</em> directory of the logback distribution, you can run this class with the command: - </p> - - <div class="source"><pre>java chapter1.HelloWorld1</pre></div> + <p>In order to facilitate running the the examples in this + introduction, we have placed the required slf4j-api.jar file in + the <em>$LOGBACK_HOME/logback-examples/lib</em> + directory. Assuming your current directory is + $LOGBACK_HOME/logback-examples, where $LOGBACK_HOME is the + directory you've installed logback, you can launch the first + sample application, <em>chapter1.HelloWord1</em> with the command: + </p> + <div class="source"><pre>java -cp lib/slf4j-api-1.1.0-beta0.jar;../logback-core-${version}.jar;\ + ../logback-classic-${version}.jar;logback-examples-${version}.jar\ + chapter1.HelloWorld1</pre></div> <p> Suprisingly enough, launching the <code>HelloWorld1</code> @@ -192,7 +183,7 @@ class. </p> -<em>Example 1.2: Printing Logger Status (logback-examples/src/main/java/chapter1/HelloWorld2.java)</em> +<em>Example 1.2: Printing Logger Status (<a href="xref/chapter1/HelloWorld2.html">logback-examples/src/main/java/chapter1/HelloWorld2.java</a>)</em> <div class="source"><pre>package chapter1; import org.slf4j.Logger; @@ -216,23 +207,22 @@ context [default] for logger [chapter1.HelloWorld2].</pre></div> -  - <p> Logback complains that no appenders were configured for the - default context. An <code>Appender</code> is a class that can be seen as an - output destination. Appenders exist for many different - destinations including the console, files, Syslog, Socket, JMS and many more. Users - can also easily create their own Appenders for any specific - situation. + default context. An <code>Appender</code> is a class that can be + seen as an output destination. Appenders exist for many different + destinations including the console, files, Syslog, Socket, JMS and + many more. Users can also easily create their own Appenders as + appropriate for their specific situation. </p> <p> - Configuring logback can be done in different ways. The - simplest but least flexible way is by calling the - <code>BasicConfigurator</code> class, like in the following code snippet. + Configuring logback can be done in various ways. The simplest but + least flexible way is by calling the + <code>BasicConfigurator</code> class, like in the following code + snippet. </p> - <em>Example 1.3: Configuring before logging (logback-examples/src/main/java/chapter1/HelloWorld3.java)</em> + <em>Example 1.3: Configuring before logging (<a href="xref/chapter1/HelloWorld3.html">logback-examples/src/main/java/chapter1/HelloWorld3.java)</a></em> <div class="source"><pre>package chapter1; import org.slf4j.Logger; @@ -262,17 +252,20 @@ <div class="source"><pre>0 [main] DEBUG chapter1.HelloWorld3 - Hello world.</pre></div> <p> - This example is rather simple. However, actual logging in a larger - application would not be that different. The general pattern logging statements - will barely change. Only the configuration process will be - different since you don't need (nor should) configure the - logging context in each and every class that will require - logging. As you will see later on in this document, configuring logback can be done - in different flexible and powerfull manners. - As well, the <code>LoggerStatusPrinter</code> will certainly not be - used after all the logging statements. + This example is rather simple. However, actual logging in a + larger application would not be much different. The general + pattern logging statements will barely change. Only the + configuration process will be different since you don't need + (nor should) configure the logging context in each and every + class that requires logging. As you will see later on in this + document, configuring logback can be done in different flexible + and powerfull ways. Note that, normally, you won't need to + invoke <code>LoggerStatusPrinter</code> after your log + statements. </p> +  + <p> These are the three steps that are required to enable logging in your application. </p>

1 0

svn commit: r861 - in logback/trunk: logback-examples/lib logback-site/src/site/xdocTemplates src/main/assembly
by noreply.ceki＠qos.ch 02 Nov '06

02 Nov '06

Author: ceki Date: Thu Nov 2 22:32:45 2006 New Revision: 861 Added: logback/trunk/logback-examples/lib/ logback/trunk/logback-examples/lib/slf4j-api-1.1.0-beta0.jar (contents, props changed) Modified: logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml logback/trunk/src/main/assembly/dist.xml Log: Syncing assembly with shortIntro Added: logback/trunk/logback-examples/lib/slf4j-api-1.1.0-beta0.jar ============================================================================== Binary file. No diff available. Modified: logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml Thu Nov 2 22:32:45 2006 @@ -18,7 +18,7 @@ <a href="shortIntro.html"><b>A short introduction to logback-classic</b></a> </li> <li> - <a href="accessLogJetty.html"><b>A short introduction to access logging with logback-access and Jetty</b></a> + <a href="access.html"><b>A short introduction to access logging Jetty and Tomcat</b></a> </li> <li> <a href="joran.html"><b>A introduction to Joran</b></a> Modified: logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Thu Nov 2 22:32:45 2006 @@ -97,36 +97,32 @@ <h2>First Baby Step</h2> + <h3>Requirements</h3> + <p>Logback-classic module requires the presence <em>slf4j-api.jar</em>, <em>logback-core.jar</em> in addition to <em>logback-classic.jar</em> on the classpath. </p> - <p>in order to falitate running the the examples in this document, - we have placed the required jar files in the - <em>logback-examples/lib</em> directory. Assuming your current - directory is $LOGBACK_HOME/logback-examples, where $LOGBACK_HOME - is the directory you've installed logback, you can start launch - the first example application, chapter1.HelloWord1 with the - following command: - </p> - <div class="source"><pre> - java -cp lib/slf4j-api-1.1.0-beta0.jar;lib/logback-core-${version}.jar;lib/logback-classic-${version}.jar - </pre></div> + <p>Let us now begin experimenting with logback.</p> -<h1>FIXME</h1> - - <p>Assuming the After you - have added the jar files <em>slf4j-api.jar</em>, - <em>logback-core.jar</em>, <em>logback-classic.jar</em> and their - dependencies to your classpath, you can begin experimenting with - logback. To + <p>In order to facilitate running the the examples in this + introduction, we have placed the required jar files in the + <em>$LOGBACK_HOME/logback-examples/lib</em> directory. Assuming + your current directory is $LOGBACK_HOME/logback-examples, where + $LOGBACK_HOME is the directory you've installed logback, you can + start launch the first example application, + <em>chapter1.HelloWord1</em> with the following command: </p> + <div class="source"><pre>java -cp lib/slf4j-api-1.1.0-beta0.jar;../logback-core-${version}.jar;\ + ../logback-classic-${version}.jar;logback-examples-${version}.jar\ + chapter1.HelloWorld1</pre></div> + + - <p>java -cp lib/logback-core-${version}.jar</p> -<em>Example 1.1: Basic template for logging (logback-examples/src/main/java/chapter1/HelloWorld1.java)</em> +<em>Example 1.1: Basic template for logging (<a href="xref/chapter1/HelloWorld1.html">logback-examples/src/main/java/chapter1/HelloWorld1.java</a>)</em> <div class="source"><pre>package chapter1; import org.slf4j.Logger; Modified: logback/trunk/src/main/assembly/dist.xml ============================================================================== --- logback/trunk/src/main/assembly/dist.xml (original) +++ logback/trunk/src/main/assembly/dist.xml Thu Nov 2 22:32:45 2006 @@ -79,10 +79,17 @@ </fileSet>  <fileSet> - <directory>logback-examples/target/classes/</directory> - <outputDirectory>logback-examples/classes/</outputDirectory> + <directory>logback-examples/target/</directory> + <outputDirectory>logback-examples/</outputDirectory> + <includes> + <include>logback-examples-${project.version}.jar</include> + </includes> </fileSet> - + <fileSet> + <directory>logback-examples/lib/</directory> + <outputDirectory>logback-examples/lib</outputDirectory> + </fileSet> +  <fileSet> <directory>logback-core/target/</directory>

1 0

svn commit: r860 - logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi
by noreply.ceki＠qos.ch 02 Nov '06

02 Nov '06

Author: ceki Date: Thu Nov 2 22:14:02 2006 New Revision: 860 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/TurboFilterAttachable.java Log: minor fix Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/TurboFilterAttachable.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/TurboFilterAttachable.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/TurboFilterAttachable.java Thu Nov 2 22:14:02 2006 @@ -8,7 +8,7 @@ import ch.qos.logback.core.spi.FilterReply; /** - * Interface for attaching ClassicFilter instances to objects. + * Interface for attaching {@link TurboFilter} instances to objects. * * @author Ceki Gülcü */

1 0

svn commit: r859 - in logback/trunk: logback-core/src/main/java/ch/qos/logback/core/rolling logback-site/src/site/fml
by noreply.seb＠qos.ch 02 Nov '06

02 Nov '06

Author: seb Date: Thu Nov 2 21:03:48 2006 New Revision: 859 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java logback/trunk/logback-site/src/site/fml/codes.fml Log: Moved tests to getNewActiveFileName method Added an entry to codes.fml when filename is not set Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java Thu Nov 2 21:03:48 2006 @@ -21,7 +21,7 @@ * according to a fixed window algorithm as described below. * * <p> - * The <b>ActiveFileName</b> property, which is required, represents the name + * The <b>File</b> property, which is required, represents the name * of the file where current logging output will be written. The * <b>FileNamePattern</b> option represents the file name pattern for the * archived (rolled over) log files. If present, the <b>FileNamePattern</b> @@ -54,6 +54,7 @@ public class FixedWindowRollingPolicy extends RollingPolicyBase { static final String FNP_NOT_SET = "The FileNamePattern option must be set before using FixedWindowRollingPolicy. "; static final String SEE_FNP_NOT_SET = "See also http://logback.qos.ch/codes.html#tbr_fnp_not_set"; + static final String SEE_PARENT_FN_NOT_SET = "Please refer to http://logback.qos.ch/codes.html#fwrp_parentFileName_not_set"; int maxIndex; int minIndex; RenameUtil util = new RenameUtil(); @@ -82,9 +83,10 @@ addWarn(SEE_FNP_NOT_SET); throw new IllegalStateException(FNP_NOT_SET + SEE_FNP_NOT_SET); } - // if (activeFileName == null) { - if (getNewActiveFileName() == null) { - addWarn("The ActiveFile name option must be set before using this rolling policy."); + + if (getParentFileName() == null) { + addWarn("The File name option must be set before using this rolling policy."); + addWarn(SEE_PARENT_FN_NOT_SET); throw new IllegalStateException("The ActiveFileName option must be set."); } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java Thu Nov 2 21:03:48 2006 @@ -81,9 +81,7 @@ if (rollingPolicy != null) { //if no active file name was set, then it's the responsability of the //rollingPolicy to create one. - if (getFile() == null) { - setFile(rollingPolicy.getNewActiveFileName()); - } + setFile(rollingPolicy.getNewActiveFileName()); activeFileCache = new File(getFile()); addInfo("Active log file name: "+ getFile()); Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java Thu Nov 2 21:03:48 2006 @@ -246,11 +246,9 @@ } } - //if we already generated a name, then we have to update - //the fileAppender with a new active file name. - if (getParentFileName() == lastGeneratedFileName) { - setParentFileName(getNewActiveFileName()); - } + //let's update the parent active file name + setParentFileName(getNewActiveFileName()); + } /** @@ -273,16 +271,16 @@ * the RollingPolicy knows it's responsible for the change of the * file name. * - * - * tmp note: !!!!! This is called only once at the start of the appender, - * and only if the parent file name is null, so no test is required. - * */ public String getNewActiveFileName() { - String newName = activeFileNamePattern.convertDate(lastCheck); - addInfo("Generated a new name for RollingFileAppender: " + newName); - lastGeneratedFileName = newName; - return newName; + if (getParentFileName() == null || getParentFileName() == lastGeneratedFileName) { + String newName = activeFileNamePattern.convertDate(lastCheck); + addInfo("Generated a new name for RollingFileAppender: " + newName); + lastGeneratedFileName = newName; + return newName; + } else { + return getParentFileName(); + } } public boolean isTriggeringEvent(File file, final Object event) { Modified: logback/trunk/logback-site/src/site/fml/codes.fml ============================================================================== --- logback/trunk/logback-site/src/site/fml/codes.fml (original) +++ logback/trunk/logback-site/src/site/fml/codes.fml Thu Nov 2 21:03:48 2006 @@ -39,8 +39,31 @@ for more information. </p> </answer> - </faq> + + <faq id="fwrp_parentFileName_not_set"> + + <question> + <p>The File name option must be set before <code>FixedWindowRollingPolicy</code>.</p> + </question> + + <answer> + <p> + The <span class="option">File</span> option is mandatory with <code>FixedWindowRollingPolicy</code>. Moreover, the File option must be + set before the declaration configuring <code>FixedWindowRollingPolicy</code>. + </p> + <p> + See the logback manual's chapter about + <a + href="http://logback.qos.ch/manual/appenders.html#FixedWindowRollingPolicy"> + FixedWindowRollingPolicy + </a> + for more information. + </p> + </answer> + </faq> + + <faq id="socket_no_host"> <question> No remote host or address is set for

1 0

svn commit: r858 - in logback/trunk: logback-examples logback-examples/src/main/java/chapter4 logback-site/src/site/xdocTemplates/manual logback-skin/src/main/resources/css
by noreply.seb＠qos.ch 02 Nov '06

02 Nov '06

Author: seb Date: Thu Nov 2 20:36:44 2006 New Revision: 858 Added: logback/trunk/logback-examples/src/main/java/chapter4/ExitWoes.java logback/trunk/logback-examples/src/main/java/chapter4/IO.java logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml Modified: logback/trunk/logback-examples/ (props changed) logback/trunk/logback-examples/pom.xml logback/trunk/logback-skin/src/main/resources/css/site.css Log: on going work, documenting appenders (chapter4) modified css to display appender options Modified: logback/trunk/logback-examples/pom.xml ============================================================================== --- logback/trunk/logback-examples/pom.xml (original) +++ logback/trunk/logback-examples/pom.xml Thu Nov 2 20:36:44 2006 @@ -31,18 +31,28 @@ </licenses> <dependencies> + <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> </dependency> + + <dependency> + <groupId>ch.qos.logback</groupId> + <artifactId>logback-core</artifactId> + <classifier>tests</classifier> + </dependency> + <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> </dependency> + <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-access</artifactId> </dependency> + </dependencies> <build> Added: logback/trunk/logback-examples/src/main/java/chapter4/ExitWoes.java ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter4/ExitWoes.java Thu Nov 2 20:36:44 2006 @@ -0,0 +1,41 @@ +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ +package chapter4; + +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; + +import org.slf4j.Logger; + +import ch.qos.logback.classic.LoggerContext; +import ch.qos.logback.core.WriterAppender; +import ch.qos.logback.core.layout.EchoLayout; + + + +public class ExitWoes { + + public static void main(String[] args) throws Exception { + LoggerContext lc = new LoggerContext(); + WriterAppender writerAppender = new WriterAppender(); + writerAppender.setContext(lc); + writerAppender.setLayout(new EchoLayout()); + + OutputStream os = new FileOutputStream("exitWoes1.log"); + writerAppender.setWriter(new OutputStreamWriter(os)); + writerAppender.setImmediateFlush(false); + writerAppender.start(); + + Logger logger = lc.getLogger(ExitWoes.class); + + logger.debug("Hello world."); + } +} Added: logback/trunk/logback-examples/src/main/java/chapter4/IO.java ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter4/IO.java Thu Nov 2 20:36:44 2006 @@ -0,0 +1,176 @@ +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ + +package chapter4; + +import org.slf4j.Logger; + +import ch.qos.logback.classic.LoggerContext; +import ch.qos.logback.classic.PatternLayout; +import ch.qos.logback.core.FileAppender; +import ch.qos.logback.core.layout.EchoLayout; + + + +public class IO extends Thread { + static String msgLong = "ABCDEGHIJKLMNOPQRSTUVWXYZabcdeghijklmnopqrstuvwxyz1234567890"; + static String msgShort = "Hello"; + static boolean scarceCPU; + static int numThreads; + static long l; + static boolean longMessage; + long len; + boolean buffered; + boolean immediateFlush; + Logger logger; + LoggerContext context; + double throughput; + + public IO(boolean _buffered, boolean _immediateFlush, long _len) { + this.len = _len; + this.buffered = _buffered; + this.immediateFlush = _immediateFlush; + context = new LoggerContext(); + logger = context.getLogger("logger-" + getName()); + + // A FileAppender is created according to the buffering and + // immediate flush setting of this IO instance. + FileAppender fa = new FileAppender(); + + if (longMessage) { + PatternLayout pa = new PatternLayout(); + pa.setPattern("%r %5p %c [%t] - %m%n"); + fa.setLayout(pa); + } else { + fa.setLayout(new EchoLayout()); + } + + fa.setFile(getName() + ".log"); + fa.setAppend(false); + fa.setImmediateFlush(immediateFlush); + fa.setBufferedIO(buffered); + fa.setContext(context); + fa.start(); + + } + + public static void main(String[] argv) throws Exception { + if (argv.length != 4) { + usage("Wrong number of arguments."); + } + + l = Integer.parseInt(argv[0]); + numThreads = Integer.parseInt(argv[1]); + scarceCPU = "true".equalsIgnoreCase(argv[2]); + longMessage = "long".equalsIgnoreCase(argv[3]); + + // ---------------------------------------------------- + // first test with unbuffered IO and immediate flushing + perfCase(false, true, l); + + // ---------------------------------------------------- + // Second test with unbuffered IO and no immediate flushing + perfCase(false, false, l); + + // ---------------------------------------------------- + // Third test with buffered IO and no immediate flushing + perfCase(true, false, l); + + // There is no fourth test as buffered IO and immediate flushing + // do not make sense. + } + + static void usage(String msg) { + System.err.println(msg); + System.err.println("Usage: java " + IO.class.getName() + + " runLength numThreads scarceCPU (short|long)\n" + + " runLength (integer) the number of logs to generate perthread\n" + + " numThreads (integer) the number of threads.\n" + + " scarceCPU (boolean) if true an additional CPU intensive thread is created\n" + + " (short|long) length of log messages."); + System.exit(1); + } + + static void perfCase(boolean buffered, boolean immediateFlush, long len) + throws Exception { + IO[] threads = new IO[numThreads]; + Counter counterThread = null; + + if (scarceCPU) { + counterThread = new Counter(); + counterThread.start(); + } + + // First create the threads + for (int i = 0; i < numThreads; i++) { + threads[i] = new IO(buffered, immediateFlush, len); + } + + // then start them + for (int i = 0; i < numThreads; i++) { + threads[i].start(); + } + + // wait for them to stop, compute the average throughputs + double sum = 0; + + for (int i = 0; i < numThreads; i++) { + threads[i].join(); + sum += threads[i].throughput; + } + + if (scarceCPU) { + // setting the interrupted field will cause counterThread to stop + counterThread.interrupted = true; + counterThread.join(); + } + + System.out.println("On average throughput of " + (sum / numThreads) + + " logs per millisecond."); + System.out.println("------------------------------------------------"); + } + + public void run() { + String msg = msgShort; + + if (longMessage) { + msg = msgLong; + } + + long before = System.currentTimeMillis(); + + for (int i = 0; i < len; i++) { + logger.debug(msg); + } + + throughput = (len * 1.0) / (System.currentTimeMillis() - before); + System.out.println(getName() + ", buffered: " + buffered + + ", immediateFlush: " + immediateFlush + ", throughput: " + throughput + + " logs per millisecond."); + } +} + + +class Counter extends Thread { + public boolean interrupted = false; + public double counter = 0; + + public void run() { + long before = System.currentTimeMillis(); + + while (!interrupted) { + counter += 0.001; + } + + double tput = (counter * 1.0) / (System.currentTimeMillis() - before); + System.out.println("Counter thread " + getName() + + " incremented counter by " + tput + " per millisecond."); + } +} Added: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml Thu Nov 2 20:36:44 2006 @@ -0,0 +1,471 @@ +<document> +  + + + <body> + <h2>Chapter 4: Appenders</h2> + <div class="author"> + Authors: Ceki Gülcü, Sébastien Pennec + </div> + + + <table> + <tr> + <td valign="top" align="top"> + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-sa/2.5/"> + <img alt="Creative Commons License" + style="border-width: 0" + src="http://creativecommons.org/images/public/somerights20.png" /> + </a> + </td> + <td> + <p>Copyright © 2000-2006, QOS.ch</p> + + <p> +  + This work is licensed under a + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-sa/2.5/"> + Creative Commons + Attribution-NonCommercial-ShareAlike 2.5 + License + </a> + . +  + </p> + </td> + </tr> + </table> + + <h2>What is an Appender</h2> + + <p> + Logback delegates the task of writing a logging event to appenders. + Appenders must imple-ment the <code>ch.qos.logback.core.Appender</code> interface. + The salient methods of this interface are summarized below: + </p> + <div class="source"><pre>package ch.qos.logback.core; + +import ch.qos.logback.core.spi.ContextAware; +import ch.qos.logback.core.spi.FilterAttachable; +import ch.qos.logback.core.spi.LifeCycle; + + +public interface Appender extends LifeCycle, ContextAware, FilterAttachable { + + public String getName(); + <b>void doAppend(Object event);</b> + public void setLayout(Layout layout); + public Layout getLayout(); + public void setName(String name); + +}</pre></div> + + <p> + Most of the methods in the Appender interface are made of setter + and getter methods. A notable exception is the <code>doAppend()</code> + method taking an Object instance as its only parameter. + This method is perhaps the most important in the logback framework. + It is responsible for outputting the logging events in a suitable format + to the appropriate output device. Appenders are named entities. + This ensures that they can be referenced by name, a quality confirmed + to be especially significant in configuration scripts. + An appender can contain multiple filters, thus the <code>Appender</code> + interface extending the <code>FilterAttachable</code> interface. + Filters are discussed in detail in a subsequent chapter. + </p> + + <p> + Appenders are ultimately responsible for outputting logging events. + However, they may delegate the actual formatting of the event to a + <code>Layout</code> object. + Each layout is associated with one and only one appender, referred to + as the containing appender. Some appenders have a built-in or fixed + event format, such that they do not require a layout. For example, the + <code>SocketAppender</code> simply serialize logging events before + transmitting them over the wire. + </p> + + <h2>AppenderBase</h2> + + <p> + The <code>ch.qos.logback.core.AppenderSkeleton</code> class is an abstract + class implementing the <code>Appender</code> interface. + It provides basic functionality shared by all appenders, + such as methods for getting or setting their name, their started status, + their layout and their filters. + It is the super-class of all appenders shipped with logback. + Although an abstract class, AppenderBase actually implements the + <code>doAppend()</code> method in the <code>Append</code> interface. + Perhaps the clearest way to discuss AppenderBase class is by + presenting a bit of its actual source code. + <code>AppenderBase</code>'s complete source code is also + <a href="../xref/ch/qos/logback/core/AppenderBase.html"> + available for viewing</a>. + </p> + +<div class="source"><pre>public synchronized void doAppend(Object eventObject) { + + // prevent re-entry. + if (guard) { + return; + } + + try { + guard = true; + + if (!this.started) { + if (statusRepeatCount++ < ALLOWED_REPEATS) { + addStatus(new WarnStatus( + "Attempted to append to non started appender [" + name + "].",this)); + } + return; + } + + if (getFilterChainDecision(eventObject) == FilterReply.DENY) { + return; + } + + // ok, we now invoke derived class' implementation of append + this.append(eventObject); + + } finally { + guard = false; + } +}</pre></div> + + <p> + This implementation of the <code>doAppend()</code> method is synchronized. + It follows that logging to the same appender from different + threads is safe. While a thread, say <em>T</em>, is executing the <code>doAppend()</code> + method, subsequent calls by other threads are queued until <em>T</em> + leaves the <code>doAppend()</code> method, ensuring + <em>T</em>'s exclusive access to the appender. + </p> + + <p> + EXPLAIN GUARD + </p> + + <p> + The first statement of the <code>doAppend()</code> method, once the <code>try</code> block + is reached is to check whether the <code>started</code> field is true. + If it is not, <code>doAppend()</code> will send a warning message and return. + In other words, once stopped, it is impossible to write to a closed appender. + <code>Appender</code> object implement the <code>LifeCycle</code> interface, + which implies that they implement <code>start()</code>, <code>stop()</code> + and <code>isStarted()</code> methods. After setting all the options of an appender, + Joran, logback's configuration framework, calls this method to signal the appender + to bind or activate its options. + Indeed, depending on the appender, certain options cannot be activated because + of interferences with other options, or appenders can even not start at all if + some options are missing. + For example, since file creation depends on truncation mode, + <code>FileAppender</code> cannot act on the value of its <code>File</code> option + until the value of the Append option is also known for certain. + Sub-classes of <code>AppenderBase</code> are required to set the boolean variable + <code>started</code> to false when their <code>stop()</code> method is invoked. + </p> + + <p> + If a warning message is sent due to incorrect calls to the <code>doAppend()</code> + method, logback's powerful <code>Status</code> error reporting system is used. In case + several incorrect calls on <code>doAppend()</code> are issued, <code>AppenderBase</code> + does not send an unlimited number of warnings. Once a certain limit is reached, the + <code>AppenderBase</code> instance stops its warnings. + </p> + + <p> + The next <code>if</code> statement checks the result + of the attached <code>Filter</code> objects. + Depending on the decision made by the filters + in the filter chain, events can be denied or alternatively accepted. + In the absence of a decision by the filter chain, events are accepted by default. + </p> + + <p> + Lastly, the <code>doAppend()</code> method invoke the derived classes' implementation + of the <code>append()</code> method, which does the actual work of appending the + event to the appropriate device. + </p> + + <p>DO WE ADD A UML DIAGRAM?? YES!!</p> + + <p>In appenders, the term option or property is reserved for named attributes + that are dynamically inferred using JavaBeans introspection. </p> + + <h2>Logback Core</h2> + + <h3>WriterAppender</h3> + + <p> + <code>WriterAppender</code> appends events to a <code>java.io.Writer</code>. + This class provides basic services that other appenders build upon. + Users do not usually instantiate <code>WriterAppender</code> objects directly. + Since <code>java.io.Writer</code> type cannot be mapped to a string, there is no + way to specify the target <code>Writer</code> object in a configuration script. + Simply put, you cannot configure a <code>WriterAppender</code> from a script. + However, this does not mean that <code>WriterAppender</code> lacks configurable options. + These options are described next. + </p> + + <table> + <tr> + <th>Option Name</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td><b><span class="option">Encoding</span></b></td> + <td><code>String</code></td> + <td> + The encoding specifies the method of conversion between 16-bit Unicode + characters into raw 8-bit bytes. This appender will use the local platform's + default encoding unless you specify otherwise using the + <span class="option">Encoding</span> option. + According to the <code>java.lang</code> package documentation, acceptable values + are dependent on the VM implementation although all implementations are + required to support at least the following encodings: + <em>US-ASCII</em>, <em>ISO-8859-1</em>, <em>UTF-8</em>, <em>UTF-16BE</em>, + <em>UTF-16LE</em> and <em>UTF-16</em>. + By default, the <span class="option">Encoding</span> option is null such + that the platform's default encoding is used. + </td> + </tr> + <tr> + <td><b><span class="option">ImmediateFlush</span></b></td> + <td><code>boolean</code></td> + <td> + If set to true, each write of a logging event is followed by a flush operation + on the underlying <code>Writer</code> object. Conversely, if the option is set to false, + each write will not be followed by a flush. + In general, skipping the flush operation improves logging throughput by roughly 15%. + The downside is that if the application exits abruptly, the unwritten characters + buffered inside the <code>Writer</code> might be lost. + This can be particularly troublesome as those unwritten characters may contain + crucial information needed in identifying the reasons behind a crash. + By default, the <span class="option">ImmediateFlush</span> option is set to true. + </td> + </tr> + </table> + + <p> + In general, if you disable immediate flushing, then make sure to flush + any output streams when your application exits. Otherwise, log messages + will be lost as illustrated by the next example. + </p> + + <em>Example 4.1: Exiting an application without flushing (logback-examples/src/main/java/chapter4/ + <a href="../xref/chapter4/ExitWoes.html">ExitWoes.java</a>)</em> +<div class="source"><pre>package chapter4; + +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.classic.LoggerContext; +import ch.qos.logback.core.WriterAppender; +import ch.qos.logback.core.layout.DummyLayout; + +public class ExitWoes { + + public static void main(String[] args) throws Exception { + LoggerContext lc = new LoggerContext(); + WriterAppender writerAppender = new WriterAppender(); + writerAppender.setContext(lc); + writerAppender.setLayout(new DummyLayout()); + + OutputStream os = new FileOutputStream("exitWoes1.log"); + writerAppender.setWriter(new OutputStreamWriter(os)); + writerAppender.setImmediateFlush(false); + writerAppender.start(); + + Logger logger = LoggerFactory.getLogger(ExitWoes1.class); + + logger.debug("Hello world."); + } +}</pre></div> + + <p> + This example creates a <code>WriterAppender</code> that uses an + <code>OutputStreamWriter</code> + wrapping a <code>FileOutputStream</code> as its underlying <code>Writer</code> object, + with immediate flushing disabled. It then proceeds to log a single debug message. + According to <code>OutputStreamWriter</code> javadocs, each invocation of a + <code>write()</code> + method causes the encoding converter to be invoked on the given character(s). + The resulting bytes are accumulated in a buffer before being written + to the underlying output stream. As astonishing as this may seem, + running <code>ExitWoes1</code> will not produce any output in the file + <em>exitWoes1.log</em> + because the Java VM does not flush output streams when it exits. + Calling the <code>shutdown()</code> method of a <b>XXXXXX</b> ensures that all + appenders in the hierarchy are closed and their buffers are flushed. + For most applications this is as simple as including the following statement + before exiting the application. + </p> + <p>WHAT TO DO IN LB ???</p> + + <p> + The <code>WriterAppender</code> is the super class of four other appenders, + namely <code>ConsoleAppender</code>, <code>FileAppender</code> which in turn is + the super class of <code>RollingFileAppender</code>. + </p> + <p><b>include UML??</b> + Figure 4 2 illustrates the class diagram for WriterAppender and its subclasses + </p> + + <h3>ConsoleAppender</h3> + + <p> + The <code>ConsoleAppender</code>, as the name indicates, appends on the console, + or more precisely on <em>System.out</em> or <em>System.err</em>, the former + being the default target. <code>ConsoleAppender</code> formats events with + a layout specified by the user. Both <em>System.out</em> and <em>System.err</em> + are <code>java.io.PrintStream</code> objects. + Consequently, they are wrapped inside an <code>OutputStreamWriter</code> + which buffers I/O operations but not character conversions. + </p> + + <table> + <tr> + <th>Option Name</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td><b><span class="option">Encoding</span></b></td> + <td><code>String</code></td> + <td>See <code>WriterAppender</code> options.</td> + </tr> + <tr> + <td><b><span class="option">ImmediateFlush</span></b></td> + <td><code>boolean</code></td> + <td>See <code>WriterAppender</code> options.</td> + </tr> + <tr> + <td><b><span class="option">Target</span></b></td> + <td><code>String</code></td> + <td> + One of the String values <em>System.out</em> or + <em>System.err</em>. The default target is <em>System.out</em>. + </td> + </tr> + </table> + + <h3>FileAppendery</h3> + + <p> + The <code>FileAppender</code>, a subclass of <code>WriterAppender</code>, + appends log events into a file. The file to write to is specified by + the <span class="option">File</span> option. + If the file already exists, it is either appended to, or truncated + depending on the value of the <span class="option">Append</span> option. + It uses a <code>FileOutputStream</code> which is wrapped by an <code>OutputStreamWriter</code>. + Note that <code>OutputStreamWriter</code> buffers I/O operations + but not character conversions. To optimize character conversions one + can set the <span class="option">BufferedIO</span> option to true + which effectively wraps the <code>OutputStreamWriter</code> with + a <code>BufferedWriter</code>. Options for <code>FileAppender</code> are summarized below. + </p> + + <table> + <tr> + <th>Option Name</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td><b><span class="option">Append</span></b></td> + <td><code>boolean</code></td> + <td>If true, events are appended at the end of an existing file. + Otherwise, if <span class="option">Append</span> is false, any existing + file is truncated. The <span class="option">Append</span> option is set to true by default.</td> + </tr> + <tr> + <td><b><span class="option">Encoding</span></b></td> + <td><code>String</code></td> + <td>See <code>WriterAppender</code> options.</td> + </tr> + <tr> + <td><b><span class="option">BufferedIO</span></b></td> + <td><code>boolean</code></td> + <td> + The <span class="option">BufferedIO</span> option is set to false by default. + If set to true, the underlying <code>OutputStreamWriter</code> is wrapped + by a <code>BufferedWriter</code> object. + Setting <span class="option">BufferedIO</span> to true automatically + sets the <span class="option">ImmediateFlush</span> option to false. + The name <span class="option">BufferedIO</span> is slightly misleading because + buffered IO is already supported by <code>OutputStreamWriter</code>. + Setting <span class="option">BufferedIO</span> to true has the effect of + buffering I/O as well as character to raw byte conversions, saving a few + CPU cycles in the process. + </td> + </tr> + <tr> + <td><b><span class="option">BufferSize</span></b></td> + <td><code>int</code></td> + <td>Size of <code>BufferedWriter</code> buffer. The default value is 8192.</td> + </tr> + <tr> + <td><b><span class="option">File</span></b></td> + <td><code>int</code></td> + <td> + The name of the file to write to. If the file does not exist, it is created. <br /> + On the MS Windows platform users frequently forget to escape back slashes. + For example, the value <em>c:\temp\test.log</em> is not likely to be interpreted + properly as <em>'\t'</em> is an escape sequence interpreted as a single + tab character <em>(\u0009)</em>. + Correct values can be specified as <em>c:/temp/test.log</em> or + alternatively as <em>c:\\temp\\test.log</em>. + The <span class="option">File</span> option has no default value. + </td> + </tr> + </table> + + <p> + By default, <code>FileAppender</code> performs a flush operation for + each event, ensuring that events are immediately written to disk. + Setting the <span class="option">ImmediateFlush</span> option to false can drastically reduce + I/O activity by letting <code>OutputStreamWriter</code> buffer bytes + before writing them on disk. For short messages, we have observed 2 or 3 + fold increases in logging throughput, i.e. the number of logs output + per unit of time. For longer messages, the throughput gains are somewhat + less dramatic, and range between 1.4 and 2 fold. Enabling the + <span class="option">BufferedIO</span> + option, that is buffering character to byte conversions, increases + performance by an additional 10% to 40% compared to only disk + I/O buffering (<span class="option">ImmediateFlush</span>=false). + Performance varies somewhat depending on the host machine as well as JDK version. + Throughput measurements are based on the <code>chapter4.IO</code> application. + Please refer to the file <em>logback-examples/src/main/java/chapter4/IO.java</em> + for actual source code. + <a href="../xref/chapter4/IO.html">Online viewing</a> + of this file is also available. + </p> + + <h2>Logback Classic</h2> + + <h2>Logback Access</h2> + + + + + + + + + + </body> +</document> Modified: logback/trunk/logback-skin/src/main/resources/css/site.css ============================================================================== --- logback/trunk/logback-skin/src/main/resources/css/site.css (original) +++ logback/trunk/logback-skin/src/main/resources/css/site.css Thu Nov 2 20:36:44 2006 @@ -360,4 +360,9 @@ .greenBold { color: green; font-weight: bold; +} + +.option { + border: 1px solid black; + font-family: Arial, sans-serif; } \ No newline at end of file

1 0

svn commit: r857 - logback/trunk/logback-site/src/site/xdocTemplates
by noreply.ceki＠qos.ch 02 Nov '06

02 Nov '06

Author: ceki Date: Thu Nov 2 20:27:55 2006 New Revision: 857 Removed: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Modified: logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Log: ongoing work on short intro Modified: logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Thu Nov 2 20:27:55 2006 @@ -51,15 +51,18 @@ Logback is intended as a successor to the popular log4j project. It was designed by Ceki Gülcü, the founder of the log4j project. It builds upon a decade long experience gained in - designing industrial-strength logging systems. The resulting product, - logback is faster with a smaller footprint than all + designing industrial-strength logging systems. The resulting + product, logback is faster with a smaller footprint than all existing logging systems, sometimes by a wide margin. Logback also offers unique and rather useful features such as Markers, parameterized logging statements, conditional stack tracing and - powerful event filtering, to cite a few. For its own error - reporting, logback relies on - <code>Status</code> - objects which you may wish to use in contexts other than logging. + powerful event filtering. These are only few examples of useful + features logback has to offer. For its own error reporting, + logback relies on <code>Status</code> objects, which greatly + facilitate troubleshooting. You may wish to rely on Status + objects in contexts other than logging. Logback-core bundles + Joran, a powerful and generic configutation system, which can be + put to use in your own projects for great effect. </p> <p> @@ -76,29 +79,52 @@ </p> <p> - The Core module lays the groundwork for the other two modules. - The Classic module extends Core. Classic can be assimilated to - an improved version of log4j. Logback Classic natively - implements the - <a href="http://www.slf4j.org">SLF4J API</a> - so that you can readily switch back and forth between logback - and other logging systems such as log4j or JDK14 Logging. The - Access module integrates with Servlet containers to provide - HTTP-access log functionality. The Access module will be covered - in a separate document. + The <em>core</em> module lays the groundwork for the other two + modules. The <em>classic</em> module extends <em>core</em>. The + classic module can be assimilated to a significantly improved + version of log4j. Logback-classic natively implements the <a + href="http://www.slf4j.org">SLF4J API</a> so that you can + readily switch back and forth between logback and other logging + systems such as log4j or JDK14 Logging. The third module called + <em>access</em> integrates with Servlet containers to provide + HTTP-access log functionality. The access module will be covered + in a <a href="access.html">separate document</a>. </p> <p> - In this document, we will use the term logback to refer to the + In this document, we will write "logback" to refer to the logback classic module. </p> <h2>First Baby Step</h2> - <p> - After you have added the jar files - <em>logback-core.jar</em>, <em>logback-classic.jar</em> and their dependencies - to your classpath, you can begin experimenting with logback. + <p>Logback-classic module requires the presence + <em>slf4j-api.jar</em>, <em>logback-core.jar</em> in addition to + <em>logback-classic.jar</em> on the classpath. + </p> + + <p>in order to falitate running the the examples in this document, + we have placed the required jar files in the + <em>logback-examples/lib</em> directory. Assuming your current + directory is $LOGBACK_HOME/logback-examples, where $LOGBACK_HOME + is the directory you've installed logback, you can start launch + the first example application, chapter1.HelloWord1 with the + following command: </p> + <div class="source"><pre> + java -cp lib/slf4j-api-1.1.0-beta0.jar;lib/logback-core-${version}.jar;lib/logback-classic-${version}.jar + </pre></div> + + +<h1>FIXME</h1> + + <p>Assuming the After you + have added the jar files <em>slf4j-api.jar</em>, + <em>logback-core.jar</em>, <em>logback-classic.jar</em> and their + dependencies to your classpath, you can begin experimenting with + logback. To + </p> + + <p>java -cp lib/logback-core-${version}.jar</p> <em>Example 1.1: Basic template for logging (logback-examples/src/main/java/chapter1/HelloWorld1.java)</em> <div class="source"><pre>package chapter1;

1 0

svn commit: r856 - logback/trunk/logback-site/src/site/xdocTemplates
by noreply.ceki＠qos.ch 02 Nov '06

02 Nov '06

Author: ceki Date: Thu Nov 2 20:27:33 2006 New Revision: 856 Added: logback/trunk/logback-site/src/site/xdocTemplates/access.xml - copied unchanged from r809, /logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Log: renaming files

1 0

[Bug 27] New: Joran doesn't configure string lists correctly.
by bugzilla-daemon＠pixie.qos.ch 02 Nov '06

02 Nov '06

http://bugzilla.qos.ch/show_bug.cgi?id=27 Summary: Joran doesn't configure string lists correctly. Product: logback-core Version: unspecified Platform: All OS/Version: All Status: NEW Severity: major Priority: P1 Component: Joran AssignedTo: logback-dev(a)qos.ch ReportedBy: noreply.sebastien(a)qos.ch Using the following configuration file: <configuration> <turboFilter class="ch.qos.logback.classic.turbo.DebugUsersTurboFilter"> <user>seb</user> <user>ceki</user> </turboFilter> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%d %level - %m%n</Pattern> </layout> </appender> <root> <level value="DEBUG" /> <appender-ref ref="CONSOLE" /> </root> </configuration> (named turbo2.xml, in classic/test/input/joran) Joran sees the two <user> elements, knows that their "containmentType" is COLLECTION but doesn't call the addUser method. Instead, it checks to see if a class attribute exists in the <user> elements, and since no such attribute is given, it reports an error such as: |-ERROR in ch.qos.logback.core.joran.action.NestedComponentIA - No class name attribute in <user> I guess that Joran has to learn that collection containmentType doesn't necessarily mean "component that requires a class attribute". Here, the value between the <user> elements is a String. I guess that inspecting the addUser method and discovering that the parameter type is a String would help. -- Configure bugmail: http://bugzilla.qos.ch/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the assignee for the bug, or are watching the assignee.

1 2

svn commit: r855 - in logback/trunk/logback-core/src: main/java/ch/qos/logback/core/joran/action main/java/ch/qos/logback/core/util test/input/joran test/java/ch/qos/logback/core/joran test/java/ch/qos/logback/core/joran/ia
by noreply.ceki＠qos.ch 02 Nov '06

02 Nov '06

Author: ceki Date: Thu Nov 2 20:06:37 2006 New Revision: 855 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java logback/trunk/logback-core/src/test/input/joran/simplePropertyIA1.xml logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/SimpleConfigurator.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/Fruit.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/FruitContextAction.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/SimplePropertyIATest.java Log: Fixed bug #27. Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java Thu Nov 2 20:06:37 2006 @@ -57,8 +57,6 @@ ContainmentType containmentType = parentBean.canContainComponent(nestedElementTagName); - System.out.println("==="+containmentType); - switch (containmentType) { case NOT_FOUND: case AS_SINGLE_COMPONENT: @@ -70,7 +68,7 @@ ImplicitActionData ad = new ImplicitActionData(parentBean, containmentType); ad.propertyName = nestedElementTagName; actionDataStack.push(ad); - //System.out.println("in NestedSimplePropertyIA deemed applicable <" + pattern + ">"); + addInfo("NestedSimplePropertyIA deemed applicable <" + pattern + ">"); return true; default: addError("PropertySetter.canContainComponent returned " + containmentType); @@ -89,9 +87,8 @@ //System.out.println("body "+body+", finalBody="+finalBody); // get the action data object pushed in isApplicable() method call ImplicitActionData actionData = (ImplicitActionData) actionDataStack.peek(); - switch (actionData.containmentType) { - case AS_SINGLE_COMPONENT: + case AS_SINGLE_PROPERTY: actionData.parentBean.setProperty(actionData.propertyName, finalBody); break; case AS_PROPERTY_COLLECTION: Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java Thu Nov 2 20:06:37 2006 @@ -113,8 +113,7 @@ name = Introspector.decapitalize(name); PropertyDescriptor prop = getPropertyDescriptor(name); - - // LogLog.debug("---------Key: "+name+", type="+prop.getPropertyType()); + if (prop == null) { addWarn("No such property [" + name + "] in " + objClass.getName() + "."); } else { @@ -287,8 +286,8 @@ } name = capitalizeFirstLetter(name); - Method adderMethod = getMethod("add" + name); + if (adderMethod == null) { addError("No adder for property [" + name + "]."); return; @@ -308,12 +307,12 @@ return; } + if (arg == null) { addError("Conversion to type [" + paramTypes[0] + "] failed."); } else { - try { - adderMethod.invoke(obj, new Object[] { arg }); + adderMethod.invoke(obj, arg); } catch (Exception ex) { addError("Failed to invoke adder for " + name, ex); } Modified: logback/trunk/logback-core/src/test/input/joran/simplePropertyIA1.xml ============================================================================== --- logback/trunk/logback-core/src/test/input/joran/simplePropertyIA1.xml (original) +++ logback/trunk/logback-core/src/test/input/joran/simplePropertyIA1.xml Thu Nov 2 20:06:37 2006 @@ -4,5 +4,6 @@ <fruit class="ch.qos.logback.core.joran.ia.Fruit"> <name>blue</name> <text>hello</text> + <text>world</text> </fruit> </context> \ No newline at end of file Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/SimpleConfigurator.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/SimpleConfigurator.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/SimpleConfigurator.java Thu Nov 2 20:06:37 2006 @@ -34,7 +34,7 @@ interpreter.addImplicitAction(nestedIA); NestedSimplePropertyIA nestedSimpleIA = new NestedSimplePropertyIA(); - nestedIA.setContext(context); + nestedSimpleIA.setContext(context); interpreter.addImplicitAction(nestedSimpleIA); } @@ -42,7 +42,6 @@ protected void addInstanceRules(RuleStore rs) { for(Pattern pattern : rulesMap.keySet()) { Action action = rulesMap.get(pattern); - System.out.println("Adding "+pattern +" "+action); rs.addRule(pattern, action); } } Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/Fruit.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/Fruit.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/Fruit.java Thu Nov 2 20:06:37 2006 @@ -9,11 +9,10 @@ List<String> textList = new ArrayList<String>(); public Fruit() { - System.out.println("Fruit constructor called"); } - public void setName(String name) { - this.name = name; + public void setName(String n) { + this.name = n; } public String getName() { Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/FruitContextAction.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/FruitContextAction.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/FruitContextAction.java Thu Nov 2 20:06:37 2006 @@ -25,7 +25,6 @@ public void begin(InterpretationContext ec, String name, Attributes attributes) throws ActionException { - inError = false; try { Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/SimplePropertyIATest.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/SimplePropertyIATest.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/ia/SimplePropertyIATest.java Thu Nov 2 20:06:37 2006 @@ -44,7 +44,9 @@ Fruit f0 = fList.get(0); assertEquals("blue", f0.getName()); - assertEquals(1, f0.textList.size()); + assertEquals(2, f0.textList.size()); + assertEquals("hello", f0.textList.get(0)); + assertEquals("world", f0.textList.get(1)); } catch (Exception je) { StatusPrinter.print(fruitContext); throw je;

1 0