- logback-dev - mailman3.qos.ch

svn commit: r1437 - logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic
by noreply.ceki＠qos.ch 16 Mar '07

16 Mar '07

Author: ceki Date: Fri Mar 16 21:35:05 2007 New Revision: 1437 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java Log: - ch.qos.logback.classic.Logger now implements org.slf4j.spi.LocationAwareLogger interface Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java Fri Mar 16 21:35:05 2007 @@ -17,6 +17,7 @@ import java.util.List; import org.slf4j.Marker; +import org.slf4j.spi.LocationAwareLogger; import ch.qos.logback.classic.spi.LoggerRemoteView; import ch.qos.logback.classic.spi.LoggingEvent; @@ -25,7 +26,7 @@ import ch.qos.logback.core.spi.AppenderAttachableImpl; import ch.qos.logback.core.spi.FilterReply; -public final class Logger implements org.slf4j.Logger, +public final class Logger implements org.slf4j.Logger, LocationAwareLogger, AppenderAttachable<LoggingEvent>, Serializable { /** @@ -251,7 +252,7 @@ /** * Invoke all the appenders of this logger. - * + * * @param event * The event to log */ @@ -373,7 +374,7 @@ filterAndLog(FQCN, null, Level.DEBUG, msg, null, null); } - public void debug(String format, Object arg) { + public final void debug(String format, Object arg) { filterAndLog(FQCN, null, Level.DEBUG, format, arg, null); } @@ -406,7 +407,7 @@ final FilterReply decision = loggerContext.getTurboFilterChainDecision( marker, this, Level.DEBUG, msg, param, t); - + if (decision == FilterReply.NEUTRAL) { if (effectiveLevelInt > level.levelInt) { return; @@ -475,7 +476,7 @@ } public void debug(Marker marker, String format, Object arg1, Object arg2) { - filterAndLog(FQCN, marker, Level.DEBUG, format, arg1, arg2 , null); + filterAndLog(FQCN, marker, Level.DEBUG, format, arg1, arg2, null); } public void debug(Marker marker, String format, Object[] argArray) { @@ -515,11 +516,11 @@ } public void error(Marker marker, String format, Object arg1, Object arg2) { - filterAndLog(FQCN, marker, Level.ERROR, format, arg1, arg2, null); + filterAndLog(FQCN, marker, Level.ERROR, format, arg1, arg2, null); } public void error(Marker marker, String format, Object[] argArray) { - filterAndLog(FQCN, marker, Level.ERROR, format, argArray, null); + filterAndLog(FQCN, marker, Level.ERROR, format, argArray, null); } public void error(Marker marker, String msg, Throwable t) { @@ -551,7 +552,7 @@ } public void info(Marker marker, String format, Object arg) { - filterAndLog(FQCN, marker, Level.INFO, format, arg , null); + filterAndLog(FQCN, marker, Level.INFO, format, arg, null); } public void info(Marker marker, String format, Object arg1, Object arg2) { @@ -563,7 +564,21 @@ } public void info(Marker marker, String msg, Throwable t) { - filterAndLog(FQCN, marker, Level.INFO, msg, null, t); + filterAndLog(FQCN, marker, Level.INFO, msg, null, t); + } + + public final boolean isDebugEnabled(Marker o1, String o2, Object o3, + Throwable o4, Object o5) { + final FilterReply decision = callTurboFilters(Level.DEBUG); + if (decision == FilterReply.NEUTRAL) { + return effectiveLevelInt <= Level.DEBUG_INT; + } else if (decision == FilterReply.DENY) { + return false; + } else if (decision == FilterReply.ACCEPT) { + return true; + } else { + throw new IllegalStateException("Unknown FilterReply value: " + decision); + } } public final boolean isDebugEnabled() { @@ -572,7 +587,7 @@ return effectiveLevelInt <= Level.DEBUG_INT; } else if (decision == FilterReply.DENY) { return false; - } else if (decision == FilterReply.ACCEPT){ + } else if (decision == FilterReply.ACCEPT) { return true; } else { throw new IllegalStateException("Unknown FilterReply value: " + decision); @@ -589,7 +604,7 @@ return effectiveLevelInt <= Level.DEBUG_INT; } else if (decision == FilterReply.DENY) { return false; - } else if (decision == FilterReply.ACCEPT){ + } else if (decision == FilterReply.ACCEPT) { return true; } else { throw new IllegalStateException("Unknown FilterReply value: " + decision); @@ -606,7 +621,7 @@ return effectiveLevelInt <= Level.DEBUG_INT; } else if (decision == FilterReply.DENY) { return false; - } else if (decision == FilterReply.ACCEPT){ + } else if (decision == FilterReply.ACCEPT) { return true; } else { throw new IllegalStateException("Unknown FilterReply value: " + decision); @@ -623,7 +638,7 @@ return effectiveLevelInt <= Level.DEBUG_INT; } else if (decision == FilterReply.DENY) { return false; - } else if (decision == FilterReply.ACCEPT){ + } else if (decision == FilterReply.ACCEPT) { return true; } else { throw new IllegalStateException("Unknown FilterReply value: " + decision); @@ -640,7 +655,7 @@ return effectiveLevelInt <= Level.DEBUG_INT; } else if (decision == FilterReply.DENY) { return false; - } else if (decision == FilterReply.ACCEPT){ + } else if (decision == FilterReply.ACCEPT) { return true; } else { throw new IllegalStateException("Unknown FilterReply value: " + decision); @@ -698,22 +713,21 @@ public String toString() { return "Logger[" + name + "]"; } - + /** - * Method that calls the attached TurboFilter - * objects based on the logger and the level. + * Method that calls the attached TurboFilter objects based on the logger and + * the level. * * It is used by isYYYEnabled() methods. * - * It returns the typical FilterReply values: - * ACCEPT, NEUTRAL or DENY. + * It returns the typical FilterReply values: ACCEPT, NEUTRAL or DENY. * * @param level * @return the reply given by the TurboFilters */ private FilterReply callTurboFilters(Level level) { - return loggerContext.getTurboFilterChainDecision( - null, this, level, null, null, null); + return loggerContext.getTurboFilterChainDecision(null, this, level, null, + null, null); } /** @@ -732,4 +746,27 @@ void buildRemoteView() { this.loggerRemoteView = new LoggerRemoteView(name, loggerContext); } + + public void log(Marker marker, String fqcn, int levelInt, String message, + Throwable t) { + Level level = null; + switch (levelInt) { + case LocationAwareLogger.DEBUG_INT: + level = Level.DEBUG; + break; + case LocationAwareLogger.INFO_INT: + level = Level.INFO; + break; + case LocationAwareLogger.WARN_INT: + level = Level.WARN; + break; + case LocationAwareLogger.ERROR_INT: + level = Level.ERROR; + break; + default: + throw new IllegalArgumentException(levelInt + + " not a valid level integet"); + } + filterAndLog(fqcn, marker, level, message, null, t); + } }

1 0

svn commit: r1436 - logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views
by noreply.seb＠qos.ch 15 Mar '07

15 Mar '07

Author: seb Date: Thu Mar 15 16:56:57 2007 New Revision: 1436 Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java Log: unused System.out call Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java Thu Mar 15 16:56:57 2007 @@ -43,8 +43,6 @@ } public void open() { - System.out.println("Link to: " + className + "/" + method + " line: " + lineNumber); - IProject[] projects = ResourcesPlugin.getWorkspace().getRoot().getProjects(); IType type;

1 0

svn commit: r1435 - logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views
by noreply.seb＠qos.ch 15 Mar '07

15 Mar '07

Author: seb Date: Thu Mar 15 16:42:58 2007 New Revision: 1435 Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java Log: Bug fix: opening an editor by clicking a link now works even with multiple projects opened Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java Thu Mar 15 16:42:58 2007 @@ -1,5 +1,7 @@ package ch.qos.logback.eclipse.views; +import java.io.File; + import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.ResourcesPlugin; @@ -58,8 +60,10 @@ if (path.startsWith("/" + project.getName())) { path = path.substring(project.getName().length() + 1); } - System.out.println(path); - openInEditor(project.getFile(path)); + IFile file = project.getFile(path); + if (file.exists()) { + openInEditor(file); + } } } catch (JavaModelException e) { e.printStackTrace();

1 0

svn commit: r1434 - in logbackPDE/trunk/plugins/ConsolePlugin: . META-INF src/main/java/ch/qos/logback/eclipse/views
by noreply.seb＠qos.ch 15 Mar '07

15 Mar '07

Author: seb Date: Thu Mar 15 15:51:07 2007 New Revision: 1434 Removed: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/MyHyperlinkPresenter.java Modified: logbackPDE/trunk/plugins/ConsolePlugin/META-INF/MANIFEST.MF logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackView.java logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackViewerConfiguration.java logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LoggingEventContentProvider.java logbackPDE/trunk/plugins/ConsolePlugin/todo.txt Log: The plugin detects links and can now open an editor to display the clicked java class. It is not able to display a specific line yet. Modified: logbackPDE/trunk/plugins/ConsolePlugin/META-INF/MANIFEST.MF ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/META-INF/MANIFEST.MF (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/META-INF/MANIFEST.MF Thu Mar 15 15:51:07 2007 @@ -15,11 +15,9 @@ org.eclipse.core.runtime, org.eclipse.jface.text, org.eclipse.ui.console, - org.eclipse.jdt, org.eclipse.jdt.core, - org.eclipse.jdt.core.manipulation, - org.eclipse.jdt.source, org.eclipse.jdt.ui, - org.eclipse.core.resources + org.eclipse.core.resources, + org.eclipse.ui.ide Eclipse-LazyStart: true Export-Package: ch.qos.logback.eclipse.views Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/JavaFileHyperLink.java Thu Mar 15 15:51:07 2007 @@ -1,7 +1,18 @@ package ch.qos.logback.eclipse.views; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.jdt.core.IType; +import org.eclipse.jdt.core.JavaModelException; +import org.eclipse.jdt.internal.core.JavaProject; +import org.eclipse.jdt.internal.corext.util.JavaModelUtil; import org.eclipse.jface.text.IRegion; import org.eclipse.jface.text.hyperlink.IHyperlink; +import org.eclipse.ui.IWorkbenchPage; +import org.eclipse.ui.PartInitException; +import org.eclipse.ui.ide.IDE; +import org.eclipse.ui.internal.Workbench; class JavaFileHyperLink implements IHyperlink { @@ -9,7 +20,7 @@ private String method; private int lineNumber; private IRegion region; - + public JavaFileHyperLink(String className, String method, int lineNumber, IRegion region) { this.lineNumber = lineNumber; this.region = region; @@ -31,5 +42,38 @@ public void open() { System.out.println("Link to: " + className + "/" + method + " line: " + lineNumber); + + IProject[] projects = ResourcesPlugin.getWorkspace().getRoot().getProjects(); + + IType type; + IProject project; + for (int i = 0; i < projects.length; i++) { + project = projects[i]; + if (project.isOpen()) { + try { + JavaProject javaProject = new JavaProject(project, null); + type = JavaModelUtil.findType(javaProject, className); + if (type != null) { + String path = type.getPath().toString(); + if (path.startsWith("/" + project.getName())) { + path = path.substring(project.getName().length() + 1); + } + System.out.println(path); + openInEditor(project.getFile(path)); + } + } catch (JavaModelException e) { + e.printStackTrace(); + } + } + } + } + + private void openInEditor(IFile file) { + IWorkbenchPage page = Workbench.getInstance().getActiveWorkbenchWindow().getActivePage(); + try { + IDE.openEditor(page, file); + } catch (PartInitException e) { + e.printStackTrace(); + } } } Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackView.java ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackView.java (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackView.java Thu Mar 15 15:51:07 2007 @@ -55,15 +55,13 @@ public void createPartControl(Composite parent) { - myConsole = new MessageConsole("Logback Console", null); + myConsole = new MessageConsole("Logback console", null); myConsole.setWaterMarks(LOW_WATERMARK, DEFAULT_HIGH_WATERMARK); viewer = new TextConsoleViewer(parent, myConsole); viewer.setEditable(false); viewer.configure(new LogbackViewerConfiguration()); - viewer.setDocument(viewer.getDocument()); - provider = new LoggingEventContentProvider(myConsole, viewer); Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackViewerConfiguration.java ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackViewerConfiguration.java (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LogbackViewerConfiguration.java Thu Mar 15 15:51:07 2007 @@ -1,39 +1,20 @@ package ch.qos.logback.eclipse.views; -import org.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter; import org.eclipse.jface.text.hyperlink.IHyperlinkDetector; -import org.eclipse.jface.text.hyperlink.IHyperlinkPresenter; import org.eclipse.jface.text.hyperlink.URLHyperlinkDetector; -import org.eclipse.jface.text.presentation.IPresentationReconciler; -import org.eclipse.jface.text.presentation.PresentationReconciler; import org.eclipse.jface.text.source.ISourceViewer; import org.eclipse.jface.text.source.SourceViewerConfiguration; import org.eclipse.swt.SWT; -import org.eclipse.swt.graphics.RGB; public class LogbackViewerConfiguration extends SourceViewerConfiguration { - PresentationReconciler recon = new PresentationReconciler(); - DefaultHyperlinkPresenter pres = new DefaultHyperlinkPresenter(new RGB(0, 0, 255)); - @Override public IHyperlinkDetector[] getHyperlinkDetectors(ISourceViewer sourceViewer) { return new IHyperlinkDetector[] { new URLHyperlinkDetector(), new JavaLinkDetector() }; } @Override - public IHyperlinkPresenter getHyperlinkPresenter(ISourceViewer sourceViewer) { - return pres; - } - - @Override public int getHyperlinkStateMask(ISourceViewer sourceViewer) { return SWT.NONE; } - - @Override - public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) { - return recon; - } - } Modified: logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LoggingEventContentProvider.java ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LoggingEventContentProvider.java (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/src/main/java/ch/qos/logback/eclipse/views/LoggingEventContentProvider.java Thu Mar 15 15:51:07 2007 @@ -29,19 +29,16 @@ private MessageConsoleStream redStream; private MessageConsoleStream blackStream; private TextConsoleViewer viewer; - //private MessageConsole console; private Color cachedRed; private Color cachedBlack; private LabelProvider labelProvider; - public LoggingEventContentProvider(MessageConsole console, TextConsoleViewer viewer) { Display display = Display.getCurrent(); cachedRed = new Color(display, 255, 0, 0); cachedBlack = new Color(display, 0, 0, 0); this.viewer = viewer; - //this.console = console; redStream = console.newMessageStream(); redStream.setColor(cachedRed); @@ -80,7 +77,7 @@ if (le == null) { return; } - + try { flushStreams(); @@ -89,7 +86,7 @@ } catch (Exception e) { PluginLogger.logError(e); } - + revealJob.schedule(50); } Modified: logbackPDE/trunk/plugins/ConsolePlugin/todo.txt ============================================================================== --- logbackPDE/trunk/plugins/ConsolePlugin/todo.txt (original) +++ logbackPDE/trunk/plugins/ConsolePlugin/todo.txt Thu Mar 15 15:51:07 2007 @@ -8,6 +8,8 @@ Color certains lines. Based on keywords and colors? +Click on a log line and display the java class that requested the log + DONE: Allow the user to change the socket's port Make the viewer always display the latest lines added

1 0

svn commit: r1433 - logback/trunk/logback-site/src/site/pages
by noreply.seb＠qos.ch 15 Mar '07

15 Mar '07

Author: seb Date: Thu Mar 15 15:15:45 2007 New Revision: 1433 Modified: logback/trunk/logback-site/src/site/pages/news.html Log: Mentionned the correction of bug 53 Modified: logback/trunk/logback-site/src/site/pages/news.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/news.html (original) +++ logback/trunk/logback-site/src/site/pages/news.html Thu Mar 15 15:15:45 2007 @@ -38,6 +38,12 @@ online manual for more information. </p> + <p> + Corrected bug 53 reported by Wilkins Poe. There is now a + <a href="dependencies.html">dependencies + page</a> that shows the requirements of each of logback's modules. + </p> + <h3>March 5th, 2007 - Release of version 0.9.2</h3>

1 0

[Bug 53] New: SMTPAppender fails without janino
by bugzilla-daemon＠pixie.qos.ch 15 Mar '07

15 Mar '07

http://bugzilla.qos.ch/show_bug.cgi?id=53 Summary: SMTPAppender fails without janino Product: logback-classic Version: unspecified Platform: Macintosh OS/Version: Mac OS Status: NEW Severity: normal Priority: P1 Component: Other AssignedTo: logback-dev(a)qos.ch ReportedBy: wilkinspoe(a)gmail.com Creating an SMTPAppender fails unless janino.jar is on the classpath, but janino is not mentioned in the documentation. Exception in thread "main" java.lang.NoClassDefFoundError: org/codehaus/janino/ExpressionEvaluator at ch.qos.logback.core.boolex.JaninoEventEvaluatorBase.start(JaninoEventEvaluatorBase.java:53) at ch.qos.logback.classic.net.SMTPAppender.start(SMTPAppender.java:55) at ch.qos.logback.core.joran.action.AppenderAction.end(AppenderAction.java:89) at ch.qos.logback.core.joran.spi.Interpreter.callEndAction(Interpreter.java:307) at ch.qos.logback.core.joran.spi.Interpreter.endElement(Interpreter.java:170) at ch.qos.logback.core.joran.spi.Interpreter.endElement(Interpreter.java:151) at ch.qos.logback.core.joran.spi.EventPlayer.play(EventPlayer.java:43) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:98) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:74) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:38) at ch.qos.logback.classic.util.ContextInitializer.configureByResource(ContextInitializer.java:24) at ch.qos.logback.classic.util.ContextInitializer.autoConfig(ContextInitializer.java:35) at ch.qos.logback.classic.util.ContextInitializer.autoConfig(ContextInitializer.java:46) at org.slf4j.impl.StaticLoggerBinder.initialize(StaticLoggerBinder.java:52) at org.slf4j.impl.StaticLoggerBinder.<init>(StaticLoggerBinder.java:44) at org.slf4j.impl.StaticLoggerBinder.<clinit>(StaticLoggerBinder.java:39) at org.slf4j.LoggerFactory.<clinit>(LoggerFactory.java:57) at logbacktest.Main.main(Main.java:37) Java Result: 1 -- Configure bugmail: http://bugzilla.qos.ch/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the assignee for the bug, or are watching the assignee.

1 1

svn commit: r1432 - logback/trunk/logback-site/src/site/pages/manual
by noreply.seb＠qos.ch 15 Mar '07

15 Mar '07

Author: seb Date: Thu Mar 15 15:13:17 2007 New Revision: 1432 Modified: logback/trunk/logback-site/src/site/pages/manual/appenders.html Log: Modified SMTPAppender's documentation Modified: logback/trunk/logback-site/src/site/pages/manual/appenders.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/appenders.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/appenders.html Thu Mar 15 15:13:17 2007 @@ -2020,6 +2020,10 @@ <code>SMTPAppender</code> is assigned a default event evaluator which triggers email transmission as a response to any event of level <em>ERROR</em> or higher. </p> + <p><code>EventEvaluator</code> objects are subclasses of the <code>JaninoEventEvaluatorBase</code> + which depends on Janino. See the <a href="../dependencies.html">dependencies page</a> + for more information. + </p> </td> </tr> </table>

1 0

svn commit: r1431 - in logback/trunk/logback-site/src/site/pages: . manual
by noreply.seb＠qos.ch 15 Mar '07

15 Mar '07

Author: seb Date: Thu Mar 15 14:56:53 2007 New Revision: 1431 Modified: logback/trunk/logback-site/src/site/pages/manual/joran.html logback/trunk/logback-site/src/site/pages/news.html Log: Updated documentation Modified: logback/trunk/logback-site/src/site/pages/manual/joran.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/joran.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/joran.html Thu Mar 15 14:56:53 2007 @@ -931,6 +931,54 @@ </root> </configuration></pre></div> +<a name="Include"></a> +<h3>File inclusion</h3> + +<p> +It is possible to include configuration elements into a <em>logback.xml</em> +configuration file. This is done by using a <em>include</em> element, as shown +in the example below: +</p> + +<em>Example 3.18: File include (logback-examples/src/main/java/chapter3/redirectConfig.xml)</em> +<div class="source"><pre><configuration> + + <include file="path/to/included/configuration/file" /> + +</configuration></pre></div> + +<p> +The target file must have its elements nested inside an <em>included</em> +element. For example, a <code>ConsoleAppender</code> would be declared this way: +</p> + +<em>Example 3.18: File include (logback-examples/src/main/java/chapter3/includedConfig.xml)</em> +<div class="source"><pre><included> + + <appender name="redirectConsole" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="Pattern" value="%d - %m%n" /> + </layout> + </appender> + + <root> + <level value="DEBUG" /> + <appender-ref ref="redirectConsole" /> + </root> + +</included></pre></div> + +<p> +It is also possible to specify the file to be included by using a +variable, in any of the ways explained above in this chapter. +</p> + +<p> +Included a file by specifying an <code>URL</code> is also possible. Instead of +using the <em>file</em> attribute, add a <em>url</em> attribute to the +<em>include</em> element. +</p> <a name="Joran"></a> <h2>Using Joran in your own application</h2> @@ -1168,7 +1216,7 @@ <p>The <em>calculator2.xml</em> file is a bit more complex, but much more interesting.</p> <p>It contains the following elements:</p> -<em>Example 3.18: Calculator configuration file (logback-examples/src/main/java/chapter3/calculator/calculator2.xml)</em> +<em>Example 3.19: Calculator configuration file (logback-examples/src/main/java/chapter3/calculator/calculator2.xml)</em> <div class="source"><pre><computation name="toto"> <literal value="7"/> <literal value="3"/> @@ -1194,7 +1242,7 @@ elements that contain instances of the same element. Here's the content of <em>calculator3.xml</em>:</p> -<em>Example 3.19: Calculator configuration file (logback-examples/src/main/java/chapter3/calculator/calculator3.xml)</em> +<em>Example 3.20: Calculator configuration file (logback-examples/src/main/java/chapter3/calculator/calculator3.xml)</em> <div class="source"><pre><computation name="toto"> <computation> <literal value="7"/> @@ -1242,7 +1290,7 @@ <p>Using new rule declarations, the preceding example, involving the calculation, could be expressed this way:</p> -<em>Example 3.20: Configuration file using new rules on the fly (logback-examples/src/main/java/chapter3/newrule/new-rule.xml)</em> +<em>Example 3.21: Configuration file using new rules on the fly (logback-examples/src/main/java/chapter3/newrule/new-rule.xml)</em> <div class="source"><pre><computation name="toto"> <new-rule pattern="*/computation/literal" actionClass="chapter3.calculator.LiteralAction"/> @@ -1342,7 +1390,7 @@ <p>The <em>implicit1.xml</em> file contains the following lines:</p> -<em>Example 3.21: Usage of implicit rules (logback-examples/src/main/java/chapter3/implicit/implicit1.xml)</em> +<em>Example 3.22: Usage of implicit rules (logback-examples/src/main/java/chapter3/implicit/implicit1.xml)</em> <div class="source"><pre><foo> <xyz printme="true"> Modified: logback/trunk/logback-site/src/site/pages/news.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/news.html (original) +++ logback/trunk/logback-site/src/site/pages/news.html Thu Mar 15 14:56:53 2007 @@ -28,6 +28,17 @@ <hr width="80%" align="center" /> + <h3>MMMM Dth, 2007 - Release of version 0.9.Y</h3> + + <p> + Includes in configuration files are now supported by Joran, logback's + configuration framework. A file can contain an <em>include</em> element + that has a <em>file</em> or <em>url</em> attribute pointing to a configuration file. + See the <a href="manual/joran.html#Include">chapter about configuration</a> in the logback's + online manual for more information. + </p> + + <h3>March 5th, 2007 - Release of version 0.9.2</h3> <p>The documentation is now in the <em>docs/</em> directory to allow an

1 0

svn commit: r1430 - in logback/trunk: logback-classic/src/main/java/ch/qos/logback/classic/joran/action logback-classic/src/test/input/joran logback-classic/src/test/java/ch/qos/logback/classic/joran logback-examples/src/main/java/chapter3
by noreply.seb＠qos.ch 15 Mar '07

15 Mar '07

Author: seb Date: Thu Mar 15 14:56:44 2007 New Revision: 1430 Added: logback/trunk/logback-classic/src/test/input/joran/redirectToFile.xml logback/trunk/logback-classic/src/test/input/joran/redirectToUrl.xml logback/trunk/logback-examples/src/main/java/chapter3/includedConfig.xml logback/trunk/logback-examples/src/main/java/chapter3/redirectConfig.xml Removed: logback/trunk/logback-classic/src/test/input/joran/redirectToInvalid.xml logback/trunk/logback-classic/src/test/input/joran/redirectWithSubst.xml Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/IncludeFileAction.java logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/joran/IncludeFileActionTest.java Log: Added url attribute to include element Modified tests Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/IncludeFileAction.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/IncludeFileAction.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/IncludeFileAction.java Thu Mar 15 14:56:44 2007 @@ -12,6 +12,8 @@ import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; +import java.net.MalformedURLException; +import java.net.URL; import org.xml.sax.Attributes; @@ -26,56 +28,102 @@ private static final String INCLUDED_TAG = "included"; private static final String FILE_ATTR = "file"; - private SaxEventRecorder recorder; - + private static final String URL_ATTR = "url"; + private SaxEventRecorder recorder = new SaxEventRecorder();; + @Override public void begin(InterpretationContext ec, String name, Attributes attributes) throws ActionException { - String attribute = attributes.getValue(FILE_ATTR); - if (attribute == null) { - addError("Path to configuration file to include is not set."); + String attFile = attributes.getValue(FILE_ATTR); + String attUrl = attributes.getValue(URL_ATTR); + // if both are null, report error and do nothing. + if (attFile == null && attUrl == null) { + addError("One of path and URL attribute must be set."); return; } - - String pathToFile; - - if (attribute.startsWith("$")) { - pathToFile = ec.subst(attribute); - } else { - pathToFile = attribute; + + String pathToFile = null; + if (attFile != null) { + if (attFile.startsWith("$")) { + pathToFile = ec.subst(attFile); + } else { + pathToFile = attFile; + } + } + + URL urlToFile = null; + String tmpUrl; + if (attUrl != null) { + if (attUrl.startsWith("$")) { + tmpUrl = ec.subst(attUrl); + } else { + tmpUrl = attUrl; + } + try { + urlToFile = new URL(tmpUrl); + } catch (MalformedURLException mue) { + String errMsg = "URL [" + tmpUrl + "] is not well formed."; + addError(errMsg, mue); + return; + } } + // we know now that either pathToFile or urlToFile + // is not null and correctly formed (in case of urlToFile). + try { - InputStream in = new FileInputStream(pathToFile); - parseAndRecord(in); - in.close(); - } catch (IOException ioe) { - String errMsg = "File [" + pathToFile + "] does not exist."; - addError(errMsg, ioe); + InputStream in = getInputStream(pathToFile, urlToFile); + if (in != null) { + parseAndRecord(in); + in.close(); + } } catch (JoranException e) { addError("Error while parsing file " + pathToFile + e); + } catch (IOException e) { + // called if in.close did not work } - + if (recorder.saxEventList.size() == 0) { return; } - + + //Let's remove the two <included> events before + //adding the events to the player. SaxEvent first = recorder.saxEventList.get(0); if (first != null && first.qName.equalsIgnoreCase(INCLUDED_TAG)) { recorder.saxEventList.remove(0); } - SaxEvent last = recorder.saxEventList.get(recorder.saxEventList.size()-1); + SaxEvent last = recorder.saxEventList.get(recorder.saxEventList.size() - 1); if (last != null && last.qName.equalsIgnoreCase(INCLUDED_TAG)) { - recorder.saxEventList.remove(recorder.saxEventList.size()-1); + recorder.saxEventList.remove(recorder.saxEventList.size() - 1); } - + ec.getJoranInterpreter().addEvents(recorder.saxEventList); } - + + private InputStream getInputStream(String pathToFile, URL urlToFile) { + if (pathToFile != null) { + try { + return new FileInputStream(pathToFile); + } catch (IOException ioe) { + String errMsg = "File [" + pathToFile + "] does not exist."; + addError(errMsg, ioe); + return null; + } + } else { + try { + return urlToFile.openStream(); + } catch (IOException e) { + String errMsg = "URL [" + urlToFile.toString() + "] does not exist."; + addError(errMsg, e); + return null; + } + } + } + private void parseAndRecord(InputStream inputSource) throws JoranException { - recorder = new SaxEventRecorder(); recorder.setContext(context); recorder.recordEvents(inputSource); } Added: logback/trunk/logback-classic/src/test/input/joran/redirectToFile.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/src/test/input/joran/redirectToFile.xml Thu Mar 15 14:56:44 2007 @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE configuration> + +<configuration> + + <include file="${testing.value.file}" /> + +</configuration> Added: logback/trunk/logback-classic/src/test/input/joran/redirectToUrl.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/src/test/input/joran/redirectToUrl.xml Thu Mar 15 14:56:44 2007 @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE configuration> + +<configuration> + + <include url="${testing.value.url}" /> + +</configuration> Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/joran/IncludeFileActionTest.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/joran/IncludeFileActionTest.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/joran/IncludeFileActionTest.java Thu Mar 15 14:56:44 2007 @@ -10,20 +10,23 @@ import ch.qos.logback.core.ConsoleAppender; import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.status.Status; +import ch.qos.logback.core.util.StatusPrinter; public class IncludeFileActionTest extends TestCase { LoggerContext context; IncludeFileAction action; - String filePath = Constants.TEST_DIR_PREFIX - + "input/joran/redirectConfig.xml"; - String invalidRedirect = Constants.TEST_DIR_PREFIX - + "input/joran/invalidRedirect.xml"; - String filePathWithSubst = Constants.TEST_DIR_PREFIX - + "input/joran/redirectWithSubst.xml"; - String redirectToInvalid = Constants.TEST_DIR_PREFIX - + "input/joran/redirectToInvalid.xml"; + String redirectToFile = Constants.TEST_DIR_PREFIX + + "input/joran/redirectToFile.xml"; + String redirectToURL = Constants.TEST_DIR_PREFIX + + "input/joran/redirectToUrl.xml"; + + String urlConfig = "http://logback.qos.ch/simpleConfig.xml"; + String simpleConfig = Constants.TEST_DIR_PREFIX + + "input/joran/simpleConfig.xml"; + String invalidConfig = Constants.TEST_DIR_PREFIX + + "input/joran/invalidConfig.xml"; @Override protected void setUp() throws Exception { @@ -41,37 +44,63 @@ } public void testLoadFileOK() throws JoranException { + System.setProperty("testing.value.file", simpleConfig); JoranConfigurator jc = new JoranConfigurator(); jc.setContext(context); - jc.doConfigure(filePath); + jc.doConfigure(redirectToFile); verifyConfig(); } public void testNoFileFound() throws JoranException { + System.setProperty("testing.value.file", "toto"); JoranConfigurator jc = new JoranConfigurator(); jc.setContext(context); - jc.doConfigure(invalidRedirect); + jc.doConfigure(redirectToFile); - assertEquals(3, context.getStatusManager().getCount()); + assertEquals(2, context.getStatusManager().getCount()); assertEquals(Status.ERROR, context.getStatusManager().getLevel()); } public void testWithCorruptFile() throws JoranException { + System.setProperty("testing.value.file", invalidConfig); JoranConfigurator jc = new JoranConfigurator(); jc.setContext(context); - jc.doConfigure(redirectToInvalid); + jc.doConfigure(redirectToFile); assertEquals(10, context.getStatusManager().getCount()); assertEquals(Status.ERROR, context.getStatusManager().getLevel()); } - public void testWithSubst() throws JoranException { +// public void testURLOK() throws JoranException { +// //This one needs that we put a file on the web +// //and requires a net connection on the test-runner's side. +// System.setProperty("testing.value.url", urlConfig); +// JoranConfigurator jc = new JoranConfigurator(); +// jc.setContext(context); +// jc.doConfigure(redirectToURL); +// +// verifyConfig(); +// } + + public void testMalformedURL() throws JoranException { + System.setProperty("testing.value.url", "htp://logback.qos.ch"); JoranConfigurator jc = new JoranConfigurator(); jc.setContext(context); - jc.doConfigure(filePathWithSubst); + jc.doConfigure(redirectToURL); - verifyConfig(); + assertEquals(2, context.getStatusManager().getCount()); + assertEquals(Status.ERROR, context.getStatusManager().getLevel()); + } + + public void testUnknownURL() throws JoranException { + System.setProperty("testing.value.url", "http://logback2345.qos.ch"); + JoranConfigurator jc = new JoranConfigurator(); + jc.setContext(context); + jc.doConfigure(redirectToURL); + + assertEquals(2, context.getStatusManager().getCount()); + assertEquals(Status.ERROR, context.getStatusManager().getLevel()); } private void verifyConfig() { Added: logback/trunk/logback-examples/src/main/java/chapter3/includedConfig.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter3/includedConfig.xml Thu Mar 15 14:56:44 2007 @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<included> + + <appender name="redirectConsole" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <param name="Pattern" value="%d - %m%n" /> + </layout> + </appender> + + <root> + <level value="DEBUG" /> + <appender-ref ref="redirectConsole" /> + </root> + +</included> \ No newline at end of file Added: logback/trunk/logback-examples/src/main/java/chapter3/redirectConfig.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter3/redirectConfig.xml Thu Mar 15 14:56:44 2007 @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<configuration> + + <include file="path/to/included/configuration/file" /> + +</configuration>

1 0

svn commit: r1429 - logback/trunk/logback-site/src/site/pages/manual
by noreply.ceki＠qos.ch 14 Mar '07

14 Mar '07

Author: ceki Date: Wed Mar 14 22:32:01 2007 New Revision: 1429 Modified: logback/trunk/logback-site/src/site/pages/manual/layouts.html Log: improved text, ongoing work Modified: logback/trunk/logback-site/src/site/pages/manual/layouts.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/layouts.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/layouts.html Wed Mar 14 22:32:01 2007 @@ -22,6 +22,14 @@ <h1>Chapter 5: Layouts</h1> + <div class="quote"> + <p>TCP implementations will follow a general principle of + robustness: be conservative in what you do, be liberal in what + you accept from others. + </p> + <p>-- JON POSTEL, RFC 793</p> + </div> + <script src="../templates/creative.js"></script> <div class="highlight"> @@ -935,23 +943,26 @@ </tr> </table> - <p>Here are some examples of the format modifier truncation:</p> + <p>The table below list examples for format modifier + truncation. Please note that the brackets, i.e the pair of "[]" + characters, are not part of the output. They are used to delimit + the width of output.</p> <table class="bodyTable" BORDER="0" CELLPADDING="8"> <th>Format modifier</th> <th>Logger name</th> - <th>Result</th> - <tr class="a"> - <td align="center">[%-20.20logger]</td> - <td align="center">main.Name</td> - <td align="center"><pre>[main.Name ]</pre></td> - </tr> + <th>Result</th> <tr class="b"> <td align="center">[%20.20logger]</td> <td align="center">main.Name</td> <td align="center"><pre>[ main.Name]</pre></td> </tr> + <tr class="a"> + <td align="center">[%-20.20logger]</td> + <td align="center">main.Name</td> + <td align="center"><pre>[main.Name ]</pre></td> + </tr> <tr class="a"> <td align="center">[%10.10logger]</td> <td align="center">main.foo.foo.bar.Name</td> @@ -964,18 +975,20 @@ </tr> </table> - <h3>Option handling</h3> + <h3>Options</h3> <p> - A conversion specifier can be followed by options between - braces. We have already seen some of the - possibilities offered by logback's option handling with, for - example, the MDC conversion specifier: + A conversion specifier can be followed by options. The are + always declared between braces. We have already seen some of the + possibilities offered by options, for instance in conjunction + with the MDC conversion specifier, as in: <em>%mdc{someKey}</em>. </p> - <p>A conversion specifier might have more than one options. For example, - a conversion specifier that uses evaluators, which we will cover very soon, - simply adds the evaluator names to the option list, as shown below:</p> + + <p>A conversion specifier might have more than one option. For + example, a conversion specifier that makes use of evaluators, + which will be covered soon, may add evaluator names to the option + list, as shown below:</p> <div class="source"><pre> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> @@ -986,43 +999,30 @@ </appender></pre></div> - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + <h3>Evaluators</h3> - <h4>Evaluators</h4> - <p> - Another use case for adding options to a conversion - specifier is when - <code>PatternLayout</code> - is used with - <a href="../xref/ch/qos/logback/core/boolex/EventEvaluator.html"> - <code>EventEvaluator</code></a> objects. - </p> - <p> - <code>EventEvaluator</code> objects - have the responsability to check wether a given event - matches a given criteria. - </p> - <p> - Let's look at an example using - <code>EventEvaluator</code> objects. - The following configuration file outputs the logging - events to the console, displaying date, thread, level, - message and caller data. - </p> - <p> - Since displaying the caller data of a logging event is rather - expensive, this information will be displayed only when the - logging request comes from a specific logger, and whose - message contains a certain string. By doing that, we make - sure that only the specific logging requests will have - their caller information generated and displayed, without - penalizing application performance. + <p>As mentioned above, option lists come in handy when a + conversion specifier is required to behave dynamically based on + one or more + <a href="../xref/ch/qos/logback/core/boolex/EventEvaluator.html"> + <code>EventEvaluator</code></a> objects. + <code>EventEvaluator</code> objects have the responsibility to + determine whether a given logging event matches the criteria of the + evaluator. + </p> + + <p>Let us review an example with <code>EventEvaluator</code> + objects. The following configuration file outputs the logging + events to the console, displaying date, thread, level, message and + caller data. Given that extracting the caller data of a logging + event is on expensive side, we will do so only when the logging + request originates from a specific logger, and whose message + contains a certain string. Thus, we make sure that only specific + logging requests will have their caller information generated and + displayed. In other cases, where the caller data is superfluous, + we will not penalize application performance. </p> - <p> - Here is how to configure logback to behave like we - described: - </p> <em> Example 5.2: Sample usage of EventEvaluators (logback-examples/src/main/java/chapter5/callerEvaluatorConfig.xml) @@ -1045,14 +1045,19 @@ <appender-ref ref="STDOUT" /> </root> </configuration></pre></div> - <p>Please note that the & value cannot be written like one would do in a java - class, because of XML encoding rules.</p> - <p>Let us test this configuration with the following code.</p> - <em> + + <p>Due to XML encoding rules, the & character cannot be + written as is, and needs to be escaped as &amp;.</p> + + <p>The above configuration file is designed to be accompanied by + the following custom-tailored code.</p> + + <p><em> Example 5.2: Sample usage of EventEvaluators <a href="../xref/chapter5/CallerEvaluatorExample.html"> (logback-examples/src/main/java/chapter5/CallerEvaluatorExample.java)</a> </em> + </p> <div class="source"><pre>package chapter5; import org.slf4j.Logger; @@ -1087,51 +1092,58 @@ } }</pre></div> <p> - The above application does nothing too fancy. Five logging - requests are issued, the third one being different from the - others. + The <em>CallerEvaluatorExample</em> application does nothing particularly + fancy. Five logging requests are issued, the third one being + different from the others. </p> <p> - When a logging request is sent, the corresponding logging event - will pass through the evaluation process. Here, the third - request will match the evaluation criteria, causing its caller - data to be displayed. + When a logging request is issued, the corresponding logging + event goes through the evaluation process. The third request + matches the evaluation criteria, causing its caller data to be + displayed. </p> + <p> Here is the output of the <code>CallerEvaluatorExample</code> class. </p> + <div class="source"><pre>0 [main] DEBUG - I know me 0 0 [main] DEBUG - I know me 1 0 [main] DEBUG - I know me 2 0 [main] DEBUG - who calls thee? Caller+0 at chapter5.CallerEvaluatorExample.main(CallerEvaluatorExample.java:28) - 0 [main] DEBUG - I know me 4</pre></div> - <p>One can change the expression to match a real world - situation. An expression testing logger name and request level - could also be meaningful: all logging requests of level - <em>WARN</em> and up, coming from a sensible part of an - application like a financial transaction module, would have their - caller data displayed. + <p>One can change the expression to correspond a real world + scenario. For instance, one could combine the logger name and + request level. Thus, logging requests of level <em>WARN</em> and + up, originating from a sensitive part of an application, e.g. a + financial transaction module, would have their caller data + displayed. </p> <p><b>Important:</b> With the <em>caller</em> conversion specifier, the data is displayed when <em>the expression evaluates to <b>true</b>.</em></p> - <p>Now, let us look at a different situation. When exceptions are + <p>Let us consider at a different situation. When exceptions are included in a logging request, their stack trace is usually displayed. However, in some cases, one might want to supress the - stack trace of specific exception. + stack trace of some specific exception. </p> - <p>The java code shown below creates five log requests, each one - with an exception. However, we do not want to have the stack trace - of the third request to be output.</p> + <p>The java code shown below creates five log requests, each with + an exception. However, it so happends that we do not wish the + stack trace of the third request to be output.</p> + <p><em> + Example 5.2: Sample usage of EventEvaluators + <a href="../xref/chapter5/ExceptionEvaluatorExample.html"> + (logback-examples/src/main/java/chapter5/ExceptionEvaluatorExample.java)</a> + </em> + </p> <div class="source"><pre>package chapter5; import org.slf4j.Logger; @@ -1166,7 +1178,8 @@ } }</pre></div> - <p>The following configuration will allow that.</p> + <p>The following configuration will supress the stack trace of the + third logging request.</p> <em> Example 5.3: Sample usage of EventEvaluators (logback-examples/src/main/java/chapter5/exceptionEvaluatorConfig.xml) @@ -1193,31 +1206,38 @@ </root> </configuration></pre></div> - <p> - With this configuration, each time an instance of the - <em>chapter5.TestException</em> - is included within a logging request, no stack trace will be displayed. + <p>With this configuration, each time an instance of the + <em>chapter5.TestException</em> is included within a logging + request, the stack trace will be suppressed. </p> - <p><b>Important:</b> With the <b><em>%ex</em></b> conversion specifier, the data is - displayed when <em>the expression evaluates to <b>false</b>.</em></p> + + <p><b>Important:</b> With the <b><em>%ex</em></b> conversion + specifier, the stack trace is displayed when <em>the expression + evaluates to <b>false</b>.</em></p> <h3>Creating a custom conversion specifier</h3> - <p>We've seen up to here quite a lot of possibilities with conversion specifier and - <code>PatternLayout</code> objects. But what if somebody wants to make her own conversion - specifier?</p> - - <p>In that case, two steps are needed.</p> - - <p>First, one must implement her own <code>Converter</code> - class. <a href="../xref/ch/qos/logback/core/pattern/Converter.html"> - <code>Converter</code></a> objects are responsible to extract a specific information out of - a <code>LoggingEvent</code>. When <em>%logger</em> is used, a - <a href="../xref/ch/qos/logback/classic/pattern/LoggerConverter.html"> - <code>LoggerConverter</code></a> - is called to extract the name of the logger from the <code>LoggingEvent</code>.</p> + + <p>Up to this point we have presented the built-inconversion + specifiers of <code>PatternLayout</code>. But it is also possible + to use a conversion specifier of your own making.</p> + + <p>Building a custom conversion specifier consists of two steps. + </p> - <p>Let us say that our customized <code>Converter</code> will output the level of the logging - event, colored following ANSI rules. Here is the necessary implementation:</p> + <p>First, you must sub-class the <code>Converter</code> class. <a + href="../xref/ch/qos/logback/core/pattern/Converter.html"> + <code>Converter</code></a> objects are responsible for extracting + information out of <code>LoggingEvent</code> objects and returning + it as String. For example, the + <a href="../xref/ch/qos/logback/classic/pattern/LoggerConverter.html"> + <code>LoggerConverter</code></a>, the converter underlying the + %logger conversion word, extracts the name of the logger from the + <code>LoggingEvent</code> and returns it as a String. It might + abbreviate the logger name in the process.</p> + + <p>Let us say that our customized <code>Converter</code> colors + the level of the logging event, according to ANSI terminal + conventions. Here is a possible implementation:</p> <em> Example 5.4: Sample Converter Example <a href="../xref/chapter5/MySampleConverter.html"> @@ -1261,14 +1281,19 @@ } </pre></div> - <p>This implementation is quite straightforward. The <code>MySampleConverter</code> class - extends <code>ClassicConverter</code>, and implements the <code>convert</code> method. - In that method, all it has to do is return the appropriate information. + +java chapter5.SampleLogging src/main/java/chapter5/mySampleConverterConfig.xml + + <p>This implementation is relatively straightforward. The + <code>MySampleConverter</code> class extends + <code>ClassicConverter</code>, and implements the + <code>convert</code> method where it returns a level string + decorated with ANSI coloring codes. </p> - <p>The second step, once the <code>Converter</code> class done, is to let logback know about - the new <code>Converter</code>. For this task, we just need to declare the new - conversion word in the configuration file, as shown below:</p> + <p>In the second step, we must let logback know about the new + <code>Converter</code>. For this purpose, we need to declare the + new conversion word in the configuration file, as shown below:</p> <em> Example 5.4: Sample Converter Example (src/main/java/chapter5/mySampleConverterConfig.xml)</em> <div class="source"><pre><configuration> @@ -1288,17 +1313,37 @@ </root> </configuration></pre></div> - <p>In this configuration file, once the new conversion word has been declared, we - just use it within a <code>PatternLayout</code> pattern element, as if - our custom conversion word had always been here.</p> - - <p>The intersted reader might want to take a look at other <code>Converter</code> implementations - like + <p>In this configuration file, once the new conversion word has + been declared, we can refert to it within a + <code>PatternLayout</code> pattern, as if the custom conversion + word had always been here.</p> + + <p>Given that ANSI terminal codes do not work on Windows, you can + view the results on non-Windows platforms such as Linux or + Mac. The following command:</p> + + <div class="source">java chapter5.SampleLogging src/main/java/chapter5/mySampleConverterConfig.xml </div> + + <p>should yield:</p> + +<div class="source">0 [main] DEBUG - Everything's going well +3 [main] <span class="red">ERROR</span> - maybe not quite... </div> + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXxxxx + + <p>Please note that the string "ERROR" is highlighted in red, + which is basically the whole point of the exercise.</p> + + <p>The intersted reader might want to take a look at other + <code>Converter</code> implementations such as <a href="../xref/ch/qos/logback/classic/pattern/MDCConverter.html"> - <code>MDCConverter</code></a> to learn how to implement more complex behaviours, involving - the use of options, in her custom <code>Converter</code> objects. + <code>MDCConverter</code></a> to learn how to implement more + complex behaviour, such as option handling. </p> + + + <a name="ClassicHTMLLayout"></a> <h3>HTMLLayout</h3> <p><a href="../xref/ch/qos/logback/classic/html/HTMLLayout.html">

1 0