| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.1 from src/site/xdoc/manual/api.xml at 2019-12-11 |
| | Rendered using Apache Maven Fluido Skin 1.8 |
| --> |
| <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.9.1" /> |
| <meta name="author" content="Ralph Goers" /> |
| <meta name="author" content="Gary Gregory" /> |
| <title>Log4j – Log4j 2 API</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.8.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.8.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><a href="http://logging.apache.org" id="bannerLeft"><img src="../images/ls-logo.jpg" alt=""/></a></div> |
| <div class="pull-right"><a href="http://logging.apache.org/log4j/2.x" id="bannerRight"><img src="../images/logo.png" alt=""/></a></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2019-12-11<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.13.0</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="https://analysis.apache.org/dashboard/index/org.apache.logging.log4j:log4j" class="externalLink" title="Sonar">Sonar</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" 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="../javadoc.html" title="Javadoc"><span class="icon-chevron-right"></span>Javadoc</a></li> |
| <li><a href="../maven-artifacts.html" title="Maven, Ivy, Gradle Artifacts"><span class="icon-chevron-right"></span>Maven, Ivy, Gradle Artifacts</a></li> |
| <li><a href="../runtime-dependencies.html" title="Runtime Dependencies"><span class="none"></span>Runtime Dependencies</a></li> |
| <li><a href="../changelog.html" title="Changelog"><span class="none"></span>Changelog</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="../thanks.html" title="Thanks"><span class="none"></span>Thanks</a></li> |
| <li class="nav-header"><img class="imageLink" src="../img/glyphicons/pencil.png" alt="For Contributors" border="0"/> For Contributors</li> |
| <li><a href="../build.html" title="Building Log4j from Source"><span class="none"></span>Building Log4j from Source</a></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/book.png" alt="Manual" 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/compatibility.html" title="Log4j 1.x Compatibility"><span class="none"></span>Log4j 1.x Compatibility</a></li> |
| <li><a href="../manual/migration.html" title="Log4j 1.x Migration"><span class="none"></span>Log4j 1.x Migration</a></li> |
| <li class="active"><a href="#"><span class="icon-chevron-down"></span>Java API</a> |
| <ul class="nav nav-list"> |
| <li><a href="../manual/logbuilder.html" title="Log Builder"><span class="none"></span>Log Builder</a></li> |
| <li><a href="../manual/flowtracing.html" title="Flow Tracing"><span class="none"></span>Flow Tracing</a></li> |
| <li><a href="../manual/markers.html" title="Markers"><span class="none"></span>Markers</a></li> |
| <li><a href="../manual/eventlogging.html" title="Event Logging"><span class="none"></span>Event Logging</a></li> |
| <li><a href="../manual/messages.html" title="Messages"><span class="none"></span>Messages</a></li> |
| <li><a href="../manual/thread-context.html" title="ThreadContext"><span class="none"></span>ThreadContext</a></li> |
| </ul></li> |
| <li><a href="../manual/scala-api.html" 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/tag.png" alt="Related Projects" border="0"/> Related Projects</li> |
| <li><a href="http://logging.apache.org/log4j/scala/index.html" class="externalLink" title="Log4j-Scala"><span class="none"></span>Log4j-Scala</a></li> |
| <li class="nav-header"><img class="imageLink" src="../img/glyphicons/link.png" alt="Legacy Sites" border="0"/> Legacy Sites</li> |
| <li><a href="http://logging.apache.org/log4j/1.2/" class="externalLink" title="Log4j 1.2 - End of Life"><span class="none"></span>Log4j 1.2 - End of Life</a></li> |
| <li><a href="http://logging.apache.org/log4j/log4j-2.3/" class="externalLink" title="Log4j 2.3 - Java 6"><span class="none"></span>Log4j 2.3 - Java 6</a></li> |
| <li><a href="http://logging.apache.org/log4j/log4j-2.12.1" class="externalLink" title="Log4j 2.12.1 - Java 7"><span class="none"></span>Log4j 2.12.1 - Java 7</a></li> |
| <li class="nav-header"><img class="imageLink" src="../img/glyphicons/cog.png" alt="Components" border="0"/> Components</li> |
| <li><a href="../log4j-api/index.html" title="API"><span class="none"></span>API</a></li> |
| <li><a href="../log4j-core/index.html" title="Implementation"><span class="none"></span>Implementation</a></li> |
| <li><a href="../log4j-jcl/index.html" title="Commons Logging Bridge"><span class="none"></span>Commons Logging Bridge</a></li> |
| <li><a href="../log4j-1.2-api/index.html" title="Log4j 1.2 API"><span class="none"></span>Log4j 1.2 API</a></li> |
| <li><a href="../log4j-slf4j-impl/index.html" title="SLF4J Binding"><span class="none"></span>SLF4J Binding</a></li> |
| <li><a href="../log4j-jul/index.html" title="JUL Adapter"><span class="none"></span>JUL Adapter</a></li> |
| <li><a href="../log4j-to-slf4j/index.html" title="Log4j 2 to SLF4J Adapter"><span class="none"></span>Log4j 2 to SLF4J Adapter</a></li> |
| <li><a href="../log4j-flume-ng/index.html" title="Apache Flume Appender"><span class="none"></span>Apache Flume Appender</a></li> |
| <li><a href="../log4j-taglib/index.html" title="Log4j Tag Library"><span class="none"></span>Log4j Tag Library</a></li> |
| <li><a href="../log4j-jmx-gui/index.html" title="Log4j JMX GUI"><span class="none"></span>Log4j JMX GUI</a></li> |
| <li><a href="../log4j-web/index.html" title="Log4j Web Application Support"><span class="none"></span>Log4j Web Application Support</a></li> |
| <li><a href="../log4j-appserver/index.html" title="Log4j Application Server Integration"><span class="none"></span>Log4j Application Server Integration</a></li> |
| <li><a href="../log4j-couchdb/index.html" title="Log4j CouchDB appender"><span class="none"></span>Log4j CouchDB appender</a></li> |
| <li><a href="../log4j-mongodb2/index.html" title="Log4j MongoDB2 appender"><span class="none"></span>Log4j MongoDB2 appender</a></li> |
| <li><a href="../log4j-mongodb3/index.html" title="Log4j MongoDB3 appender"><span class="none"></span>Log4j MongoDB3 appender</a></li> |
| <li><a href="../log4j-cassandra/index.html" title="Log4j Cassandra appender"><span class="none"></span>Log4j Cassandra appender</a></li> |
| <li><a href="../log4j-iostreams/index.html" title="Log4j IO Streams"><span class="none"></span>Log4j IO Streams</a></li> |
| <li><a href="../log4j-liquibase/index.html" title="Log4j Liquibase Binding"><span class="none"></span>Log4j Liquibase Binding</a></li> |
| <li><a href="../log4j-docker/index.html" title="Log4j Docker Support"><span class="none"></span>Log4j Docker Support</a></li> |
| <li><a href="../log4j-spring-cloud-config/log4j-spring-cloud-config-client/index.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/info.png" alt="Project Information" border="0"/> Project Information</li> |
| <li><a href="../dependency-convergence.html" title="Dependency Convergence"><span class="none"></span>Dependency Convergence</a></li> |
| <li><a href="../dependency-management.html" title="Dependency Management"><span class="none"></span>Dependency Management</a></li> |
| <li><a href="../team-list.html" title="Project Team"><span class="none"></span>Project Team</a></li> |
| <li><a href="../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li> |
| <li><a href="../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a></li> |
| <li><a href="../license.html" title="Project License"><span class="none"></span>Project License</a></li> |
| <li><a href="../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a></li> |
| <li><a href="../project-summary.html" title="Project Summary"><span class="none"></span>Project Summary</a></li> |
| <li class="nav-header"><img class="imageLink" src="../img/glyphicons/layers.png" alt="Project Reports" border="0"/> Project Reports</li> |
| <li><a href="../changes-report.html" title="Changes Report"><span class="none"></span>Changes Report</a></li> |
| <li><a href="../jira-report.html" title="JIRA Report"><span class="none"></span>JIRA Report</a></li> |
| <li><a href="../rat-report.html" title="RAT Report"><span class="none"></span>RAT Report</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <hr /> |
| <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" > |
| |
| |
| <section> |
| <h2><a name="Log4j_2_API"></a>Log4j 2 API</h2> |
| <a name="Overview"></a> |
| <section> |
| <h3><a name="Overview"></a>Overview</h3> |
| |
| <p> |
| The Log4j 2 API provides the interface that applications should code to and provides the |
| adapter components required for implementers to create a logging implementation. Although Log4j 2 |
| is broken up between an API and an implementation, the primary purpose of doing so was not to |
| allow multiple implementations, although that is certainly possible, but to clearly define |
| what classes and methods are safe to use in "normal" application code. |
| </p> |
| <section> |
| <h4><a name="Hello_World.21"></a>Hello World!</h4> |
| |
| <p> |
| No introduction would be complete without the customary Hello, World example. Here is ours. First, |
| a Logger with the name "HelloWorld" is obtained from the |
| <a href="../log4j-api/apidocs/org/apache/logging/log4j/LogManager.html">LogManager</a>. |
| Next, the logger is used to write the "Hello, World!" message, however the message will be written |
| only if the Logger is configured to allow informational messages. |
| </p> |
| |
| <div> |
| <pre class="prettyprint linenums">import org.apache.logging.log4j.LogManager; |
| import org.apache.logging.log4j.Logger; |
| |
| public class HelloWorld { |
| private static final Logger logger = LogManager.getLogger("HelloWorld"); |
| public static void main(String[] args) { |
| logger.info("Hello, World!"); |
| } |
| }</pre></div> |
| |
| <p> |
| The output from the call to logger.info() will vary significantly depending on the configuration |
| used. See the <a href="./configuration.html">Configuration</a> section for more details. |
| </p> |
| </section><section> |
| <h4><a name="Substituting_Parameters"></a>Substituting Parameters</h4> |
| |
| <p> |
| Frequently the purpose of logging is to provide information about what is happening in the system, |
| which requires including information about the objects being manipulated. In Log4j 1.x this could |
| be accomplished by doing: |
| </p> |
| |
| <div> |
| <pre class="prettyprint linenums">if (logger.isDebugEnabled()) { |
| logger.debug("Logging in user " + user.getName() + " with birthday " + user.getBirthdayCalendar()); |
| }</pre></div> |
| |
| <p> |
| Doing this repeatedly has the effect of making the code feel like it is more about logging than the |
| actual task at hand. In addition, it results in the logging level being checked twice; once on the |
| call to isDebugEnabled and once on the debug method. A better alternative would be: |
| </p> |
| |
| <div> |
| <pre class="prettyprint">logger.debug("Logging in user {} with birthday {}", user.getName(), user.getBirthdayCalendar());</pre></div> |
| |
| <p> |
| With the code above the logging level will only be checked once and the String construction will |
| only occur when debug logging is enabled. |
| </p> |
| </section><section> |
| <h4><a name="Formatting_Parameters"></a>Formatting Parameters</h4> |
| |
| <p> |
| Formatter Loggers leave formatting up to you if toString() is not what you want. |
| To facilitate formatting, you can use the same format strings as Java's |
| <a class="externalLink" href="http://docs.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax">Formatter</a>. |
| For example: |
| </p> |
| |
| <div> |
| <pre class="prettyprint linenums">public static Logger logger = LogManager.getFormatterLogger("Foo"); |
| |
| logger.debug("Logging in user %s with birthday %s", user.getName(), user.getBirthdayCalendar()); |
| logger.debug("Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar()); |
| logger.debug("Integer.MAX_VALUE = %,d", Integer.MAX_VALUE); |
| logger.debug("Long.MAX_VALUE = %,d", Long.MAX_VALUE); |
| </pre></div> |
| |
| <p> |
| To use a formatter Logger, you must call one of the LogManager |
| <a href="../log4j-api/apidocs/org/apache/logging/log4j/LogManager.html#getFormatterLoggerjava.lang.Class">getFormatterLogger</a> |
| methods. The output for this example shows that Calendar toString() is verbose compared to custom formatting: |
| </p> |
| |
| <div> |
| <pre class="prettyprint linenums">2012-12-12 11:56:19,633 [main] DEBUG: User John Smith with birthday java.util.GregorianCalendar[time=?,areFieldsSet=false,areAllFieldsSet=false,lenient=true,zone=sun.util.calendar.ZoneInfo[id="America/New_York",offset=-18000000,dstSavings=3600000,useDaylight=true,transitions=235,lastRule=java.util.SimpleTimeZone[id=America/New_York,offset=-18000000,dstSavings=3600000,useDaylight=true,startYear=0,startMode=3,startMonth=2,startDay=8,startDayOfWeek=1,startTime=7200000,startTimeMode=0,endMode=3,endMonth=10,endDay=1,endDayOfWeek=1,endTime=7200000,endTimeMode=0]],firstDayOfWeek=1,minimalDaysInFirstWeek=1,ERA=?,YEAR=1995,MONTH=4,WEEK_OF_YEAR=?,WEEK_OF_MONTH=?,DAY_OF_MONTH=23,DAY_OF_YEAR=?,DAY_OF_WEEK=?,DAY_OF_WEEK_IN_MONTH=?,AM_PM=0,HOUR=0,HOUR_OF_DAY=0,MINUTE=0,SECOND=0,MILLISECOND=?,ZONE_OFFSET=?,DST_OFFSET=?] |
| 2012-12-12 11:56:19,643 [main] DEBUG: User John Smith with birthday 05 23, 1995 |
| 2012-12-12 11:56:19,643 [main] DEBUG: Integer.MAX_VALUE = 2,147,483,647 |
| 2012-12-12 11:56:19,643 [main] DEBUG: Long.MAX_VALUE = 9,223,372,036,854,775,807 |
| </pre></div> |
| </section><section> |
| <h4><a name="Mixing_Loggers_with_Formatter_Loggers"></a>Mixing Loggers with Formatter Loggers</h4> |
| |
| <p> |
| Formatter loggers give fine-grained control over the output format, but have the drawback |
| that the correct type must be specified (for example, passing anything other than a decimal integer |
| for a %d format parameter gives an exception). |
| </p> |
| |
| <p> |
| If your main usage is to use {}-style parameters, but occasionally you need fine-grained |
| control over the output format, you can use the printf method:</p> |
| |
| <div> |
| <pre class="prettyprint linenums">public static Logger logger = LogManager.getLogger("Foo"); |
| |
| logger.debug("Opening connection to {}...", someDataSource); |
| logger.printf(Level.INFO, "Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar()); |
| </pre></div> |
| |
| <a name="LambdaSupport"></a> |
| </section><section> |
| <h4><a name="Java_8_lambda_support_for_lazy_logging"></a>Java 8 lambda support for lazy logging</h4> |
| |
| <p> |
| In release 2.4, the Logger interface added support for lambda expressions. |
| This allows client code to lazily log messages without explicitly checking if the requested log |
| level is enabled. For example, previously you would write: |
| </p> |
| |
| <div> |
| <pre class="prettyprint linenums">// pre-Java 8 style optimization: explicitly check the log level |
| // to make sure the expensiveOperation() method is only called if necessary |
| if (logger.isTraceEnabled()) { |
| logger.trace("Some long-running operation returned {}", expensiveOperation()); |
| }</pre></div> |
| |
| <p> |
| With Java 8 you can achieve the same effect with a lambda expression. |
| You no longer need to explicitly check the log level: |
| </p> |
| |
| <div> |
| <pre class="prettyprint linenums">// Java-8 style optimization: no need to explicitly check the log level: |
| // the lambda expression is not evaluated if the TRACE level is not enabled |
| logger.trace("Some long-running operation returned {}", () -> expensiveOperation());</pre></div> |
| |
| </section><section> |
| <h4><a name="Logger_Names"></a>Logger Names</h4> |
| |
| <p> |
| Most logging implementations use a hierarchical scheme for matching logger names with logging |
| configuration. In this scheme, the logger name hierarchy is represented by '.' characters |
| in the logger name, in a fashion very similar to the hierarchy used for Java package names. For example, |
| org.apache.logging.appender and org.apache.logging.filter both have |
| org.apache.logging as their parent. In most cases, applications name their loggers by |
| passing the current class's name to LogManager.getLogger(...). Because this usage is so |
| common, Log4j 2 provides that as the default when the logger name parameter is either omitted or is |
| null. For example, in all examples below the Logger will have a name of |
| "org.apache.test.MyTest". |
| </p> |
| |
| <div> |
| <pre class="prettyprint linenums">package org.apache.test; |
| |
| public class MyTest { |
| private static final Logger logger = LogManager.getLogger(MyTest.class); |
| }</pre></div> |
| |
| <div> |
| <pre class="prettyprint linenums">package org.apache.test; |
| |
| public class MyTest { |
| private static final Logger logger = LogManager.getLogger(MyTest.class.getName()); |
| }</pre></div> |
| |
| <div> |
| <pre class="prettyprint linenums">package org.apache.test; |
| |
| public class MyTest { |
| private static final Logger logger = LogManager.getLogger(); |
| }</pre></div> |
| </section></section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p align="center">Copyright © 1999-2019 <a class="external" href="http://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> |
| </body> |
| </html> |
