| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- Generated by Apache Maven Doxia at Jan 28, 2013 --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| <title> |
| Migration from Log4j 1.x - Apache Log4j 2</title> |
| <link rel="stylesheet" href="../css/bootstrap.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../css/site.css" type="text/css" /> |
| <script type="text/javascript" src="../js/jquery.min.js"></script> |
| <script type="text/javascript" src="../js/bootstrap.min.js"></script> |
| <script type="text/javascript" src="../js/prettify.min.js"></script> |
| <script type="text/javascript" src="../js/site.js"></script> |
| <meta name="author" content="Ralph Goers" /> |
| <meta name="Date-Revision-yyyymmdd" content="20130128" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| |
| </head> |
| <body class="composite"> |
| <img class="logo-left" src="../images/ls-logo.jpg" alt="Apache logging services logo" /> |
| <img class="logo-right" src="../images/logo.jpg" alt="Apache log4j logo" /> |
| <div class="clear"></div> |
| |
| <div class="navbar"> |
| <div class="navbar-inner"> |
| <div class="container-fluid"> |
| <a class="brand" href="http://logging.apache.org/log4j/2.x/">Apache Log4j 2 ™</a> |
| <ul class="nav"> |
| <li> |
| |
| |
| <a href="http://wiki.apache.org/logging" class="external" target="_blank" title="Logging Wiki">Logging Wiki</a> |
| </li> |
| <li> |
| |
| |
| <a href="http://www.apache.org/" class="external" target="_blank" title="Apache">Apache</a> |
| </li> |
| <li> |
| <a href="../../../" title="Logging Services">Logging Services</a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container-fluid"> |
| <table class="layout-table"> |
| <tr> |
| <td class="sidebar"> |
| <div class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header"><i class="icon-home"></i>Apache Log4j™ 2</li> |
| <li class="none"> |
| <a href="../index.html" title="About">About</a> |
| </li> |
| <li class="none"> |
| <a href="../download.html" title="Download">Download</a> |
| </li> |
| <li class="none"> |
| <a href="../build.html" title="Build and Install">Build and Install</a> |
| </li> |
| <li class="none"> |
| <a href="../changelog.html" title="Changelog">Changelog</a> |
| </li> |
| </ul> |
| <ul class="nav nav-list"> |
| <li class="nav-header"><i class="icon-book"></i>Manual</li> |
| <li class="none"> |
| <a href="../manual/index.html" title="Introduction">Introduction</a> |
| </li> |
| <li class="none"> |
| <a href="../manual/architecture.html" title="Architecture">Architecture</a> |
| </li> |
| <li class="none active"> |
| <a href="../manual/migration.html" title="Log4j 1.x Migration">Log4j 1.x Migration</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/api.html" title="API">API</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/configuration.html" title="Configuration">Configuration</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/plugins.html" title="Plugins">Plugins</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/lookups.html" title="Lookups">Lookups</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/appenders.html" title="Appenders">Appenders</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/layouts.html" title="Layouts">Layouts</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/filters.html" title="Filters">Filters</a> |
| </li> |
| <li class="none"> |
| <a href="../manual/jmx.html" title="JMX">JMX</a> |
| </li> |
| <li class="none"> |
| <a href="../manual/logsep.html" title="Logging Separation">Logging Separation</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../manual/extending.html" title="Extending Log4j">Extending Log4j</a> |
| </li> |
| </ul> |
| <ul class="nav nav-list"> |
| <li class="nav-header"><i class="icon-cog"></i>Components</li> |
| <li class="none"> |
| <a href="../log4j-api/index.html" title="API">API</a> |
| </li> |
| <li class="none"> |
| <a href="../log4j-core/index.html" title="Implementation">Implementation</a> |
| </li> |
| <li class="none"> |
| <a href="../log4j-jcl/index.html" title="Commons Logging Bridge">Commons Logging Bridge</a> |
| </li> |
| <li class="none"> |
| <a href="../log4j-1.2-api/index.html" title="Log4J 1.2 API">Log4J 1.2 API</a> |
| </li> |
| <li class="none"> |
| <a href="../log4j-slf4j-impl/index.html" title="SLF4J Binding">SLF4J Binding</a> |
| </li> |
| <li class="none"> |
| <a href="../log4j-to-slf4j/index.html" title="Log4j 2 to SLF4J Adapter">Log4j 2 to SLF4J Adapter</a> |
| </li> |
| <li class="none"> |
| <a href="../log4j-flume-ng/index.html" title="Apache Flume">Apache Flume</a> |
| </li> |
| <li class="none"> |
| <a href="../log4j-web/index.html" title="Log4j Web">Log4j Web</a> |
| </li> |
| </ul> |
| <ul class="nav nav-list"> |
| <li class="nav-header"><i class="icon-info-sign"></i>Project Information</li> |
| <li class="none"> |
| <a href="../dependencies.html" title="Dependencies">Dependencies</a> |
| </li> |
| <li class="none"> |
| <a href="../dependency-convergence.html" title="Dependency Convergence">Dependency Convergence</a> |
| </li> |
| <li class="none"> |
| <a href="../dependency-management.html" title="Dependency Management">Dependency Management</a> |
| </li> |
| <li class="none"> |
| <a href="../team-list.html" title="Project Team">Project Team</a> |
| </li> |
| <li class="none"> |
| <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a> |
| </li> |
| <li class="none"> |
| <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a> |
| </li> |
| <li class="none"> |
| <a href="../license.html" title="Project License">Project License</a> |
| </li> |
| <li class="none"> |
| <a href="../source-repository.html" title="Source Repository">Source Repository</a> |
| </li> |
| <li class="none"> |
| <a href="../project-summary.html" title="Project Summary">Project Summary</a> |
| </li> |
| </ul> |
| <ul class="nav nav-list"> |
| <li class="nav-header"><i class="icon-cog"></i>Project Reports</li> |
| <li class="none"> |
| <a href="../changes-report.html" title="Changes Report">Changes Report</a> |
| </li> |
| <li class="none"> |
| <a href="../jira-report.html" title="JIRA Report">JIRA Report</a> |
| </li> |
| <li class="none"> |
| <a href="../surefire-report.html" title="Surefire Report">Surefire Report</a> |
| </li> |
| <li class="none"> |
| <a href="../rat-report.html" title="RAT Report">RAT Report</a> |
| </li> |
| </ul> |
| </div> |
| <div id="poweredBy"> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Built by Maven" src="../images/maven-feather.png" /> |
| </a> |
| </div> |
| </td> |
| <td class="content"> |
| <!-- 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. --> |
| |
| <div class="section"><h2>Migration from Log4j 1.x<a name="Migration_from_Log4j_1.x"></a></h2> |
| <a name="The_Log4j_1.x_bridge"></a> |
| <div class="section"><h3>The Log4j 1.x bridge<a name="The_Log4j_1.x_bridge"></a></h3> |
| <p> |
| Perhaps the simplest way to convert to using Log4j 2 is to replace the log4j 1.x jar file with |
| Log4j 2's log4j-1.2-api jar. However, to use this successfully applications must meet the |
| following requirements: |
| </p><ol style="list-style-type: decimal"> |
| <li>They must not access methods and classes internal to the Log4j 1.x implementation such |
| as Appenders, LoggerRepository or Logger's callAppenders method.</li> |
| <li>They must not programmatically configure Log4j.</li> |
| <li>They must not be configuring by calling DomConfigurator or the PropertiesConfigurator.</li> |
| </ol> |
| |
| </div> |
| <div class="section"><h3>Converting to the Log4j 2 API<a name="Converting_to_the_Log4j_2_API"></a></h3> |
| <p>For the most part, converting from the Log4j 1.x API to Log4j 2.0 should be fairly simple. Many |
| of the log statements will require no modification. However, where necessary the following changes must be |
| made. |
| </p><ol style="list-style-type: decimal"> |
| <li>Calls to Logger.getLogger must be modified to LogManager.getLogger.</li> |
| <li>Calls to Logger.getRootLogger or LogManager.getRootLogger must be replaced woth |
| LogManager.getLogger("").</li> |
| <li>Calls to LogManager.getLogger that accept a LoggerFactory must remove the LoggerFactory and |
| use one of Log4j 2's other extension mechanisms.</li> |
| <li>Calls to logger.setLevel or similar methods are not supported in the API. Applications |
| should remove these. Equivalent functionality is provided in the Log4j 2 implementation |
| classes but may leave the application susceptible to changes in Log4j 2 internals.</li> |
| <li>The Log4j 2 API methods accept String messages instead of Objects. Applications that |
| wish to log Objects should either wrap the Object in an ObjectMessage or create a |
| custom Message for the Object.</li> |
| <li>Where appropriate, applications should convert to use parameterized messages instead of |
| String concatenation.</li> |
| </ol> |
| |
| </div> |
| <div class="section"><h3>Configuration<a name="Configuration"></a></h3> |
| <p> |
| Although the Log4j 2 configuration syntax is different than that of Log4j 1.x, most, if not all, of |
| the same functionality is available. Below are the example configurations for Log4j 1.x and their |
| counterparts in Log4j 2. |
| </p> |
| |
| <div class="section"><h4>Sample 1 - Simple configuration using a Console Appender<a name="Sample_1_-_Simple_configuration_using_a_Console_Appender"></a></h4> |
| <p>Log4j 1.x XML configuration</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd"> |
| <log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'> |
| <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender"> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </layout> |
| </appender> |
| <category name="org.apache.log4j.xml"> |
| <priority value="info" /> |
| </category> |
| <root> |
| <priority value ="debug" /> |
| <appender-ref ref="STDOUT" /> |
| </root> |
| </log4j:configuration></pre></div> |
| <p>Log4j 2 XML configuration</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <configuration> |
| <appenders> |
| <Console name="STDOUT" target="SYSTEM_OUT"> |
| <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </Console> |
| </appenders> |
| <loggers> |
| <logger name="org.apache.log4j.xml" level="info"/> |
| <root level="debug"> |
| <appender-ref ref="STDOUT"/> |
| </root> |
| </loggers> |
| </configuration></pre></div> |
| |
| </div><div class="section"><h4>Sample 2 - Simple configuration using a File Appender<a name="Sample_2_-_Simple_configuration_using_a_File_Appender"></a></h4> |
| <p>Log4j 1.x XML configuration</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd"> |
| <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> |
| <appender name="A1" class="org.apache.log4j.FileAppender"> |
| <param name="File" value="A1.log" /> |
| <param name="Append" value="false" /> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%t %-5p %c{2} - %m%n"/> |
| </layout> |
| </appender> |
| <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender"> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </layout> |
| </appender> |
| <category name="org.apache.log4j.xml"> |
| <priority value="debug" /> |
| <appender-ref ref="A1" /> |
| </category> |
| <root> |
| <priority value ="debug" /> |
| <appender-ref ref="STDOUT" /> |
| </root> |
| </log4j:configuration></pre></div> |
| |
| <p>Log4j 2 XML configuration</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <configuration> |
| <appenders> |
| <File name="A1" fileName="A1.log" append="false"> |
| <PatternLayout pattern="%t %-5p %c{2} - %m%n"/> |
| </File> |
| <Console name="STDOUT" target="SYSTEM_OUT"> |
| <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </Console> |
| </appenders> |
| <loggers> |
| <logger name="org.apache.log4j.xml" level="debug"> |
| <appender-ref ref="A1"/> |
| </logger> |
| <root level="debug"> |
| <appender-ref ref="STDOUT"/> |
| </root> |
| </loggers> |
| </configuration></pre></div> |
| |
| </div><div class="section"><h4>Sample 3 - SocketAppender<a name="Sample_3_-_SocketAppender"></a></h4> |
| <p>Log4j 1.x XML configuration. This example from Log4j 1.x is misleading. The SocketAppender does not |
| actually use a Layout. Configuring one will have no effect.</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd"> |
| <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> |
| <appender name="A1" class="org.apache.log4j.net.SocketAppender"> |
| <param name="RemoteHost" value="localhost"/> |
| <param name="Port" value="5000"/> |
| <param name="LocationInfo" value="true"/> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%t %-5p %c{2} - %m%n"/> |
| </layout> |
| </appender> |
| <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender"> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </layout> |
| </appender> |
| <category name="org.apache.log4j.xml"> |
| <priority value="debug"/> |
| <appender-ref ref="A1"/> |
| </category> |
| <root> |
| <priority value="debug"/> |
| <appender-ref ref="STDOUT"/> |
| </root> |
| </log4j:configuration></pre></div> |
| |
| <p>Log4j 2 XML configuration</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <configuration> |
| <appenders> |
| <Socket name="A1" host="localHost" port="5000"> |
| <SerializedLayout/> |
| </Socket> |
| <Console name="STDOUT" target="SYSTEM_OUT"> |
| <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </Console> |
| </appenders> |
| <loggers> |
| <logger name="org.apache.log4j.xml" level="debug"> |
| <appender-ref ref="A1"/> |
| </logger> |
| <root level="debug"> |
| <appender-ref ref="STDOUT"/> |
| </root> |
| </loggers> |
| </configuration></pre></div> |
| |
| </div><div class="section"><h4>Sample 4 - AsynchAppender<a name="Sample_4_-_AsynchAppender"></a></h4> |
| <p>Log4j 1.x XML configuration using the AsynchAppender.</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd"> |
| <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" configDebug="true"> |
| <appender name="ASYNC" class="org.apache.log4j.AsyncAppender"> |
| <appender-ref ref="TEMP"/> |
| </appender> |
| <appender name="TEMP" class="org.apache.log4j.FileAppender"> |
| <param name="File" value="temp"/> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </layout> |
| </appender> |
| <root> |
| <priority value="debug"/> |
| <appender-ref ref="ASYNC"/> |
| </root> |
| </log4j:configuration></pre></div> |
| |
| <p>Log4j 2 XML configuration. </p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <configuration status="debug"> |
| <appenders> |
| <File name="TEMP" fileName="temp"> |
| <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </File> |
| <Asynch name="ASYNC"> |
| <appender-ref ref="TEMP"/> |
| </Asynch> |
| </appenders> |
| <loggers> |
| <root level="debug"> |
| <appender-ref ref="ASYNC"/> |
| </root> |
| </loggers> |
| </configuration></pre></div> |
| |
| |
| </div><div class="section"><h4>Sample 5 - AsynchAppender with Console and File<a name="Sample_5_-_AsynchAppender_with_Console_and_File"></a></h4> |
| <p>Log4j 1.x XML configuration using the AsynchAppender.</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd"> |
| <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" configDebug="true"> |
| <appender name="ASYNC" class="org.apache.log4j.AsyncAppender"> |
| <appender-ref ref="TEMP"/> |
| <appender-ref ref="CONSOLE"/> |
| </appender> |
| <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender"> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </layout> |
| </appender> |
| <appender name="TEMP" class="org.apache.log4j.FileAppender"> |
| <param name="File" value="temp"/> |
| <layout class="org.apache.log4j.PatternLayout"> |
| <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </layout> |
| </appender> |
| <root> |
| <priority value="debug"/> |
| <appender-ref ref="ASYNC"/> |
| </root> |
| </log4j:configuration></pre></div> |
| |
| <p>Log4j 2 XML configuration. Note that the Asynch Appender should be configured after the appenders it |
| references. This will allow it to shutdown properly.</p> |
| <div class="prettyprint linenums"><pre><?xml version="1.0" encoding="UTF-8"?> |
| <configuration status="debug"> |
| <appenders> |
| <Console name="CONSOLE" target="SYSTEM_OUT"> |
| <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </Console> |
| <File name="TEMP" fileName="temp"> |
| <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/> |
| </File> |
| <Asynch name="ASYNC"> |
| <appender-ref ref="TEMP"/> |
| <appender-ref ref="CONSOLE"/> |
| </Asynch> |
| </appenders> |
| <loggers> |
| <root level="debug"> |
| <appender-ref ref="ASYNC"/> |
| </root> |
| </loggers> |
| </configuration></pre></div> |
| </div></div> |
| </div> |
| |
| |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="footer"> |
| <p>Copyright © 1999-2013 <a class="external" href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</p> |
| <p>Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.</p> |
| <p>Site powered by <a class="external" href="http://twitter.github.com/bootstrap/">Twitter Bootstrap</a>. Icons from <a class="external" href="http://glyphicons.com/">Glyphicons Free</a>.</p> |
| </div> |
| </div> |
| </body> |
| </html> |
