Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.12.1 / manual / migration.html
blob: 3e54167d3a65245e29bdacc0205fa1b91349c9ca [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
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.
-->
<!-- Generated by Apache Maven Doxia at 2019-08-06 -->
<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>Log4j &#x2013; Migrating 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="20190806" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<a href="https://logging.apache.org/">
<img class="logo-left" src="../images/ls-logo.jpg" alt="Apache logging services logo" />
</a>
<img class="logo-right" src="../images/logo.png" alt="Apache log4j logo" />
<div class="clear"></div>
<div class="navbar">
<div class="navbar-inner">
<div class="container-fluid">
<a class="brand" href="https://logging.apache.org/log4j/2.x/">Apache Log4j 2 &trade;</a>
<ul class="nav">
<li>
<a href="https://cwiki.apache.org/confluence/display/LOGGING/Log4j" class="external" target="_blank" title="Logging Wiki">Logging Wiki</a>
</li>
<li>
<a href="https://www.apache.org/" class="external" target="_blank" title="Apache">Apache</a>
</li>
<li>
<a href="../../../" title="Logging Services">Logging Services</a>
</li>
<li>
<a href="https://analysis.apache.org/dashboard/index/org.apache.logging.log4j:log4j" class="external" target="_blank" title="Sonar">Sonar</a>
</li>
<li>
<a href="https://github.com/apache/logging-log4j2" class="external" target="_blank" title="GitHub">GitHub</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="collapsed">
<a href="../javadoc.html" title="Javadoc">Javadoc</a>
</li>
<li class="collapsed">
<a href="../maven-artifacts.html" title="Maven, Ivy, Gradle Artifacts">Maven, Ivy, Gradle Artifacts</a>
</li>
<li class="none">
<a href="../runtime-dependencies.html" title="Runtime Dependencies">Runtime Dependencies</a>
</li>
<li class="none">
<a href="../changelog.html" title="Changelog">Changelog</a>
</li>
<li class="none">
<a href="../faq.html" title="FAQ">FAQ</a>
</li>
<li class="collapsed">
<a href="../performance.html" title="Performance">Performance</a>
</li>
<li class="none">
<a href="../articles.html" title="Articles and Tutorials">Articles and Tutorials</a>
</li>
<li class="none">
<a href="../thanks.html" title="Thanks">Thanks</a>
</li>
</ul>
<ul class="nav nav-list">
<li class="nav-header"><i class="icon-pencil"></i>For Contributors</li>
<li class="none">
<a href="../build.html" title="Building Log4j from Source">Building Log4j from Source</a>
</li>
<li class="none">
<a href="../guidelines.html" title="Guidelines">Guidelines</a>
</li>
<li class="none">
<a href="../javastyle.html" title="Style Guide">Style Guide</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="Java API">Java API</a>
</li>
<li class="none">
<a href="../manual/scala-api.html" title="Scala API">Scala API</a>
</li>
<li class="collapsed">
<a href="../manual/configuration.html" title="Configuration">Configuration</a>
</li>
<li class="collapsed">
<a href="../manual/usage.html" title="Usage">Usage</a>
</li>
<li class="collapsed">
<a href="../manual/webapp.html" title="Web Applications and JSPs">Web Applications and JSPs</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="collapsed">
<a href="../manual/async.html" title="Async Loggers">Async Loggers</a>
</li>
<li class="collapsed">
<a href="../manual/garbagefree.html" title="Garbage-free Logging">Garbage-free Logging</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>
<li class="collapsed">
<a href="../manual/plugins.html" title="Plugins">Plugins</a>
</li>
<li class="collapsed">
<a href="../manual/customconfig.html" title="Programmatic Log4j Configuration">Programmatic Log4j Configuration</a>
</li>
<li class="collapsed">
<a href="../manual/customloglevels.html" title="Custom Log Levels">Custom Log Levels</a>
</li>
</ul>
<ul class="nav nav-list">
<li class="nav-header"><i class="icon-tags"></i>Related Projects</li>
<li class="none">
<a href="http://logging.apache.org/log4j/scala/index.html" class="external" target="_blank" title="Log4j-Scala">Log4j-Scala</a>
</li>
</ul>
<ul class="nav nav-list">
<li class="nav-header"><i class="icon-tags"></i>Legacy</li>
<li class="none">
<a href="http://logging.apache.org/log4j/1.2/" class="external" target="_blank" title="Log4j 1.2">Log4j 1.2</a>
</li>
<li class="none">
<a href="http://logging.apache.org/log4j/log4j-2.3/" class="external" target="_blank" title="Log4j 2.3">Log4j 2.3</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-jul/index.html" title="JUL Adapter">JUL Adapter</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 Appender">Apache Flume Appender</a>
</li>
<li class="none">
<a href="../log4j-taglib/index.html" title="Log4j Tag Library">Log4j Tag Library</a>
</li>
<li class="none">
<a href="../log4j-jmx-gui/index.html" title="Log4j JMX GUI">Log4j JMX GUI</a>
</li>
<li class="none">
<a href="../log4j-web/index.html" title="Log4j Web Application Support">Log4j Web Application Support</a>
</li>
<li class="none">
<a href="../log4j-appserver/index.html" title="Log4j Application Server Integration">Log4j Application Server Integration</a>
</li>
<li class="none">
<a href="../log4j-couchdb/index.html" title="Log4j CouchDB appender">Log4j CouchDB appender</a>
</li>
<li class="none">
<a href="../log4j-mongodb2/index.html" title="Log4j MongoDB2 appender">Log4j MongoDB2 appender</a>
</li>
<li class="none">
<a href="../log4j-mongodb3/index.html" title="Log4j MongoDB3 appender">Log4j MongoDB3 appender</a>
</li>
<li class="none">
<a href="../log4j-cassandra/index.html" title="Log4j Cassandra appender">Log4j Cassandra appender</a>
</li>
<li class="none">
<a href="../log4j-iostreams/index.html" title="Log4j IO Streams">Log4j IO Streams</a>
</li>
<li class="none">
<a href="../log4j-liquibase/index.html" title="Log4j Liquibase Binding">Log4j Liquibase Binding</a>
</li>
<li class="none">
<a href="../log4j-docker/index.html" title="Log4j Docker Support">Log4j Docker Support</a>
</li>
<li class="none">
<a href="../log4j-spring-cloud-config/log4j-spring-cloud-config-client/index.html" title="Log4j Spring Cloud Config Client">Log4j Spring Cloud Config Client</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="../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="../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><a name="Migrating_from_Log4j_1.x"></a>Migrating from Log4j 1.x</h2>
<a name="Log4j1.2Bridge"></a>
<div class="section">
<h3><a name="Using_the_Log4j_1.x_bridge"></a>Using the Log4j 1.x bridge</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 <tt>log4j-1.2-api.jar</tt>. 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 <tt>Appender</tt>s, <tt>LoggerRepository</tt> or <tt>Category</tt>'s
<tt>callAppenders</tt> method.</li>
<li>They must not programmatically configure Log4j.</li>
<li>They must not configure by calling the classes <tt>DOMConfigurator</tt> or
<tt>PropertyConfigurator</tt>.</li>
</ol>
</div>
<div class="section">
<h3><a name="Converting_to_the_Log4j_2_API"></a>Converting to the Log4j 2 API</h3>
<p>For the most part, converting from the Log4j 1.x API to Log4j 2 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>
The main package in version 1 is <tt>org.apache.log4j</tt>, in version 2 it is
<tt>org.apache.logging.log4j</tt>
</li>
<li>
Calls to <tt>org.apache.log4j.Logger.getLogger()</tt> must be modified to
<tt>org.apache.logging.log4j.LogManager.getLogger()</tt>.
</li>
<li>
Calls to <tt>org.apache.log4j.Logger.getRootLogger()</tt> or
<tt>org.apache.log4j.LogManager.getRootLogger()</tt> must be replaced with
<tt>org.apache.logging.log4j.LogManager.getRootLogger()</tt>.</li>
<li>
Calls to <tt>org.apache.log4j.Logger.getLogger</tt> that accept a <tt>LoggerFactory</tt> must
remove the <tt>org.apache.log4j.spi.LoggerFactory</tt> and use one of Log4j 2's other extension
mechanisms.
</li>
<li>
Replace calls to <tt>org.apache.log4j.Logger.getEffectiveLevel()</tt> with
<tt>org.apache.logging.log4j.Logger.getLevel()</tt>.
</li>
<li>
Remove calls to <tt>org.apache.log4j.LogManager.shutdown()</tt>, they are not needed in version 2
because the Log4j Core now automatically adds a JVM shutdown hook on start up to perform any Core
clean ups.
<ol style="list-style-type: decimal">
<li>
Starting in Log4j 2.1, you can specify a custom
<a href="../log4j-core/apidocs/org/apache/logging/log4j/core/util/ShutdownCallbackRegistry.html" class="javadoc">ShutdownCallbackRegistry</a>
to override the default JVM shutdown hook strategy.
</li>
<li>
Starting in Log4j 2.6, you can now use <tt>org.apache.logging.log4j.LogManager.shutdown()</tt>
to initiate shutdown manually.
</li>
</ol>
</li>
<li>
Calls to <tt>org.apache.log4j.Logger.setLevel()</tt> or similar methods are not supported in the API.
Applications should remove these. Equivalent functionality is provided in the Log4j 2 implementation
classes, see <tt>org.apache.logging.log4j.core.config.Configurator.setLevel()</tt>, but may leave
the application susceptible to changes in Log4j 2 internals.
</li>
<li>
Where appropriate, applications should convert to use parameterized messages instead of String
concatenation.
</li>
<li>
<a class="externalLink" href="http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/MDC.html"><tt>org.apache.log4j.MDC</tt></a> and
<a class="externalLink" href="http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/NDC.html"><tt>org.apache.log4j.NDC</tt></a>
have been replaced by the <a href="thread-context.html">Thread Context</a>.
</li>
</ol>
</div>
<div class="section">
<h3><a name="Configuring_Log4j_2"></a>Configuring Log4j 2</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.
</p>
<p>
Note that system property interpolation via the <tt>${foo}</tt> syntax has been extended to allow
property lookups from many different sources. See the <a href="lookups.html">Lookups</a> documentation
for more details. For example, using a lookup for the system property named <tt>catalina.base</tt>,
in Log4j 1.x, the syntax would be <tt>${catalina.base}</tt>. In Log4j 2, the syntax would be
<tt>${sys:catalina.base}</tt>.
</p>
<p>
Log4j 1.x has a XMLLayout which is different from the XmlLayout in Log4j 2, the log4j-1.2-api module
contains a <tt>Log4j1XmlLayout</tt> which produce output in the format as in Log4j 1.x.
The Log4j 1.x <tt>SimpleLayout</tt> can be emulated with PatternLayout &quot;%level - %m%n&quot;.
The Log4j 1.x <tt>TTCCLayout</tt> can be emulated with PatternLayout &quot;%r [%t] %p %c %notEmpty{%ndc }- %m%n&quot;.
</p>
<p>
Both <tt>PatternLayout</tt> and <tt>EnhancedPatternLayout</tt> in Log4j 1.x can be replaced with
<tt>PatternLayout</tt> in Log4j 2. The log4j-1.2-api module contains two pattern conversions &quot;%ndc&quot; and &quot;%properties&quot; which
can be used to emulate &quot;%x&quot; and &quot;%X&quot; in Log4j 1.x PatternLayout (&quot;%x&quot; and %X&quot; in Log4j 2 have a slightly different format).
</p>
<p>
Below are the example configurations for Log4j 1.x and their counterparts in Log4j 2.
</p>
<div class="section">
<h4><a name="Sample_1_-_Simple_configuration_using_a_Console_Appender"></a>Sample 1 - Simple configuration using a Console Appender</h4>
<p>Log4j 1.x XML configuration</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!DOCTYPE log4j:configuration PUBLIC &quot;-//APACHE//DTD LOG4J 1.2//EN&quot; &quot;log4j.dtd&quot;&gt;
&lt;log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'&gt;
&lt;appender name=&quot;STDOUT&quot; class=&quot;org.apache.log4j.ConsoleAppender&quot;&gt;
&lt;layout class=&quot;org.apache.log4j.PatternLayout&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;category name=&quot;org.apache.log4j.xml&quot;&gt;
&lt;priority value=&quot;info&quot; /&gt;
&lt;/category&gt;
&lt;Root&gt;
&lt;priority value =&quot;debug&quot; /&gt;
&lt;appender-ref ref=&quot;STDOUT&quot; /&gt;
&lt;/Root&gt;
&lt;/log4j:configuration&gt;</pre></div>
<p>Log4j 2 XML configuration</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;Configuration&gt;
&lt;Appenders&gt;
&lt;Console name=&quot;STDOUT&quot; target=&quot;SYSTEM_OUT&quot;&gt;
&lt;PatternLayout pattern=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/Console&gt;
&lt;/Appenders&gt;
&lt;Loggers&gt;
&lt;Logger name=&quot;org.apache.log4j.xml&quot; level=&quot;info&quot;/&gt;
&lt;Root level=&quot;debug&quot;&gt;
&lt;AppenderRef ref=&quot;STDOUT&quot;/&gt;
&lt;/Root&gt;
&lt;/Loggers&gt;
&lt;/Configuration&gt;</pre></div>
</div>
<div class="section">
<h4><a name="Sample_2_-_Simple_configuration_using_a_File_Appender_XMLLayout_and_SimpleLayout"></a>Sample 2 - Simple configuration using a File Appender, XMLLayout and SimpleLayout</h4>
<p>Log4j 1.x XML configuration</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!DOCTYPE log4j:configuration PUBLIC &quot;-//APACHE//DTD LOG4J 1.2//EN&quot; &quot;log4j.dtd&quot;&gt;
&lt;log4j:configuration xmlns:log4j=&quot;http://jakarta.apache.org/log4j/&quot;&gt;
&lt;appender name=&quot;A1&quot; class=&quot;org.apache.log4j.FileAppender&quot;&gt;
&lt;param name=&quot;File&quot; value=&quot;A1.log&quot; /&gt;
&lt;param name=&quot;Append&quot; value=&quot;false&quot; /&gt;
&lt;layout class=&quot;org.apache.log4j.xml.XMLLayout&quot; /&gt;
&lt;/appender&gt;
&lt;appender name=&quot;STDOUT&quot; class=&quot;org.apache.log4j.ConsoleAppender&quot;&gt;
&lt;layout class=&quot;org.apache.log4j.SimpleLayout&quot; /&gt;
&lt;/appender&gt;
&lt;category name=&quot;org.apache.log4j.xml&quot;&gt;
&lt;priority value=&quot;debug&quot; /&gt;
&lt;appender-ref ref=&quot;A1&quot; /&gt;
&lt;/category&gt;
&lt;root&gt;
&lt;priority value =&quot;debug&quot; /&gt;
&lt;appender-ref ref=&quot;STDOUT&quot; /&gt;
&lt;/Root&gt;
&lt;/log4j:configuration&gt;</pre></div>
<p>Log4j 2 XML configuration</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;Configuration&gt;
&lt;Appenders&gt;
&lt;File name=&quot;A1&quot; fileName=&quot;A1.log&quot; append=&quot;false&quot;&gt;
&lt;Log4j1XmlLayout /&gt;
&lt;/File&gt;
&lt;Console name=&quot;STDOUT&quot; target=&quot;SYSTEM_OUT&quot;&gt;
&lt;PatternLayout pattern=&quot;%level - %m%n&quot;/&gt;
&lt;/Console&gt;
&lt;/Appenders&gt;
&lt;Loggers&gt;
&lt;Logger name=&quot;org.apache.log4j.xml&quot; level=&quot;debug&quot;&gt;
&lt;AppenderRef ref=&quot;A1&quot;/&gt;
&lt;/Logger&gt;
&lt;Root level=&quot;debug&quot;&gt;
&lt;AppenderRef ref=&quot;STDOUT&quot;/&gt;
&lt;/Root&gt;
&lt;/Loggers&gt;
&lt;/Configuration&gt;</pre></div>
</div>
<div class="section">
<h4><a name="Sample_3_-_SocketAppender"></a>Sample 3 - SocketAppender</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>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!DOCTYPE log4j:configuration PUBLIC &quot;-//APACHE//DTD LOG4J 1.2//EN&quot; &quot;log4j.dtd&quot;&gt;
&lt;log4j:configuration xmlns:log4j=&quot;http://jakarta.apache.org/log4j/&quot;&gt;
&lt;appender name=&quot;A1&quot; class=&quot;org.apache.log4j.net.SocketAppender&quot;&gt;
&lt;param name=&quot;RemoteHost&quot; value=&quot;localhost&quot;/&gt;
&lt;param name=&quot;Port&quot; value=&quot;5000&quot;/&gt;
&lt;param name=&quot;LocationInfo&quot; value=&quot;true&quot;/&gt;
&lt;layout class=&quot;org.apache.log4j.PatternLayout&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%t %-5p %c{2} - %m%n&quot;/&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;appender name=&quot;STDOUT&quot; class=&quot;org.apache.log4j.ConsoleAppender&quot;&gt;
&lt;layout class=&quot;org.apache.log4j.PatternLayout&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;category name=&quot;org.apache.log4j.xml&quot;&gt;
&lt;priority value=&quot;debug&quot;/&gt;
&lt;appender-ref ref=&quot;A1&quot;/&gt;
&lt;/category&gt;
&lt;root&gt;
&lt;priority value=&quot;debug&quot;/&gt;
&lt;appender-ref ref=&quot;STDOUT&quot;/&gt;
&lt;/Root&gt;
&lt;/log4j:configuration&gt;</pre></div>
<p>Log4j 2 XML configuration</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;Configuration&gt;
&lt;Appenders&gt;
&lt;Socket name=&quot;A1&quot; host=&quot;localHost&quot; port=&quot;5000&quot;&gt;
&lt;PatternLayout pattern=&quot;%t %-5p %c{2} - %m%n&quot;/&gt;
&lt;/Socket&gt;
&lt;Console name=&quot;STDOUT&quot; target=&quot;SYSTEM_OUT&quot;&gt;
&lt;PatternLayout pattern=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/Console&gt;
&lt;/Appenders&gt;
&lt;Loggers&gt;
&lt;Logger name=&quot;org.apache.log4j.xml&quot; level=&quot;debug&quot;&gt;
&lt;AppenderRef ref=&quot;A1&quot;/&gt;
&lt;/Logger&gt;
&lt;Root level=&quot;debug&quot;&gt;
&lt;AppenderRef ref=&quot;STDOUT&quot;/&gt;
&lt;/Root&gt;
&lt;/Loggers&gt;
&lt;/Configuration&gt;</pre></div>
</div>
<div class="section">
<h4><a name="Sample_4_-_AsyncAppender_and_TTCCLayout"></a>Sample 4 - AsyncAppender and TTCCLayout</h4>
<p>Log4j 1.x XML configuration using the AsyncAppender.</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!DOCTYPE log4j:configuration PUBLIC &quot;-//APACHE//DTD LOG4J 1.2//EN&quot; &quot;log4j.dtd&quot;&gt;
&lt;log4j:configuration xmlns:log4j=&quot;http://jakarta.apache.org/log4j/&quot; configDebug=&quot;true&quot;&gt;
&lt;appender name=&quot;ASYNC&quot; class=&quot;org.apache.log4j.AsyncAppender&quot;&gt;
&lt;appender-ref ref=&quot;TEMP&quot;/&gt;
&lt;/appender&gt;
&lt;appender name=&quot;TEMP&quot; class=&quot;org.apache.log4j.FileAppender&quot;&gt;
&lt;param name=&quot;File&quot; value=&quot;temp&quot;/&gt;
&lt;layout class=&quot;org.apache.log4j.TTCCLayout&quot;&gt;
&lt;param name=&quot;ThreadPrinting&quot; value=&quot;true&quot;/&gt;
&lt;param name=&quot;CategoryPrefixing&quot; value=&quot;true&quot;/&gt;
&lt;param name=&quot;ContextPrinting&quot; value=&quot;true&quot;/&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;root&gt;
&lt;priority value=&quot;debug&quot;/&gt;
&lt;appender-ref ref=&quot;ASYNC&quot;/&gt;
&lt;/Root&gt;
&lt;/log4j:configuration&gt;</pre></div>
<p>Log4j 2 XML configuration. </p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;Configuration status=&quot;debug&quot;&gt;
&lt;Appenders&gt;
&lt;File name=&quot;TEMP&quot; fileName=&quot;temp&quot;&gt;
&lt;PatternLayout pattern=&quot;%r [%t] %p %c %notEmpty{%ndc }- %m%n&quot;/&gt;
&lt;/File&gt;
&lt;Async name=&quot;ASYNC&quot;&gt;
&lt;AppenderRef ref=&quot;TEMP&quot;/&gt;
&lt;/Async&gt;
&lt;/Appenders&gt;
&lt;Loggers&gt;
&lt;Root level=&quot;debug&quot;&gt;
&lt;AppenderRef ref=&quot;ASYNC&quot;/&gt;
&lt;/Root&gt;
&lt;/Loggers&gt;
&lt;/Configuration&gt;</pre></div>
</div>
<div class="section">
<h4><a name="Sample_5_-_AsyncAppender_with_Console_and_File"></a>Sample 5 - AsyncAppender with Console and File</h4>
<p>Log4j 1.x XML configuration using the AsyncAppender.</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;!DOCTYPE log4j:configuration PUBLIC &quot;-//APACHE//DTD LOG4J 1.2//EN&quot; &quot;log4j.dtd&quot;&gt;
&lt;log4j:configuration xmlns:log4j=&quot;http://jakarta.apache.org/log4j/&quot; configDebug=&quot;true&quot;&gt;
&lt;appender name=&quot;ASYNC&quot; class=&quot;org.apache.log4j.AsyncAppender&quot;&gt;
&lt;appender-ref ref=&quot;TEMP&quot;/&gt;
&lt;appender-ref ref=&quot;CONSOLE&quot;/&gt;
&lt;/appender&gt;
&lt;appender name=&quot;CONSOLE&quot; class=&quot;org.apache.log4j.ConsoleAppender&quot;&gt;
&lt;layout class=&quot;org.apache.log4j.PatternLayout&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;appender name=&quot;TEMP&quot; class=&quot;org.apache.log4j.FileAppender&quot;&gt;
&lt;param name=&quot;File&quot; value=&quot;temp&quot;/&gt;
&lt;layout class=&quot;org.apache.log4j.PatternLayout&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;root&gt;
&lt;priority value=&quot;debug&quot;/&gt;
&lt;appender-ref ref=&quot;ASYNC&quot;/&gt;
&lt;/Root&gt;
&lt;/log4j:configuration&gt;</pre></div>
<p>Log4j 2 XML configuration. Note that the Async Appender should be configured after the appenders it
references. This will allow it to shutdown properly.</p>
<div>
<pre class="prettyprint linenums">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;Configuration status=&quot;debug&quot;&gt;
&lt;Appenders&gt;
&lt;Console name=&quot;CONSOLE&quot; target=&quot;SYSTEM_OUT&quot;&gt;
&lt;PatternLayout pattern=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/Console&gt;
&lt;File name=&quot;TEMP&quot; fileName=&quot;temp&quot;&gt;
&lt;PatternLayout pattern=&quot;%d %-5p [%t] %C{2} (%F:%L) - %m%n&quot;/&gt;
&lt;/File&gt;
&lt;Async name=&quot;ASYNC&quot;&gt;
&lt;AppenderRef ref=&quot;TEMP&quot;/&gt;
&lt;AppenderRef ref=&quot;CONSOLE&quot;/&gt;
&lt;/Async&gt;
&lt;/Appenders&gt;
&lt;Loggers&gt;
&lt;Root level=&quot;debug&quot;&gt;
&lt;AppenderRef ref=&quot;ASYNC&quot;/&gt;
&lt;/Root&gt;
&lt;/Loggers&gt;
&lt;/Configuration&gt;</pre></div>
</div></div>
</div>
</td>
</tr>
</table>
</div>
<div class="footer">
<p>Copyright &copy; 1999-2019 <a class="external" href="https://www.apache.org/">The 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://getbootstrap.com/">Twitter Bootstrap</a>. Icons from <a class="external" href="http://glyphicons.com/">Glyphicons Free</a>.</p>
</div>
</div>
</body>
</html>