You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2019/12/03 06:01:34 UTC
[logging-log4j2] 01/02: Update site documentation
This is an automated email from the ASF dual-hosted git repository.
rgoers pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 64358308425530df17aa468429e944ca33ed2339
Author: Ralph Goers <rg...@apache.org>
AuthorDate: Sun Dec 1 10:42:44 2019 -0700
Update site documentation
---
RELEASE-NOTES.md | 84 ++++++++++++++++++++++++-------------------
src/changes/announcement.vm | 28 ++++++++-------
src/changes/changes.xml | 2 +-
src/site/markdown/articles.md | 2 ++
src/site/markdown/index.md.vm | 6 ++++
5 files changed, 72 insertions(+), 50 deletions(-)
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
index 1d860fc..b32329c 100644
--- a/RELEASE-NOTES.md
+++ b/RELEASE-NOTES.md
@@ -14,9 +14,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-# Apache Log4j 2.12.1 Release Notes
+# Apache Log4j 2.13.0 Release Notes
-The Apache Log4j 2 team is pleased to announce the Log4j 2.12.1 release!
+The Apache Log4j 2 team is pleased to announce the Log4j 2.13.0 release!
Apache Log4j is a well known framework for logging application behavior. Log4j 2 is an upgrade
to Log4j that provides significant improvements over its predecessor, Log4j 1.x, and provides
@@ -27,60 +27,70 @@ temporary objects) while logging. In addition, Log4j 2 will not lose events whil
The artifacts may be downloaded from https://logging.apache.org/log4j/2.x/download.html.
-This release contains bugfixes and minor enhancements.
+This release contains bugfixes and minor enhancements. Some of the new features in this release are:
+
+1. Log4j 2 now requires Java 8 or higher to build and run.
+1. Experimental support for Log4j 1 configuration files. See
+[Log4j 2 Compatiblity with Log4j 1](https://logging.apache.org/log4j/2.x//manual/compatiblity.html).
+1. The Logger API has been enhanced to support a builder pattern. This can dramatically improve the overhead of
+capturing location information. See [Log Builder](https://logging.apache.org/log4j/2.x//manual/logbuilder.html).
+1. Better integration with Spring Boot by providing access to Spring variables in Log4j 2 configuration files and
+allowing Log4j 2 system properties to be defined in the Spring configuration.
+See [Logging in the Cloud](manual/cloud.html#Managing_Logging_Configuration).
+1. Support for accessing Kubernetes information via a Log4j 2 Lookup.
+1. The Gelf Layout now allows the message to be formatted using a PatternLayout pattern.
+[Logging in the Cloud](https://logging.apache.org/log4j/2.x//manual/cloud.html#Log4j_Configuration) provides an example of this, as well
+as the use of the Spring and Kubernetes Lookups.
Due to a break in compatibility in the SLF4J binding, Log4j now ships with two versions of the SLF4J to Log4j adapters.
log4j-slf4j-impl should be used with SLF4J 1.7.x and earlier and log4j-slf4j18-impl should be used with SLF4J 1.8.x and
later.
-This release improves the performance of capturing location information, makes log4j-core optional in the log4j 1.2
-bridge, and explicitly removes LoggerContext references from compoents that keep track of them when the LoggerContext
-is shut down. More details on the new features and fixes are itemized below.
-
Note that the XML, JSON and YAML formats changed in the 2.11.0 release: they no longer have the "timeMillis" attribute
and instead have an "Instant" element with "epochSecond" and "nanoOfSecond" attributes.
-The Log4j 2.12.1 API, as well as many core components, maintains binary compatibility with previous releases.
+The Log4j 2.13.0 API, as well as many core components, maintains binary compatibility with previous releases.
-## GA Release 2.12.1
+## GA Release 2.13.0
Changes in this version include:
+### New Features
+* [LOG4J2-63](https://issues.apache.org/jira/browse/LOG4J2-63):
+Add experimental support for Log4j 1 configuration files.
+* [LOG4J2-2716](https://issues.apache.org/jira/browse/LOG4J2-2716):
+Add the ability to lookup Kubernetes attributes in the Log4j configuration. Allow Log4j properties to
+ be retrieved from the Spring environment if it is available.
+* [LOG4J2-2710](https://issues.apache.org/jira/browse/LOG4J2-2710):
+Allow Spring Boot application properties to be accessed in the Log4j 2 configuration. Add
+ lower and upper case Lookups.
+* [LOG4J2-2639](https://issues.apache.org/jira/browse/LOG4J2-2639):
+Add builder pattern to Logger interface.
### Fixed Bugs
-* [LOG4J2-1946](https://issues.apache.org/jira/browse/LOG4J2-1946):
-Allow file renames to work when files are missing from the sequence. Thanks to Igor Perelyotov.
-* [LOG4J2-2650](https://issues.apache.org/jira/browse/LOG4J2-2650):
-Support emulating a MAC address when using ipv6. Thanks to Mattia Bertorello.
-* [LOG4J2-2366](https://issues.apache.org/jira/browse/LOG4J2-2366):
-Remove references to LoggerContext when it is shutdown.
-* [LOG4J2-2644](https://issues.apache.org/jira/browse/LOG4J2-2644):
-Improve the performance of capturing location information.
-* [LOG4J2-2658](https://issues.apache.org/jira/browse/LOG4J2-2658):
-AbstractAction.reportException records a warning to the status logger, providing more information when file
- based appenders fail to compress rolled data asynchronously.
-* [LOG4J2-2659](https://issues.apache.org/jira/browse/LOG4J2-2659):
-AbstractAction handles and records unchecked RuntimeException and Error in addition to IOException.
+* [LOG4J2-2712](https://issues.apache.org/jira/browse/LOG4J2-2712):
+The rolling file appenders would fail to compress the file after rollover if the file name matched the
+ file pattern.
+* [LOG4J2-2693](https://issues.apache.org/jira/browse/LOG4J2-2693):
+@PluginValue does not support attribute names besides "value".
+* [LOG4J2-2647](https://issues.apache.org/jira/browse/LOG4J2-2647):
+Validation blocks definition of script in properties configuration.
+* [LOG4J2-2680](https://issues.apache.org/jira/browse/LOG4J2-2680):
+Set result of rename action to true if file was copied. Thanks to Guillermo Xavier Hurtado Garcia.
+* [LOG4J-2672](https://issues.apache.org/jira/browse/LOG4J-2672):
+Add automatic module names where missing. Thanks to Stephen Colebourne.
+* [LOG4J2-2673](https://issues.apache.org/jira/browse/LOG4J2-2673):
+OutputStreamAppender.Builder ignores setFilter(). Thanks to Yuichi Sugimura.
### Changes
-* [LOG4J2-2556](https://issues.apache.org/jira/browse/LOG4J2-2556):
-Make Log4j Core optional for Log4j 1.2 API.
-* [LOG4J2-2646](https://issues.apache.org/jira/browse/LOG4J2-2646):
-Update MongoDB 3 driver from 3.10.1 to 3.10.2.
-* [LOG4J2-2657](https://issues.apache.org/jira/browse/LOG4J2-2657):
-Improve exception messages in the JDBC appender.
-* [LOG4J2-2660](https://issues.apache.org/jira/browse/LOG4J2-2660):
-Retry when JDBC throws a java.sql.SQLTransactionRollbackException in commitAndClose().
+* [LOG4J2-2709](https://issues.apache.org/jira/browse/LOG4J2-2709):
+Allow message portion of GELF layout to be formatted using a PatternLayout. Allow
+ ThreadContext attributes to be explicitly included or excluded in the GelfLayout.
---
-Apache Log4j 2.12.1 requires a minimum of Java 7 to build and run. Log4j 2.3 was the
-last release that supported Java 6.
-
-Basic compatibility with Log4j 1.x is provided through the log4j-1.2-api component, however it
-does not implement some of the very implementation specific classes and methods. The package
-names and Maven groupId have been changed to org.apache.logging.log4j to avoid any conflicts
-with log4j 1.x.
+Apache Log4j 2.13.0 requires a minimum of Java 8 to build and run. Log4j 2.3 was the
+last release that supported Java 6 and Log4j 2.11.2 is the last release to support Java 7.
For complete information on Apache Log4j 2, including instructions on how to submit bug
reports, patches, or suggestions for improvement, see the Apache Apache Log4j 2 website:
diff --git a/src/changes/announcement.vm b/src/changes/announcement.vm
index 0b25be5..088ecf4 100644
--- a/src/changes/announcement.vm
+++ b/src/changes/announcement.vm
@@ -65,16 +65,25 @@ temporary objects) while logging. In addition, Log4j 2 will not lose events whil
The artifacts may be downloaded from https://logging.apache.org/log4j/2.x/download.html.
-This release contains bugfixes and minor enhancements.
+This release contains bugfixes and minor enhancements. Some of the new features in this release are:
+
+1. Log4j 2 now requires Java 8 or higher to build and run.
+1. Experimental support for Log4j 1 configuration files. See
+[Log4j 2 Compatiblity with Log4j 1](${project.url}/manual/compatiblity.html).
+1. The Logger API has been enhanced to support a builder pattern. This can dramatically improve the overhead of
+capturing location information. See [Log Builder](${project.url}/manual/logbuilder.html).
+1. Better integration with Spring Boot by providing access to Spring variables in Log4j 2 configuration files and
+allowing Log4j 2 system properties to be defined in the Spring configuration.
+See [Logging in the Cloud](manual/cloud.html#Managing_Logging_Configuration).
+1. Support for accessing Kubernetes information via a Log4j 2 Lookup.
+1. The Gelf Layout now allows the message to be formatted using a PatternLayout pattern.
+[Logging in the Cloud](${project.url}/manual/cloud.html#Log4j_Configuration) provides an example of this, as well
+as the use of the Spring and Kubernetes Lookups.
Due to a break in compatibility in the SLF4J binding, Log4j now ships with two versions of the SLF4J to Log4j adapters.
log4j-slf4j-impl should be used with SLF4J 1.7.x and earlier and log4j-slf4j18-impl should be used with SLF4J 1.8.x and
later.
-This release improves the performance of capturing location information, makes log4j-core optional in the log4j 1.2
-bridge, and explicitly removes LoggerContext references from compoents that keep track of them when the LoggerContext
-is shut down. More details on the new features and fixes are itemized below.
-
Note that the XML, JSON and YAML formats changed in the 2.11.0 release: they no longer have the "timeMillis" attribute
and instead have an "Instant" element with "epochSecond" and "nanoOfSecond" attributes.
@@ -120,13 +129,8 @@ $h3 Removed
#end
---
-Apache Log4j ${relVersion} requires a minimum of Java 7 to build and run. Log4j 2.3 was the
-last release that supported Java 6.
-
-Basic compatibility with Log4j 1.x is provided through the log4j-1.2-api component, however it
-does not implement some of the very implementation specific classes and methods. The package
-names and Maven groupId have been changed to org.apache.logging.log4j to avoid any conflicts
-with log4j 1.x.
+Apache Log4j ${relVersion} requires a minimum of Java 8 to build and run. Log4j 2.3 was the
+last release that supported Java 6 and Log4j 2.11.2 is the last release to support Java 7.
For complete information on ${project.name}, including instructions on how to submit bug
reports, patches, or suggestions for improvement, see the Apache ${project.name} website:
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 61c6031..cfa07b7 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -42,7 +42,7 @@
be retrieved from the Spring environment if it is available.
</action>
<action issue="LOG4J2-2710" dev="rgoers" type="add">
- Allow Spring Boot application properties to be accessed in the Log4j 2 configuraiton. Add
+ Allow Spring Boot application properties to be accessed in the Log4j 2 configuration. Add
lower and upper case Lookups.
</action>
<action issue="LOG4J2-2709" dev="rgoers" type="update">
diff --git a/src/site/markdown/articles.md b/src/site/markdown/articles.md
index 167b545..bafc3e0 100644
--- a/src/site/markdown/articles.md
+++ b/src/site/markdown/articles.md
@@ -44,6 +44,8 @@ guide for up-to-date and detailed information on how to configure and use Log4j
## English
+* [A guide to logging in Java](https://www.marcobehler.com/guides/a-guide-to-logging-in-java)
+(June 23, 2019)
* [Exploring the Secrets of Java Logs: Log4j 2 Log System](https://www.alibabacloud.com/blog/exploring-the-secrets-of-java-logs-log4j-2-log-system_594821)
(May 17, 2019)
* [Log4j2 Tutorial](https://howtodoinjava.com/log4j2/)
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index 156e540..07c0abb 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -118,6 +118,12 @@ and updating the Log4j configuration through Spring Cloud Configuration. This su
version 2.13.0 to add support for accessing Spring Boot properties as well as Kubernetes information.
See [Logging in the Cloud](manual/cloud.html) for details.
+$h3 Compatible with Log4j 1.x
+
+The Log4j-1.2-api module of Log4j 2 provides compatiblity for applications using the Log4j 1 logging methods. As
+of Log4j 2.13.0 Log4j 2 also provides experimental support for Log4j 1.x configuration files. See
+[Log4j 2 Compatiblity with Log4j 1](manual/compatibility.html) for more information.
+
$h2 Documentation
The Log4j 2 User's Guide is available on this [site](manual/index.html) or as a downloadable