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 ea4cf759bcd680de489808a1827d78448c7bc11b Author: Ralph Goers <[email protected]> AuthorDate: Mon Dec 26 21:27:28 2022 -0700 LOG4J2-3644 - Deprecate package scanning --- .../core/config/plugins/util/PluginManager.java | 16 ++++-- src/site/xdoc/manual/appenders.xml | 60 +++++++++++----------- src/site/xdoc/manual/configuration.xml.vm | 5 +- src/site/xdoc/manual/filters.xml | 30 +++++------ src/site/xdoc/manual/plugins.xml | 6 +-- 5 files changed, 63 insertions(+), 54 deletions(-) diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/util/PluginManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/util/PluginManager.java index abe2aa91be..8dae9cc3d4 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/util/PluginManager.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/util/PluginManager.java @@ -14,13 +14,8 @@ * See the license for the specific language governing permissions and * limitations under the license. */ - package org.apache.logging.log4j.core.config.plugins.util; -import org.apache.logging.log4j.Logger; -import org.apache.logging.log4j.status.StatusLogger; -import org.apache.logging.log4j.util.Strings; - import java.util.Collection; import java.util.HashMap; import java.util.LinkedHashMap; @@ -28,6 +23,10 @@ import java.util.List; import java.util.Map; import java.util.concurrent.CopyOnWriteArrayList; +import org.apache.logging.log4j.Logger; +import org.apache.logging.log4j.status.StatusLogger; +import org.apache.logging.log4j.util.Strings; + /** * Loads and manages all the plugins. */ @@ -125,6 +124,9 @@ public class PluginManager { * @since 2.1 */ public void collectPlugins(final List<String> packages) { + if (isNotEmpty(packages) || isNotEmpty(PACKAGES)) { + LOGGER.warn("The use of package scanning to locate plugins is deprecated and will be removed in a future release"); + } final String categoryLowerCase = category.toLowerCase(); final Map<String, PluginType<?>> newPlugins = new LinkedHashMap<>(); @@ -173,4 +175,8 @@ public class PluginManager { } } } + + private boolean isNotEmpty(List<String> list) { + return list != null && !list.isEmpty(); + } } diff --git a/src/site/xdoc/manual/appenders.xml b/src/site/xdoc/manual/appenders.xml index 02b59dfb25..37790b0ade 100644 --- a/src/site/xdoc/manual/appenders.xml +++ b/src/site/xdoc/manual/appenders.xml @@ -158,7 +158,7 @@ </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <File name="MyFile" fileName="logs/app.log"> <PatternLayout> @@ -471,7 +471,7 @@ CREATE TABLE logs ( </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <Console name="STDOUT" target="SYSTEM_OUT"> <PatternLayout pattern="%m%n"/> @@ -540,7 +540,7 @@ CREATE TABLE logs ( </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingFile name="RollingFile" fileName="logs/app.log" filePattern="logs/app-%d{MM-dd-yyyy}.log.gz" ignoreExceptions="false"> @@ -701,7 +701,7 @@ CREATE TABLE logs ( </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <File name="MyFile" fileName="logs/app.log"> <PatternLayout> @@ -887,7 +887,7 @@ CREATE TABLE logs ( </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <Flume name="eventLogger" compress="true"> <Agent host="192.168.10.101" port="8800"/> @@ -907,7 +907,7 @@ CREATE TABLE logs ( </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <Flume name="eventLogger" compress="true" type="persistent" dataDir="./logData"> <Agent host="192.168.10.101" port="8800"/> @@ -928,7 +928,7 @@ CREATE TABLE logs ( Agent. </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <Flume name="eventLogger" compress="true" type="Embedded"> <Agent host="192.168.10.101" port="8800"/> @@ -954,7 +954,7 @@ CREATE TABLE logs ( events to an embedded Flume Agent. </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="error" name="MyApp" packages=""> +<Configuration status="error" name="MyApp"> <Appenders> <Flume name="eventLogger" compress="true" type="Embedded"> <Property name="channels">file</Property> @@ -2237,7 +2237,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <MemoryMappedFile name="MyFile" fileName="logs/app.log"> <PatternLayout> @@ -2820,7 +2820,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RandomAccessFile name="MyFile" fileName="logs/app.log"> <PatternLayout> @@ -2915,7 +2915,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <Console name="STDOUT" target="SYSTEM_OUT"> <PatternLayout pattern="%m%n"/> @@ -2957,7 +2957,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { to the MapMessage: </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <Console name="STDOUT" target="SYSTEM_OUT"> <PatternLayout pattern="%m%n"/> @@ -3520,7 +3520,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingFile name="RollingFile" fileName="logs/app.log" filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz"> @@ -3543,7 +3543,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { This second example shows a rollover strategy that will keep up to 20 files before removing them. </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingFile name="RollingFile" fileName="logs/app.log" filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz"> @@ -3571,7 +3571,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingFile name="RollingFile" fileName="logs/app.log" filePattern="logs/$${date:yyyy-MM}/app-%d{yyyy-MM-dd-HH}-%i.log.gz"> @@ -3597,7 +3597,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingFile name="RollingFile" filePattern="logs/app-%d{yyyy-MM-dd-HH}-%i.log.gz"> <PatternLayout> @@ -3620,7 +3620,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingFile name="RollingFile" filePattern="logs/app-%d{yyyy-MM-dd-HH}-%i.log.gz"> <PatternLayout> @@ -3857,7 +3857,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Properties> <Property name="baseDir">logs</Property> </Properties> @@ -3892,7 +3892,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Properties> <Property name="baseDir">logs</Property> </Properties> @@ -3998,7 +3998,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="trace" name="MyApp" packages=""> +<Configuration status="trace" name="MyApp"> <Properties> <Property name="baseDir">logs</Property> </Properties> @@ -4121,7 +4121,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="trace" name="MyApp" packages=""> +<Configuration status="trace" name="MyApp"> <Properties> <Property name="baseDir">logs</Property> </Properties> @@ -4339,7 +4339,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingRandomAccessFile name="RollingRandomAccessFile" fileName="logs/app.log" filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz"> @@ -4363,7 +4363,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { 20 files before removing them. </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingRandomAccessFile name="RollingRandomAccessFile" fileName="logs/app.log" filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz"> @@ -4398,7 +4398,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <RollingRandomAccessFile name="RollingRandomAccessFile" fileName="logs/app.log" filePattern="logs/$${date:yyyy-MM}/app-%d{yyyy-MM-dd-HH}-%i.log.gz"> @@ -4641,7 +4641,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </p> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <Flume name="AuditLogger" compress="true"> <Agent host="192.168.10.101" port="8800"/> @@ -4796,7 +4796,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { </tr> </table> <pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> -<Configuration status="warn" name="MyApp" packages=""> +<Configuration status="warn" name="MyApp"> <Appenders> <SMTP name="Mail" subject="Error Log" to="[email protected]" from="[email protected]" smtpHost="localhost" smtpPort="25" bufferSize="50"> @@ -4952,7 +4952,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity { This is an unsecured TCP configuration: </p> <pre class="prettyprint linenums"><