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

svn commit: r422 - logback/core/trunk/src/main/java/ch/qos/logback/core/net
by noreply.ceki＠qos.ch 09 Aug '06

09 Aug '06

Author: ceki Date: Wed Aug 9 18:54:15 2006 New Revision: 422 Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogAppenderBase.java Log: Syslog relateed work Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogAppenderBase.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogAppenderBase.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogAppenderBase.java Wed Aug 9 18:54:15 2006 @@ -1,8 +1,6 @@ package ch.qos.logback.core.net; import java.io.IOException; -import java.net.InetAddress; -import java.net.UnknownHostException; import ch.qos.logback.core.AppenderBase; import ch.qos.logback.core.Layout; @@ -32,7 +30,7 @@ } } - abstract public Layout makeDefaultLayout(int facility); + abstract public Layout buildLayout(int facility); abstract public int getSeverityForEvent(Object eventObject); @@ -57,7 +55,7 @@ * * @throws IllegalArgumentException if the facility string is not recognized * */ - static int facilityStringToint(String facilityStr) { + static public int facilityStringToint(String facilityStr) { if ("KERN".equalsIgnoreCase(facilityStr)) { return SyslogConstants.LOG_KERN; } else if ("USER".equalsIgnoreCase(facilityStr)) {

1 0

svn commit: r421 - in logback/classic/trunk/src: main/java/ch/qos/logback/classic/net main/java/ch/qos/logback/classic/pattern test/java/ch/qos/logback/classic test/java/ch/qos/logback/classic/net test/java/ch/qos/logback/classic/pattern
by noreply.ceki＠qos.ch 09 Aug '06

09 Aug '06

Author: ceki Date: Wed Aug 9 18:53:49 2006 New Revision: 421 Added: logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/ logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/MockSyslogServer.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/PackageTest.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/SyslogAppenderTest.java Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java logback/classic/trunk/src/main/java/ch/qos/logback/classic/pattern/SyslogStartConverter.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/AllTest.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/pattern/ConverterTest.java Log: Syslog relateed work Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java Wed Aug 9 18:53:49 2006 @@ -10,6 +10,7 @@ package ch.qos.logback.classic.net; import ch.qos.logback.classic.PatternLayout; +import ch.qos.logback.classic.pattern.SyslogStartConverter; import ch.qos.logback.classic.spi.LoggingEvent; import ch.qos.logback.classic.util.LevelToSyslogSeverity; import ch.qos.logback.core.Layout; @@ -22,11 +23,22 @@ public class SyslogAppender extends SyslogAppenderBase { Layout layout; + String pattern; + String patternSuffix; - public Layout makeDefaultLayout(int facility) { + public Layout buildLayout(int facility) { PatternLayout pl = new PatternLayout(); - pl.getInstanceConverterMap().put("syslogStart", "sfsdf"); - pl.setPattern("%syslogStart{"+facility+"} "); + pl.getInstanceConverterMap().put("syslogStart", SyslogStartConverter.class.getName()); + + if(patternSuffix == null) { + patternSuffix = "%syslogStart{"+facility+"}"; + } + + if(pattern == null) { + pattern = "%m%exception"; + } + + pl.setPattern(patternSuffix+pattern); pl.setContext(getContext()); pl.start(); return pl; @@ -45,7 +57,8 @@ } /* - * Set the layout. + * Set the layout directly. Normally, for the user SyslogAppender would want to set + * the patterns and not the layout directly. * * @see ch.qos.logback.core.Appender#setLayout(ch.qos.logback.core.Layout) */ Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/pattern/SyslogStartConverter.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/pattern/SyslogStartConverter.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/pattern/SyslogStartConverter.java Wed Aug 9 18:53:49 2006 @@ -11,49 +11,44 @@ import java.net.InetAddress; import java.net.UnknownHostException; +import java.text.DateFormatSymbols; import java.text.SimpleDateFormat; import java.util.Date; -import java.util.List; -import java.util.TimeZone; +import java.util.Locale; import ch.qos.logback.classic.spi.LoggingEvent; import ch.qos.logback.classic.util.LevelToSyslogSeverity; -import ch.qos.logback.core.CoreGlobal; +import ch.qos.logback.core.net.SyslogAppenderBase; public class SyslogStartConverter extends ClassicConverter { long lastTimestamp = -1; String timesmapStr = null; - SimpleDateFormat simpleFormat = null; + SimpleDateFormat simpleFormat; String localHostName; int facility; public void start() { - - String datePattern = getFirstOption(); - if (datePattern == null) { - datePattern = CoreGlobal.ISO8601_PATTERN; + int errorCount = 0; + + String facilityStr = getFirstOption(); + if (facilityStr == null) { + //errorCount++; + addError("was expecting a facility string as an option"); + return; } + facility = SyslogAppenderBase.facilityStringToint(facilityStr); localHostName = getLocalHostname(); try { - simpleFormat = new SimpleDateFormat(datePattern); - // maximumCacheValidity = - // CachedDateFormat.getMaximumCacheValidity(pattern); + simpleFormat = new SimpleDateFormat("MMM dd hh:mm:ss", new DateFormatSymbols(Locale.US)); } catch (IllegalArgumentException e) { - getLogger().warn( - "Could not instantiate SimpleDateFormat with pattern " + datePattern, - e); - // default to the ISO8601 format - simpleFormat = new SimpleDateFormat(CoreGlobal.ISO8601_PATTERN); + addError("Could not instantiate SimpleDateFormat", e); + errorCount++; } - List optionList = getOptionList(); - - // if the option list contains a TZ option, then set it. - if (optionList != null && optionList.size() > 1) { - TimeZone tz = TimeZone.getTimeZone((String) optionList.get(1)); - simpleFormat.setTimeZone(tz); + if(errorCount == 0) { + super.start(); } } Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/AllTest.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/AllTest.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/AllTest.java Wed Aug 9 18:53:49 2006 @@ -22,6 +22,7 @@ suite.addTest(ch.qos.logback.classic.PackageTest.suite()); suite.addTest(ch.qos.logback.classic.pattern.PackageTest.suite()); suite.addTest(ch.qos.logback.classic.joran.PackageTest.suite()); + suite.addTest(ch.qos.logback.classic.net.PackageTest.suite()); return suite; } } Added: logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/MockSyslogServer.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/MockSyslogServer.java Wed Aug 9 18:53:49 2006 @@ -0,0 +1,35 @@ +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ +package ch.qos.logback.classic.net; + +import java.net.DatagramSocket; + +/** + * + * @author Ceki G&uumllcü + */ +public class MockSyslogServer extends Thread { + + final int loopLen; + DatagramSocket socket; + + MockSyslogServer(int loopLen) { + super(); + this.loopLen = loopLen; + + } + + @Override + public void run() { + for(int i = 0; i < loopLen; i++) { + + } + } +} Added: logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/PackageTest.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/PackageTest.java Wed Aug 9 18:53:49 2006 @@ -0,0 +1,24 @@ +/** + * LOGBack: the reliable, fast and flexible logging library for Java. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation. + */ +package ch.qos.logback.classic.net; + + +import junit.framework.Test; +import junit.framework.TestCase; +import junit.framework.TestSuite; + +public class PackageTest extends TestCase { + + public static Test suite() { + TestSuite suite = new TestSuite(); + suite.addTestSuite(SyslogAppenderTest.class); + return suite; + } +} \ No newline at end of file Added: logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/SyslogAppenderTest.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/net/SyslogAppenderTest.java Wed Aug 9 18:53:49 2006 @@ -0,0 +1,28 @@ +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ +package ch.qos.logback.classic.net; + +import junit.framework.TestCase; + +public class SyslogAppenderTest extends TestCase { + + public SyslogAppenderTest(String arg0) { + super(arg0); + } + + protected void setUp() throws Exception { + super.setUp(); + } + + protected void tearDown() throws Exception { + super.tearDown(); + } + +} Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/pattern/ConverterTest.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/pattern/ConverterTest.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/pattern/ConverterTest.java Wed Aug 9 18:53:49 2006 @@ -19,20 +19,9 @@ import org.slf4j.MarkerFactory; import ch.qos.logback.classic.Level; -import ch.qos.logback.classic.pattern.CallerDataConverter; -import ch.qos.logback.classic.pattern.ClassOfCallerConverter; -import ch.qos.logback.classic.pattern.FileOfCallerConverter; -import ch.qos.logback.classic.pattern.LevelConverter; -import ch.qos.logback.classic.pattern.LineOfCallerConverter; -import ch.qos.logback.classic.pattern.LineSeparatorConverter; -import ch.qos.logback.classic.pattern.LoggerConverter; -import ch.qos.logback.classic.pattern.MessageConverter; -import ch.qos.logback.classic.pattern.MethodOfCallerConverter; -import ch.qos.logback.classic.pattern.RelativeTimeConverter; -import ch.qos.logback.classic.pattern.ThreadConverter; -import ch.qos.logback.classic.pattern.ThrowableInformationConverter; import ch.qos.logback.classic.spi.LoggingEvent; import ch.qos.logback.core.CoreGlobal; +import ch.qos.logback.core.net.SyslogConstants; import ch.qos.logback.core.pattern.DynamicConverter; import ch.qos.logback.core.pattern.FormatInfo; @@ -82,7 +71,7 @@ StringBuffer buf = new StringBuffer(); converter.write(buf, le); // the number below should be the line number of the previous line - assertEquals("83", buf.toString()); + assertEquals("72", buf.toString()); } } @@ -281,5 +270,23 @@ } } } + + public void testSyslogStart() throws Exception { + { + DynamicConverter converter = new SyslogStartConverter(); + this.optionList.clear(); + this.optionList.add("MAIL"); + converter.setOptionList(this.optionList); + converter.start(); + + LoggingEvent event = makeLoggingEvent(null); + + StringBuffer buf = new StringBuffer(); + converter.write(buf, event); + + String expected = "<"+(SyslogConstants.LOG_MAIL+SyslogConstants.INFO_SEVERITY)+">"; + assertTrue(buf.toString().startsWith(expected)); + } + } }

1 0

svn commit: r420 - in logback/core/trunk/src: main/java/ch/qos/logback/core main/java/ch/qos/logback/core/net main/java/ch/qos/logback/core/pattern test/java/ch/qos/logback/core/pattern/parser
by noreply.ceki＠qos.ch 08 Aug '06

08 Aug '06

Author: ceki Date: Tue Aug 8 23:13:08 2006 New Revision: 420 Added: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogAppenderBase.java Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/FileAppender.java logback/core/trunk/src/main/java/ch/qos/logback/core/WriterAppender.java logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogConstants.java logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogWriter.java logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/AbstractPatternLayoutBaseTest.java Log: - on going work on SyslogAppender - added support for instance converter map in PatternLayout - various copyright related changes (minor) Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/FileAppender.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/FileAppender.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/FileAppender.java Tue Aug 8 23:13:08 2006 @@ -1,11 +1,11 @@ /** - * LOGBack: the reliable, fast and flexible logging library for Java. - * + * Logback: the reliable, generic, fast and flexible logging framework. + * * Copyright (C) 1999-2006, QOS.ch - * - * This library is free software, you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation. + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. */ package ch.qos.logback.core; Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/WriterAppender.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/WriterAppender.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/WriterAppender.java Tue Aug 8 23:13:08 2006 @@ -1,11 +1,11 @@ /** - * LOGBack: the reliable, fast and flexible logging library for Java. - * + * Logback: the reliable, generic, fast and flexible logging framework. + * * Copyright (C) 1999-2006, QOS.ch - * - * This library is free software, you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation. + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. */ package ch.qos.logback.core; Added: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogAppenderBase.java ============================================================================== --- (empty file) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogAppenderBase.java Tue Aug 8 23:13:08 2006 @@ -0,0 +1,148 @@ +package ch.qos.logback.core.net; + +import java.io.IOException; +import java.net.InetAddress; +import java.net.UnknownHostException; + +import ch.qos.logback.core.AppenderBase; +import ch.qos.logback.core.Layout; + +public abstract class SyslogAppenderBase extends AppenderBase { + + Layout layout; + int facility; + String facilityStr; + String syslogHost; + SyslogWriter sw; + //private String localHostname; + + public void start() { + int errorCount = 0; + if (facilityStr == null) { + addError("The Facility option is mandatory"); + errorCount++; + } + + facility = facilityStringToint(facilityStr); + + layout = getLayout(); + + if(errorCount == 0) { + super.start(); + } + } + + abstract public Layout makeDefaultLayout(int facility); + + abstract public int getSeverityForEvent(Object eventObject); + + @Override + protected void append(Object eventObject) { + if(!isStarted()) { + return; + } + try { + String msg = layout.doLayout(eventObject); + sw.write(msg); + sw.flush(); + } catch(IOException ioe) { + addError("Failed to send diagram to "+syslogHost, ioe); + stop(); + + } + } + + /** + * Returns the integer value corresponding to the named syslog facility. + * + * @throws IllegalArgumentException if the facility string is not recognized + * */ + static int facilityStringToint(String facilityStr) { + if ("KERN".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_KERN; + } else if ("USER".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_USER; + } else if ("MAIL".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_MAIL; + } else if ("DAEMON".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_DAEMON; + } else if ("AUTH".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_AUTH; + } else if ("SYSLOG".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_SYSLOG; + } else if ("LPR".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LPR; + } else if ("NEWS".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_NEWS; + } else if ("UUCP".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_UUCP; + } else if ("CRON".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_CRON; + } else if ("AUTHPRIV".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_AUTHPRIV; + } else if ("FTP".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_FTP; + } else if ("LOCAL0".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL0; + } else if ("LOCAL1".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL1; + } else if ("LOCAL2".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL2; + } else if ("LOCAL3".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL3; + } else if ("LOCAL4".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL4; + } else if ("LOCAL5".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL5; + } else if ("LOCAL6".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL6; + } else if ("LOCAL7".equalsIgnoreCase(facilityStr)) { + return SyslogConstants.LOG_LOCAL7; + } else { + throw new IllegalArgumentException(facilityStr + " is not a valid syslog facility string"); + } + } + + + /** + * Returns the value of the <b>SyslogHost</b> option. + */ + public String getSyslogHost() { + return syslogHost; + } + + /** + * The <b>SyslogHost</b> option is the name of the the syslog host where log + * output should go. + * + * <b>WARNING</b> If the SyslogHost is not set, then this appender will fail. + */ + public void setSyslogHost(String syslogHost) { + this.syslogHost = syslogHost; + } + + /** + * Returns the string value of the <b>Facility</b> option. + * + * See {@link #setFacility} for the set of allowed values. + */ + public String getFacility() { + return facilityStr; + } + + /** + * The <b>Facility</b> option must be set one of the strings KERN, + * USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, + * NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, + * LOCAL6, LOCAL7. Case is not important. + * + * <p>See {@link SyslogConstants} and RFC 3164 for more information about the + * <b>Facility</b> option. + */ + public void setFacility(String facilityStr) { + if(facilityStr != null) { + facilityStr = facilityStr.trim(); + } + this.facilityStr = facilityStr; + } +} Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogConstants.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogConstants.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogConstants.java Tue Aug 8 23:13:08 2006 @@ -1,14 +1,12 @@ package ch.qos.logback.core.net; /** - * Constants used by syslog daemon and transitively by {@link SyslogAppender}. + * Constants used by syslog daemon and transitively by {@link SyslogAppenderBase}. * * @author Ceki Gülcü **/ public class SyslogConstants { - - // Following constants extracted from RFC 3164, we multiply them by 8 // in order to precompute the facility part of PRI. // See RFC 3164, Section 4.1.1 for exact details. Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogWriter.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogWriter.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogWriter.java Tue Aug 8 23:13:08 2006 @@ -12,7 +12,7 @@ * SyslogWriter is a wrapper around the {@link DatagramSocket} class * so that it behaves like a {@link Writer}. */ -public class SyslogWriter extends Writer { +class SyslogWriter extends Writer { /** * The maximum length after which we discard the existing string buffer and * start anew. Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java Tue Aug 8 23:13:08 2006 @@ -27,6 +27,8 @@ Converter head; String pattern; + Map<String, String> instanceConverterMap = new HashMap<String, String>(); + /** * Concrete implementations of this class are responsible for elaborating the * mapping between pattern words and converters. @@ -39,20 +41,30 @@ * Returns a map where the default converter map is merged with the map * contained in the context. */ - public Map<String, String> getConverterMap() { - Map<String, String> map = new HashMap<String, String>(); + public Map<String, String> getEffectiveConverterMap() { + + Map<String, String> effectiveMap = new HashMap<String, String>(); + + + // add the least specific map fist Map<String, String> defaultMap = getDefaultConverterMap(); if (defaultMap != null) { - map.putAll(defaultMap); + effectiveMap.putAll(defaultMap); } + + // contextMap is more specific than the default map Context context = getContext(); if (context != null) { Map<String, String> contextMap = context.getConverterMap(); if (contextMap != null) { - map.putAll(contextMap); + effectiveMap.putAll(contextMap); } } - return map; + + // set the most specific map last + effectiveMap.putAll(instanceConverterMap); + + return effectiveMap; } public void start() { @@ -62,7 +74,7 @@ p.setStatusManager(getContext().getStatusManager()); } Node t = p.parse(); - this.head = p.compile(t, getConverterMap()); + this.head = p.compile(t, getEffectiveConverterMap()); postCompileProcessing(head); DynamicConverter.startConverters(this.head); super.start(); @@ -129,4 +141,8 @@ } return c; } + + public Map<String, String> getInstanceConverterMap() { + return instanceConverterMap; + } } Modified: logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/AbstractPatternLayoutBaseTest.java ============================================================================== --- logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/AbstractPatternLayoutBaseTest.java (original) +++ logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/AbstractPatternLayoutBaseTest.java Tue Aug 8 23:13:08 2006 @@ -46,10 +46,12 @@ */ public void testConverterStart() { PatternLayoutBase plb = getPatternLayoutBase(); - plb.getConverterMap().put("EX", ExceptionalConverter.class.getName()); + plb.getInstanceConverterMap().put("EX", ExceptionalConverter.class.getName()); plb.setPattern("%EX"); plb.start(); - plb.doLayout(getEventObject()); + String result = plb.doLayout(getEventObject()); + assertFalse(result.contains("%PARSER_ERROR_EX")); + System.out.println("========="+result); } public void testStarted() {

1 0

svn commit: r419 - in logback/classic/trunk/src/main/java/ch/qos/logback/classic: net pattern util
by noreply.ceki＠qos.ch 08 Aug '06

08 Aug '06

Author: ceki Date: Tue Aug 8 23:13:05 2006 New Revision: 419 Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/ logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java logback/classic/trunk/src/main/java/ch/qos/logback/classic/pattern/SyslogStartConverter.java logback/classic/trunk/src/main/java/ch/qos/logback/classic/util/LevelToSyslogSeverity.java Log: - on going work on SyslogAppender - added support for instance converter map in PatternLayout - various copyright related changes (minor) Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java Tue Aug 8 23:13:05 2006 @@ -0,0 +1,64 @@ +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ +package ch.qos.logback.classic.net; + +import ch.qos.logback.classic.PatternLayout; +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.classic.util.LevelToSyslogSeverity; +import ch.qos.logback.core.Layout; +import ch.qos.logback.core.net.SyslogAppenderBase; + +/** + * + * @author Ceki G&uumllcü + */ +public class SyslogAppender extends SyslogAppenderBase { + + Layout layout; + + public Layout makeDefaultLayout(int facility) { + PatternLayout pl = new PatternLayout(); + pl.getInstanceConverterMap().put("syslogStart", "sfsdf"); + pl.setPattern("%syslogStart{"+facility+"} "); + pl.setContext(getContext()); + pl.start(); + return pl; + } + + /* + * Convert a level to equivalent syslog severity. Only levels for printing methods + * i.e DEBUG, WARN, INFO and ERROR are converted. + * + * @see ch.qos.logback.core.net.SyslogAppenderBase#getSeverityForEvent(java.lang.Object) + */ + @Override + public int getSeverityForEvent(Object eventObject) { + LoggingEvent event = (LoggingEvent) eventObject; + return LevelToSyslogSeverity.convert(event); + } + + /* + * Set the layout. + * + * @see ch.qos.logback.core.Appender#setLayout(ch.qos.logback.core.Layout) + */ + public void setLayout(Layout layout) { + this.layout = layout; + } + + /* + * + * @see ch.qos.logback.core.Appender#getLayout() + */ + public Layout getLayout() { + return layout; + } + +} Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/pattern/SyslogStartConverter.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/pattern/SyslogStartConverter.java Tue Aug 8 23:13:05 2006 @@ -0,0 +1,102 @@ +/** + * LOGBack: the reliable, fast and flexible logging library for Java. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation. + */ +package ch.qos.logback.classic.pattern; + +import java.net.InetAddress; +import java.net.UnknownHostException; +import java.text.SimpleDateFormat; +import java.util.Date; +import java.util.List; +import java.util.TimeZone; + +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.classic.util.LevelToSyslogSeverity; +import ch.qos.logback.core.CoreGlobal; + +public class SyslogStartConverter extends ClassicConverter { + + long lastTimestamp = -1; + String timesmapStr = null; + SimpleDateFormat simpleFormat = null; + String localHostName; + int facility; + + public void start() { + + String datePattern = getFirstOption(); + if (datePattern == null) { + datePattern = CoreGlobal.ISO8601_PATTERN; + } + + localHostName = getLocalHostname(); + try { + simpleFormat = new SimpleDateFormat(datePattern); + // maximumCacheValidity = + // CachedDateFormat.getMaximumCacheValidity(pattern); + } catch (IllegalArgumentException e) { + getLogger().warn( + "Could not instantiate SimpleDateFormat with pattern " + datePattern, + e); + // default to the ISO8601 format + simpleFormat = new SimpleDateFormat(CoreGlobal.ISO8601_PATTERN); + } + + List optionList = getOptionList(); + + // if the option list contains a TZ option, then set it. + if (optionList != null && optionList.size() > 1) { + TimeZone tz = TimeZone.getTimeZone((String) optionList.get(1)); + simpleFormat.setTimeZone(tz); + } + } + + public String convert(Object event) { + LoggingEvent le = (LoggingEvent) event; + StringBuilder sb = new StringBuilder(); + + int pri = facility + LevelToSyslogSeverity.convert(le); + System.out.println("" + pri); + sb.append("<"); + sb.append(pri); + sb.append(">"); + fillInTimestamp(sb, le.getTimeStamp()); + sb.append(' '); + sb.append(localHostName); + sb.append(' '); + + return sb.toString(); + } + + /** + * This method gets the network name of the machine we are running on. + * Returns "UNKNOWN_LOCALHOST" in the unlikely case where the host name + * cannot be found. + * @return String the name of the local host + */ + public String getLocalHostname() { + try { + InetAddress addr = InetAddress.getLocalHost(); + return addr.getHostName(); + } catch (UnknownHostException uhe) { + addError("Could not determine local host name", uhe); + return "UNKNOWN_LOCALHOST"; + } + } + + void fillInTimestamp(StringBuilder sb, long timestamp) { + // if called multiple times within the same millisecond + // use last value + if (timestamp != lastTimestamp) { + lastTimestamp = timestamp; + timesmapStr = simpleFormat.format(new Date(timestamp)); + } + sb.append(timesmapStr); + } +} Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/util/LevelToSyslogSeverity.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/util/LevelToSyslogSeverity.java Tue Aug 8 23:13:05 2006 @@ -0,0 +1,42 @@ +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. + */ + +package ch.qos.logback.classic.util; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.net.SyslogConstants; + +public class LevelToSyslogSeverity { + + /* + * Convert a level to equivalent syslog severity. Only levels for printing methods + * i.e DEBUG, WARN, INFO and ERROR are converted. + * + */ + static public int convert(LoggingEvent event) { + + Level level = event.getLevel(); + + switch (level.levelInt) { + case Level.ERROR_INT: + return SyslogConstants.ERROR_SEVERITY; + case Level.WARN_INT: + return SyslogConstants.WARNING_SEVERITY; + case Level.INFO_INT: + return SyslogConstants.INFO_SEVERITY; + case Level.DEBUG_INT: + return SyslogConstants.LOG_ALERT; + default: + throw new IllegalArgumentException("Level " + level + + " is not a valid level for a printing method"); + } + } +}

1 0

svn commit: r418 - in logback/classic/trunk: examples/src/chapter1 src/main/java/ch/qos/logback src/main/java/ch/qos/logback/classic src/main/java/ch/qos/logback/classic/joran/action src/main/java/org/slf4j/impl src/test/java/ch/qos/logback/classic src/test/java/ch/qos/logback/classic/joran
by noreply.seb＠qos.ch 08 Aug '06

08 Aug '06

Author: seb Date: Tue Aug 8 21:16:32 2006 New Revision: 418 Removed: logback/classic/trunk/src/main/java/org/slf4j/impl/LBLoggerFactory.java Modified: logback/classic/trunk/examples/src/chapter1/MyAppWithConfigFile.java logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java logback/classic/trunk/src/main/java/ch/qos/logback/classic/LoggerContext.java logback/classic/trunk/src/main/java/ch/qos/logback/classic/joran/action/RootLoggerAction.java logback/classic/trunk/src/main/java/org/slf4j/impl/StaticLoggerBinder.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/BasicLoggerTest.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/LoggerContextTest.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java Log: - LoggerContext now implements SLF4J's ILoggerFactory, consequently we could get rid of org.slf4j.impl.LBLoggerFactory class - In LoggerContext, the getRootLogger method has been replaced by getLogger("root"); Modified: logback/classic/trunk/examples/src/chapter1/MyAppWithConfigFile.java ============================================================================== --- logback/classic/trunk/examples/src/chapter1/MyAppWithConfigFile.java (original) +++ logback/classic/trunk/examples/src/chapter1/MyAppWithConfigFile.java Tue Aug 8 21:16:32 2006 @@ -1,19 +1,21 @@ package chapter1; //Import SLF4J classes. +import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.LoggerContext; import ch.qos.logback.classic.joran.JoranConfigurator; import ch.qos.logback.core.util.StatusPrinter; public class MyAppWithConfigFile { public static void main(String[] args) { - Logger logger = (Logger) LoggerFactory.getLogger(MyAppWithConfigFile.class); + Logger logger = LoggerFactory.getLogger(MyAppWithConfigFile.class); + LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); JoranConfigurator configurator = new JoranConfigurator(); - configurator.setContext(logger.getLoggerContext()); + configurator.setContext(lc); configurator.doConfigure(args[0]); logger.info("Entering application."); @@ -21,6 +23,6 @@ bar.doIt(); logger.info("Exiting application."); - StatusPrinter.print(logger.getLoggerContext().getStatusManager()); + StatusPrinter.print(lc.getStatusManager()); } } Modified: logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java Tue Aug 8 21:16:32 2006 @@ -19,13 +19,12 @@ ca.setLayout(pl); ca.start(); - Logger rootLogger = lc.getRootLogger(); + Logger rootLogger = lc.getLogger(LoggerContext.ROOT_NAME); rootLogger.addAppender(ca); } public static void configureDefaultContext() { - Logger logger = (Logger) LoggerFactory.getLogger(BasicConfigurator.class); - LoggerContext lc = logger.getLoggerContext(); + LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); configure(lc); } } Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/LoggerContext.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/LoggerContext.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/LoggerContext.java Tue Aug 8 21:16:32 2006 @@ -1,11 +1,11 @@ /** - * LOGBack: the reliable, fast and flexible logging library for Java. - * - * Copyright (C) 1999-2005, QOS.ch, LOGBack.com - * - * This library is free software, you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation. + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. */ package ch.qos.logback.classic; @@ -13,6 +13,8 @@ import java.util.HashMap; import java.util.Hashtable; +import org.slf4j.ILoggerFactory; + import ch.qos.logback.core.ContextBase; import ch.qos.logback.core.CoreGlobal; import ch.qos.logback.core.status.ErrorStatus; @@ -21,9 +23,11 @@ /** * @author ceki */ -public class LoggerContext extends ContextBase { +public class LoggerContext extends ContextBase implements ILoggerFactory { - private Logger root; + public static final String ROOT_NAME = "root"; + + final Logger root; private int size; private int noAppenderWarning = 0; @@ -42,22 +46,19 @@ putObject(CoreGlobal.EVALUATOR_MAP, new HashMap()); } - /** - * Return this contexts root logger - * - * @return - */ - public Logger getRootLogger() { - return root; - } - public final Logger getLogger(final Class clazz) { return getLogger(clazz.getName()); } public final Logger getLogger(final String name) { + //if we are asking for the root logger, then let us return it without wasting time + if (ROOT_NAME.equalsIgnoreCase(name)) { + return root; + } + int i = 0; Logger logger = root; + Logger childLogger = (Logger) loggerCache.get(name); // if we have the child, then let us return it without wasting time if (childLogger != null) { Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/joran/action/RootLoggerAction.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/joran/action/RootLoggerAction.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/joran/action/RootLoggerAction.java Tue Aug 8 21:16:32 2006 @@ -17,7 +17,6 @@ import ch.qos.logback.core.joran.action.Action; import ch.qos.logback.core.joran.spi.ExecutionContext; - public class RootLoggerAction extends Action { static final String NAME_ATTR = "name"; static final String CLASS_ATTR = "class"; @@ -33,7 +32,7 @@ //logger.debug("In begin method"); LoggerContext loggerContext = (LoggerContext) this.context; - root = loggerContext.getRootLogger(); + root = loggerContext.getLogger(LoggerContext.ROOT_NAME); //getLogger().debug("Pushing root logger on stack"); ec.pushObject(root); Modified: logback/classic/trunk/src/main/java/org/slf4j/impl/StaticLoggerBinder.java ============================================================================== --- logback/classic/trunk/src/main/java/org/slf4j/impl/StaticLoggerBinder.java (original) +++ logback/classic/trunk/src/main/java/org/slf4j/impl/StaticLoggerBinder.java Tue Aug 8 21:16:32 2006 @@ -1,9 +1,11 @@ package org.slf4j.impl; -import org.slf4j.LoggerFactory; import org.slf4j.ILoggerFactory; +import org.slf4j.LoggerFactory; import org.slf4j.spi.LoggerFactoryBinder; +import ch.qos.logback.classic.LoggerContext; + /** * * The binding of {@link LoggerFactory} class with an actual instance of @@ -17,7 +19,7 @@ * The unique instance of this class. */ public static final StaticLoggerBinder SINGLETON = new StaticLoggerBinder(); - private static final String loggerFactoryClassStr = LBLoggerFactory.class.getName(); + private static final String loggerFactoryClassStr = LoggerContext.class.getName(); /** The ILoggerFactory instance returned by the {@link #getLoggerFactory} method * should always be the same object @@ -25,7 +27,9 @@ private final ILoggerFactory loggerFactory; private StaticLoggerBinder() { - loggerFactory = new LBLoggerFactory(); + LoggerContext lc = new LoggerContext(); + lc.setName("default"); + loggerFactory = lc; } public ILoggerFactory getLoggerFactory() { Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/BasicLoggerTest.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/BasicLoggerTest.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/BasicLoggerTest.java Tue Aug 8 21:16:32 2006 @@ -1,5 +1,5 @@ /** - * LOGBack: the generic, reliable, fast and flexible logging framework. + * Logback: the reliable, generic, fast and flexible logging framework. * * Copyright (C) 1999-2006, QOS.ch * @@ -11,8 +11,9 @@ import junit.framework.TestCase; -import ch.qos.logback.classic.Logger; -import ch.qos.logback.classic.LoggerContext; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.BasicConfigurator; import ch.qos.logback.core.appender.ListAppender; import ch.qos.logback.core.util.StatusPrinter; @@ -23,7 +24,7 @@ LoggerContext lc = new LoggerContext(); ListAppender listAppender = new ListAppender(); listAppender.start(); - Logger root = lc.getRootLogger(); + Logger root = lc.getLogger(LoggerContext.ROOT_NAME); root.addAppender(listAppender); Logger logger = lc.getLogger(BasicLoggerTest.class); assertEquals(0, listAppender.list.size()); @@ -36,7 +37,7 @@ ListAppender listAppender = new ListAppender(); //listAppender.start(); listAppender.setContext(lc); - Logger root = lc.getRootLogger(); + Logger root = lc.getLogger(LoggerContext.ROOT_NAME); root.addAppender(listAppender); Logger logger = lc.getLogger(BasicLoggerTest.class); logger.debug("hello"); @@ -44,11 +45,10 @@ } public void testAdditive() { - { LoggerContext lc = new LoggerContext(); ListAppender listAppender = new ListAppender(); listAppender.start(); - Logger root = lc.getRootLogger(); + Logger root = lc.getLogger(LoggerContext.ROOT_NAME); root.addAppender(listAppender); Logger logger = lc.getLogger(BasicLoggerTest.class); logger.addAppender(listAppender); @@ -56,6 +56,14 @@ logger.debug("hello"); // 1 instead of two, since logger is not additive assertEquals(1, listAppender.list.size()); - } + } + + public void testRootLogger() { + Logger logger = (Logger)LoggerFactory.getLogger(LoggerContext.ROOT_NAME); + LoggerContext lc = logger.getLoggerContext(); + + assertNotNull("Returned logger is null", logger); + assertEquals("Return logger isn't named root", logger.getName(), LoggerContext.ROOT_NAME); + assertTrue("logger instances should be indentical", logger == lc.root); } } Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/LoggerContextTest.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/LoggerContextTest.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/LoggerContextTest.java Tue Aug 8 21:16:32 2006 @@ -23,7 +23,7 @@ } public void testRootGetLogger() { - Logger root = lc.getRootLogger(); + Logger root = lc.getLogger(LoggerContext.ROOT_NAME); assertEquals(Level.DEBUG, root.getLevel()); assertEquals(Level.DEBUG, root.getEffectiveLevel()); } Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java Tue Aug 8 21:16:32 2006 @@ -34,7 +34,7 @@ StatusPrinter.print(loggerContext.getStatusManager()); Logger logger = loggerContext.getLogger(this.getClass().getName()); - Logger root = loggerContext.getRootLogger(); + Logger root = loggerContext.getLogger(LoggerContext.ROOT_NAME); ListAppender listAppender = (ListAppender) root.getAppender("LIST"); assertEquals(0, listAppender.list.size()); String msg = "hello world"; @@ -53,7 +53,7 @@ StatusPrinter.print(loggerContext.getStatusManager()); Logger logger = loggerContext.getLogger(this.getClass().getName()); - Logger root = loggerContext.getRootLogger(); + Logger root = loggerContext.getLogger(LoggerContext.ROOT_NAME); ListAppender listAppender = (ListAppender) root.getAppender("LIST"); assertEquals(0, listAppender.list.size()); String msg = "hello world";

1 0

svn commit: r417 - logback/classic/trunk/src/site/xdocTemplates
by noreply.seb＠qos.ch 08 Aug '06

08 Aug '06

Author: seb Date: Tue Aug 8 19:55:34 2006 New Revision: 417 Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Log: Px now is Lx Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Tue Aug 8 19:55:34 2006 @@ -441,19 +441,19 @@ </tr> <tr align="left"> <td>X</td> - <td>P<sub>x</sub></td> - <td>P<sub>x</sub></td> + <td>L<sub>x</sub></td> + <td>L<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y</td> - <td>P<sub>xy</sub></td> - <td>P<sub>xy</sub></td> + <td>L<sub>xy</sub></td> + <td>L<sub>xy</sub></td> </tr> <tr align="left"> <td>X.Y.Z</td> - <td>P<sub>xyz</sub></td> - <td>P<sub>xyz</sub></td> + <td>L<sub>xyz</sub></td> + <td>L<sub>xyz</sub></td> </tr> </table> @@ -488,24 +488,24 @@ <tr align="left"> <td>X</td> - <td>P<sub>x</sub></td> - <td>P<sub>x</sub></td> + <td>L<sub>x</sub></td> + <td>L<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y</td> <td>none</td> - <td>P<sub>x</sub></td> + <td>L<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y.Z</td> - <td>P<sub>xyz</sub></td> - <td>P<sub>xyz</sub></td> + <td>L<sub>xyz</sub></td> + <td>L<sub>xyz</sub></td> </tr> </table> <p> In example 3, the loggers <code>root</code>, <code>X</code> and <code>X.Y.Z</code> are assigned the levels <code>L<sub>root</sub></code>, - <code>P<sub>x</sub></code> and <code>P<sub>xyz</sub></code> + <code>L<sub>x</sub></code> and <code>L<sub>xyz</sub></code> respectively. The logger <code>X.Y</code> inherits its level value from its parent <code>X</code>. </p> @@ -536,25 +536,25 @@ <tr align="left"> <td>X</td> - <td>P<sub>x</sub></td> - <td>P<sub>x</sub></td> + <td>L<sub>x</sub></td> + <td>L<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y</td> <td>none</td> - <td>P<sub>x</sub></td> + <td>L<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y.Z</td> <td>none</td> - <td>P<sub>x</sub></td> + <td>L<sub>x</sub></td> </tr> </table> <p> In example 4, the loggers <code>root</code> and <code>X</code> and are assigned the levels <code>L<sub>root</sub></code> and - <code>P<sub>x</sub></code> respectively. The loggers <code>X.Y</code> and + <code>L<sub>x</sub></code> respectively. The loggers <code>X.Y</code> and <code>X.Y.Z</code> inherits their level value from their nearest parent <code>X</code> having an assigned level. </p>

1 0

svn commit: r416 - in logback/classic/trunk: examples/src/chapter1 src/site/xdocTemplates
by noreply.seb＠qos.ch 08 Aug '06

08 Aug '06

Author: seb Date: Tue Aug 8 15:59:11 2006 New Revision: 416 Added: logback/classic/trunk/examples/src/chapter1/Bar.java logback/classic/trunk/examples/src/chapter1/HelloWorld1.java logback/classic/trunk/examples/src/chapter1/HelloWorld2.java logback/classic/trunk/examples/src/chapter1/HelloWorld3.java logback/classic/trunk/examples/src/chapter1/MyApp.java logback/classic/trunk/examples/src/chapter1/MyAppWithConfigFile.java logback/classic/trunk/examples/src/chapter1/sample-config-1.xml logback/classic/trunk/examples/src/chapter1/sample-config-2.xml logback/classic/trunk/examples/src/chapter1/sample-config-3.xml Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Log: modified examples, updated documentation and css styles accordingly Added: logback/classic/trunk/examples/src/chapter1/Bar.java ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/Bar.java Tue Aug 8 15:59:11 2006 @@ -0,0 +1,11 @@ +package chapter1; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +class Bar { + Logger logger = LoggerFactory.getLogger(Bar.class); + public void doIt() { + logger.debug("doing my job"); + } +} \ No newline at end of file Added: logback/classic/trunk/examples/src/chapter1/HelloWorld1.java ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/HelloWorld1.java Tue Aug 8 15:59:11 2006 @@ -0,0 +1,13 @@ +package chapter1; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class HelloWorld1 { + + public static void main(String[] args) { + + Logger logger = LoggerFactory.getLogger(HelloWorld1.class); + logger.debug("Hello world."); + } +} Added: logback/classic/trunk/examples/src/chapter1/HelloWorld2.java ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/HelloWorld2.java Tue Aug 8 15:59:11 2006 @@ -0,0 +1,15 @@ +package chapter1; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.classic.util.LoggerStatusPrinter; + +public class HelloWorld2 { + + public static void main(String[] args) { + Logger logger = LoggerFactory.getLogger(HelloWorld2.class); + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + } +} Added: logback/classic/trunk/examples/src/chapter1/HelloWorld3.java ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/HelloWorld3.java Tue Aug 8 15:59:11 2006 @@ -0,0 +1,18 @@ +package chapter1; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.BasicConfigurator; +import ch.qos.logback.classic.util.LoggerStatusPrinter; + +public class HelloWorld3 { + + public static void main(String[] args) { + Logger logger = LoggerFactory.getLogger(HelloWorld3.class); + + BasicConfigurator.configureDefaultContext(); + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + } +} Added: logback/classic/trunk/examples/src/chapter1/MyApp.java ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/MyApp.java Tue Aug 8 15:59:11 2006 @@ -0,0 +1,22 @@ +package chapter1; + +// Import SLF4J classes. +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.BasicConfigurator; + +public class MyApp { + + public static void main(String[] args) { + // Set up a simple configuration that logs on the console. + BasicConfigurator.configureDefaultContext(); + + Logger logger = LoggerFactory.getLogger(MyApp.class); + + logger.info("Entering application."); + Bar bar = new Bar(); + bar.doIt(); + logger.info("Exiting application."); + } +} Added: logback/classic/trunk/examples/src/chapter1/MyAppWithConfigFile.java ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/MyAppWithConfigFile.java Tue Aug 8 15:59:11 2006 @@ -0,0 +1,26 @@ +package chapter1; + +//Import SLF4J classes. +import org.slf4j.LoggerFactory; + +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.joran.JoranConfigurator; +import ch.qos.logback.core.util.StatusPrinter; + +public class MyAppWithConfigFile { + + public static void main(String[] args) { + Logger logger = (Logger) LoggerFactory.getLogger(MyAppWithConfigFile.class); + + JoranConfigurator configurator = new JoranConfigurator(); + configurator.setContext(logger.getLoggerContext()); + configurator.doConfigure(args[0]); + + logger.info("Entering application."); + Bar bar = new Bar(); + bar.doIt(); + logger.info("Exiting application."); + + StatusPrinter.print(logger.getLoggerContext().getStatusManager()); + } +} Added: logback/classic/trunk/examples/src/chapter1/sample-config-1.xml ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/sample-config-1.xml Tue Aug 8 15:59:11 2006 @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <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="STDOUT" /> + </root> +</configuration> Added: logback/classic/trunk/examples/src/chapter1/sample-config-2.xml ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/sample-config-2.xml Tue Aug 8 15:59:11 2006 @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" + value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> + </appender> + + <appender name="FILE" + class="ch.qos.logback.core.FileAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" + value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> + <param name="File" + value="sample-log.txt" /> + </appender> + + <root> + <level value="debug" /> + <appender-ref ref="STDOUT" /> + <appender-ref ref="FILE" /> + </root> +</configuration> Added: logback/classic/trunk/examples/src/chapter1/sample-config-3.xml ============================================================================== --- (empty file) +++ logback/classic/trunk/examples/src/chapter1/sample-config-3.xml Tue Aug 8 15:59:11 2006 @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" + value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> + </appender> + + <appender name="FILE" + class="ch.qos.logback.core.FileAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" + value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> + <param name="File" + value="sample-log.txt" /> + </appender> + + <logger name="chapter1"> + <level value="info" /> + </logger> + + <root> + <level value="debug" /> + <appender-ref ref="STDOUT" /> + <appender-ref ref="FILE" /> + </root> +</configuration> Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Tue Aug 8 15:59:11 2006 @@ -83,6 +83,10 @@ HTPP-access log functionality. The Access module will be covered in a separate document. </p> + <p> + In this document, we will use the word logback to refer to the + logback classic module. + </p> <h2>First Baby Step</h2> @@ -94,7 +98,7 @@ to your classpath, you can begin experimenting with logback. </p> -<div class="source"><em>Example 1.1: Basic template for logging (examples/HelloWorld1.java)</em> +<div class="source"><em>Example 1.1: Basic template for logging (examples/chapter1/HelloWorld1.java)</em> package chapter1; import org.slf4j.Logger; @@ -108,8 +112,7 @@ logger.debug("Hello world."); } -} -</div> +}</div> <p> The <code>HelloWorld</code> class is defined in the @@ -165,7 +168,7 @@ class. </p> -<div class="source"><em>Example 1.2: Printing Logger Status (examples/HelloWorld2.java)</em> +<div class="source"><em>Example 1.2: Printing Logger Status (examples/chapter1/HelloWorld2.java)</em> package chapter1; import org.slf4j.Logger; @@ -179,8 +182,7 @@ logger.debug("Hello world."); <b>LoggerStatusPrinter.printStatusInDefaultContext();</b> } -} -</div> +}</div> <p>Running the <code>HelloWorld2</code> application will produce @@ -202,12 +204,12 @@ </p> <p> - Configuring logback classic can be done a different ways. The + Configuring logback can be done a different ways. The simplest but less flexible way is by calling the <code>BasicConfigurator</code> class, like in the following code snippet. </p> - <div class="source"><em>Example 1.3: Configuring before logging (examples/HelloWorld3.java)</em> -package ch.qos.logback.classic.examples; + <div class="source"><em>Example 1.3: Configuring before logging (examples/chapter1/HelloWorld3.java)</em> +package chapter1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -224,8 +226,7 @@ LoggerStatusPrinter.printStatusInDefaultContext(); } -} -</div> +}</div> <p> Let's run the <code>HelloWorld3</code> @@ -234,9 +235,7 @@ The logging request will then be propagated to the Appender and the console will output the following: </p> -<div class="source"> -0 [main] DEBUG ch.qos.logback.classic.examples.HelloWorld3 - Hello world. -</div> +<div class="source">0 [main] DEBUG chapter1.HelloWorld3 - Hello world.</div> <p> This example is very simple. However, actual logging in a larger @@ -253,7 +252,7 @@ </p> <ol> - <li>Configure the logback classic environment. You can do it using several + <li>Configure the logback environment. You can do it using several sophisticated ways. The BasicConfigurator is the simplest but also least flexible.</li> <li>In every class where you wish to perform logging, retrieve a Logger instance by invoking the LoggerFactory and passing the current class as the parameter.</li> @@ -266,7 +265,7 @@ <h2>Logger, Appenders and Layouts</h2> </div> <p> - Logback classic has three main components: Loggers, + Logback has three main components: Loggers, Appenders and Layouts. These three types of components work together to enable developers to log messages according to message type and level, and to control at runtime how these @@ -278,7 +277,7 @@ of logback. </p> - <h3>Logger hierarchy</h3> + <h3>Logger context</h3> <p> The first and foremost advantage of any logging API over @@ -287,14 +286,14 @@ unhindered. This capability assumes that the logging space, that is, the space of all possible logging statements, is categorized according to some developer-chosen criteria. - Loggers are named entities. </p> + <p> - Logger names are case-sensitive and they follow the - hierarchical naming rule: + In logback, Loggers are named entities. Their names are case-sensitive and they follow the + contextual naming rule: </p> <div class="definition"> - <div class="deftitle">Named Hierarchy</div> + <div class="deftitle">Named Context</div> <p> A logger is said to be an ancestor of another logger if its name followed by a dot is a prefix of the descendant @@ -313,7 +312,7 @@ This naming scheme should be familiar to most developers. </p> <p> - The root logger resides at the top of the logger hierarchy. + The root logger resides at the top of the logger context. It is exceptional in a way that is always exists. Like every logger, it can be retrieved by its name, like this: </p> @@ -326,23 +325,21 @@ methods in the Logger interface are listed below. </p> - <div class="source">package org.slf4j; public interface Logger { + <div class="source">package org.slf4j; +public interface Logger { -// Creation and retrieval method: -public static LoggergetLogger(String name); - -// Printing methods: -public void debug(Object message); -public void info(Object message); -public void warn(Object message); -public void error(Object message); -public void fatal(Object message); + // Printing methods: + public void debug(Object message); + public void info(Object message); + public void warn(Object message); + public void error(Object message); + public void fatal(Object message); }</div> <p> Loggers may be assigned levels. The set of possible levels, that is DEBUG, INFO, WARN and ERROR are defined in the - ch.qos.logback.classic.Level class. The level class cannot + <em>ch.qos.logback.classic.Level</em> class. The level class cannot be sub-classed as a much better approach exist in the form of Marker objects. </p> @@ -357,8 +354,8 @@ <div class="deftitle">Level Inheritance</div> <p> The inherited level for a given logger <em>L</em>, - is equal to the first non-null level in the logger hierarchy, starting at - <em>L</em> and proceeding upwards in the hierarchy towards the root logger. + is equal to the first non-null level in the logger context, starting at + <em>L</em> and proceeding upwards in the context towards the root logger. </p> </div> <p> @@ -371,7 +368,7 @@ rule. </p> - <table class="exampleTable"> + <table> <tr> <th> Logger @@ -392,33 +389,33 @@ </tr> <tr> <td>root</td> - <td>Proot</td> - <td>Proot</td> + <td>L<sub>root</sub></td> + <td>L<sub>root</sub></td> </tr> <tr> <td>X</td> <td>none</td> - <td>Proot</td> + <td>L<sub>root</sub></td> </tr> <tr> <td>X.Y</td> <td>none</td> - <td>Proot</td> + <td>L<sub>root</sub></td> </tr> <tr> <td>X.Y.Z</td> <td>none</td> - <td>Proot</td> + <td>L<sub>root</sub></td> </tr> </table> <p> In example 1 above, only the root logger is assigned a level. </p> - This level value, <code>Proot</code>, is inherited by the other loggers + This level value, <code>L<sub>root</sub></code>, is inherited by the other loggers <code>X</code>, <code>X.Y</code> and <code>X.Y.Z</code> - <table class="exampleTable"> + <table> <tr> <th> Logger @@ -439,24 +436,24 @@ </tr> <tr align="left"> <td>root</td> - <td>Proot</td> - <td>Proot</td> + <td>L<sub>root</sub></td> + <td>L<sub>root</sub></td> </tr> <tr align="left"> <td>X</td> - <td>Px</td> - <td>Px</td> + <td>P<sub>x</sub></td> + <td>P<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y</td> - <td>Pxy</td> - <td>Pxy</td> + <td>P<sub>xy</sub></td> + <td>P<sub>xy</sub></td> </tr> <tr align="left"> <td>X.Y.Z</td> - <td>Pxyz</td> - <td>Pxyz</td> + <td>P<sub>xyz</sub></td> + <td>P<sub>xyz</sub></td> </tr> </table> @@ -465,7 +462,7 @@ There is no need for level inheritence. </p> - <table class="exampleTable"> + <table> <tr> <th> Logger @@ -485,34 +482,34 @@ </tr> <tr align="left"> <td>root</td> - <td>Proot</td> - <td>Proot</td> + <td>L<sub>root</sub></td> + <td>L<sub>root</sub></td> </tr> <tr align="left"> <td>X</td> - <td>Px</td> - <td>Px</td> + <td>P<sub>x</sub></td> + <td>P<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y</td> <td>none</td> - <td>Px</td> + <td>P<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y.Z</td> - <td>Pxyz</td> - <td>Pxyz</td> + <td>P<sub>xyz</sub></td> + <td>P<sub>xyz</sub></td> </tr> </table> <p> In example 3, the loggers <code>root</code>, <code>X</code> - and <code>X.Y.Z</code> are assigned the levels <code>Proot</code>, - <code>Px</code> and <code>Pxyz</code> + and <code>X.Y.Z</code> are assigned the levels <code>L<sub>root</sub></code>, + <code>P<sub>x</sub></code> and <code>P<sub>xyz</sub></code> respectively. The logger <code>X.Y</code> inherits its level value from its parent <code>X</code>. </p> - <table class="exampleTable"> + <table> <tr> <th> @@ -533,45 +530,36 @@ </tr> <tr align="left"> <td>root</td> - <td>Proot</td> - <td>Proot</td> + <td>L<sub>root</sub></td> + <td>L<sub>root</sub></td> </tr> <tr align="left"> <td>X</td> - <td>Px</td> - <td>Px</td> + <td>P<sub>x</sub></td> + <td>P<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y</td> <td>none</td> - <td>Px</td> + <td>P<sub>x</sub></td> </tr> <tr align="left"> <td>X.Y.Z</td> <td>none</td> - <td>Px</td> + <td>P<sub>x</sub></td> </tr> </table> <p> In example 4, the loggers <code>root</code> and <code>X</code> - and are assigned the levels <code>Proot</code> and - <code>Px</code> respectively. The loggers <code>X.Y</code> and + and are assigned the levels <code>L<sub>root</sub></code> and + <code>P<sub>x</sub></code> respectively. The loggers <code>X.Y</code> and <code>X.Y.Z</code> inherits their level value from their nearest parent <code>X</code> having an assigned level. </p> - <p> - In a more graphic way, here is how you the logger hierarchy - works: - </p> - - <img src="images/loggerlevel.jpg" alt="loggerLevelVsMessageLevel" /> - <h3>Printing methods</h3> - - <p> By definition, the printing method determines the level of a logging request. For example, if <code>L</code> @@ -583,7 +571,7 @@ if its level is higher than or equal to the level of its logger. Otherwise, the request is said to be <em>disabled</em>. A logger without an assigned level will inherit one from - the hierarchy. This rule is summarized below. + the context. This rule is summarized below. </p> <div class="definition"> <div class="deftitle">Basic Selection Rule</div> @@ -598,10 +586,55 @@ </div> <p> - This rule is at the heart of logback classic. It assumes + This rule is at the heart of logback. It assumes that levels are ordered. For the standard levels, we have <code>DEBUG < INFO < WARN < ERROR</code>. </p> + + <p> + In a more graphic way, here is how the selection rule works: in the following + table, the horizontal header shows the level of the logging request, while the + vertical header shows the level of the logger. + </p> + + <table> + <tr> + <td></td> + <th>DEBUG</th> + <th>INFO</th> + <th>WARN</th> + <th>ERROR</th> + </tr> + <tr> + <th>DEBUG</th> + <td><span class="greenBold">YES</span></td> + <td><span class="greenBold">YES</span></td> + <td><span class="greenBold">YES</span></td> + <td><span class="greenBold">YES</span></td> + </tr> + <tr> + <th>INFO</th> + <td><span class="redBold">NO</span></td> + <td><span class="greenBold">YES</span></td> + <td><span class="greenBold">YES</span></td> + <td><span class="greenBold">YES</span></td> + </tr> + <tr> + <th>WARN</th> + <td><span class="redBold">NO</span></td> + <td><span class="redBold">NO</span></td> + <td><span class="greenBold">YES</span></td> + <td><span class="greenBold">YES</span></td> + </tr> + <tr> + <th>ERROR</th> + <td><span class="redBold">NO</span></td> + <td><span class="redBold">NO</span></td> + <td><span class="redBold">NO</span></td> + <td><span class="greenBold">YES</span></td> + </tr> + </table> + <p>Here is an example of this rule.</p> <div class="source">// get a logger instance named "com.foo", with an <span class="blue">INFO</span>level. @@ -621,8 +654,7 @@ barlogger.<span class="green">info</span>("Located nearest gas station."); // This request is disabled, because<span class="green">DEBUG</span> < <span class="blue">INFO</span>. -barlogger.<span class="green">debug</span>("Exiting gas station search"); -</div> +barlogger.<span class="green">debug</span>("Exiting gas station search");</div> <p> Calling the <code>getLogger</code> @@ -644,7 +676,7 @@ retrieve the same instance somewhere else in the code without passing around references. In fundamental contradiction to biological parenthood, where parents always - preceed their children, logback classic loggers can be + preceed their children, logback loggers can be created and configured in any order. In particular, a "parent" logger will find and link to its descendants even if it is instantiated after them. @@ -691,8 +723,8 @@ The addAppender method adds an appender to a given logger. Each enabled logging request for a given logger will be forwarded to all the appenders in that logger as well as the - appenders higher in the hierarchy. In other words, appenders - are inherited additively from the logger hierarchy. For + appenders higher in the context. In other words, appenders + are inherited additively from the logger context. For example, if a console appender is added to the root logger, then all enabled logging requests will at least print on the console. If in addition a file appender is added to a @@ -941,9 +973,9 @@ </p> <p> Let us give a taste of how this is done with the help of an - imaginary application MyApp that uses logback classic. + imaginary application MyApp that uses logback. </p> -<div class="source"><em>Example 1.4: Basic configuration (examples/MyApp.java)</em> +<div class="source"><em>Example 1.4: Basic configuration (examples/chapter1/MyApp.java)</em> package chapter1; // Import SLF4J classes. @@ -966,25 +998,22 @@ bar.doIt(); logger.info("Exiting application."); } -} -</div> +}</div> <p> This class begins by defining a static logger instance variable with the name MyApp. It then uses the Bar class, defined as shown below: </p> -<div class="source"> -class Bar { +<div class="source">class Bar { Logger logger = LoggerFactory.getLogger(Bar.class); public void doIt() { logger.debug("doing my job"); } -} -</div> +}</div> <p> The invocation of the BasicConfigurator create, as we have seen, - a simple yet sufficient logback classic setup. By default, + a simple yet sufficient logback setup. By default, the root Logger is assigned to Level.DEBUG. </p> <p>The BasicConfigurator has to be called only once. Any other class that wishes to @@ -992,35 +1021,30 @@ <p> The output of MyApp is: </p> -<div class="source"> -0 [main] INFO ch.qos.logback.classic.examples.MyApp - Entering application. +<div class="source">0 [main] INFO ch.qos.logback.classic.examples.MyApp - Entering application. 0 [main] DEBUG ch.qos.logback.classic.examples.Bar - doing my job -0 [main] INFO ch.qos.logback.classic.examples.MyApp - Exiting application. -</div> +0 [main] INFO ch.qos.logback.classic.examples.MyApp - Exiting application.</div> - <p>Let's configure logback classic to do exactly the same output, this time + <p>Let's configure logback to do exactly the same output, this time with an XML configuration file.</p> -<div class="source"> -<?xml version="1.0" encoding="UTF-8" ?> - -<logback:configuration xmlns:logback='http://logback.qos.ch/'> +<div class="source"><?xml version="1.0" encoding="UTF-8" ?> - <appender name="STDOUT" - class="ch.qos.logback.core.ConsoleAppender"> - <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="STDOUT" /> - </root> -</logback:configuration> +<configuration> -</div> + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <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="STDOUT" /> + </root> +</configuration></div> <p>We first created an Appender, named <em>STDOUT</em> that is of ConsoleAppender tye. Its layout is managed by a PatternLayout, that uses the value of the "pattern" parameter to generate @@ -1036,7 +1060,8 @@ <p>The console output will be exactly the same as before. However, this time, we didn't need to import and call the BasicConfigurator class, as you can see in the following code section: </p> -<div class="source">package chapter1; +<div class="source"><em>Example 1.5: Logback configuration from file (examples/chapter1/MyAppWithConfigFile.java)</em> +package chapter1; //Import SLF4J classes. import org.slf4j.LoggerFactory; @@ -1058,8 +1083,7 @@ bar.doIt(); logger.info("Exiting application."); } -} -</div> +}</div> <p> We used the JoranConfigurator class to parse the configuration file we just created. Joran is a XML interpreter, similar to the commons-digester API, but offering several @@ -1067,38 +1091,37 @@ on the tags it finds. </p> - <p>Logging to the console is a rather simple example. Let's now configure logback classic + <p>Logging to the console is a rather simple example. Let's now configure logback so that it logs to the console, but also to a custom file.</p> <div class="source"><?xml version="1.0" encoding="UTF-8" ?> -<logback:configuration xmlns:logback='http://logback.qos.ch/'> +<configuration> - <appender name="STDOUT" - class="ch.qos.logback.core.ConsoleAppender"> - <layout class="ch.qos.logback.classic.PatternLayout"> - <param name="pattern" - value="%-4relative [%thread] %-5level %class - %msg%n" /> - </layout> - </appender> - - <appender name="FILE" - class="ch.qos.logback.core.FileAppender"> - <layout class="ch.qos.logback.classic.PatternLayout"> - <param name="pattern" - value="%-4relative [%thread] %-5level %class - %msg%n" /> - </layout> - <param name="File" - value="sample-log.txt" /> - </appender> - - <root> - <level value="debug" /> - <appender-ref ref="STDOUT" /> - <appender-ref ref="FILE" /> - </root> -</logback:configuration> -</div> + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" + value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> + </appender> + + <appender name="FILE" + class="ch.qos.logback.core.FileAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="pattern" + value="%-4relative [%thread] %-5level %class - %msg%n" /> + </layout> + <param name="File" + value="sample-log.txt" /> + </appender> + + <root> + <level value="debug" /> + <appender-ref ref="STDOUT" /> + <appender-ref ref="FILE" /> + </root> +</configuration></div> <p>Now, all the logging statements are directed to the console and to a file named <em>sample-log.txt</em>. As you can see, the configuration needed to add an Appender is very small. The param element, in either @@ -1111,10 +1134,8 @@ <p>This done, the output is modified to show only statements of level INFO and higher.</p> -<div class="source"> -0 [main] INFO chapter1.MyAppWithConfigFile - Entering application. -0 [main] INFO chapter1.MyAppWithConfigFile - Exiting application. -</div> +<div class="source">0 [main] INFO chapter1.MyAppWithConfigFile - Entering application. +0 [main] INFO chapter1.MyAppWithConfigFile - Exiting application.</div> <p>Note that to obtain these different logging behaviors we did not need to recompile code. We could just as easily have logged to a UNIX Syslog daemon, redirected all chapter1 output

1 0

svn commit: r415 - logback/skin/trunk/src/main/resources/css
by noreply.seb＠qos.ch 08 Aug '06

08 Aug '06

Author: seb Date: Tue Aug 8 15:59:08 2006 New Revision: 415 Modified: logback/skin/trunk/src/main/resources/css/site.css Log: modified examples, updated documentation and css styles accordingly Modified: logback/skin/trunk/src/main/resources/css/site.css ============================================================================== --- logback/skin/trunk/src/main/resources/css/site.css (original) +++ logback/skin/trunk/src/main/resources/css/site.css Tue Aug 8 15:59:08 2006 @@ -349,17 +349,6 @@ font-family: Courier, monospace; } -table.exampleTable { - width: 50%; - -} -table.exampleTable th { - color: white; - background-color: #bbb; - text-align: left; - font-weight: bold; -} - .green { color: green; } @@ -367,3 +356,11 @@ color: blue; } +.redBold { + color: red; + font-weight: bold; +} +.greenBold { + color: green; + font-weight: bold; +} \ No newline at end of file

1 0

svn commit: r414 - logback/classic/trunk/src/main/assembly
by noreply.seb＠qos.ch 08 Aug '06

08 Aug '06

Author: seb Date: Tue Aug 8 15:57:43 2006 New Revision: 414 Modified: logback/classic/trunk/src/main/assembly/source.xml Log: modified assembly config to include examples sources and classes Modified: logback/classic/trunk/src/main/assembly/source.xml ============================================================================== --- logback/classic/trunk/src/main/assembly/source.xml (original) +++ logback/classic/trunk/src/main/assembly/source.xml Tue Aug 8 15:57:43 2006 @@ -27,7 +27,7 @@ <directory>src</directory> </fileSet> <fileSet> - <directory>src</directory> + <directory>examples/</directory> </fileSet> </fileSets> <dependencySets>

1 0

svn commit: r413 - logback/core/trunk/src/main/java/ch/qos/logback/core/net
by noreply.ceki＠qos.ch 07 Aug '06

07 Aug '06

Author: ceki Date: Mon Aug 7 23:06:51 2006 New Revision: 413 Added: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogConstants.java logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogWriter.java Log: ongoing work on SyslogAppender Added: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogConstants.java ============================================================================== --- (empty file) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogConstants.java Mon Aug 7 23:06:51 2006 @@ -0,0 +1,82 @@ +package ch.qos.logback.core.net; + +/** + * Constants used by syslog daemon and transitively by {@link SyslogAppender}. + * + * @author Ceki Gülcü + **/ +public class SyslogConstants { + + + + // Following constants extracted from RFC 3164, we multiply them by 8 + // in order to precompute the facility part of PRI. + // See RFC 3164, Section 4.1.1 for exact details. + + /** Emergency: system is unusable */ + public static final int EMERGENCY_SEVERITY = 0; + /** Alert: action must be taken immediately */ + public static final int ALERT_SEVERITY = 1; + /** Critical: critical conditions */ + public static final int CRITICAL_SEVERITY = 2; + /** Error: error conditions */ + public static final int ERROR_SEVERITY = 3; + /** Warning: warning conditions */ + public static final int WARNING_SEVERITY = 4; + /** Notice: normal but significant condition */ + public static final int NOTICE_SEVERITY = 5; + /** Informational: informational messages */ + public static final int INFO_SEVERITY = 6; + /** Debug: debug-level messages */ + public static final int DEBUG_SEVERITY = 7; + + + /** kernel messages, numerical code 0. */ + public static final int LOG_KERN = 0; + /** user-level messages, numerical code 1. */ + public static final int LOG_USER = 1 << 3; + /** mail system, numerical code 2. */ + public static final int LOG_MAIL = 2 << 3; + /** system daemons, numerical code 3. */ + public static final int LOG_DAEMON = 3 << 3; + /** security/authorization messages, numerical code 4. */ + public static final int LOG_AUTH = 4 << 3; + /** messages generated internally by syslogd, numerical code 5. */ + public static final int LOG_SYSLOG = 5 << 3; + /** line printer subsystem, numerical code 6. */ + public static final int LOG_LPR = 6 << 3; + /** network news subsystem, numerical code 7. */ + public static final int LOG_NEWS = 7 << 3; + /** UUCP subsystem, numerical code 8 */ + public static final int LOG_UUCP = 8 << 3; + /** clock daemon, numerical code 9. */ + public static final int LOG_CRON = 9 << 3; + /** security/authorization messages, numerical code 10. */ + public static final int LOG_AUTHPRIV = 10 << 3; + /** ftp daemon, numerical code 11. */ + public static final int LOG_FTP = 11 << 3; + /** NTP subsystem, numerical code 12. */ + public static final int LOG_NTP = 12 << 3; + /** log audit, numerical code 13. */ + public static final int LOG_AUDIT = 13 << 3; + /** log alert, numerical code 14. */ + public static final int LOG_ALERT = 14 << 3; + /** clock daemon, numerical code 15. */ + public static final int LOG_CLOCK = 15 << 3; + /** reserved for local use, numerical code 16. */ + public static final int LOG_LOCAL0 = 16 << 3; + /** reserved for local use, numerical code 17. */ + public static final int LOG_LOCAL1 = 17 << 3; + /** reserved for local use, numerical code 18. */ + public static final int LOG_LOCAL2 = 18 << 3; + /** reserved for local use, numerical code 19. */ + public static final int LOG_LOCAL3 = 19 << 3; + /** reserved for local use, numerical code 20. */ + public static final int LOG_LOCAL4 = 20 << 3; + /** reserved for local use, numerical code 21. */ + public static final int LOG_LOCAL5 = 21 << 3; + /** reserved for local use, numerical code 22. */ + public static final int LOG_LOCAL6 = 22 << 3; + /** reserved for local use, numerical code 23.*/ + public static final int LOG_LOCAL7 = 23 << 3; +} Added: logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogWriter.java ============================================================================== --- (empty file) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/net/SyslogWriter.java Mon Aug 7 23:06:51 2006 @@ -0,0 +1,63 @@ +package ch.qos.logback.core.net; + +import java.io.IOException; +import java.io.Writer; +import java.net.DatagramPacket; +import java.net.DatagramSocket; +import java.net.InetAddress; +import java.net.SocketException; +import java.net.UnknownHostException; + +/** + * SyslogWriter is a wrapper around the {@link DatagramSocket} class + * so that it behaves like a {@link Writer}. + */ +public class SyslogWriter extends Writer { + /** + * The maximum length after which we discard the existing string buffer and + * start anew. + */ + static final int MAX_LEN = 1024; + + static final int SYSLOG_PORT = 514; + + private InetAddress address; + private DatagramSocket ds; + private StringBuffer buf = new StringBuffer(); + + public SyslogWriter(String syslogHost) throws UnknownHostException, SocketException { + this.address = InetAddress.getByName(syslogHost); + this.ds = new DatagramSocket(); + } + + public void write(char[] charArray, int offset, int len) throws IOException { + buf.append(charArray, offset, len); + } + + public void write(String str) throws IOException { + buf.append(str); + + } + + public void flush() throws IOException { + byte[] bytes = buf.toString().getBytes(); + DatagramPacket packet = + new DatagramPacket(bytes, bytes.length, address, SYSLOG_PORT); + + if (this.ds != null) { + ds.send(packet); + } + // clean up for next round + if(buf.length() > MAX_LEN) { + buf = new StringBuffer(); + } else { + buf.setLength(0); + } + } + + public void close() { + address = null; + ds = null; + } +} +

1 0