September 2006 - logback-dev

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

14 Sep '06

Author: seb Date: Thu Sep 14 11:26:39 2006 New Revision: 582 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Log: - improved javadoc Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Thu Sep 14 11:26:39 2006 @@ -28,19 +28,22 @@ * The content of the table columns are specified using a conversion pattern. * See {@link ch.qos.logback.classic.PatternLayout} for documentation on the * available patterns. - * + * * Note that the pattern %ex used to display an Exception is not the only way - * to display an Exception with this layout. - * - * An internal {@link ch.qos.logback.classic.html.IThrowableRenderer} can be called - * to render the throwable. + * to display an Exception with this layout. If you use this pattern, a table column will + * be created to display the potential Exception's stacktrace. + * + * However, a better solution is available in the form of implementations of the + * {@link ch.qos.logback.classic.html.IThrowableRenderer} interface. + * These implementations can be called and assigned to HTMLLayout to manage the display + * of anything related to Exceptions. + * * By default, a {@link ch.qos.logback.classic.html.DefaultThrowableRenderer} - * is assigned to the HTMLLayout. It writes the Exception on a new table row. - * - * FIXME WRITE MORE ABOUT THIS. - * - * In that case, then one must add %ex - * to the pattern to display Exceptions. + * is assigned to the HTMLLayout. It writes the Exception on a new table row, along + * with its stacktrace, in a easily readable manner. + * + * If one wants to use the &ex pattern anyway, then a NOPThrowableRenderer + * can be specified in the configuration file. * * A user-specified external CSS file can be linked to the html page. * In case one does not want to customize the html output, an internal CSS style @@ -59,7 +62,7 @@ * <layout class="ch.qos.logback.classic.html.HTMLLayout"> * <param name="pattern" value="%relative%thread%mdc%level%class%msg" /> * </layout> - * <throwableRenderer class="ch.qos.logback.classic.html.ThrowableRenderer" /> + * <throwableRenderer class="ch.qos.logback.classic.html.DefaultThrowableRenderer" /> * <param name="From" value="sender.email(a)domain.net" /> * <param name="SMTPHost" value="mail.domain.net" /> * <param name="Subject" value="LastEvent: %class - %msg" /> @@ -72,8 +75,11 @@ * </root> * </configuration> *</pre> - * - * + * + * In this configuration file, the throwableRenderer element specifies the default + * implementation of IThrowableRenderer. It could be omitted, but is showed for educationnal + * purposes. + * * @author Ceki Gülcü * @author Sébastien Pennec */

1 0

svn commit: r581 - in logback/trunk: logback-access logback-classic logback-core
by noreply.ceki＠qos.ch 13 Sep '06

13 Sep '06

Author: ceki Date: Wed Sep 13 23:19:59 2006 New Revision: 581 Added: logback/trunk/logback-access/LICENSE.txt logback/trunk/logback-classic/LICENSE.txt logback/trunk/logback-core/LICENSE.txt Log: required for ibiblio bundling Added: logback/trunk/logback-access/LICENSE.txt ============================================================================== --- (empty file) +++ logback/trunk/logback-access/LICENSE.txt Wed Sep 13 23:19:59 2006 @@ -0,0 +1,12 @@ + +Logback Core Module LICENSE +--------------------------- + +Logback Core Module source code and binaries are distributed under the +GNU Lesser General Public License as published by the Free Software Foundation. + +Logback: the generic, reliable, fast and flexible logging library for Java. + +Copyright (C) 2000-2006, QOS.ch This library is free software, you can +redistribute it and/or modify it under the terms of the GNU Lesser General Public License +as published by the Free Software Foundation. \ No newline at end of file Added: logback/trunk/logback-classic/LICENSE.txt ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/LICENSE.txt Wed Sep 13 23:19:59 2006 @@ -0,0 +1,12 @@ + +Logback Core Module LICENSE +--------------------------- + +Logback Core Module source code and binaries are distributed under the +GNU Lesser General Public License as published by the Free Software Foundation. + +Logback: the generic, reliable, fast and flexible logging library for Java. + +Copyright (C) 2000-2006, QOS.ch This library is free software, you can +redistribute it and/or modify it under the terms of the GNU Lesser General Public License +as published by the Free Software Foundation. \ No newline at end of file Added: logback/trunk/logback-core/LICENSE.txt ============================================================================== --- (empty file) +++ logback/trunk/logback-core/LICENSE.txt Wed Sep 13 23:19:59 2006 @@ -0,0 +1,12 @@ + +Logback Core Module LICENSE +--------------------------- + +Logback Core Module source code and binaries are distributed under the +GNU Lesser General Public License as published by the Free Software Foundation. + +Logback: the generic, reliable, fast and flexible logging library for Java. + +Copyright (C) 2000-2006, QOS.ch This library is free software, you can +redistribute it and/or modify it under the terms of the GNU Lesser General Public License +as published by the Free Software Foundation. \ No newline at end of file

1 0

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

13 Sep '06

Author: seb Date: Wed Sep 13 19:54:25 2006 New Revision: 580 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SocketAppenderTest.java Log: - code reformat in SocketAppender - updated test so that it does not tests serialization but only appender behaviour. Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/net/SocketAppender.java Wed Sep 13 19:54:25 2006 @@ -99,299 +99,299 @@ public class SocketAppender extends AppenderBase { - /** - * The default port number of remote logging server (4560). - */ - static final int DEFAULT_PORT = 4560; - - /** - * The default reconnection delay (30000 milliseconds or 30 seconds). - */ - static final int DEFAULT_RECONNECTION_DELAY = 30000; - - /** - * We remember host name as String in addition to the resolved InetAddress so - * that it can be returned via getOption(). - */ - String remoteHost; - - InetAddress address; - int port = DEFAULT_PORT; - ObjectOutputStream oos; - int reconnectionDelay = DEFAULT_RECONNECTION_DELAY; - - private Connector connector; - - int counter = 0; - - // reset the ObjectOutputStream every 70 calls - private static final int RESET_FREQUENCY = 70; - - public SocketAppender() { - } - - /** - * Connects to remote server at <code>address</code> and <code>port</code>. - */ - public SocketAppender(InetAddress address, int port) { - this.address = address; - this.remoteHost = address.getHostName(); - this.port = port; - // connect(address, port); - } - - /** - * Connects to remote server at <code>host</code> and <code>port</code>. - */ - public SocketAppender(String host, int port) { - this.port = port; - this.address = getAddressByName(host); - this.remoteHost = host; - // connect(address, port); - } - - // /** - // * Connect to the specified RemoteHost and Port. - // */ - // public void activateOptions() { - // connect(address, port); - // } - - /** - * Start this appender. - */ - public void start() { - int errorCount = 0; - if (port == 0) { - errorCount++; - addError("No port was configured for appender" + name); - } - - if (address == null) { - errorCount++; - addError("No remote address was configured for appender" + name); - } - - connect(address, port); - - if (errorCount == 0) { - this.started = true; - } - } - - /** - * Strop this appender. - * - * - * This will mark the appender as closed and call then {@link #cleanUp} - * method. - */ - @Override - public void stop() { - if (!isStarted()) - return; - - this.started = false; - cleanUp(); - } - - /** - * Drop the connection to the remote host and release the underlying connector - * thread if it has been created - */ - public void cleanUp() { - if (oos != null) { - try { - oos.close(); - } catch (IOException e) { - addError("Could not close oos.", e); - } - oos = null; - } - if (connector != null) { - addInfo("Interrupting the connector."); - connector.interrupted = true; - connector = null; // allow gc - } - } - - void connect(InetAddress address, int port) { - if (this.address == null) - return; - try { - // First, close the previous connection if any. - cleanUp(); - oos = new ObjectOutputStream(new Socket(address, port).getOutputStream()); - } catch (IOException e) { - - String msg = "Could not connect to remote logback server at [" - + address.getHostName() + "]."; - if (reconnectionDelay > 0) { - msg += " We will try again later."; - fireConnector(); // fire the connector thread - } - addError(msg, e); - } - } - - @Override - protected void append(Object event) { - - if (event == null) - return; - - if (address == null) { - addError("No remote host is set for SocketAppender named \"" + this.name - + "\"."); - return; - } - - if (oos != null) { - try { - oos.writeObject(event); - //addInfo("=========Flushing."); - oos.flush(); - if (++counter >= RESET_FREQUENCY) { - counter = 0; - // Failing to reset the object output stream every now and - // then creates a serious memory leak. - // System.err.println("Doing oos.reset()"); - oos.reset(); - } - } catch (IOException e) { - oos = null; - addWarn("Detected problem with connection: " + e); - if (reconnectionDelay > 0) { - fireConnector(); - } - } - } - } - - void fireConnector() { - if (connector == null) { - addInfo("Starting a new connector thread."); - connector = new Connector(); - connector.setDaemon(true); - connector.setPriority(Thread.MIN_PRIORITY); - connector.start(); - } - } - - static InetAddress getAddressByName(String host) { - try { - return InetAddress.getByName(host); - } catch (Exception e) { - // addError("Could not find address of [" + host + "].", e); - return null; - } - } - - /** - * The RemoteHost option takes a string value which should be the host - * name of the server where a {@link SocketNode} is running. - */ - public void setRemoteHost(String host) { - address = getAddressByName(host); - remoteHost = host; - } - - /** - * Returns value of the RemoteHost option. - */ - public String getRemoteHost() { - return remoteHost; - } - - /** - * The Port option takes a positive integer representing the port - * where the server is waiting for connections. - */ - public void setPort(int port) { - this.port = port; - } - - /** - * Returns value of the Port option. - */ - public int getPort() { - return port; - } - - /** - * The ReconnectionDelay option takes a positive integer representing - * the number of milliseconds to wait between each failed connection attempt - * to the server. The default value of this option is 30000 which corresponds - * to 30 seconds. - * - * - * Setting this option to zero turns off reconnection capability. - */ - public void setReconnectionDelay(int delay) { - this.reconnectionDelay = delay; - } - - /** - * Returns value of the ReconnectionDelay option. - */ - public int getReconnectionDelay() { - return reconnectionDelay; - } - - public Layout getLayout() { - return null; - } - - public void setLayout(Layout layout) { - } - - /** - * The Connector will reconnect when the server becomes available again. It - * does this by attempting to open a new connection every - * <code>reconnectionDelay</code> milliseconds. - * - * - * It stops trying whenever a connection is established. It will restart to - * try reconnect to the server when previpously open connection is droppped. - * - * @author Ceki Gülcü - * @since 0.8.4 - */ - class Connector extends Thread { - - boolean interrupted = false; - - public void run() { - Socket socket; - while (!interrupted) { - try { - sleep(reconnectionDelay); - addInfo("Attempting connection to " + address.getHostName()); - socket = new Socket(address, port); - synchronized (this) { - oos = new ObjectOutputStream(socket.getOutputStream()); - connector = null; - addInfo("Connection established. Exiting connector thread."); - break; - } - } catch (InterruptedException e) { - addInfo("Connector interrupted. Leaving loop."); - return; - } catch (java.net.ConnectException e) { - addInfo("Remote host " + address.getHostName() - + " refused connection."); - } catch (IOException e) { - addInfo("Could not connect to " + address.getHostName() - + ". Exception is " + e); - } - } - // addInfo("Exiting Connector.run() method."); - } - - /** - * public void finalize() { LogLog.debug("Connector finalize() has been - * called."); } - */ - } + /** + * The default port number of remote logging server (4560). + */ + static final int DEFAULT_PORT = 4560; + + /** + * The default reconnection delay (30000 milliseconds or 30 seconds). + */ + static final int DEFAULT_RECONNECTION_DELAY = 30000; + + /** + * We remember host name as String in addition to the resolved InetAddress so + * that it can be returned via getOption(). + */ + String remoteHost; + + InetAddress address; + int port = DEFAULT_PORT; + ObjectOutputStream oos; + int reconnectionDelay = DEFAULT_RECONNECTION_DELAY; + + private Connector connector; + + int counter = 0; + + // reset the ObjectOutputStream every 70 calls + private static final int RESET_FREQUENCY = 70; + + public SocketAppender() { + } + + /** + * Connects to remote server at <code>address</code> and <code>port</code>. + */ + public SocketAppender(InetAddress address, int port) { + this.address = address; + this.remoteHost = address.getHostName(); + this.port = port; + // connect(address, port); + } + + /** + * Connects to remote server at <code>host</code> and <code>port</code>. + */ + public SocketAppender(String host, int port) { + this.port = port; + this.address = getAddressByName(host); + this.remoteHost = host; + // connect(address, port); + } + + // /** + // * Connect to the specified RemoteHost and Port. + // */ + // public void activateOptions() { + // connect(address, port); + // } + + /** + * Start this appender. + */ + public void start() { + int errorCount = 0; + if (port == 0) { + errorCount++; + addError("No port was configured for appender" + name); + } + + if (address == null) { + errorCount++; + addError("No remote address was configured for appender" + name); + } + + connect(address, port); + + if (errorCount == 0) { + this.started = true; + } + } + + /** + * Strop this appender. + * + * + * This will mark the appender as closed and call then {@link #cleanUp} + * method. + */ + @Override + public void stop() { + if (!isStarted()) + return; + + this.started = false; + cleanUp(); + } + + /** + * Drop the connection to the remote host and release the underlying connector + * thread if it has been created + */ + public void cleanUp() { + if (oos != null) { + try { + oos.close(); + } catch (IOException e) { + addError("Could not close oos.", e); + } + oos = null; + } + if (connector != null) { + addInfo("Interrupting the connector."); + connector.interrupted = true; + connector = null; // allow gc + } + } + + void connect(InetAddress address, int port) { + if (this.address == null) + return; + try { + // First, close the previous connection if any. + cleanUp(); + oos = new ObjectOutputStream(new Socket(address, port).getOutputStream()); + } catch (IOException e) { + + String msg = "Could not connect to remote logback server at [" + + address.getHostName() + "]."; + if (reconnectionDelay > 0) { + msg += " We will try again later."; + fireConnector(); // fire the connector thread + } + addError(msg, e); + } + } + + @Override + protected void append(Object event) { + + if (event == null) + return; + + if (address == null) { + addError("No remote host is set for SocketAppender named \"" + this.name + + "\"."); + return; + } + + if (oos != null) { + try { + oos.writeObject(event); + // addInfo("=========Flushing."); + oos.flush(); + if (++counter >= RESET_FREQUENCY) { + counter = 0; + // Failing to reset the object output stream every now and + // then creates a serious memory leak. + // System.err.println("Doing oos.reset()"); + oos.reset(); + } + } catch (IOException e) { + oos = null; + addWarn("Detected problem with connection: " + e); + if (reconnectionDelay > 0) { + fireConnector(); + } + } + } + } + + void fireConnector() { + if (connector == null) { + addInfo("Starting a new connector thread."); + connector = new Connector(); + connector.setDaemon(true); + connector.setPriority(Thread.MIN_PRIORITY); + connector.start(); + } + } + + static InetAddress getAddressByName(String host) { + try { + return InetAddress.getByName(host); + } catch (Exception e) { + // addError("Could not find address of [" + host + "].", e); + return null; + } + } + + /** + * The RemoteHost option takes a string value which should be the host + * name of the server where a {@link SocketNode} is running. + */ + public void setRemoteHost(String host) { + address = getAddressByName(host); + remoteHost = host; + } + + /** + * Returns value of the RemoteHost option. + */ + public String getRemoteHost() { + return remoteHost; + } + + /** + * The Port option takes a positive integer representing the port + * where the server is waiting for connections. + */ + public void setPort(int port) { + this.port = port; + } + + /** + * Returns value of the Port option. + */ + public int getPort() { + return port; + } + + /** + * The ReconnectionDelay option takes a positive integer representing + * the number of milliseconds to wait between each failed connection attempt + * to the server. The default value of this option is 30000 which corresponds + * to 30 seconds. + * + * + * Setting this option to zero turns off reconnection capability. + */ + public void setReconnectionDelay(int delay) { + this.reconnectionDelay = delay; + } + + /** + * Returns value of the ReconnectionDelay option. + */ + public int getReconnectionDelay() { + return reconnectionDelay; + } + + public Layout getLayout() { + return null; + } + + public void setLayout(Layout layout) { + } + + /** + * The Connector will reconnect when the server becomes available again. It + * does this by attempting to open a new connection every + * <code>reconnectionDelay</code> milliseconds. + * + * + * It stops trying whenever a connection is established. It will restart to + * try reconnect to the server when previpously open connection is droppped. + * + * @author Ceki Gülcü + * @since 0.8.4 + */ + class Connector extends Thread { + + boolean interrupted = false; + + public void run() { + Socket socket; + while (!interrupted) { + try { + sleep(reconnectionDelay); + addInfo("Attempting connection to " + address.getHostName()); + socket = new Socket(address, port); + synchronized (this) { + oos = new ObjectOutputStream(socket.getOutputStream()); + connector = null; + addInfo("Connection established. Exiting connector thread."); + break; + } + } catch (InterruptedException e) { + addInfo("Connector interrupted. Leaving loop."); + return; + } catch (java.net.ConnectException e) { + addInfo("Remote host " + address.getHostName() + + " refused connection."); + } catch (IOException e) { + addInfo("Could not connect to " + address.getHostName() + + ". Exception is " + e); + } + } + // addInfo("Exiting Connector.run() method."); + } + + /** + * public void finalize() { LogLog.debug("Connector finalize() has been + * called."); } + */ + } } 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 Wed Sep 13 19:54:25 2006 @@ -1,5 +1,10 @@ package ch.qos.logback.classic.net; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; import java.util.Map; import junit.framework.TestCase; @@ -13,126 +18,130 @@ public class SocketAppenderTest extends TestCase { - private LoggerContext lc; - private MockSocketServer mockSocketServer; - - public void testStartFailNoRemoteHost() { - lc = new LoggerContext(); - SocketAppender appender = new SocketAppender(); - appender.setContext(lc); - appender.setPort(123); - appender.start(); - assertEquals(1, lc.getStatusManager().getCount()); - } - - public void testRecieveMessage() throws InterruptedException { - 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(); - - 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); - - LoggerRemoteView loggerRemoteView = remoteEvent.getLoggerRemoteView(); - assertNotNull(loggerRemoteView); - assertEquals("root", loggerRemoteView.getName()); - - LoggerContextRemoteView loggerContextRemoteView = loggerRemoteView.getLoggerContextView(); - assertNotNull(loggerContextRemoteView); - assertEquals("test", loggerContextRemoteView.getName()); - 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(); - } + ByteArrayOutputStream bos; + ObjectInputStream inputStream; + SocketAppender appender; + Logger logger; + + LoggerContext lc; + MockSocketServer mockSocketServer; + + public void setUp() throws Exception { + lc = new LoggerContext(); + lc.setName("test"); + lc.setProperty("testKey", "testValue"); + appender = new SocketAppender(); + appender.setPort(123); + appender.setContext(lc); + appender.setRemoteHost("localhost"); + appender.start(); + logger = lc.getLogger(LoggerContext.ROOT_NAME); + logger.addAppender(appender); + } + + public void testStartFailNoRemoteHost() { + lc = new LoggerContext(); + SocketAppender appender = new SocketAppender(); + appender.setContext(lc); + appender.setPort(123); + appender.start(); + assertEquals(1, lc.getStatusManager().getCount()); + } + + public void testRecieveMessage() throws InterruptedException, IOException, + ClassNotFoundException { + + //create the byte output stream + bos = new ByteArrayOutputStream() ; + appender.oos = new ObjectOutputStream(bos); + + LoggingEvent event = createLoggingEvent(); + appender.append(event); + + //create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + LoggingEvent remoteEvent = (LoggingEvent) inputStream.readObject(); + + assertEquals("test message", remoteEvent.getMessage()); + assertEquals(Level.DEBUG, remoteEvent.getLevel()); + } + + public void testRecieveWithContext() throws InterruptedException, IOException, ClassNotFoundException { + + //create the byte output stream + bos = new ByteArrayOutputStream() ; + appender.oos = new ObjectOutputStream(bos); + + LoggingEvent event = createLoggingEvent(); + appender.append(event); + + //create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + LoggingEvent remoteEvent = (LoggingEvent) inputStream.readObject(); + + LoggerRemoteView loggerRemoteView = remoteEvent.getLoggerRemoteView(); + assertNotNull(loggerRemoteView); + assertEquals("root", loggerRemoteView.getName()); + + LoggerContextRemoteView loggerContextRemoteView = loggerRemoteView + .getLoggerContextView(); + assertNotNull(loggerContextRemoteView); + assertEquals("test", loggerContextRemoteView.getName()); + Map<String, String> props = loggerContextRemoteView.getPropertyMap(); + assertEquals("testValue", props.get("testKey")); + } + + public void testMessageWithMDC() throws InterruptedException, IOException, ClassNotFoundException { + //create the byte output stream + bos = new ByteArrayOutputStream() ; + appender.oos = new ObjectOutputStream(bos); + + MDC.put("key", "testValue"); + LoggingEvent event = createLoggingEvent(); + appender.append(event); + + //create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + LoggingEvent remoteEvent = (LoggingEvent) inputStream.readObject(); + + Map<String, String> MDCPropertyMap = remoteEvent.getMDCPropertyMap(); + assertEquals("testValue", MDCPropertyMap.get("key")); + } + + public void testMessageWithUpdatedMDC() throws InterruptedException, IOException, ClassNotFoundException { + //create the byte output stream + bos = new ByteArrayOutputStream() ; + appender.oos = new ObjectOutputStream(bos); + + MDC.put("key", "testValue"); + LoggingEvent event = createLoggingEvent(); + appender.append(event); + + MDC.put("key", "updatedTestValue"); + event = createLoggingEvent(); + appender.append(event); + + //create the input stream based on the ouput stream + ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); + inputStream = new ObjectInputStream(bis); + + @SuppressWarnings("unused") + LoggingEvent remoteEvent1 = (LoggingEvent) inputStream.readObject(); + LoggingEvent remoteEvent2 = (LoggingEvent) inputStream.readObject(); + + Map<String, String> MDCPropertyMap = remoteEvent2.getMDCPropertyMap(); + assertEquals("updatedTestValue", MDCPropertyMap.get("key")); + } + + private LoggingEvent createLoggingEvent() { + LoggingEvent le = new LoggingEvent(this.getClass().getName(), logger, + Level.DEBUG, "test message", null, null); + return le; + } }

1 0

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

13 Sep '06

Author: seb Date: Wed Sep 13 19:47:12 2006 New Revision: 579 Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java Log: - updated test Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java Wed Sep 13 19:47:12 2006 @@ -46,7 +46,7 @@ address = addressArray[0]; assertEquals("sebastien.nospam(a)qos.ch", address.toString()); - assertEquals("logging report", appender.getMessage().getSubject()); + assertEquals("logging report", appender.getSubject()); assertTrue(appender.isStarted());

1 0

svn commit: r578 - in logback/trunk/logback-classic/src: main/java/ch/qos/logback/classic/html test/java/ch/qos/logback/classic/html
by noreply.seb＠qos.ch 13 Sep '06

13 Sep '06

Author: seb Date: Wed Sep 13 19:40:25 2006 New Revision: 578 Added: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/DefaultThrowableRenderer.java - copied, changed from r576, /logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/IThrowableRenderer.java logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/NOPThrowableRenderer.java Removed: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java Log: - added IThrowableRenderer, an interface to allow multiple implementations of ThrowableRenderer to be easily used - added NOPThrowableRenderer, a no op implementation of the IThrowableRenderer interface - the HTMLLayout now uses the DefaultThrowableRenderer by default. - updated tests - on going work on the HTMLLayout javadoc Copied: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/DefaultThrowableRenderer.java (from r576, /logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java) ============================================================================== --- /logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/DefaultThrowableRenderer.java Wed Sep 13 19:40:25 2006 @@ -3,14 +3,15 @@ import static ch.qos.logback.core.Layout.LINE_SEP; import ch.qos.logback.classic.helpers.Transform; import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.classic.spi.ThrowableInformation; -public class ThrowableRenderer { +public class DefaultThrowableRenderer implements IThrowableRenderer { static final String TRACE_PREFIX = "     "; Throwable throwable; - public ThrowableRenderer() { + public DefaultThrowableRenderer() { } @@ -24,6 +25,7 @@ if (len == 0) { return; } + sbuf.append("<tr><td class=\"Exception\" colspan=\"6\">"); sbuf.append(Transform.escapeTags(s[0])); sbuf.append(LINE_SEP); for (int i = 1; i < len; i++) { @@ -31,10 +33,14 @@ sbuf.append(Transform.escapeTags(s[i])); sbuf.append(LINE_SEP); } - } + sbuf.append("</td></tr>"); + } } public void render(StringBuffer sbuf, LoggingEvent event) { - render(sbuf, event.getThrowableInformation().getThrowableStrRep()); + ThrowableInformation ti = event.getThrowableInformation(); + if (ti != null) { + render(sbuf, ti.getThrowableStrRep()); + } } } Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Wed Sep 13 19:40:25 2006 @@ -28,19 +28,25 @@ * The content of the table columns are specified using a conversion pattern. * See {@link ch.qos.logback.classic.PatternLayout} for documentation on the * available patterns. + * * Note that the pattern %ex used to display an Exception is not the only way * to display an Exception with this layout. - * An internal {@link ch.qos.logback.classic.html.ThrowableRenderer} can be called - * to render the throwable. If a ThrowableRenderer is specified, it is used to render - * the Exception on a new line. - * If no such object is specified to the HTMLLayout, then one must add %ex + * + * An internal {@link ch.qos.logback.classic.html.IThrowableRenderer} can be called + * to render the throwable. + * By default, a {@link ch.qos.logback.classic.html.DefaultThrowableRenderer} + * is assigned to the HTMLLayout. It writes the Exception on a new table row. + * + * FIXME WRITE MORE ABOUT THIS. + * + * In that case, then one must add %ex * to the pattern to display Exceptions. * - * A user-specified external CSS file can be link to the html page. - * In case one does not want to custom the html output, an internal CSS + * A user-specified external CSS file can be linked to the html page. + * In case one does not want to customize the html output, an internal CSS style * is used. * - * The HTMLLayout is often used in conjunction with a SMTPAppender, to + * The HTMLLayout is often used in conjunction with SMTPAppender, to * send a nicely formatted html email. Of course, it can be used with any * other Appender. * @@ -87,7 +93,7 @@ private CssBuilder cssBuilder; - ThrowableRenderer throwableRenderer; + IThrowableRenderer throwableRenderer = new DefaultThrowableRenderer(); // counter keeping track of the rows output private long counter = 0; @@ -132,6 +138,13 @@ */ @Override public void start() { + int errorCount = 0; + + if (throwableRenderer == null) { + addError("ThrowableRender cannot be null."); + errorCount++; + } + try { Parser p = new Parser(pattern); if (getContext() != null) { @@ -142,9 +155,12 @@ DynamicConverter.startConverters(this.head); } catch (ScanException ex) { addError("Incorrect pattern found", ex); + errorCount++; } - started = true; + if (errorCount == 0) { + started = true; + } } /** @@ -288,10 +304,8 @@ buf.append("</tr>"); buf.append(LINE_SEP); - if (throwableRenderer != null && event.getThrowableInformation() != null) { - buf.append("<tr><td class=\"Exception\" colspan=\"6\">"); + if (event.getThrowableInformation() != null) { throwableRenderer.render(buf, event); - buf.append("</td></tr>"); } return buf.toString(); } @@ -328,11 +342,11 @@ } } - public ThrowableRenderer getThrowableRenderer() { + public IThrowableRenderer getThrowableRenderer() { return throwableRenderer; } - public void setThrowableRenderer(ThrowableRenderer throwableRenderer) { + public void setThrowableRenderer(IThrowableRenderer throwableRenderer) { this.throwableRenderer = throwableRenderer; } Added: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/IThrowableRenderer.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/IThrowableRenderer.java Wed Sep 13 19:40:25 2006 @@ -0,0 +1,9 @@ +package ch.qos.logback.classic.html; + +import ch.qos.logback.classic.spi.LoggingEvent; + +public interface IThrowableRenderer { + + public void render(StringBuffer sbuf, LoggingEvent event); + +} Added: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/NOPThrowableRenderer.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/NOPThrowableRenderer.java Wed Sep 13 19:40:25 2006 @@ -0,0 +1,11 @@ +package ch.qos.logback.classic.html; + +import ch.qos.logback.classic.spi.LoggingEvent; + +public class NOPThrowableRenderer implements IThrowableRenderer { + + public void render(StringBuffer sbuf, LoggingEvent event) { + return; + } + +} Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java Wed Sep 13 19:40:25 2006 @@ -30,6 +30,7 @@ ListAppender appender = new ListAppender(); appender.setContext(lc); layout = new HTMLLayout(); + layout.setThrowableRenderer(new DefaultThrowableRenderer()); layout.setContext(lc); layout.setPattern("%level%thread%msg"); layout.start(); @@ -65,11 +66,12 @@ public void testAppendThrowable() throws Exception { StringBuffer buf = new StringBuffer(); String[] strArray = { "test1", "test2" }; - layout.throwableRenderer.render(buf, strArray); - // System.out.println(buf.toString()); + DefaultThrowableRenderer renderer = (DefaultThrowableRenderer)layout.throwableRenderer; + renderer.render(buf, strArray); + System.out.println(buf.toString()); String[] result = buf.toString().split(HTMLLayout.LINE_SEP); - assertEquals("test1", result[0]); - assertEquals(ThrowableRenderer.TRACE_PREFIX + "test2", result[1]); + assertEquals("<tr><td class=\"Exception\" colspan=\"6\">test1", result[0]); + assertEquals(DefaultThrowableRenderer.TRACE_PREFIX + "test2", result[1]); } public void testDoLayout() throws Exception {

1 0

svn commit: r577 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi
by noreply.seb＠qos.ch 13 Sep '06

13 Sep '06

Author: seb Date: Wed Sep 13 19:05:08 2006 New Revision: 577 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java Log: commented output to Console Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java Wed Sep 13 19:05:08 2006 @@ -102,8 +102,7 @@ String tagName = getTagName(localName, qName); - System.out.println("startElement [" + tagName + "]"); - // LogLog.debug("in startElement <" + tagName + ">"); + //System.out.println("startElement [" + tagName + "]"); pattern.push(tagName);

1 0

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

13 Sep '06

Author: seb Date: Wed Sep 13 17:37:34 2006 New Revision: 576 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java Log: - updated ThrowableRenderer and HTMLLayout. The ThrowableRenderer can be specified in the configuration file. If it is present, it is used to render the Exception in a new line. If no ThrowableRenderer is specified, the user must add a %ex to the pattern used by the HTMLLayout to display Exceptions. Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Wed Sep 13 17:37:34 2006 @@ -28,9 +28,13 @@ * The content of the table columns are specified using a conversion pattern. * See {@link ch.qos.logback.classic.PatternLayout} for documentation on the * available patterns. - * Note that the pattern %ex used to display an Exception does not need - * to be specified with this layout. An internal {@link ch.qos.logback.classic.html.ThrowableRenderer} is - * called to render the throwable. + * Note that the pattern %ex used to display an Exception is not the only way + * to display an Exception with this layout. + * An internal {@link ch.qos.logback.classic.html.ThrowableRenderer} can be called + * to render the throwable. If a ThrowableRenderer is specified, it is used to render + * the Exception on a new line. + * If no such object is specified to the HTMLLayout, then one must add %ex + * to the pattern to display Exceptions. * * A user-specified external CSS file can be link to the html page. * In case one does not want to custom the html output, an internal CSS @@ -49,6 +53,7 @@ * <layout class="ch.qos.logback.classic.html.HTMLLayout"> * <param name="pattern" value="%relative%thread%mdc%level%class%msg" /> * </layout> + * <throwableRenderer class="ch.qos.logback.classic.html.ThrowableRenderer" /> * <param name="From" value="sender.email(a)domain.net" /> * <param name="SMTPHost" value="mail.domain.net" /> * <param name="Subject" value="LastEvent: %class - %msg" /> @@ -82,7 +87,7 @@ private CssBuilder cssBuilder; - ThrowableRenderer throwableRenderer = new ThrowableRenderer(); + ThrowableRenderer throwableRenderer; // counter keeping track of the rows output private long counter = 0; @@ -219,10 +224,6 @@ sbuf.append("<tr class=\"header\">"); sbuf.append(LINE_SEP); while (c != null) { - // if (c instanceof ThrowableHandlingConverter) { - // c = c.getNext(); - // continue; - // } name = computeConverterName(c); if (name == null) { c = c.getNext(); @@ -287,7 +288,7 @@ buf.append("</tr>"); buf.append(LINE_SEP); - if (throwableRenderer.newLineRequired(event)) { + if (throwableRenderer != null && event.getThrowableInformation() != null) { buf.append("<tr><td class=\"Exception\" colspan=\"6\">"); throwableRenderer.render(buf, event); buf.append("</td></tr>"); @@ -327,4 +328,13 @@ } } + public ThrowableRenderer getThrowableRenderer() { + return throwableRenderer; + } + + public void setThrowableRenderer(ThrowableRenderer throwableRenderer) { + this.throwableRenderer = throwableRenderer; + } + + } Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java Wed Sep 13 17:37:34 2006 @@ -17,10 +17,6 @@ public void setThrowable(Throwable t) { this.throwable = t; } - - public boolean newLineRequired(LoggingEvent event) { - return event.getThrowableInformation() != null; - } public void render(StringBuffer sbuf, String[] s) { if (s != null) {

1 0

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

13 Sep '06

Author: seb Date: Wed Sep 13 16:12:55 2006 New Revision: 575 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Log: - added some documentation in the javadoc - corrected docType declaration - suppressed two unused variables Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Wed Sep 13 16:12:55 2006 @@ -23,10 +23,45 @@ /** * - * HTMLLayout outputs events in an HTML table. The content of the table columns - * are specified using a conversion pattern. See - * {@link ch.qos.logback.classic.PatternLayout} for documentation on the + * HTMLLayout outputs events in an HTML table. + * + * The content of the table columns are specified using a conversion pattern. + * See {@link ch.qos.logback.classic.PatternLayout} for documentation on the * available patterns. + * Note that the pattern %ex used to display an Exception does not need + * to be specified with this layout. An internal {@link ch.qos.logback.classic.html.ThrowableRenderer} is + * called to render the throwable. + * + * A user-specified external CSS file can be link to the html page. + * In case one does not want to custom the html output, an internal CSS + * is used. + * + * The HTMLLayout is often used in conjunction with a SMTPAppender, to + * send a nicely formatted html email. Of course, it can be used with any + * other Appender. + * + * In case on wants to use the HTMLLayout with a SMTPAppender, here is a sample + * configuration file that can be used. + * + * <pre> + * <configuration> + * <appender name="SMTP" class="ch.qos.logback.classic.net.SMTPAppender"> + * <layout class="ch.qos.logback.classic.html.HTMLLayout"> + * <param name="pattern" value="%relative%thread%mdc%level%class%msg" /> + * </layout> + * <param name="From" value="sender.email(a)domain.net" /> + * <param name="SMTPHost" value="mail.domain.net" /> + * <param name="Subject" value="LastEvent: %class - %msg" /> + * <param name="To" value="destination.email(a)domain.net" /> + * </appender> + * + * <root> + * <level value="debug" /> + * <appender-ref ref="SMTP" /> + * </root> + * </configuration> + *</pre> + * * * @author Ceki Gülcü * @author Sébastien Pennec @@ -39,14 +74,10 @@ */ static final String DEFAULT_CONVERSION_PATTERN = "%date%thread%level%logger%mdc%msg"; - protected final int BUF_SIZE = 256; - protected final int MAX_CAPACITY = 1024; - private String pattern; private Converter head; - // private String timezone; private String title = "Logback Log Messages"; private CssBuilder cssBuilder; @@ -94,6 +125,7 @@ /** * Parses the pattern and creates the Converter linked list. */ + @Override public void start() { try { Parser p = new Parser(pattern); @@ -139,10 +171,9 @@ /** * Returns appropriate HTML headers. */ + @Override public String getHeader() { StringBuffer sbuf = new StringBuffer(); - // PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - // SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" sbuf.append("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\""); sbuf.append(" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"); sbuf.append(LINE_SEP); @@ -212,6 +243,7 @@ /** * Returns the appropriate HTML footers. */ + @Override public String getFooter() { StringBuffer sbuf = new StringBuffer(); sbuf.append("</table>");

1 0

svn commit: r574 - in logback/trunk/logback-classic/src: main/java/ch/qos/logback/classic/html main/java/ch/qos/logback/classic/pattern test/java/ch/qos/logback/classic/html
by noreply.seb＠qos.ch 13 Sep '06

13 Sep '06

Author: seb Date: Wed Sep 13 15:51:24 2006 New Revision: 574 Added: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/pattern/ThrowableHandlingConverter.java logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java Log: - added ThrowableRenderer class to manage the output of exceptions - updated HTMLLayout to use the new class - updated tests - removed the unnecessary method onNewLine from ThrowableHandlingConverter Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/HTMLLayout.java Wed Sep 13 15:51:24 2006 @@ -13,10 +13,7 @@ import ch.qos.logback.classic.ClassicLayout; import ch.qos.logback.classic.PatternLayout; import ch.qos.logback.classic.helpers.CssBuilder; -import ch.qos.logback.classic.helpers.Transform; -import ch.qos.logback.classic.pattern.ThrowableHandlingConverter; import ch.qos.logback.classic.spi.LoggingEvent; -import ch.qos.logback.classic.spi.ThrowableInformation; import ch.qos.logback.core.LayoutBase; import ch.qos.logback.core.pattern.Converter; import ch.qos.logback.core.pattern.DynamicConverter; @@ -42,25 +39,23 @@ */ static final String DEFAULT_CONVERSION_PATTERN = "%date%thread%level%logger%mdc%msg"; - static final String TRACE_PREFIX = "     "; protected final int BUF_SIZE = 256; protected final int MAX_CAPACITY = 1024; - + private String pattern; - + private Converter head; - - //private String timezone; + + // private String timezone; private String title = "Logback Log Messages"; private CssBuilder cssBuilder; - // Does our PatternConverter chain handle throwable on its own? - private boolean chainHandlesThrowable; + ThrowableRenderer throwableRenderer = new ThrowableRenderer(); // counter keeping track of the rows output private long counter = 0; - //max number of rows before we close the table and create a new one + // max number of rows before we close the table and create a new one private static final int ROW_LIMIT = 10000; /** @@ -87,11 +82,11 @@ public String getPattern() { return pattern; } - + public CssBuilder getCssBuilder() { return cssBuilder; } - + public void setCssBuilder(CssBuilder cssBuilder) { this.cssBuilder = cssBuilder; } @@ -107,25 +102,13 @@ } Node t = p.parse(); this.head = p.compile(t, PatternLayout.defaultConverterMap); - postCompileProcessing(head); DynamicConverter.startConverters(this.head); - } catch (ScanException ex) { + } catch (ScanException ex) { addError("Incorrect pattern found", ex); } - + started = true; } - - private void postCompileProcessing(Converter c) { - while (c != null) { - if (c instanceof ThrowableHandlingConverter) { - chainHandlesThrowable = true; - return; - } - c = c.getNext(); - } - chainHandlesThrowable = false; - } /** * The Title option takes a String value. This option sets the @@ -153,30 +136,15 @@ return "text/html"; } - void appendThrowableAsHTML(final String[] s, final StringBuffer sbuf) { - if (s != null) { - int len = s.length; - if (len == 0) { - return; - } - sbuf.append(Transform.escapeTags(s[0])); - sbuf.append(LINE_SEP); - for (int i = 1; i < len; i++) { - sbuf.append(TRACE_PREFIX); - sbuf.append(Transform.escapeTags(s[i])); - sbuf.append(LINE_SEP); - } - } - } - /** * Returns appropriate HTML headers. */ public String getHeader() { StringBuffer sbuf = new StringBuffer(); - + // PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + // SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" sbuf.append("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\""); - sbuf.append(" SYSTEM \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"); + sbuf.append(" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"); sbuf.append(LINE_SEP); sbuf.append("<html>"); sbuf.append(LINE_SEP); @@ -208,7 +176,7 @@ sbuf.append(LINE_SEP); sbuf.append("<table cellspacing=\"0\">"); sbuf.append(LINE_SEP); - + createTableHeader(sbuf); return sbuf.toString(); @@ -220,10 +188,10 @@ sbuf.append("<tr class=\"header\">"); sbuf.append(LINE_SEP); while (c != null) { - if (c instanceof ThrowableHandlingConverter) { - c = c.getNext(); - continue; - } + // if (c instanceof ThrowableHandlingConverter) { + // c = c.getNext(); + // continue; + // } name = computeConverterName(c); if (name == null) { c = c.getNext(); @@ -234,14 +202,12 @@ sbuf.append("\">"); sbuf.append(computeConverterName(c)); sbuf.append("</td>"); - sbuf.append(LINE_SEP); + sbuf.append(LINE_SEP); c = c.getNext(); } sbuf.append("</tr>"); sbuf.append(LINE_SEP); } - - /** * Returns the appropriate HTML footers. @@ -263,7 +229,7 @@ public String doLayout(LoggingEvent event) { StringBuffer buf = new StringBuffer(); handleTableClosing(buf); - + boolean odd = true; if (((counter++) & 1) == 0) { odd = false; @@ -271,7 +237,6 @@ String level = event.getLevel().toString().toLowerCase(); - buf.append(LINE_SEP); buf.append("<tr class=\""); buf.append(level); @@ -284,44 +249,20 @@ Converter c = head; while (c != null) { - if (c instanceof ThrowableHandlingConverter) { - ThrowableHandlingConverter converter = (ThrowableHandlingConverter)c; - if (converter.onNewLine(event)) { - buf.append("</tr>"); - buf.append("<tr colspan=\"6\">"); - appendThrowableAsHTML(event.getThrowableInformation().getThrowableStrRep(), buf); - //appendEventToBuffer(buf, c, event); - if (c.getNext() != null) { - //here we assume that when we exist the while loop, - //a </tr> tag is added. - buf.append("</tr>"); - buf.append("<tr>"); - } - } - } else { - appendEventToBuffer(buf, c, event); - } + appendEventToBuffer(buf, c, event); c = c.getNext(); } buf.append("</tr>"); buf.append(LINE_SEP); - // if the pattern chain handles throwables then no need to do it again here. - if (!chainHandlesThrowable) { - ThrowableInformation ti = event.getThrowableInformation(); - if (ti != null) { - String[] s = ti.getThrowableStrRep(); - if (s != null) { - buf.append("<tr><td class=\"Exception\" colspan=\"6\">"); - appendThrowableAsHTML(s, buf); - buf.append("</td></tr>"); - buf.append(LINE_SEP); - } - } + if (throwableRenderer.newLineRequired(event)) { + buf.append("<tr><td class=\"Exception\" colspan=\"6\">"); + throwableRenderer.render(buf, event); + buf.append("</td></tr>"); } return buf.toString(); } - + private void handleTableClosing(StringBuffer sbuf) { if (this.counter >= ROW_LIMIT) { counter = 0; @@ -333,64 +274,18 @@ createTableHeader(sbuf); } } - - private void appendEventToBuffer(StringBuffer buf, Converter c, LoggingEvent event) { + + private void appendEventToBuffer(StringBuffer buf, Converter c, + LoggingEvent event) { buf.append("<td class=\""); buf.append(computeConverterName(c)); buf.append("\">"); buf.append(c.convert(event)); buf.append("</td>"); - buf.append(LINE_SEP); - } - - /** - * Generate an internal CSS file. - * - * @param buf The StringBuffer where the CSS file will be placed. - */ - void getInternalCSS(StringBuffer buf) { - - buf.append("<STYLE type=\"text/css\">"); - buf.append(LINE_SEP); - buf.append("table { margin-left: 2em; margin-right: 2em; border-left: 2px solid #AAA; }"); - buf.append(LINE_SEP); - - buf.append("TR.even { background: #FFFFFF; }"); - buf.append(LINE_SEP); - - buf.append("TR.odd { background: #DADADA; }"); - buf.append(LINE_SEP); - - buf.append("TR.warn TD.level, TR.error TD.level, TR.fatal TD.level {font-weight: bold; color: #FF4040 }"); - buf.append(LINE_SEP); - - buf.append("TD { padding-right: 1ex; padding-left: 1ex; border-right: 2px solid #AAA; }"); - buf.append(LINE_SEP); - - buf.append("TD.Time, TD.Date { text-align: right; font-family: courier, monospace; font-size: smaller; }"); buf.append(LINE_SEP); - - buf.append("TD.Thread { text-align: left; }"); - buf.append(LINE_SEP); - - buf.append("TD.Level { text-align: right; }"); - buf.append(LINE_SEP); - - buf.append("TD.Logger { text-align: left; }"); - buf.append(LINE_SEP); - - buf.append("TR.header { background: #9090FF; color: #FFF; font-weight: bold; font-size: larger; }"); - buf.append(LINE_SEP); - - buf.append("TD.Exception { background: #C0C0F0; font-family: courier, monospace;}"); - buf.append(LINE_SEP); - - buf.append("</STYLE>"); - buf.append(LINE_SEP); - } - - private String computeConverterName(Converter c) { + + private String computeConverterName(Converter c) { String className = c.getClass().getSimpleName(); int index = className.indexOf("Converter"); if (index == -1) { Added: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/html/ThrowableRenderer.java Wed Sep 13 15:51:24 2006 @@ -0,0 +1,44 @@ +package ch.qos.logback.classic.html; + +import static ch.qos.logback.core.Layout.LINE_SEP; +import ch.qos.logback.classic.helpers.Transform; +import ch.qos.logback.classic.spi.LoggingEvent; + +public class ThrowableRenderer { + + static final String TRACE_PREFIX = "     "; + + Throwable throwable; + + public ThrowableRenderer() { + + } + + public void setThrowable(Throwable t) { + this.throwable = t; + } + + public boolean newLineRequired(LoggingEvent event) { + return event.getThrowableInformation() != null; + } + + public void render(StringBuffer sbuf, String[] s) { + if (s != null) { + int len = s.length; + if (len == 0) { + return; + } + sbuf.append(Transform.escapeTags(s[0])); + sbuf.append(LINE_SEP); + for (int i = 1; i < len; i++) { + sbuf.append(TRACE_PREFIX); + sbuf.append(Transform.escapeTags(s[i])); + sbuf.append(LINE_SEP); + } + } + } + + public void render(StringBuffer sbuf, LoggingEvent event) { + render(sbuf, event.getThrowableInformation().getThrowableStrRep()); + } +} Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/pattern/ThrowableHandlingConverter.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/pattern/ThrowableHandlingConverter.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/pattern/ThrowableHandlingConverter.java Wed Sep 13 15:51:24 2006 @@ -1,7 +1,5 @@ package ch.qos.logback.classic.pattern; -import ch.qos.logback.classic.pattern.ClassicConverter; -import ch.qos.logback.classic.spi.LoggingEvent; /** @@ -13,9 +11,4 @@ boolean handlesThrowable() { return true; } - - // tentatively... - public boolean onNewLine(LoggingEvent le) { - return le.getThrowableInformation() != null; - } } Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/html/HTMLLayoutTest.java Wed Sep 13 15:51:24 2006 @@ -31,7 +31,7 @@ appender.setContext(lc); layout = new HTMLLayout(); layout.setContext(lc); - layout.setPattern("%level %thread %msg"); + layout.setPattern("%level%thread%msg"); layout.start(); appender.setLayout(layout); logger = lc.getLogger(LoggerContext.ROOT_NAME); @@ -58,20 +58,18 @@ Element trElement = tableElement.element("tr"); List<Element> elementList = trElement.elements(); assertEquals("Level", elementList.get(0).getText()); - assertEquals("Literal", elementList.get(1).getText()); - assertEquals("Thread", elementList.get(2).getText()); - assertEquals("Literal", elementList.get(3).getText()); - assertEquals("Message", elementList.get(4).getText()); + assertEquals("Thread", elementList.get(1).getText()); + assertEquals("Message", elementList.get(2).getText()); } public void testAppendThrowable() throws Exception { StringBuffer buf = new StringBuffer(); String[] strArray = { "test1", "test2" }; - layout.appendThrowableAsHTML(strArray, buf); + layout.throwableRenderer.render(buf, strArray); // System.out.println(buf.toString()); String[] result = buf.toString().split(HTMLLayout.LINE_SEP); assertEquals("test1", result[0]); - assertEquals(HTMLLayout.TRACE_PREFIX + "test2", result[1]); + assertEquals(ThrowableRenderer.TRACE_PREFIX + "test2", result[1]); } public void testDoLayout() throws Exception { @@ -79,25 +77,17 @@ String result = layout.doLayout(le); Document doc = parseOutput(result); Element trElement = doc.getRootElement(); - assertEquals(5, trElement.elements().size()); + assertEquals(3, trElement.elements().size()); { Element tdElement = (Element) trElement.elements().get(0); assertEquals("DEBUG", tdElement.getText()); } { Element tdElement = (Element) trElement.elements().get(1); - assertEquals(" ", tdElement.getText()); - } - { - Element tdElement = (Element) trElement.elements().get(2); assertEquals("main", tdElement.getText()); } { - Element tdElement = (Element) trElement.elements().get(3); - assertEquals(" ", tdElement.getText()); - } - { - Element tdElement = (Element) trElement.elements().get(4); + Element tdElement = (Element) trElement.elements().get(2); assertEquals("test message", tdElement.getText()); } // System.out.println(result); @@ -130,8 +120,12 @@ } // public void testLog() { -// for (int i = 1; i <= 1000; i++) { -// logger.debug("test message" + i); +// for (int i = 1; i <= 10; i++) { +// if (i == 5 || i == 8) { +// logger.debug("test", new Exception("test exception")); +// } else { +// logger.debug("test message" + i); +// } // } // }

1 0

svn commit: r573 - in logback/trunk: . logback-classic
by noreply.seb＠qos.ch 13 Sep '06

13 Sep '06

Author: seb Date: Wed Sep 13 15:06:21 2006 New Revision: 573 Modified: logback/trunk/logback-classic/pom.xml logback/trunk/pom.xml Log: - corrected dependency declaration Modified: logback/trunk/logback-classic/pom.xml ============================================================================== --- logback/trunk/logback-classic/pom.xml (original) +++ logback/trunk/logback-classic/pom.xml Wed Sep 13 15:06:21 2006 @@ -39,7 +39,6 @@ <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> - <version>1.1.0-beta0</version> </dependency> <dependency> Modified: logback/trunk/pom.xml ============================================================================== --- logback/trunk/pom.xml (original) +++ logback/trunk/pom.xml Wed Sep 13 15:06:21 2006 @@ -66,9 +66,14 @@ </dependency> <dependency> <groupId>dom4j</groupId> - <artifactId>dom4j</artifactId> + <artifactId>dom4j</artifactId> <version>1.6.1</version> </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-api</artifactId> + <version>1.1.0-beta0</version> + </dependency>  <dependency>

1 0