March 2010 - logback-dev - mailman3.qos.ch

[JIRA] Created: (LBCLASSIC-190) Allow programmatic traversal of the logger tree
by Robert Elliot (JIRA) 08 Mar '10

08 Mar '10

Allow programmatic traversal of the logger tree ----------------------------------------------- Key: LBCLASSIC-190 URL: http://jira.qos.ch/browse/LBCLASSIC-190 Project: logback-classic Issue Type: Improvement Components: Other Affects Versions: 0.9.19 Reporter: Robert Elliot Assignee: Logback dev list I'm interested in writing a module for logback to allow on the fly changes to the logger tree - changing levels, adding appenders, maybe adding filters with code supplied dynamically. My vision for the gui is to show the logger tree like a folder tree. However, now I come to look at it it seems neither the child loggers nor the parent logger of a logger are exposed, which rather blows this whole concept out of the water. Is there a particularly strong reason for this? If not, I've forked logback here: http://github.com/Mahoney/logback and exposed the data. As part of the same thing I changed the children from a List to a Set as it seems more semantically correct and cleans up the code slightly. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

2 3

[JIRA] Created: (CONSPLUG-23) double-click on console log message doesn't open editor when message came from an inner class
by Joe Kearney (JIRA) 08 Mar '10

08 Mar '10

double-click on console log message doesn't open editor when message came from an inner class --------------------------------------------------------------------------------------------- Key: CONSPLUG-23 URL: http://jira.qos.ch/browse/CONSPLUG-23 Project: Console Plugin Issue Type: Bug Environment: Eclipse 3.5.2, Logback console 1.1.0, logback 0.9.0, slf4j 1.5.11 Reporter: Joe Kearney Assignee: Logback dev list Example below. All three log messages are logged, but only the first goes to the log statement on double click. {code:title=Scratch.java} package logback.console.bug.demo; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class Scratch { private static final Logger LOGGER = LoggerFactory.getLogger(Scratch.class.getName()); public static void main(String[] args) { LOGGER.info("hello from main()"); new InnerClass().someMethod(); } private static class InnerClass { private static final Logger LOCAL_LOGGER = LoggerFactory.getLogger(Scratch.InnerClass.class.getName()); public void someMethod() { LOGGER.info("Hello from inner class through outer logger"); LOCAL_LOGGER.info("Hello from inner class through inner logger"); } } } {code} -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 0

[JIRA] Created: (LBSITE-39) Review the logack-demo chapter
by Ceki Gulcu (JIRA) 08 Mar '10

08 Mar '10

Review the logack-demo chapter ------------------------------ Key: LBSITE-39 URL: http://jira.qos.ch/browse/LBSITE-39 Project: logback-site Issue Type: Task Reporter: Ceki Gulcu Assignee: Logback dev list -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 0

[JIRA] Created: (CONSPLUG-22) autocomplete in filter creation dialog
by Joe Kearney (JIRA) 08 Mar '10

08 Mar '10

autocomplete in filter creation dialog -------------------------------------- Key: CONSPLUG-22 URL: http://jira.qos.ch/browse/CONSPLUG-22 Project: Console Plugin Issue Type: New Feature Components: interface Reporter: Joe Kearney Assignee: Logback dev list Priority: Minor It would very useful to be able to use autocomplete in creating filter expressions. This would mean a user doesn't need to know the logback API. Could perhaps present the built-in variables (documentation page talks about "level, logger, message, and several others") initially. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 0

[JIRA] Created: (CONSPLUG-21) filtering by logger name is disallowed by filter entry dialog
by Joe Kearney (JIRA) 08 Mar '10

08 Mar '10

filtering by logger name is disallowed by filter entry dialog ------------------------------------------------------------- Key: CONSPLUG-21 URL: http://jira.qos.ch/browse/CONSPLUG-21 Project: Console Plugin Issue Type: Bug Environment: Eclipse 3.5.2, console plugin 1.1 Reporter: Joe Kearney Assignee: Logback dev list Filtering by logger name doesn't appear to work. Dialog says "The new expression is not correct." for a number of filter expressions that seem correctly formed. Example use case: I'm trying to filter to accept DEBUG messages from my code, but deny such messages from Spring, whose loggers are called "org.springframework...". Example reproduction: I try the following and keep getting "The new expression is not correct." There is no error in the Eclipse error log or in the console. logger.contains("org.springframework") event.getLoggerName().contains("org.springframework") (Guessing types of these supplied variables from http://logback.qos.ch/manual/filters.html#evalutatorFilter.) Filtering on the message appears to be accepted by the config window: message.contains("org.springframework") but it doesn't apply any filtering to the logger name. (Here the logger name actually gets compacted to "o.s...." but trying other, non-compacted, segments of the name doesn't help either.) I assume that this is intended behaviour. For now I can filter out things like "reating instance" or "bean", but that's hardly satisfactory. Some more examples in the plugin documentation would be mighty handy. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 0

[JIRA] Commented: (LBCLASSIC-57) SyslogAppender fails sporadically
by Ceki Gulcu (JIRA) 08 Mar '10

08 Mar '10

[ http://jira.qos.ch/browse/LBCLASSIC-57?page=com.atlassian.jira.plugin.syste… ] Ceki Gulcu commented on LBCLASSIC-57: ------------------------------------- The bug has been fixed by SyslogAppender truncating messages longer than 256Kbytes. > SyslogAppender fails sporadically > --------------------------------- > > Key: LBCLASSIC-57 > URL: http://jira.qos.ch/browse/LBCLASSIC-57 > Project: logback-classic > Issue Type: Bug > Environment: $ uname -a > Linux ... 2.6.9-67.ELsmp #1 SMP Wed Nov 7 13:56:44 EST 2007 x86_64 x86_64 x86_64 GNU/Linux > $ java -version > java version "1.6.0_03" > Java(TM) SE Runtime Environment (build 1.6.0_03-b05) > Java HotSpot(TM) Server VM (build 1.6.0_03-b05, mixed mode) > multiprocessor PC box > Reporter: Anton Tagunov > Assignee: Logback dev list > Fix For: 0.9.12 > > > * several JVM-s per Linux box > * 5 SyslogAppender-s logging to syslog-ng on 127.0.0.1 > Once in a while one of the SyslogAppender-s (the busiest one with longest messages) stops logging completely > Other SyslogAppender-ss continue working fine. > /usr/sbin/tcpdump has confirmed upd packets reach > syslog-ng port via 'lo' network interface for remaining appends > /usr/sbin/tcpdump has confirmed NO udp packets reach > syslog-ng port via 'lo' network interface for the failing appender > We have JMX enabled. JConsole does show StatusManager messages. > There are no error messages there. > Just the messages emitted during initial logback configuration > from logback.xml on the classpath. > We had invoked 'reload()' method via JMX. > StatusMananger messages observed via JMX show that reload had happened. > Full re-configuration had happened. > All 5 SyslogAppenders had been apparently re-created. > Yet NO udp messages had come from the SyslogAppender > replacing those which had previously failed. > Reloading did not help at all. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 0

[JIRA] Commented: (LBCLASSIC-57) SyslogAppender fails sporadically
by Ingo Siebert (JIRA) 08 Mar '10

08 Mar '10

[ http://jira.qos.ch/browse/LBCLASSIC-57?page=com.atlassian.jira.plugin.syste… ] Ingo Siebert commented on LBCLASSIC-57: --------------------------------------- If I understand it right, then this bug had never been fixed. Why is this closed then? It also occurs with JDK5. > SyslogAppender fails sporadically > --------------------------------- > > Key: LBCLASSIC-57 > URL: http://jira.qos.ch/browse/LBCLASSIC-57 > Project: logback-classic > Issue Type: Bug > Environment: $ uname -a > Linux ... 2.6.9-67.ELsmp #1 SMP Wed Nov 7 13:56:44 EST 2007 x86_64 x86_64 x86_64 GNU/Linux > $ java -version > java version "1.6.0_03" > Java(TM) SE Runtime Environment (build 1.6.0_03-b05) > Java HotSpot(TM) Server VM (build 1.6.0_03-b05, mixed mode) > multiprocessor PC box > Reporter: Anton Tagunov > Assignee: Logback dev list > Fix For: 0.9.12 > > > * several JVM-s per Linux box > * 5 SyslogAppender-s logging to syslog-ng on 127.0.0.1 > Once in a while one of the SyslogAppender-s (the busiest one with longest messages) stops logging completely > Other SyslogAppender-ss continue working fine. > /usr/sbin/tcpdump has confirmed upd packets reach > syslog-ng port via 'lo' network interface for remaining appends > /usr/sbin/tcpdump has confirmed NO udp packets reach > syslog-ng port via 'lo' network interface for the failing appender > We have JMX enabled. JConsole does show StatusManager messages. > There are no error messages there. > Just the messages emitted during initial logback configuration > from logback.xml on the classpath. > We had invoked 'reload()' method via JMX. > StatusMananger messages observed via JMX show that reload had happened. > Full re-configuration had happened. > All 5 SyslogAppenders had been apparently re-created. > Yet NO udp messages had come from the SyslogAppender > replacing those which had previously failed. > Reloading did not help at all. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 0

[GIT] Logback: the generic, reliable, fast and flexible logging framework. branch, master, updated. v0.9.18-68-g9a9462c
by git-noreply＠pixie.qos.ch 05 Mar '10

05 Mar '10

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 9a9462cf0af145a7c80fc655ff8298416393b3bd (commit) from a9729dc84972f7c16fd4b857d9c2b6372d9f4158 (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=9a9462cf0af145a7c80fc655… http://github.com/ceki/logback/commit/9a9462cf0af145a7c80fc655ff8298416393b… commit 9a9462cf0af145a7c80fc655ff8298416393b3bd Author: Ceki Gulcu <ceki(a)qos.ch> Date: Sat Mar 6 00:16:39 2010 +0100 editing the manual diff --git a/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java b/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java index abbe4f6..ae25ca0 100644 --- a/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java +++ b/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java @@ -50,10 +50,16 @@ public abstract class Action extends ContextAwareBase { * Called when the parser encounters an element matching a * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. */ - public abstract void begin(InterpretationContext ec, String name, + public abstract void begin(InterpretationContext ic, String name, Attributes attributes) throws ActionException; - public void body(InterpretationContext ec, String body) + /** + * Called to pass the body (as text) contained within an element. + * @param ic + * @param body + * @throws ActionException + */ + public void body(InterpretationContext ic, String body) throws ActionException { // NOP } @@ -62,34 +68,34 @@ public abstract class Action extends ContextAwareBase { * Called when the parser encounters an endElement event matching a * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. */ - public abstract void end(InterpretationContext ec, String name) + public abstract void end(InterpretationContext ic, String name) throws ActionException; public String toString() { return this.getClass().getName(); } - protected int getColumnNumber(InterpretationContext ec) { - Interpreter jp = ec.getJoranInterpreter(); - Locator locator = jp.getLocator(); + protected int getColumnNumber(InterpretationContext ic) { + Interpreter ji = ic.getJoranInterpreter(); + Locator locator = ji.getLocator(); if (locator != null) { return locator.getColumnNumber(); } return -1; } - protected int getLineNumber(InterpretationContext ec) { - Interpreter jp = ec.getJoranInterpreter(); - Locator locator = jp.getLocator(); + protected int getLineNumber(InterpretationContext ic) { + Interpreter ji = ic.getJoranInterpreter(); + Locator locator = ji.getLocator(); if (locator != null) { return locator.getLineNumber(); } return -1; } - protected String getLineColStr(InterpretationContext ec) { - String line = "line: " + getLineNumber(ec) + ", column: " - + getColumnNumber(ec); + protected String getLineColStr(InterpretationContext ic) { + String line = "line: " + getLineNumber(ic) + ", column: " + + getColumnNumber(ic); return line; } } diff --git a/logback-site/src/site/pages/manual/encoders.html b/logback-site/src/site/pages/manual/encoders.html new file mode 100644 index 0000000..9b2ccad --- /dev/null +++ b/logback-site/src/site/pages/manual/encoders.html @@ -0,0 +1,29 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> + <title>Chapter 4: Appenders</title> + <link rel="stylesheet" type="text/css" href="../css/common.css" /> + <link rel="stylesheet" type="text/css" href="../css/screen.css" media="screen" /> + <link rel="stylesheet" type="text/css" href="../css/_print.css" media="print" /> + <link rel="stylesheet" type="text/css" href="../css/prettify.css" media="screen" / + </head> + <body onload="prettyPrint()"> + <script type="text/javascript">prefix='../';</script> + <script type="text/javascript" src="../js/prettify.js"></script> + <script src="../templates/header.js" type="text/javascript"></script> + <div id="left"> + <noscript>Please turn on Javascript to view this menu</noscript> + <script src="../templates/left.js" type="text/javascript"></script> + </div> + <div id="right"> + <script src="menu.js" type="text/javascript"></script> + </div> + + <div id="content"> + + <h1>Chapter 6: Encoders</h1> + </div> + </body> +</html> diff --git a/logback-site/src/site/pages/manual/filters.html b/logback-site/src/site/pages/manual/filters.html index 716c3f2..4ca854c 100644 --- a/logback-site/src/site/pages/manual/filters.html +++ b/logback-site/src/site/pages/manual/filters.html @@ -24,7 +24,7 @@ </div> <div id="content"> - <h1>Chapter 6: Filters</h1> + <h1>Chapter 7: Filters</h1> <div class="quote"> Have lots of ideas and throw away the bad ones. You aren't diff --git a/logback-site/src/site/pages/manual/index.html b/logback-site/src/site/pages/manual/index.html index f4ac339..e8d7e21 100644 --- a/logback-site/src/site/pages/manual/index.html +++ b/logback-site/src/site/pages/manual/index.html @@ -48,6 +48,7 @@ <li>logback configuration scripts in XML format</li> <li>appenders</li> <li>layouts</li> + <li>encoders</li> <li>filters</li> <li>mapped diagnostic contexts</li> <li>joran, logback's configuration system</li> @@ -89,28 +90,32 @@ <a href="layouts.html">Chapter 5: Layouts</a> </li> + <li> + <a href="encoders.html">Chapter 6: Encoders</a> + </li> + <li> - <a href="filters.html">Chapter 6: Filters</a> + <a href="filters.html">Chapter 7: Filters</a> </li> <li> - <a href="mdc.html">Chapter 7: Mapped Diagnostic Context</a> + <a href="mdc.html">Chapter 8: Mapped Diagnostic Contexts</a> </li> <li> - <a href="loggingSeparation.html">Chapter 8: Logging Separation</a> + <a href="loggingSeparation.html">Chapter 9: Logging Separation</a> </li> <li> - <a href="jmxConfig.html">Chapter 9: JMX Configurator</a> + <a href="jmxConfig.html">Chapter 10: JMX Configurator</a> </li> <li> - <a href="onJoran.html">Chapter 10: Joran</a> + <a href="onJoran.html">Chapter 11: Joran</a> </li> <li> - <a href="migrationFromLog4j.html">Chapter 11: Migration from log4j</a> + <a href="migrationFromLog4j.html">Chapter 12: Migration from log4j</a> </li> </ul> diff --git a/logback-site/src/site/pages/manual/jmxConfig.html b/logback-site/src/site/pages/manual/jmxConfig.html index 96eeb39..5481188 100644 --- a/logback-site/src/site/pages/manual/jmxConfig.html +++ b/logback-site/src/site/pages/manual/jmxConfig.html @@ -25,7 +25,7 @@ </div> <div id="content"> - <h2>JMX Configurator</h2> + <h2>Chapter 10: JMX Configurator</h2> As its name indicates, <code>JMXConfigurator</code> allows configuration of logback via JMX. In a nutshell, it lets you diff --git a/logback-site/src/site/pages/manual/loggingSeparation.html b/logback-site/src/site/pages/manual/loggingSeparation.html index 4350841..ecea848 100644 --- a/logback-site/src/site/pages/manual/loggingSeparation.html +++ b/logback-site/src/site/pages/manual/loggingSeparation.html @@ -23,7 +23,7 @@ </div> <div id="content"> - <h2>Chapter 9: Context Selectors</h2> + <h2>Chapter 9: Logging separation</h2> <div class="quote"> It is not knowledge, but the act of learning, not diff --git a/logback-site/src/site/pages/manual/mdc.html b/logback-site/src/site/pages/manual/mdc.html index 6529648..8b0bf37 100644 --- a/logback-site/src/site/pages/manual/mdc.html +++ b/logback-site/src/site/pages/manual/mdc.html @@ -23,7 +23,7 @@ </div> <div id="content"> - <h1>Chapter 7: Mapped Diagnostic Context</h1> + <h1>Chapter 8: Mapped Diagnostic Context</h1> <div class="quote"> Lock the doors. diff --git a/logback-site/src/site/pages/manual/menu.js b/logback-site/src/site/pages/manual/menu.js index 5459e11..c41b284 100644 --- a/logback-site/src/site/pages/manual/menu.js +++ b/logback-site/src/site/pages/manual/menu.js @@ -5,9 +5,10 @@ document.write('<a href="architecture.html">Ch2: Architecture document.write('<a href="configuration.html">Ch3: Configuration</a>'); document.write('<a href="appenders.html">Ch4: Appenders</a>'); document.write('<a href="layouts.html">Ch5: Layouts</a>'); -document.write('<a href="filters.html">Ch6: Filters</a>'); -document.write('<a href="mdc.html">Ch7: Mapped Diagnostic Contexts</a>'); -document.write('<a href="loggingSeparation.html">Ch8: Logging Separation</a>'); -document.write('<a href="jmxConfig.html">Ch9: JMX Configurator</a>'); -document.write('<a href="onJoran.html">Ch10: Joran</a>'); -document.write('<a href="migrationFromLog4j.html">Ch11: Migration from log4j</a>'); +document.write('<a href="encoders.html">Ch6: Encoders</a>'); +document.write('<a href="filters.html">Ch7: Filters</a>'); +document.write('<a href="mdc.html">Ch8: Mapped Diagnostic Contexts</a>'); +document.write('<a href="loggingSeparation.html">Ch9: Logging Separation</a>'); +document.write('<a href="jmxConfig.html">Ch10: JMX Configurator</a>'); +document.write('<a href="onJoran.html">Ch11: Joran</a>'); +document.write('<a href="migrationFromLog4j.html">Ch12: Migration from log4j</a>'); diff --git a/logback-site/src/site/pages/manual/migrationFromLog4j.html b/logback-site/src/site/pages/manual/migrationFromLog4j.html index b9b6e41..dd392cf 100644 --- a/logback-site/src/site/pages/manual/migrationFromLog4j.html +++ b/logback-site/src/site/pages/manual/migrationFromLog4j.html @@ -23,7 +23,7 @@ </div> <div id="content"> - <h2>Migration from log4j</h2> + <h2>Chapter 12: Migration from log4j</h2> <div class="quote"> The more things change, the more they remain the diff --git a/logback-site/src/site/pages/manual/onJoran.html b/logback-site/src/site/pages/manual/onJoran.html index b44a270..9c6f259 100644 --- a/logback-site/src/site/pages/manual/onJoran.html +++ b/logback-site/src/site/pages/manual/onJoran.html @@ -23,7 +23,7 @@ </div> <div id="content"> - <h2>Joran in your own applications</h2> + <h2>Chapter 11: Joran</h2> <div class="quote"> The answer, my friend, is blowin' in the wind, The answer @@ -176,24 +176,33 @@ import org.xml.sax.Attributes; import ch.qos.logback.core.joran.spi.ExecutionContext; public abstract class Action { - - /** * Called when the parser encounters an element matching a * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. */ - public abstract void begin(InterpretationContext ec, String name, + public abstract void begin(InterpretationContext ic, String name, Attributes attributes) throws ActionException; + /** + * Called to pass the body (as text) contained within an element. + */ + public void body(InterpretationContext ic, String body) + throws ActionException { + // NOP + } + /* * Called when the parser encounters an endElement event matching a * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. */ - public abstract void end(InterpretationContext ec, String name) + public abstract void end(InterpretationContext ic, String name) throws ActionException; }</pre> - Thus, every action must implement the begin and end methods. + Thus, every action must implement the <code>begin()</code> and + <code>end()</code> methods. The implemetnation of the + <code>body()</code> method being optional on account of the + empty/nop implementation provided by <code>Action</code>. <h3><a name="ruleStore" href="#ruleStore">RuleStore</a> </h3> ----------------------------------------------------------------------- Summary of changes: .../ch/qos/logback/core/joran/action/Action.java | 30 ++++++++++++-------- logback-site/src/site/pages/manual/encoders.html | 29 +++++++++++++++++++ logback-site/src/site/pages/manual/filters.html | 2 +- logback-site/src/site/pages/manual/index.html | 17 +++++++---- logback-site/src/site/pages/manual/jmxConfig.html | 2 +- .../src/site/pages/manual/loggingSeparation.html | 2 +- logback-site/src/site/pages/manual/mdc.html | 2 +- logback-site/src/site/pages/manual/menu.js | 13 ++++---- .../src/site/pages/manual/migrationFromLog4j.html | 2 +- logback-site/src/site/pages/manual/onJoran.html | 21 ++++++++++---- 10 files changed, 85 insertions(+), 35 deletions(-) create mode 100644 logback-site/src/site/pages/manual/encoders.html hooks/post-receive -- Logback: the generic, reliable, fast and flexible logging framework.

1 0

[GIT] Logback: the generic, reliable, fast and flexible logging framework. branch, master, updated. v0.9.18-67-ga9729dc
by git-noreply＠pixie.qos.ch 05 Mar '10

05 Mar '10

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 a9729dc84972f7c16fd4b857d9c2b6372d9f4158 (commit) from 1a1fc55afe69a0a74c31c765c9ae7fd97273936e (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=a9729dc84972f7c16fd4b857… http://github.com/ceki/logback/commit/a9729dc84972f7c16fd4b857d9c2b6372d9f4… commit a9729dc84972f7c16fd4b857d9c2b6372d9f4158 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Fri Mar 5 22:46:58 2010 +0100 edits to the chapter on appenders diff --git a/logback-examples/src/main/java/chapters/appenders/conf/logback-RollingSizeBased.xml b/logback-examples/src/main/java/chapters/appenders/conf/logback-RollingSizeBased.xml index 8563e24..43dc771 100644 --- a/logback-examples/src/main/java/chapters/appenders/conf/logback-RollingSizeBased.xml +++ b/logback-examples/src/main/java/chapters/appenders/conf/logback-RollingSizeBased.xml @@ -3,20 +3,20 @@ <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>test.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <fileNamePattern>tests.%i.log.zip</fileNamePattern> + <fileNamePattern>test.%i.log.zip</fileNamePattern> <minIndex>1</minIndex> <maxIndex>3</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <maxFileSize>1KB</maxFileSize> + <maxFileSize>5MB</maxFileSize> </triggeringPolicy> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration> diff --git a/logback-examples/src/main/java/chapters/appenders/conf/logbback-sizeAndTime.xml b/logback-examples/src/main/java/chapters/appenders/conf/logbback-sizeAndTime.xml index de69021..505cd9c 100644 --- a/logback-examples/src/main/java/chapters/appenders/conf/logbback-sizeAndTime.xml +++ b/logback-examples/src/main/java/chapters/appenders/conf/logbback-sizeAndTime.xml @@ -1,13 +1,13 @@ <configuration> <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${randomOutputDir}z${testId}</file> + <file>mylog.txt</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> - <fileNamePattern> - ${randomOutputDir}${testId}-%d{yyyy-MM-dd_HH_mm_ss}.%i - </fileNamePattern> +  + <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> - <maxFileSize>${sizeThreshold}</maxFileSize> +  + <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <encoder> diff --git a/logback-site/src/site/pages/manual/appenders.html b/logback-site/src/site/pages/manual/appenders.html index 8e6d07c..1b1c8ef 100644 --- a/logback-site/src/site/pages/manual/appenders.html +++ b/logback-site/src/site/pages/manual/appenders.html @@ -39,7 +39,8 @@ <script src="../templates/creative.js" type="text/javascript"></script> <script src="../templates/setup.js" type="text/javascript"></script> - <h2>What is an Appender?</h2> + <h2><a name="whatIsAnAppender" href="#whatIsAnAppender">What is an + Appender?</a></h2> Logback delegates the task of writing a logging event to components called appenders. Appenders must implement the <a @@ -95,7 +96,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl - <h2><a name="AppenderBase">AppenderBase</a></h2> + <h2><a name="AppenderBase" href="#AppenderBase">AppenderBase</a></h2> The <a href="../xref/ch/qos/logback/core/AppenderBase.html"> <code>ch.qos.logback.core.AppenderBase</code></a> class is an @@ -220,7 +221,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl dynamically using JavaBeans introspection through setter and getter methods. - <h2>Logback-core</h2> + <h1>Logback-core</h1> Logback-core lays the foundation upon which the other logback modules are built. In general, the components in logback-core @@ -231,9 +232,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl - <h3> + <h2> <a name="OutputStreamAppender" href="#OutputStreamAppender">OutputStreamAppender</a> - </h3> + </h2> <a href="../xref/ch/qos/logback/core/OutputStreamAppender.html"><code>OutputStreamAppender</code></a> @@ -289,10 +290,10 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <img src="images/chapters/appenders/appenderClassDiagram.jpg" alt="A UML diagram showing OutputStreamAppender and sub-classes"/> - <h3> + <h2> <a name="ConsoleAppender" href="#ConsoleAppender">ConsoleAppender</a> - </h3> + </h2> The <a href="../xref/ch/qos/logback/core/ConsoleAppender.html"> <code>ConsoleAppender</code></a>, as the name indicates, appends on @@ -344,7 +345,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="STDOUT" /> </root> </configuration></pre> @@ -359,9 +360,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl href="../xref/chapters/appenders/ConfigurationTester.html">chapters.appenders.ConfigurationTester</a> src/main/java/chapters/appenders/conf/logback-Console.xml - <h3> + <h2> <a name="FileAppender" href="#FileAppender">FileAppender</a> - </h3> + </h2> The <a href="../xref/ch/qos/logback/core/FileAppender.html"><code>FileAppender</code></a>, @@ -482,7 +483,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration></pre> @@ -547,9 +548,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl java chapters.appenders.ConfigurationTester src/main/java/chapters/appenders/conf/logback-timestamp.xml - <h3> + <h2> <a name="RollingFileAppender" href="#RollingFileAppender">RollingFileAppender</a> - </h3> + </h2> <a href="../xref/ch/qos/logback/core/rolling/RollingFileAppender.html"><code>RollingFileAppender</code></a> @@ -559,16 +560,18 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl met, change its logging target to another file. - There are two important logback components that interact with - <code>RollingFileAppender</code>. First, a - <code>RollingPolicy</code> instance attached to the - <code>RollingFileAppender</code> is responsible for undertaking the - action for performing a rollover. Second, a - <code>TriggeringPolicy</code> instance attached to a - <code>RollingFileAppender</code> will determine if and exactly when - rollover occurs. Thus, <code>RollingPolicy</code> is responsible - for the what and <code>TriggeringPolicy</code> is - responsible for the when. + There are two important sub-components that interact with + <code>RollingFileAppender</code>. The first + <code>RollingFileAppender</code> sub-component, namely + <code>RollingPolicy</code>, (<a href="#onRollingPolicies">see + below</a>) is responsible for undertaking the actions required for + a rollover. A second sub-component of + <code>RollingFileAppender</code>, namely + <code>TriggeringPolicy</code>, (<a href="#TriggeringPolicy">see + below</a>) will determine if and exactly when rollover + occurs. Thus, <code>RollingPolicy</code> is responsible for the + what and <code>TriggeringPolicy</code> is responsible for + the when. <code>RollingPolicy</code> is described To be of any use, a <code>RollingFileAppender</code> must have @@ -659,7 +662,8 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl </tr> </table> - <h3>Rolling policies</h3> + <h3><a name="onRollingPolicies" href="#onRollingPolicies">Overview + of rolling policies</a></h3> <a href="../xref/ch/qos/logback/core/rolling/RollingPolicy.html"><code>RollingPolicy</code></a> @@ -841,7 +845,7 @@ public interface RollingPolicy extends LifeCycle { <code>FixedWindowRollingPolicy</code>. Note that the File option is mandatory even if it contains some of the same information as conveyed with the FileNamePattern option. + class="option">fileNamePattern option. Example 4.: Sample configuration of a <code>RollingFileAppender</code> using a @@ -879,11 +883,16 @@ public interface RollingPolicy extends LifeCycle { <code>TimeBasedRollingPolicy</code></a> is possibly the most popular rolling policy. It defines a rollover policy based on time, for example by day or by month. + <code>TimeBasedRollingPolicy</code> assumes the responsibility for + rollover as well as for the triggering of said rollover. Indeed, + <code>TimeBasedTriggeringPolicy</code> implements both + <code>RollingPolicy</code> and <code>TriggeringPolicy</code> + interfaces. <code>TimeBasedRollingPolicy</code>'s admits two properties, the mandatory fileNamePattern property and - the optional MaxHistory property. + the optional maxHistory property. <table class="bodyTable"> @@ -896,12 +905,13 @@ public interface RollingPolicy extends LifeCycle { <td>fileNamePattern</td> <td><code>String</code></td> <td> - FileNamePattern property defines - the name of the rolled (archived) log files. Its value should - consist of the name of the file, plus a suitably placed - %d conversion specifier. The %d conversion - specifier may contain a date-and-time pattern as specified by - the <code>java.text.SimpleDateFormat</code> class. If the + The mandatory fileNamePattern + property defines the name of the rolled (archived) log + files. Its value should consist of the name of the file, plus + a suitably placed %d conversion specifier. The + %d conversion specifier may contain a date-and-time + pattern as specified by the + <code>java.text.SimpleDateFormat</code> class. If the date-and-time pattern is omitted, then the default pattern yyyy-MM-dd is assumed. The File property in @@ -925,19 +935,19 @@ public interface RollingPolicy extends LifeCycle { The date-and-time pattern, as found within the accolades of %d{} follow java.text.SimpleDateFormat conventions. The forward slash '/' or backward slash '\' characters anywhere - within the FileNamePattern property or within the + within the fileNamePattern property or within the date-and-time pattern will be interpreted as directory separators. </td> </tr> - <tr> - <td>maxHistory</td> + <tr class="a"> + <td>maxHistory</td> <td>int</td> - <td>The maxHistory property - controls the maximum number of archive files to keep, + <td>The optional maxHistory + property controls the maximum number of archive files to keep, deleting older files. For example, if you specify monthly - rollover, and set MaxHistory to 6, then 6 months worth of + rollover, and set maxHistory to 6, then 6 months worth of archives files will be kept with files older than 6 months deleted. Note as old archived log files are removed, any folders which were created for the purpose of log file @@ -1060,12 +1070,13 @@ public interface RollingPolicy extends LifeCycle { Just like <code>FixedWindowRollingPolicy</code>, <code>TimeBasedRollingPolicy</code> supports automatic file compression. This feature is enabled if the value of the FileNamePattern option ends with .gz + class="option">fileNamePattern option ends with .gz or .zip. + <table class="bodyTable"> <tr class="a"> - <th>FileNamePattern</th> + <th>fileNamePattern</th> <th>Rollover schedule</th> <th>Example</th> </tr> @@ -1107,13 +1118,6 @@ public interface RollingPolicy extends LifeCycle { resulting archive files will carry different names. - <code>TimeBasedRollingPolicy</code> assumes the responsibility - for rollover as well as for the triggering of said - rollover. Indeed, <code>TimeBasedTriggeringPolicy</code> implements - both <code>RollingPolicy</code> and <code>TriggeringPolicy</code> - interfaces. - - By setting the file property you can decouple the location of the active log file and the location of the archived log files. The logging output will be targeted into @@ -1128,7 +1132,7 @@ public interface RollingPolicy extends LifeCycle { The maxHistory property controls the maximum number of archive files to keep, deleting older files. For example, if you specify monthly rollover, and set MaxHistory to 6, then 6 months worth of + class="option">maxHistory to 6, then 6 months worth of archives files will be kept with files older than 6 months deleted. Note as old archived log files are removed, any folders which were created for the purpose of log file archiving will be @@ -1155,7 +1159,8 @@ public interface RollingPolicy extends LifeCycle { <code>TimeBasedRollingPolicy</code>. - Example 4.: Sample configuration of a <code>RollingFileAppender</code> using a + Example 4.: Sample configuration of a + <code>RollingFileAppender</code> using a <code>TimeBasedRollingPolicy</code> (logback-examples/src/main/java/chapters/appenders/conf/logback-RollingTimeBased.xml) @@ -1168,7 +1173,7 @@ public interface RollingPolicy extends LifeCycle { <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>  - <MaxHistory>30</MaxHistory> + <maxHistory>30</maxHistory> </rollingPolicy> <encoder> @@ -1206,7 +1211,7 @@ public interface RollingPolicy extends LifeCycle { </encocer> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration></pre> @@ -1217,7 +1222,7 @@ public interface RollingPolicy extends LifeCycle { href="#SizeAndTimeBasedFNATP">Size and time based archiving</a> </h3> - You may sometimes wish to archive files essentially by date but + Sometimes you may wish to archive files essentially by date but at the same time limit the size of each log file, in particular if post-processing tools impose size limits on the log files. In order to address this requirement, logback ships with a @@ -1225,53 +1230,54 @@ public interface RollingPolicy extends LifeCycle { <code>SizeAndTimeBasedFNATP</code>, where FNATP stands for File Naming And Triggering Policy. - + Here is a sample configuration file demonstrating time and size + based log file archiving. Example 4.: Sample configuration for <code>SizeAndTimeBasedFNATP</code> (logback-examples/src/main/java/chapters/appenders/conf/logback-sizeAndTime.xml) <pre class="prettyprint source"><configuration> - <appender name="ROLLING" - class="ch.qos.logback.core.rolling.RollingFileAppender"> - <File>mylog.txt</File> - <rollingPolicy - class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> - <FileNamePattern> - mylog-%d{yyyy-MM-dd_HH_mm_ss}.%i.txt - </FileNamePattern> - <TimeBasedFileNamingAndTriggeringPolicy + <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>mylog.txt</file> + <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> +  + <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern> + <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> - <MaxFileSize>${sizeThreshold}</MaxFileSize> - </TimeBasedFileNamingAndTriggeringPolicy> +  + <maxFileSize>100MB</maxFileSize> + </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> - <layout> - <Pattern>%msg%n</Pattern> - </layout> + <encoder> + <pattern>%msg%n</pattern> + </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="ROLLING" /> </root> </configuration></pre> - Note the "%i" conversion token in addition to "%d{}". Each time - the current log file reaches <code>MaxFileSize</code> before the - current time period end, it will be archived with an increasing - index, starting at 0. - - Size and time based archiving supports cleaning of old archive - files. You just need to specify the number of periods to preserve - with the <code><MaxHistory></code> element. When your + Note the "%i" conversion token in addition to "%d". Each time + the current log file reaches maxFileSize before the current time period + ends, it will be archived with an increasing index, starting at + 0. + + Size and time based archiving supports deletion of old archive + files. You need to specify the number of periods to preserve with + the maxHistory property. When your application is stopped and restarted, logging will continue at the correct location, i.e. at the largest index number for the current period. - <h3> - <a name="TriggeringPolicy" href="#TriggeringPolicy">Triggering policy interface</a> - </h3> + <h2> + <a name="TriggeringPolicy" href="#TriggeringPolicy">Overview of + triggering policies</a> + </h2> <a href="../xref/ch/qos/logback/core/rolling/TriggeringPolicy.html"><code>TriggeringPolicy</code></a> @@ -1297,6 +1303,11 @@ public interface TriggeringPolicy<E> extends LifeCycle { rollover should occur or not, based on the said parameters. + The most widely-used triggering policy, namely + <code>TimeBasedRollingPolicy</code> which also doubles as a + rolliging policy, was already <a + href="#TimeBasedRollingPolicy">discussed earlier</a> along with + other rolling policies. <h4><a name="SizeBasedTriggeringPolicy" href="#SizeBasedTriggeringPolicy">SizeBasedTriggeringPolicy</a></h4> @@ -1305,49 +1316,49 @@ public interface TriggeringPolicy<E> extends LifeCycle { href="../xref/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.html"> <code>SizeBasedTriggeringPolicy</code></a> looks at size of the currently active file. If it grows larger than the specified size, - the <code>FileAppender</code> using the - <code>SizeBasedTriggeringPolicy</code> will proceed to the - rollover of the existing active file and create a new one. + it will signal the owning <code>RollingFileAppender</code> to + trigger the rollover of the existing active file. - This <code>TriggeringPolicy</code> accepts only one parameter, - namely MaxFileSize, with a default - value of 10 MB. + <code>SizeBasedTriggeringPolicy</code> accepts only one + parameter, namely maxFileSize, with a + default value of 10 MB. - The MaxFileSize option can be + The maxFileSize option can be specified in bytes, kilobytes, megabytes or gigabytes by suffixing a numeric value with KB, MB and respectively GB. For example, 5000000, 5000KB, 5MB and 2GB are all valid values, with the first - three being also equivalent. + three being equivalent. Here is a sample configuration with a <code>RollingFileAppender</code> in conjunction with - <code>SizeBasedTriggeringPolicy</code>. + <code>SizeBasedTriggeringPolicy</code> triggering roll over when + the log file reaches 5MB in size. Example 4.: Sample configuration of a <code>RollingFileAppender</code> using a <code>SizeBasedTriggeringPolicy</code> (logback-examples/src/main/java/chapters/appenders/conf/logback-RollingSizeBased.xml) <pre class="prettyprint source"><configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <File>testFile.log</File> + <file>test.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <FileNamePattern>testFile.%i.log.zip</FileNamePattern> - <MinIndex>1</MinIndex> - <MaxIndex>3</MaxIndex> + <fileNamePattern>test.%i.log.zip</fileNamePattern> + <minIndex>1</minIndex> + <maxIndex>3</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <MaxFileSize>5MB</MaxFileSize> + <maxFileSize>5MB</maxFileSize> </triggeringPolicy> - <layout class="ch.qos.logback.classic.PatternLayout"> - <Pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</Pattern> - </layout> + <encoder + <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> + </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration></pre> @@ -1557,7 +1568,7 @@ public interface TriggeringPolicy<E> extends LifeCycle { <IncludeCallerData>${includeCallerData}</IncludeCallerData> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="SOCKET" /> </root> @@ -2021,7 +2032,7 @@ Context ctx = new InitialContext(env);</pre> <TopicBindingName>MyTopic</TopicBindingName> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="Topic" /> </root> </configuration></pre> @@ -2089,7 +2100,7 @@ Context ctx = new InitialContext(env);</pre> <QueueBindingName>MyQueue</QueueBindingName> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="Queue" /> </root> </configuration></pre> @@ -2302,7 +2313,7 @@ Context ctx = new InitialContext(env);</pre> </layout> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="EMAIL" /> </root> </configuration></pre> @@ -2468,7 +2479,7 @@ public class CounterBasedEvaluator extends ContextAwareBase implements EventEval <layout class="ch.qos.logback.classic.html.HTMLLayout"/> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="EMAIL" /> </root> </configuration></pre> @@ -2571,7 +2582,7 @@ logger.error(notifyAdminMarker, </layout> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="EMAIL" /> </root> </configuration></pre> @@ -2602,7 +2613,7 @@ logger.error(notifyAdminMarker, </layout> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="EMAIL" /> </root> </configuration></pre> @@ -2914,7 +2925,7 @@ logger.error(notifyAdminMarker, </connectionSource> </appender> - <root level="debug" > + <root level="DEBUG" > <appender-ref ref="DB" /> </root> </configuration></pre> @@ -3001,7 +3012,7 @@ logger.error(notifyAdminMarker, </connectionSource> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="DB" /> </root> </configuration></pre> @@ -3108,7 +3119,7 @@ logger.error(notifyAdminMarker, </connectionSource> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="DB" /> </root> </configuration</pre> @@ -3142,7 +3153,7 @@ logger.error(notifyAdminMarker, </connectionSource> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="DB" /> </root> </configuration></pre> @@ -3271,7 +3282,7 @@ logger.error(notifyAdminMarker, <SuffixPattern>[%thread] %logger %msg</SuffixPattern> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="STDOUT" /> </root> </configuration></pre> ----------------------------------------------------------------------- Summary of changes: .../appenders/conf/logback-RollingSizeBased.xml | 6 +- .../appenders/conf/logbback-sizeAndTime.xml | 10 +- logback-site/src/site/pages/manual/appenders.html | 229 ++++++++++---------- 3 files changed, 128 insertions(+), 117 deletions(-) hooks/post-receive -- Logback: the generic, reliable, fast and flexible logging framework.

1 0

[GIT] Logback: the generic, reliable, fast and flexible logging framework. branch, master, updated. v0.9.18-66-g1a1fc55
by git-noreply＠pixie.qos.ch 05 Mar '10

05 Mar '10

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 1a1fc55afe69a0a74c31c765c9ae7fd97273936e (commit) from 108c2384db2295b33f7b336818954c20765482f9 (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=1a1fc55afe69a0a74c31c765… http://github.com/ceki/logback/commit/1a1fc55afe69a0a74c31c765c9ae7fd972739… commit 1a1fc55afe69a0a74c31c765c9ae7fd97273936e Author: Ceki Gulcu <ceki(a)qos.ch> Date: Fri Mar 5 16:33:16 2010 +0100 Editing the chapter on appenders diff --git a/logback-examples/src/main/java/chapters/appenders/ConfigurationTester.java b/logback-examples/src/main/java/chapters/appenders/ConfigurationTester.java index d215a04..5bc4f0a 100644 --- a/logback-examples/src/main/java/chapters/appenders/ConfigurationTester.java +++ b/logback-examples/src/main/java/chapters/appenders/ConfigurationTester.java @@ -35,7 +35,6 @@ public class ConfigurationTester { Logger logger = (Logger) LoggerFactory.getLogger(ConfigurationTester.class); LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); - System.out.println("***********"+args[0]); try { JoranConfigurator configurator = new JoranConfigurator(); configurator.setContext(lc); diff --git a/logback-examples/src/main/java/chapters/appenders/ExitWoes1.java b/logback-examples/src/main/java/chapters/appenders/ExitWoes1.java deleted file mode 100644 index 29f5bb2..0000000 --- a/logback-examples/src/main/java/chapters/appenders/ExitWoes1.java +++ /dev/null @@ -1,46 +0,0 @@ -/** - * Logback: the reliable, generic, fast and flexible logging framework. - * Copyright (C) 1999-2009, QOS.ch. All rights reserved. - * - * This program and the accompanying materials are dual-licensed under - * either the terms of the Eclipse Public License v1.0 as published by - * the Eclipse Foundation - * - * or (per the licensee's choosing) - * - * under the terms of the GNU Lesser General Public License version 2.1 - * as published by the Free Software Foundation. - */ -package chapters.appenders; - -import java.io.FileOutputStream; -import java.io.OutputStream; - -import org.slf4j.LoggerFactory; - -import ch.qos.logback.classic.Logger; -import ch.qos.logback.classic.LoggerContext; -import ch.qos.logback.classic.spi.ILoggingEvent; -import ch.qos.logback.core.OutputStreamAppender; -import ch.qos.logback.core.encoder.EchoEncoder; - -public class ExitWoes1 { - - public static void main(String[] args) throws Exception { - LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); - lc.reset(); // we want to override the default-config. - OutputStreamAppender<ILoggingEvent> writerAppender = new OutputStreamAppender<ILoggingEvent>(); - writerAppender.setContext(lc); - writerAppender.setEncoder(new EchoEncoder<ILoggingEvent>()); - - OutputStream os = new FileOutputStream("exitWoes1.log"); - writerAppender.setOutputStream(os); - writerAppender.start(); - Logger root = lc.getLogger(Logger.ROOT_LOGGER_NAME); - root.addAppender(writerAppender); - - Logger logger = lc.getLogger(ExitWoes1.class); - - logger.debug("Hello world."); - } -} \ No newline at end of file diff --git a/logback-examples/src/main/java/chapters/appenders/ExitWoes2.java b/logback-examples/src/main/java/chapters/appenders/ExitWoes2.java deleted file mode 100644 index 6459cc8..0000000 --- a/logback-examples/src/main/java/chapters/appenders/ExitWoes2.java +++ /dev/null @@ -1,51 +0,0 @@ -/** - * Logback: the reliable, generic, fast and flexible logging framework. - * Copyright (C) 1999-2009, QOS.ch. All rights reserved. - * - * This program and the accompanying materials are dual-licensed under - * either the terms of the Eclipse Public License v1.0 as published by - * the Eclipse Foundation - * - * or (per the licensee's choosing) - * - * under the terms of the GNU Lesser General Public License version 2.1 - * as published by the Free Software Foundation. - */ -package chapters.appenders; - -import java.io.FileOutputStream; -import java.io.OutputStream; - -import org.slf4j.LoggerFactory; - -import ch.qos.logback.classic.Logger; -import ch.qos.logback.classic.LoggerContext; -import ch.qos.logback.classic.spi.ILoggingEvent; -import ch.qos.logback.core.OutputStreamAppender; -import ch.qos.logback.core.encoder.EchoEncoder; -import ch.qos.logback.core.util.StatusPrinter; - -public class ExitWoes2 { - - public static void main(String[] args) throws Exception { - LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); - lc.reset();//this is to cancel default-config. - OutputStreamAppender<ILoggingEvent> writerAppender = new OutputStreamAppender<ILoggingEvent>(); - writerAppender.setContext(lc); - writerAppender.setEncoder(new EchoEncoder<ILoggingEvent>()); - - OutputStream os = new FileOutputStream("exitWoes2.log"); - writerAppender.setOutputStream(os); - writerAppender.start(); - Logger root = lc.getLogger(Logger.ROOT_LOGGER_NAME); - root.addAppender(writerAppender); - - Logger logger = lc.getLogger(ExitWoes2.class); - - logger.debug("Hello world."); - - lc.stop(); - - StatusPrinter.print(lc); - } -} \ No newline at end of file diff --git a/logback-examples/src/main/java/chapters/appenders/conf/logback-Console.xml b/logback-examples/src/main/java/chapters/appenders/conf/logback-Console.xml index 68a72ee..dff6351 100644 --- a/logback-examples/src/main/java/chapters/appenders/conf/logback-Console.xml +++ b/logback-examples/src/main/java/chapters/appenders/conf/logback-Console.xml @@ -1,4 +1,4 @@ -<configuration debug="true"> +<configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  + <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern> +  <maxHistory>30</maxHistory> </rollingPolicy> @@ -13,7 +15,7 @@ </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration> \ No newline at end of file diff --git a/logback-examples/src/main/java/chapters/appenders/conf/logback-fileAppender.xml b/logback-examples/src/main/java/chapters/appenders/conf/logback-fileAppender.xml index c67ccda..aba1950 100644 --- a/logback-examples/src/main/java/chapters/appenders/conf/logback-fileAppender.xml +++ b/logback-examples/src/main/java/chapters/appenders/conf/logback-fileAppender.xml @@ -11,7 +11,7 @@ </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration> \ No newline at end of file diff --git a/logback-examples/src/main/java/chapters/appenders/conf/logback-timestamp.xml b/logback-examples/src/main/java/chapters/appenders/conf/logback-timestamp.xml index 340280b..83d0ab8 100644 --- a/logback-examples/src/main/java/chapters/appenders/conf/logback-timestamp.xml +++ b/logback-examples/src/main/java/chapters/appenders/conf/logback-timestamp.xml @@ -14,7 +14,7 @@ </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration> diff --git a/logback-site/src/site/pages/manual/appenders.html b/logback-site/src/site/pages/manual/appenders.html index 2469859..8e6d07c 100644 --- a/logback-site/src/site/pages/manual/appenders.html +++ b/logback-site/src/site/pages/manual/appenders.html @@ -257,17 +257,28 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl </tr> <tr class="a"> - <td>Encoder</td> - <td><code>Encoder</code></td> + <td>encoder</td> + <td><a + href="../xref/ch/qos/logback/core/encoder/Encoder.html"><code>Encoder</code></a></td> <td>Determines the manner in which an event is written to the underlying <code>OutputStreamAppender</code>. Encoders are - described in a <a href="encoders.html">dictated chapter</a>. + described in a <a href="encoders.html">dedicated chapter</a>. </td> </tr> </table> + Given the structure of current hard drives and performance tests + we have conducted, it appears that turning off immediate flushing or + buffering of character to byte conversions have rather small impact + on performance. As such, as of logback vesion 0.9.19, the ImmediateFlush, BufferedIO and BufferSize properties have been removed + without replacement. + + The <code>OutputStreamAppender</code> is the superclass of three other appenders, namely <code>ConsoleAppender</code>, <code>FileAppender</code> which in turn is the super class of @@ -287,12 +298,12 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <code>ConsoleAppender</code></a>, as the name indicates, appends on the console, or more precisely on System.out or System.err, the former being the default - target. <code>ConsoleAppender</code> formats events with a layout - specified by the user. Layouts will be discussed in the next - chapter. Both System.out and System.err 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. + target. <code>ConsoleAppender</code> formats events with the hellp + of an encoder specified by the user. Encoders will be discussed in a + subsequent chapter. Both System.out and System.err + are of type <code>java.io.PrintStream</code>. Consequently, they + are wrapped inside an <code>OutputStreamWriter</code> which buffers + I/O operations. <table class="bodyTable"> @@ -302,12 +313,14 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <th>Description</th> </tr> <tr class="b"> - <td>Encoder</td> - <td><code>Encoder</code></td> + <td>encoder</td> + <td> + <a href="../xref/ch/qos/logback/core/encoder/Encoder.html"><code>Encoder</code></a> + </td> <td>See <code>OutputStreamAppender</code> properties.</td> </tr> <tr class="a"> - <td>Target</td> + <td>target</td> <td><code>String</code></td> <td> One of the String values System.out or @@ -324,8 +337,10 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <pre class="prettyprint source"><configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> - <encoder class="ch.qos.logback.classic.PatternLayout"> - <Pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</Pattern> +  + <encoder> + <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> </encoder> </appender> @@ -335,8 +350,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl </configuration></pre> After you have set your current path to the - logback-examples directory, you can give the above - configuration file a whirl by issuing the following command: + logback-examples directory and <a href="../setup.html">set + up your class path</a>, you can give the above configuration file a + whirl by issuing the following command: java <a @@ -353,15 +369,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl a file. The target file is specified by the File option. If the file already exists, it is either appended to, or truncated depending on the value of the - Append option. - <code>FileAppender</code> 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 BufferedIO option to true which - effectively wraps the <code>OutputStreamWriter</code> with a - <code>BufferedWriter</code>. Properties for <code>FileAppender</code> - are summarized below. + Append option. <table class="bodyTable properties"> @@ -371,7 +379,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <th>Description</th> </tr> <tr class="alt"> - <td>Append</td> + <td>append</td> <td><code>boolean</code></td> <td>If true, events are appended at the end of an existing file. Otherwise, if Append is @@ -381,14 +389,16 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl </td> </tr> <tr > - <td>Encoding</td> - <td><code>String</code></td> + <td>encoder</td> + <td> + <a href="../xref/ch/qos/logback/core/encoder/Encoder.html"><code>Encoder</code></a> + </td> <td>See <code>OutputStreamAppender</code> properties.</td> </tr> <tr class="alt"> - <td>File</td> + <td>file</td> <td><code>String</code></td> <td>The name of the file to write to. If the file does not exist, it is created. On the MS Windows platform users @@ -400,9 +410,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl c:\\temp\\test.log. The File option has no default value. - If the parent directory of the file does now exist, the - FileAppender will automatically create it, including any - necessary but nonexistent parent directories. + If the parent directory of the file does not exist, + <code>FileAppender</code> will automatically create it, + including any necessary but nonexistent parent directories. </td> </tr> @@ -410,7 +420,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <tr > <td><a name="prudent" - href="#prudent">Prudent</a></td> + href="#prudent">prudent</a></td> <td><code>boolean</code></td> <td>In prudent mode, <code>FileAppeder</code> will safely @@ -435,6 +445,17 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl second in prudent mode. + Prudent mode effectively serializes IO operations between + all JVMs writing to the same file. Thus, as he number of JVMs + competing to access the file increases so will the delay + incurred by each I/O operation. As long as the total + number of I/O operations is in the order of 20 log requests + per second, the impact on performance should be + negligible. Applications generating 100 or more I/O + operations per second can see an impact on performance and + should avoid using prudent mode. + + Prudent mode can be used in conjunction with <code>RollingFileAppender</code> although some <a href="#prudentWithRolling">restrictions apply</a>. @@ -452,9 +473,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <pre class="prettyprint source"><configuration> <appender name="FILE" class="ch.qos.logback.core.FileAppender"> - <File>testFile.log</File> - <Append>true</Append> -  <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> @@ -497,13 +518,13 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <appender name="FILE" class="ch.qos.logback.core.FileAppender">  - <File>log-${bySecond}.txt</File> - <layout> - <Pattern>%logger{35} - %msg%n</Pattern> - </layout> + <file>log-${bySecond}.txt</file> + <encoder> + <pattern>%logger{35} - %msg%n</pattern> + </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration></pre> @@ -522,6 +543,10 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>. + Experiment with by running the command: + + java chapters.appenders.ConfigurationTester src/main/java/chapters/appenders/conf/logback-timestamp.xml + <h3> <a name="RollingFileAppender" href="#RollingFileAppender">RollingFileAppender</a> </h3> @@ -541,7 +566,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl action for performing a rollover. Second, a <code>TriggeringPolicy</code> instance attached to a <code>RollingFileAppender</code> will determine if and exactly when - rollover happens Thus, <code>RollingPolicy</code> is responsible + rollover occurs. Thus, <code>RollingPolicy</code> is responsible for the what and <code>TriggeringPolicy</code> is responsible for the when. @@ -563,45 +588,32 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <th>Description</th> </tr> <tr class="b"> - <td>Append</td> - <td><code>boolean</code></td> + <td>file</td> + <td><code>String</code></td> <td>See <code>FileAppender</code> properties.</td> </tr> <tr class="a"> - <td>BufferedIO</td> + <td>append</td> <td><code>boolean</code></td> <td>See <code>FileAppender</code> properties.</td> - </tr> - <tr class="b"> - <td>BufferSize</td> - <td><code>int</code></td> - <td>See <code>FileAppender</code> properties.</td> - </tr> - <tr class="a"> - <td>Encoding</td> - <td><code>String</code></td> - <td>See <code>OutputStreamAppender</code> properties.</td> </tr> <tr class="b"> - <td>File</td> - <td><code>String</code></td> - <td>See <code>FileAppender</code> properties.</td> - </tr> - <tr class="a"> - <td>ImmediateFlush</td> - <td><code>boolean</code></td> + <td>encoder</td> + <td> + <a href="../xref/ch/qos/logback/core/encoder/Encoder.html"><code>Encoder</code></a> + </td> <td>See <code>OutputStreamAppender</code> properties.</td> - </tr> - <tr class="b"> - <td>RollingPolicy</td> + </tr> + <tr class="a"> + <td>rollingPolicy</td> <td><code>RollingPolicy</code></td> <td>This option is the component that will dictate <code>RollingFileAppender</code>'s behavior when rollover occurs. See more information below. </td> </tr> - <tr class="a"> - <td>TriggeringPolicy</td> + <tr class="b"> + <td>triggeringPolicy</td> <td><code>TriggeringPolicy</code></td> <td> This option is the component that will tell @@ -609,9 +621,9 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl procedure. See more information below. </td> </tr> - <tr class="b"> + <tr class="a"> <td valign="top"><a name="prudentWithRolling" - href="#prudentWithRolling">Prudent</a></td> + href="#prudentWithRolling">prudent</a></td> <td valign="top"><code>boolean</code></td> @@ -634,7 +646,7 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl allowed. (We can't have one JVM writing to a file while another JVM is compressing it.) </li> - <li>The File property of + <li>The file property of <code>FileAppender</code> cannot be set and must be left blank. Indeed, most operating systems do not allow renaming of a file while another process has it opened. @@ -651,8 +663,8 @@ public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachabl <a href="../xref/ch/qos/logback/core/rolling/RollingPolicy.html"><code>RollingPolicy</code></a> - is responsible for the rollover procedure. It manages file renaming - and in occasion file deleting. + is responsible for the rollover procedure which involves file + moving and renaming. The <code>RollingPolicy</code> interface is presented below: @@ -664,17 +676,19 @@ import ch.qos.logback.core.spi.LifeCycle; public interface RollingPolicy extends LifeCycle { public void rollover() throws RolloverFailure; - public String getNewActiveFileName(); + public String getActiveFileName(); + public CompressionMode getCompressionMode(); public void setParent(FileAppender appender); }</pre> - The <code>rollover</code> method proceeds to the file change, - renaming or deletion. The <code>getNewActiveFileName()</code> - method is called to compute a new file name, with respect to the - configuration elements that were injected into the - <code>RollingPolicy</code>. Lastly, a <code>RollingPolicy</code> - is given a reference to its parent via the <code>setParent</code> - method. + The <code>rollover</code> method accomplishes the work involved + in archiving the current log file. The + <code>getActiveFileName()</code> method is called to compute a the + file name of the current log file (where live logs are written + to). As indicated by <code>getCompressionMode</code> method a + RollingPolicy is also responsible for determining the compression + mode. Lastly, a <code>RollingPolicy</code> is given a reference to + its parent via the <code>setParent</code> method. <h4> @@ -688,7 +702,7 @@ public interface RollingPolicy extends LifeCycle { to a fixed window algorithm as described below. - The FileNamePattern option + The fileNamePattern option represents the file name pattern for the archived (rolled over) log files. This option is required and must include an integer token %i somewhere within the pattern. @@ -705,7 +719,7 @@ public interface RollingPolicy extends LifeCycle { <th>Description</th> </tr> <tr class="b"> - <td>MinIndex</td> + <td>minIndex</td> <td><code>int</code></td> <td> This option represents the lower bound for the window's @@ -714,7 +728,7 @@ public interface RollingPolicy extends LifeCycle { </td> </tr> <tr class="a"> - <td>MaxIndex</td> + <td>maxIndex</td> <td><code>int</code></td> <td> This option represents the upper bound for the window's @@ -723,7 +737,7 @@ public interface RollingPolicy extends LifeCycle { </td> </tr> <tr class="b"> - <td>FileNamePattern</td> + <td>fileNamePattern</td> <td><code>String</code></td> <td> This option represents the pattern that will be followed @@ -737,12 +751,12 @@ public interface RollingPolicy extends LifeCycle { will produce archive files named MyLogFile1.log, MyLogFile2.log and MyLogFile3.log. - Note that file compression is also specified via the FileNamePattern option. For example, the - file name pattern MyLogFile%i.log.zip will indicate - to the <code>FixedWindowRollingPolicy</code> that the archived - file must be compressed using the zip format; - gz format is also supported. + Note that file compression is also specified via this + property. For example, fileNamePattern set to + MyLogFile%i.log.zip means that archived file must be + compressed using the zip format; gz format + is also supported. </td> </tr> @@ -750,18 +764,17 @@ public interface RollingPolicy extends LifeCycle { Given that the fixed window rolling policy requires as many file renaming operations as the window size, large window sizes are - strongly discouraged. The current implementation will automatically - reduce the window size to 12, when larger values are specified by - the user. + strongly discouraged. When large values are specified by the user, + the current implementation will automatically reduce the window + size to 12. - Let us go over a more concrete example of the fixed windows - rollover policy. Suppose that the MinIndex is set to 1, MaxIndex set to 3, that FileNamePattern option is set to - foo%i.log, and that FileNamePattern option is set to + Let us go over a more concrete example of the fixed window + rollover policy. Suppose that minIndex + is set to 1, maxIndex set to + 3, fileNamePattern property + set to foo%i.log, and that fileNamePattern property is set to foo.log. @@ -836,23 +849,23 @@ public interface RollingPolicy extends LifeCycle { <pre class="prettyprint source"><configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <File>test.log</File> + <file>test.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <FileNamePattern>tests.%i.log.zip</FileNamePattern> - <MinIndex>1</MinIndex> - <MaxIndex>3</MaxIndex> + <fileNamePattern>tests.%i.log.zip</fileNamePattern> + <minIndex>1</minIndex> + <maxIndex>3</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <MaxFileSize>5MB</MaxFileSize> + <maxFileSize>5MB</maxFileSize> </triggeringPolicy> - <layout class="ch.qos.logback.classic.PatternLayout"> - <Pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</Pattern> - </layout> + <encoder> + <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> + </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration></pre> @@ -869,40 +882,80 @@ public interface RollingPolicy extends LifeCycle { <code>TimeBasedRollingPolicy</code>'s admits two properties, the - mandatory FileNamePattern property and + mandatory fileNamePattern property and the optional MaxHistory property. - - FileNamePattern property defines the - name of the rolled (archived) log files. Its value should consist - of the name of the file, plus a suitably placed %d - conversion specifier. The %d conversion specifier may - contain a date-and-time pattern as specified by the - <code>java.text.SimpleDateFormat</code> class. If the - date-and-time pattern is omitted, then the default pattern - yyyy-MM-dd is assumed. The File property in - <code>RollingFileAppender</code> (the parent of - <code>TimeBasedRollingPolicy</code>) can be either set or omitted. - + <table class="bodyTable"> + <tr class="a"> + <th>Property Name</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr class="b"> + <td>fileNamePattern</td> + <td><code>String</code></td> + <td> + FileNamePattern property defines + the name of the rolled (archived) log files. Its value should + consist of the name of the file, plus a suitably placed + %d conversion specifier. The %d conversion + specifier may contain a date-and-time pattern as specified by + the <code>java.text.SimpleDateFormat</code> class. If the + date-and-time pattern is omitted, then the default pattern + yyyy-MM-dd is assumed. The File property in + <code>RollingFileAppender</code> (the parent of + <code>TimeBasedRollingPolicy</code>) can be either set or + omitted. + + By setting the file property + of the containig <code>FileAppender</code>, you can decouple + the location of the active log file and the location of the + archived log files. The current logs will be always targeted + at the file specified by the file + property. It follows that the name of the currently active + log file will not change over time. However, if you choose to + omit the file property, then the + active file will be computed anew for each period based on + the value of fileNamePattern. + The examples below should clarify the point. + - By setting the File property you can - decouple the location of the active log file and the location of - the archived log files. The current logs will be always targeted at - the file specified by the File - property. It follows that the name of the currently active log file - will not change over time. However, if you choose to omit the File property, then the active file will be - computed anew for each period based on the value of FileNamePattern. The following examples - should clarify the point. - + The date-and-time pattern, as found within the accolades + of %d{} follow java.text.SimpleDateFormat conventions. The + forward slash '/' or backward slash '\' characters anywhere + within the FileNamePattern property or within the + date-and-time pattern will be interpreted as directory + separators. + + </td> + </tr> + <tr> + <td>maxHistory</td> + <td>int</td> + <td>The maxHistory property + controls the maximum number of archive files to keep, + deleting older files. For example, if you specify monthly + rollover, and set MaxHistory to 6, then 6 months worth of + archives files will be kept with files older than 6 months + deleted. Note as old archived log files are removed, any + folders which were created for the purpose of log file + archiving will be removed as appropriate. + </td> + </tr> + </table> + + + Here are a few <code>fileNamePattern</code> values with an + explanation of their effects. + + <table class="bodyTable"> <tr class="a"> <th> - FileNamePattern + fileNamePattern </th> <th>Rollover schedule</th> <th>Example</th> @@ -918,14 +971,14 @@ public interface RollingPolicy extends LifeCycle { </td> <td> - File property not set: During November + file property not set: During November 23rd, 2006, logging output will go to the file /wombat/foo.2006-11-23. At midnight and for the rest of the 24th, logging output will be directed to /wombat/foo.2006-11-24. - File property set to + file property set to /wombat/foo.txt: During November 23rd, 2006, logging output will go to the file /wombat/foo.txt. At midnight, foo.txt will be renamed as @@ -945,14 +998,14 @@ public interface RollingPolicy extends LifeCycle { </td> <td>Rollover at the beginning of each month.</td> <td> - File property not set: During the - month of October 2006, logging output will go to + file property not set: During + the month of October 2006, logging output will go to /wombat/2006/10/foo.txt. After midnight of October 31st and for the rest of November, logging output will be directed to /wombat/2006/11/foo.txt. - File property set to + file property set to /wombat/foo.txt: The active log file will always be /wombat/foo.txt. During the month of October 2006, logging output will go to /wombat/foo.txt. At @@ -1003,165 +1056,154 @@ public interface RollingPolicy extends LifeCycle { folders. - The date-and-time pattern, as found within accolades in %d{} - follow java.text.SimpleDateFormat conventions. This any characters - within the date-and-time pattern outside the ranges - ['a'..'z'] and ['A'..'Z'] will be treated as - quoted text. For instance, characters like '.', ' - ', '#' and '@' will appear in the resulting - time text even when they are not enclosed within single - quotes. Nevertheless, we recommend against using the colon - ':' character anywhere within the FileNamePattern option. The text before the - colon is interpreted as the protocol specification of a URL, which - is most probably not what you intend. The forward slash - '/' or backward slash '\' characters anywhere - within the FileNamePattern property or - within the date-and-time pattern will be interpreted as directory - separators and any missing directories will be created as - necessary. - - - Just like <code>FixedWindowRollingPolicy</code>, - <code>TimeBasedRollingPolicy</code> supports automatic file - compression. This feature is enabled if the value of the FileNamePattern option ends with .gz - or .zip. - - <table class="bodyTable"> - <tr class="a"> - <th>FileNamePattern</th> - <th>Rollover schedule</th> - <th>Example</th> - </tr> - <tr class="b"> - <td>/wombat/foo.%d.gz</td> - <td>Daily rollover (at midnight) with automatic GZIP compression of the - archived files.</td> - <td> - File property not set: During - November 23rd, 2009, logging output will go to the file - /wombat/foo.2009-11-23. However, at midnight that - file will be compressed to become - /wombat/foo.2009-11-23.gz. For the 24th of November, - logging output will be directed to - /wombat/folder/foo.2009-11-24 until it's rolled over - at the beginning of the next day. - - - File property set to - /wombat/foo.txt: During November 23rd, 2009, logging output - will go to the file /wombat/foo.txt. At midnight that - file will be compressed and renamed as - /wombat/foo.2009-11-23.gz. A new - /wombat/foo.txt file will be created where logging - output will go for the rest of November 24rd. At midnight - November 24th, /wombat/foo.txt will be compressed and - renamed as /wombat/foo.2009-11-24.gz. and so on. - - </td> - </tr> - </table> - - The FileNamePattern serves a dual - purpose. First, by studying the pattern, logback computes the - requested rollover periodicity. Second, it computes each archived - file's name. Note that it is possible for two different patterns to - specify the same periodicity. The patterns yyyy-MM and - yyyy@MM both specify monthly rollover, although the - resulting archive files will carry different names. - + Just like <code>FixedWindowRollingPolicy</code>, + <code>TimeBasedRollingPolicy</code> supports automatic file + compression. This feature is enabled if the value of the FileNamePattern option ends with .gz + or .zip. + + <table class="bodyTable"> + <tr class="a"> + <th>FileNamePattern</th> + <th>Rollover schedule</th> + <th>Example</th> + </tr> + <tr class="b"> + <td>/wombat/foo.%d.gz</td> + <td>Daily rollover (at midnight) with automatic GZIP compression of the + archived files.</td> + <td> + file property not set: During + November 23rd, 2009, logging output will go to the file + /wombat/foo.2009-11-23. However, at midnight that + file will be compressed to become + /wombat/foo.2009-11-23.gz. For the 24th of November, + logging output will be directed to + /wombat/folder/foo.2009-11-24 until it's rolled over + at the beginning of the next day. + + + file property set to + /wombat/foo.txt: During November 23rd, 2009, logging output + will go to the file /wombat/foo.txt. At midnight that + file will be compressed and renamed as + /wombat/foo.2009-11-23.gz. A new + /wombat/foo.txt file will be created where logging + output will go for the rest of November 24rd. At midnight + November 24th, /wombat/foo.txt will be compressed and + renamed as /wombat/foo.2009-11-24.gz. and so on. + + </td> + </tr> + </table> + + The fileNamePattern serves a dual + purpose. First, by studying the pattern, logback computes the + requested rollover periodicity. Second, it computes each archived + file's name. Note that it is possible for two different patterns to + specify the same periodicity. The patterns yyyy-MM and + yyyy@MM both specify monthly rollover, although the + resulting archive files will carry different names. + - <code>TimeBasedRollingPolicy</code> assumes the responsibility - for rollover as well as for the triggering of said rollover. Indeed, - <code>TimeBasedTriggeringPolicy</code> implements both - <code>RollingPolicy</code> and <code>TriggeringPolicy</code> - interfaces. - + <code>TimeBasedRollingPolicy</code> assumes the responsibility + for rollover as well as for the triggering of said + rollover. Indeed, <code>TimeBasedTriggeringPolicy</code> implements + both <code>RollingPolicy</code> and <code>TriggeringPolicy</code> + interfaces. + - By setting the File property you can - decouple the location of the active log file and the location of the - archived log files. The logging output will be targeted into the - file specified by the File property. It - follows that the name of the active log file will not change over - time. However, if you choose to omit the File property, then the active file will be - computed anew for each period based on the value of FileNamePattern. - + By setting the file property you can + decouple the location of the active log file and the location of + the archived log files. The logging output will be targeted into + the file specified by the file + property. It follows that the name of the active log file will not + change over time. However, if you choose to omit the File property, then the active file will be + computed anew for each period based on the value of fileNamePattern. + - The MaxHistory property controls the - maximum number of archive files to keep, deleting older files. For - example, if you specify monthly rollover, and set MaxHistory to 6, then 6 months worth of - archives files will be kept with files older than 6 months - deleted. Note as old archived log files are removed, any folders - which were created for the purpose of log file archiving will be - removed as appropriate. - + The maxHistory property controls the + maximum number of archive files to keep, deleting older files. For + example, if you specify monthly rollover, and set MaxHistory to 6, then 6 months worth of + archives files will be kept with files older than 6 months + deleted. Note as old archived log files are removed, any folders + which were created for the purpose of log file archiving will be + removed as appropriate. + + For various technical reasons, rollovers are not clock-driven + but depend on the arrival of logging events. For example, on 8th of + March 2002, assuming the fileNamePattern is set to yyyy-MM-dd + (daily rollover), the arrival of the first event after midnight + will trigger a rollover. If there are no logging events during, say + 23 minutes and 47 seconds after midnight, then rollover will + actually occur at 00:23'47 AM on March 9th and not at 0:00 AM. + Thus, depending on the arrival rate of events, rollovers might be + triggered with some latency. However, regardless of the delay, the + rollover algorithm is known to be correct, in the sense that all + logging events generated during a certain period will be output in + the correct file delimiting that period. + - For various technical reasons, rollovers are not clock-driven but - depend on the arrival of logging events. For example, on 8th of - March 2002, assuming the FileNamePattern - is set to yyyy-MM-dd (daily rollover), the arrival of the - first event after midnight will trigger a rollover. If there are no - logging events during, say 23 minutes and 47 seconds after midnight, - then rollover will actually occur at 00:23'47 AM on March 9th and - not at 0:00 AM. Thus, depending on the arrival rate of events, - rollovers might be triggered with some latency. However, regardless - of the delay, the rollover algorithm is known to be correct, in the - sense that all logging events generated during a certain period will - be output in the correct file delimiting that period. - - - Here is a sample configuration for - <code>RollingFileAppender</code> in conjunction with a - <code>TimeBasedRollingPolicy</code>. - + Here is a sample configuration for + <code>RollingFileAppender</code> in conjunction with a + <code>TimeBasedRollingPolicy</code>. + - Example 4.: Sample configuration of a <code>RollingFileAppender</code> using a - <code>TimeBasedRollingPolicy</code> (logback-examples/src/main/java/chapters/appenders/conf/logback-RollingTimeBased.xml) - <pre class="prettyprint source"><configuration> + Example 4.: Sample configuration of a <code>RollingFileAppender</code> using a + + <code>TimeBasedRollingPolicy</code> + (logback-examples/src/main/java/chapters/appenders/conf/logback-RollingTimeBased.xml) + + <pre class="prettyprint source"><configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <File>logFile.log</File> + <file>logFile.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> - <FileNamePattern>logFile.%d{yyyy-MM-dd}.log</FileNamePattern> +  + <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern> +  <MaxHistory>30</MaxHistory> </rollingPolicy> - <layout class="ch.qos.logback.classic.PatternLayout"> - <Pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</Pattern> - </layout> + <encoder> + <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> + </encoder> </appender> - <root level="debug"> + <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration></pre> The next configuration sample illustrates the use of <code>RollingFileAppender</code> associated with - <code>TimeBasedRollingPolicy</code> in Prudent + <code>TimeBasedRollingPolicy</code> in prudent mode. - Example 4.: Sample configuration of a <code>RollingFileAppender</code> using a - <code>TimeBasedRollingPolicy</code> (logback-examples/src/main/java/chapters/appenders/conf/logback-PrudentTimeBasedRolling.xml) + Example 4.: Sample configuration of a + <code>RollingFileAppender</code> using a + <code>TimeBasedRollingPolicy</code> + (logback-examples/src/main/java/chapters/appenders/conf/logback-PrudentTimeBasedRolling.xml) + <pre class="prettyprint source"><configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">  - <Prudent>true</Prudent> + <prudent>true</prudent> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> - <FileNamePattern>logFile.%d{yyyy-MM-dd}.log</FileNamePattern> - <MaxHistory>30</MaxHistory> + <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern> + <maxHistory>30</maxHistory> </rollingPolicy> - <layout class="ch.qos.logback.classic.PatternLayout"> - <Pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</Pattern> - </layout> + <encoder> + <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> + </encocer> </appender> <root level="debug"> ----------------------------------------------------------------------- Summary of changes: .../chapters/appenders/ConfigurationTester.java | 1 - .../main/java/chapters/appenders/ExitWoes1.java | 46 -- .../main/java/chapters/appenders/ExitWoes2.java | 51 -- .../chapters/appenders/conf/logback-Console.xml | 4 +- .../conf/logback-PrudentTimeBasedRolling.xml | 2 +- .../appenders/conf/logback-RollingFixedWindow.xml | 2 +- .../appenders/conf/logback-RollingTimeBased.xml | 6 +- .../appenders/conf/logback-fileAppender.xml | 2 +- .../chapters/appenders/conf/logback-timestamp.xml | 2 +- logback-site/src/site/pages/manual/appenders.html | 580 +++++++++++--------- 10 files changed, 321 insertions(+), 375 deletions(-) delete mode 100644 logback-examples/src/main/java/chapters/appenders/ExitWoes1.java delete mode 100644 logback-examples/src/main/java/chapters/appenders/ExitWoes2.java hooks/post-receive -- Logback: the generic, reliable, fast and flexible logging framework.

1 0