rgoers/src/site/xdoc/index.xml - logging-log4j1 - Git at Google

 <?xml version="1.0"?>
 <!--
     Licensed to the Apache Software Foundation (ASF) under one or more
     contributor license agreements.  See the NOTICE file distributed with
     this work for additional information regarding copyright ownership.
     The ASF licenses this file to You under the Apache License, Version 2.0
     (the "License"); you may not use this file except in compliance with
     the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
 -->

 <document>
     <properties>
         <title>Log4J 2.0 Guide</title>
         <author email="rgoers@apache.org">Ralph Goers</author>
     </properties>

     <body>
         <section name="About Log4j 2.0">

             <p>
               Log4Jj 2.0 is an upgrade to Log4j that provides significant improvements over its predecessor, Log4j
               1.x, and provides many of the improvements available in Logback while fixing some inherent problems in
               Logback's architecture.
             </p>

             <p>Some of the features and improvements in Log4j 2.0 are:</p>

             <h3>API Separation</h3>
             <p>
               The API for Log4j is separate from the implementation. It is now clear to application developers
               what classes and methods they can use with compatibility being assured while allowing
               improvements to be made to the implementation.
             </p>
             <h3>Improved Performance</h3>
             <p>
               Faster performance than Log4j 1.x in critical areas and similar performance to Logback in
               most circumstances. See <a href="performance.html">Performance</a> for more information.
             </p>
             <h3>Support for multiple APIs</h3>
             <p>
               While the Log4j 2.0 API will provide the best performance, support for the SL4J and Commons Logging
               APIs are provided.
             </p>
             <h3>Automatic Reloading of Configurations</h3>
             <p>
               Like Logback, Log4j 2.0 can automatically reload its configuration upon modification. Unlike Logback,
               it will do so without losing log events while reconfiguration is taking place.
             </p>
             <h3>Advanced Filtering</h3>
             <p>
               Like Logback, Log4j 2.0 supports filtering based on context data, markers, regular expressions and
               other components in the Log event and can be specified to apply to all events before being passed
               to Loggers or as they pass through appenders. In addition, filters can also be associated with
               Loggers. Unlike Logback, a common Filter class can be used in any of these circumstances.
             </p>
             <h3>Plugin Architecture</h3>
             <p>
               All configurable components are defined as Log4j plugins. As such, no Log4j code must be changed to
               create a new Appender, Layout, Pattern Converter, etc. Log4j will automatically
               recognize properly defined plugins and use them when they are referenced in the configuration.
             </p>
             <h3>Property Support</h3>
             <p>
               Properties can be referenced in the configuration and either be directly replace or passed to the
               underlying component where they can be dynamically resolved. Properties can come from values
               defined in the configuration file, system properties, environment variables, the ThreadContext
               Map, and data present in the event. Users can further customize the property providers by
               adding their own <a href="../lookups.html">Lookup</a> Plugin.
             </p>

         </section>

         <section name="Requirements">
            <p>
              Log4j 2.0 requires Java 5 but has will take advantage of enhancements in Java 6 to improve performance.
              Some features may require optional dependencies. These dependencies are
              specified in the documentation for those features.
           </p>
         </section>

         <section name="News">
           <p>
             Log4j 2.0 is now available. The API for Log4j 2.0 is not compatible with Log4j 1.x, however an adapter
             is available to allow applications to continue to use the Log4j 1.x API. Adapters are also available for
             Commons Logging and SLF4J.
           </p>
         </section>

     </body>
 </document>
	<?xml version="1.0"?>
	<!--
	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	-->

	<document>
	<properties>
	<title>Log4J 2.0 Guide</title>
	<author email="rgoers@apache.org">Ralph Goers</author>
	</properties>

	<body>
	<section name="About Log4j 2.0">

	<p>
	Log4Jj 2.0 is an upgrade to Log4j that provides significant improvements over its predecessor, Log4j
	1.x, and provides many of the improvements available in Logback while fixing some inherent problems in
	Logback's architecture.
	</p>

	<p>Some of the features and improvements in Log4j 2.0 are:</p>

	<h3>API Separation</h3>
	<p>
	The API for Log4j is separate from the implementation. It is now clear to application developers
	what classes and methods they can use with compatibility being assured while allowing
	improvements to be made to the implementation.
	</p>
	<h3>Improved Performance</h3>
	<p>
	Faster performance than Log4j 1.x in critical areas and similar performance to Logback in
	most circumstances. See <a href="performance.html">Performance</a> for more information.
	</p>
	<h3>Support for multiple APIs</h3>
	<p>
	While the Log4j 2.0 API will provide the best performance, support for the SL4J and Commons Logging
	APIs are provided.
	</p>
	<h3>Automatic Reloading of Configurations</h3>
	<p>
	Like Logback, Log4j 2.0 can automatically reload its configuration upon modification. Unlike Logback,
	it will do so without losing log events while reconfiguration is taking place.
	</p>
	<h3>Advanced Filtering</h3>
	<p>
	Like Logback, Log4j 2.0 supports filtering based on context data, markers, regular expressions and
	other components in the Log event and can be specified to apply to all events before being passed
	to Loggers or as they pass through appenders. In addition, filters can also be associated with
	Loggers. Unlike Logback, a common Filter class can be used in any of these circumstances.
	</p>
	<h3>Plugin Architecture</h3>
	<p>
	All configurable components are defined as Log4j plugins. As such, no Log4j code must be changed to
	create a new Appender, Layout, Pattern Converter, etc. Log4j will automatically
	recognize properly defined plugins and use them when they are referenced in the configuration.
	</p>
	<h3>Property Support</h3>
	<p>
	Properties can be referenced in the configuration and either be directly replace or passed to the
	underlying component where they can be dynamically resolved. Properties can come from values
	defined in the configuration file, system properties, environment variables, the ThreadContext
	Map, and data present in the event. Users can further customize the property providers by
	adding their own <a href="../lookups.html">Lookup</a> Plugin.
	</p>

	</section>

	<section name="Requirements">
	<p>
	Log4j 2.0 requires Java 5 but has will take advantage of enhancements in Java 6 to improve performance.
	Some features may require optional dependencies. These dependencies are
	specified in the documentation for those features.
	</p>
	</section>

	<section name="News">
	<p>
	Log4j 2.0 is now available. The API for Log4j 2.0 is not compatible with Log4j 1.x, however an adapter
	is available to allow applications to continue to use the Log4j 1.x API. Adapters are also available for
	Commons Logging and SLF4J.
	</p>
	</section>

	</body>
	</document>