| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-sources/site/markdown/maven-artifacts.md.vm at 2024-03-06 |
| | Rendered using Apache Maven Fluido Skin 1.11.2 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> |
| <title>Log4j – Maven, Ivy, Gradle, and SBT Artifacts</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.2.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-1.11.2.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><a href="../.." id="bannerLeft"><img src="images/ls-logo.jpg" alt="" style="" /></a></div> |
| <div class="pull-right"><a href="./" id="bannerRight"><img src="images/logo.png" alt="" style="" /></a></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2024-03-06<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.23.1</li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://github.com/apache/logging-log4j2" class="externalLink" title="GitHub">GitHub</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="../../" title="Logging Services">Logging Services</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a></li> |
| <li class="pull-right"><a href="https://cwiki.apache.org/confluence/display/LOGGING/Log4j" class="externalLink" title="Logging Wiki">Logging Wiki</a></li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header"><img class="imageLink" src="img/glyphicons/home.png" alt="Apache Log4j™ 2" style="border: 0;" /> Apache Log4j™ 2</li> |
| <li><a href="index.html" title="About"><span class="none"></span>About</a></li> |
| <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> |
| <li><a href="support.html" title="Support"><span class="none"></span>Support</a></li> |
| <li class="active"><a><span class="icon-chevron-down"></span>Maven, Ivy, Gradle Artifacts</a> |
| <ul class="nav nav-list"> |
| <li><a href="maven-artifacts.html#using-log4j-in-your-apache-maven-build" title="Maven"><span class="none"></span>Maven</a></li> |
| <li><a href="maven-artifacts.html#using-log4j-in-your-apache-ivy-build" title="Ivy"><span class="none"></span>Ivy</a></li> |
| <li><a href="maven-artifacts.html#using-log4j-in-your-gradle-build" title="Gradle"><span class="none"></span>Gradle</a></li> |
| <li><a href="maven-artifacts.html#using-log4j-in-your-sbt-build" title="SBT"><span class="none"></span>SBT</a></li> |
| <li><a href="maven-artifacts.html#maven-bill-of-materials-bom" title="Maven Bill of Materials (BOM)"><span class="none"></span>Maven Bill of Materials (BOM)</a></li> |
| <li><a href="maven-artifacts.html#cyclonedx-software-bill-of-materials-sbom" title="CycloneDX Software Bill of Materials (SBOM)"><span class="none"></span>CycloneDX Software Bill of Materials (SBOM)</a></li> |
| <li><a href="maven-artifacts.html#optional-components" title="Optional Components"><span class="none"></span>Optional Components</a></li> |
| <li><a href="maven-artifacts.html#snapshot-builds" title="Snapshot builds"><span class="none"></span>Snapshot builds</a></li> |
| </ul></li> |
| <li><a href="release-notes.html" title="Release Notes"><span class="none"></span>Release Notes</a></li> |
| <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> |
| <li><a href="performance.html" title="Performance"><span class="icon-chevron-right"></span>Performance</a></li> |
| <li><a href="articles.html" title="Articles and Tutorials"><span class="none"></span>Articles and Tutorials</a></li> |
| <li><a href="security.html" title="Security"><span class="icon-chevron-right"></span>Security</a></li> |
| <li class="nav-header"><img class="imageLink" src="img/glyphicons/book.png" alt="Manual" style="border: 0;" /> Manual</li> |
| <li><a href="manual/index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="manual/architecture.html" title="Architecture"><span class="none"></span>Architecture</a></li> |
| <li><a href="manual/api-separation.html" title="API Separation"><span class="none"></span>API Separation</a></li> |
| <li><a href="manual/migration.html" title="Log4j 1.x Migration"><span class="icon-chevron-right"></span>Log4j 1.x Migration</a></li> |
| <li><a href="manual/api.html" title="Java API"><span class="icon-chevron-right"></span>Java API</a></li> |
| <li><a href="../kotlin" title="Kotlin API"><span class="none"></span>Kotlin API</a></li> |
| <li><a href="../scala" title="Scala API"><span class="none"></span>Scala API</a></li> |
| <li><a href="manual/configuration.html" title="Configuration"><span class="icon-chevron-right"></span>Configuration</a></li> |
| <li><a href="manual/usage.html" title="Usage"><span class="icon-chevron-right"></span>Usage</a></li> |
| <li><a href="manual/webapp.html" title="Web Applications and JSPs"><span class="icon-chevron-right"></span>Web Applications and JSPs</a></li> |
| <li><a href="manual/lookups.html" title="Lookups"><span class="icon-chevron-right"></span>Lookups</a></li> |
| <li><a href="manual/appenders.html" title="Appenders"><span class="icon-chevron-right"></span>Appenders</a></li> |
| <li><a href="manual/layouts.html" title="Layouts"><span class="icon-chevron-right"></span>Layouts</a></li> |
| <li><a href="manual/filters.html" title="Filters"><span class="icon-chevron-right"></span>Filters</a></li> |
| <li><a href="manual/async.html" title="Async Loggers"><span class="icon-chevron-right"></span>Async Loggers</a></li> |
| <li><a href="manual/garbagefree.html" title="Garbage-free Logging"><span class="icon-chevron-right"></span>Garbage-free Logging</a></li> |
| <li><a href="manual/jmx.html" title="JMX"><span class="none"></span>JMX</a></li> |
| <li><a href="manual/logsep.html" title="Logging Separation"><span class="none"></span>Logging Separation</a></li> |
| <li><a href="manual/extending.html" title="Extending Log4j"><span class="icon-chevron-right"></span>Extending Log4j</a></li> |
| <li><a href="manual/plugins.html" title="Plugins"><span class="icon-chevron-right"></span>Plugins</a></li> |
| <li><a href="manual/customconfig.html" title="Programmatic Log4j Configuration"><span class="icon-chevron-right"></span>Programmatic Log4j Configuration</a></li> |
| <li><a href="manual/customloglevels.html" title="Custom Log Levels"><span class="icon-chevron-right"></span>Custom Log Levels</a></li> |
| <li class="nav-header"><img class="imageLink" src="img/glyphicons/pencil.png" alt="For Contributors" style="border: 0;" /> For Contributors</li> |
| <li><a href="guidelines.html" title="Guidelines"><span class="none"></span>Guidelines</a></li> |
| <li><a href="javastyle.html" title="Style Guide"><span class="none"></span>Style Guide</a></li> |
| <li class="nav-header"><img class="imageLink" src="img/glyphicons/cog.png" alt="Components" style="border: 0;" /> Components</li> |
| <li><a href="log4j-api.html" title="API"><span class="none"></span>API</a></li> |
| <li><a href="log4j-jcl.html" title="Commons Logging Bridge"><span class="none"></span>Commons Logging Bridge</a></li> |
| <li><a href="log4j-1.2-api.html" title="Log4j 1.2 API"><span class="none"></span>Log4j 1.2 API</a></li> |
| <li><a href="log4j-slf4j-impl.html" title="SLF4J Binding"><span class="none"></span>SLF4J Binding</a></li> |
| <li><a href="log4j-jul.html" title="JUL Adapter"><span class="none"></span>JUL Adapter</a></li> |
| <li><a href="log4j-jpl.html" title="JDK Platform Logger"><span class="none"></span>JDK Platform Logger</a></li> |
| <li><a href="log4j-to-slf4j.html" title="Log4j 2 to SLF4J Adapter"><span class="none"></span>Log4j 2 to SLF4J Adapter</a></li> |
| <li><a href="log4j-flume-ng.html" title="Apache Flume Appender"><span class="none"></span>Apache Flume Appender</a></li> |
| <li><a href="log4j-taglib.html" title="Log4j Tag Library"><span class="none"></span>Log4j Tag Library</a></li> |
| <li><a href="log4j-jmx-gui.html" title="Log4j JMX GUI"><span class="none"></span>Log4j JMX GUI</a></li> |
| <li><a href="log4j-web.html" title="Log4j Web Application Support"><span class="none"></span>Log4j Web Application Support</a></li> |
| <li><a href="log4j-jakarta-web.html" title="Log4j Jakarta Web Application Support"><span class="none"></span>Log4j Jakarta Web Application Support</a></li> |
| <li><a href="log4j-appserver.html" title="Log4j Application Server Integration"><span class="none"></span>Log4j Application Server Integration</a></li> |
| <li><a href="log4j-couchdb.html" title="Log4j CouchDB appender"><span class="none"></span>Log4j CouchDB appender</a></li> |
| <li><a href="log4j-mongodb3.html" title="Log4j MongoDB3 appender"><span class="none"></span>Log4j MongoDB3 appender</a></li> |
| <li><a href="log4j-mongodb4.html" title="Log4j MongoDB4 appender"><span class="none"></span>Log4j MongoDB4 appender</a></li> |
| <li><a href="log4j-cassandra.html" title="Log4j Cassandra appender"><span class="none"></span>Log4j Cassandra appender</a></li> |
| <li><a href="log4j-iostreams.html" title="Log4j IO Streams"><span class="none"></span>Log4j IO Streams</a></li> |
| <li><a href="log4j-docker.html" title="Log4j Docker Support"><span class="none"></span>Log4j Docker Support</a></li> |
| <li><a href="log4j-kubernetes.html" title="Log4j Kubernetes Support"><span class="none"></span>Log4j Kubernetes Support</a></li> |
| <li><a href="log4j-spring-boot.html" title="Log4j Spring Boot"><span class="none"></span>Log4j Spring Boot</a></li> |
| <li><a href="log4j-spring-cloud-config-client.html" title="Log4j Spring Cloud Config Client"><span class="none"></span>Log4j Spring Cloud Config Client</a></li> |
| <li class="nav-header"><img class="imageLink" src="img/glyphicons/tag.png" alt="Related Projects" style="border: 0;" /> Related Projects</li> |
| <li><a href="../../chainsaw/2.x/index.html" title="Chainsaw"><span class="none"></span>Chainsaw</a></li> |
| <li><a href="../../log4cxx/latest_stable/index.html" title="Log4Cxx"><span class="none"></span>Log4Cxx</a></li> |
| <li><a href="../../log4j-audit/latest/index.html" title="Log4j Audit"><span class="none"></span>Log4j Audit</a></li> |
| <li><a href="../kotlin" title="Log4j Kotlin"><span class="none"></span>Log4j Kotlin</a></li> |
| <li><a href="../scala" title="Log4j Scala"><span class="none"></span>Log4j Scala</a></li> |
| <li><a href="../transform" title="Log4j Transform"><span class="none"></span>Log4j Transform</a></li> |
| <li><a href="../../log4net/index.html" title="Log4Net"><span class="none"></span>Log4Net</a></li> |
| <li class="nav-header"><img class="imageLink" src="img/glyphicons/link.png" alt="Legacy Sites" style="border: 0;" /> Legacy Sites</li> |
| <li><a href="../log4j-2.12.4/" title="Log4j 2.12.4 - Java 7"><span class="none"></span>Log4j 2.12.4 - Java 7</a></li> |
| <li><a href="../log4j-2.3.2/" title="Log4j 2.3.2 - Java 6"><span class="none"></span>Log4j 2.3.2 - Java 6</a></li> |
| <li><a href="../1.2/" title="Log4j 1.2 - End of Life"><span class="none"></span>Log4j 1.2 - End of Life</a></li> |
| <li class="nav-header"><img class="imageLink" src="img/glyphicons/info.png" alt="Project Information" style="border: 0;" /> Project Information</li> |
| <li><a href="team.html" title="Project Team"><span class="none"></span>Project Team</a></li> |
| <li><a href="https://www.apache.org/licenses/LICENSE-2.0" class="externalLink" title="Project License"><span class="none"></span>Project License</a></li> |
| <li><a href="https://github.com/apache/logging-log4j2" class="externalLink" title="Source Repository"><span class="none"></span>Source Repository</a></li> |
| <li><a href="runtime-dependencies.html" title="Runtime Dependencies"><span class="none"></span>Runtime Dependencies</a></li> |
| <li><a href="javadoc.html" title="Javadoc"><span class="none"></span>Javadoc</a></li> |
| <li><a href="thanks.html" title="Thanks"><span class="none"></span>Thanks</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10" > |
| <!-- vim: set syn=markdown : --> |
| <!-- |
| 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. |
| --> |
| <h1>Maven, Ivy, Gradle, and SBT Artifacts</h1> |
| <p>Log4j 2 is broken up in an API and an implementation (core), where the API |
| provides the interface that applications should code to. |
| Strictly speaking Log4j core is only needed at runtime and not at compile time.</p> |
| <p>However, below we list Log4j core as a compile time dependency |
| to improve the startup time for <a href="manual/plugins.html">custom plugins</a> as it provides an |
| annotation processor that generates a metadata file to cache plugin information as well |
| as the necessary code to compile against to create custom plugins.</p><section> |
| <h2><a name="Using_Log4j_in_your_Apache_Maven_build"></a>Using Log4j in your Apache Maven build</h2> |
| <p>To build with <a class="externalLink" href="https://maven.apache.org/">Apache Maven</a>, add the dependencies listed below to your |
| <code>pom.xml</code> file.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-api</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-core</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div></section><section> |
| <h2><a name="Using_Log4j_in_your_Apache_Ivy_build"></a>Using Log4j in your Apache Ivy build</h2> |
| <p>To build with <a class="externalLink" href="https://ant.apache.org/ivy/">Apache Ivy</a>, add the dependencies listed below to your |
| <code>ivy.xml</code> file.</p> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-api" rev="2.23.1" /> |
| <dependency org="org.apache.logging.log4j" name="log4j-core" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div></section><section> |
| <h2><a name="Using_Log4j_in_your_Gradle_build"></a>Using Log4j in your Gradle build</h2> |
| <p>To build with <a class="externalLink" href="https://gradle.org/">Gradle</a>, add the dependencies listed below to your |
| <code>build.gradle</code> file.</p> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-api:2.23.1' |
| implementation 'org.apache.logging.log4j:log4j-core:2.23.1' |
| } |
| </code></pre></div></section><section> |
| <h2><a name="Using_Log4j_in_your_SBT_build"></a>Using Log4j in your SBT build</h2> |
| <p>To build with <a class="externalLink" href="http://www.scala-sbt.org/">SBT</a>, add the dependencies listed below to your <code>build.sbt</code> file.</p> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-api" % "2.23.1" |
| libraryDependencies += "org.apache.logging.log4j" % "log4j-core" % "2.23.1" |
| </code></pre></div></section><section> |
| <h2><a name="Maven_Bill_of_Materials_.28BOM.29"></a>Maven Bill of Materials (BOM)</h2> |
| <p>To keep your Log4j module versions aligned, a <a class="externalLink" href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms">Maven Bill of Materials (BOM) POM</a> is provided for your convenience.</p> |
| <p>To use this with Maven, add the dependency listed below to your <code>pom.xml</code> file. |
| Note that the <code><dependencyManagement></code> nesting and the <code><scope>import</scope></code> instruction. |
| This will <i>import</i> all modules bundled with the associated Log4j release to your <code>dependencyManagement</code>. |
| As a result, you don't have to specify versions of the imported modules (<code>log4j-api</code>, <code>log4j-core</code>, etc.) while adding them using <code><dependency></code> elements.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencyManagement> |
| <dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-bom</artifactId> |
| <version>2.23.1</version> |
| <scope>import</scope> |
| <type>pom</type> |
| </dependency> |
| </dependencies> |
| </dependencyManagement> |
| </code></pre></div> |
| <p>Gradle 5.0+ supports importing Maven BOM as a <a class="externalLink" href="https://docs.gradle.org/current/userguide/platforms.html#sub:bom_import">platform</a> |
| to align dependency versions.</p> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation platform('org.apache.logging.log4j:log4j-bom:2.23.1') |
| |
| implementation 'org.apache.logging.log4j:log4j-api' |
| runtimeOnly 'org.apache.logging.log4j:log4j-core' |
| // etc. |
| } |
| </code></pre></div> |
| <p>To use this with Gradle 2.8-4.10, an additional <a class="externalLink" href="https://github.com/spring-gradle-plugins/dependency-management-plugin">Gradle plugin</a> |
| is required for dependency management functionality.</p> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>plugins { |
| id 'io.spring.dependency-management' version '1.0.15.RELEASE' |
| } |
| |
| dependencyManagement { |
| imports { |
| mavenBom 'org.apache.logging.log4j:log4j-bom:2.23.1' |
| } |
| } |
| |
| dependencies { |
| // For Gradle 2.8-3.3 use compile/runtime instead of implementation/runtimeOnly |
| implementation 'org.apache.logging.log4j:log4j-api' |
| runtimeOnly 'org.apache.logging.log4j:log4j-core' |
| // etc. |
| } |
| </code></pre></div></section><section> |
| <h2><a name="CycloneDX_Software_Bill_of_Materials_.28SBOM.29"></a>CycloneDX Software Bill of Materials (SBOM)</h2> |
| <p>Starting with version <code>2.22.0</code>, Log4j distributes <a class="externalLink" href="https://cyclonedx.org/capabilities/sbom/">CycloneDX Software Bill of Materials (SBOM)</a> along with each deployed artifact. |
| This is streamlined by <code>logging-parent</code>, see <a class="externalLink" href="https://logging.apache.org/logging-parent/latest/#cyclonedx-sbom">its website</a> for details.</p></section><section> |
| <h2><a name="Optional_Components"></a>Optional Components</h2> |
| <p>Log4j 2.x contains several optional components that can be included in an application.</p><section> |
| <h3><a name="Log4j_1.x_API_Bridge"></a>Log4j 1.x API Bridge</h3> |
| <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> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-1.2-api</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-1.2-api" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-1.2-api:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-1.2-api" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="Apache_Commons_Logging_Bridge"></a>Apache Commons Logging Bridge</h3> |
| <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> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-jcl</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-jcl" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-jcl:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-jcl" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="SLF4J_Bridge"></a>SLF4J Bridge</h3> |
| <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> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-slf4j-impl</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-slf4j-impl" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-slf4j-impl" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="JUL_Adapter"></a>JUL Adapter</h3> |
| <p>If existing components use Java Util Logging and you want to have this logging routed to Log4j 2, |
| then add the following.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-jul</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-jul" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-jul:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-jul" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="Web_Servlet_Support"></a>Web Servlet Support</h3> |
| <p>In order to properly support and handle the ClassLoader environment and container lifecycle of a web |
| application, an additional module is required. This module is only required at runtime. In addition, if |
| you're using servlets in an OSGi environment, make sure your preferred version of the servlet API is |
| already available (e.g., if you want to use 3.0, but you've also got 2.5 loaded, make sure both are |
| loaded).</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-web</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-web" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-web:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-web" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="Tag_Library"></a>Tag Library</h3> |
| <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> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-taglib</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-taglib" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-taglib:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-taglib" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="Apache_Flume_Appender"></a>Apache Flume Appender</h3> |
| <p>The Flume Appender allows applications to send events to Flume Agents.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-flume-ng</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-flume-ng" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-flume-ng:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-flume-ng" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="Log4j_to_SLF4J_Adapter"></a>Log4j to SLF4J Adapter</h3> |
| <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> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-to-slf4j</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-to-slf4j" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-to-slf4j:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-to-slf4j" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="CouchDB"></a>CouchDB</h3> |
| <p>If your configuration uses the NoSQL CouchDB appender, then add the following.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-couchdb</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-couchdb" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-couchdb:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-couchdb" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="MongoDB"></a>MongoDB</h3> |
| <p>If your configuration uses the NoSQL MongoDB appender, then add the following.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-mongodb</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-mongodb" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-mongodb:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-mongodb" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="Cassandra"></a>Cassandra</h3> |
| <p>If your configuration uses the Cassandra appender, then add the following.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-cassandra</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-cassandra" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-cassandra:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-cassandra" % "2.23.1" |
| </code></pre></div></section><section> |
| <h3><a name="IO_Streams"></a>IO Streams</h3> |
| <p>Log4j IO Streams allow applications to have data that is written to an OutputStream |
| or a Writer be redirected to a Logger, or have data that is read from an InputStream or |
| a Reader be wiretapped by a Logger. To use IO Streams, add the following.</p> |
| <p><code>pom.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency> |
| <groupId>org.apache.logging.log4j</groupId> |
| <artifactId>log4j-iostreams</artifactId> |
| <version>2.23.1</version> |
| </dependency> |
| </dependencies> |
| </code></pre></div> |
| <p><code>ivy.xml</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code><dependencies> |
| <dependency org="org.apache.logging.log4j" name="log4j-iostreams" rev="2.23.1" /> |
| </dependencies> |
| </code></pre></div> |
| <p><code>build.gradle</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>dependencies { |
| implementation 'org.apache.logging.log4j:log4j-iostreams:2.23.1' |
| } |
| </code></pre></div> |
| <p><code>build.sbt</code></p> |
| |
| <div class="source"><pre class="prettyprint"><code>libraryDependencies += "org.apache.logging.log4j" % "log4j-iostreams" % "2.23.1" |
| </code></pre></div></section></section><section> |
| <h2><a name="Snapshot_builds"></a>Snapshot builds</h2> |
| <p>You can access the latest development snapshot by using the Maven repository |
| <code>https://repository.apache.org/snapshots</code> and the current SNAPSHOT version. |
| Generally, the <code>main</code> branch will use the next patch version as its snapshot |
| version regardless of what the next actual version of Log4j will be. For example, |
| if the latest release were <code>2.0</code>, then <code>main</code> would be using the version |
| <code>2.0.1-SNAPSHOT</code>. Always verify with <code>pom.xml</code> in the <code>main</code> branch as described |
| in the <a href="source-repository.html">source repository page</a>.</p><section> |
| <h3><a name="Maven"></a>Maven</h3> |
| <p>Maven users can add the following to their <code>pom.xml</code> to enable snapshots:</p> |
| |
| <div class="source"><pre class="prettyprint"><code><repositories> |
| <repository> |
| <id>apache.snapshots</id> |
| <name>Apache Snapshot Repository</name> |
| <url>https://repository.apache.org/snapshots</url> |
| <releases> |
| <enabled>false</enabled> |
| </releases> |
| </repository> |
| </repositories> |
| </code></pre></div></section><section> |
| <h3><a name="Gradle"></a>Gradle</h3> |
| <p>Gradle users can add the following to their <code>build.gradle</code> to enable snapshots:</p> |
| |
| <div class="source"><pre class="prettyprint"><code>repositories { |
| mavenCentral() |
| maven { url 'https://repository.apache.org/snapshots' } |
| } |
| </code></pre></div></section><section> |
| <h3><a name="SBT"></a>SBT</h3> |
| <p>SBT users can add the following to their <code>build.sbt</code> to enable snapshots:</p> |
| |
| <div class="source"><pre class="prettyprint"><code>resolvers += "Apache Snapshot Repository" at "https://repository.apache.org/snapshots" |
| </code></pre></div></section></section> |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p align="center">Copyright © 1999-2024 <a class="external" href="https://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.<br> |
| Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.</p> |
| </div> |
| </div> |
| </footer> |
| <script> |
| if(anchors) { |
| anchors.add(); |
| } |
| </script> |
| </body> |
| </html> |
