[FOLLOWUP] Fix StatusLogger log level filtering when debug mode is en…

…abled
panbingkun · Mar 2, 2024 · 0407c14 · 0407c14
1 parent c542041
commit 0407c14
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 3 deletions.
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusConsoleListener.java b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusConsoleListener.java
@@ -44,14 +44,28 @@ public class StatusConsoleListener implements StatusListener {
     // `volatile` is necessary to correctly read the `stream` without holding the lock
     private volatile PrintStream stream;
 
+    // whether or not enables debug mode
+    private final boolean debugEnabled;
+
     /**
      * Constructs a {@link StatusConsoleListener} instance writing to {@link System#out} using the supplied level.
      *
      * @param level the level of status messages that should appear on the console
      * @throws NullPointerException on null {@code level}
      */
     public StatusConsoleListener(final Level level) {
-        this(level, System.out);
+        this(level, false);
+    }
+
+    /**
+     * Constructs a {@link StatusConsoleListener} instance writing to {@link System#out} using the supplied level.
+     *
+     * @param level the level of status messages that should appear on the console
+     * @param debugEnabled whether or not enables debug mode
+     * @throws NullPointerException on null {@code level}
+     */
+    public StatusConsoleListener(final Level level, final boolean debugEnabled) {
+        this(level, System.out, debugEnabled);
     }
 
     /**
@@ -65,8 +79,25 @@ public StatusConsoleListener(final Level level) {
      * @throws NullPointerException on null {@code level} or {@code stream}
      */
     public StatusConsoleListener(final Level level, final PrintStream stream) {
+        this(level, stream, false);
+    }
+
+    /**
+     * Constructs a {@link StatusConsoleListener} instance using the supplied level and stream.
+     * <p>
+     * Make sure not to use a logger stream of some sort to avoid creating an infinite loop of indirection!
+     * </p>
+     *
+     * @param level the level of status messages that should appear on the console
+     * @param stream the stream to write to
+     * @param debugEnabled whether or not enables debug mode
+     * @throws NullPointerException on null {@code level} or {@code stream}
+     */
+    public StatusConsoleListener(final Level level, final PrintStream stream,
+        final boolean debugEnabled) {
         this.initialLevel = this.level = requireNonNull(level, "level");
         this.initialStream = this.stream = requireNonNull(stream, "stream");
+        this.debugEnabled = debugEnabled;
     }
 
     /**
@@ -134,7 +165,7 @@ public Level getStatusLevel() {
     @Override
     public void log(final StatusData data) {
         requireNonNull(data, "data");
-        if (level.isLessSpecificThan(data.getLevel())) {
+        if (debugEnabled || level.isLessSpecificThan(data.getLevel())) {
             final String formattedStatus = data.getFormattedStatus();
             stream.println(formattedStatus);
         }

diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusLogger.java b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusLogger.java
@@ -526,7 +526,8 @@ private static final class InstanceHolder {
                 StatusLogger.class.getSimpleName(),
                 ParameterizedNoReferenceMessageFactory.INSTANCE,
                 Config.getInstance(),
-                new StatusConsoleListener(Config.getInstance().fallbackListenerLevel));
+                new StatusConsoleListener(Config.getInstance().fallbackListenerLevel,
+                    Config.getInstance().debugEnabled));
     }
 
     /**