[logback-dev] [GIT] Logback: the generic, reliable, fast and flexible logging framework. branch, master, updated. v_0.9.25-28-g32168a3
added by portage for gitosis-gentoo
git-noreply at pixie.qos.ch
Tue Nov 9 18:20:46 CET 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 32168a310cd48e5920d7b03dc23e88f15496c528 (commit)
from 7547101fdc70b4bcd9820c8becb0591ada7465ac (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=32168a310cd48e5920d7b03dc23e88f15496c528
http://github.com/ceki/logback/commit/32168a310cd48e5920d7b03dc23e88f15496c528
commit 32168a310cd48e5920d7b03dc23e88f15496c528
Author: Ceki Gulcu <ceki at qos.ch>
Date: Tue Nov 9 18:17:45 2010 +0100
- Ongoing work on LBCORE-180 and LBCLASSIC-232
- edit property names in the documentaiton so that the first letter is lower case
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/ConfigurationAction.java b/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/ConfigurationAction.java
index 3eef4b4..ebd2ec1 100644
--- a/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/ConfigurationAction.java
+++ b/logback-classic/src/main/java/ch/qos/logback/classic/joran/action/ConfigurationAction.java
@@ -80,9 +80,6 @@ public class ConfigurationAction extends Action {
addInfo("End of configuration.");
LoggerContext loggerContext = (LoggerContext) context;
StatusPrinter.print(loggerContext);
-
- // LoggerContext loggerContext = (LoggerContext) context;
- // ConfiguratorBase.detachTemporaryConsoleAppender(repository, errorList);
}
ec.popObject();
}
diff --git a/logback-core/src/main/java/ch/qos/logback/core/ContextBase.java b/logback-core/src/main/java/ch/qos/logback/core/ContextBase.java
index 7338691..f811400 100644
--- a/logback-core/src/main/java/ch/qos/logback/core/ContextBase.java
+++ b/logback-core/src/main/java/ch/qos/logback/core/ContextBase.java
@@ -17,11 +17,12 @@ import java.util.HashMap;
import java.util.Map;
import ch.qos.logback.core.status.StatusManager;
+import static ch.qos.logback.core.CoreConstants.CONTEXT_NAME_KEY;
public class ContextBase implements Context {
private long birthTime = System.currentTimeMillis();
-
+
private String name;
private StatusManager sm = new BasicStatusManager();
// TODO propertyMap should be observable so that we can be notified
@@ -31,7 +32,7 @@ public class ContextBase implements Context {
Map<String, Object> objectMap = new HashMap<String, Object>();
Object configurationLock = new Object();
-
+
public StatusManager getStatusManager() {
return sm;
}
@@ -40,10 +41,10 @@ public class ContextBase implements Context {
* Set the {@link StatusManager} for this context. Note that by default this
* context is initialized with a {@link BasicStatusManager}. A null value for
* the 'statusManager' argument is not allowed.
- *
+ *
* <p> A malicious attacker can set the status manager to a dummy instance,
* disabling internal error reporting.
- *
+ *
* @param statusManager
* the new status manager
*/
@@ -63,7 +64,17 @@ public class ContextBase implements Context {
this.propertyMap.put(key, val);
}
+ /**
+ * Given a key, return the corresponding property value. If invoked with
+ * the special key "CONTEXT_NAME", the name of the context is returned.
+ *
+ * @param key
+ * @return
+ */
public String getProperty(String key) {
+ if(CONTEXT_NAME_KEY.equals(key))
+ return getName();
+
return (String) this.propertyMap.get(key);
}
@@ -91,7 +102,7 @@ public class ContextBase implements Context {
* The context name can be set only if it is not already set, or if the
* current name is the default context name, namely "default", or if the
* current name and the old name are the same.
- *
+ *
* @throws IllegalStateException
* if the context already has a name, other than "default".
*/
diff --git a/logback-core/src/main/java/ch/qos/logback/core/CoreConstants.java b/logback-core/src/main/java/ch/qos/logback/core/CoreConstants.java
index 9d65b75..d654f9b 100644
--- a/logback-core/src/main/java/ch/qos/logback/core/CoreConstants.java
+++ b/logback-core/src/main/java/ch/qos/logback/core/CoreConstants.java
@@ -19,10 +19,10 @@ public class CoreConstants {
// applets.
public static final String LINE_SEPARATOR = System.getProperty("line.separator");
public static final int LINE_SEPARATOR_LEN = LINE_SEPARATOR.length();
-
-
+
+
public static final String CODES_URL = "http://logback.qos.ch/codes.html";
-
+
/**
* The default context name.
*/
@@ -32,88 +32,94 @@ public class CoreConstants {
* {@link Context} object store.
*/
public static final String PATTERN_RULE_REGISTRY = "PATTERN_RULE_REGISTRY";
-
+
public static final String ISO8601_STR = "ISO8601";
public static final String ISO8601_PATTERN = "yyyy-MM-dd HH:mm:ss,SSS";
-
+
/**
* Time format used in Common Log Format
*/
static public final String CLF_DATE_PATTERN = "dd/MM/yyyy:HH:mm:ss Z";
-
+
/**
* The key used in locating the evaluator map in context's object map.
*/
static public final String EVALUATOR_MAP = "EVALUATOR_MAP";
/**
- * By convention, we assume that the static method named "valueOf" taking
- * a string argument can restore a given object from its string
+ * By convention, we assume that the static method named "valueOf" taking
+ * a string argument can restore a given object from its string
* representation.
*/
static public final String VALUE_OF = "valueOf";
-
+
/**
* An empty string.
*/
public final static String EMPTY_STRING = "";
-
+
/**
* An empty string array.
*/
public final static String[] EMPTY_STRING_ARRAY = new String[] {};
-
+
/**
* An empty Class array.
*/
public final static Class<?>[] EMPTY_CLASS_ARRAY = new Class[] {};
public final static String CAUSED_BY = "Caused by: ";
-
-
+
+
public final static char PERCENT_CHAR = '%';
public static final char LEFT_PARENTHESIS_CHAR = '(';
public static final char RIGHT_PARENTHESIS_CHAR = ')';
-
- /**
- * Number of rows before in an HTML table before,
+
+ /**
+ * Number of rows before in an HTML table before,
* we close the table and create a new one
*/
public static final int TABLE_ROW_LIMIT = 10000;
-
-
+
+
// reset the ObjectOutputStream every OOS_RESET_FREQUENCY calls
// this avoid serious memory leaks
public static final int OOS_RESET_FREQUENCY = 70;
-
+
/**
* The reference bogo instructions per second on
* Ceki's machine (Orion)
*/
public static long REFERENCE_BIPS = 9000;
-
-
+
+
// the max number of times an error should be reported
static public final int MAX_ERROR_COUNT = 4;
-
-
+
+
static public final char DOT = '.';
static public final char TAB = '\t';
static public final char DOLLAR = '$';
-
+
static public final String SEE_FNP_NOT_SET = "See also http://logback.qos.ch/codes.html#tbr_fnp_not_set";
-
+
// The url used for the last configuration via Joran. If a file is used for the
// configuration, then file.getURL() is registered
public static String URL_OF_LAST_CONFIGURATION_VIA_JORAN = "URL_OF_LAST_CONFIGURATION_VIA_JORAN";
-
+
/**
* The key under which the local host name is registered in the logger
* context.
*/
public static final String HOSTNAME_KEY = "HOSTNAME";
-
-
+
+ /**
+ * The key under which the current context name is registered in the logger
+ * context.
+ */
+ public static final String CONTEXT_NAME_KEY = "CONTEXT_NAME";
+
+
public static int BYTES_PER_INT = 4;
public static final int MILLIS_IN_ONE_SECOND = 1000;
}
diff --git a/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java b/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java
index abd4bf6..6d1ee31 100644
--- a/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java
+++ b/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java
@@ -359,34 +359,65 @@ public abstract class SMTPAppenderBase<E> extends AppenderBase<E> {
}
/**
- * The <b>SMTPHost</b> option takes a string value which should be a the host
- * name of the SMTP server that will send the e-mail message.
+ * Alias for smtpHost
+ * @param smtpHost
*/
public void setSMTPHost(String smtpHost) {
+ setSmtpHost(smtpHost);
+ }
+
+ /**
+ * The <b>smtpHost</b> option takes a string value which should be a the host
+ * name of the SMTP server that will send the e-mail message.
+ */
+ public void setSmtpHost(String smtpHost) {
this.smtpHost = smtpHost;
}
/**
- * Returns value of the <b>SMTPHost</b> option.
+ * Alias for getSmtpHost().
*/
public String getSMTPHost() {
+ return getSmtpHost();
+ }
+
+ /**
+ * Returns value of the <b>SMTPHost</b> option.
+ */
+ public String getSmtpHost() {
return smtpHost;
}
/**
- * The port where the SMTP server is running. Default value is 25.
+ * Alias for {@link #setSmtpPort}.
*
* @param port
*/
public void setSMTPPort(int port) {
+ setSmtpPort(port);
+ }
+
+ /**
+ * The port where the SMTP server is running. Default value is 25.
+ *
+ * @param port
+ */
+ public void setSmtpPort(int port) {
this.smtpPort = port;
}
/**
+ * Alias for {@link #getSmtpPort}
* @return
- * @see #setSMTPPort(int)
- */
+ */
public int getSMTPPort() {
+ return getSmtpPort();
+ }
+ /**
+ * See {@link #setSmtpPort}
+ * @return
+ */
+ public int getSmtpPort() {
return smtpPort;
}
diff --git a/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java b/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java
index 475451a..842b9d8 100644
--- a/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java
+++ b/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java
@@ -206,8 +206,7 @@ public abstract class SocketAppenderBase<E> extends AppenderBase<E> {
}
/**
- * The <b>RemoteHost</b> option takes a string value which should be the host
- * name of the server where a {@link SocketNode} is running.
+ * The <b>RemoteHost</b> property takes the name of of the host where a corresponding server is running.
*/
public void setRemoteHost(String host) {
address = getAddressByName(host);
@@ -215,14 +214,14 @@ public abstract class SocketAppenderBase<E> extends AppenderBase<E> {
}
/**
- * Returns value of the <b>RemoteHost</b> option.
+ * Returns value of the <b>RemoteHost</b> property.
*/
public String getRemoteHost() {
return remoteHost;
}
/**
- * The <b>Port</b> option takes a positive integer representing the port
+ * The <b>Port</b> property takes a positive integer representing the port
* where the server is waiting for connections.
*/
public void setPort(int port) {
@@ -230,18 +229,18 @@ public abstract class SocketAppenderBase<E> extends AppenderBase<E> {
}
/**
- * Returns value of the <b>Port</b> option.
+ * Returns value of the <b>Port</b> property.
*/
public int getPort() {
return port;
}
/**
- * The <b>ReconnectionDelay</b> option takes a positive integer representing
+ * The <b>reconnectionDelay</b> property takes a positive integer representing
* the number of milliseconds to wait between each failed connection attempt
* to the server. The default value of this option is 30000 which corresponds
* to 30 seconds.
- *
+ *
* <p>
* Setting this option to zero turns off reconnection capability.
*/
@@ -250,7 +249,7 @@ public abstract class SocketAppenderBase<E> extends AppenderBase<E> {
}
/**
- * Returns value of the <b>ReconnectionDelay</b> option.
+ * Returns value of the <b>reconnectionDelay</b> property.
*/
public int getReconnectionDelay() {
return reconnectionDelay;
diff --git a/logback-core/src/main/java/ch/qos/logback/core/pattern/parser/Compiler.java b/logback-core/src/main/java/ch/qos/logback/core/pattern/parser/Compiler.java
index 7b5512a..bc94153 100644
--- a/logback-core/src/main/java/ch/qos/logback/core/pattern/parser/Compiler.java
+++ b/logback-core/src/main/java/ch/qos/logback/core/pattern/parser/Compiler.java
@@ -63,8 +63,8 @@ class Compiler<E> extends ContextAwareBase {
} else {
// if the appropriate dynaconverter cannot be found, then replace
// it with a dummy LiteralConverter indicating an error.
- Converter<E> errConveter = new LiteralConverter<E>("%PARSER_ERROR_"
- + kn.getValue());
+ Converter<E> errConveter = new LiteralConverter<E>("%PARSER_ERROR["
+ + kn.getValue()+"]");
addStatus(new ErrorStatus("[" + kn.getValue()
+ "] is not a valid conversion word", this));
addToList(errConveter);
diff --git a/logback-core/src/test/java/ch/qos/logback/core/ContextBaseTest.java b/logback-core/src/test/java/ch/qos/logback/core/ContextBaseTest.java
index 823ccec..b211323 100644
--- a/logback-core/src/test/java/ch/qos/logback/core/ContextBaseTest.java
+++ b/logback-core/src/test/java/ch/qos/logback/core/ContextBaseTest.java
@@ -29,7 +29,7 @@ public class ContextBaseTest {
context.setName("hello");
}
-
+
@Test
public void idempotentNameTest() {
context.setName("hello");
@@ -57,4 +57,15 @@ public class ContextBaseTest {
assertNull(context.getProperty("keyA"));
assertNull(context.getObject("keyA"));
}
+
+ @Test
+ public void contextNameProperty() {
+ assertNull(context.getProperty(CoreConstants.CONTEXT_NAME_KEY));
+ String HELLO = "hello";
+ context.setName(HELLO);
+ assertEquals(HELLO, context.getProperty(CoreConstants.CONTEXT_NAME_KEY));
+ // good to have a raw reference to the "CONTEXT_NAME" as most clients would
+ // not go through CoreConstants
+ assertEquals(HELLO, context.getProperty("CONTEXT_NAME"));
+ }
}
diff --git a/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/ParserTest.java b/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/ParserTest.java
index 26ea464..6fab0fc 100644
--- a/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/ParserTest.java
+++ b/logback-core/src/test/java/ch/qos/logback/core/pattern/parser/ParserTest.java
@@ -226,6 +226,18 @@ public class ParserTest {
}
}
+ // see http://jira.qos.ch/browse/LBCORE-180
+ @Test
+ public void keywordGluedToLitteral() throws Exception {
+ {
+ Parser p = new Parser("%x{}a");
+ Node t = p.parse();
+ KeywordNode witness = new KeywordNode("x");
+ witness.next = new Node(Node.LITERAL, "a");
+ assertEquals(witness, t);
+ }
+ }
+
@Test
public void testCompositeFormatting() throws Exception {
diff --git a/logback-examples/src/main/java/chapters/appenders/mail/mail1.xml b/logback-examples/src/main/java/chapters/appenders/mail/mail1.xml
index 2ad7810..e695921 100644
--- a/logback-examples/src/main/java/chapters/appenders/mail/mail1.xml
+++ b/logback-examples/src/main/java/chapters/appenders/mail/mail1.xml
@@ -1,13 +1,13 @@
<configuration>
<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <SMTPHost>ADDRESS-OF-YOUR-SMTP-HOST</SMTPHost>
- <To>EMAIL-DESTINATION</To>
- <To>ANOTHER_EMAIL_DESTINATION</To> <!-- additional destinations are possible -->
- <From>SENDER-EMAIL</From>
- <Subject>%logger{20} - %m</Subject>
+ <smtpHost>ADDRESS-OF-YOUR-SMTP-HOST</smtpHost>
+ <to>EMAIL-DESTINATION</to>
+ <to>ANOTHER_EMAIL_DESTINATION</to> <!-- additional destinations are possible -->
+ <from>SENDER-EMAIL</from>
+ <subject>%logger{20} - %m</subject>
<layout class="ch.qos.logback.classic.PatternLayout">
- <Pattern>%date %-5level %logger - %message%n</Pattern>
+ <pattern>%date %-5level %logger - %message%n</pattern>
</layout>
</appender>
diff --git a/logback-site/src/site/pages/manual/appenders.html b/logback-site/src/site/pages/manual/appenders.html
index 1ae186d..0f326e8 100644
--- a/logback-site/src/site/pages/manual/appenders.html
+++ b/logback-site/src/site/pages/manual/appenders.html
@@ -1466,8 +1466,8 @@ public interface TriggeringPolicy<E> extends LifeCycle {
</p>
<p>The remote server is identified by the <span
- class="option">RemoteHost</span> and <span
- class="option">Port</span> properties.
+ class="option">remoteHost</span> and <span
+ class="option">port</span> properties.
<code>SocketAppender</code> properties are listed in the following
table.
</p>
@@ -1479,18 +1479,18 @@ public interface TriggeringPolicy<E> extends LifeCycle {
<th>Description</th>
</tr>
<tr class="b">
- <td><b><span class="option">IncludeCallerData</span></b></td>
+ <td><b><span class="option">includeCallerData</span></b></td>
<td><code>boolean</code></td>
<td>
<p>
- The <span class="option">IncludeCallerData</span> option takes a boolean value.
+ The <span class="option">includeCallerData</span> option takes a boolean value.
If true, the caller data will be available to the remote host.
By default no caller data is sent to the server.
</p>
</td>
</tr>
<tr class="a">
- <td><b><span class="option">Port</span></b></td>
+ <td><b><span class="option">port</span></b></td>
<td><code>int</code></td>
<td>
<p>
@@ -1499,10 +1499,10 @@ public interface TriggeringPolicy<E> extends LifeCycle {
</td>
</tr>
<tr class="b">
- <td><b><span class="option">ReconnectionDelay</span></b></td>
+ <td><b><span class="option">reconnectionDelay</span></b></td>
<td><code>int</code></td>
<td>
- The <span class="option">ReconnectionDelay</span> option takes a
+ The <span class="option">reconnectionDelay</span> option takes a
positive integer representing the number of milliseconds to wait between
each failed connection attempt to the server.
The default value of this option is 30'000 which corresponds to 30 seconds.
@@ -1512,7 +1512,7 @@ public interface TriggeringPolicy<E> extends LifeCycle {
</td>
</tr>
<tr class="a">
- <td><b><span class="option">RemoteHost</span></b></td>
+ <td><b><span class="option">remoteHost</span></b></td>
<td><code>String</code></td>
<td>
The host name of the server.
@@ -1587,10 +1587,10 @@ public interface TriggeringPolicy<E> extends LifeCycle {
<pre id="client1" class="prettyprint source"><configuration>
<appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender">
- <RemoteHost>${host}</RemoteHost>
- <Port>${port}</Port>
- <ReconnectionDelay>10000</ReconnectionDelay>
- <IncludeCallerData>${includeCallerData}</IncludeCallerData>
+ <remoteHost>${host}</remoteHost>
+ <port>${port}</port>
+ <reconnectionDelay>10000</reconnectionDelay>
+ <includeCallerData>${includeCallerData}</includeCallerData>
</appender>
<root level="DEBUG">
@@ -1602,8 +1602,8 @@ public interface TriggeringPolicy<E> extends LifeCycle {
<p>
Note that in the above configuration scripts the values for the
- <span class="option">RemoteHost</span>, <span class="option">Port</span> and
- <span class="option">IncludeCallerData</span> properties
+ <span class="option">remoteHost</span>, <span class="option">port</span> and
+ <span class="option">includeCallerData</span> properties
are not given directly but as substituted variable keys. The values for the variables
can be specified as system properties:
</p>
@@ -1640,502 +1640,22 @@ public interface TriggeringPolicy<E> extends LifeCycle {
<p class="source">2006-11-06 17:37:30,968 DEBUG [Thread-0] [?:?] chapters.appenders.socket.SocketClient2 - Hi</p>
- <p>
- The outcome can be easily changed by instructing the <code>SocketAppender</code>
- to include caller data by setting the <span class="option">IncludeCallerData</span>
- option to true. Using the following command will do the trick:
- </p>
-
-<div class="source"><pre>java -Dhost=localhost -Dport=6000 -DincludeCallerData=true \
- chapters.appenders.socket.SocketClient2 src/main/java/chapters/appenders/socket/client1.xml
-</pre></div>
-
- <p>
- As deserialized events can be handled in the same way as locally
- generated events, they even can be sent to a second server for further treatment.
- As an exercise, you may wish to setup two servers where the first server
- tunnels the events it receives from its clients to a second server.
- </p>
-
- <a name="JMSAppenderBase"></a>
- <h3>JMSAppenderBase</h3>
-
- <p>
- The <a href="../xref/ch/qos/logback/core/net/JMSAppenderBase.html">
- <code>JMSAppenderBase</code></a> subclasses conceptually accomplish
- the same task as the <code>SocketAppender</code> but as the name
- suggests it is based on the JMS API instead of TCP sockets.
- JMS or the Java Message Service API
- provides an abstraction for Message-Oriented Middleware (MOM) products.
- One of the key architectural concepts in JMS is the decoupling of message
- producers and message consumers. Senders do not have to wait for receivers
- to handle messages and conversely the receiver consumes messages as they
- become available; messages are said to be delivered asynchronously. Just as
- importantly, consumers as well as producers can be added or removed at will
- to a JMS channel. The set of the message producers and message consumers can
- vary independently and transparently over time, with both sets oblivious
- to each other.
- </p>
-
- <p>The JMS specification provides for two types of messaging
- models, publish-and-subscribe and point-to-point queueing. Logback
- supports the former model with <code>JMSTopicAppender</code> and
- the latter with <code>JMSQueueAppender</code> Both appenders
- extend the <code>JMSAppenderBase</code> class and publish
- serialized events to a topic or queue specified by the user.
- </p>
-
- <p>One or more <code>JMSTopicSink</code> or
- <code>JMSQueueSink</code> applications can register with a JMS
- server and consume the serialized events. The consumers of events
- generated by JMS appenders need not only be
- <code>JMSTopicSink</code> or <code>JMSQueueSink</code>
- applications. Any application or MessageDrivenBean capable of
- subscribing to the appropriate topic or queue and consuming
- serialized logging event messages would be suitable. Additional
- consumers could be quickly built based on the
- <code>JMSTopicSink</code> or <code>JMSQueueSink</code> model.
- </p>
-
- <p>
- Here are <code>JMSAppenderBase</code>'s properties:
- </p>
-
- <table class="bodyTable">
- <tr class="a">
- <th>Property Name</th>
- <th>Type</th>
- <th>Description</th>
- </tr>
- <tr class="a">
- <td><b><span class="option">InitialContextFactoryName</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- The class name of the initial JNDI context factory. There is no need
- to set this option if you have a properly configured <em>jndi.properties</em>
- file or if <code>JMSAppenderBase</code> subclass is running
- within an application server.
- </p>
- <p>
- If you set this option, you should
- also set the <span class="option">ProviderURL</span> option.
- </p>
- </td>
- </tr>
- <tr class="b">
- <td><b><span class="option">ProviderURL</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- This option specifies configuration information for the
- JNDI service provider. The value of the property should contain a
- URL string (e.g. <em>ldap://somehost:389</em>).
- </p>
- <p>
- The <span class="option">ProviderURL</span> option is taken into
- account only if the <span class="option">InitialContextFactoryName</span>
- option is specified. It is ignored otherwise.
- </p>
- </td>
- </tr>
- <tr class="a">
- <td><b><span class="option">URLPkgPrefixes</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- This option contains the list of package prefixes to
- use when loading in URL context factories. The value of the
- property should be a colon-separated list of package
- prefixes for the class name of the URL context factory class.
- </p>
- <p>
- For JBoss the value of this option should be:
- org.jboss.naming:org.jnp.interfaces
- This option is not needed under Weblogic.
- </p>
- <p>
- This option is taken into account only if the
- <span class="option">InitialContextFactoryName</span>
- option is specified. It is ignored otherwise.
- </p>
- </td>
- </tr>
- <tr class="a">
- <td><b><span class="option">SecurityPrincipalName</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- The security principal name to use when accessing the JNDI namespace.
- This option is usually not required.
- </p>
- <p>
- This option is taken into account only if the
- <span class="option">InitialContextFactoryName</span>
- option is specified. It is ignored otherwise.
- </p>
- </td>
- </tr>
- <tr class="b">
- <td>
- <b>
- <span class="option">SecurityCredentials</span>
- </b>
- </td>
- <td>
- <code>String</code>
- </td>
- <td>
- <p>
- The security credentials to use when accessing the
- JNDI namespace. This option is usually not required.
- </p>
- <p>
- This option is taken into account only if the
- <span class="option">
- InitialContextFactoryName
- </span>
- option is specified. It is ignored otherwise.
- </p>
- </td>
- </tr>
- <tr class="a">
- <td>
- <b>
- <span class="option">UserName</span>
- </b>
- </td>
- <td>
- <code>String</code>
- </td>
- <td>
- <p>
- The username to use when creating a topic or queue connection.
- </p>
- </td>
- </tr>
- <tr class="b">
- <td>
- <b>
- <span class="option">Password</span>
- </b>
- </td>
- <td>
- <code>String</code>
- </td>
- <td>
- <p>
- The password to use when creating a topic or queue connection.
- </p>
- </td>
- </tr>
- </table>
-
- <p>
- JMS topics, queues and connection factories are administered objects that are obtained
- using the JNDI API. This in turn implies the necessity of retrieving a JNDI Context.
- There are two common methods for obtaining a JNDI Context. If a file resource named
- <em>jndi.properties</em> is available to the JNDI API, it will use the information
- found therein to retrieve an initial JNDI context.
- To obtain an initial context, one simply calls:
- </p>
-
-<div class="source"><pre>InitialContext jndiContext = new InitialContext();</pre></div>
-
- <p>
- Calling the no-argument <code>InitialContext()</code> constructor will also work
- from within Enterprise Java Beans (EJBs).
- Indeed, it is part of the EJB contract for application servers to provide
- each enterprise bean an environment naming context (ENC).
- </p>
-
- <p>
- In the second approach, several predetermined properties are specified.
- These properties are passed to the <code>InitialContext</code> constructor
- to connect to the naming service provider.
- For example, to connect to an
- <a href="http://www.activemq.org/site/home.html"><code>ActiveMQ</code></a>
- naming server one would write:
- </p>
-
-<pre class="prettyprint source longline">Properties env = new Properties();
-env.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.activemq.jndi.ActiveMQInitialContextFactory");
-env.put(Context.PROVIDER_URL, "tcp://<em>hostname</em>:61616");
-Context ctx = new InitialContext(env);</pre>
-
- <p>
- where <em>hostname</em> is the host where the ActiveMQ server is running.
- </p>
-
- <p>
- Other JNDI providers will obviously require different values.
- As mentioned previously, the initial JNDI context can be obtained by calling
- the no-argument <code>InitialContext()</code> constructor from within EJBs.
- Only clients running in a separate JVM need to be concerned about
- the <em>jndi.properties</em> file or setting the different properties
- before calling <code>InitialContext</code> constructor taking a
- Properties (i.e. Hashtable) parameter.
- </p>
-
- <h4>Comments on JMS appenders</h4>
-
- <p>Transmitting a packet of information using JMS is certain to be
- substantially slower than sending the same packet using raw TCP
- sockets. JMS vendors bragging about the performance of their
- messaging platform tend to omit this simple fact. Guaranteed
- store and forward messaging comes at a hefty price. In return for
- increased cost, JMS messaging provides decoupling of sender and
- receiver. As long as the JMS provider is reachable, messages will
- eventually arrive at the destination. However, what if the JMS
- server is down or simply unreachable?
- </p>
-
- <p>According to the JMS specification, producers can mark a
- message as either persistent or non-persistent. The persistent
- delivery mode instructs the JMS provider to log the message to
- stable storage as part of the client's send operation, allowing
- the message to survive provider crashes. JMS appenders do not set
- the delivery mode of messages they produce because according to
- the JMS specification, the delivery mode is considered as an
- administered property.
- </p>
-
- <p>Once a message reaches the JMS provider, the provider assumes
- the responsibility of delivering it to its destination, relieving
- the client from this chore. What if the JMS server is
- unreachable? The JMS API provides an
- <code>ExceptionListener</code> interface to deal with this
- situation. When the client runtime of the JMS provider detects a
- lost connection to the JMS server, it calls the
- <code>onException()</code> method of the registered
- <code>ExceptionListener</code>. Once notified of the problem,
- client code can attempt to reestablish the connection. According
- to the section 4.3.8 of the JMS specification, the provider should
- attempt to resolve connection problems prior to notifying the
- client. The JMS appenders do not implement the
- <code>ExceptionListener</code> interface.
- </p>
-
- <a name="JMSTopicAppender"></a>
- <h3>JMSTopicAppender</h3>
-
- <p>
- The <a href="../xref/ch/qos/logback/classic/net/JMSTopicAppender.html">
- <code>JMSTopicAppender</code></a> acts as a message producer to a publish and subscribe
- Topic.
- </p>
-
- <p>
- Its most important method, <code>doAppend()</code> is listed below:
- </p>
-
-<pre class="prettyprint source">public void append(ILoggingEvent event) {
- if (!isStarted()) {
- return;
- }
-
- try {
- ObjectMessage msg = topicSession.createObjectMessage();
- Serializable so = pst.transform(event);
- msg.setObject(event);
- topicPublisher.publish(msg);
- successiveFailureCount = 0;
- } catch (Exception e) {
- successiveFailureCount++;
- if (successiveFailureCount > SUCCESSIVE_FAILURE_LIMIT) {
- stop();
- }
- addError("Could not publish message in JMSTopicAppender [" + name + "].", e);
- }
-}</pre>
-
- <p>
- The <code>isStarted()</code> method allows the appender to check
- whether prerequisite conditions for its proper functioning, in
- particular the availability of a valid and open
- <code>TopicConnection</code> and a <code>TopicSession</code>,
- are fulfilled. If that is not the case, the append method
- returns without performing any work. If the prerequisite
- conditions are fulfilled, then the method proceeds to publish
- the logging event. This is done by obtaining a
- <code>javax.jms.ObjectMessage</code> from the
- <code>TopicSession</code> and then setting its payload to the
- logging event received as the input parameter. Once the payload
- of the message is set, it is published. Note that the
- <code>ILoggingEvent</code> is transformed to a serializable
- object by a <a
- href="../xref/ch/qos/logback/core/spi/PreSerializationTransformer.html">PreSerializationTransformer</a>. Only
- Serializable objects can be transported within an
- <code>ObjectMessage</code>.
- </p>
-
- <p>
- In summary, the <code>JMSTopicAppender</code> broadcasts messages consisting
- of a serialized <code>LoggingEvent</code> payload over a user-specified
- JMS topic. These events can be processed by a
- <a href="../xref/ch/qos/logback/classic/net/JMSTopicSink.html">
- <code>JMSTopicSink</code></a>
- or a similar consumer. According to JMS specification, the provider
- will asynchronously call the <code>onMessage()</code> of duly registered
- and subscribed <code>javax.jms.MessageListener</code> objects.
- The <code>onMessage()</code> method in <code>JMSTopicSink</code>
- is implemented as follows:
- </p>
-
-<pre class="prettyprint source">public void onMessage(javax.jms.Message message) {
- ILoggingEvent event;
- try {
- if (message instanceof ObjectMessage) {
- ObjectMessage objectMessage = (ObjectMessage) message;
- event = (ILoggingEvent) objectMessage.getObject();
- Logger log = (Logger) LoggerFactory.getLogger(event.getLoggerName());
- log.callAppenders(event);
- } else {
- logger.warn("Received message is of type " + message.getJMSType()
- + ", was expecting ObjectMessage.");
- }
- } catch (JMSException jmse) {
- logger.error("Exception thrown while processing incoming message.", jmse);
- }
-}</pre>
-
- <p>
- The <code>onMessage()</code> method begins by retrieving the logging event's payload.
- It then obtains a Logger with the same name as the logger name of the incoming event.
- The event is then logged through this logger as if it were generated locally,
- by calling its <code>callAppenders()</code> method. The <code>SocketNode</code> class used by
- <code>SimpleSocketServer</code> handles incoming logging events essentially in the same way.
- </p>
-
- <p>
- Some properties are proper to <code>JMSTopicAppender</code>. They are
- listed below.
- </p>
-
- <table class="bodyTable">
- <tr class="a">
- <th>Property Name</th>
- <th>Type</th>
- <th>Description</th>
- </tr>
- <tr class="a">
- <td><b><span class="option">TopicConnectionFactoryBindingName</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- The name of the topic factory. There is no default value for this mandatory option.
- </p>
- </td>
- </tr>
- <tr class="b">
- <td><b><span class="option">TopicBindingName</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- The name of the topic to use. There is no default value for this mandatory option.
- </p>
- </td>
- </tr>
- </table>
-
- <p>
- <code>JMSTopicAppender</code> is rather straightforward to configure:
+ <p>The outcome can be easily changed by instructing the
+ <code>SocketAppender</code> to include caller data by setting the
+ <span class="option">includeCallerData</span> option to
+ true. Using the following command will do the trick:
</p>
- <p class="example">Example: JMSTopicAppender configuration
- (logback-examples/src/main/java/chapters/appenders/conf/logback-JMSTopic.xml)</p>
-
- <span class="asGroovy" onclick="return asGroovy('logback-JMSTopic');">View as .groovy</span>
- <pre id="logback-JMSTopic" class="prettyprint source"><configuration>
+ <pre class="source">java -Dhost=localhost -Dport=6000 -DincludeCallerData=true \
+ chapters.appenders.socket.SocketClient2 src/main/java/chapters/appenders/socket/client1.xml</pre>
- <appender name="Topic"
- class="ch.qos.logback.classic.net.JMSTopicAppender">
- <InitialContextFactoryName>
- org.apache.activemq.jndi.ActiveMQInitialContextFactory
- </InitialContextFactoryName>
- <ProviderURL>tcp://localhost:61616</ProviderURL>
- <TopicConnectionFactoryBindingName>
- ConnectionFactory
- </TopicConnectionFactoryBindingName>
- <TopicBindingName>MyTopic</TopicBindingName>
- </appender>
-
- <root level="DEBUG">
- <appender-ref ref="Topic" />
- </root>
-</configuration></pre>
-
- <a name="JMSQueueAppender"></a>
- <h3>JMSQueueAppender</h3>
-
- <p>
- The <a href="../xref/ch/qos/logback/classic/net/JMSQueueAppender.html">
- <code>JMSQueueAppender</code></a> acts as a message producer to a point-to-point
- Queue.
+ <p>As deserialized events can be handled in the same way as
+ locally generated events, they even can be sent to a second server
+ for further treatment. As an exercise, you may wish to setup two
+ servers where the first server tunnels the events it receives from
+ its clients to a second server.
</p>
- <p>
- It works in a very similar manner to the <code>JMSTopicAppender</code>.
- </p>
-
- <p>
- Some properties are proper to <code>JMSQueueAppender</code>. They are
- listed below.
- </p>
-
- <table class="bodyTable">
- <tr class="a">
- <th>Property Name</th>
- <th>Type</th>
- <th>Description</th>
- </tr>
- <tr class="b">
- <td><b><span class="option">QueueConnectionFactoryBindingName</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- The name of the queue factory. There is no default value for this mandatory option.
- </p>
- </td>
- </tr>
- <tr class="a">
- <td><b><span class="option">QueueBindingName</span></b></td>
- <td><code>String</code></td>
- <td>
- <p>
- The name of the queue to use. There is no default value for this mandatory option.
- </p>
- </td>
- </tr>
- </table>
-
- <p>
- A typical <code>JMSQueueAppender</code> configuration file looks very
- similar to that of a <code>JMSTopicAppender</code>.
- </p>
-
- <p class="example">Example: JMSQueueAppender configuration
- (logback-examples/src/main/java/chapters/appenders/conf/logback-JMSQueue.xml)</p>
-
- <span class="asGroovy" onclick="return asGroovy('logback-JMSQueue');">View as .groovy</span>
- <pre id="logback-JMSQueue" class="prettyprint source"><configuration>
-
- <appender name="Queue"
- class="ch.qos.logback.classic.net.JMSQueueAppender">
- <InitialContextFactoryName>
- org.apache.activemq.jndi.ActiveMQInitialContextFactory
- </InitialContextFactoryName>
- <ProviderURL>tcp://localhost:61616</ProviderURL>
- <QueueConnectionFactoryBindingName>
- ConnectionFactory
- </QueueConnectionFactoryBindingName>
- <QueueBindingName>MyQueue</QueueBindingName>
- </appender>
-
- <root level="DEBUG">
- <appender-ref ref="Queue" />
- </root>
-</configuration></pre>
<h3><a name="SMTPAppender" href="#SMTPAppender">SMTPAppender</a></h3>
@@ -2160,26 +1680,26 @@ Context ctx = new InitialContext(env);</pre>
</tr>
<tr>
- <td><b><span class="option">SMTPHost</span></b></td>
+ <td><b><span class="option">smtpHost</span></b></td>
<td><code>String</code></td>
<td>The host name of the SMTP server. This parameter is mandatory.</td>
</tr>
<tr class="alt">
- <td><b><span class="option">SMTPPort</span></b></td>
+ <td><b><span class="option">smtpPort</span></b></td>
<td><code>int</code></td>
<td>The port where the SMTP server is listening. Defaults to
25.</td>
</tr>
<tr>
- <td><b><span class="option">To</span></b></td>
+ <td><b><span class="option">to</span></b></td>
<td><code>String</code></td>
<td>The email address of the recipient. Multiple recipients
can be specified by using several <To> elements.</td>
</tr>
<tr class="alt">
- <td><b><span class="option">From</span></b></td>
+ <td><b><span class="option">from</span></b></td>
<td><code>String</code></td>
<td>The originator of the email messages sent by
<code>SMTPAppender</code> in the <a
@@ -2192,7 +1712,7 @@ Context ctx = new InitialContext(env);</pre>
</td>
</tr>
<tr>
- <td><b><span class="option">Subject</span></b></td>
+ <td><b><span class="option">subject</span></b></td>
<td><code>String</code></td>
<td>
<p>The subject of the email. It can be any value accepted as
@@ -2206,7 +1726,7 @@ Context ctx = new InitialContext(env);</pre>
that triggered the email message.
</p>
- <p>Assuming the <span class="option">Subject</span> option
+ <p>Assuming the <span class="option">subject</span> option
is set to "Log: %logger - %msg" and the triggering event's
logger is named "com.foo.Bar", and contains the message
"Hello world", then the outgoing email will have the subject
@@ -2219,7 +1739,7 @@ Context ctx = new InitialContext(env);</pre>
<tr class="alt">
- <td><b><span class="option">Discriminator</span></b></td>
+ <td><b><span class="option">discriminator</span></b></td>
<td><code><a href="../xref/ch/qos/logback/core/sift/Discriminator.html">Discriminator</a></code></td>
<td>
<p>With the help of a <span
@@ -2239,7 +1759,7 @@ Context ctx = new InitialContext(env);</pre>
</tr>
<tr >
<td><b><span class="option"><a name="smtpAppender_Evaluator"
- href="#smtpAppender_Evaluator">Evaluator</a></span></b></td>
+ href="#smtpAppender_Evaluator">evaluator</a></span></b></td>
<td><code><a
href="../xref/ch/qos/logback/classic/boolex/IEvaluator.html">IEvaluator</a></code></td>
<td>
@@ -2281,18 +1801,18 @@ Context ctx = new InitialContext(env);</pre>
</tr>
<tr class="alt">
- <td valign="top"><b><span class="option">CyclicBufferTracker</span></b>
+ <td valign="top"><b><span class="option">cyclicBufferTracker</span></b>
</td>
<td><a href="../xref/ch/qos/logback/core/spi/CyclicBufferTracker.html"><code>CyclicBufferTracker</code></a>
</td>
<td>
- <p>As the name indicates a <code>CyclicBufferTracker</code>
- tracks cyclic buffers. It does so based on the keys returned
- by the <span class="option">Discriminator</span> (see
- above).
+ <p>As the name indicates, an instance of the
+ <code>CyclicBufferTracker</code> class tracks cyclic
+ buffers. It does so based on the keys returned by the <span
+ class="option">discriminator</span> (see above).
</p>
- <p>If you don't specify a CyclicBufferTracker, an instance
- of <a
+ <p>If you don't specify a <span
+ class="option">cyclicBufferTracker</span>, an instance of <a
href="../xref/ch/qos/logback/core/spi/CyclicBufferTrackerImpl.html">CyclicBufferTrackerImpl</a>
will be automatically created. By default, this instance
will keep events in a cyclic buffer of size 256. You may
@@ -2302,13 +1822,13 @@ Context ctx = new InitialContext(env);</pre>
</tr>
<tr>
- <td><b><span class="option">Username</span></b></td>
+ <td><b><span class="option">username</span></b></td>
<td><code>String</code></td> <td>The username value to use
during plain user/password authentication. By default, this
parameter is null. </td>
</tr>
<tr class="alt">
- <td><b><span class="option">Password</span></b></td>
+ <td><b><span class="option">password</span></b></td>
<td><code>String</code></td>
<td>The password value to use for plain user/password
authentication. By default, this parameter is null.
@@ -2332,7 +1852,7 @@ Context ctx = new InitialContext(env);</pre>
</tr>
<tr>
- <td><b><span class="option">CharsetEncoding</span></b></td>
+ <td><b><span class="option">charsetEncoding</span></b></td>
<td><code>String</code></td>
<td>The outgoing email message will be encoded in the
designated <a
@@ -2384,13 +1904,13 @@ Context ctx = new InitialContext(env);</pre>
<span class="asGroovy" onclick="return asGroovy('mail1');">View as .groovy</span>
<pre id="mail1" class="prettyprint source"><configuration>
<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <SMTPHost>ADDRESS-OF-YOUR-SMTP-HOST</SMTPHost>
- <To>EMAIL-DESTINATION</To>
- <To>ANOTHER_EMAIL_DESTINATION</To> <!-- additional destinations are possible -->
- <From>SENDER-EMAIL</From>
- <Subject>TESTING: %logger{20} - %m</Subject>
+ <smtpHost>ADDRESS-OF-YOUR-SMTP-HOST</smtpHost>
+ <to>EMAIL-DESTINATION</to>
+ <to>ANOTHER_EMAIL_DESTINATION</to> <!-- additional destinations are possible -->
+ <from>SENDER-EMAIL</from>
+ <subject>TESTING: %logger{20} - %m</subject>
<layout class="ch.qos.logback.classic.PatternLayout">
- <Pattern>%date %-5level %logger{35} - %message%n</Pattern>
+ <pattern>%date %-5level %logger{35} - %message%n</pattern>
</layout>
</appender>
@@ -2401,8 +1921,8 @@ Context ctx = new InitialContext(env);</pre>
<p>Before trying out <code>chapters.appenders.mail.Email</code> application
with the above configuration file, you must set the <span
- class="option">SMTPHost</span>, <span class="option">To</span> and
- <span class="option">From</span> properties to values appropriate for
+ class="option">smtpHost</span>, <span class="option">to</span> and
+ <span class="option">from</span> properties to values appropriate for
your environment. Once you have set the correct values in the
configuration file, execute the following command:
</p>
@@ -2418,16 +1938,16 @@ Context ctx = new InitialContext(env);</pre>
<p><img src="images/chapters/appenders/smtpAppender1.jpg" alt="resulting email"/></p>
<p>In the next example configuration file <em>mail2.xml</em>, the
- values for the <span class="option">SMTPHost</span>, <span
+ values for the <span class="option">smtpHost</span>, <span
class="option">To</span> and <span class="option">From</span>
properties are determined by variable substitution. Here is the
relevant part of <em>mail2.xml</em>.
</p>
<pre class="prettyprint source"><appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <SMTPHost>${smtpHost}</SMTPHost>
- <To>${to}</To>
- <From>${from}</From>
+ <smtpHost>${smtpHost}</smtpHost>
+ <to>${to}</to>
+ <from>${from}</from>
<layout class="ch.qos.logback.classic.html.HTMLLayout"/>
</appender></pre>
@@ -2482,16 +2002,16 @@ Context ctx = new InitialContext(env);</pre>
<p class="example">Example: <code>SMTPAppender</code> configuration with a custom bufer size (logback-examples/src/main/java/chapters/appenders/mail/customBufferSize.xml)</p>
<pre class="prettyprint source"><configuration>
<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <SMTPHost>${smtpHost}</SMTPHost>
- <To>${to}</To>
- <From>${from}</From>
- <Subject>%logger{20} - %m</Subject>
- <Layout class="ch.qos.logback.classic.html.HTMLLayout"/>
+ <smtpHost>${smtpHost}</smtpHost>
+ <to>${to}</to>
+ <from>${from}</from>
+ <subject>%logger{20} - %m</subject>
+ <layout class="ch.qos.logback.classic.html.HTMLLayout"/>
- <b><CyclicBufferTracker class="ch.qos.logback.core.spi.CyclicBufferTrackerImpl"></b>
+ <b><cyclicBufferTracker class="ch.qos.logback.core.spi.CyclicBufferTrackerImpl"></b>
<b><!-- send just one log entry per email --></b>
- <b><BufferSize>1</BufferSize></b>
- <b></CyclicBufferTracker></b>
+ <b><bufferSize>1</bufferSize></b>
+ <b></cyclicBufferTracker></b>
</appender>
<root level="DEBUG">
@@ -2581,11 +2101,11 @@ public class CounterBasedEvaluator extends ContextAwareBase implements EventEval
<span class="asGroovy" onclick="return asGroovy('mail3');">View as .groovy</span>
<pre id="mail3" class="prettyprint source"><configuration>
<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <b><Evaluator class="chapters.appenders.mail.CounterBasedEvaluator" /></b>
- <SMTPHost>${smtpHost}</SMTPHost>
- <To>${to}</To>
- <From>${from}</From>
- <Subject>%logger{20} - %m</Subject>
+ <b><evaluator class="chapters.appenders.mail.CounterBasedEvaluator" /></b>
+ <smtpHost>${smtpHost}</smtpHost>
+ <to>${to}</to>
+ <from>${from}</from>
+ <subject>%logger{20} - %m</subject>
<layout class="ch.qos.logback.classic.html.HTMLLayout"/>
</appender>
@@ -2638,9 +2158,9 @@ logger.error(<b>notifyAdmin</b>,
<!-- you specify add as many markers as you want -->
<marker>TRANSACTION_FAILURE</marker>
</evaluator></b>
- <SMTPHost>${smtpHost}</SMTPHost>
- <To>${to}</To>
- <From>${from}</From>
+ <smtpHost>${smtpHost}</smtpHost>
+ <to>${to}</to>
+ <from>${from}</from>
<layout class="ch.qos.logback.classic.html.HTMLLayout"/>
</appender>
@@ -2742,18 +2262,18 @@ logger.error(<b>notifyAdmin</b>,
<span class="asGroovy" onclick="return asGroovy('gmailSSL');">View as .groovy</span>
<pre id="gmailSSL" class="prettyprint source"><configuration>
<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <b><SMTPHost>smtp.gmail.com</SMTPHost></b>
- <b><SMTPPort>465</SMTPPort></b>
- <b><SSL>true</SSL></b>
- <b><Username>YOUR_USERNAME at gmail.com</Username></b>
- <b><Password>YOUR_GMAIL_PASSWORD</Password></b>
-
- <To>EMAIL-DESTINATION</To>
- <To>ANOTHER_EMAIL_DESTINATION</To> <!-- additional destinations are possible -->
- <From>YOUR_USERNAME at gmail.com</From>
- <Subject>TESTING: %logger{20} - %m</Subject>
+ <b><smtpHost>smtp.gmail.com</smtpHost></b>
+ <b><smtpPort>465</smtpPort></b>
+ <b><ssl>true</ssl></b>
+ <b><username>YOUR_USERNAME at gmail.com</username></b>
+ <b><password>YOUR_GMAIL_PASSWORD</password></b>
+
+ <to>EMAIL-DESTINATION</to>
+ <to>ANOTHER_EMAIL_DESTINATION</to> <!-- additional destinations are possible -->
+ <from>YOUR_USERNAME at gmail.com</from>
+ <subject>TESTING: %logger{20} - %m</subject>
<layout class="ch.qos.logback.classic.PatternLayout">
- <Pattern>%date %-5level %logger{35} - %message%n</Pattern>
+ <pattern>%date %-5level %logger{35} - %message%n</pattern>
</layout>
</appender>
@@ -2774,18 +2294,18 @@ logger.error(<b>notifyAdmin</b>,
<span class="asGroovy" onclick="return asGroovy('gmailSTARTTLS');">View as .groovy</span>
<pre id="gmailSTARTTLS" class="prettyprint source"><configuration>
<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <SMTPHost>smtp.gmail.com</SMTPHost>
- <SMTPPort>587</SMTPPort>
+ <smtpHost>smtp.gmail.com</smtpHost>
+ <smtpPort>587</smtpPort>
<STARTTLS>true</STARTTLS>
- <Username>YOUR_USERNAME at gmail.com</Username>
- <Password>YOUR_GMAIL_xPASSWORD</Password>
+ <username>YOUR_USERNAME at gmail.com</username>
+ <password>YOUR_GMAIL_xPASSWORD</password>
- <To>EMAIL-DESTINATION</To>
- <To>ANOTHER_EMAIL_DESTINATION</To> <!-- additional destinations are possible -->
- <From>YOUR_USERNAME at gmail.com</From>
- <Subject>TESTING: %logger{20} - %m</Subject>
+ <to>EMAIL-DESTINATION</to>
+ <to>ANOTHER_EMAIL_DESTINATION</to> <!-- additional destinations are possible -->
+ <from>YOUR_USERNAME at gmail.com</from>
+ <subject>TESTING: %logger{20} - %m</subject>
<layout class="ch.qos.logback.classic.PatternLayout">
- <Pattern>%date %-5level %logger - %message%n</Pattern>
+ <pattern>%date %-5level %logger - %message%n</pattern>
</layout>
</appender>
@@ -2821,7 +2341,7 @@ logger.error(<b>notifyAdmin</b>,
<span class="asGroovy" onclick="return asGroovy('mailWithMDCBasedDiscriminator');">View as .groovy</span>
<pre id="mailWithMDCBasedDiscriminator" class="prettyprint source"><configuration>
<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
- <SMTPHost>ADDRESS-OF-YOUR-SMTP-HOST</SMTPHost>
+ <smtpHost>ADDRESS-OF-YOUR-SMTP-HOST</smtpHost>
<to>EMAIL-DESTINATION</to>
<from>SENDER-EMAIL</from>
@@ -3428,7 +2948,7 @@ logger.error(<b>notifyAdmin</b>,
<tr class="b">
<td>
<b>
- <span class="option">SyslogHost</span>
+ <span class="option">syslogHost</span>
</b>
</td>
<td>
@@ -3441,7 +2961,7 @@ logger.error(<b>notifyAdmin</b>,
<tr class="a">
<td>
<b>
- <span class="option">Port</span>
+ <span class="option">port</span>
</b>
</td>
<td>
@@ -3455,7 +2975,7 @@ logger.error(<b>notifyAdmin</b>,
<tr class="b">
<td>
<b>
- <span class="option">Facility</span>
+ <span class="option">facility</span>
</b>
</td>
<td>
@@ -3463,11 +2983,11 @@ logger.error(<b>notifyAdmin</b>,
</td>
<td>
<p>
- The <span class="option">Facility</span> is meant to identify
+ The <span class="option">facility</span> is meant to identify
the source of a message.
</p>
<p>
- The <span class="option">Facility</span> option must be set one
+ The <span class="option">facility</span> option must be set one
of the strings <em>KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP,
CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2,
LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7</em>. Case is not important.
@@ -3477,19 +2997,19 @@ logger.error(<b>notifyAdmin</b>,
<tr class="a">
<td>
<b>
- <span class="option">SuffixPattern</span>
+ <span class="option">suffixPattern</span>
</b>
</td>
<td>
<code>String</code>
</td>
<td>
- <p>The <span class="option">SuffixPattern</span> option
+ <p>The <span class="option">suffixPattern</span> option
specifies the format of the non-standardized part of the
message sent to the syslog server. By default, its value is
<em>[%thread] %logger %msg</em>. Any value that a
<code>PatternLayout</code> could use is a correct <span
- class="option">SuffixPattern</span> value.
+ class="option">suffixPattern</span> value.
</p>
</td>
</tr>
@@ -3505,7 +3025,7 @@ logger.error(<b>notifyAdmin</b>,
<p>
Since the format of a syslog request follows rather strict rules, there is no layout
to be used with <code>SyslogAppender</code>. However, the using the
- <span class="option">SuffixPattern</span> option lets the user display whatever
+ <span class="option">suffixPattern</span> option lets the user display whatever
information she wishes.
</p>
@@ -3517,11 +3037,10 @@ logger.error(<b>notifyAdmin</b>,
<span class="asGroovy" onclick="return asGroovy('logback-syslog');">View as .groovy</span>
<pre id="logback-syslog" class="prettyprint source"><configuration>
- <appender name="SYSLOG"
- class="ch.qos.logback.classic.net.SyslogAppender">
- <SyslogHost>remote_home</SyslogHost>
- <Facility>AUTH</Facility>
- <SuffixPattern>[%thread] %logger %msg</SuffixPattern>
+ <appender name="SYSLOG" class="ch.qos.logback.classic.net.SyslogAppender">
+ <syslogHost>remote_home</syslogHost>
+ <facility>AUTH</facility>
+ <suffixPattern>[%thread] %logger %msg</suffixPattern>
</appender>
<root level="DEBUG">
@@ -3583,15 +3102,15 @@ logger.debug("Alice says hello"); </p>
desired discriminator type is
ch.qos.logback.classic.sift.MDCBasedDiscriminator -->
<b><discriminator></b>
- <b><Key><span class="green">userid</span></Key></b>
- <b><DefaultValue>unknown</DefaultValue></b>
+ <b><key><span class="green">userid</span></key></b>
+ <b><defaultValue>unknown</defaultValue></b>
<b></discriminator></b>
<b><sift></b>
<b><appender name="FILE-<span class="green">${userid}</span>" class="ch.qos.logback.core.FileAppender"></b>
- <b><File><span class="green">${userid}</span>.log</File></b>
- <b><Append>false</Append></b>
+ <b><file><span class="green">${userid}</span>.log</file></b>
+ <b><append>false</append></b>
<b><layout class="ch.qos.logback.classic.PatternLayout"></b>
- <b><Pattern>%d [%thread] %level %mdc %logger{35} - %msg%n</Pattern></b>
+ <b><pattern>%d [%thread] %level %mdc %logger{35} - %msg%n</pattern></b>
<b></layout></b>
<b></appender></b>
<b></sift></b>
@@ -3609,7 +3128,7 @@ logger.debug("Alice says hello"); </p>
will use the MDC value associated with the <span
class="option">Key</span> property as a discriminator. If that
value is null, then the value associated with the <span
- class="option">DefaultValue</span> property will be used.
+ class="option">defaultValue</span> property will be used.
</p>
<p>The <code>SiftingAppender</code> is unique in its capacity to
@@ -3789,16 +3308,16 @@ public class CountingConsoleAppender extends AppenderBase<ILoggingEvent> {
<pre class="prettyprint source"><appender name="SMTP"
class="ch.qos.logback.access.net.SMTPAppender">
<layout class="ch.qos.logback.access.html.HTMLLayout">
- <Pattern>%h%l%u%t%r%s%b</Pattern>
+ <pattern>%h%l%u%t%r%s%b</pattern>
</layout>
<b><Evaluator class="ch.qos.logback.access.net.URLEvaluator">
<URL>url1.jsp</URL>
<URL>directory/url2.html</URL>
</Evaluator></b>
- <From>sender_email at host.com</From>
- <SMTPHost>mail.domain.com</SMTPHost>
- <To>recipient_email at host.com</To>
+ <from>sender_email at host.com</from>
+ <smtpHost>mail.domain.com</smtpHost>
+ <to>recipient_email at host.com</to>
</appender></pre>
<p>This way of triggering the email lets users select pages that
@@ -3807,8 +3326,6 @@ public class CountingConsoleAppender extends AppenderBase<ILoggingEvent> {
accessed previously, and any information the user wants to be
included in the email.
</p>
-
-
<a name="AccessDBAppender"></a>
<h3>DBAppender</h3>
@@ -3923,8 +3440,7 @@ public class CountingConsoleAppender extends AppenderBase<ILoggingEvent> {
</tr>
</table>
- <p>
- All properties of classic's <code>DBAppender</code> are available
+ <p>All properties of classic's <code>DBAppender</code> are available
in access' <code>DBAppender</code>. The latter offers one more option,
described below.
</p>
@@ -3950,12 +3466,11 @@ public class CountingConsoleAppender extends AppenderBase<ILoggingEvent> {
</td>
</tr>
</table>
-
- <p>
- Here is a sample configuration that uses <code>DBAppender</code>.
- </p>
- <p class="example">Example: DBAppender configuration (logback-examples/src/main/java/chapters/appenders/conf/access/logback-DB.xml)</em>
+ <p>Here is a sample configuration that uses <code>DBAppender</code>.</p>
+
+ <p class="example">Example: DBAppender configuration <em>(logback-examples/src/main/java/chapters/appenders/conf/access/logback-DB.xml)</em></p>
+
<pre class="prettyprint source"><configuration>
<appender name="DB" class="ch.qos.logback.access.db.DBAppender">
@@ -3983,7 +3498,7 @@ public class CountingConsoleAppender extends AppenderBase<ILoggingEvent> {
uses a designated field in AccessEvent as basis for selecting a
nested appender. If the value of the designated field is null,
then the value specified in the <span
- class="option">DefaultValue</span> property is used.
+ class="option">defaultValue</span> property is used.
</p>
<p>The desginated AccessEvent field can be one of COOKIE,
@@ -4002,13 +3517,13 @@ public class CountingConsoleAppender extends AppenderBase<ILoggingEvent> {
<Key>id</Key>
<FieldName>SESSION_ATTRIBUTE</FieldName>
<AdditionalKey>username</AdditionalKey>
- <DefaultValue>NA</DefaultValue>
+ <defaultValue>NA</defaultValue>
</Discriminator>
<sift>
<appender name="${id}" class="ch.qos.logback.core.FileAppender">
- <File>byUser/${id}.log</File>
+ <file>byUser/${id}.log</file>
<layout class="ch.qos.logback.access.PatternLayout">
- <Pattern>%h %l %u %t \"%r\" %s %b</Pattern>
+ <pattern>%h %l %u %t \"%r\" %s %b</pattern>
</layout>
</appender>
</sift>
diff --git a/logback-site/src/site/pages/manual/configuration.html b/logback-site/src/site/pages/manual/configuration.html
index 1f40973..8d5bd64 100644
--- a/logback-site/src/site/pages/manual/configuration.html
+++ b/logback-site/src/site/pages/manual/configuration.html
@@ -1278,10 +1278,11 @@ public class MyApp3 {
sequence. For example, if <em>java.home.dir</em> system property is
set to <em>/home/xyz</em>, then every occurrence of the sequence
<em>${java.home.dir}</em> will be interpreted as <em>/home/xyz</em>.
- As it often comes in handy, the variable ${HOSTNAME} is
- automatically defined.</p>
+ As they often come in handy, the ${HOSTNAME} and ${CONTEXT_NAME}
+ variables are automatically defined.</p>
- <h4>Properties are inserted into the logger context</h4>
+ <h4><a name="propsPartOfContext"
+ href="#propsPartOfContext">Properties are inserted into the context</a></h4>
<p>Note that the values defined via <code><property></code>
element are actually inserted into the logger context. In other
@@ -1465,6 +1466,12 @@ fileName=myApp.log
defined automatically during configuration.</p>
<!-- ============================================================== -->
+ <h3><a name="context_name" href="#context_name">CONTEXT_NAME property</a></h3>
+
+ <p>When a context is asked for a property named
+ <code>CONTEXT_NAME</code> it returns with its own name.</p>
+
+ <!-- ============================================================== -->
<h3><a name="timestamp" href="#timestamp">Setting a timestamp</a></h3>
@@ -1622,7 +1629,7 @@ fileName=myApp.log
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
- <pattern>%d %contextName %level %msg %logger{50}%n</pattern>
+ <pattern>%d ${CONTEXT_NAME} %level %msg %logger{50}%n</pattern>
</encoder>
</appender>
diff --git a/logback-site/src/site/pages/manual/layouts.html b/logback-site/src/site/pages/manual/layouts.html
index 23e0bf2..133f36e 100644
--- a/logback-site/src/site/pages/manual/layouts.html
+++ b/logback-site/src/site/pages/manual/layouts.html
@@ -1007,12 +1007,36 @@ Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38)</pre>
</table>
+
+ <h4>% character has special meaning</h4>
+
<p>Given that in the context of conversion patterns the percent
sign carries special meaning, in order to include it as a literal,
it needs to be escaped with a backslash, e.g. "%d %p <b>\%</b>
%m%n".
</p>
+ <h4>Restrictions on literals immediately following conversion
+ words</h4>
+
+ <p>In most cases literals naturally contain spaces or other
+ delimiting characters so that they are not confused with
+ conversion words. For example, the pattern
+ "%level [%thread] - %message%n" contains the string
+ literals <code>" ["</code> and
+ <code>"] - "</code>. However, if a character which can
+ be part of a java identifier immediately follows a conversion
+ word, logback's pattern parser will be fooled into thinking that
+ the literal is part of the conversion word. For example, the
+ pattern "%date<b>%nHello</b>" will be interpreted as two
+ conversion words %date and %nHello and since %nHello is not a
+ known conversion word, logback will output %PARSER_ERROR[nHello]
+ for %nHello. If you wish the string literal "Hello" to immediately
+ separate %n and Hello, pass an empty argument list to %n. For
+ example, "%date<b>%n{}</b>Hello" will be interpreted as %date
+ followed by %n followed by the literal "Hello".
+
+ </p>
<h2><a name="formatModifiers" href="#formatModifiers">Format
modifiers</a></h2>
@@ -1181,6 +1205,29 @@ Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38)</pre>
"<code>%.-1level</code>".
</p>
+ <h2><a name="cwOptions" href="#cwOptions">Conversion word
+ options</a></h2>
+
+ <p>
+ 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 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>
+
+ <pre class="prettyprint source">
+ <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+ <layout class="ch.qos.logback.classic.PatternLayout">
+ <param name="Pattern" value="%-4relative [%thread] %-5level - %msg%n \
+ <b>%caller{2, DISP_CALLER_EVAL, OTHER_EVAL_NAME, THIRD_EVAL_NAME}</b>" />
+ </layout>
+ </appender></pre>
<h2><a name="Parentheses" href="#Parentheses">Parentheses are
@@ -1239,30 +1286,6 @@ Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38)</pre>
interpreted as literals.
</p>
- <h3><a name="cwOptions" href="#cwOptions">Options</a></h3>
-
- <p>
- 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 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>
-
- <pre class="prettyprint source">
- <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
- <layout class="ch.qos.logback.classic.PatternLayout">
- <param name="Pattern" value="%-4relative [%thread] %-5level - %msg%n \
- <b>%caller{2, DISP_CALLER_EVAL, OTHER_EVAL_NAME, THIRD_EVAL_NAME}</b>" />
- </layout>
- </appender></pre>
-
-
<h2><a name="Evaluators" href="#Evaluators">Evaluators</a></h2>
<p>As mentioned above, option lists come in handy when a
diff --git a/logback-site/src/site/pages/news.html b/logback-site/src/site/pages/news.html
index a184053..b666ef3 100644
--- a/logback-site/src/site/pages/news.html
+++ b/logback-site/src/site/pages/news.html
@@ -38,6 +38,12 @@
will no longer throw a <code>NullPointerException</code>.
</p>
+ <p>Every context now returns its own name when asked for the
+ property CONTEXT_<code>NAME</code>. This addresses <a
+ href="http://jira.qos.ch/browse/LBCORE-178">LBCORE-178</a> as
+ reported by Michael Osipov.
+ </p>
+
<h3>20th of October, 2010 - Release of version 0.9.26</h3>
-----------------------------------------------------------------------
Summary of changes:
.../classic/joran/action/ConfigurationAction.java | 3 -
.../main/java/ch/qos/logback/core/ContextBase.java | 21 +-
.../java/ch/qos/logback/core/CoreConstants.java | 62 +-
.../ch/qos/logback/core/net/SMTPAppenderBase.java | 43 +-
.../qos/logback/core/net/SocketAppenderBase.java | 15 +-
.../qos/logback/core/pattern/parser/Compiler.java | 4 +-
.../java/ch/qos/logback/core/ContextBaseTest.java | 13 +-
.../logback/core/pattern/parser/ParserTest.java | 12 +
.../main/java/chapters/appenders/mail/mail1.xml | 12 +-
logback-site/src/site/pages/manual/appenders.html | 733 ++++----------------
.../src/site/pages/manual/configuration.html | 15 +-
logback-site/src/site/pages/manual/layouts.html | 71 ++-
logback-site/src/site/pages/news.html | 6 +
13 files changed, 314 insertions(+), 696 deletions(-)
hooks/post-receive
--
Logback: the generic, reliable, fast and flexible logging framework.
More information about the logback-dev
mailing list