commit | fa410e45ee80ded989527f4d837aadf81ac75485 | [log] [tgz] |
---|---|---|
author | Andy Wilkinson <awilkinson@pivotal.io> | Wed Dec 25 03:19:30 2019 +0000 |
committer | Carter Kozak <ckozak@apache.org> | Tue Dec 24 22:21:33 2019 -0500 |
tree | 07d868a7ae9956f7e2002ae850b2ec663525f6cc | |
parent | 34ab05dd21ae1d1f85a2a0f658799a18871067d3 [diff] |
LOG4J-2735 - make PluginCache output reproducible (#321) Previously, the data written by a PluginCache with identical categories and entries would vary depending on the order in which those categories or entries were added to the cache. The ordering of the elements handled by the annotation processor that populates the cache is not guaranteed so multiple compilations of identical source code could result in different output. This prevented projects that define Log4j2 plugins from having a reproducible build. This commit updates PluginCache to use TreeMaps to hold categories and their entries. This ensures that the cache's data is stored and written in an order determined by sorting their String keys rather than by when they are added. This makes the cache's output reproducible, irrespective of the order of the elements handled by the annotation processor.
Apache Log4j 2 is an upgrade to Log4j that provides significant improvements over its predecessor, Log4j 1.x, and provides many of the improvements available in Logback while fixing some inherent problems in Logback's architecture.
By sending a pull request you grant the Apache Software Foundation sufficient rights to use and release the submitted work under the Apache license. You grant the same rights (copyright license, patent license, etc.) to the Apache Software Foundation as if you have signed a Contributor License Agreement. For contributions that are judged to be non-trivial, you will be asked to actually signing a Contributor License Agreement.
Users should refer to Maven, Ivy, Gradle, and SBT Artifacts on the Log4j web site for instructions on how to include Log4j into their project using their chosen build tool.
Basic usage of the Logger
API:
package com.example; import org.apache.logging.log4j.Logger; import org.apache.logging.log4j.LogManager; public class Example { private static final Logger LOGGER = LogManager.getLogger(); public static void main(String... args) { String thing = args.length > 0 ? args[0] : "world"; LOGGER.info("Hello, {}!", thing); LOGGER.debug("Got calculated value only if debug enabled: {}", () -> doSomeCalculation()); } private static Object doSomeCalculation() { // do some complicated calculation } }
And an example log4j2.xml
configuration file:
<?xml version="1.0" encoding="UTF-8"?> <Configuration> <Appenders> <Console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> </Console> </Appenders> <Loggers> <Logger name="com.example" level="INFO"/> <Root level="error"> <AppenderRef ref="Console"/> </Root> </Loggers> </Configuration>
The Log4j 2 User's Guide is available here or as a downloadable PDF.
Log4j 2.4 and greater requires Java 7, versions 2.0-alpha1 to 2.3 required Java 6. Some features require optional dependencies; the documentation for these features specifies the dependencies.
Apache Log4j 2 is distributed under the Apache License, version 2.0.
How to download Log4j, and how to use it from Maven, Ivy and Gradle. You can access the latest development snapshot by using the Maven repository https://repository.apache.org/snapshots
, see Snapshot builds.
Issues, bugs, and feature requests should be submitted to the JIRA issue tracking system for this project.
Pull request on GitHub are welcome, but please open a ticket in the JIRA issue tracker first, and mention the JIRA issue in the Pull Request.
Log4j requires Apache Maven 3.x. To build from source and install to your local Maven repository, execute the following:
mvn install
We love contributions! Take a look at our contributing page.