This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Logback: the generic, reliable, fast and flexible logging framework.". The branch, master has been updated via 22126c5c13088502dc0b5c9c7dda4218ac3c8978 (commit) from 0a2446b85f3ba811d9cbd153f3e591ca44ea4e0f (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=logback.git;a=commit;h=22126c5c13088502dc0b5c9c7... http://github.com/ceki/logback/commit/22126c5c13088502dc0b5c9c7dda4218ac3c89... commit 22126c5c13088502dc0b5c9c7dda4218ac3c8978 Author: Ceki Gulcu <ceki@qos.ch> Date: Thu May 3 18:38:10 2012 +0200 outputPatternAsPresentationHeader renamed as outputPatternAsHeader and is now false by default diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/BasicConfigurator.java b/logback-classic/src/main/java/ch/qos/logback/classic/BasicConfigurator.java index 6890b9e..8c8de83 100644 --- a/logback-classic/src/main/java/ch/qos/logback/classic/BasicConfigurator.java +++ b/logback-classic/src/main/java/ch/qos/logback/classic/BasicConfigurator.java @@ -46,7 +46,6 @@ public class BasicConfigurator { ca.setName("console"); PatternLayoutEncoder pl = new PatternLayoutEncoder(); pl.setContext(lc); - pl.setOutputPatternAsPresentationHeader(false); pl.setPattern("%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"); pl.start(); diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/encoder/PatternLayoutEncoder.java b/logback-classic/src/main/java/ch/qos/logback/classic/encoder/PatternLayoutEncoder.java index 5bf4705..9e9782e 100644 --- a/logback-classic/src/main/java/ch/qos/logback/classic/encoder/PatternLayoutEncoder.java +++ b/logback-classic/src/main/java/ch/qos/logback/classic/encoder/PatternLayoutEncoder.java @@ -24,7 +24,7 @@ public class PatternLayoutEncoder extends PatternLayoutEncoderBase<ILoggingEvent PatternLayout patternLayout = new PatternLayout(); patternLayout.setContext(context); patternLayout.setPattern(getPattern()); - patternLayout.setOutputPatternAsPresentationHeader(outputPatternAsPresentationHeader); + patternLayout.setOutputPatternAsHeader(outputPatternAsHeader); patternLayout.start(); this.layout = patternLayout; super.start(); diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/jul/LevelChangePropagator.java b/logback-classic/src/main/java/ch/qos/logback/classic/jul/LevelChangePropagator.java index 3f8cb7d..2c90cec 100644 --- a/logback-classic/src/main/java/ch/qos/logback/classic/jul/LevelChangePropagator.java +++ b/logback-classic/src/main/java/ch/qos/logback/classic/jul/LevelChangePropagator.java @@ -60,7 +60,7 @@ public class LevelChangePropagator extends ContextAwareBase implements LoggerCon private void propagate(Logger logger, Level level) { addInfo("Propagating " + level + " level on " + logger + " onto the JUL framework"); java.util.logging.Logger julLogger = JULHelper.asJULLogger(logger); - // prevent garbage collection of jul loggers levels were propagated to + // prevent garbage collection of jul loggers whose level we set // see also http://jira.qos.ch/browse/LBCLASSIC-256 julLoggerSet.add(julLogger); java.util.logging.Level julLevel = JULHelper.asJULLevel(level); diff --git a/logback-classic/src/test/java/ch/qos/logback/classic/encoder/PatternLayoutEncoderTest.java b/logback-classic/src/test/java/ch/qos/logback/classic/encoder/PatternLayoutEncoderTest.java index bab8c26..6def85c 100644 --- a/logback-classic/src/test/java/ch/qos/logback/classic/encoder/PatternLayoutEncoderTest.java +++ b/logback-classic/src/test/java/ch/qos/logback/classic/encoder/PatternLayoutEncoderTest.java @@ -59,7 +59,7 @@ public class PatternLayoutEncoderTest { void init(ByteArrayOutputStream baos) throws IOException { ple.start(); - ((PatternLayout) ple.getLayout()).setOutputPatternAsPresentationHeader(false); + ((PatternLayout) ple.getLayout()).setOutputPatternAsHeader(false); ple.init(baos); } diff --git a/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/PerformanceComparatorLogback.java b/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/PerformanceComparatorLogback.java index aacc7c6..223584c 100644 --- a/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/PerformanceComparatorLogback.java +++ b/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/PerformanceComparatorLogback.java @@ -1,12 +1,5 @@ package ch.qos.logback.classic.issue.lbcore243; -/** - * Created with IntelliJ IDEA. - * User: ceki - * Date: 26.04.12 - * Time: 21:52 - * To change this template use File | Settings | File Templates. - */ import ch.qos.logback.classic.LoggerContext; import ch.qos.logback.classic.joran.JoranConfigurator; diff --git a/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/logback_without_immediateFlush.xml b/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/logback_without_immediateFlush.xml index 3d4f49e..b69f357 100644 --- a/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/logback_without_immediateFlush.xml +++ b/logback-classic/src/test/java/ch/qos/logback/classic/issue/lbcore243/logback_without_immediateFlush.xml @@ -12,7 +12,8 @@ <encoder> <Pattern>%d{ISO8601} %5p [%t] %c - %m%n</Pattern> <immediateFlush>false</immediateFlush> - <!--<charset>UTF-8</charset>--> + <outputPatternAsHeader>true</outputPatternAsHeader> + <charset>UTF-8</charset> </encoder> </appender> <root> diff --git a/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppender_GreenTest.java b/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppender_GreenTest.java index 71a15b8..8ebd4de 100644 --- a/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppender_GreenTest.java +++ b/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppender_GreenTest.java @@ -90,7 +90,7 @@ public class SMTPAppender_GreenTest { PatternLayout layout = new PatternLayout(); layout.setContext(lc); layout.setFileHeader(HEADER); - layout.setOutputPatternAsPresentationHeader(false); + layout.setOutputPatternAsHeader(false); layout.setPattern("%-4relative %mdc [%thread] %-5level %class - %msg%n"); layout.setFileFooter(FOOTER); layout.start(); diff --git a/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java b/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java index fa5cfab..3fe2ad8 100644 --- a/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java +++ b/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java @@ -34,7 +34,7 @@ abstract public class PatternLayoutBase<E> extends LayoutBase<E> { Map<String, String> instanceConverterMap = new HashMap<String, String>(); - protected boolean outputPatternAsHeader = true; + protected boolean outputPatternAsHeader = false; /** * Concrete implementations of this class are responsible for elaborating the diff --git a/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutEncoderBase.java b/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutEncoderBase.java index a094dcc..628afa1 100644 --- a/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutEncoderBase.java +++ b/logback-core/src/main/java/ch/qos/logback/core/pattern/PatternLayoutEncoderBase.java @@ -55,7 +55,7 @@ public class PatternLayoutEncoderBase<E> extends LayoutWrappingEncoder<E> { * @deprecated replaced by {@link #setOutputPatternAsHeader(boolean)} */ public void setOutputPatternAsPresentationHeader(boolean outputPatternAsHeader) { - addWarn("outputPatternAsPresentationHeader option is deprecated. Use outputPatternAsHeader option instead."); + addWarn("[outputPatternAsPresentationHeader] property is deprecated. Please use [outputPatternAsHeader] option instead."); this.outputPatternAsHeader = outputPatternAsHeader; } diff --git a/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java b/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java index ce730de..d33e8c0 100644 --- a/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java +++ b/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java @@ -29,7 +29,6 @@ public class SamplePatternLayout<E> extends PatternLayoutBase<E> { public SamplePatternLayout() { converterMap.put("OTT", Converter123.class.getName()); converterMap.put("hello", ConverterHello.class.getName()); - outputPatternAsPresentationHeader = false; } public Map<String, String> getDefaultConverterMap() { diff --git a/logback-site/src/site/pages/manual/appenders.html b/logback-site/src/site/pages/manual/appenders.html index de31c49..3574056 100644 --- a/logback-site/src/site/pages/manual/appenders.html +++ b/logback-site/src/site/pages/manual/appenders.html @@ -377,7 +377,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl a file. The target file is specified by the <span class="prop">File</span> option. If the file already exists, it is either appended to, or truncated depending on the value of the - <span class="prop">Append</span> option. + <span class="prop">append</span> property. </p> <table class="bodyTable properties striped"> @@ -390,10 +390,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <td><b><span class="prop">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="prop">Append</span> is - false, any existing file is truncated. The <span - class="prop">Append</span> option is set to true by - default. + file. Otherwise, if <span class="prop">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 > @@ -472,6 +471,15 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl </tr> </table> + <p><span class="label notice">Immediate Flush</span> By default, + each log event is immediately flushed to the underlying output + stream. For significantly increased logging throughput, you may + want to set the <span class="prop">immediateFlush</span> property + to <code>false</code> of the underlying encoder. Encoders and in + particular <a + href="encoders.html#LayoutWrappingEncoder"><code>LayoutWrappingEncoder</code></a> + are described in a separate chapter.</p> + <p>Below is an example of a configuration file for <code>FileAppender</code>: </p> diff --git a/logback-site/src/site/pages/manual/encoders.html b/logback-site/src/site/pages/manual/encoders.html index 5e95765..6de5b7b 100644 --- a/logback-site/src/site/pages/manual/encoders.html +++ b/logback-site/src/site/pages/manual/encoders.html @@ -142,11 +142,13 @@ public class LayoutWrappingEncoder<E> extends EncoderBase<E> { protected Layout<E> layout; private Charset charset; + private boolean immediateFlush = true; public void doEncode(E event) throws IOException { String txt = layout.doLayout(event); outputStream.write(convertToBytes(txt)); - outputStream.flush(); + if (immediateFlush) + outputStream.flush(); } private byte[] convertToBytes(String s) { @@ -162,10 +164,15 @@ public class LayoutWrappingEncoder<E> extends EncoderBase<E> { layout convert the incoming event into string. The resulting text string is converted to bytes according to the charset encoding chosen by the user. Those bytes are then written to the - <code>OutputStream</code> given by the owning appender and the - <code>OutputStream</code> is immediately flushed. + <code>OutputStream</code> given by the owning appender. By + default, the <code>OutputStream</code> is immediately flushed, + unless the <span class="prop">immediateFlush</span> property is + explicitly set to false. Setting the <span + class="prop">immediateFlush</span> property to false can + significantly improve logging throughput. See + <code>PatternLayoutEncoder</code> below for example. </p> - + <h2><a name="PatternLayoutEncoder" href="#PatternLayoutEncoder">PatternLayoutEncoder</a></h2> @@ -186,9 +193,61 @@ public class LayoutWrappingEncoder<E> extends EncoderBase<E> { logback error codes</a>. </p> + <h4><a name="outputPatternAsHeader" href="#outputPatternAsHeader">Output pattern string as header</a></h4> + + <p>In order to facilitate parsing of log files, logback can insert + the pattern used for the log output at the top of log files. This + feature is <b>disabled</b> by default. It can be enabled by + setting the <span class="prop">outputPatternAsHeader</span> + property to 'true' for relevant + <code>PatternLayoutEncoder</code>. Here is an example:</p> + +<pre class="prettyprint"><appender name="FILE" class="ch.qos.logback.core.FileAppender"> + <file>foo.log</file> + <encoder> + <pattern>%d %-5level [%thread] %logger{0}: %msg%n</pattern> + <b><outputPatternAsHeader>true</outputPatternAsHeader></b> + </encoder> +</appender></pre> + + <p>This will result output akin to the following in the log file:</p> + + <pre>#logback.classic pattern: %d [%thread] %-5level %logger{36} - %msg%n +2012-04-26 14:54:38,461 [main] DEBUG com.foo.App - Hello world +2012-04-26 14:54:38,461 [main] DEBUG com.foo.App - Hi again +...</pre> + + <p>The line starting with "#logback.classic pattern" is newly + inserted pattern line.</p> + + <h4><span class="prop">immediateFlush</span> property</h4> + + <p>As a sub-class of <a + href="../xref/ch/qos/logback/core/encoder/LayoutWrappingEncoder.html"><code>LayoutWrappingEncoder</code></a>, + <code>PatternLayoutEncoder</code> admits the <span + class="prop">immediateFlush</span> property. The default value + for <span class="prop">immediateFlush</span> is 'false'. However, + by setting this property to 'false', logging throughput can be + quadrupled although your mileage may vary. + </p> + + <p>Below is a sample configuration for a + <code>FileAppender</code> containing a + <code>PatternLayoutEncoder</code> with its <span + class="prop">immediateFlush</span> property set to 'false'.</p> +<pre class="prettyprint"><appender name="FILE" class="ch.qos.logback.core.FileAppender"> + <file>foo.log</file> + <encoder> + <pattern>%d %-5level [%thread] %logger{0}: %msg%n</pattern> + <!-- this quadruples logging throughput --> + <b><immediateFlush>false</immediateFlush></b> + </encoder> +</appender></pre> + + - <script src="../templates/footer.js" type="text/javascript"></script> + <script src="../templates/footer.js" type="text/javascript"></script> </div> </body> diff --git a/logback-site/src/site/pages/news.html b/logback-site/src/site/pages/news.html index 26126fe..70c8002 100644 --- a/logback-site/src/site/pages/news.html +++ b/logback-site/src/site/pages/news.html @@ -32,41 +32,30 @@ <h3>3rd of May, 2012 - Release of version 1.0.3</h3> - <p><code>PatternLayoutEncoder</code> now admits the <span - class="option">immediateFlush</span> option (set to true by - default). By setting this option to false, logging throughput can - be quadrupled, although your mileage may vary. This option was - requested in <a + <p><code>PatternLayoutEncoder</code> class now admits the <span + class="prop"><a + href="manual/encoders.html#LayoutWrappingEncoder">immediateFlush</a></span> + property (set to true by default). By setting this property to + 'false', logging throughput can be quadrupled, although your + mileage may vary. This enhancement was requested in <a href="http://jira.qos.ch/browse/LBCORE-243">LBCORE-243</a>. </p> - <p>In order to facilitate parsing of log files, logback can now - insert the pattern used for the log output at the top of log - files. This feature was requested by James Strachan in <a + <p>In order to facilitate parsing of log files, logback can now <a + href="manual/encoders.html#outputPatternAsHeader">output the + pattern</a> used for the log output at the top of log files as a + header. This feature was requested by James Strachan in <a href="http://jira.qos.ch/browse/LBCORE-234">LBCORE-234</a>. - However, this feature is <b>not</b> enabled by default. It can be - enabled by setting the <span - class="option">outputPatternAsHeader</span> option to 'true' for - the relevant encoder. Here is an example:</p> + </p> -<pre class="prettyprint"><appender name="FILE" class="ch.qos.logback.core.FileAppender"> - <file>foo.log</file> - <encoder> - <pattern>%d %-5level [%thread] %logger{0}: %msg%n</pattern> - <b><outputPatternAsHeader>true</outputPatternAsHeader></b> - </encoder> -</appender></pre> + <p><code>LevelChangePropagator</code> now retains references to + j.u.l. loggers whose level it sets. This fixes garbage collection + issues reported in <a + href="http://jira.qos.ch/browse/LBCLASSIC-256">LBCLASSIC-256</a> + by Samuel Stanojevic who also provided the appropriate patch. + </p> - <p>This will result output akin to the following in the log file:</p> - - <pre>#logback.classic pattern: %d [%thread] %-5level %logger{36} - %msg%n -2012-04-26 14:54:38,461 [main] DEBUG com.foo.App - Hello world -2012-04-26 14:54:38,461 [main] DEBUG com.foo.App - Hi again -...</pre> - - <p>The line starting with "#logback.classic pattern" is newly - inserted pattern line.</p> <h3>26th of April, 2012 - Release of version 1.0.2</h3> @@ -77,7 +66,7 @@ its pattern at the top of log files</h4> <p>This feature, although still available, is no longer enabled by - default. See release 1.0.3 for details. + default. See release notes for version 1.0.3 for details. </p> @@ -119,7 +108,7 @@ </p> <p>Added new property the <span - class="option">cleanHistoryOnStart</span> to <a + class="prop">cleanHistoryOnStart</span> to <a href="manual/appenders.html#TimeBasedRollingPolicy">TimeBasedRollingPolicy</a>. By setting this property to <code>true</code>, history removal will work as expected even in the case of short lived @@ -237,8 +226,6 @@ Pierre Queinnec. </p> - - <h3>September 21st, 2011 - Release of version 0.9.30</h3> <p>Archive removal can now deal with prolonged periods of @@ -281,15 +268,15 @@ reported by Josh Oddman.</p> <p>It is now possible to specify multiple destination addresses - separated by commas in the the <span class="option">to</span> + separated by commas in the the <span class="prop">to</span> property of <code>SMTPAppender</code>. This fixes <a href="http://jira.qos.ch/browse/LBCORE-213">LBCORE-213</a> reported by Alexandre Garnier who also provided the relevant patch. In previous versions of logback multiple destination addresses could only be specified by using multiple <span - class="option">to</span> properties. As of version 0.9.30 both + class="prop">to</span> properties. As of version 0.9.30 both comma separated addresses and multiple <span - class="option">to</span> properties are supported. + class="prop">to</span> properties are supported. </p> <p>When debug attribute is set to true within the @@ -420,7 +407,7 @@ </p> <p>The <a href="manual/appenders.html#smtpTo"><span - class="option">to</span></a> option of SMTPAppender now admits a + class="prop">to</span></a> option of SMTPAppender now admits a pattern and is evaluated dynamically.</p> <p><code>TeeServletInputStream</code> no longer chokes on input @@ -740,7 +727,7 @@ ALTER TABLE logging_event ADD arg3 VARCHAR(254);</pre> special. </p> - <p>The <span class="option">CharsetEncoder</span> property in + <p>The <span class="prop">CharsetEncoder</span> property in <code>SMTPAppender</code> can now be accessed and set from configuration files. This fixes <a href="http://jira.qos.ch/browse/LBCLASSIC-194">LBCLASSIC-194</a>. diff --git a/logback-site/src/site/pages/templates/header.js b/logback-site/src/site/pages/templates/header.js index 96a6a46..6bfd5f4 100644 --- a/logback-site/src/site/pages/templates/header.js +++ b/logback-site/src/site/pages/templates/header.js @@ -5,7 +5,7 @@ document.write('</a></td>') document.write('<td> </td>'); -document.write('<td width=70%"><span style="font-weight: bold; font-size: medium; background-color: #FFDDDD">Due to an error, <a href="http://repo1.maven.org/maven2/ch/qos/logback/logback-classic/maven-metadata.xml">metadata</a> for logback on Maven central only mentions version 1.0.2. As such such, "mvn" can no longer fetch earlier versions of logback from Maven central. Until this issue is resolved, one simple workaround is to upgrade to logback 1.0.2 in your project' pom.xml file. Please also vote for <a href="https://issues.sonatype.org/browse/OSSRH-3437">OSSRH-3437</a>.</span></td>'); +document.write('<td width="70%" style="padding-right: 10em;"><span style="font-weight: bold; font-size: medium; background-color: #FFF8E8; ">Due to an error, <a href="http://repo1.maven.org/maven2/ch/qos/logback/logback-classic/maven-metadata.xml">metadata</a> for logback on Maven central only mentions versions 1.0.2 and 1.0.3. It follows that "mvn" can no longer fetch earlier versions of logback artifacts from Maven central. Until this issue is resolved, one simple workaround is to upgrade your project's <em>pom.xml</em> file to use logback version 1.0.3 (or 1.0.2). Please also vote for <a href="https://issues.sonatype.org/browse/OSSRH-3437">OSSRH-3437</a>.</span></td>'); document.write('</tr></table>') ----------------------------------------------------------------------- Summary of changes: .../ch/qos/logback/classic/BasicConfigurator.java | 1 - .../classic/encoder/PatternLayoutEncoder.java | 2 +- .../logback/classic/jul/LevelChangePropagator.java | 2 +- .../classic/encoder/PatternLayoutEncoderTest.java | 2 +- .../lbcore243/PerformanceComparatorLogback.java | 7 -- .../lbcore243/logback_without_immediateFlush.xml | 3 +- .../classic/net/SMTPAppender_GreenTest.java | 2 +- .../logback/core/pattern/PatternLayoutBase.java | 2 +- .../core/pattern/PatternLayoutEncoderBase.java | 2 +- .../core/pattern/parser/SamplePatternLayout.java | 1 - logback-site/src/site/pages/manual/appenders.html | 18 ++++-- logback-site/src/site/pages/manual/encoders.html | 69 ++++++++++++++++++-- logback-site/src/site/pages/news.html | 61 +++++++----------- logback-site/src/site/pages/templates/header.js | 2 +- 14 files changed, 110 insertions(+), 64 deletions(-) hooks/post-receive -- Logback: the generic, reliable, fast and flexible logging framework.