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

svn commit: r668 - logback/trunk/logback-site/src/site
by noreply.ceki＠qos.ch 12 Oct '06

12 Oct '06

Author: ceki Date: Thu Oct 12 13:39:06 2006 New Revision: 668 Modified: logback/trunk/logback-site/src/site/site.xml Log: reference correct skin version Modified: logback/trunk/logback-site/src/site/site.xml ============================================================================== --- logback/trunk/logback-site/src/site/site.xml (original) +++ logback/trunk/logback-site/src/site/site.xml Thu Oct 12 13:39:06 2006 @@ -4,7 +4,7 @@ <skin> <groupId>ch.qos.logback</groupId> <artifactId>logback-skin</artifactId> - <version>0.4-SNAPSHOT</version> + <version>0.5-SNAPSHOT</version> </skin> <publishDate position="navigation-bottom" format="dd-MM-yyyy"/>

1 0

svn commit: r667 - in logback/trunk: logback-access logback-classic logback-core logback-site logback-skin
by noreply.seb＠qos.ch 11 Oct '06

11 Oct '06

Author: seb Date: Wed Oct 11 17:26:49 2006 New Revision: 667 Modified: logback/trunk/logback-access/ (props changed) logback/trunk/logback-classic/ (props changed) logback/trunk/logback-core/ (props changed) logback/trunk/logback-site/ (props changed) logback/trunk/logback-skin/ (props changed) Log:

1 0

svn commit: r666 - in logback/trunk: . logback-classic/examples/src/chapter5 logback-classic/src/main/java/ch/qos/logback/classic logback-classic/src/main/java/org/slf4j logback-site/src/site/xdocTemplates
by noreply.seb＠qos.ch 11 Oct '06

11 Oct '06

Author: seb Date: Wed Oct 11 17:26:04 2006 New Revision: 666 Added: logback/trunk/logback-classic/examples/src/chapter5/ logback/trunk/logback-classic/examples/src/chapter5/PatternSample.java logback/trunk/logback-site/src/site/xdocTemplates/layouts.xml Modified: logback/trunk/ (props changed) logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java logback/trunk/logback-classic/src/main/java/org/slf4j/LoggerFactory.java logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml logback/trunk/logback-site/src/site/xdocTemplates/joran.xml Log: - corrected javadoc in PatternLayout.java - supressed call to system.out in LoggerFactory - added keyword option in accessLogJetty.xml - added link to layouts.xml in documentation.xml - added a first working copy of layouts.xml Added: logback/trunk/logback-classic/examples/src/chapter5/PatternSample.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/examples/src/chapter5/PatternSample.java Wed Oct 11 17:26:04 2006 @@ -0,0 +1,28 @@ +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) LoggerFactory.getLogger("root"); + + PatternLayout layout = new PatternLayout(); + layout.setPattern("%-5level [%thread]: %message%n"); + layout.start(); + + ConsoleAppender appender = new ConsoleAppender(); + appender.setContext(rootLogger.getLoggerContext()); + appender.setLayout(layout); + appender.start(); + + rootLogger.addAppender(appender); + + rootLogger.debug("Message 1"); + rootLogger.warn("Message 2"); + } +} \ No newline at end of file Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java Wed Oct 11 17:26:04 2006 @@ -104,7 +104,7 @@ * logger name is printed in full. * * - * For example, for the category name "a.b.c" the pattern %logger{2} + * For example, for the logger name "a.b.c" the pattern %logger{2} * will output "b.c". See more examples of name abbreviations further down this * document. * @@ -124,7 +124,7 @@ * name is output in fully qualified form. * * - * For example, for the class name "org.apache.xyz.SomeClass", the pattern + * For example, for the class name "ch.logback.xyz.SomeClass", the pattern * %class{1} will output "SomeClass". See more examples of name * abbreviations further down this document. * @@ -153,7 +153,7 @@ * * WARNING Generating caller file information is extremely slow. Its use * should be avoided unless execution speed is not an issue. - * + * </td> * </tr> * * <tr> @@ -184,7 +184,7 @@ * * WARNING Generating caller location information is extremely slow. * It's use should be avoided unless execution speed is not an issue. - * + * </td> * </tr> * * @@ -202,7 +202,7 @@ * * WARNING Generating caller location information is extremely slow. * It's use should be avoided unless execution speed is not an issue. - * + * </td> * </tr> * * <tr> @@ -215,7 +215,7 @@ * non-portable line separator strings such as "\n", or "\r\n". Thus, it is the * preferred way of specifying a line separator. * - * + * </td> * </tr> * * <tr> @@ -394,7 +394,7 @@ * characters and truncated if longer. * * </dl> - * Here are a few more examples of the format modifier behaviour, with emphasis on + * Here are a few more examples of the precision specifier behaviour, with emphasis on * the way it affects class names. * * Modified: logback/trunk/logback-classic/src/main/java/org/slf4j/LoggerFactory.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/org/slf4j/LoggerFactory.java (original) +++ logback/trunk/logback-classic/src/main/java/org/slf4j/LoggerFactory.java Wed Oct 11 17:26:04 2006 @@ -71,7 +71,6 @@ try { loggerFactory = StaticLoggerBinder.SINGLETON.getLoggerFactory(); URL url = Loader.getResource("logback-classic.xml"); - System.out.println("URL = " + url); if (url != null) { JoranConfigurator configurator = new JoranConfigurator(); configurator.setContext((Context)loggerFactory); Modified: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Wed Oct 11 17:26:04 2006 @@ -303,17 +303,16 @@ </tr> <tr> - <td align="center">reqParameter</td> + <td align="center">reqParameter{paramName}</td> <td> Parameter of the response. This conversion word can be followed by a key whose corresponding data will be extracted from the header information. - Example: %reqParameter{userName} </td> </tr> <tr> - <td align="center">i / header</td> + <td align="center">i{header} / header{header}</td> <td> Request header. Just like the reqParameter @@ -386,7 +385,7 @@ </td> </tr> <tr> - <td align="center">reqAttribute</td> + <td align="center">reqAttribute{attributeName}</td> <td> Attribute of the request. Just like the reqParameter @@ -395,7 +394,7 @@ </td> </tr> <tr> - <td align="center">reqCookie</td> + <td align="center">reqCookie{cookie}</td> <td> Request cookie. Just like the reqParameter @@ -404,7 +403,7 @@ </td> </tr> <tr> - <td align="center">responseHeader</td> + <td align="center">responseHeader{header}</td> <td> Header of the response. Just like the reqParameter Modified: logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml Wed Oct 11 17:26:04 2006 @@ -17,12 +17,15 @@ <li> <a href="shortIntro.html">A short introduction to logback-classic</a> </li> - <li> <a href="accessLogJetty.html">A short introduction to access logging with logback-access and Jetty</a> </li> <li> + <a href="layouts.html">Layout reference</a> + </li> + + <li> <a href="apidocs/index.html">Javadoc</a> </li> Modified: logback/trunk/logback-site/src/site/xdocTemplates/joran.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/joran.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/joran.xml Wed Oct 11 17:26:04 2006 @@ -21,7 +21,7 @@ Joran is actually a generic configuration system which can be used -independently of logging. To emphaises this point, I should mention +independently of logging. To emphaises this point, We should mention that the logback-core module does not have a notion of loggers. In that sprit, many of the examples related to this tutorial, have nothing to do with loggers, appenders or layouts. @@ -188,7 +188,7 @@  It creates a <code>RuleStore</code> and a <code>Context</code> It adds the hello-world pattern, with it's corresponding action - It creates a Joran interpreted, and passes the <code>RuleStore</code> + It creates a Joran interpreter, and passes the <code>RuleStore</code> It creates a SAX parser and parses the given file, specifying the newly created Joran interpreter as the <code>ContentHandler</code> </ul> Added: logback/trunk/logback-site/src/site/xdocTemplates/layouts.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-site/src/site/xdocTemplates/layouts.xml Wed Oct 11 17:26:04 2006 @@ -0,0 +1,614 @@ +<document> +  + + + <body> + <h2>Layouts</h2> + <div class="author"> + Authors: Ceki Gülcü, Sébastien Pennec + </div> + + + <table> + <tr> + <td valign="top" align="top"> + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-nd/2.5/"> + <img alt="Creative Commons License" border="0" + valign="top" align="top" + src="http://creativecommons.org/images/public/somerights20.png" /> + </a> + </td> + <td> + Copyright © 2000-2006, QOS.ch + + + This work is licensed under a + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-nd/2.5/"> + Creative Commons + Attribution-Noncommercial-No Derivative + Works 2.5 License + </a> + . + + </td> + </tr> + </table> + + <h2>What is a layout</h2> + + + While appenders are responsible for writing logging output + to an appender dependent device, layouts are responsible for + the format of the output. In case you were wondering, + lay-outs have nothing to do with large estates in Florida. + The + <code>format()</code> + method in the Layout class takes in a object that represents + the logging event and returns a String. A synopsis of the + Layout interface is shown below. + + <div class="source"> + public interface Layout extends ContextAware, LifeCycle { + + String doLayout(Object event); + + String getHeader(); + + String getFooter(); + + String getContentType(); + </div> + + This interface is really simple and yet is sufficent for + many formatting needs. + + +  + + <h2>Logback classic</h2> + + + As we've seen, a Layout implementation takes as a parameter + an object that represents a logging event. The typing of the + parameter to <code>Object</code> + is because logging events may have different way of being + designed. In logback classic, a logging event is represented + by the <code>ch.qos.logback.classic.LoggingEvent</code> + class. Therefore, all layouts in logback classic implement a + sub-interface of <code>Layout</code> named <code>ClassicLayout</code>. + + + + Here is what a + <code>ClassicLayout</code> + looks like: + + + <div class="source"> + public interface ClassicLayout extends Layout { + + String doLayout(LoggingEvent event); + + } + </div> + + <h3>PatternLayout</h3> + + + Logback ships with a flexible layout called <code>PatternLayout</code>. + As all layouts, <code>PatternLayout</code> + takes in a logging event and returns a String. However, the + returned String can be modified at will by tweaking its + conversion pattern. + + + The conversion pattern of <code>PatternLayout</code> + is closely related to the conversion pattern of the + <code>printf()</code> function in the C programming language. + A conversion pattern is composed of literal text and format + control expressions called conversion specifiers. + You are free to insert any literal text within the conversion pattern. + Each conversion specifier starts with a percent sign (%) and is followed by + optional format modifiers and a conversion character. The + conversion character controls the type of data to use, e.g. + logger name, level, date, thread name. The format modifiers + control such things as field width, padding, and left or + right justification. The following is a simple example. + +Example 5.1: Sample usage of a PatternLayout (examples/chapter5/PatternSample.java) +<div class="source">public class PatternSample { + + static public void main(String[] args) throws Exception { + Logger rootLogger = (Logger) LoggerFactory.getLogger("root"); + + PatternLayout layout = new PatternLayout(); + layout.setPattern("%-5level [%thread]: %message%n"); + layout.start(); + + ConsoleAppender appender = new ConsoleAppender(); + appender.setContext(rootLogger.getLoggerContext()); + appender.setLayout(layout); + appender.start(); + + rootLogger.addAppender(appender); + + rootLogger.debug("Message 1"); + rootLogger.warn("Message 2"); + } +}</div> + + + The conversion pattern is set to be "%-5level [%thread]: %message%n". + Running PatternSample will yield the following output on the console. + +<div class="source">DEBUG [main]: Message 1 +WARN [main]: Message 2</div> + + Note that in the conversion pattern "%-5level [%thread]: %message%n" + there is no explicit separator between literal text and conversion + specifiers. When parsing a conversion pattern, <code>PatternLayout</code> + is capable of differentiating between literal text (space characters, the brackets, + colon character) and conversion specifiers. In the example above, + the conversion specifier %-5level means the level of the logging event + should be left justified to a width of five characters. + Format specifiers will be explained in a short moment. + + + The recognized conversion characters and words are + + <table border="1" CELLPADDING="8"> + <th>Conversion Character or Word</th> + <th>Effect</th> + + <tr> + <td align="center"> + c / l / lo / logger + </td> + + <td> + + Used to output the logger of the logging event. + The logger conversion specifier can be + optionally followed by + precision specifier + , that is a decimal constant in brackets. + + + If a precision specifier is given, then only the + corresponding number of right most components of + the logger name will be printed. By default the + logger name is printed in full. + + + For example, for the category name "a.b.c" the + pattern + %logger{2} + will output "b.c". See more examples of name + abbreviations further down this document. + + </td> + </tr> + + <tr> + <td align="center"> + C / class + </td> + + <td> + + Used to output the fully qualified class name of + the caller issuing the logging request. This + conversion specifier can be optionally followed + by + precision specifier + , that is a decimal constant in brackets. + + + If a precision specifier is given, then only the + corresponding number of right most components of + the class name will be printed. By default the + class name is output in fully qualified form. + + + For example, for the class name + "ch.logback.xyz.SomeClass", the pattern + %class{1} + will output "SomeClass". See more examples of + name abbreviations further down this document. + + + WARNING + Generating the caller class information is slow. + Thus, it's use should be avoided unless + execution speed is not an issue. + + </td> + </tr> + + <tr> + <td align="center"> + d / date + </td> + <td> + Used to output the date of the logging event. The + date conversion specifier may be followed by a set + of braces containing a date and time pattern strings + {@link java.text.SimpleDateFormat}, + ABSOLUTE + , + DATE + or + ISO8601 + . For example, + %d{HH:mm:ss,SSS} + , + %d{dd MMM yyyy ;HH:mm:ss,SSS} + or + %d{DATE} + . If no date format specifier is given then ISO8601 + format is assumed. + </td> + </tr> + + <tr> + <td align="center"> + F / file + </td> + + <td> + + Used to output the file name where the logging + request was issued. + + + WARNING + Generating caller file information is extremely + slow. Its use should be avoided unless execution + speed is not an issue. + + </td> + </tr> + + <tr> + <td align="center"> + caller + </td> + + <td> + + Used to output location information of the + caller which generated the logging event. + + + The location information depends on the JVM + implementation but usually consists of the fully + qualified name of the calling method followed by + the caller's source the file name and line + number between parentheses. + + + The location information can be very useful. + However, it's generation is + extremely + slow. It's use should be avoided unless + execution speed is not an issue. + + </td> + </tr> + + <tr> + <td align="center"> + L / line + </td> + + <td> + + Used to output the line number from where the + logging request was issued. + + + WARNING + Generating caller location information is + extremely slow. It's use should be avoided + unless execution speed is not an issue. + + </td> + </tr> + + + <tr> + <td align="center"> + m / msg / message + </td> + <td> + Used to output the application supplied message + associated with the logging event. + </td> + </tr> + + <tr> + <td align="center"> + M / method + </td> + + <td> + + Used to output the method name where the logging + request was issued. + + + WARNING + Generating caller location information is + extremely slow. It's use should be avoided + unless execution speed is not an issue. + + </td> + </tr> + + <tr> + <td align="center"> + n + </td> + + <td> + + Outputs the platform dependent line separator + character or characters. + + + This conversion character offers practically the + same performance as using non-portable line + separator strings such as "\n", or "\r\n". Thus, + it is the preferred way of specifying a line + separator. + + </td> + + </tr> + + <tr> + <td align="center"> + p / le / level + </td> + <td>Used to output the level of the logging event.</td> + </tr> + + <tr> + + <td align="center"> + r / relative + </td> + + <td> + Used to output the number of milliseconds elapsed + since the start of the application until the + creation of the logging event. + </td> + </tr> + + + <tr> + <td align="center"> + t / thread + </td> + + <td> + Used to output the name of the thread that generated + the logging event. + </td> + + </tr> + + <tr> + <td align="center"> + X + </td> + + <td> + + + Used to output the MDC (mapped diagnostic + context) associated with the thread that + generated the logging event. The + X + conversion character can be followed by the key + for the map placed between braces, as in + %X{clientNumber} + where + <code>clientNumber</code> + is the key. The value in the MDC corresponding + to the key will be output. If no additional + sub-option is specified, then the entire + contents of the MDC key value pair set is output + using a format key1=val1, key2=val2 + + + + See + <a + href="http://logback.qos.ch/apidocs/ch/qos/logback/classic/MDC.html"> + MDC + </a> + class for more details. + + + </td> + </tr> + <tr> + <td align="center"> + throwable + </td> + + <td> + + Used to output the Throwable trace that has been + bound to the LoggingEvent, by default this will + output the full trace as one would normally find + by a call to Throwable.printStackTrace(). The + throwable conversion word can be followed by an + option in the form + %throwable{short} + which will only output the first line of the + ThrowableInformation. + + </td> + </tr> + + <tr> + + <td align="center"> + % + </td> + + <td>The sequence %% outputs a single percent sign.</td> + </tr> + + </table> + + By default the relevant information is output as is. + However, with the aid of format modifiers it is possible to + change the minimum field width, the maximum field width and + justification. + + + The optional format modifier is placed between the percent + sign and the conversion character or word. + + + The first optional format modifier is the + left justification flag + which is just the minus (-) character. Then comes the + optional + 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 + 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 + character is space. If the data item is larger than the + minimum field width, the field is expanded to accommodate + the data. The value is never truncated. + + + This behavior can be changed using the + maximum field width + modifier which is designated by a period followed by a + decimal constant. If the data item is longer than the + maximum field, then the extra characters are removed from + the + beginning + of the data item and not from the end. For example, it the + maximum field width is eight and the data item is ten + characters long, then the first two characters of the data + item are dropped. This behavior deviates from the printf + function in C where truncation is done from the end. + + + Below are various format modifier examples for the logger + conversion specifier. + + + <table BORDER="1" CELLPADDING="8"> + <th>Format modifier</th> + <th>Left justify</th> + <th>Minimum width</th> + <th>Maximum width</th> + <th>Comment</th> + + <tr> + <td align="center">%20c</td> + <td align="center">false</td> + <td align="center">20</td> + <td align="center">none</td> + <td> + Left pad with spaces if the category name is less + than 20 characters long. + </td> + </tr> + <tr> + <td align="center">%-20c</td> + <td align="center">true</td> + <td align="center">20</td> + <td align="center">none</td> + <td> + Right pad with spaces if the logger name is less + than 20 characters long. + </td> + </tr> + <tr> + <td align="center">%.30c</td> + <td align="center">NA</td> + <td align="center">none</td> + <td align="center">30</td> + <td> + Truncate from the beginning if the logger name is + longer than 30 characters. + </td> + </tr> + <tr> + <td align="center">%20.30c</td> + <td align="center">false</td> + <td align="center">20</td> + <td align="center">30</td> + <td> + Left 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. + </td> + </tr> + <tr> + <td align="center">%-20.30c</td> + <td align="center">true</td> + <td align="center">20</td> + <td align="center">30</td> + <td> + 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. + </td> + </tr> + </table> + + + + + + + + + + + + + + + + + <h3>HTMLLayout</h3> + + + Example 1.1: Basic template for logging + (examples/chapter1/HelloWorld1.java) + + + + + + + <h2>Logback access</h2> + <h3>PatternLayout</h3> + <h3>HTMLLayout</h3> + +</body> +</document>

1 0

svn commit: r665 - logback/trunk/logback-site/src/site/xdocTemplates
by noreply.seb＠qos.ch 11 Oct '06

11 Oct '06

Author: seb Date: Wed Oct 11 15:04:35 2006 New Revision: 665 Modified: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Log: minor fix Modified: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Wed Oct 11 15:04:35 2006 @@ -195,22 +195,22 @@ <h2>Example 2: RollingFileAppender</h2> - In the next configuration file, using logback access - <code>SMTPAppender</code>, could be: + Another configuration file, using logback' + <code>RollingFileAppender</code>, could be: <pre> <configuration> <appender name="FILE" - class="ch.qos.logback.core.rolling.RollingFileAppender"> - <rollingPolicy - class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> - <ActiveFileName>access.log"</ActiveFileName> - <FileNamePattern>access.%d{yyyy-MM-dd}.log.zip</FileNamePattern> - </rollingPolicy> - - <layout class="ch.qos.logback.access.PatternLayout"> - <Pattern">combined</Pattern"> - </layout> - </appender> + class="ch.qos.logback.core.rolling.RollingFileAppender"> + <rollingPolicy + class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> + <ActiveFileName>access.log"</ActiveFileName> + <FileNamePattern>access.%d{yyyy-MM-dd}.log.zip</FileNamePattern> + </rollingPolicy> + + <layout class="ch.qos.logback.access.PatternLayout"> + <Pattern">combined</Pattern"> + </layout> + </appender> <appender-ref ref="FILE" /> </configuration>

1 0

svn commit: r664 - logback/trunk/logback-site/src/site/xdocTemplates
by noreply.seb＠qos.ch 11 Oct '06

11 Oct '06

Author: seb Date: Wed Oct 11 14:56:56 2006 New Revision: 664 Modified: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Log: modified rolling file appender configuration Modified: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Wed Oct 11 14:56:56 2006 @@ -203,13 +203,12 @@ class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> - <param name="ActiveFileName" value="access.log" /> - <param name="FileNamePattern" value="access.%d{yyyy-MM-dd}.log.zip" /> + <ActiveFileName>access.log"</ActiveFileName> + <FileNamePattern>access.%d{yyyy-MM-dd}.log.zip</FileNamePattern> </rollingPolicy> <layout class="ch.qos.logback.access.PatternLayout"> - <param name="Pattern" - value="combined" /> + <Pattern">combined</Pattern"> </layout> </appender>

1 0

svn commit: r663 - logback/trunk/logback-access/src/main/java/ch/qos/logback/access
by noreply.seb＠qos.ch 11 Oct '06

11 Oct '06

Author: seb Date: Wed Oct 11 14:43:32 2006 New Revision: 663 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java Log: combined pattern correction Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java Wed Oct 11 14:43:32 2006 @@ -225,7 +225,7 @@ public static String CLF_PATTERN = "%h %l %u %t \"%r\" %s %b"; public static String CLF_PATTERN_NAME = "common"; public static String CLF_PATTERN_NAME_2 = "clf"; - public static String COMBINED_PATTERN = "%h %l %u %t \"%r\" %s %b \"%i{Referer}\" \"%i{User-Agent}"; + public static String COMBINED_PATTERN = "%h %l %u %t \"%r\" %s %b \"%i{Referer}\" \"%i{User-Agent}\""; public static String COMBINED_PATTERN_NAME = "combined"; static {

1 0

svn commit: r662 - in logback/trunk: logback-access/src/main/java/ch/qos/logback/access logback-site/src/site/xdocTemplates
by noreply.seb＠qos.ch 11 Oct '06

11 Oct '06

Author: seb Date: Wed Oct 11 12:03:12 2006 New Revision: 662 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Log: - corrected combined pattern - updated jetty doc with tested configuration of RollingFileAppender - Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java Wed Oct 11 12:03:12 2006 @@ -225,7 +225,7 @@ public static String CLF_PATTERN = "%h %l %u %t \"%r\" %s %b"; public static String CLF_PATTERN_NAME = "common"; public static String CLF_PATTERN_NAME_2 = "clf"; - public static String COMBINED_PATTERN = "%h %l %u %t \"%r\" %>s %b \"%i{Referer}\" \"%i{User-Agent}"; + public static String COMBINED_PATTERN = "%h %l %u %t \"%r\" %s %b \"%i{Referer}\" \"%i{User-Agent}"; public static String COMBINED_PATTERN_NAME = "combined"; static { Modified: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Wed Oct 11 12:03:12 2006 @@ -183,12 +183,13 @@ <div class="source"><layout class="ch.qos.logback.access.PatternLayout"> <Pattern>%h %l %u %t "%r" %s %b "%i{Referer}" "%i{User-Agent}"</Pattern> - </layout></div> +</layout></div> is equivalent to: <div class="source"><layout class="ch.qos.logback.access.PatternLayout"> - <Pattern>combined</Pattern></layout> + <Pattern>combined</Pattern> +</layout> </div> @@ -198,32 +199,31 @@ <code>SMTPAppender</code>, could be: <pre> <configuration> - <appender name="SMTP" - class="ch.qos.logback.access.net.SMTPAppender"> - <layout - class="ch.qos.logback.access.PatternLayout"> - <param name="pattern" - value="%remoteIP [%date] %requestURL %statusCode %bytesSent" /> - </layout> - <param name="From" value="sender(a)domaine.org" /> - <param name="SMTPHost" value="mail.domain.org" /> - <param name="Subject" - value="Last Event: %statusCode %requestURL" /> - <param name="To" value="server_admin(a)domain.org" /> - </appender> - <appender-ref ref="SMTP" /> + <appender name="FILE" + class="ch.qos.logback.core.rolling.RollingFileAppender"> + <rollingPolicy + class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> + <param name="ActiveFileName" value="access.log" /> + <param name="FileNamePattern" value="access.%d{yyyy-MM-dd}.log.zip" /> + </rollingPolicy> + + <layout class="ch.qos.logback.access.PatternLayout"> + <param name="Pattern" + value="combined" /> + </layout> + </appender> + + <appender-ref ref="FILE" /> </configuration> </pre> - Here, there is no output to the console. Instead, logback access - builds a buffer with the logging events, and in case of an - events that meets a certain condition, an email is sent to the - specified address, using the declared informations. By default, - an event that would cause an email to be sent is when a status - code of 500 or more occurs, which means that an error occured on - the server. + logs to the file named access.log. This file will be rolled over + every 24 hours. We specify in the configuration the name of the file + where the actual logging is added, and the pattern that the archived + files must match. + The newly archived file will be automatically compressed.

1 0

svn commit: r661 - logback/trunk/logback-classic/src/main/java/org/slf4j
by noreply.seb＠qos.ch 11 Oct '06

11 Oct '06

Author: seb Date: Wed Oct 11 10:34:13 2006 New Revision: 661 Modified: logback/trunk/logback-classic/src/main/java/org/slf4j/package.html Log: added link to slf4j Modified: logback/trunk/logback-classic/src/main/java/org/slf4j/package.html ============================================================================== --- logback/trunk/logback-classic/src/main/java/org/slf4j/package.html (original) +++ logback/trunk/logback-classic/src/main/java/org/slf4j/package.html Wed Oct 11 10:34:13 2006 @@ -7,7 +7,8 @@ <body> - Contains SLF4J implementations binding logback classes to the SLF4J framework. + Contains SLF4J implementations binding logback classes to the SLF4J framework. The + complete javadoc for SLF4J can be found on the <a href="http://www.slf4j.org">SLF4J website</a>. </body> </html> \ No newline at end of file

1 0

svn commit: r660 - in logback/trunk: logback-access/src/main/java/ch/qos/logback/access logback-site/src/site/xdocTemplates
by noreply.ceki＠qos.ch 10 Oct '06

10 Oct '06

Author: ceki Date: Tue Oct 10 22:32:15 2006 New Revision: 660 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Log: updated docs. I have not actually checked that the config files included in the docs actually work. They should be verified at some stage... Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java Tue Oct 10 22:32:15 2006 @@ -107,6 +107,14 @@ * </td> * </tr> * <tr> + * <td align="center">l</td> + * <td> + * Remote user. In logback-access, this converter always returns + * the value "-". + * + * </td> + * </tr> + * <tr> * <td align="center">m / requestMethod</td> * <td> * Modified: logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/accessLogJetty.xml Tue Oct 10 22:32:15 2006 @@ -18,25 +18,19 @@ <table> <tr> <td valign="top" align="top"> - <a rel="license" - href="http://creativecommons.org/licenses/by-nc-nd/2.5/"> - <img alt="Creative Commons License" border="0" - valign="top" align="top" - src="http://creativecommons.org/images/public/somerights20.png" /> - </a> + <a rel="license" href="http://creativecommons.org/licenses/by/2.5/"> + <img alt="Creative Commons License" style="border-width: 0" + src="http://creativecommons.org/images/public/somerights20.png"/> + </a> + </td> <td> - Copyright © 2000-2006, QOS.ch + Copyright © 2005-2006, QOS.ch - This work is licensed under a - <a rel="license" - href="http://creativecommons.org/licenses/by-nc-nd/2.5/"> - Creative Commons - Attribution-Noncommercial-No Derivative - Works 2.5 License - </a> - . + This work is licensed under a <a rel="license" + href="http://creativecommons.org/licenses/by/2.5/">Creative + Commons Attribution 2.5 License</a>. </td> </tr> @@ -45,50 +39,58 @@ <h2>Introduction</h2> - Since its first design drafts, logback has been concieved as a modular framework. - Being able to use logback's internal core in many situations, without heavy coding or - complex specific configuration was one of our goals. + Logback was designed as a modular framework from the start. Being + able to use logback's internal core in many situations, without + heavy coding or complex specific configuration was one of our + goals. + - Lobgack access integrates with Servlet containers such as Jetty and Tomcat to provide - HTTP-access log functionality. + Lobgack access integrates with Servlet containers such as Jetty + and Tomcat to provide HTTP-access log functionality. - Integrating logback into Jetty is very simple. Once done, one can benefit from the power - and flexibility found only in fully-fledged logging systems. + Integrating logback into Jetty is rather simple. Once done, you + can benefit from the power and flexibility found only in + fully-fledged logging systems. - To use logback access with Jetty, first download the files, then place the - logback-core-VERSION.jar and logback-access-VERSION.jar files - in the Jetty classpath. + To use logback-access with Jetty, after downlading the logback + distribution, place the files logback-core-VERSION.jar + and logback-access-VERSION.jar under $JETTY_HOME/lib + directory, where $JETTY_HOME is the folder where you have + installed Jetty. We tested logback-access module with Jetty + version 6.0.1. <h2>Logback's RequestLog implementation</h2> - Logback's <code>ch.qos.logback.access.jetty.RequestLogImpl</code> is an - implementation of jetty's <code>RequestLog</code> interface. This interface - is used by Jetty to allow external components to manage request logging. + The <code>ch.qos.logback.access.jetty.RequestLogImpl</code> + class implements jetty's <code><a + href="http://jetty.mortbay.org/apidocs/org/mortbay/jetty/RequestLog.html">RequestLog</a></code> + interface. This interface is used by Jetty to allow external + components to manage request logging. +  In logback, logging destinations are called Appenders. These classes can be attached directly to <code>RequestLogImpl</code>. - Logback's internal error reporting system is based on Status objects. - <code>RequestLogImpl</code> uses the same <code>StatusManager</code> - as <code>LoggerContext</code> does. - + + - To configure jetty in order to use <code>RequestLogImpl</code>, the - following lines must be added to the jetty configuration - file, namely etc/jetty.xml: + To configure jetty in order to use logback's + <code>RequestLogImpl</code>, add the following lines + to the jetty configuration file, namely $JETTY_HOME/etc/jetty.xml: <pre> <Ref id="requestLog"> @@ -104,24 +106,26 @@ the actual class that will be called at each logging request. - By default, <code>RequestLogImpl</code> looks for a logback configuration - file called logback.xml, in the same folder where jetty.xml - is located, that is etc/logback.xml. This configuration file - contains declarations of logback components. There, one can specify, - at runtime, the destinations where the logging requests will be sent, - and the format that logback will use to display the logging events. + By default, <code>RequestLogImpl</code> looks for a logback + configuration file called logback-access.xml, in the + same folder where jetty.xml is located. This + configuration file contains directives for configuring logback + components. Among others, you can specify the appenders where + the logging requests will be sent, and their format. - The logback.xml file - is slightly different than the usual logback classic - configuration file. Most of it is the same: Appenders and - Layouts (which are logback components to format logging output) - are declared the exact same way. However, loggers - elements are not allowed. + + Altough similar, the logback-access.xml file is slightly + different than the usual logback classic configuration file. + Appenders and Layouts are declared the exact same way. However, in + the access module there is no notion of loggers and consequently + loggers elements are disallowed in configuraiton files for + logback-access. - It is possible to put the logback - configuration file anywhere, as long as it's path is - specified. Here is another example of declaration of the logback - component in the jetty configuration file, with a path to the logback.xml file. + + As long the path is specified, you can place the logback + configuration file in other location. Here is another example of + jetty configuration file, with a path to the logback access + configuration file. <pre> <Ref id="requestLog"> @@ -129,13 +133,15 @@ <New id="requestLogImpl" class="ch.qos.logback.access.jetty.RequestLogImpl"> </New> - <Set name="fileName">path/to/logback.xml</Set> + <Set name="fileName">path/to/myaccess.xml</Set> </Set> </Ref> </pre> + + <h2>Example 1: logback-access configuration</h2> - Here is a sample logback.xml file that can be used right - away: + Here is a sample logback-access.xml file that you can + immediately put to use: <pre> <configuration> @@ -143,8 +149,7 @@ class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.access.PatternLayout"> - <param name="Pattern" - value="%date %server %remoteIP %clientHost %user %requestURL" /> + <Pattern>%h %l %u %user %date "%r" %s %b</Pattern> </layout> </appender> @@ -152,12 +157,45 @@ </configuration> </pre> - This file declares a logging destination (in the appender element). The - appender used is the ConsoleAppender which obviously logs events to the console. - A PatternLayout is also declared, to format the output. More informations about this - layout later on in this document. + It declares a <code>ConsoleAppender</code> which directs its + output at the console. The <code>ConsoleAppender</code> contains + a <code>PatternLayout</code> format the output. The log format is + specied using the %h %l %u %user %date "%r" %s %b" pattern which + is the Commong Log Format (CLF). This format is recognized by log + analysers such as <a href="http://www.analog.cx/">Analog</a> or <a + href="http://awstats.sourceforge.net/">AWStats</a>. - Another configuration file, using logback access <code>SMTPAppender</code>, could be: + + Instead of specifying the complete pattern, the word "common" + or "clf" can be used as a shorthand. Thus, the following are all + equivalent + + + <div class="source"><Pattern>%h %l %u %user %date "%r" %s %b</Pattern> +<Pattern>common</Pattern> +<Pattern>clf</Pattern></div> + + The so called "combined" format is also widely recognized. It is + defined as the '%h %l %u %t "%r" %s %b "%i{Referer}" + "%i{User-Agent}"' pattern. As a facilitator, you can use the + "combined" as a shorthand. Thus, the following directive + + + <div class="source"><layout class="ch.qos.logback.access.PatternLayout"> + <Pattern>%h %l %u %t "%r" %s %b "%i{Referer}" "%i{User-Agent}"</Pattern> + </layout></div> + + is equivalent to: + + <div class="source"><layout class="ch.qos.logback.access.PatternLayout"> + <Pattern>combined</Pattern></layout> + </div> + + + <h2>Example 2: RollingFileAppender</h2> + + In the next configuration file, using logback access + <code>SMTPAppender</code>, could be: <pre> <configuration> <appender name="SMTP" @@ -176,35 +214,40 @@ <appender-ref ref="SMTP" /> </configuration> </pre> + + - Here, there is no output to the console. Instead, logback access builds a buffer with - the logging events, and in case of an events that meets a certain condition, - an email is sent to the specified address, using the declared informations. - By default, an event that would cause an email to be sent is when a status - code of 500 or more occurs, which means that an error occured on the server. - - - These two configuration example should give you an idea of the - existing possibilities when having at hand the flexibility of a logging framework - like logback. Most of the things that you can do with the classic module of logback is - available for access logging. - - - A special, module-specific implementation of <code>PatternLayout</code> - was implemented to allow http-specific patterns to be used. - The <a href="http://logback.qos.ch/apidocs/ch/qos/logback/access/PatternLayout.html"> - <code>ch.qos.logback.access.PatternLayout</code></a> provides a way to - format the logging output that is just as easy and flexible - as the usual <code>PatternLayout</code>. - - - For more information about the - general use of a <code>PatternLayout</code>, please refer to logback - classic's <a href="http://logback.qos.ch/apidocs/ch/qos/logback/classic/PatternLayout.html"> - <code>ch.qos.logback.classic.PatternLayout</code></a>. + Here, there is no output to the console. Instead, logback access + builds a buffer with the logging events, and in case of an + events that meets a certain condition, an email is sent to the + specified address, using the declared informations. By default, + an event that would cause an email to be sent is when a status + code of 500 or more occurs, which means that an error occured on + the server. + + + + These two configuration examples should give you an idea of the + possibilities offered by the logback-access module. In + principle, most of the things that you can do with + logback-classic module are equally possible with logback-access. + + <h2>PatternLayout</h2> + - Logback access <code>PatternLayout</code> offers the following possibilities: + An http-specific implementation of <code>PatternLayout</code> is + included in the access module. The <a + href="http://logback.qos.ch/apidocs/ch/qos/logback/access/PatternLayout.html"> + <code>ch.qos.logback.access.PatternLayout</code></a> provides a + way to format the logging output that is just as easy and + flexible as the <code>PatternLayout</code> found in logback + classic. + + + + Logback access <code>PatternLayout</code> offers the following + possibilities: <table border="1" CELLPADDING="8"> <th align="center">Conversion Character or Word</th> @@ -250,6 +293,16 @@ </td> </tr> + <tr> + <td align="center">l</td> + <td> + + Remote log name. In logback-access, this converter always + returns the value "-". + + </td> + </tr> + <tr> <td align="center">reqParameter</td> <td> @@ -361,5 +414,21 @@ </td> </tr> </table> + + +  +  </body> </document>

2 1

svn commit: r659 - logback/trunk/logback-access/src/main/java/ch/qos/logback/access
by noreply.seb＠qos.ch 10 Oct '06

10 Oct '06

Author: seb Date: Tue Oct 10 21:33:53 2006 New Revision: 659 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java Log: added clf/common/combined keywords Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java Tue Oct 10 21:33:53 2006 @@ -215,6 +215,10 @@ public static final Map<String, String> defaultConverterMap = new HashMap<String, String>(); public static String CLF_PATTERN = "%h %l %u %t \"%r\" %s %b"; + public static String CLF_PATTERN_NAME = "common"; + public static String CLF_PATTERN_NAME_2 = "clf"; + public static String COMBINED_PATTERN = "%h %l %u %t \"%r\" %>s %b \"%i{Referer}\" \"%i{User-Agent}"; + public static String COMBINED_PATTERN_NAME = "combined"; static { @@ -316,4 +320,15 @@ return doLayout((AccessEvent) o); } + @Override + public void start() { + if (getPattern().equalsIgnoreCase(CLF_PATTERN_NAME) + || getPattern().equalsIgnoreCase(CLF_PATTERN_NAME_2)) { + setPattern(CLF_PATTERN); + } else if (getPattern().equalsIgnoreCase(COMBINED_PATTERN_NAME)) { + setPattern(COMBINED_PATTERN); + } + super.start(); + } + }

1 0