From ffed940c0043d4a72573e5b3300da33a774450be Mon Sep 17 00:00:00 2001 From: "Piotr P. Karwasz" Date: Wed, 16 Oct 2024 08:26:08 +0200 Subject: [PATCH] Fixes property names in release notes (#3089) Fixes the names of configuration properties introduced after `2.10.0` to always use the normalized form. Fixes #3079 --- ...cts_the_configured_log4j2_is_webapp_property.xml | 6 +++++- ...tus_logger_timestamp_format_is_now_configura.xml | 5 ++++- ...n_on_how_to_toggle_log4j2_debug_system_prope.xml | 6 +++++- ..._default_Require_log4j2_enableJndi_to_be_set.xml | 6 +++++- src/changelog/2.17.0/.release-notes.adoc.ftl | 6 +++++- ...he_java_protocol_only_JNDI_will_remain_disab.xml | 13 +++++++++++-- ...ow_uses_JndiManager_to_access_JNDI_resources.xml | 9 +++++++-- ...cript_enableLanguages_to_be_specified_to_ena.xml | 6 +++++- src/changelog/2.22.0/change_basic_auth_encoding.xml | 4 +++- .../2.23.1/fix_StatusLogger_instant_formatting.xml | 4 +++- src/changelog/2.24.0/.release-notes.adoc.ftl | 4 +++- ...63_add_logback_throwable_consuming_semantics.xml | 4 +++- .../2.24.0/2374_refactor_initialization.xml | 6 +++++- .../2.24.0/2379_fix_message_factory_properties.xml | 10 ++++++++-- .../2.24.0/2462_disable_jmx_by_default.xml | 9 +++++++-- src/changelog/2.24.0/2703_log4j_debug.xml | 5 ++++- src/changelog/2.24.0/change-is-webapp.xml | 8 +++++++- .../deprecate_log4j2_default_status_level.xml | 5 ++++- .../modules/ROOT/pages/manual/systemproperties.adoc | 2 +- 19 files changed, 95 insertions(+), 23 deletions(-) diff --git a/src/changelog/2.10.0/LOG4J2-2091_Log4j_respects_the_configured_log4j2_is_webapp_property.xml b/src/changelog/2.10.0/LOG4J2-2091_Log4j_respects_the_configured_log4j2_is_webapp_property.xml index abbee25ab73..920abe1c410 100644 --- a/src/changelog/2.10.0/LOG4J2-2091_Log4j_respects_the_configured_log4j2_is_webapp_property.xml +++ b/src/changelog/2.10.0/LOG4J2-2091_Log4j_respects_the_configured_log4j2_is_webapp_property.xml @@ -4,5 +4,9 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> - Log4j respects the configured "log4j2.is.webapp" property + + Log4j respects the configured + xref:manual/systemproperties.adoc#log4j2.isWebapp[`log4j2.isWebapp`] + property. + diff --git a/src/changelog/2.11.0/LOG4J2-2250_The_internal_status_logger_timestamp_format_is_now_configura.xml b/src/changelog/2.11.0/LOG4J2-2250_The_internal_status_logger_timestamp_format_is_now_configura.xml index 29e60533f7a..1bd0b1e15fb 100644 --- a/src/changelog/2.11.0/LOG4J2-2250_The_internal_status_logger_timestamp_format_is_now_configura.xml +++ b/src/changelog/2.11.0/LOG4J2-2250_The_internal_status_logger_timestamp_format_is_now_configura.xml @@ -4,5 +4,8 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="changed"> - The internal status logger timestamp format is now configurable with system property `log4j2.StatusLogger.DateFormat`. + + The internal status logger timestamp format is now configurable with system property + xref:manual/status-logger.adoc#log4j2.statusLoggerDateFormat[`log4j2.statusLoggerDateFormat`]. + diff --git a/src/changelog/2.15.0/LOG4J2-3160_Fix_documentation_on_how_to_toggle_log4j2_debug_system_prope.xml b/src/changelog/2.15.0/LOG4J2-3160_Fix_documentation_on_how_to_toggle_log4j2_debug_system_prope.xml index 08a8b38ebf2..0091fb3bb71 100644 --- a/src/changelog/2.15.0/LOG4J2-3160_Fix_documentation_on_how_to_toggle_log4j2_debug_system_prope.xml +++ b/src/changelog/2.15.0/LOG4J2-3160_Fix_documentation_on_how_to_toggle_log4j2_debug_system_prope.xml @@ -4,5 +4,9 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> - Fix documentation on how to toggle log4j2.debug system property. + + Fix documentation on how to toggle + xref:manual/status-logger.adoc#log4j2.debug[`log4j2.debug`] + system property. + diff --git a/src/changelog/2.16.0/LOG4J2-3208_Disable_JNDI_by_default_Require_log4j2_enableJndi_to_be_set.xml b/src/changelog/2.16.0/LOG4J2-3208_Disable_JNDI_by_default_Require_log4j2_enableJndi_to_be_set.xml index 13d7be46deb..3968288cf32 100644 --- a/src/changelog/2.16.0/LOG4J2-3208_Disable_JNDI_by_default_Require_log4j2_enableJndi_to_be_set.xml +++ b/src/changelog/2.16.0/LOG4J2-3208_Disable_JNDI_by_default_Require_log4j2_enableJndi_to_be_set.xml @@ -4,5 +4,9 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> - Disable JNDI by default. Require log4j2.enableJndi to be set to true to allow JNDI. + + Disable JNDI by default. Require + xref:manual/systemproperties.adoc#properties-jndi[`log4j2.enableJndi`] + to be set to true to allow JNDI. + diff --git a/src/changelog/2.17.0/.release-notes.adoc.ftl b/src/changelog/2.17.0/.release-notes.adoc.ftl index fff400b11fe..b25ba48a6ea 100644 --- a/src/changelog/2.17.0/.release-notes.adoc.ftl +++ b/src/changelog/2.17.0/.release-notes.adoc.ftl @@ -45,7 +45,11 @@ Recursive evaluation is still allowed while generating the configuration. * The `JndiLookup`, `JndiContextSelector`, and `JMSAppender` now require individual system properties to be enabled. * Remove LDAP and LDAPS as supported protocols from JNDI. -The single `log4j2.enableJndi` property introduced in Log4j 2.16.0 has been replaced with three individual properties; `log4j2.enableJndiContextSelector`, `log4j2.enableJndiJms`, and `log4j2.enableJndiLookup`. +The single `log4j2.enableJndi` property introduced in Log4j 2.16.0 has been replaced with three individual properties: +xref:manual/systemproperties.adoc#log4j2.enableJndiContextSelector[`log4j2.enableJndiContextSelector`], +xref:manual/systemproperties.adoc#log4j2.enableJndiJms[`log4j2.enableJndiJms`], +and + xref:manual/systemproperties.adoc#log4j2.enableJndiLookup[`log4j2.enableJndiLookup`]. The Log4j 2.17.0 API, as well as many core components, maintains binary compatibility with previous releases. diff --git a/src/changelog/2.17.0/LOG4J2-3242_Limit_JNDI_to_the_java_protocol_only_JNDI_will_remain_disab.xml b/src/changelog/2.17.0/LOG4J2-3242_Limit_JNDI_to_the_java_protocol_only_JNDI_will_remain_disab.xml index ad04a77cf6a..04b0ec7031c 100644 --- a/src/changelog/2.17.0/LOG4J2-3242_Limit_JNDI_to_the_java_protocol_only_JNDI_will_remain_disab.xml +++ b/src/changelog/2.17.0/LOG4J2-3242_Limit_JNDI_to_the_java_protocol_only_JNDI_will_remain_disab.xml @@ -4,6 +4,15 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> - Limit JNDI to the java protocol only. JNDI will remain disabled by default. Rename JNDI enablement property from - 'log4j2.enableJndi' to 'log4j2.enableJndiLookup', 'log4j2.enableJndiJms', and 'log4j2.enableJndiContextSelector'. + + Limit JNDI to the java protocol only. + JNDI will remain disabled by default. + Rename JNDI enablement property from + xref:manual/systemproperties.adoc#properties-jndi[`log4j2.enableJndi`] + to + xref:manual/systemproperties.adoc#log4j2.enableJndiLookup[`log4j2.enableJndiLookup`], + xref:manual/systemproperties.adoc#log4j2.enableJndiJms[`log4j2.enableJndiJms`], + and + xref:manual/systemproperties.adoc#log4j2.enableJndiContextSelector[`log4j2.enableJndiContextSelector`]. + diff --git a/src/changelog/2.17.1/LOG4J2-3293_JdbcAppender_now_uses_JndiManager_to_access_JNDI_resources.xml b/src/changelog/2.17.1/LOG4J2-3293_JdbcAppender_now_uses_JndiManager_to_access_JNDI_resources.xml index 54ce27ac86d..56c7dd1ac35 100644 --- a/src/changelog/2.17.1/LOG4J2-3293_JdbcAppender_now_uses_JndiManager_to_access_JNDI_resources.xml +++ b/src/changelog/2.17.1/LOG4J2-3293_JdbcAppender_now_uses_JndiManager_to_access_JNDI_resources.xml @@ -4,6 +4,11 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> - JdbcAppender now uses JndiManager to access JNDI resources. JNDI is only enabled when system property - log4j2.enableJndiJdbc is set to true. + + xref:manual/appenders/database.adoc#JdbcAppender[JDBC Appender] + now uses `JndiManager` to access JNDI resources. + JNDI is only enabled when the system property + xref:manual/systemproperties.adoc#log4j2.enableJndiJdbc[`log4j2.enableJndiJdbc`] + is set to `true`. + diff --git a/src/changelog/2.17.2/LOG4J2-2486_Require_log4j2_Script_enableLanguages_to_be_specified_to_ena.xml b/src/changelog/2.17.2/LOG4J2-2486_Require_log4j2_Script_enableLanguages_to_be_specified_to_ena.xml index 17407d90f73..a73a33e938c 100644 --- a/src/changelog/2.17.2/LOG4J2-2486_Require_log4j2_Script_enableLanguages_to_be_specified_to_ena.xml +++ b/src/changelog/2.17.2/LOG4J2-2486_Require_log4j2_Script_enableLanguages_to_be_specified_to_ena.xml @@ -4,5 +4,9 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="added"> - Require log4j2.Script.enableLanguages to be specified to enable scripting for specific languages. + + Require + xref:manual/systemproperties.adoc#log4j2.scriptEnableLanguages[`log4j2.scriptEnableLanguages`] + to be specified to enable scripting for specific languages. + diff --git a/src/changelog/2.22.0/change_basic_auth_encoding.xml b/src/changelog/2.22.0/change_basic_auth_encoding.xml index f528caab8cc..ffe7a67ac11 100644 --- a/src/changelog/2.22.0/change_basic_auth_encoding.xml +++ b/src/changelog/2.22.0/change_basic_auth_encoding.xml @@ -5,6 +5,8 @@ type="changed"> - Change default encoding of HTTP Basic Authentication to UTF-8 and add `log4j2.configurationAuthorizationEncoding` property to overwrite it. + Change default encoding of HTTP Basic Authentication to UTF-8 and add + xref:manual/systemproperties.adoc#log4j2.configurationAuthorizationEncoding[`log4j2.configurationAuthorizationEncoding`] + property to overwrite it. diff --git a/src/changelog/2.23.1/fix_StatusLogger_instant_formatting.xml b/src/changelog/2.23.1/fix_StatusLogger_instant_formatting.xml index 2f2298baee2..4b965ca3c09 100644 --- a/src/changelog/2.23.1/fix_StatusLogger_instant_formatting.xml +++ b/src/changelog/2.23.1/fix_StatusLogger_instant_formatting.xml @@ -5,7 +5,9 @@ type="fixed"> - Add `log4j2.StatusLogger.dateFormatZone` system property to set the time-zone `StatusLogger` uses to format `java.time.Instant`. + Add + xref:manual/statusLogger.adoc#log4j2.statusLoggerDateFormatZone[`log4j2.statusLoggerDateFormatZone`] + system property to set the time-zone `StatusLogger` uses to format `java.time.Instant`. Without this, formatting patterns accessing to time-zone-specific fields (e.g., year-of-era) cause failures. diff --git a/src/changelog/2.24.0/.release-notes.adoc.ftl b/src/changelog/2.24.0/.release-notes.adoc.ftl index caf821ef085..3be76ceb6b1 100644 --- a/src/changelog/2.24.0/.release-notes.adoc.ftl +++ b/src/changelog/2.24.0/.release-notes.adoc.ftl @@ -58,6 +58,8 @@ Please migrate to xref:components.adoc#log4j-mongodb[`log4j-mongodb`] (client ve === JMX changes -Starting in version 2.24.0, JMX support is disabled by default and can be re-enabled via the `log4j2.disableJmx=false` system property. +Starting in version 2.24.0, JMX support is disabled by default and can be re-enabled via the +xref:manual/systemproperties.adoc#log4j2.disableJmx[`log4j2.disableJmx`] +system property. <#include "../.changelog.adoc.ftl"> diff --git a/src/changelog/2.24.0/2363_add_logback_throwable_consuming_semantics.xml b/src/changelog/2.24.0/2363_add_logback_throwable_consuming_semantics.xml index 7d8332750d1..9e917978615 100644 --- a/src/changelog/2.24.0/2363_add_logback_throwable_consuming_semantics.xml +++ b/src/changelog/2.24.0/2363_add_logback_throwable_consuming_semantics.xml @@ -6,6 +6,8 @@ Add Logback throwable-consuming semantics as an option in `log4j-slf4j-impl` and `log4j-slf4j2-impl`. - Users can enable it by setting the property `log4j2.messageFactory` to `org.apache.logging.slf4j.message.ThrowableConsumingMessageFactory`. + Users can enable it by setting the property + xref:manual/systemproperties.adoc#log4j2.messageFactory[`log4j2.messageFactory`] + to `org.apache.logging.slf4j.message.ThrowableConsumingMessageFactory`. diff --git a/src/changelog/2.24.0/2374_refactor_initialization.xml b/src/changelog/2.24.0/2374_refactor_initialization.xml index b80bb68867c..ed80858b32b 100644 --- a/src/changelog/2.24.0/2374_refactor_initialization.xml +++ b/src/changelog/2.24.0/2374_refactor_initialization.xml @@ -4,5 +4,9 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="changed"> - Centralize initialization in the `Provider` class and deprecate `log4j2.loggerContextFactory` property. + + Centralize initialization in the `Provider` class and deprecate the + xref:manual/systemproperties.adoc#log4j2.loggerContextFactory[`log4j2.loggerContextFactory`] + property. + diff --git a/src/changelog/2.24.0/2379_fix_message_factory_properties.xml b/src/changelog/2.24.0/2379_fix_message_factory_properties.xml index f86978422f1..6e414b11f54 100644 --- a/src/changelog/2.24.0/2379_fix_message_factory_properties.xml +++ b/src/changelog/2.24.0/2379_fix_message_factory_properties.xml @@ -3,6 +3,12 @@ xmlns="https://logging.apache.org/xml/ns" xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> - - Fix handling of `log4j2.messageFactory` and `log4j2.flowMessageFactory` properties + + + Fix handling of + xref:manual/systemproperties.adoc#log4j2.messageFactory[`log4j2.messageFactory`] + and + xref:manual/systemproperties.adoc#log4j2.flowMessageFactory[`log4j2.flowMessageFactory`] + properties. + diff --git a/src/changelog/2.24.0/2462_disable_jmx_by_default.xml b/src/changelog/2.24.0/2462_disable_jmx_by_default.xml index 0adfd67cbad..3e3ca1b31f8 100644 --- a/src/changelog/2.24.0/2462_disable_jmx_by_default.xml +++ b/src/changelog/2.24.0/2462_disable_jmx_by_default.xml @@ -3,6 +3,11 @@ xmlns="https://logging.apache.org/xml/ns" xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="changed"> - - Disable JMX support by default. Require `log4j2.disableJmx` to be set to `false` to enable JMX support. + + + Disable JMX support by default. + Requires + xref:manual/systemproperties.adoc#log4j2.disableJmx[`log4j2.disableJmx`] + to be set to `false` to enable JMX support. + diff --git a/src/changelog/2.24.0/2703_log4j_debug.xml b/src/changelog/2.24.0/2703_log4j_debug.xml index 42a9fd1c534..f0ea523807d 100644 --- a/src/changelog/2.24.0/2703_log4j_debug.xml +++ b/src/changelog/2.24.0/2703_log4j_debug.xml @@ -4,5 +4,8 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> - Fix handling of `log4j2.debug`. + + Fix handling of + xref:manual/status-logger#log4j2.debug[`log4j2.debug`]. + diff --git a/src/changelog/2.24.0/change-is-webapp.xml b/src/changelog/2.24.0/change-is-webapp.xml index 105b114ccd6..2c0d9fd9abe 100644 --- a/src/changelog/2.24.0/change-is-webapp.xml +++ b/src/changelog/2.24.0/change-is-webapp.xml @@ -5,6 +5,12 @@ type="changed"> - Prioritize user-defined values of `log4j2.enableThreadLocals`, `log4j2.garbagefreeThreadContextMap` and `log4j2.shutdownHookEnabled` over the value of `log4j.isWebapp`. + Prioritize user-defined values of + xref:manual/systemproperties.adoc#log4j2.enableThreadlocals[`log4j2.enableThreadlocals`], + xref:manual/systemproperties.adoc#log4j2.garbagefreeThreadContextMap[`log4j2.garbagefreeThreadContextMap`] + and + xref:manual/systemproperties.adoc#log4j2.shutdownHookEnabled[`log4j2.shutdownHookEnabled`] + over the value of + xref:manual/systemproperties.adoc#log4j2.isWebapp[`log4j2.isWebapp`]. diff --git a/src/changelog/2.24.0/deprecate_log4j2_default_status_level.xml b/src/changelog/2.24.0/deprecate_log4j2_default_status_level.xml index b5c6d463a35..12c86c83e9b 100644 --- a/src/changelog/2.24.0/deprecate_log4j2_default_status_level.xml +++ b/src/changelog/2.24.0/deprecate_log4j2_default_status_level.xml @@ -4,5 +4,8 @@ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="changed"> - Deprecate `log4j2.defaultStatusLevel` property in Log4j Core in favor of `log4j2.statusLoggerLevel` + + Deprecate `log4j2.defaultStatusLevel` property in Log4j Core in favor of + xref:manual/status-logger.adoc#log4j2.statusLoggerLevel[`log4j2.statusLoggerLevel`]. + diff --git a/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc b/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc index e72136de40f..2bd4b6e75e5 100644 --- a/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc +++ b/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc @@ -46,7 +46,7 @@ If a `log4j2.system.properties` file is available on the classpath its contents [WARNING] ==== -To provide backward compatibility with versions older than 2.10 a certain number of additional property names is also supported using a fuzzy matching algorithm. +To provide backward compatibility with versions older than 2.10.0 a certain number of additional property names are also supported using a fuzzy matching algorithm. In case of problems with the properties sub-system, make sure that your application does not use property names with the following case-insensitive prefixes: