Log4j2 API

Reply-To: dev@logging.apache.org Delivered-To: mailing list commits@logging.apache.org Received: (qmail 53747 invoked by uid 99); 29 Apr 2012 16:25:07 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 29 Apr 2012 16:25:07 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 29 Apr 2012 16:25:01 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id AF1D623888CD; Sun, 29 Apr 2012 16:24:39 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1331935 - /logging/log4j/log4j2/trunk/src/site/xdoc/manual/ Date: Sun, 29 Apr 2012 16:24:38 -0000 To: commits@logging.apache.org From: rgoers@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120429162439.AF1D623888CD@eris.apache.org> Author: rgoers Date: Sun Apr 29 16:24:38 2012 New Revision: 1331935 URL: http://svn.apache.org/viewvc?rev=1331935&view=rev Log: change all Log4j2 instances to Log4j 2 Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/api.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/architecture.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/eventlogging.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/extending.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/filters.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/flowtracing.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/index.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/jmx.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/logsep.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/lookups.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/markers.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/messages.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/plugins.xml logging/log4j/log4j2/trunk/src/site/xdoc/manual/thread-context.xml Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/api.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/api.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/api.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/api.xml Sun Apr 29 16:24:38 2012 @@ -18,12 +18,12 @@ - Log4j2 API + Log4j 2 API Ralph Goers -

@@ -75,4 +75,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml Sun Apr 29 16:24:38 2012 @@ -18,7 +18,7 @@ - Log4j2 Appenders + Log4j 2 Appenders Ralph Goers @@ -1006,7 +1006,7 @@

The SocketAppender is an OutputStreamAppender that writes its output to a remote destination specified by a host and port. The data can be sent over either TCP or UDP and can be sent in any format. - The default format is to send a Serialized LogEvent. Log4j2 contains a SocketServer which is capable + The default format is to send a Serialized LogEvent. Log4j 2 contains a SocketServer which is capable of receiving serialized LogEvents and routing them through the logging system on the server.

@@ -1238,4 +1238,4 @@ - \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/architecture.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/architecture.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/architecture.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/architecture.xml Sun Apr 29 16:24:38 2012 @@ -18,7 +18,7 @@ - Log4j2 Architecture + Log4j 2 Architecture Ralph Goers @@ -26,9 +26,9 @@

Log4j uses the classes shown in the diagram below.

Applications using the Log4j2 API will request a Logger with a specific name from the + Log4j 2 Class Relationships +

Applications using the Log4j 2 API will request a Logger with a specific name from the LogManager. The LogManager will locate the appropriate LoggerContext and then obtain the Logger from it. If the Logger must be created it will be associated with the LoggerConfig that contains either a) the same name as the Logger, b) the name of a parent package, or c) the root LoggerConfig. LoggerConfig @@ -45,7 +45,7 @@ developer-chosen criteria.

In Log4j 1.x the Logger Hierarchy was maintained through a relationship between Loggers. - In Log4j2 this relationship no longers exists. Instead, the hierarchy is maintained + In Log4j 2 this relationship no longers exists. Instead, the hierarchy is maintained in the relationship between LoggerConfig objects.

@@ -100,7 +100,7 @@ LogManager.getLogger static method and passing the name of the desired Logger. Further informaiton on the Logging - API can be found atLog4j2 API. + API can be found atLog4j 2 API.

LoggerContext

@@ -183,7 +183,7 @@

LoggerConfigs will be assigned a Log Level. The set of possible - levels includes (TRACE, DEBUG, INFO, WARN, ERROR and FATAL). Note that in Log4j2, the Level is + levels includes (TRACE, DEBUG, INFO, WARN, ERROR and FATAL). Note that in Log4j 2, the Level is an Enum and cannot be sub-classed. Users who desire more granularity are encouraged to use Markers instead. @@ -192,7 +192,7 @@ Log4j 1.x and Logback - both have the concept of "Level Inheritance". In Log4j2, Loggers and LoggerConfigs are two different + both have the concept of "Level Inheritance". In Log4j 2, Loggers and LoggerConfigs are two different objects so this concept is implemented differently. Each Logger references the appropriate LoggerConfig which in turn can reference its parent, thus achieving the same effect.

@@ -671,4 +671,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml Sun Apr 29 16:24:38 2012 @@ -18,7 +18,7 @@ - Configuring Log4j2 + Configuring Log4j 2 Ralph Goers @@ -32,7 +32,7 @@ manage these log statements without the need to modify them manually.

- Configuration of Log4j2 can be accomplished in 1 of 4 ways: + Configuration of Log4j 2 can be accomplished in 1 of 4 ways:

Through a configuration file written in XML or JSON.
Programmatically, by creating a ConfigurationFactory and Configuration implementation.

This page focuses primarily on configuring Log4j through a configuration file. Information on - programmatically configuring Log4j can be found at Extending Log4j2. + programmatically configuring Log4j can be found at Extending Log4j 2.

- Note that unlike Log4j 1.x, the public Log4j2 API does not expose methods to add, modify or remove + Note that unlike Log4j 1.x, the public Log4j 2 API does not expose methods to add, modify or remove appenders and filters or manipulate the configuration in any way.

@@ -637,7 +637,7 @@

- Log4j2 supports the ability to specify tokens in the configuration as references to properties defined + Log4j 2 supports the ability to specify tokens in the configuration as references to properties defined elsewhere. Some of these properties will be resolved when the configuration file is interpreted while others may be passed to components where they will be evaluated at runtime. To accomplish this, Log4j uses variations Apache Commons Lang's @@ -761,13 +761,13 @@ to be able to diagnose problems in the logging configuration or in the configured components. Since logging has not been configured, "normal" logging cannot be used during initialization. In addition, normal logging within appenders could create infinite recursion which Log4j will detect and cause - the recursive events to be ignored. To accomodate this need, the Log4j2 API includes a + the recursive events to be ignored. To accomodate this need, the Log4j 2 API includes a StatusLogger. Components declare an instance of the StatusLogger similar to

- Since StatusLogger implements the Log4j2 API's Logger interface, all the normal Logger methods may + Since StatusLogger implements the Log4j 2 API's Logger interface, all the normal Logger methods may be used.

@@ -884,11 +884,11 @@ log configuration can be used during testing than what is used in production.

- A second approach, which is extensively used by Log4j2, is to set the log4j.configurationFile property + A second approach, which is extensively used by Log4j 2, is to set the log4j.configurationFile property in the method annotated with @BeforeClass in the junit test class. This will allow an arbitrarily named file to be used during the test.

- Log4j2 API + Log4j 2 API Ralph Goers -

@@ -138,4 +138,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/extending.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/extending.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/extending.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/extending.xml Sun Apr 29 16:24:38 2012 @@ -18,7 +18,7 @@ - Extending Log4j2 + Extending Log4j 2 Ralph Goers @@ -57,4 +57,4 @@

\ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/filters.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/filters.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/filters.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/filters.xml Sun Apr 29 16:24:38 2012 @@ -655,4 +655,4 @@ - \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/flowtracing.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/flowtracing.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/flowtracing.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/flowtracing.xml Sun Apr 29 16:24:38 2012 @@ -18,12 +18,12 @@ - Log4j2 API + Log4j 2 API Ralph Goers -

@@ -239,4 +239,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/index.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/index.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/index.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/index.xml Sun Apr 29 16:24:38 2012 @@ -23,7 +23,7 @@ -

Almost every large application includes its own logging or tracing API. In conformance with this rule, the E.U. - + Log4j 1.x has been widely adopted and used in many applications. However, through the years development on it has slowed down. It has become more difficult to maintain due to its need to be compliant with very old versions of Java. Its alternative, SLF4J/Logback made many needed improvements to the - framework. So why bother with Log4j2? Here are a few of the reasons. + framework. So why bother with Log4j 2? Here are a few of the reasons.

Log4j2 is designed to be usable as an audit logging framework. Both Log4j - 1.x and Logback will lose events while reconfiguring. Log4j2 will not. in +

Log4j 2 is designed to be usable as an audit logging framework. Both Log4j + 1.x and Logback will lose events while reconfiguring. Log4j 2 will not. in Logback exceptions in Appenders are never visible to the application. In - Log4j2 Appenders can be configured to allow the exception to percolate + Log4j 2 Appenders can be configured to allow the exception to percolate to the application

Log4j2 uses a Plugin system that makes it extremely easy to extend the +

Log4j 2 uses a Plugin system that makes it extremely easy to extend the framework by adding new Appenders, Filters, Layouts, Lookups, and Pattern Converters without requiring any changes to Log4j.

The performance of Log4j2 is similar to that of Logback. It is slightly +

The performance of Log4j 2 is similar to that of Logback. It is slightly slower in some tests and faster in others.

Due to the Plugin system configuration is simpler. Entries in the configuration do not require a class name to be specified.

@@ -99,20 +99,20 @@ manipulated. Users are free to create their own Message types and write custom Layouts, Filters and Lookups to manipulate them.

Log4j 1.x supports Filters on Appenders. Logback added TurboFilters to allow - filtering of events before they are processed by a Logger. Log4j2 supports + filtering of events before they are processed by a Logger. Log4j 2 supports Filters that can be configured to process events before they are handled by a Logger, as they are processed by a Logger or on an Appender.

Many Logback Appenders do not accept a Layout and will only send data in a - fixed format. Most Log4j2 Appenders accept a Layout, allowing the data to + fixed format. Most Log4j 2 Appenders accept a Layout, allowing the data to be transported in any format desired.

Layouts in Log4j 1.x and Logback return a String. This resulted in the problems discussed at Logback Encoders. - Log4j2 takes the simpler approach that Layouts always return a byte array. This has + Log4j 2 takes the simpler approach that Layouts always return a byte array. This has the advantage that it means they can be used in virtually any Appender, not just the ones that write to an OutputStream.
The Syslog Appender supports both TCP and UDP as well as support for the BSD syslog and the RFC 5424 formats.
Log4j2 takes advantage of Java 5 concurrency support and performs locking +
Log4j 2 takes advantage of Java 5 concurrency support and performs locking at the lowest level possible. Log4j 1.x has known deadlock issues. Many of these are fixed in Logback but many Logback classes still require synchronization at a fairly high level.

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/jmx.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/jmx.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/jmx.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/jmx.xml Sun Apr 29 16:24:38 2012 @@ -29,4 +29,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml Sun Apr 29 16:24:38 2012 @@ -18,7 +18,7 @@ - Log4j2 Layouts + Log4j 2 Layouts Ralph Goers @@ -27,7 +27,7 @@

Layouts are used by Appenders to format the LogEvent into a form that meets the needs of whoever will be consuming the log events. In Log4j 1.x and Logback Layouts were expected to transform an event into a - String. In Log4j2 Layouts return a byte array. This allows the result of the Layout to be useful in + String. In Log4j 2 Layouts return a byte array. This allows the result of the Layout to be useful in many more types of Appenders. However, this means most Layouts need to be configured with a Charset to insure the byte array contains correct values. @@ -766,4 +766,4 @@

- Log4j2 Lookups + Log4j 2 Lookups Ralph Goers @@ -150,4 +150,4 @@ -

- Log4j2 API + Log4j 2 API Ralph Goers -

@@ -94,4 +94,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/messages.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/messages.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/messages.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/messages.xml Sun Apr 29 16:24:38 2012 @@ -18,16 +18,16 @@ - Log4j2 API Messages + Log4j 2 API Messages Ralph Goers -

- Although Log4j2 provides Logger methods that accept Strings and Objects, all of these are ulitmately + Although Log4j 2 provides Logger methods that accept Strings and Objects, all of these are ulitmately captured in Message objects that are then associated with the log event. Applications are free to construct Messages of their own and pass them to the Logger. Although it may seem more expensive than passing the message format and parameters directly to the event, testing has shown that with modern @@ -243,4 +243,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/plugins.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/plugins.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/plugins.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/plugins.xml Sun Apr 29 16:24:38 2012 @@ -18,7 +18,7 @@ - Log4j2 Plugins + Log4j 2 Plugins Ralph Goers @@ -30,14 +30,14 @@ Log4j 1.x allowed for extension by requiring class attributes on most of the configuration declarations. In the case of some elements, notably the PatternLayout, the only way to add new pattern converters was to extend the PatternLayout class and add them via code. One of - goals of Log4j2 is to make extending it extremely easy through the use of plugins. + goals of Log4j 2 is to make extending it extremely easy through the use of plugins.

- In Log4j2 a plugin is declared by adding a Plugin annotation to the class declaration. During + In Log4j 2 a plugin is declared by adding a Plugin annotation to the class declaration. During initialization the Configuration will invoke the PluginManager to locate all the Log4j plugins that are located in the declared packages. As the configuration is processed the appropriate plugins will be automatically configured and - initialized. Log4j2 utilizes a few different types of plugins which are described in the follownig + initialized. Log4j 2 utilizes a few different types of plugins which are described in the follownig sections.

@@ -102,4 +102,4 @@

- \ No newline at end of file + Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/thread-context.xml URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/thread-context.xml?rev=1331935&r1=1331934&r2=1331935&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/thread-context.xml (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/thread-context.xml Sun Apr 29 16:24:38 2012 @@ -18,12 +18,12 @@ - Log4j2 Thread Context + Log4j 2 Thread Context Ralph Goers -

Introduction

Log4j introduced the concept of the Mapped Diagnostic Context or MDC. It has been documented and @@ -36,10 +36,10 @@ SLF4J/Logback followed with its own implementation of the MDC, which is documented very well at Mapped Diagnostic Context.

Log4j2 continues with the idea of the MDC and the NDC but merges them into a single Thread Context. +

Log4j 2 continues with the idea of the MDC and the NDC but merges them into a single Thread Context. The Thread Context Map is the equivalent of the MDC and the Thread Context Stack is the equivalent of the NDC. Although these are frequently used for purposes other than diagnosing problems, they are still - frequently referred to as the MDC and NDC in Log4j2 since they are already well known by those acronyms. + frequently referred to as the MDC and NDC in Log4j 2 since they are already well known by those acronyms.

Fish Tagging

Most real-world systems have to deal with multiple clients simultaneously. In a typical multithreaded @@ -118,4 +118,4 @@

- \ No newline at end of file +