[logback-dev] [GIT] Logback: the generic, reliable, fast and flexible logging framework. branch, master, updated. release_0.9.19-11-g60bd9df
added by portage for gitosis-gentoo
git-noreply at pixie.qos.ch
Wed Mar 31 00:07:57 CEST 2010
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Logback: the generic, reliable, fast and flexible logging framework.".
The branch, master has been updated
via 60bd9dfb27e27cd509e6a18aa1de80ec6f1379d8 (commit)
from 91737bd88e2830f2d20d016f166d701ffd8ad5b3 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
http://git.qos.ch/gitweb/?p=logback.git;a=commit;h=60bd9dfb27e27cd509e6a18aa1de80ec6f1379d8
http://github.com/ceki/logback/commit/60bd9dfb27e27cd509e6a18aa1de80ec6f1379d8
commit 60bd9dfb27e27cd509e6a18aa1de80ec6f1379d8
Author: Ceki Gulcu <ceki at qos.ch>
Date: Wed Mar 31 00:06:32 2010 +0200
- documenting conditional processing
- additional test cases for conditional processing
diff --git a/logback-classic/src/test/java/ch/qos/logback/classic/joran/conditional/ConditionalTest.java b/logback-classic/src/test/java/ch/qos/logback/classic/joran/conditional/ConditionalTest.java
index be99ad2..dcb46b5 100644
--- a/logback-classic/src/test/java/ch/qos/logback/classic/joran/conditional/ConditionalTest.java
+++ b/logback-classic/src/test/java/ch/qos/logback/classic/joran/conditional/ConditionalTest.java
@@ -21,6 +21,7 @@ import java.io.IOException;
import java.net.InetAddress;
import java.net.UnknownHostException;
+import org.junit.After;
import org.junit.Before;
import org.junit.Test;
@@ -37,69 +38,83 @@ import ch.qos.logback.core.testUtil.RandomUtil;
import ch.qos.logback.core.util.CoreTestConstants;
import ch.qos.logback.core.util.StatusPrinter;
-
public class ConditionalTest {
LoggerContext context = new LoggerContext();
Logger root = context.getLogger(Logger.ROOT_LOGGER_NAME);
-
int diff = RandomUtil.getPositiveInt();
String randomOutputDir = CoreTestConstants.OUTPUT_DIR_PREFIX + diff + "/";
-
+
@Before
public void setUp() throws UnknownHostException {
- context.setName("c"+diff);
+ context.setName("c" + diff);
context.putProperty("randomOutputDir", randomOutputDir);
- InetAddress localhost = InetAddress.getLocalHost();
- context.putProperty("aHost", localhost.getCanonicalHostName());
}
-
-
+
+ @After
+ public void tearDown() {
+ StatusPrinter.printIfErrorsOccured(context);
+ }
+
void configure(String file) throws JoranException {
JoranConfigurator jc = new JoranConfigurator();
jc.setContext(context);
jc.doConfigure(file);
}
-
+
@Test
- public void conditionalConsoleApp_THEN() throws JoranException, IOException,
- InterruptedException {
+ public void conditionalConsoleApp_IF_THEN_True() throws JoranException,
+ IOException, InterruptedException {
+ InetAddress localhost = InetAddress.getLocalHost();
+ context.putProperty("aHost", localhost.getCanonicalHostName());
String configFileAsStr = ClassicTestConstants.JORAN_INPUT_PREFIX
+ "conditional/conditionalConsoleApp.xml";
configure(configFileAsStr);
FileAppender fileAppender = (FileAppender) root.getAppender("FILE");
assertNotNull(fileAppender);
-
+
ConsoleAppender consoleAppender = (ConsoleAppender) root.getAppender("CON");
assertNotNull(consoleAppender);
- StatusPrinter.printIfErrorsOccured(context);
StatusChecker checker = new StatusChecker(context);
assertTrue(checker.isErrorFree());
}
-
+
+ @Test
+ public void conditionalConsoleApp_IF_THEN_False() throws JoranException,
+ IOException, InterruptedException {
+
+ String configFileAsStr = ClassicTestConstants.JORAN_INPUT_PREFIX
+ + "conditional/conditionalConsoleApp.xml";
+ configure(configFileAsStr);
+ FileAppender fileAppender = (FileAppender) root.getAppender("FILE");
+ assertNotNull(fileAppender);
+
+ ConsoleAppender consoleAppender = (ConsoleAppender) root.getAppender("CON");
+ assertNull(consoleAppender);
+ StatusChecker checker = new StatusChecker(context);
+ assertTrue(checker.isErrorFree());
+ }
+
@Test
- public void conditionalConsoleApp_ELSE() throws JoranException, IOException,
- InterruptedException {
+ public void conditionalConsoleApp_IF_THEN_ELSE() throws JoranException,
+ IOException, InterruptedException {
String configFileAsStr = ClassicTestConstants.JORAN_INPUT_PREFIX
+ "conditional/conditionalConsoleApp_ELSE.xml";
configure(configFileAsStr);
-
- StatusPrinter.print(context);
-
-
+
FileAppender fileAppender = (FileAppender) root.getAppender("FILE");
assertNotNull(fileAppender);
-
+
ConsoleAppender consoleAppender = (ConsoleAppender) root.getAppender("CON");
assertNull(consoleAppender);
-
+
ListAppender listAppender = (ListAppender) root.getAppender("LIST");
assertNotNull(listAppender);
-
- //StatusPrinter.printIfErrorsOccured(context);
+
+ // StatusPrinter.printIfErrorsOccured(context);
StatusChecker checker = new StatusChecker(context);
assertTrue(checker.isErrorFree());
}
diff --git a/logback-core/src/main/java/ch/qos/logback/core/joran/conditional/IfAction.java b/logback-core/src/main/java/ch/qos/logback/core/joran/conditional/IfAction.java
index 7898f4d..b65a139 100644
--- a/logback-core/src/main/java/ch/qos/logback/core/joran/conditional/IfAction.java
+++ b/logback-core/src/main/java/ch/qos/logback/core/joran/conditional/IfAction.java
@@ -87,9 +87,12 @@ public class IfAction extends Action {
if (!state.boolResult) {
listToPlay = state.elseSaxEventList;
}
-
- // insert past this event
- interpreter.addEventsDynamically(listToPlay, 1);
+
+ // if boolResult==false & missing else, listToPlay may be null
+ if(listToPlay != null) {
+ // insert past this event
+ interpreter.addEventsDynamically(listToPlay, 1);
+ }
}
diff --git a/logback-core/src/test/input/joran/conditional/ifWithoutElse.xml b/logback-core/src/test/input/joran/conditional/ifWithoutElse.xml
new file mode 100644
index 0000000..ef1a39f
--- /dev/null
+++ b/logback-core/src/test/input/joran/conditional/ifWithoutElse.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<x>
+ <stack name="BEGIN"/>
+ <if condition='p("Ki1").equals("Val1")'>
+ <then>
+ <stack name="a"/>
+ </then>
+ </if>
+ <stack name="END"/>
+</x>
diff --git a/logback-core/src/test/java/ch/qos/logback/core/joran/conditional/IfThenElseTest.java b/logback-core/src/test/java/ch/qos/logback/core/joran/conditional/IfThenElseTest.java
index 5d3f98b..3a414e8 100644
--- a/logback-core/src/test/java/ch/qos/logback/core/joran/conditional/IfThenElseTest.java
+++ b/logback-core/src/test/java/ch/qos/logback/core/joran/conditional/IfThenElseTest.java
@@ -15,6 +15,7 @@ package ch.qos.logback.core.joran.conditional;
import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
import java.util.Arrays;
import java.util.HashMap;
@@ -32,6 +33,7 @@ import ch.qos.logback.core.joran.action.NOPAction;
import ch.qos.logback.core.joran.action.ext.StackAction;
import ch.qos.logback.core.joran.spi.JoranException;
import ch.qos.logback.core.joran.spi.Pattern;
+import ch.qos.logback.core.status.StatusChecker;
import ch.qos.logback.core.testUtil.RandomUtil;
import ch.qos.logback.core.util.CoreTestConstants;
import ch.qos.logback.core.util.StatusPrinter;
@@ -62,6 +64,7 @@ public class IfThenElseTest {
@After
public void tearDown() throws Exception {
+ StatusPrinter.printIfErrorsOccured(context);
StackAction.reset();
}
@@ -69,7 +72,6 @@ public class IfThenElseTest {
public void if0_Then() throws JoranException {
context.putProperty("Ki1", "Val1");
tc.doConfigure(CONDITIONAL_DIR_PREFIX+"if0.xml");
- StatusPrinter.printIfErrorsOccured(context);
verifyConfig(new String[] {"BEGIN", "a", "END"});
}
@@ -80,6 +82,22 @@ public class IfThenElseTest {
}
@Test
+ public void ifWithoutElse_True() throws JoranException {
+ context.putProperty("Ki1", "Val1");
+ tc.doConfigure(CONDITIONAL_DIR_PREFIX+"ifWithoutElse.xml");
+ verifyConfig(new String[] {"BEGIN", "a", "END"});
+ }
+
+ @Test
+ public void ifWithoutElse_False() throws JoranException {
+ tc.doConfigure(CONDITIONAL_DIR_PREFIX+"ifWithoutElse.xml");
+ verifyConfig(new String[] {"BEGIN", "END"});
+ StatusChecker checker = new StatusChecker(context);
+ assertTrue(checker.isErrorFree());
+ }
+
+
+ @Test
public void nestedIf() throws JoranException {
tc.doConfigure(CONDITIONAL_DIR_PREFIX+"nestedIf.xml");
StatusPrinter.printIfErrorsOccured(context);
diff --git a/logback-site/src/site/pages/manual/configuration.html b/logback-site/src/site/pages/manual/configuration.html
index 8208a53..914f52e 100644
--- a/logback-site/src/site/pages/manual/configuration.html
+++ b/logback-site/src/site/pages/manual/configuration.html
@@ -129,8 +129,8 @@
<code>MyApp1</code>.
</p>
- <em>Example 3.<span class="autoEx"/>: Simple example of
- <code>BasicConfigurator</code> usage <a
+ <em>Example: Simple example of <code>BasicConfigurator</code>
+ usage <a
href="../xref/chapters/configuration/MyApp1.html">(logback-examples/src/main/java/chapters/configuration/MyApp1.java)</a></em>
<pre class="prettyprint source">package manual.configuration;
@@ -154,7 +154,7 @@ public class MyApp1 {
instantiates a Foo object. The Foo class is listed below:
</p>
- <em>Example 3.<span class="autoEx"/>: Small class doing logging
+ <em>Example: Small class doing logging
<a href="../xref/chapters/configuration/Foo.html">(logback-examples/src/main/java/chapters/configuration/Foo.java)</a>
</em>
@@ -231,7 +231,7 @@ public class Foo {
seen.
</p>
- <p><em>Example 3.<span class="autoEx"/>: Basic configuration file
+ <p><em>Example: Basic configuration file
(logback-examples/src/main/java/chapters/configuration/sample0.xml)</em></p>
@@ -276,7 +276,7 @@ public class Foo {
addition of two lines of code for printing internal status
data.</p>
- <em>Example 3.<span class="autoEx"/>: Print logback's internal status information
+ <em>Example: Print logback's internal status information
<a
href="../xref/chapters/configuration/MyApp2.html">(logback-examples/src/main/java/chapters/configuration/MyApp2.java)</a></em>
@@ -325,7 +325,7 @@ public class Foo {
</p>
- <em>Example 3.<span class="autoEx"/>: Basic configuration file
+ <em>Example: Basic configuration file
using debug mode
(logback-examples/src/main/java/chapters/configuration/sample1.xml)</em>
@@ -399,7 +399,7 @@ public class Foo {
<code><configuration></code> element to true, as shown next.
</p>
- <em>Example 3.<span class="autoEx"/>: Scanning for changes in
+ <em>Example: Scanning for changes in
configuration file and automatic re-configuraion
(logback-examples/src/main/java/chapters/configuration/scan1.xml)</em>
@@ -416,7 +416,7 @@ public class Foo {
units of milliseconds, seconds, minutes or hours. Here is an
example:</p>
- <em>Example 3.<span class="autoEx"/>: Specifying a different
+ <em>Example: Specifying a different
scanning period
(logback-examples/src/main/java/chapters/configuration/scan2.xml)</em>
@@ -468,7 +468,7 @@ public class Foo {
application, <em>MyApp3</em>, invokes JoranConfigurator on a
configuration file passed as a parameter.</p>
- <p><em>Example 3.<span class="autoEx"/>: Invoking
+ <p><em>Example: Invoking
<code>JoranConfigurator</code> directly <a
href="../xref/chapters/configuration/MyApp3.html">(logback-examples/src/main/java/chapters/configuration/MyApp3.java)</a></em></p>
@@ -605,7 +605,7 @@ public class MyApp3 {
<p>It is also possible to register one or more status listeners
within a configuration file. Here is an example.</p>
- <p><em>Example 3.<span class="autoEx"/>: Registering a status listener (logback-examples/src/main/java/chapters/configuration/onConsoleStatusListener.xml)</em></p>
+ <p><em>Example: Registering a status listener (logback-examples/src/main/java/chapters/configuration/onConsoleStatusListener.xml)</em></p>
<pre class="prettyprint source"><configuration>
<b><statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener" /></b>
@@ -762,7 +762,7 @@ public class MyApp3 {
following configuration file shows how to achieve that.
</p>
-<em>Example 3.<span class="autoEx"/>: Setting the level of a logger (logback-examples/src/main/java/chapters/configuration/sample2.xml)</em>
+<em>Example: Setting the level of a logger (logback-examples/src/main/java/chapters/configuration/sample2.xml)</em>
<pre class="prettyprint source"><configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
@@ -800,7 +800,7 @@ public class MyApp3 {
of the <em>chapters.configuration.Foo</em> logger to <code>DEBUG</code>.
</p>
-<em>Example 3.<span class="autoEx"/>: Setting the level of multiple loggers (logback-examples/src/main/java/chapters/configuration/sample3.xml)</em>
+<em>Example: Setting the level of multiple loggers (logback-examples/src/main/java/chapters/configuration/sample3.xml)</em>
<pre class="source prettyprint"><configuration>
<appender name="STDOUT"
@@ -879,7 +879,7 @@ public class MyApp3 {
<em>sample4.xml</em> is a case in point:
</p>
- <em>Example 3.<span class="autoEx"/>: Logger level sample
+ <em>Example: Logger level sample
(logback-examples/src/main/java/chapters/configuration/sample4.xml)</em>
<pre class="prettyprint source"><configuration>
@@ -1003,7 +1003,7 @@ public class MyApp3 {
configuration file illustrates:
</p>
-<em>Example 3.<span class="autoEx"/>: Multiple loggers (logback-examples/src/main/java/chapters/configuration/multiple.xml)</em>
+<em>Example: Multiple loggers (logback-examples/src/main/java/chapters/configuration/multiple.xml)</em>
<pre class="prettyprint source"><configuration>
<appender name="<b>FILE</b>" class="ch.qos.logback.core.FileAppender">
@@ -1055,7 +1055,7 @@ public class MyApp3 {
duplicated.
</p>
- <em>Example 3.<span class="autoEx"/>: Duplicate appender
+ <em>Example: Duplicate appender
(logback-examples/src/main/java/chapters/configuration/duplicate.xml)</em>
<pre class="prettyprint source"><configuration>
@@ -1101,7 +1101,7 @@ public class MyApp3 {
set of loggers flow into a specific appender.
</p>
- <em>Example 3.<span class="autoEx"/>: Multiple appender
+ <em>Example: Multiple appender
(logback-examples/src/main/java/chapters/configuration/restricted.xml)</em>
<pre class="prettyprint source"><configuration>
@@ -1146,7 +1146,7 @@ public class MyApp3 {
of the tree.
</p>
-<em>Example 3.<span class="autoEx"/>: Additivity flag (logback-examples/src/main/java/chapters/configuration/additivityFlag.xml)</em>
+<em>Example: Additivity flag (logback-examples/src/main/java/chapters/configuration/additivityFlag.xml)</em>
<pre class="prettyprint source"><configuration>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
@@ -1184,6 +1184,44 @@ public class MyApp3 {
<em>foo.log</em> file and only in that file.
</p>
+
+ <h3><a name="contextName" href="#contextName">Setting the context name</a></h3>
+
+ <p>As mentioned <a href="architecture.html#LoggerContext">in an
+ earlier chapter</a>, every logger is attached to logger context. By
+ default, the logger context is called "default". However, you can
+ set a different name with the help of the
+ <code><contextName></code> configuration directive. Note that
+ once set, the logger context name <a
+ href="../apidocs/ch/qos/logback/core/ContextBase.html#setName(java.lang.String)">cannot
+ be changed</a>. Setting the context name is a simple and
+ straightforward method in order to distinguish between multiple
+ applications logging to the same target.
+ </p>
+
+ <em>Example: Set the context name and display it
+ (logback-examples/src/main/java/chapters/configuration/contextName.xml)</em>
+ <pre class="prettyprint source"><configuration>
+ <b><contextName>myAppName</contextName></b>
+ <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>%d <b>%contextName</b> [%t] %level %logger{36} - %msg%n</pattern>
+ </encoder>
+ </appender>
+
+ <root level="debug">
+ <appender-ref ref="STDOUT" />
+ </root>
+</configuration></pre>
+
+ <p>This last examples illustrates naming of the logger
+ context. Adding the the <a
+ href="layouts.html#conversionWord">contextName conversion word</a>
+ in layout's pattern will output the said name.</p>
+
+ <!-- =============================================================== -->
+
+
<h4><a name="variableSubstitution"
href="#variableSubstitution">Variable substitution</a></h4>
@@ -1214,7 +1252,7 @@ public class MyApp3 {
output file.
</p>
- <em>Example 3.<span class="autoEx"/>: Simple Variable substitution
+ <em>Example: Simple Variable substitution
(logback-examples/src/main/java/chapters/configuration/variableSubstitution1.xml)
</em>
@@ -1243,7 +1281,7 @@ public class MyApp3 {
<p class="source">java -DUSER_HOME="/home/sebastien" MyApp2</p>
- <em>Example 3.<span class="autoEx"/>: System Variable substitution
+ <em>Example: System Variable substitution
(logback-examples/src/main/java/chapters/configuration/variableSubstitution2.xml)
</em>
@@ -1267,7 +1305,7 @@ public class MyApp3 {
how one can do such a setup.
</p>
- <em>Example 3.<span class="autoEx"/>: Variable substitution using a
+ <em>Example: Variable substitution using a
separate file
(logback-examples/src/main/java/chapters/configuration/variableSubstitution3.xml)
</em>
@@ -1295,7 +1333,7 @@ public class MyApp3 {
file might look like.
</p>
- <em>Example 3.<span class="autoEx"/>: Variable file
+ <em>Example: Variable file
(logback-examples/src/main/java/chapters/configuration/variables1.properties)</em>
<pre class="source">USER_HOME=/home/sebastien</pre>
@@ -1330,7 +1368,7 @@ public class MyApp3 {
</p>
- <em>Example 3.<span class="autoEx"/>: Nested variable references
+ <em>Example: Nested variable references
(logback-examples/src/main/java/chapters/configuration/variables2.properties)</em>
<pre class="source">USER_HOME=/home/sebastien
@@ -1342,7 +1380,7 @@ fileName=myApp.log
"fileName".
</p>
- <em>Example 3.<span class="autoEx"/>: Variable substitution using
+ <em>Example: Variable substitution using
a separate file
(logback-examples/src/main/java/chapters/configuration/variableSubstitution4.xml)</em>
@@ -1374,9 +1412,134 @@ fileName=myApp.log
operator. For example, assuming <em>aKey</em> is not defined,
<code>"${aKey<b>:-golden</b>}"</code> will be interpreted as
"golden".</p>
+ <!-- ============================================================== -->
+
+ <h3><a name="conditional" href="#conditional">Conditional
+ processing of configuration files</a></h3>
+ <p>XML syntax is awfully cumbersome to serve as a basis for a
+ general purpose programming language. Nevertheless, recognizing the
+ fact that developers need to juggle between several configuration
+ files targeting different environments, e.g. development, testing
+ and production. Often the different files have substantial parts in
+ common differing only in a few places. To avoid duplication, logback
+ supports conditional processing of configuration files with the help
+ of <code><if></code>, <code><then></code> and
+ <code><else></code> elements.</p>
+
+ <p>The general format for conditional statements is shown below.</p>
+
+ <pre class="prettyprint source"><configuration>
+
+ <!-- if-then form -->
+ <if condition="some conditional expression">
+ <then>
+ ...
+ </then>
+ </if>
+
+ <!-- if-then-else form -->
+ <if condition="some conditional expression">
+ <then>
+ ...
+ </then>
+ <else>
+ ...
+ </else>
+ </if>
+
+</configuration></pre>
+
+ <p>The condition is a java expression where only context properties
+ or system properties are accessible. For a key passed as argument,
+ the <code>property</code>() or its shorter equivalent
+ <code>p</code>() methods return the String value of the property.
+ For example, to access the value a property with key "k", you would
+ write <code>property("k")</code> or equivalently
+ <code>p("k")</code>. If the property with key "k" is undefined, the
+ property method will return the empty string and not null. This
+ avoids the need to to check for null values.</p>
+
+ <p>In the next example, the <code>ConsoleAppender</code> will be
+ attached to the root logger, but only if the HOSTNAME is
+ "torino". Note that the <code>FileAppender</code> named "FILE" is
+ attached to the root logger in any case.
+ </p>
+
+
+ <pre class="prettyprint source"><configuration>
+
+ <b><if condition='property("HOSTNAME").contains("torino")'></b>
+ <b><then></b>
+ <appender name="CON" class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>%d %-5level %logger{35} - %msg %n</pattern>
+ </encoder>
+ </appender>
+ <root>
+ <appender-ref ref="CON" />
+ </root>
+ <b></then></b>
+ <b></if></b>
+
+ <appender name="FILE" class="ch.qos.logback.core.FileAppender">
+ <file>${randomOutputDir}/conditional.log</file>
+ <encoder>
+ <pattern>%d %-5level %logger{35} - %msg %n</pattern>
+ </encoder>
+ </appender>
+
+ <root level="ERROR">
+ <appender-ref ref="FILE" />
+ </root>
+</configuration></pre>
+
+
+ <p>Conditional processing is supported everywhere within the
+ <code><configuration></code> element. Nested if-then-else
+ statements are also supported. However, as mentioned earlier, XML is
+ not a good basis for scripting, and too many conditionals can
+ quickly render your configuration files ungrokable.
+ </p>
+
+
+ <!-- ============================================================== -->
+
+ <h3><a name="insertFromJNDI" href="#insertFromJNDI">Obtaining
+ variables from JNDI</a></h3>
+
+ <p>Under certain circumstances, you may want to make use of
+ env-entries stored in JNDI. The <code><insertFromJNDI></code>
+ configuration directive extracts an env-entry stored in JNDI and
+ inserts it as variable as specified by the <span
+ class="attr">as</span> attribute.
+ </p>
+
+ <em>Example: Insert as properties env-entries obtained via JNDI
+ (logback-examples/src/main/java/chapters/configuration/insertFromJNDI.xml)</em>
+ <pre class="prettyprint source"><configuration>
+ <b><insertFromJNDI env-entry-name="java:comp/env/appName" as="<span class="green">appName"</span> /></b>
+ <b><contextName><span class="green">${appName}</span></contextName></b>
+
+ <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>%d %contextName %level %msg %logger{50}%n</pattern>
+ </encoder>
+ </appender>
+
+ <root level="DEBUG">
+ <appender-ref ref="CONSOLE" />
+ </root>
+</configuration></pre>
+
+ <p>In this last example, the "java:comp/env/appName" env-entry is
+ inserted as the <span class="variable">appName</span> property. Note
+ that the <code><contextName></code> directive sets the context
+ name based on the value of the <span class="variable">appName</span>
+ property inserted by the previous <code><insertFromJNDI></code>
+ directive.
+ </p>
-
<h3><a name="fileInclusion" href="#fileInclusion">File
inclusion</a></h3>
@@ -1385,7 +1548,7 @@ fileName=myApp.log
element, as shown below:
</p>
- <em>Example 3.<span class="autoEx"/>: File include
+ <em>Example: File include
(logback-examples/src/main/java/chapters/configuration/containingConfig.xml)</em>
<pre class="prettyprint source"><configuration>
@@ -1402,7 +1565,7 @@ fileName=myApp.log
<code>ConsoleAppender</code> could be declared as:
</p>
- <em>Example 3.<span class="autoEx"/>: File include
+ <em>Example: File include
(logback-examples/src/main/java/chapters/configuration/includedConfig.xml)</em>
<pre class="source"><b class="green big"><included></b>
@@ -1445,77 +1608,6 @@ fileName=myApp.log
</ul>
-
- <h3><a name="contextName" href="#contextName">Setting the context name</a></h3>
-
- <p>As mentioned <a href="architecture.html#LoggerContext">in an
- earlier chapter</a>, every logger is attached to logger context. By
- default, the logger context is called "default". However, you can
- set a different name with the help of the
- <code><contextName></code> configuration directive. Note that
- once set, the logger context name <a
- href="../apidocs/ch/qos/logback/core/ContextBase.html#setName(java.lang.String)">cannot
- be changed</a>. Setting the context name is a simple and
- straightforward method in order to distinguish between multiple
- applications logging to the same target.
- </p>
-
- <em>Example 3.<span class="autoEx"/>: Set the context name and display it
- (logback-examples/src/main/java/chapters/configuration/contextName.xml)</em>
- <pre class="prettyprint source"><configuration>
- <b><contextName>myAppName</contextName></b>
- <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
- <encoder>
- <pattern>%d <b>%contextName</b> [%t] %level %logger{36} - %msg%n</pattern>
- </encoder>
- </appender>
-
- <root level="debug">
- <appender-ref ref="STDOUT" />
- </root>
-</configuration></pre>
-
- <p>This last examples illustrates naming of the logger
- context. Adding the the <a
- href="layouts.html#conversionWord">contextName conversion word</a>
- in layout's pattern will output the said name.</p>
-
- <h3><a name="insertFromJNDI" href="#insertFromJNDI">Obtaining
- variables from JNDI</a></h3>
-
- <p>Under certain circumstances, you may want to make use of
- env-entries stored in JNDI. The <code><insertFromJNDI></code>
- configuration directive extracts an env-entry stored in JNDI and
- inserts it as variable as specified by the <span
- class="attr">as</span> attribute.
- </p>
-
- <em>Example 3.<span class="autoEx"/>: Insert as properties env-entries obtained via JNDI
- (logback-examples/src/main/java/chapters/configuration/insertFromJNDI.xml)</em>
- <pre class="prettyprint source"><configuration>
- <b><insertFromJNDI env-entry-name="java:comp/env/appName" as="<span class="green">appName"</span> /></b>
- <b><contextName><span class="green">${appName}</span></contextName></b>
-
- <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
- <encoder>
- <pattern>%d %contextName %level %msg %logger{50}%n</pattern>
- </encoder>
- </appender>
-
- <root level="DEBUG">
- <appender-ref ref="CONSOLE" />
- </root>
-</configuration></pre>
-
- <p>In this last example, the "java:comp/env/appName" env-entry is
- inserted as the <span class="variable">appName</span> property. Note
- that the <code><contextName></code> directive sets the context
- name based on the value of the <span class="variable">appName</span>
- property inserted by the previous <code><insertFromJNDI></code>
- directive..
-
-</p>
-
<script src="../templates/footer.js" type="text/javascript"></script>
</div>
</body>
diff --git a/logback-site/src/site/pages/news.html b/logback-site/src/site/pages/news.html
index 5599a10..28310bc 100644
--- a/logback-site/src/site/pages/news.html
+++ b/logback-site/src/site/pages/news.html
@@ -34,6 +34,10 @@
<p>Fixed issue related to charsets in
<code>LayoutWrappingEncoder</code> not being recognized in config
files.</p>
+
+ <p>Logback now supports <a
+ href="manual/configuration.html#conditional">conditional
+ processing</a> of configuration files.</p>
<p>Logback now provides <a
href="http://logback.qos.ch/manual/loggingSeparation.html">an
@@ -42,7 +46,6 @@
href="http://jira.qos.ch/browse/LBCLASSIC-166">LBCLASSIC-166</a>
and <a
href="http://jira.qos.ch/browse/LBCLASSIC-87">LBCLASSIC-87</a>.
-
</p>
diff --git a/logback-site/src/site/pages/reasonsToSwitch.html b/logback-site/src/site/pages/reasonsToSwitch.html
index 877887d..14e401c 100644
--- a/logback-site/src/site/pages/reasonsToSwitch.html
+++ b/logback-site/src/site/pages/reasonsToSwitch.html
@@ -98,6 +98,20 @@
working again.
</p>
+ <h3><a name="conditional" href="#conditional">Conditional
+ prcessing of configuration files</a></h3>
+
+ <p>Recognizing the fact that developers need to juggle between
+ several configuration files targeting different environments,
+ e.g. development, testing and production. Often the different
+ files have substantial parts in common differing only in a few
+ places. To avoid duplication, logback supports <a
+ href="manual/configuration.html#conditional">conditional
+ processing of configuration files</a> with the help of
+ <code><if></code>, <code><then></code> and
+ <code><else></code> elements.
+ </p>
+
<h3><a name="filters" href="#filters">Filters</a></h3>
-----------------------------------------------------------------------
Summary of changes:
.../classic/joran/conditional/ConditionalTest.java | 63 +++--
.../logback/core/joran/conditional/IfAction.java | 9 +-
.../conditional/{if0.xml => ifWithoutElse.xml} | 5 +-
.../core/joran/conditional/IfThenElseTest.java | 20 ++-
.../src/site/pages/manual/configuration.html | 286 +++++++++++++-------
logback-site/src/site/pages/news.html | 5 +-
logback-site/src/site/pages/reasonsToSwitch.html | 14 +
7 files changed, 272 insertions(+), 130 deletions(-)
copy logback-core/src/test/input/joran/conditional/{if0.xml => ifWithoutElse.xml} (75%)
hooks/post-receive
--
Logback: the generic, reliable, fast and flexible logging framework.
More information about the logback-dev
mailing list