blob: ddb589599090ac6485672a3b8c05fb06d1050bbe [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 Feb 9, 2014 -->
<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>
Maven and Ivy Artifacts - 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="Date-Revision-yyyymmdd" content="20140209" />
<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 &trade;</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>
<li>
<a href="https://analysis.apache.org/dashboard/index/org.apache.logging.log4j:log4j" class="external" target="_blank" title="Sonar">Sonar</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 active">
<a href="maven-artifacts.html" title="Maven and Ivy">Maven and Ivy</a>
</li>
<li class="none">
<a href="build.html" title="Build">Build</a>
</li>
<li class="none">
<a href="changelog.html" title="Changelog">Changelog</a>
</li>
<li class="collapsed">
<a href="javadoc.html" title="Javadoc">Javadoc</a>
</li>
<li class="none">
<a href="faq.html" title="FAQ">FAQ</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">
<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/webapp.html" title="Web Applications and JSPs">Web Applications and JSPs</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="collapsed">
<a href="manual/async.html" title="Async Loggers">Async Loggers</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 NG Appender">Apache Flume NG 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>
</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>Maven and Ivy Artifacts<a name="Maven_and_Ivy_Artifacts"></a></h2>
<div class="section"><h3>Using Log4j in your Apache Maven build<a name="Using_Log4j_in_your_Apache_Maven_build"></a></h3>
<p>
To build with <a class="externalLink" href="http://maven.apache.org/">Apache Maven</a>, add the dependencies listed below to your
<tt>pom.xml</tt> file.
</p>
<tt>pom.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-api&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-core&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div>
</div>
<div class="section"><h3>Using Log4j in your Apache Ivy build<a name="Using_Log4j_in_your_Apache_Ivy_build"></a></h3>
<p>
To build with <a class="externalLink" href="https://ant.apache.org/ivy/">Apache Ivy</a>, add the dependencies listed below to your
<tt>ivy.xml</tt> file.
</p>
<tt>ivy.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-api&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-core&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;/dependencies&gt;
</pre></div>
</div>
<div class="section"><h3>Optional Components<a name="Optional_Components"></a></h3>
<p>
Log4j 2.x contains several optional components that can be included in an application.
</p>
<div class="section"><h4>Log4j 1.x API Bridge<a name="Log4j_1.x_API_Bridge"></a></h4>
<p>If existing components use Log4j 1.x and you want to have this logging routed to Log4j 2,
then remove any log4j 1.x dependencies and add the following.
</p>
<tt>pom.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-1.2-api&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div>
<tt>ivy.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-1.2-api&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;/dependencies&gt;
</pre></div>
</div><div class="section"><h4>Apache Commons Logging Bridge<a name="Apache_Commons_Logging_Bridge"></a></h4>
<p>If existing components use Apache Commons Logging 1.x and you want to have this logging routed to Log4j 2,
then add the following but do not remove any Commons Logging 1.x dependencies.
</p>
<tt>pom.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-jcl&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div>
<tt>ivy.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-jcl&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;/dependencies&gt;
</pre></div>
</div><div class="section"><h4>SLF4J Bridge<a name="SLF4J_Bridge"></a></h4>
<p>If existing components use SLF4J and you want to have this logging routed to Log4j 2, then add the
following but do not remove any SLF4J dependencies.
</p>
<tt>pom.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-slf4j-impl&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div>
<tt>ivy.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-slf4j-impl&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;/dependencies&gt;
</pre></div>
</div><div class="section"><h4>Tag Library<a name="Tag_Library"></a></h4>
<p>The Log4j Log Tag Library creates the capability of inserting log statements in JSPs without
the use of Java scripting. It uses the standard Log4j 2 API to log messages according to
your Log4j configuration.
</p>
<tt>pom.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-taglib&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div>
<tt>ivy.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-taglib&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;/dependencies&gt;
</pre></div>
</div><div class="section"><h4>Apache Flume NG Appender<a name="Apache_Flume_NG_Appender"></a></h4>
<p>The Flume NG Appender allows applications to send events to Flume NG Agents.</p>
<tt>pom.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-flume-ng&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div>
<tt>ivy.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-flume-ng&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;/dependencies&gt;
</pre></div>
</div><div class="section"><h4>Log4j to SLF4J Adapter<a name="Log4j_to_SLF4J_Adapter"></a></h4>
<p>The Log4j 2 to SLF4J Adapter allows applications coded to the Log4j 2 API to be routed to SLF4J. Use of this
adapter may cause some loss of performance as the Log4j 2 Messages must be formatted before they can be passed
to SLF4J. The SLF4J Bridge must NOT be on the class path when this is in use.</p>
<tt>pom.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.logging.log4j&lt;/groupId&gt;
&lt;artifactId&gt;log4j-to-slf4j&lt;/artifactId&gt;
&lt;version&gt;2.0-rc1&lt;/version&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre></div>
<tt>ivy.xml</tt>
<div class="prettyprint linenums"><pre>
&lt;dependencies&gt;
&lt;dependency org=&quot;org.apache.logging.log4j&quot; name=&quot;log4j-to-slf4j&quot; rev=&quot;2.0-rc1&quot; /&gt;
&lt;/dependencies&gt;
</pre></div>
</div></div>
</div>
</td>
</tr>
</table>
</div>
<div class="footer">
<p>Copyright &copy; 1999-2014 <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>