September 2006 - logback-dev

logbag vs. LOGBack
by Boris Unckel 19 Sep '06

19 Sep '06

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

2 1

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

15 Sep '06

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

1 0

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

14 Sep '06

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

1 0

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

14 Sep '06

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

1 0

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

14 Sep '06

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

1 0

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

14 Sep '06

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

1 0

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

14 Sep '06

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

1 0

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

14 Sep '06

Author: seb Date: Thu Sep 14 15:57:58 2006 New Revision: 585 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java Log: Added javadoc: - quick intro about PatternLayout and pattern conversion - explanation of format modifier on classnames, with examples - doc in progress Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java Thu Sep 14 15:57:58 2006 @@ -33,7 +33,91 @@ import ch.qos.logback.core.pattern.Converter; import ch.qos.logback.core.pattern.PatternLayoutBase; - +/** + * + * PatternLayout is a simple yet powerfull way to turn a LoggingEvent into + * a String. + * + * The returned String can be modified by specifying a pattern to the layout. + * A pattern is composed of literal text and format control expressions called + * conversion specifiers. Any literal can be inserted between the conversions + * specifiers. When literals are inserted, PatternLayout is able to differentiate + * which part of the pattern are conversion specifiers and which should be + * added as-is to the output string. + * + * A conversion specifier starts with a percent sign (%) and is followed by + * a letter or a word, describing the type of data that will be displayed. + * A format modifier can be added to the conversion specifier. It will tweak + * the way that the conversion specifier will display the data. + * + * Here are a few quick examples: + * + * <table cellpadding=10> + * <tr> + * <th>Conversion pattern</th> + * <th>Result</th> + * <th>Explanation</th> + * </tr> + * <tr> + * <td>%level [%thread]: %message</td> + * <td>DEBUG [main]: Message 1</td> + * <td>Simple pattern</td> + * </tr> + * <tr> + * <td>%level [%logger]: %message</td> + * <td>DEBUG [org.foo.bar.SampleClass]: Message 2</td> + * <td>With %logger, the fully qualified name is displayed</td> + * </tr> + * <tr> + * <td>%level [%logger{10}]: %message</td> + * <td>DEBUG [o.f.b.SampleClass]: Message 2</td> + * <td>A format modifier has been added to the conversion specifier, thus + * modifying the string displayed.</td> + * </tr> + * </table> + * + * When a conversion specifier is used in conjunction with a format modifier, + * the resulting string is modified. It is modified in a way that one can still + * read the class name, and deduce its fully qualified name by looking at the + * packages' first letter. + * + * The format modifier can have a milder effect on the resulting string. If a + * larger number is specified, a longer part of the fully qualified name will be + * displayed without modification. In that case, the name of deeper packages + * are displayed first. + * + * Here are a few more examples of the format modifier behaviour. + * + * <table cellpadding=10> + * <tr> + * <th>Conversion Pattern</th> + * <th>Class name</th> + * <th>Result</th> + * </tr> + * <tr> + * <td>%logger{10}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>m.s.s.Bar</td> + * </tr> + * <tr> + * <td>%logger{15}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>m.s.sample.Bar</td> + * </tr> + * <tr> + * <td>%logger{16}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>m.sub.sample.Bar</td> + * </tr> + * <tr> + * <td>%logger{26}</td> + * <td>mainPackage.sub.sample.Bar</td> + * <td>mainPackage.sub.sample.Bar</td> + * </tr> + * </table> + * + * + */ public class PatternLayout extends PatternLayoutBase implements ClassicLayout { // FIXME fix exception handling

1 0

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

14 Sep '06

Author: seb Date: Thu Sep 14 12:07:30 2006 New Revision: 584 Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SocketAppenderTest.java Log: - Back to a version with MockServer 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 Thu Sep 14 12:07:30 2006 @@ -1,10 +1,5 @@ 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; @@ -18,25 +13,8 @@ public class SocketAppenderTest extends TestCase { - ByteArrayOutputStream bos; - ObjectInputStream inputStream; - SocketAppender appender; - Logger logger; - - LoggerContext lc; - - 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); - } + private LoggerContext lc; + private MockSocketServer mockSocketServer; public void testStartFailNoRemoteHost() { lc = new LoggerContext(); @@ -47,40 +25,38 @@ 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(); + 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()); - assertEquals("test message", remoteEvent.getMessage()); + LoggingEvent remoteEvent = mockSocketServer.loggingEventList.get(0); + assertEquals("test msg", remoteEvent.getMessage()); assertEquals(Level.DEBUG, remoteEvent.getLevel()); } - public void testRecieveWithContext() throws InterruptedException, IOException, ClassNotFoundException { + 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()); - //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(); + LoggingEvent remoteEvent = mockSocketServer.loggingEventList.get(0); LoggerRemoteView loggerRemoteView = remoteEvent.getLoggerRemoteView(); assertNotNull(loggerRemoteView); @@ -94,53 +70,69 @@ 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); + public void testMessageWithMDC() throws InterruptedException { + startServer(1); + configureClient(); + + Logger logger = lc.getLogger(LoggerContext.ROOT_NAME); MDC.put("key", "testValue"); - LoggingEvent event = createLoggingEvent(); - appender.append(event); + 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()); - //create the input stream based on the ouput stream - ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray()); - inputStream = new ObjectInputStream(bis); - - LoggingEvent remoteEvent = (LoggingEvent) inputStream.readObject(); - + LoggingEvent remoteEvent = mockSocketServer.loggingEventList.get(0); 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); + public void testMessageWithUpdatedMDC() throws InterruptedException { + startServer(2); + configureClient(); + + Logger logger = lc.getLogger(LoggerContext.ROOT_NAME); MDC.put("key", "testValue"); - LoggingEvent event = createLoggingEvent(); - appender.append(event); + logger.debug("test msg"); MDC.put("key", "updatedTestValue"); - event = createLoggingEvent(); - appender.append(event); + logger.debug("test msg 2"); - //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(); + // 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 LoggingEvent createLoggingEvent() { - LoggingEvent le = new LoggingEvent(this.getClass().getName(), logger, - Level.DEBUG, "test message", null, null); - return le; + 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: r583 - logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net
by noreply.seb＠qos.ch 14 Sep '06

14 Sep '06

Author: seb Date: Thu Sep 14 11:30:28 2006 New Revision: 583 Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SocketAppenderTest.java Log: minor fix 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 Thu Sep 14 11:30:28 2006 @@ -24,7 +24,6 @@ Logger logger; LoggerContext lc; - MockSocketServer mockSocketServer; public void setUp() throws Exception { lc = new LoggerContext();

1 0