- logback-dev - mailman3.qos.ch

svn commit: r594 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling
by noreply.seb＠qos.ch 19 Sep '06

19 Sep '06

Author: seb Date: Tue Sep 19 16:02:04 2006 New Revision: 594 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java Log: - added a configuration example in the javadoc Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java Tue Sep 19 16:02:04 2006 @@ -14,7 +14,38 @@ /** * SizeBasedTriggeringPolicy looks at size of the file being - * currently written to. + * currently written to. If it grows bigger than the specified size, + * the FileAppender using the SizeBasedTriggeringPolicy rolls the file + * and creates a new one. + * + * Here is an example of a configuration using SizeBasedTriggeringPolicy. + * + * <pre> + * <configuration> + * <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> + * <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + * <param name="ActiveFile" value="outputFile.log" /> + * <param name="FileNamePattern" value="logFile.%i.log" /> + * <param name="MinIndex" value="1" /> + * <param name="MaxIndex" value="3" /> + * </rollingPolicy> + * + * <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedRollingPolicy"> + * <param name="MaxFileSize" value="5MB" /> + * </triggeringPolicy> + * + * <layout class="ch.qos.logback.classic.PatternLayout"> + * <param name="pattern" value="%-4relative [%thread] %-5level %class - %msg%n" /> + * </layout> + * </appender> + * + * <root> + * <level value="debug" /> + * <appender-ref ref="FILE" /> + * </root> + * </configuration> + * </pre> + * * * @author Ceki Gülcü *

1 0

svn commit: r593 - logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic
by noreply.seb＠qos.ch 19 Sep '06

19 Sep '06

Author: seb Date: Tue Sep 19 15:36:32 2006 New Revision: 593 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java Log: - improved javadoc 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 Tue Sep 19 15:36:32 2006 @@ -34,90 +34,412 @@ import ch.qos.logback.core.pattern.PatternLayoutBase; /** + * + * A flexible layout configurable with pattern string. The goal of this class is + * to {@link #format format} a {@link LoggingEvent} and return the results in a + * {#link String}. The format of the result depends on the + * conversion pattern. + * + * + * + * The conversion pattern is closely related to the conversion pattern of the + * printf function in C. A conversion pattern is composed of literal text and + * format control expressions called conversion specifiers. + * + * + * Note that 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 or + * conversion word. The conversion character or word specifies the + * type of data, e.g. logger, level, date, thread name. The format modifiers + * control such things as field width, padding, left and right justification. + * The following is a simple example. + * + * + * Let the conversion pattern be "%-5level [%thread]: %message%n" and + * assume that the logback environment was set to use a PatternLayout. Then the + * statements + * + * <pre> + * Logger logger = LoggerFactory.getLogger("root"); + * root.debug("Message 1"); + * root.warn("Message 2"); + * </pre> + * + * would yield the output + * + * <pre> + * DEBUG [main]: Message 1 + * WARN [main]: Message 2 + * </pre> + * + * + * Note that there is no explicit separator between text and conversion + * specifiers. The pattern parser knows when it has reached the end of a + * conversion specifier when it reads a conversion character. 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. + * + * 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. * - * PatternLayout is a simple yet powerfull way to turn a LoggingEvent into - * a String. * - * The returned String can be modified by specifying a pattern to the layout. - * A pattern is composed of literal text and format control expressions called - * conversion specifiers. Any literal can be inserted between the conversions - * specifiers. When literals are inserted, PatternLayout is able to differentiate - * which part of the pattern are conversion specifiers and which should be - * added as-is to the output string. - * - * A conversion specifier starts with a percent sign (%) and is followed by - * a letter or a word, describing the type of data that will be displayed. - * A format modifier can be added to the conversion specifier. It will tweak - * the way that the conversion specifier will display the data. - * - * Here are a few quick examples: - * - * <table cellpadding=10> - * <tr> - * <th>Conversion pattern</th> - * <th>Result</th> - * <th>Explanation</th> - * </tr> - * <tr> - * <td>%level [%thread]: %message</td> - * <td>DEBUG [main]: Message 1</td> - * <td>Simple pattern</td> - * </tr> - * <tr> - * <td>%level [%logger]: %message</td> - * <td>DEBUG [org.foo.bar.SampleClass]: Message 2</td> - * <td>With %logger, the fully qualified name is displayed</td> - * </tr> - * <tr> - * <td>%level [%logger{10}]: %message</td> - * <td>DEBUG [o.f.b.SampleClass]: Message 2</td> - * <td>A format modifier has been added to the conversion specifier, thus - * modifying the string displayed.</td> - * </tr> + * 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 "org.apache.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. + * + * </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 + * callers 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. + * + * </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. + * + * </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. + * + * + * </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 {@link MDC} 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>Left justify + * <th>Minimum width + * <th>Maximum width + * <th>Comment + * + * <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. + * + * <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. + * + * <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. + * + * <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. + * + * <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. + * * </table> + * * - * When a conversion specifier is used in conjunction with a format modifier, - * the resulting string is modified. It is modified in a way that one can still - * read the class name, and deduce its fully qualified name by looking at the - * packages' first letter. - * - * The format modifier can have a milder effect on the resulting string. If a - * larger number is specified, a longer part of the fully qualified name will be - * displayed without modification. In that case, the name of deeper packages - * are displayed first. - * - * Here are a few more examples of the format modifier behaviour. - * - * <table cellpadding=10> - * <tr> - * <th>Conversion Pattern</th> - * <th>Class name</th> - * <th>Result</th> - * </tr> - * <tr> - * <td>%logger{10}</td> - * <td>mainPackage.sub.sample.Bar</td> - * <td>m.s.s.Bar</td> - * </tr> - * <tr> - * <td>%logger{15}</td> - * <td>mainPackage.sub.sample.Bar</td> - * <td>m.s.sample.Bar</td> - * </tr> - * <tr> - * <td>%logger{16}</td> - * <td>mainPackage.sub.sample.Bar</td> - * <td>m.sub.sample.Bar</td> - * </tr> - * <tr> - * <td>%logger{26}</td> - * <td>mainPackage.sub.sample.Bar</td> - * <td>mainPackage.sub.sample.Bar</td> - * </tr> + * Below are some examples of conversion patterns. + * + * <dl> + * + * + * <dt>%relative [%thread] %-5level %logger %mdc - %message\n + * + * <dd>This is essentially the TTCC layout. + * + * + * <dt>%-6relative [%15.15thread] %-5level %30.30logger %mdc - %message\n + * + * + * <dd>Similar to the TTCC layout except that the relative time is right padded + * if less than 6 digits, thread name is right padded if less than 15 characters + * and truncated if longer and the logger name is left padded if shorter than 30 + * characters and truncated if longer. + * + * </dl> + * Here are a few more examples of the format modifier behaviour, with emphasis on + * the way it affects class names. + * + * + * <table BORDER=1 CELLPADDING=8> + * + * <tr> + * <th>Conversion Pattern</th> + * <th>Class name</th> + * <th>Result</th> + * </tr> + * + * <tr> + * <td>%logger{10}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>m.s.s.Bar</td> + * </tr> + * + * <tr> + * <td>%logger{15}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>m.s.sample.Bar</td> + * </tr> + * + * <tr> + * <td>%logger{16}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>m.sub.sample.Bar</td> + * </tr> + * + * <tr> + * <td>%logger{26}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>mainPackage.sub.sample.Bar</td> + * </tr> + * * </table> - * + * + * + * The above text is largely inspired from Peter A. Darnell and Philip E. + * Margolis' highly recommended book "C -- a Software Engineering Approach", + * ISBN 0-387-97389-3. + * * */ + public class PatternLayout extends PatternLayoutBase implements ClassicLayout { // FIXME fix exception handling @@ -135,14 +457,14 @@ defaultConverterMap.put("level", LevelConverter.class.getName()); defaultConverterMap.put("le", LevelConverter.class.getName()); defaultConverterMap.put("p", LevelConverter.class.getName()); - + defaultConverterMap.put("t", ThreadConverter.class.getName()); defaultConverterMap.put("thread", ThreadConverter.class.getName()); defaultConverterMap.put("lo", LoggerConverter.class.getName()); defaultConverterMap.put("logger", LoggerConverter.class.getName()); defaultConverterMap.put("c", LoggerConverter.class.getName()); - + defaultConverterMap.put("m", MessageConverter.class.getName()); defaultConverterMap.put("msg", MessageConverter.class.getName()); defaultConverterMap.put("message", MessageConverter.class.getName()); @@ -158,10 +480,10 @@ defaultConverterMap.put("F", FileOfCallerConverter.class.getName()); defaultConverterMap.put("file", FileOfCallerConverter.class.getName()); - + defaultConverterMap.put("X", MDCConverter.class.getName()); defaultConverterMap.put("mdc", MDCConverter.class.getName()); - + defaultConverterMap .put("ex", ThrowableInformationConverter.class.getName()); defaultConverterMap.put("exception", ThrowableInformationConverter.class

1 0

svn commit: r592 - in logback/trunk: . logback-access/src/main/java/ch/qos/logback/access/pattern logback-access/src/main/java/ch/qos/logback/access/spi logback-access/src/test/java/ch/qos/logback/access/pattern logback-access/src/test/java/ch/qos/logback/access/pattern/helpers
by noreply.seb＠qos.ch 19 Sep '06

19 Sep '06

Author: seb Date: Tue Sep 19 10:32:01 2006 New Revision: 592 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/RequestHeaderConverter.java logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/ResponseHeaderConverter.java logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ConverterTest.java logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyRequest.java logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyResponse.java logback/trunk/pom.xml Log: - updated dependencies to use jetty 6.0.0 - modified AccessEvent method getHeader to getRequestHeader - added getResponseHeader to AccessEvent - updated DummyResponse to provide header access Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/RequestHeaderConverter.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/RequestHeaderConverter.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/RequestHeaderConverter.java Tue Sep 19 10:32:01 2006 @@ -22,7 +22,7 @@ return "INACTIVE_HEADER_CONV"; } - return accessEvent.getHeader(key); + return accessEvent.getRequestHeader(key); } } Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/ResponseHeaderConverter.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/ResponseHeaderConverter.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/pattern/ResponseHeaderConverter.java Tue Sep 19 10:32:01 2006 @@ -22,7 +22,8 @@ return "INACTIVE_REPONSE_HEADER_CONV"; } - return null; + return accessEvent.getResponseHeader(key); + //return null; // HttpServletResponse response = accessEvent.getHttpResponse(); // Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java Tue Sep 19 10:32:01 2006 @@ -9,6 +9,8 @@ import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; +import org.mortbay.jetty.Response; + import ch.qos.logback.access.pattern.AccessConverter; public class AccessEvent implements Serializable { @@ -30,7 +32,7 @@ String method; String serverName; - Map headerMap; + Map requestHeaderMap; long contentLength = SENTINEL; int statusCode = SENTINEL; @@ -169,15 +171,15 @@ return remoteAddr; } - public String getHeader(String key) { + public String getRequestHeader(String key) { String result = null; - if (headerMap == null) { + if (requestHeaderMap == null) { if (httpRequest != null) { - buildHeaderMap(); - result = (String) headerMap.get(key); + buildRequestHeaderMap(); + result = (String) requestHeaderMap.get(key); } } else { - result = (String) headerMap.get(key); + result = (String) requestHeaderMap.get(key); } if (result != null) { @@ -187,15 +189,26 @@ } } - public void buildHeaderMap() { - headerMap = new HashMap(); + public void buildRequestHeaderMap() { + requestHeaderMap = new HashMap(); Enumeration e = httpRequest.getHeaderNames(); while(e.hasMoreElements()) { String key = (String) e.nextElement(); - headerMap.put(key, httpRequest.getHeader(key)); + requestHeaderMap.put(key, httpRequest.getHeader(key)); } } - + + public String getResponseHeader(String key) { + //TODO buildMap + if (httpResponse instanceof org.mortbay.jetty.Response) { + return ((org.mortbay.jetty.Response)httpResponse).getHeader(key); + } + if (httpResponse instanceof ch.qos.logback.access.pattern.helpers.DummyResponse) { + return ((ch.qos.logback.access.pattern.helpers.DummyResponse)httpResponse).getHeader(key); + } + + return null; + } /** * Attributes are not serialized * Modified: logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ConverterTest.java ============================================================================== --- logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ConverterTest.java (original) +++ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ConverterTest.java Tue Sep 19 10:32:01 2006 @@ -133,14 +133,13 @@ } public void testResponseHeaderConverter() { - // TODO - // ResponseHeaderConverter converter = new ResponseHeaderConverter(); - // List<String> optionList = new ArrayList<String>(); - // optionList.add("headerName1"); - // converter.setOptionList(optionList); - // converter.start(); - // String result = converter.convert(event); - // assertEquals(request.getHeader("headerName1"), result); + ResponseHeaderConverter converter = new ResponseHeaderConverter(); + List<String> optionList = new ArrayList<String>(); + optionList.add("headerName1"); + converter.setOptionList(optionList); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getHeader("headerName1"), result); } public void testServerNameConverter() { Modified: logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyRequest.java ============================================================================== --- logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyRequest.java (original) +++ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyRequest.java Tue Sep 19 10:32:01 2006 @@ -18,13 +18,13 @@ public class DummyRequest implements HttpServletRequest { Hashtable<String, String> headerNames; - + public DummyRequest() { headerNames = new Hashtable<String, String>(); headerNames.put("headerName1", "headerValue1"); headerNames.put("headerName2", "headerValue2"); } - + public String getAuthType() { return null; } @@ -35,7 +35,7 @@ public Cookie[] getCookies() { Cookie cookie = new Cookie("testName", "testCookie"); - return new Cookie[] {cookie}; + return new Cookie[] { cookie }; } public long getDateHeader(String arg0) { Modified: logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyResponse.java ============================================================================== --- logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyResponse.java (original) +++ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyResponse.java Tue Sep 19 10:32:01 2006 @@ -2,8 +2,9 @@ import java.io.IOException; import java.io.PrintWriter; -import java.util.Hashtable; +import java.util.HashMap; import java.util.Locale; +import java.util.Map; import javax.servlet.ServletOutputStream; import javax.servlet.http.Cookie; @@ -11,19 +12,18 @@ public class DummyResponse implements HttpServletResponse { - Hashtable<String, String> headerNames; - + Map<String, String> headerMap; public DummyResponse() { - headerNames = new Hashtable<String, String>(); - headerNames.put("headerName1", "headerValue1"); - headerNames.put("headerName2", "headerValue2"); + headerMap = new HashMap<String, String>(); + headerMap.put("headerName1", "headerValue1"); + headerMap.put("headerName2", "headerValue2"); } - + public void addCookie(Cookie arg0) { - + } - public void addDateHeader(String arg0, long arg1) { + public void addDateHeader(String arg0, long arg1) { } public void addHeader(String arg0, String arg1) { @@ -52,7 +52,7 @@ return null; } - public void sendError(int arg0) throws IOException { + public void sendError(int arg0) throws IOException { } public void sendError(int arg0, String arg1) throws IOException { @@ -64,19 +64,19 @@ public void setDateHeader(String arg0, long arg1) { } - public void setHeader(String arg0, String arg1) { + public void setHeader(String arg0, String arg1) { } - public void setIntHeader(String arg0, int arg1) { + public void setIntHeader(String arg0, int arg1) { } - public void setStatus(int arg0) { + public void setStatus(int arg0) { } - public void setStatus(int arg0, String arg1) { + public void setStatus(int arg0, String arg1) { } - public void flushBuffer() throws IOException { + public void flushBuffer() throws IOException { } public int getBufferSize() { @@ -110,10 +110,10 @@ public void reset() { } - public void resetBuffer() { + public void resetBuffer() { } - public void setBufferSize(int arg0) { + public void setBufferSize(int arg0) { } public void setCharacterEncoding(String arg0) { @@ -122,10 +122,14 @@ public void setContentLength(int arg0) { } - public void setContentType(String arg0) { + public void setContentType(String arg0) { } public void setLocale(Locale arg0) { } + + public String getHeader(String key) { + return headerMap.get(key); + } } Modified: logback/trunk/pom.xml ============================================================================== --- logback/trunk/pom.xml (original) +++ logback/trunk/pom.xml Tue Sep 19 10:32:01 2006 @@ -85,7 +85,7 @@ <dependency> <groupId>org.mortbay.jetty</groupId> <artifactId>jetty</artifactId> - <version>6.0.0beta9</version> + <version>6.0.0</version> </dependency> <dependency> @@ -97,7 +97,7 @@ <dependency> <groupId>org.mortbay.jetty</groupId> <artifactId>servlet-api-2.5</artifactId> - <version>6.0.0beta9</version> + <version>6.0.0</version> </dependency> </dependencies>

1 0

logbag vs. LOGBack
by Boris Unckel 19 Sep '06

19 Sep '06

Hello all, I found a project with a similiar name: http://www.theserverside.com/news/thread.tss?thread_id=42243 http://logbag.com/ I did not find any code or links to cvs/svn, currently it seems to be vaporware. Very interesting... Regards Boris

2 1

svn commit: r591 - in logback/trunk/logback-access/src: main/java/ch/qos/logback/access test/java test/java/ch test/java/ch/qos test/java/ch/qos/logback test/java/ch/qos/logback/access test/java/ch/qos/logback/access/pattern test/java/ch/qos/logback/access/pattern/helpers
by noreply.seb＠qos.ch 15 Sep '06

15 Sep '06

Author: seb Date: Fri Sep 15 16:00:56 2006 New Revision: 591 Added: logback/trunk/logback-access/src/test/java/ logback/trunk/logback-access/src/test/java/ch/ logback/trunk/logback-access/src/test/java/ch/qos/ logback/trunk/logback-access/src/test/java/ch/qos/logback/ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ConverterTest.java logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyRequest.java logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyResponse.java Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java Log: - added word patterns to PatternLayout - added a test class for Converters. - added two dummy implementations of HttpServletRequest and HttpServletResponse 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 Fri Sep 15 16:00:56 2006 @@ -64,6 +64,7 @@ defaultConverterMap.put("l", NAConverter.class.getName()); defaultConverterMap.put("m", RequestMethodConverter.class.getName()); + defaultConverterMap.put("requestMethod", RequestMethodConverter.class.getName()); defaultConverterMap.put("r", RequestURLConverter.class.getName()); defaultConverterMap.put("requestURL", RequestURLConverter.class.getName()); @@ -73,12 +74,16 @@ defaultConverterMap.put("t", DateConverter.class.getName()); + defaultConverterMap.put("date", DateConverter.class.getName()); defaultConverterMap.put("u", RemoteUserConverter.class.getName()); + defaultConverterMap.put("user", RemoteUserConverter.class.getName()); defaultConverterMap.put("U", RequestURIConverter.class.getName()); + defaultConverterMap.put("requestURI", RequestURIConverter.class.getName()); defaultConverterMap.put("v", ServerNameConverter.class.getName()); + defaultConverterMap.put("server", ServerNameConverter.class.getName()); } @@ -90,7 +95,7 @@ /** * Returns the default converter map for this instance. */ - public Map getDefaultConverterMap() { + public Map<String, String> getDefaultConverterMap() { return defaultConverterMap; } Added: logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ConverterTest.java ============================================================================== --- (empty file) +++ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/ConverterTest.java Fri Sep 15 16:00:56 2006 @@ -0,0 +1,162 @@ +package ch.qos.logback.access.pattern; + +import java.util.ArrayList; +import java.util.List; + +import javax.servlet.http.Cookie; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import junit.framework.TestCase; +import ch.qos.logback.access.pattern.helpers.DummyRequest; +import ch.qos.logback.access.pattern.helpers.DummyResponse; +import ch.qos.logback.access.spi.AccessEvent; + +public class ConverterTest extends TestCase { + + AccessEvent event; + HttpServletRequest request; + HttpServletResponse response; + + public void setUp() throws Exception { + super.setUp(); + request = new DummyRequest(); + response = new DummyResponse(); + event = createEvent(); + } + + public void tearDown() throws Exception { + super.tearDown(); + event = null; + request = null; + response = null; + } + + public void testContentLengthConverter() { + // TODO when AccessEvent has been modified + } + + public void testDateConverter() { + DateConverter converter = new DateConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(converter.simpleFormat.format(event.getTimeStamp()), result); + } + + public void testLineLocalPortConverter() { + LocalPortConverter converter = new LocalPortConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(Integer.toString(request.getLocalPort()), result); + } + + public void testRemoteHostConverter() { + RemoteHostConverter converter = new RemoteHostConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getRemoteHost(), result); + } + + public void testRemoteIPAddressConverter() { + RemoteIPAddressConverter converter = new RemoteIPAddressConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getRemoteAddr(), result); + } + + public void testRemoteUserConverter() { + RemoteUserConverter converter = new RemoteUserConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getRemoteUser(), result); + } + + public void testRequestAttributeConverter() { + RequestAttributeConverter converter = new RequestAttributeConverter(); + List<String> optionList = new ArrayList<String>(); + optionList.add("testKey"); + converter.setOptionList(optionList); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getAttribute("testKey"), result); + } + + public void testRequestCookieConverter() { + RequestCookieConverter converter = new RequestCookieConverter(); + List<String> optionList = new ArrayList<String>(); + optionList.add("testName"); + converter.setOptionList(optionList); + converter.start(); + String result = converter.convert(event); + Cookie cookie = request.getCookies()[0]; + assertEquals(cookie.getValue(), result); + } + + public void testRequestHeaderConverter() { + RequestHeaderConverter converter = new RequestHeaderConverter(); + List<String> optionList = new ArrayList<String>(); + optionList.add("headerName1"); + converter.setOptionList(optionList); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getHeader("headerName1"), result); + } + + public void testRequestMethodConverter() { + RequestMethodConverter converter = new RequestMethodConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getMethod(), result); + } + + public void testRequestProtocolConverter() { + RequestProtocolConverter converter = new RequestProtocolConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getProtocol(), result); + } + + public void testRequestURIConverter() { + RequestURIConverter converter = new RequestURIConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getRequestURI(), result); + } + + public void testRequestURLConverter() { + RequestURLConverter converter = new RequestURLConverter(); + converter.start(); + String result = converter.convert(event); + String expected = request.getMethod() + " " + request.getRequestURI() + " " + + request.getProtocol(); + assertEquals(expected, result); + } + + public void testResponseHeaderConverter() { + // TODO + // ResponseHeaderConverter converter = new ResponseHeaderConverter(); + // List<String> optionList = new ArrayList<String>(); + // optionList.add("headerName1"); + // converter.setOptionList(optionList); + // converter.start(); + // String result = converter.convert(event); + // assertEquals(request.getHeader("headerName1"), result); + } + + public void testServerNameConverter() { + ServerNameConverter converter = new ServerNameConverter(); + converter.start(); + String result = converter.convert(event); + assertEquals(request.getServerName(), result); + } + + public void testStatusCodeConverter() { + //TODO + } + + private AccessEvent createEvent() { + AccessEvent ae = new AccessEvent(request, response); + return ae; + } + +} Added: logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyRequest.java ============================================================================== --- (empty file) +++ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyRequest.java Fri Sep 15 16:00:56 2006 @@ -0,0 +1,246 @@ +package ch.qos.logback.access.pattern.helpers; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.security.Principal; +import java.util.Enumeration; +import java.util.Hashtable; +import java.util.Locale; +import java.util.Map; + +import javax.servlet.RequestDispatcher; +import javax.servlet.ServletInputStream; +import javax.servlet.http.Cookie; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpSession; + +public class DummyRequest implements HttpServletRequest { + + Hashtable<String, String> headerNames; + + public DummyRequest() { + headerNames = new Hashtable<String, String>(); + headerNames.put("headerName1", "headerValue1"); + headerNames.put("headerName2", "headerValue2"); + } + + public String getAuthType() { + return null; + } + + public String getContextPath() { + return null; + } + + public Cookie[] getCookies() { + Cookie cookie = new Cookie("testName", "testCookie"); + return new Cookie[] {cookie}; + } + + public long getDateHeader(String arg0) { + return 0; + } + + public String getHeader(String key) { + return headerNames.get(key); + } + + public Enumeration getHeaderNames() { + return headerNames.keys(); + } + + public Enumeration getHeaders(String arg0) { + return null; + } + + public int getIntHeader(String arg0) { + return 0; + } + + public String getMethod() { + return "testMethod"; + } + + public String getPathInfo() { + return null; + } + + public String getPathTranslated() { + return null; + } + + public String getQueryString() { + return null; + } + + public String getRemoteUser() { + return "testUser"; + } + + public String getRequestURI() { + return "testURI"; + } + + public StringBuffer getRequestURL() { + return null; + } + + public String getRequestedSessionId() { + return null; + } + + public String getServletPath() { + return null; + } + + public HttpSession getSession() { + return null; + } + + public HttpSession getSession(boolean arg0) { + return null; + } + + public Principal getUserPrincipal() { + return null; + } + + public boolean isRequestedSessionIdFromCookie() { + return false; + } + + public boolean isRequestedSessionIdFromURL() { + return false; + } + + public boolean isRequestedSessionIdFromUrl() { + return false; + } + + public boolean isRequestedSessionIdValid() { + return false; + } + + public boolean isUserInRole(String arg0) { + return false; + } + + public Object getAttribute(String key) { + if (key.equals("testKey")) { + return "testKey"; + } else { + return null; + } + } + + public Enumeration getAttributeNames() { + return null; + } + + public String getCharacterEncoding() { + return null; + } + + public int getContentLength() { + return 0; + } + + public String getContentType() { + return null; + } + + public ServletInputStream getInputStream() throws IOException { + return null; + } + + public String getLocalAddr() { + return null; + } + + public String getLocalName() { + return null; + } + + public int getLocalPort() { + return 11; + } + + public Locale getLocale() { + return null; + } + + public Enumeration getLocales() { + return null; + } + + public String getParameter(String arg0) { + return null; + } + + public Map getParameterMap() { + return null; + } + + public Enumeration getParameterNames() { + return null; + } + + public String[] getParameterValues(String arg0) { + return null; + } + + public String getProtocol() { + return "testProtocol"; + } + + public BufferedReader getReader() throws IOException { + return null; + } + + public String getRealPath(String arg0) { + return null; + } + + public String getRemoteAddr() { + return "testRemoteAddress"; + } + + public String getRemoteHost() { + return "testHost"; + } + + public int getRemotePort() { + return 0; + } + + public RequestDispatcher getRequestDispatcher(String arg0) { + return null; + } + + public String getScheme() { + return null; + } + + public String getServerName() { + return "testServerName"; + } + + public int getServerPort() { + return 0; + } + + public boolean isSecure() { + return false; + } + + public void removeAttribute(String arg0) { + } + + public void setAttribute(String arg0, Object arg1) { + } + + public void setCharacterEncoding(String arg0) + throws UnsupportedEncodingException { + } +} Added: logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyResponse.java ============================================================================== --- (empty file) +++ logback/trunk/logback-access/src/test/java/ch/qos/logback/access/pattern/helpers/DummyResponse.java Fri Sep 15 16:00:56 2006 @@ -0,0 +1,131 @@ +package ch.qos.logback.access.pattern.helpers; + +import java.io.IOException; +import java.io.PrintWriter; +import java.util.Hashtable; +import java.util.Locale; + +import javax.servlet.ServletOutputStream; +import javax.servlet.http.Cookie; +import javax.servlet.http.HttpServletResponse; + +public class DummyResponse implements HttpServletResponse { + + Hashtable<String, String> headerNames; + + public DummyResponse() { + headerNames = new Hashtable<String, String>(); + headerNames.put("headerName1", "headerValue1"); + headerNames.put("headerName2", "headerValue2"); + } + + public void addCookie(Cookie arg0) { + + } + + public void addDateHeader(String arg0, long arg1) { + } + + public void addHeader(String arg0, String arg1) { + } + + public void addIntHeader(String arg0, int arg1) { + } + + public boolean containsHeader(String arg0) { + return false; + } + + public String encodeRedirectURL(String arg0) { + return null; + } + + public String encodeRedirectUrl(String arg0) { + return null; + } + + public String encodeURL(String arg0) { + return null; + } + + public String encodeUrl(String arg0) { + return null; + } + + public void sendError(int arg0) throws IOException { + } + + public void sendError(int arg0, String arg1) throws IOException { + } + + public void sendRedirect(String arg0) throws IOException { + } + + public void setDateHeader(String arg0, long arg1) { + } + + public void setHeader(String arg0, String arg1) { + } + + public void setIntHeader(String arg0, int arg1) { + } + + public void setStatus(int arg0) { + } + + public void setStatus(int arg0, String arg1) { + } + + public void flushBuffer() throws IOException { + } + + public int getBufferSize() { + return 0; + } + + public String getCharacterEncoding() { + return null; + } + + public String getContentType() { + return null; + } + + public Locale getLocale() { + return null; + } + + public ServletOutputStream getOutputStream() throws IOException { + return null; + } + + public PrintWriter getWriter() throws IOException { + return null; + } + + public boolean isCommitted() { + return false; + } + + public void reset() { + } + + public void resetBuffer() { + } + + public void setBufferSize(int arg0) { + } + + public void setCharacterEncoding(String arg0) { + } + + public void setContentLength(int arg0) { + } + + public void setContentType(String arg0) { + } + + public void setLocale(Locale arg0) { + } + +}

1 0

svn commit: r590 - logback/trunk
by noreply.ceki＠qos.ch 14 Sep '06

14 Sep '06

Author: ceki Date: Thu Sep 14 20:10:31 2006 New Revision: 590 Added: logback/trunk/updateBundle.sh Log: command for uploading bundles on pixie Added: logback/trunk/updateBundle.sh ============================================================================== --- (empty file) +++ logback/trunk/updateBundle.sh Thu Sep 14 20:10:31 2006 @@ -0,0 +1,26 @@ + +VERSION=0.4-SNAPSHOT +echo $VERSION + +MVN=/java/maven-2.0.4/bin/mvn + +BUNDLES_DIR=pixie:/var/www/logback.qos.ch/htdocs/dist/bundles/ + +update() { + MODULE=$1 + pushd $MODULE + $MVN repository:bundle-create + echo Maven exited with $? + if [ $? != 0 ] + then + echo mvn command failed + exit 1; + fi + scp target/$MODULE-$VERSION-bundle.jar $BUNDLES_DIR + popd +} + +update logback-core +update logback-classic +update logback-access +

1 0

svn commit: r589 - logback/trunk/logback-site/src/site/fml
by noreply.seb＠qos.ch 14 Sep '06

14 Sep '06

Author: seb Date: Thu Sep 14 19:54:28 2006 New Revision: 589 Modified: logback/trunk/logback-site/src/site/fml/codes.fml Log: - added questions/answers - formatted xml to display properly Modified: logback/trunk/logback-site/src/site/fml/codes.fml ============================================================================== --- logback/trunk/logback-site/src/site/fml/codes.fml (original) +++ logback/trunk/logback-site/src/site/fml/codes.fml Thu Sep 14 19:54:28 2006 @@ -49,13 +49,11 @@ You can specify the remote host in the configuration file like this: - <pre> -<appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> + <source><appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> ... - <param name="remoteHost" value="127.0.0.1" /> + <param name="remoteHost" value="127.0.0.1" /> ... -</appender> - </pre> +</appender></source> </answer> </faq> <faq id="socket_no_port"> @@ -74,13 +72,11 @@ You can specify the remote port in the configuration file like this: - <pre> -<appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> + <source><appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> ... - <param name="port" value="4560" /> + <param name="port" value="4560" /> ... -</appender> - </pre> +</appender></source> </answer> </faq> <faq id="smtp_no_tp"> @@ -104,13 +100,11 @@ <code>TriggeringPolicy</code> in the configuration file like this: - <pre> -<appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> + <source><appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> ... - <param name="port" value="4560"/> + <param name="port" value="4560"/> ... -</appender> - </pre> +</appender></source> </answer> </faq> <faq id="smtp_no_layout"> @@ -141,15 +135,13 @@ <code>Layout</code> in the configuration file like this: - <pre> -<appender name="SMTP" class="ch.qos.logback.classic.net.SMTPAppender"> + <source><appender name="SMTP" class="ch.qos.logback.classic.net.SMTPAppender"> ... - <layout class="ch.qos.logback.classic.PatternLayout"> - <param name="pattern" value="%-4relative [%thread] %-5level %class - %msg%n" /> - </layout> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> ... -</appender> - </pre> +</appender></source> </answer> </faq> <faq id="sbtp_size_format">

1 0

svn commit: r588 - logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi
by noreply.ceki＠qos.ch 14 Sep '06

14 Sep '06

Author: ceki Date: Thu Sep 14 19:32:22 2006 New Revision: 588 Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java Log: check latest jetty releases for the availability of appropriate method Modified: logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java ============================================================================== --- logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java (original) +++ logback/trunk/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java Thu Sep 14 19:32:22 2006 @@ -236,7 +236,7 @@ if (contentLength == SENTINEL) { if (httpResponse != null) { if (httpResponse instanceof org.mortbay.jetty.Response) { - // NA + // TODO } else if (httpResponse instanceof com.caucho.server.connection.AbstractHttpResponse) { contentLength = ((com.caucho.server.connection.AbstractHttpResponse) httpResponse) .getContentLength();

1 0

svn commit: r587 - in logback/trunk: logback-classic/src/main/java/ch/qos/logback/classic/net logback-core/src/main/java/ch/qos/logback/core/net logback-core/src/main/java/ch/qos/logback/core/rolling logback-site/src/site/fml
by noreply.seb＠qos.ch 14 Sep '06

14 Sep '06

Author: seb Date: Thu Sep 14 18:24:46 2006 New Revision: 587 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java logback/trunk/logback-site/src/site/fml/codes.fml Log: - updated codes.html page - updated a few classes' addError calls to display a link to the codes.html page Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java Thu Sep 14 18:24:46 2006 @@ -164,12 +164,12 @@ int errorCount = 0; if (port == 0) { errorCount++; - addError("No port was configured for appender" + name); + addError("No port was configured for appender" + name + " For more information, please visit http://logback.qos.ch/codes.html#socket_no_port"); } if (address == null) { errorCount++; - addError("No remote address was configured for appender" + name); + addError("No remote address was configured for appender" + name + " For more information, please visit http://logback.qos.ch/codes.html#socket_no_host"); } connect(address, port); @@ -242,7 +242,7 @@ if (address == null) { addError("No remote host is set for SocketAppender named \"" + this.name - + "\"."); + + "\". For more information, please visit http://logback.qos.ch/codes.html#socket_no_host"); return; } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java Thu Sep 14 18:24:46 2006 @@ -133,7 +133,7 @@ } if (this.layout == null) { - addError("No layout set for appender named [" + name + "]."); + addError("No layout set for appender named [" + name + "]. For more information, please visit http://logback.qos.ch/codes.html#smtp_no_layout"); return false; } return true; Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/SizeBasedTriggeringPolicy.java Thu Sep 14 18:24:46 2006 @@ -75,7 +75,7 @@ return Long.valueOf(s).longValue() * multiplier; } catch (NumberFormatException e) { - addError("[" + s + "] is not in proper int form."); + addError("[" + s + "] is not in proper int form. For more info, please visit http://logback.qos.ch/codes.html#sbtp_size_format"); addError("[" + value + "] not in expected format.", e); } } Modified: logback/trunk/logback-site/src/site/fml/codes.fml ============================================================================== --- logback/trunk/logback-site/src/site/fml/codes.fml (original) +++ logback/trunk/logback-site/src/site/fml/codes.fml Thu Sep 14 18:24:46 2006 @@ -1,30 +1,183 @@ -<?xml version="1.0" encoding="iso-8859-1"?> +<?xml version="1.0" encoding="iso-8859-1" ?> <document> - <body> + <body> - <faqs title="Logback error messages and their meanings"> - - <part id="Generalities"> - <title>Generalities</title> - - <faq id="tbr_fnp_not_set"> - - <question>The FileNamePattern option must be set before - using <code>TimeBasedRollingPolicy</code> or - <code>FixedWindowRollingPolicy</code>. - </question> - - <answer> - The FileNamePattern option for both - <code>TimeBasedRollingPolicy</code> and - <code>FixedWindowRollingPolicy</code> is mandatory. - - </answer> - - </faq> - </part> - </faqs> - </body> + <faqs title="Logback error messages and their meanings"> + <part id="Generalities"> + <title>Generalities</title> + + <faq id="tbr_fnp_not_set"> + + <question> + The + FileNamePattern + option must be set before using + <code>TimeBasedRollingPolicy</code> + or + <code>FixedWindowRollingPolicy</code> + . + </question> + + <answer> + + The + FileNamePattern + option for both + <code>TimeBasedRollingPolicy</code> + and + <code>FixedWindowRollingPolicy</code> + is mandatory. + + </answer> + + </faq> + <faq id="socket_no_host"> + <question> + No remote host or address is set for + <code>SocketAppender</code> + . + </question> + + <answer> + + A remote host or address is mandatory for + SocketAppender. + + + You can specify the remote host in the + configuration file like this: + + <pre> +<appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> + ... + <param name="remoteHost" value="127.0.0.1" /> + ... +</appender> + </pre> + </answer> + </faq> + <faq id="socket_no_port"> + <question> + No remote port is set for + <code>SocketAppender</code> + . + </question> + + <answer> + + A remote port is mandatory for + SocketAppender. + + + You can specify the remote port in the + configuration file like this: + + <pre> +<appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> + ... + <param name="port" value="4560" /> + ... +</appender> + </pre> + </answer> + </faq> + <faq id="smtp_no_tp"> + <question> + No + <code>TriggeringPolicy</code> + is set for appender + </question> + + <answer> + + A + <code>TriggeringPolicy</code> + is mandatory for + <code>SMTPAppender</code> + . It allows the appender to know when to + send the email to the specified address. + + + You can specify the + <code>TriggeringPolicy</code> + in the configuration file like this: + + <pre> +<appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender"> + ... + <param name="port" value="4560"/> + ... +</appender> + </pre> + </answer> + </faq> + <faq id="smtp_no_layout"> + <question> + No + <code>Layout</code> + is set for appender + </question> + + <answer> + + A + <code>Layout</code> + is mandatory for + <code>SMTPAppender</code> + . It allows the appender format the logging + events before sending the email. Two layouts + are often used with + <code>SMTPAppender</code> + : + <code>PatternLayout</code> + and + <code>HTMLLayout</code> + . + + + You can specify the + <code>Layout</code> + in the configuration file like this: + + <pre> +<appender name="SMTP" class="ch.qos.logback.classic.net.SMTPAppender"> + ... + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> + ... +</appender> + </pre> + </answer> + </faq> + <faq id="sbtp_size_format"> + <question> + Specified number is not in proper int form, or + not expected format. + </question> + + <answer> + + When you specify the MaxFileSize to be used + by the SizeBasedRollingPolicy, logback + expects a rather precise format: + + <ul> + <li>The number has to be an integer</li> + <li> + You can add 'KB', 'MB' or 'GB' after the + number. + </li> + </ul> + + Here are some correct values: 500KB, 15MB, + 2GB. + + </answer> + </faq> + </part> + </faqs> + </body> </document>

1 0

svn commit: r586 - logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net
by noreply.seb＠qos.ch 14 Sep '06

14 Sep '06

Author: seb Date: Thu Sep 14 15:59:36 2006 New Revision: 586 Added: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/LoggingEventSerializationTest.java Log: created a test that only tests Serialization of LoggingEvent and verifies that the context and mdc values are passed and are readable once the event has been deserialized. Added: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/LoggingEventSerializationTest.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/LoggingEventSerializationTest.java Thu Sep 14 15:59:36 2006 @@ -0,0 +1,136 @@ +package ch.qos.logback.classic.net; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.util.Map; + +import junit.framework.TestCase; +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.LoggerContext; +import ch.qos.logback.classic.MDC; +import ch.qos.logback.classic.spi.LoggerContextRemoteView; +import ch.qos.logback.classic.spi.LoggerRemoteView; +import ch.qos.logback.classic.spi.LoggingEvent; + +public class LoggingEventSerializationTest extends TestCase { + + LoggerContext lc; + Logger logger; + + ByteArrayOutputStream bos; + ObjectOutputStream oos; + ObjectInputStream inputStream; + + public void setUp() throws Exception { + super.setUp(); + lc = new LoggerContext(); + lc.setName("testContext"); + logger = lc.getLogger(LoggerContext.ROOT_NAME); + } + + public void tearDown() throws Exception { + super.tearDown(); + lc = null; + logger = null; + } + + public void testBasic() throws Exception { + // create the byte output stream + bos = new ByteArrayOutputStream(); + oos = new ObjectOutputStream(bos); + + LoggingEvent event = createLoggingEvent(); + oos.writeObject(event); + + // create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + LoggingEvent remoteEvent = (LoggingEvent) inputStream.readObject(); + + assertEquals("test message", remoteEvent.getMessage()); + assertEquals(Level.DEBUG, remoteEvent.getLevel()); + } + + public void testContext() throws Exception { + // create the byte output stream + bos = new ByteArrayOutputStream(); + oos = new ObjectOutputStream(bos); + + lc.setProperty("testKey", "testValue"); + LoggingEvent event = createLoggingEvent(); + oos.writeObject(event); + + // create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + LoggingEvent remoteEvent = (LoggingEvent) inputStream.readObject(); + + LoggerRemoteView loggerRemoteView = remoteEvent.getLoggerRemoteView(); + assertNotNull(loggerRemoteView); + assertEquals("root", loggerRemoteView.getName()); + + LoggerContextRemoteView loggerContextRemoteView = loggerRemoteView + .getLoggerContextView(); + assertNotNull(loggerContextRemoteView); + assertEquals("testContext", loggerContextRemoteView.getName()); + Map<String, String> props = loggerContextRemoteView.getPropertyMap(); + assertEquals("testValue", props.get("testKey")); + } + + public void testMDC() throws Exception { + // create the byte output stream + bos = new ByteArrayOutputStream(); + oos = new ObjectOutputStream(bos); + + MDC.put("key", "testValue"); + LoggingEvent event = createLoggingEvent(); + oos.writeObject(event); + + // create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + LoggingEvent remoteEvent = (LoggingEvent) inputStream.readObject(); + + Map<String, String> MDCPropertyMap = remoteEvent.getMDCPropertyMap(); + assertEquals("testValue", MDCPropertyMap.get("key")); + } + + public void testUpdatedMDC() throws Exception { + // create the byte output stream + bos = new ByteArrayOutputStream(); + oos = new ObjectOutputStream(bos); + + MDC.put("key", "testValue"); + LoggingEvent event1 = createLoggingEvent(); + oos.writeObject(event1); + + MDC.put("key", "updatedTestValue"); + LoggingEvent event2 = createLoggingEvent(); + oos.writeObject(event2); + + // create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + LoggingEvent remoteEvent1 = (LoggingEvent) inputStream.readObject(); + LoggingEvent remoteEvent2 = (LoggingEvent) inputStream.readObject(); + + // We observe the second logging event. It should provide us with + // the updated MDC property. + Map<String, String> MDCPropertyMap = remoteEvent2.getMDCPropertyMap(); + assertEquals("updatedTestValue", MDCPropertyMap.get("key")); + } + + private LoggingEvent createLoggingEvent() { + LoggingEvent le = new LoggingEvent(this.getClass().getName(), logger, + Level.DEBUG, "test message", null, null); + return le; + } + +}

1 0