Author: ceki Date: Wed Dec 3 19:18:33 2008 New Revision: 2049 Modified: logback/trunk/logback-site/src/site/pages/faq.html logback/trunk/logback-site/src/site/pages/manual/joran.html logback/trunk/logback-site/src/site/pages/news.html Log: Added an FAQ entry: Is it possible for multiple JEE applications to share the same configuration file but without stepping on each other's toes? Related to LBCLASSIC-42 Modified: logback/trunk/logback-site/src/site/pages/faq.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/faq.html (original) +++ logback/trunk/logback-site/src/site/pages/faq.html Wed Dec 3 19:18:33 2008 @@ -45,6 +45,14 @@ <a href="#auto_config">How does the automatic configuration work?</a> </li> + + <li> + <a href="#sharedConfiguration">Is it possible for multiple JEE + applications to share the same configuration file but without + stepping on each other's toes? + </a> + </li> + <li> <a href="#setup_jetty">How can Jetty be instructed to use logback-classic as its logging implementataion? @@ -99,11 +107,11 @@ <p>This question is answered in the <a href="manual/joran.html#auto_configuration">relevant section</a> of the logback manual. - </p> - + </p> + <hr/> </dd> - <hr/> + <!-- ========================================================= --> @@ -122,9 +130,65 @@ <code>org.slf4j.LoggerFactory</code>. Thus, it is possible for a logback logger to be deserialized as a log4j or j.u.l. logger, depending on the deserialization environment.</p> + + <hr/> + </dd> + + + <!-- ========================================================= --> + + <dt> + <a name="sharedConfiguration" href="#sharedConfiguration"> + Is it possible for multiple JEE applications to share the + same configuration file but without stepping on each other's + toes?</a> + </dt> + <dd> + <p>Yes, it is. Using <a + href="manual/joran.html#variableSubstitution">variable + substitution</a>, it is possible to have a single + configuration file to output logs to different destinations + depending on each JEE application. Here is a sample + configuration file designed for this purpose.</p> + + <p class="source"><configuration> + <appender name="FILE" class="ch.qos.logback.core.FileAppender"> + <!-- "application-name" is a variable --> + <File><b>c:/logs/${application-name}.log</b></File> + <layout class="ch.qos.logback.classic.PatternLayout"> + <Pattern>%d %p %t %c - %m%n</Pattern> + </layout> + </appender> + <root level="debug"> + <appender-ref ref="FILE"/> + </root> +</configuration> </p> + + <p>Assuming each JEE application loads a different copy of + logback classes into memory, if we can somehow inject a + different value for <code><em>application-name</em></code> + each time an application starts, logs will be output to + different files. We just need to initialize logback with the + above configuration file while injecting a different value + for <code><em>application-name</em></code> variable. Here is + sample code that programmatically configures logback. It + should be invoked during the initialization of your JEE + applications. + </p> + + <p class="source"> LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory(); + // inject the name of the current application as "applicaiton-name" + // property of the LoggerContext + <b>context.putProperty("application-name", NAME_OF_CURRENT_APPLICATION);</b> + JoranConfigurator jc = new JoranConfigurator(); + jc.setContext(context); + context.reset(); // override default configuration + jc.doConfigure("/path/to/the/above/configuration/file.xml"); </p> + + <hr/> </dd> - <hr/> + <!-- ========================================================= --> <dt> @@ -139,31 +203,34 @@ logging. </p> - <p>The following jar files must be present in the - <em>JETTY_HOME/lib</em> directory. + <p>Logback jar files must be present on Jetty's class + path. These files are + <em>logback-core-${project.version}.jar</em> and + <em>logback-classic-${project.version}.jar</em>. These files + should be placed under the <em>$JETTY_HOME/lib</em> + directory. </p> + + + <p>Since Jetty's uses an older version of SLF4J internally, + we recommend that the old version be replaced by + <em>slf4j-api-${slf4j.version}.jar</em>. This file can be + downloaded from the <a + href="http://www.slf4j.org/download.html">SLF4J</a> project. + </p> + - <p>Logback-classic is based on the SLF4J api. Therefore, the - <em>slf4j-api-VERSION.jar</em> jar must be present. This jar - can be downloaded from the <a - href="http://www.slf4j.org/">SLF4J</a> project. - </p> - <p>Logback's own jars must also be present, namely - <em>logback-core-VERSION.jar</em> and - <em>logback-classic-VERSION.jar</em> . - </p> - - <p> To configure logback-classic, a file called - <em>logback.xml</em> should be placed in the - <em>JETTY_HOME/resources</em> directory. You can find sample - configuration files in the - <em>logback-examples/src/main/java/chapter4/conf/</em> folder - shipping within the logback distribution. + <p>For automaticly configuring logback-classic, you can + place the file <em>logback.xml</em> under the + <em>$JETTY_HOME/resources</em> directory. You can find + sample configuration files in the + <em>logback-examples/src/main/java/chapter4/conf/</em> + folder shipping within the logback distribution. </p> + <hr/> </dd> - <hr /> 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 Wed Dec 3 19:18:33 2008 @@ -954,7 +954,8 @@ <em>foo.log</em> file and only in that file. </p> - <h4>Variable substitution</h4> + <h4><a name="variableSubstitution" + href="#variableSubstitution">Variable substitution</a></h4> <p>In principle, variable substitution can occur at any point where a value can be specified. The syntax of variable substitution is @@ -1133,7 +1134,9 @@ </root> </configuration></pre></div> - <h4>Default substitution values for variables</h4> + <h4><a name="defaultValuesForVariables" + href="#defaultValuesForVariables">Default substitution values for + variables</a></h4> <p>Under certain circumstances, it may be desirable for a variable to have a default value in case it is not declared or its value is 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 Wed Dec 3 19:18:33 2008 @@ -28,7 +28,7 @@ <hr width="80%" align="center" /> - <h3>28th of November 2008 - Release of version 0.9.12</h3> + <h3>4th of December 2008 - Release of version 0.9.12</h3> <p>Fixed <a href="http://jira.qos.ch/browse/LBCORE-26">bug LBCORE-26</a> reported by Tsutomu YANO and independently by @@ -59,7 +59,13 @@ href="http://jira.qos.ch/browse/LBCLASSIC-33">LBCLASSIC-33</a>, <a href="http://jira.qos.ch/browse/LBCLASSIC-14">LBCLASSIC-24</a> and <a href="http://jira.qos.ch/browse/LBCLASSIC-24">LBCLASSIC-14</a> - JMXConfigurator has been redesigned. + <code>JMXConfigurator</code> has been redesigned. + </p> + + <p>Fixed <a + href="http://jira.qos.ch/browse/LBGENERAL-22">LBGENERAL-22</a>. The + <a href="http://logback.qos.ch/translator/">log4j.properties + translator</a> web-application has been significatnly refactored. </p> <p>Fixed improvement request <a