September 2006 - logback-dev

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

08 Sep '06

Author: seb Date: Fri Sep 8 15:07:37 2006 New Revision: 536 Modified: logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Log: shortIntro now mentions the existence of the PropertiesTranslator webapp. chosen url: http://logback.qos.ch/PropertiesTranslator/ Modified: logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Fri Sep 8 15:07:37 2006 @@ -983,7 +983,11 @@ XML format. - Let us give a taste of how this is done with the help of an + Log4j users can convert their <code>log4j.properties</code> files to logback xml configration files using + our <a href="http://logback.qos.ch/PropertiesTranslator/">PropertiesTranslator</a> webapp. + + + Let us give a taste of how logback configuration is done with the help of an imaginary application MyApp that uses logback. Example 1.4: Basic configuration (examples/chapter1/MyApp.java)

1 0

svn commit: r535 - in logback/trunk/logback-classic/src: main/java/ch/qos/logback/classic main/java/ch/qos/logback/classic/spi test/java/ch/qos/logback/classic/net
by noreply.seb＠qos.ch 08 Sep '06

08 Sep '06

Author: seb Date: Fri Sep 8 12:29:30 2006 New Revision: 535 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/MDC.java logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/LoggingEvent.java logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SocketAppenderTest.java Log: - Updated MDC to create a new map instance each time a property is added - Modified method name in MDC: getContext is now getPropertyMap - Updated LoggingEvent to provide access to the MDC Properties - Updated SocketAppenderTest to verify that the LoggingEvent always exposes the last version of the MDC Properties Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/MDC.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/MDC.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/MDC.java Fri Sep 8 12:29:30 2006 @@ -30,16 +30,23 @@ * * If the current thread does not have a context map it is created as a side * effect of this call. + * + * + * Each time a value is added, a new instance of the map is created. This is + * to be certain that the serialization process will operate on the updated map + * and not send a reference to the old map, thus not allowing the remote logback + * component to see the latest changes. */ public static void put(String key, String val) { - HashMap<String, String> hashMap = threadLocal.get(); + HashMap<String, String> oldMap = threadLocal.get(); - if (hashMap == null) { - hashMap = new HashMap<String, String>(); - threadLocal.set(hashMap); + HashMap<String, String> newMap = new HashMap<String, String>(); + if (oldMap != null) { + newMap.putAll(oldMap); } - - hashMap.put(key, val); + threadLocal.set(newMap); + + newMap.put(key, val); } /** @@ -60,13 +67,22 @@ /** * Remove the the context identified by the <code>key</code> parameter. + * + * + * Each time a value is removed, a new instance of the map is created. This is + * to be certain that the serialization process will operate on the updated map + * and not send a reference to the old map, thus not allowing the remote logback + * component to see the latest changes. */ public static void remove(String key) { - HashMap<String, String> hashMap = threadLocal.get(); + HashMap<String, String> oldMap = threadLocal.get(); - if (hashMap != null) { - hashMap.remove(key); + HashMap<String, String> newMap = new HashMap<String, String>(); + if (oldMap != null) { + newMap.putAll(oldMap); } + + newMap.remove(key); } /** @@ -85,7 +101,7 @@ * Get the current thread's MDC as a map. This method is intended to be used * internally. */ - public static Map<String, String> getContext() { + public static Map<String, String> getPropertyMap() { return threadLocal.get(); } Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/LoggingEvent.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/LoggingEvent.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/spi/LoggingEvent.java Fri Sep 8 12:29:30 2006 @@ -14,13 +14,14 @@ import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.Serializable; +import java.util.Map; import org.slf4j.Marker; import org.slf4j.impl.MessageFormatter; - -import ch.qos.logback.classic.Logger; import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.MDC; /** * The internal representation of logging events. When an affirmative decision @@ -84,8 +85,10 @@ private CallerData[] callerDataArray; private LoggerRemoteView loggerRemoteView; - + private Marker marker; + + private Map<String, String> MDCPropertyMap; /** * The number of milliseconds elapsed from 1/1/1970 until logging event was @@ -262,20 +265,22 @@ public String getFormattedMessage() { return formattedMessage; } + + public Map<String, String> getMDCPropertyMap() { + //no lazy init since the MDC might + //change its map instance. + this.MDCPropertyMap = MDC.getPropertyMap(); + return MDCPropertyMap; + } private void writeObject(ObjectOutputStream out) throws IOException { out.defaultWriteObject(); - //out.writeObject(loggerView); - out.writeInt(level.levelInt); } private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); - //String loggerName = (String) in.readObject(); - //logger = LoggerFactory.getLogger(loggerName); - //loggerView = (LoggerView)in.readObject(); int levelInt = in.readInt(); level = Level.toLevel(levelInt); } Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SocketAppenderTest.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SocketAppenderTest.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SocketAppenderTest.java Fri Sep 8 12:29:30 2006 @@ -3,16 +3,21 @@ 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 SocketAppenderTest extends TestCase { + private LoggerContext lc; + private MockSocketServer mockSocketServer; + public void testStartFailNoRemoteHost() { - LoggerContext lc = new LoggerContext(); + lc = new LoggerContext(); SocketAppender appender = new SocketAppender(); appender.setContext(lc); appender.setPort(123); @@ -21,36 +26,39 @@ } public void testRecieveMessage() throws InterruptedException { - MockSocketServer mockServer = new MockSocketServer(1); - mockServer.start(); - // give MockSyslogServer head start - Thread.sleep(100); + startServer(1); + configureClient(); + + Logger logger = lc.getLogger(LoggerContext.ROOT_NAME); + logger.debug("test msg"); + // Wait max 2 seconds for mock server to finish. However, it should + // finish much sooner than that. + mockSocketServer.join(2000); + assertTrue(mockSocketServer.finished); + assertEquals(1, mockSocketServer.loggingEventList.size()); + + LoggingEvent remoteEvent = mockSocketServer.loggingEventList.get(0); + assertEquals("test msg", remoteEvent.getMessage()); + assertEquals(Level.DEBUG, remoteEvent.getLevel()); + } + + public void testRecieveWithContext() throws InterruptedException { + startServer(1); + configureClient(); - // client configuration - LoggerContext lc = new LoggerContext(); - lc.setName("test"); - lc.setProperty("testKey", "testValue"); - Logger root = lc.getLogger(LoggerContext.ROOT_NAME); - SocketAppender socketAppender = new SocketAppender(); - socketAppender.setContext(lc); - socketAppender.setName("socket"); - socketAppender.setPort(4560); - socketAppender.setRemoteHost("localhost"); - root.addAppender(socketAppender); - socketAppender.start(); - Logger logger = lc.getLogger(LoggerContext.ROOT_NAME); logger.debug("test msg"); // Wait max 2 seconds for mock server to finish. However, it should // finish much sooner than that. - mockServer.join(2000); - assertTrue(mockServer.finished); - assertEquals(1, mockServer.loggingEventList.size()); - LoggingEvent remoteEvent = mockServer.loggingEventList.get(0); + mockSocketServer.join(2000); + assertTrue(mockSocketServer.finished); + assertEquals(1, mockSocketServer.loggingEventList.size()); + + LoggingEvent remoteEvent = mockSocketServer.loggingEventList.get(0); + LoggerRemoteView loggerRemoteView = remoteEvent.getLoggerRemoteView(); - assertEquals("test msg", remoteEvent.getMessage()); assertNotNull(loggerRemoteView); assertEquals("root", loggerRemoteView.getName()); @@ -60,4 +68,71 @@ Map<String, String> props = loggerContextRemoteView.getPropertyMap(); assertEquals("testValue", props.get("testKey")); } + + + public void testMessageWithMDC() throws InterruptedException { + startServer(1); + configureClient(); + + Logger logger = lc.getLogger(LoggerContext.ROOT_NAME); + + MDC.put("key", "testValue"); + logger.debug("test msg"); + + // Wait max 2 seconds for mock server to finish. However, it should + // finish much sooner than that. + mockSocketServer.join(2000); + assertTrue(mockSocketServer.finished); + assertEquals(1, mockSocketServer.loggingEventList.size()); + + LoggingEvent remoteEvent = mockSocketServer.loggingEventList.get(0); + Map<String, String> MDCPropertyMap = remoteEvent.getMDCPropertyMap(); + assertEquals("testValue", MDCPropertyMap.get("key")); + } + + public void testMessageWithUpdatedMDC() throws InterruptedException { + startServer(2); + configureClient(); + + Logger logger = lc.getLogger(LoggerContext.ROOT_NAME); + + MDC.put("key", "testValue"); + logger.debug("test msg"); + + MDC.put("key", "updatedTestValue"); + logger.debug("test msg 2"); + + // Wait max 2 seconds for mock server to finish. However, it should + // finish much sooner than that. + mockSocketServer.join(2000); + assertTrue(mockSocketServer.finished); + assertEquals(2, mockSocketServer.loggingEventList.size()); + + //We observe the second logging event. It should provide us with + //the updated MDC property. + LoggingEvent remoteEvent = mockSocketServer.loggingEventList.get(1); + Map<String, String> MDCPropertyMap = remoteEvent.getMDCPropertyMap(); + assertEquals("updatedTestValue", MDCPropertyMap.get("key")); + } + + private void startServer(int expectedEventNumber) throws InterruptedException { + mockSocketServer = new MockSocketServer(expectedEventNumber); + mockSocketServer.start(); + // give MockSocketServer head start + Thread.sleep(100); + } + + private void configureClient() { + lc = new LoggerContext(); + lc.setName("test"); + lc.setProperty("testKey", "testValue"); + Logger root = lc.getLogger(LoggerContext.ROOT_NAME); + SocketAppender socketAppender = new SocketAppender(); + socketAppender.setContext(lc); + socketAppender.setName("socket"); + socketAppender.setPort(4560); + socketAppender.setRemoteHost("localhost"); + root.addAppender(socketAppender); + socketAppender.start(); + } }

1 0

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

08 Sep '06

Author: seb Date: Fri Sep 8 11:52:05 2006 New Revision: 534 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RolloverFailure.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java Log: Updated javadoc Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java Fri Sep 8 11:52:05 2006 @@ -1,5 +1,5 @@ /** - * 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 * @@ -27,21 +27,20 @@ * <code>RollingPolicy</code> and a <code>TriggeringPolicy</code>. * * <code>RollingFileAppender</code> can be configured programattically or - * using {@link org.apache.log4j.joran.JoranConfigurator}. Here is a sample + * using {@link ch.qos.logback.classic.joran.JoranConfigurator}. Here is a sample * configration file: <pre><?xml version="1.0" encoding="UTF-8" ?> -<!DOCTYPE log4j:configuration> -<log4j:configuration debug="true"> +<configuration debug="true"> - <appender name="ROLL" class="org.apache.log4j.rolling.RollingFileAppender"> - <rollingPolicy class="org.apache.log4j.rolling.TimeBasedRollingPolicy"> + <appender name="ROLL" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <param name="FileNamePattern" value="/wombat/foo.%d{yyyy-MM}.gz"/> </rollingPolicy> - <layout class="org.apache.log4j.PatternLayout"> - <param name="ConversionPattern" value="%c{1} - %m%n"/> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="Pattern" value="%c{1} - %m%n"/> </layout> </appender> @@ -49,7 +48,7 @@ <appender-ref ref="ROLL"/> </root> -</log4j:configuration> +</configuration> </pre> *This configuration file specifies a monthly rollover schedule including Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RolloverFailure.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RolloverFailure.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RolloverFailure.java Fri Sep 8 11:52:05 2006 @@ -1,17 +1,11 @@ -/* - * Copyright 1999,2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. +/** + * Logback: the reliable, generic, fast and flexible logging framework. + * + * Copyright (C) 1999-2006, QOS.ch + * + * This library is free software, you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation. */ package ch.qos.logback.core.rolling; Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java Fri Sep 8 11:52:05 2006 @@ -117,6 +117,32 @@ * </tr> * </table> * + * <h2>Configuration example</h2> + * Here is a complete logback configuration xml file that uses TimeBasedTriggeringPolicy. + * + * <pre> + * <configuration> + * <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> + * <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> + * <param name="FileNamePattern" value="foo_%d{yyyy-MM}.log" /> + * <param name="ActiveFileName" value="foo.log" /> + * </rollingPolicy> + * <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> + * + * This configuration will produce output to a file called <code>foo.log</code>. For example, at the end of the month + * of September 2006, the file will be renamed to <code>foo_2006-09.log</code> and a new <code>foo.log</code> file + * will be created and used for actual logging. + * * @author Ceki Gülcü */ public class TimeBasedRollingPolicy extends RollingPolicyBase implements TriggeringPolicy {

1 0

Remaining tasks before 0.3 release
by Sebastien Pennec 08 Sep '06

08 Sep '06

Hi all, Here are the remaining tasks that need to be done before a 0.3 version can be released. TimeBasedTriggeringPolicy: - Update javadoc. - Add an example config xml file. MDC: - Add the MDC map to the serialized LoggingEvent. - Modify the put method of MDC to create a new instance of the map each time a new property is introduced, so that the serialization mechanism sends the new map and not its reference. - Create an MDCConverter. - Corresponding tests. PropertiesTranslator: - Update documentation to tell about PropertiesTranslator. - Decide of a url for the webapp - Update PropertiesTranslator project to a non-snapshot version - Set up a server and install the PropertiesTranslatorWebApp. Site: - put the codes.html page back online. Project management: - Update logback-skin to be a subproject of logback. Anything more? -- Sébastien Pennec sebastien(a)qos.ch Logback: The reliable, generic, fast and flexible logging framework for Java.

1 0

svn commit: r533 - logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic
by noreply.ceki＠qos.ch 07 Sep '06

07 Sep '06

Author: ceki Date: Fri Sep 8 00:13:00 2006 New Revision: 533 Removed: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Log:

1 0

Logback on linux
by Ceki Gülcü 07 Sep '06

07 Sep '06

Hi All, I am happy to report that all existing logback tests now pass on Linux x86 (32 bit) and Linux AMD64 using Sun's 1.5.08 JDK. Obviously, tests still pass on Windows as before. -- Ceki Gülcü Logback: The reliable, generic, fast and flexible logging framework for Java. http://ceki.blogspot.com/

1 0

svn commit: r532 - logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic
by noreply.ceki＠qos.ch 07 Sep '06

07 Sep '06

Author: ceki Date: Fri Sep 8 00:11:00 2006 New Revision: 532 Added: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/MDCTestThread.java - copied, changed from r531, /logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/MDCTest.java Log: Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/MDCTest.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/MDCTest.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/MDCTest.java Fri Sep 8 00:11:00 2006 @@ -6,10 +6,10 @@ public void test() throws InterruptedException { - TestThread threadA = new TestThread("a"); + MDCTestThread threadA = new MDCTestThread("a"); threadA.start(); - TestThread threadB = new TestThread("b"); + MDCTestThread threadB = new MDCTestThread("b"); threadB.start(); threadA.join(); Copied: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/MDCTestThread.java (from r531, /logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java) ============================================================================== --- /logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/MDCTestThread.java Fri Sep 8 00:11:00 2006 @@ -1,10 +1,10 @@ package ch.qos.logback.classic; -public class TestThread extends Thread { +public class MDCTestThread extends Thread { String val; - public TestThread(String val) { + public MDCTestThread(String val) { super(); this.val = val; }

1 0

svn commit: r531 - logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic
by noreply.ceki＠qos.ch 07 Sep '06

07 Sep '06

Author: ceki Date: Fri Sep 8 00:09:16 2006 New Revision: 531 Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Log: how about public class? Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Fri Sep 8 00:09:16 2006 @@ -1,6 +1,6 @@ package ch.qos.logback.classic; -class TestThread extends Thread { +public class TestThread extends Thread { String val;

1 0

svn commit: r530 - logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic
by noreply.ceki＠qos.ch 07 Sep '06

07 Sep '06

Author: ceki Date: Fri Sep 8 00:08:22 2006 New Revision: 530 Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Log: better luck with public constructor? Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Fri Sep 8 00:08:22 2006 @@ -3,10 +3,12 @@ class TestThread extends Thread { String val; - TestThread(String val) { + + public TestThread(String val) { super(); this.val = val; } + String x0; String x1; String x2;

1 0

svn commit: r529 - logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic
by noreply.ceki＠qos.ch 07 Sep '06

07 Sep '06

Author: ceki Date: Fri Sep 8 00:01:43 2006 New Revision: 529 Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Log: call super constructor Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/TestThread.java Fri Sep 8 00:01:43 2006 @@ -4,6 +4,7 @@ String val; TestThread(String val) { + super(); this.val = val; } String x0;

1 0