October 2006 - logback-dev - mailman3.qos.ch

svn commit: r775 - logback/trunk/logback-access/src/main/java/ch/qos/logback/access/joran
by noreply.ceki＠qos.ch 25 Oct '06

25 Oct '06

Author: ceki Date: Wed Oct 25 17:02:42 2006 New Revision: 775 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/joran/JoranConfigurator.java Log: minor change Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/joran/JoranConfigurator.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/joran/JoranConfigurator.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/joran/JoranConfigurator.java Wed Oct 25 17:02:42 2006 @@ -27,11 +27,12 @@ @Override public void addInstanceRules(RuleStore rs) { - + super.addInstanceRules(rs); + rs.addRule(new Pattern("configuration"), new ConfigurationAction()); rs.addRule(new Pattern("configuration/appender-ref"), new AppenderRefAction()); - super.addInstanceRules(rs); + }

1 0

svn commit: r774 - logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran
by noreply.ceki＠qos.ch 25 Oct '06

25 Oct '06

Author: ceki Date: Wed Oct 25 17:02:21 2006 New Revision: 774 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/JoranConfigurator.java Log: no need to add parent's rules twice Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/JoranConfigurator.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/JoranConfigurator.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/JoranConfigurator.java Wed Oct 25 17:02:21 2006 @@ -34,6 +34,7 @@ @Override public void addInstanceRules(RuleStore rs) { + // parent rules already added super.addInstanceRules(rs); rs.addRule(new Pattern("configuration"), new ConfigurationAction()); @@ -54,7 +55,6 @@ rs .addRule(new Pattern("configuration/appender/layout"), new LayoutAction()); - super.addInstanceRules(rs); } }

1 0

svn commit: r773 - in logback/trunk/logback-site/src/site: resources/css xdocTemplates xdocTemplates/manual
by noreply.seb＠qos.ch 25 Oct '06

25 Oct '06

Author: seb Date: Wed Oct 25 16:59:59 2006 New Revision: 773 Added: logback/trunk/logback-site/src/site/resources/css/ logback/trunk/logback-site/src/site/resources/css/access.css logback/trunk/logback-site/src/site/resources/css/classic.css Modified: logback/trunk/logback-site/src/site/xdocTemplates/license.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml Log: - Changes to the doc - Moved printing notice to manual index.html - Added css files for classic and access Added: logback/trunk/logback-site/src/site/resources/css/access.css ============================================================================== --- (empty file) +++ logback/trunk/logback-site/src/site/resources/css/access.css Wed Oct 25 16:59:59 2006 @@ -0,0 +1,44 @@ +table { + margin-left: 2em; + margin-right: 2em; + border-left: 2px solid #AAA; +} + +TR.even { + background: #FFFFFF; +} + +TR.odd { + background: #EAEAEA; +} + +TD { + padding-right: 1ex; + padding-left: 1ex; + border-right: 2px solid #AAA; +} + +TD.Time, TD.Date { + text-align: right; + font-family: courier, monospace; + font-size: smaller; +} + +TD.RemoteHost, TD.RequestProtocol, TD.RequestHeader, TD.RequestURL, TD.RemoteUser, TD.RequestURI, TD.ServerName { + text-align: left; +} + +TD.RequestAttribute, TD.RequestCookie, TD.ResponseHeader, TD.RequestParameter { + text-align: left; +} + +TD.RemoteIPAddress, TD.LocalIPAddress, TD.ContentLength, TD.StatusCode, TD.LocalPort { + text-align: right; +} + +TR.header { + background: #596ED5; + color: #FFF; + font-weight: bold; + font-size: larger; +} Added: logback/trunk/logback-site/src/site/resources/css/classic.css ============================================================================== --- (empty file) +++ logback/trunk/logback-site/src/site/resources/css/classic.css Wed Oct 25 16:59:59 2006 @@ -0,0 +1,54 @@ +table { + margin-left: 2em; + margin-right: 2em; + border-left: 2px solid #AAA; +} + +TR.even { + background: #FFFFFF; +} + +TR.odd { + background: #EAEAEA; +} + +TR.warn TD.Level, TR.error TD.Level, TR.fatal TD.Level { + font-weight: bold; + color: #FF4040 +} + +TD { + padding-right: 1ex; + padding-left: 1ex; + border-right: 2px solid #AAA; +} + +TD.Time, TD.Date { + text-align: right; + font-family: courier, monospace; + font-size: smaller; +} + +TD.Thread { + text-align: left; +} + +TD.Level { + text-align: right; +} + +TD.Logger { + text-align: left; +} + +TR.header { + background: #596ED5; + color: #FFF; + font-weight: bold; + font-size: larger; +} + +TD.Exception { + background: #A2AEE8; + font-family: courier, monospace; +} Modified: logback/trunk/logback-site/src/site/xdocTemplates/license.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/license.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/license.xml Wed Oct 25 16:59:59 2006 @@ -20,13 +20,13 @@ as published by the Free Software Foundation. - <div class="source big">Logback: the reliable, generic, fast and flexible logging library for Java. + <div class="source big"><pre>Logback: the reliable, generic, fast and flexible logging library for Java. Copyright (C) 2000-2006, QOS.ch This library is free software, you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as -published by the Free Software Foundation.</div> +published by the Free Software Foundation.</pre></div> Please note that logback is intended to be used behind the SLF4J API, which is licensed under <a Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml Wed Oct 25 16:59:59 2006 @@ -14,6 +14,10 @@ At the moment, only one chapter is available. More to come. + Printing notice: if you want to print this document, you might want to + use <a href="http://www.getfirefox.com">Firefox</a>, with Adapt to page size enabled, + or <a href="http://www.opera.com">Opera</a> for better rendering on paper. + <ul> <li> <a href="layouts.html">Manual Chapter 5: Layout reference</a> Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml Wed Oct 25 16:59:59 2006 @@ -43,10 +43,6 @@ </td> </tr> </table> - - Printing notice: if you want to print this document, you might want to - use Firefox, with Adapt to page size enabled, - or Opera for better rendering on paper. <h2>What is a layout</h2> @@ -1223,17 +1219,19 @@ A user-specified external CSS file can be linked to the html - page. In case one does not want to customize the html - output, an internal CSS style is used. In that case, the following + page. In that case, the following xml element can be nested into the <code><layout></code> element. <div class="source"><pre><layout> ... - <cssBuilder class="ch.qos.logback.core.helpers.CssBuilder"> + <cssBuilder class="ch.qos.logback.core.html.UrlCssBuilder"> <param name="url" value="path_to_StyleFile.css" /> </cssBuilder> ... </layout></pre></div> + + In case one does not want to customize the html + output, an internal CSS style is used. The <code>HTMLLayout</code> is often, although not necessarily used in conjunction with @@ -1261,23 +1259,23 @@ </root> </configuration></pre></div> - When <code>HTMLLayout</code> is used with any <code>FileAppender</code>, - one can specify the html page's title, simply by adding an element to the configuration, - as shown above: + <code>HTMLLayout</code> can also be used with any <code>FileAppender</code>. In that + case, one can specify a rolling policy to archive log messages automatically. + One real world example could use the configuration below. <div class="source"><pre><configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <ActiveFileName>lastLogEntries.html</ActiveFileName> - <FileNamePattern>lastLogEntries.%d{yyyy-MM-dd}.log</FileNamePattern> + <FileNamePattern>logEntries.%d{yyyy-MM-dd}.log</FileNamePattern> </rollingPolicy> <layout class="ch.qos.logback.classic.html.HTMLLayout"> - <cssBuilder class="ch.qos.logback.core.helpers.CssBuilder"> - <param name="url" value="path_to_StyleFile.css" /> + <cssBuilder class="ch.qos.logback.core.html.UrlCssBuilder"> + <url>address_of_a_custom_stylesheet.css</url> </cssBuilder> <Pattern>%relative%thread%mdc%level%logger%msg</Pattern> - <Title>Last Logging Events</Title> + <Title>Logging Events</Title> </layout> </appender>

1 0

svn commit: r772 - logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay
by noreply.ceki＠qos.ch 25 Oct '06

25 Oct '06

Author: ceki Date: Wed Oct 25 14:54:12 2006 New Revision: 772 Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java Log: minor change Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java Wed Oct 25 14:54:12 2006 @@ -8,7 +8,6 @@ import junit.framework.TestSuite; import ch.qos.logback.core.joran.action.Action; import ch.qos.logback.core.joran.action.NOPAction; -import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.Constants; import ch.qos.logback.core.util.StatusPrinter;

1 0

svn commit: r771 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action
by noreply.ceki＠qos.ch 25 Oct '06

25 Oct '06

Author: ceki Date: Wed Oct 25 14:49:45 2006 New Revision: 771 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java Log: commented out System.out.println statement Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java Wed Oct 25 14:49:45 2006 @@ -81,7 +81,7 @@ public void body(InterpretationContext ec, String body) { String finalBody = ec.subst(body); - System.out.println("body "+body+", finalBody="+finalBody); + //System.out.println("body "+body+", finalBody="+finalBody); // get the action data object pushed in isApplicable() method call ImplicitActionData actionData = (ImplicitActionData) actionDataStack.peek(); actionData.parentBean.setProperty(actionData.propertyName, finalBody);

1 0

svn commit: r770 - in logback/trunk: logback-access/src/main/java/ch/qos/logback/access/html logback-classic/src/main/java/ch/qos/logback/classic/html
by noreply.seb＠qos.ch 25 Oct '06

25 Oct '06

Author: seb Date: Wed Oct 25 11:35:26 2006 New Revision: 770 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/html/HTMLLayout.java logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Log: html layouts now instanciante a default css builder in their constructor. temporary situation before classic and access modules have their own default css builder Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/html/HTMLLayout.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/html/HTMLLayout.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/html/HTMLLayout.java Wed Oct 25 11:35:26 2006 @@ -15,6 +15,7 @@ import ch.qos.logback.access.AccessLayout; import ch.qos.logback.access.PatternLayout; import ch.qos.logback.access.spi.AccessEvent; +import ch.qos.logback.core.html.DefaultCssBuilder; import ch.qos.logback.core.html.HTMLLayoutBase; import ch.qos.logback.core.html.NOPThrowableRenderer; import ch.qos.logback.core.pattern.Converter; @@ -50,6 +51,7 @@ public HTMLLayout() { pattern = DEFAULT_CONVERSION_PATTERN; throwableRenderer = new NOPThrowableRenderer(); + cssBuilder = new DefaultCssBuilder(); } @Override Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Wed Oct 25 11:35:26 2006 @@ -15,6 +15,7 @@ import ch.qos.logback.classic.ClassicLayout; import ch.qos.logback.classic.PatternLayout; import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.html.DefaultCssBuilder; import ch.qos.logback.core.html.HTMLLayoutBase; import ch.qos.logback.core.pattern.Converter; @@ -48,6 +49,7 @@ public HTMLLayout() { pattern = DEFAULT_CONVERSION_PATTERN; throwableRenderer = new DefaultThrowableRenderer(); + cssBuilder = new DefaultCssBuilder(); } protected Map<String, String> getDefaultConverterMap() {

1 0

svn commit: r769 - in logback/trunk: logback-classic/examples/src/chapter5 logback-site/src/site/xdocTemplates/manual
by noreply.seb＠qos.ch 25 Oct '06

25 Oct '06

Author: seb Date: Wed Oct 25 11:34:32 2006 New Revision: 769 Modified: logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout2.java logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig2.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml Log: updated docs Modified: logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout2.java ============================================================================== --- logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout2.java (original) +++ logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout2.java Wed Oct 25 11:34:32 2006 @@ -13,8 +13,8 @@ this.prefix = prefix; } - public void setPrintThreadName(String printThreadName) { - this.printThreadName = printThreadName.equals("true"); + public void setPrintThreadName(boolean printThreadName) { + this.printThreadName = printThreadName; } public String doLayout(LoggingEvent event) { Modified: logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig2.xml ============================================================================== --- logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig2.xml (original) +++ logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig2.xml Wed Oct 25 11:34:32 2006 @@ -3,7 +3,7 @@ <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <layout class="chapter5.MySampleLayout2"> - <prefix>MyContext</prefix> + <prefix>MyPrefix</prefix> <printThreadName>false</printThreadName> </layout> </appender> Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml Wed Oct 25 11:34:32 2006 @@ -81,13 +81,10 @@ Logback classic only processes events of type <code>ch.qos.logback.classic.LoggingEvent</code>. - Therefore, classic extends <code>Layout</code> - to accept only <code>LoggingEvent</code> objects. - - - - The extending interface is called - <code>ClassicLayout</code>, as shown below. + Therefore, logback classic module imposes that + all its layouts implement + the <code>ClassicLayout</code> interface that is + shown below. <div class="source"><pre>public interface ClassicLayout extends Layout { @@ -132,7 +129,7 @@ sbuf.append(LINE_SEP); return sbuf.toString(); } - + //method declared in ch.qos.logback.core.Layout interface public String doLayout(Object event) { return doLayout((LoggingEvent)event); } @@ -153,7 +150,7 @@ interface, since it is intented to be used with the classic module. Therefore, it offers a trivial implementation of the <code>doLayout(Object event)</code> method, that only casts the event - in the right type and passes it to the method where the actual formatting + to the right type and passes it to the method where the actual formatting takes place. The marginally more interesting <code>doLayout(LoggingEvent event)</code> @@ -164,7 +161,7 @@ build the message in its proper form. - In the previous listing of the <code>Layout</code> class, + In the above listing of the <code>Layout</code> class, we had omitted the class static <code>LINE_SEP</code> field which is simply assigned the value returned by <code>System.getProperty("line.separator")</code> @@ -173,9 +170,9 @@ a String. - The format method ignores any eventual exceptions contained - in the event, leaving the task of handling throwables to the - containing appender. + The <code>doLayout</code> method ignores any eventual exceptions contained + in the event. In a real world layout implementation, you would probably not want + to silently ignore exceptions. Custom layouts are configured as any other layout, as shown below: @@ -213,7 +210,88 @@ The reader shall find a slightly modified version of our custom layout in <code>MySampleLayout2.java</code>. She will discover that adding an option to a layout is as simple as declaring a setter method for the option. - See also chapter5/sampleLayoutConfig2.xml for a configuration example. + + + The + <code>MySampleLayout2</code> + class contains two attributes. The first one is a prefix that + can be added to the output. The second attribute is used to + choose wether to display the name of the thread from which + the logging request was sent. + + Here is the implementation of this class: +<div class="source"><pre>package chapter5; + +import ch.qos.logback.classic.ClassicLayout; +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.LayoutBase; + +public class MySampleLayout2 extends LayoutBase implements ClassicLayout { + + String prefix = null; + boolean printThreadName = true; + + public void setPrefix(String prefix) { + this.prefix = prefix; + } + + public void setPrintThreadName(boolean printThreadName) { + this.printThreadName = printThreadName; + } + + public String doLayout(LoggingEvent event) { + StringBuffer sbuf = new StringBuffer(128); + if (prefix != null) { + sbuf.append(prefix + ": "); + } + sbuf.append(event.getTimeStamp() - LoggingEvent.getStartTime()); + sbuf.append(" "); + sbuf.append(event.getLevel()); + if (printThreadName) { + sbuf.append(" ["); + sbuf.append(event.getThreadName()); + sbuf.append("] "); + } else { + sbuf.append(" "); + } + sbuf.append(event.getLoggerRemoteView().getName()); + sbuf.append(" - "); + sbuf.append(event.getFormattedMessage()); + sbuf.append(LINE_SEP); + return sbuf.toString(); + } + + public String doLayout(Object event) { + return doLayout((LoggingEvent) event); + } +}</pre></div> + + Appart from the actual use of the two attributes, in the <code>doLayout</code> method, + the two setter methods are the only addition to the original class. Yet, it is sufficient + to allow the user to configure these attributes, as shown in the configuration file below: + +<div class="source"><pre>%lt;configuration> + + %lt;appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + %lt;layout class="chapter5.MySampleLayout2"> + %lt;prefix>MyPrefix%lt;/prefix> + %lt;printThreadName>false%lt;/printThreadName> + %lt;/layout> + %lt;/appender> + + %lt;root> + %lt;level value="debug" /> + %lt;appender-ref ref="STDOUT" /> + %lt;/root> +%lt;/configuration></pre></div> + + + Note that the <code>PrintThreadName</code> attribute is a boolean + and not a <code>String</code>. It can be configured anyway by writing true + of false in the configuration file. + + <a name="AccessPatternLayout" /> <h3>PatternLayout</h3> @@ -226,7 +304,7 @@ <code>PatternLayout</code> takes a logging event and returns a String. However, the - returned String can be modified at will by tweaking its + returned String can be customized at will by tweaking its conversion pattern. @@ -250,7 +328,15 @@ Example 5.1: Sample usage of a PatternLayout (examples/chapter5/PatternSample.java) - <div class="source"><pre>public class PatternSample { + <div class="source"><pre>package chapter5; + +import org.slf4j.LoggerFactory; + +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.PatternLayout; +import ch.qos.logback.core.ConsoleAppender; + +public class PatternSample { static public void main(String[] args) throws Exception { Logger rootLogger = (Logger) @@ -317,7 +403,8 @@ <td> - Used to output the logger name of the logging event. + Used to output the name of the logger at the + source of the logging event. The logger name conversion word can take an @@ -326,7 +413,7 @@ without significant loss of meaning. - The next table should clear things up. + The next table should clarify the matter. <table BORDER="1" CELLPADDING="8"> <tr> @@ -377,7 +464,7 @@ the caller issuing the logging request. - Just like the logger conversion word, this + Just like the %logger conversion word above, this word can take an interger as it's first option and use its abbreviation algorithm to shorten the class name. @@ -405,11 +492,11 @@ The option admits the same syntax as the time pattern string of the <code>java.text.SimpleDateFormat</code>. A shortcut to the ISO8601 format is available by - specifying ISO8601 in the braces. If no option is set, - the converter uses ISO8601 as a default value. + specifying the String "ISO8601" in the braces. If no option is set, + the converter uses "ISO8601" as the default value. Here are some sample option values. They assume that the actual date is Friday 20th of October, 2006 and that - the reader finished her meal a short while ago. + the author finished his meal a short while ago. <table BORDER="1" CELLPADDING="8"> <tr> @@ -456,7 +543,8 @@ <tr> <td align="center"> - caller + caller{depth} + caller{depth, evaluator-1, ... evaluator-n} </td> <td> @@ -493,9 +581,7 @@ against a given criteria before creating the output. For example, using %caller{3, CALLER_DISPLAY_EVAL} will display three lines of stacktrace, only if the evaluator called CALLER_DISPLAY_EVAL - returns a positive answer. - This behaviour is justified by the fact that displaying - caller data is rather expensive, and one should generally not want to display it. + returns a positive answer. Evaluators are described further down this document. @@ -646,6 +732,8 @@ <td align="center"> ex{length} throwable{length} + ex{length, evaluator-1, ..., evaluator-n} + throwable{length, evaluator-1, ..., evaluator-n} </td> <td> @@ -655,7 +743,7 @@ will be output. The throwable conversion word can followed by one of - the following options:$ + the following options: <ul> short: prints the first line of the stack trace @@ -702,9 +790,7 @@ against a given criteria before creating the output. For example, using %ex{full, EX_DISPLAY_EVAL} will display the full stacktrace of the exception, only if the evaluator called EX_DISPLAY_EVAL - returns a negative answer. This behaviour is justified by the fact that - throwable data is generally displayed unless the evaluator would - return a positive value. Evaluators are described + returns a negative answer. Evaluators are described further down this document. </td> @@ -738,7 +824,7 @@ minimum field width modifier. This is a decimal constant that represents the minimum number of characters to output. If the data item - requires fewer characters, it is padded on either the left + contains fewer characters, it is padded on either the left or the right until the minimum width is reached. The default is to pad on the left (right justify) but you can specify right padding with the left justification flag. The padding @@ -829,7 +915,7 @@ Right pad with spaces if the logger name is shorter than 20 characters. However, if logger name is longer than 30 characters, then truncate from the - beginning. + beginning. </td> </tr> <tr> @@ -838,7 +924,7 @@ <td align="center">none</td> <td align="center">30</td> <td> - Truncate from the end if the logger name is + Truncate from the end if the logger name is longer than 30 characters. </td> </tr> @@ -882,9 +968,9 @@ example, the MDC conversion specifier: %mdc{someKey}. - A conversion specifier might use more that one options. For example, + A conversion specifier might have more than one options. For example, a conversion specifier that uses evaluators, which we will cover very soon, - simply adds the evaluator names to the options list, as shown above + simply adds the evaluator names to the option list, as shown below: <div class="source"><pre> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> @@ -899,22 +985,21 @@ <h4>Evaluators</h4> - Another very useful way of adding options to a conversion + Another use case for adding options to a conversion specifier is when <code>PatternLayout</code> is used with - <code>EventEvaluators</code> - . + <code>EventEvaluator</code> objects. - <code>EventEvaluators</code> + <code>EventEvaluator</code> objects have the responsability to check wether a given event matches a given criteria. Let's look at an example using - <code>EventEvaluators</code> - . The following configuration file outputs the logging + <code>EventEvaluator</code> objects. + The following configuration file outputs the logging events to the console, displaying date, thread, level, message and caller data. @@ -923,7 +1008,7 @@ expensive, this information will be displayed only when the logging request comes from a specific logger, and whose message contains a certain string. By doing that, we make - sure that only the most important logging requests will have + sure that only the specific logging requests will have their caller information generated and displayed, without penalizing application performance. @@ -955,8 +1040,8 @@ </root> </configuration></pre></div> Please note that the & value cannot be written like one would do in a java - class, because of XML format encoding. - Let's test this configuration with the following code. + class, because of XML encoding rules. + Let us test this configuration with the following code. Example 5.2: Sample usage of EventEvaluators (examples/chapter5/EventEvaluatorExample.java) @@ -986,13 +1071,13 @@ } }</pre></div> - This excerpt does nothing very fancy. Five logging requests + This excerpt does nothing too fancy. Five logging requests are issued, the third one being different from the others. When a logging request is sent, the corresponding logging - event will pass through the evaluation process. Here, - obviously, the third request will match the evaluation, + event will pass through the evaluation process. Here, + the third request will match the evaluation, causing its caller data to be displayed. @@ -1003,8 +1088,8 @@ <div class="source"><pre>0 [main] DEBUG - logging statement0 0 [main] DEBUG - logging statement1 0 [main] DEBUG - logging statement2 -0 [main] DEBUG - stacktrace logging statement3 Caller+0 \ - at chapter5.CallerEvaluatorExample.main(CallerEvaluatorExample.java:28) +0 [main] DEBUG - stacktrace logging statement3 +Caller+0 at chapter5.CallerEvaluatorExample.main(CallerEvaluatorExample.java:28) 0 [main] DEBUG - logging statement4</pre></div> @@ -1018,13 +1103,13 @@ Important: With the caller conversion specifier, the data is displayed when the expression evaluates to true. - Let's look at a different situation. When exceptions are - added to a logging request, they are usually displayed. However, in some cases, - one might want some exceptions never to be displayed. - - The java code shown below is creating five log requests, each one - with an exception. However, we do not want request number 3 to display - its exception in the logging output. + Let us look at a different situation. When exceptions are included in + a logging request, their stack trace is usually displayed. However, in some cases, + one might want to supress the stack trace of specific exception. + + The java code shown below creates five log requests, each one + with an exception. However, we do not want to have the stack trace of the + third request to be output. <div class="source"><pre>public class ExceptionEvaluatorExample { @@ -1081,11 +1166,9 @@ With this configuration, each time an instance of the chapter5.TestException - will be associated with a logging request containing an - exception, no information will be displayed about the - exception. + is included within a logging request, no stack trace will be displayed. - Important: With the ex conversion specifier, the data is + Important: With the %ex conversion specifier, the data is displayed when the expression evaluates to false. <a name="ClassicHTMLLayout"/> @@ -1100,22 +1183,27 @@ The content of the table columns are specified using a conversion pattern. See <code>PatternLayout</code> for documentation on - the available patterns. This ensure that the user has full access to the creation + the available patterns. This ensures that the user has full control over the creation of the html table. One can choose to display any (or all) data that <code>PatternLayout</code> can provide. One notable point about the use of <code>PatternLayout</code> with <code>HTMLLayout</code> - is that conversion specifiers should not be separated by a space. Each specifier found in the - pattern will result in a separate column, meaning that spaces will create empty columns. + is that conversion specifiers should not be separated by a space or in general + any literals. Each specifier found in the + pattern will result in a separate column, meaning that each literal will create + an extra column. The pattern %ex used to display an Exception is not the only way to display an Exception with this layout. If you use this pattern, a table column will be created to display the potential - Exception's stacktrace. + Exception's stacktrace. That means that, in most cases, the column + will be empty, and will take quite a lot of space when displaying + an exception's stack trace. - However, a better solution is available in the form of + Since printing a stack trace on a separate column is not very readable, + a better solution is available in the form of implementations of the <code>IThrowableRenderer</code> interface. These implementations can be called and assigned to HTMLLayout to manage the display of anything related to @@ -1123,13 +1211,13 @@ By default, a <code>DefaultThrowableRenderer</code> is - assigned to the HTMLLayout. It writes the Exception on a new - table row, along with its stacktrace, in a easily readable - manner. + assigned to the HTMLLayout. It writes the Exception on a new + table row, along with its stacktrace, in a easily readable + manner, like presented in the picture above. If one wants to use the - &ex + %ex pattern anyway, then a <code>NOPThrowableRenderer</code> can be specified in the configuration file. @@ -1148,21 +1236,19 @@ </layout></pre></div> - The <code>HTMLLayout</code> is often used in conjunction with - <code>SMTPAppender</code>, to send a nicely formatted html email. Of - course, it can be used with any other Appender. + The <code>HTMLLayout</code> is often, although not necessarily used in conjunction with + <code>SMTPAppender</code>, to send a nicely formatted html email. When one wants to use the <code>HTMLLayout</code> with a <code>SMTPAppender</code>, - the following configuration is typically used. + the following configuration would be typical. <div class="source"><pre><configuration> <appender name="SMTP" class="ch.qos.logback.classic.net.SMTPAppender"> <layout class="ch.qos.logback.classic.html.HTMLLayout"> <param name="pattern" value="%relative%thread%mdc%level%class%msg" /> </layout> - <throwableRenderer class="ch.qos.logback.classic.html.DefaultThrowableRenderer" /> <param name="From" value="sender.email(a)domain.net" /> <param name="SMTPHost" value="mail.domain.net" /> <param name="Subject" value="LastEvent: %class - %msg" /> @@ -1174,13 +1260,7 @@ <appender-ref ref="SMTP" /> </root> </configuration></pre></div> - - In this configuration file, the - throwableRenderer - element specifies the default implementation of - IThrowableRenderer. It could be omitted, but is showed for - educationnal purposes. - + When <code>HTMLLayout</code> is used with any <code>FileAppender</code>, one can specify the html page's title, simply by adding an element to the configuration, as shown above: @@ -1208,9 +1288,9 @@ </configuration></pre></div> <h2>Logback access</h2> - Just like <code>ClassicLayout</code> represents the <code>Layout</code> interface - for the classic module, the <code>AccessLayout</code> exists for the access module. It's - implementation is very straight-forward. + Just like <code>ClassicLayout</code> restricts the possible <code>Layout</code> classes + for the classic module, the <code>AccessLayout</code> imposes a structure for <code>Layout</code> objects + in the access module. It is reproduced below. <div class="source"><pre>public interface AccessLayout extends Layout { @@ -1218,14 +1298,14 @@ }</pre></div> - Many access layouts are actually adaptations of classic layouts. Logback - modules classic and access address pretty different needs, but offer the same power - and flexibility to the user. + Many access layouts are mere adaptations of classic layouts. Logback + classic and access modules address different needs, but offer comparable power + and flexibility. <h3>Writing your own Layout</h3> - Writing a custom <code>Layout</code> for logback access works almost exactly the - same as writing such a component for the classic module. - The only exceptions comes from the fact that layouts in access module imlement + Writing a custom <code>Layout</code> for logback access is nearly identical + as to writing a <code>Layout</code> for the classic module. + The only difference comes from the fact that access layouts must implement the <code>AccessLayout</code> interface instead <code>ClassicLayout</code>. <a name="AccessPatternLayout" />

1 0

svn commit: r768 - logback/trunk/logback-access/src/main/java/ch/qos/logback/access/tomcat
by noreply.ceki＠qos.ch 24 Oct '06

24 Oct '06

Author: ceki Date: Tue Oct 24 23:01:00 2006 New Revision: 768 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/tomcat/LogbackValve.java Log: in logback-acess the default config file is logback-access.xml Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/tomcat/LogbackValve.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/tomcat/LogbackValve.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/tomcat/LogbackValve.java Tue Oct 24 23:01:00 2006 @@ -40,11 +40,11 @@ * <Valve className="ch.qos.logback.access.tomcat.LogbackValve"/> * * By default, LogbackValve looks for a logback configuration file called - * logback.xml, in the same folder where the tomcat configuration is located, - * that is /conf/logback.xml. The logback.xml file is slightly different than - * the usual logback classic configuration file. Most of it is the same: - * Appenders and Layouts are declared the exact same way. However, loggers - * elements are not allowed. + * logback-access.xml, in the same folder where the tomcat configuration is located, + * that is $TOMCAT_HOME/conf/logback-access.xml. The format of logback-access configuration file + * is only slightly different than for logback-classic. Most of it remains the same: + * Appenders and Layouts are declared the same way. However, since logback-access has + * no notion of declared loggers, logger elements are not allowed. * * Here is a sample logback.xml file that can be used right away: * @@ -77,7 +77,7 @@ AppenderAttachable { public final static String DEFAULT_CONFIG_FILE = "conf" + File.separatorChar - + "logback.xml"; + + "logback-access.xml"; // Attributes from ContextBase: private String name;

1 0

svn commit: r767 - logback/trunk/logback-site/src/site/resources/images
by noreply.ceki＠qos.ch 24 Oct '06

24 Oct '06

Author: ceki Date: Tue Oct 24 21:45:59 2006 New Revision: 767 Added: logback/trunk/logback-site/src/site/resources/images/ logback/trunk/logback-site/src/site/resources/images/hortisMG.ai logback/trunk/logback-site/src/site/resources/images/hortisMG.gif (contents, props changed) Log: missing images Added: logback/trunk/logback-site/src/site/resources/images/hortisMG.ai ============================================================================== Files (empty file) and logback/trunk/logback-site/src/site/resources/images/hortisMG.ai Tue Oct 24 21:45:59 2006 differ Added: logback/trunk/logback-site/src/site/resources/images/hortisMG.gif ============================================================================== Binary file. No diff available.

1 0

svn commit: r766 - in logback/trunk/logback-core/src/main/java/ch/qos/logback/core: helpers html rolling
by noreply.seb＠qos.ch 24 Oct '06

24 Oct '06

Author: seb Date: Tue Oct 24 20:50:34 2006 New Revision: 766 Added: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/CssBuilder.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/DefaultCssBuilder.java - copied, changed from r764, /logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/DefaultCssBuilder.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/UrlCssBuilder.java Removed: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/DefaultCssBuilder.java Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/HTMLLayoutBase.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java Log: -- refactoring of css builder - started work on merging activeFileName and FileName Added: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/CssBuilder.java ============================================================================== --- (empty file) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/CssBuilder.java Tue Oct 24 20:50:34 2006 @@ -0,0 +1,7 @@ +package ch.qos.logback.core.html; + +public interface CssBuilder { + + public void addCss(StringBuffer sbuf); + +} Copied: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/DefaultCssBuilder.java (from r764, /logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/DefaultCssBuilder.java) ============================================================================== --- /logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/DefaultCssBuilder.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/DefaultCssBuilder.java Tue Oct 24 20:50:34 2006 @@ -7,75 +7,65 @@ * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ -package ch.qos.logback.core.helpers; +package ch.qos.logback.core.html; import static ch.qos.logback.core.Layout.LINE_SEP; /** - * This class helps the HTMLLayout build the CSS link. - * It either provides the HTMLLayout with a default css file, - * or builds the link to an external, user-specified, file. - * + * This class helps the HTMLLayout build the CSS link. It either provides the + * HTMLLayout with a default css file, or builds the link to an external, + * user-specified, file. + * * @author Sébastien Pennec */ -public class DefaultCssBuilder { +public class DefaultCssBuilder implements CssBuilder { - String url; - - public DefaultCssBuilder() { + public DefaultCssBuilder() { } - - public String getUrl() { - return url; - } - - public void setUrl(String url) { - this.url = url; - } - - public void addExternalCSS(StringBuffer sbuf) { - sbuf.append("<LINK REL=StyleSheet HREF=\""); - sbuf.append(url); - sbuf.append("\" TITLE=\"Basic\" />"); - } - - public static void addDefaultCSS(StringBuffer buf) { - buf.append("<STYLE type=\"text/css\">"); - buf.append(LINE_SEP); - buf.append("table { margin-left: 2em; margin-right: 2em; border-left: 2px solid #AAA; }"); - buf.append(LINE_SEP); - - buf.append("TR.even { background: #FFFFFF; }"); - buf.append(LINE_SEP); - - buf.append("TR.odd { background: #EAEAEA; }"); - buf.append(LINE_SEP); - - buf.append("TR.warn TD.Level, TR.error TD.Level, TR.fatal TD.Level {font-weight: bold; color: #FF4040 }"); - buf.append(LINE_SEP); - - buf.append("TD { padding-right: 1ex; padding-left: 1ex; border-right: 2px solid #AAA; }"); - buf.append(LINE_SEP); - - buf.append("TD.Time, TD.Date { text-align: right; font-family: courier, monospace; font-size: smaller; }"); - buf.append(LINE_SEP); - - buf.append("TD.Thread { text-align: left; }"); - buf.append(LINE_SEP); - - buf.append("TD.Level { text-align: right; }"); - buf.append(LINE_SEP); - - buf.append("TD.Logger { text-align: left; }"); - buf.append(LINE_SEP); - - buf.append("TR.header { background: #596ED5; color: #FFF; font-weight: bold; font-size: larger; }"); - buf.append(LINE_SEP); - buf.append("TD.Exception { background: #A2AEE8; font-family: courier, monospace;}"); - buf.append(LINE_SEP); + public void addCss(StringBuffer sbuf) { + sbuf.append("<STYLE type=\"text/css\">"); + sbuf.append(LINE_SEP); + sbuf + .append("table { margin-left: 2em; margin-right: 2em; border-left: 2px solid #AAA; }"); + sbuf.append(LINE_SEP); + + sbuf.append("TR.even { background: #FFFFFF; }"); + sbuf.append(LINE_SEP); + + sbuf.append("TR.odd { background: #EAEAEA; }"); + sbuf.append(LINE_SEP); + + sbuf + .append("TR.warn TD.Level, TR.error TD.Level, TR.fatal TD.Level {font-weight: bold; color: #FF4040 }"); + sbuf.append(LINE_SEP); + + sbuf + .append("TD { padding-right: 1ex; padding-left: 1ex; border-right: 2px solid #AAA; }"); + sbuf.append(LINE_SEP); + + sbuf + .append("TD.Time, TD.Date { text-align: right; font-family: courier, monospace; font-size: smaller; }"); + sbuf.append(LINE_SEP); + + sbuf.append("TD.Thread { text-align: left; }"); + sbuf.append(LINE_SEP); + + sbuf.append("TD.Level { text-align: right; }"); + sbuf.append(LINE_SEP); + + sbuf.append("TD.Logger { text-align: left; }"); + sbuf.append(LINE_SEP); + + sbuf + .append("TR.header { background: #596ED5; color: #FFF; font-weight: bold; font-size: larger; }"); + sbuf.append(LINE_SEP); + + sbuf + .append("TD.Exception { background: #A2AEE8; font-family: courier, monospace;}"); + sbuf.append(LINE_SEP); - buf.append("</STYLE>"); - buf.append(LINE_SEP); + sbuf.append("</STYLE>"); + sbuf.append(LINE_SEP); } } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/HTMLLayoutBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/HTMLLayoutBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/HTMLLayoutBase.java Tue Oct 24 20:50:34 2006 @@ -3,7 +3,6 @@ import java.util.Map; import ch.qos.logback.core.LayoutBase; -import ch.qos.logback.core.helpers.CssBuilder; import ch.qos.logback.core.pattern.Converter; import ch.qos.logback.core.pattern.DynamicConverter; import ch.qos.logback.core.pattern.parser.Node; @@ -23,6 +22,8 @@ protected String title = "Logback Log Messages"; + //It is the responsability of derived classes to set + //this variable in their constructor to a default value. protected CssBuilder cssBuilder; protected IThrowableRenderer throwableRenderer; //no more initialization ?????? @@ -131,11 +132,13 @@ sbuf.append(title); sbuf.append("</title>"); sbuf.append(LINE_SEP); - if (cssBuilder == null) { - CssBuilder.addDefaultCSS(sbuf); - } else { - cssBuilder.addExternalCSS(sbuf); - } + + cssBuilder.addCss(sbuf); +// if (cssBuilder == null) { +// DefaultCssBuilder.addDefaultCSS(sbuf); +// } else { +// cssBuilder.addExternalCSS(sbuf); +// } sbuf.append(LINE_SEP); sbuf.append("</head>"); sbuf.append(LINE_SEP); Added: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/UrlCssBuilder.java ============================================================================== --- (empty file) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/html/UrlCssBuilder.java Tue Oct 24 20:50:34 2006 @@ -0,0 +1,40 @@ +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ +package ch.qos.logback.core.html; + + +/** + * This class helps the HTMLLayout build the CSS link. + * It either provides the HTMLLayout with a default css file, + * or builds the link to an external, user-specified, file. + * + * @author Sébastien Pennec + */ +public class UrlCssBuilder implements CssBuilder { + + String url = "http://logback.qos.ch/css/classic.css"; + + public UrlCssBuilder() { + } + + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + public void addCss(StringBuffer sbuf) { + sbuf.append("<LINK REL=StyleSheet HREF=\""); + sbuf.append(url); + sbuf.append("\" TITLE=\"Basic\" />"); + } +} Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java Tue Oct 24 20:50:34 2006 @@ -83,8 +83,12 @@ // the activeFile variable is used by the triggeringPolicy.isTriggeringEvent method activeFileCache = new File(afn); addInfo("Active log file name: "+afn); - setFile(afn); + // The local setFile throws an exception, so we use the parent's version. + // This is to prevent the user from configuring both the RollingFileAppender with + // an activeFileName _and_ the FileAppender's file attribute, causing confusion + // on the attributes' uses. + super.setFile(afn); super.start(); } else { addWarn("No RollingPolicy was set for the RollingFileAppender named "+ getName()); @@ -185,4 +189,10 @@ rollingPolicy = (RollingPolicy) policy; } } + + @Override + public void setFile(String filename) { + throw new UnsupportedOperationException("With RollingFileAppender please use activeFileName " + + "option instead of File"); + } } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java Tue Oct 24 20:50:34 2006 @@ -26,6 +26,11 @@ protected int compressionMode = Compress.NONE; protected FileNamePattern fileNamePattern; protected String fileNamePatternStr; + /* + * It would have been nice to merge 'activeFileName' into filename of + * FileAppender. Unfortunately, a child component must be self contained + * as it is started before its parent. + */ protected String activeFileName = null; private boolean started;

1 0