Skip to content

Commit

Permalink
[LOG4J2-3647] Add global filter support to LogBuilder
Browse files Browse the repository at this point in the history 
`LogBuilder` suppliers in the `Logger` class always return a no-op
builder if the log message level is higher than the configured level.
This way global filters are always skipped.

This patch always returns a functional builder if we detect the presence
of a global filter.
  • Loading branch information
@ppkarwasz
ppkarwasz committed Jan 28, 2023
1 parent 35cb298 commit 113a8e8
Show file tree
Hide file tree
Showing 14 changed files with 803 additions and 30 deletions.
138 changes: 111 additions & 27 deletions log4j-api/src/main/java/org/apache/logging/log4j/internal/DefaultLogBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,21 @@
*/
package org.apache.logging.log4j.internal;

import java.util.Arrays;

import org.apache.logging.log4j.BridgeAware;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogBuilder;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.message.Message;
import org.apache.logging.log4j.message.SimpleMessage;
import org.apache.logging.log4j.spi.ExtendedLogger;
import org.apache.logging.log4j.status.StatusLogger;
import org.apache.logging.log4j.util.LambdaUtil;
import org.apache.logging.log4j.util.StackLocatorUtil;
import org.apache.logging.log4j.util.Supplier;


/**
* Collects data for a log event and then logs it. This class should be considered private.
*/
Expand All @@ -38,7 +40,7 @@ public class DefaultLogBuilder implements BridgeAware, LogBuilder {
private static final String FQCN = DefaultLogBuilder.class.getName();
private static final Logger LOGGER = StatusLogger.getLogger();

private Logger logger;
private ExtendedLogger logger;
private Level level;
private Marker marker;
private Throwable throwable;
Expand All @@ -47,7 +49,7 @@ public class DefaultLogBuilder implements BridgeAware, LogBuilder {
private long threadId;
private String fqcn = FQCN;

public DefaultLogBuilder(Logger logger, Level level) {
public DefaultLogBuilder(ExtendedLogger logger, Level level) {
this.logger = logger;
this.level = level;
this.threadId = Thread.currentThread().getId();
Expand All @@ -68,7 +70,7 @@ public void setEntryPoint(String fqcn) {
* @param level The logging level for this event.
* @return This LogBuilder instance.
*/
public LogBuilder reset(Logger logger, Level level) {
public LogBuilder reset(ExtendedLogger logger, Level level) {
this.logger = logger;
this.level = level;
this.marker = null;
Expand Down Expand Up @@ -108,138 +110,137 @@ public boolean isInUse() {

@Override
public void log(Message message) {
if (isValid()) {
if (isValid() && isEnabled(message)) {
logMessage(message);
}
}

@Override
public Message logAndGet(Supplier<Message> messageSupplier) {
Message message = null;
if (isValid()) {
logMessage(message = messageSupplier.get());
if (isValid() && isEnabled(message = messageSupplier.get())) {
logMessage(message);
}
return message;
}

@Override
public void log(final CharSequence message) {
if (isValid()) {
if (isValid() && isEnabled(message)) {
logMessage(logger.getMessageFactory().newMessage(message));
}
}

@Override
public void log(String message) {
if (isValid()) {
if (isValid() && isEnabled(message)) {
logMessage(logger.getMessageFactory().newMessage(message));
}
}

@Override
public void log(String message, Object... params) {
if (isValid()) {
if (isValid() && isEnabled(message, params)) {
logMessage(logger.getMessageFactory().newMessage(message, params));
}
}

@Override
public void log(String message, Supplier<?>... params) {
if (isValid()) {
logMessage(logger.getMessageFactory().newMessage(message, LambdaUtil.getAll(params)));
final Object[] objs;
if (isValid() && isEnabled(message, objs = LambdaUtil.getAll(params))) {
logMessage(logger.getMessageFactory().newMessage(message, objs));
}
}

@Override
public void log(Supplier<Message> messageSupplier) {
if (isValid()) {
logMessage(messageSupplier.get());
}
logAndGet(messageSupplier);
}

@Override
public void log(Object message) {
if (isValid()) {
if (isValid() && isEnabled(message)) {
logMessage(logger.getMessageFactory().newMessage(message));
}
}

@Override
public void log(String message, Object p0) {
if (isValid()) {
if (isValid() && isEnabled(message, p0)) {
logMessage(logger.getMessageFactory().newMessage(message, p0));
}
}

@Override
public void log(String message, Object p0, Object p1) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2, Object p3) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2, p3)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2, p3));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2, p3, p4)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2, p3, p4));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2, p3, p4, p5)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2, p3, p4, p5));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2, p3, p4, p5, p6)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2, p3, p4, p5, p6));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6,
Object p7) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2, p3, p4, p5, p6, p7)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2, p3, p4, p5, p6, p7));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6,
Object p7, Object p8) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2, p3, p4, p5, p6, p7, p8)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2, p3, p4, p5, p6, p7, p8));
}
}

@Override
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6,
Object p7, Object p8, Object p9) {
if (isValid()) {
if (isValid() && isEnabled(message, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9)) {
logMessage(logger.getMessageFactory().newMessage(message, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9));
}
}

@Override
public void log() {
if (isValid()) {
if (isValid() && isEnabled(EMPTY_MESSAGE)) {
logMessage(EMPTY_MESSAGE);
}
}
Expand All @@ -265,4 +266,87 @@ private boolean isValid() {
}
return true;
}

protected boolean isEnabled(Message message) {
return logger.isEnabled(level, marker, message, throwable);
}

protected boolean isEnabled(CharSequence message) {
return logger.isEnabled(level, marker, message, throwable);
}

protected boolean isEnabled(String message) {
return logger.isEnabled(level, marker, message, throwable);
}

protected boolean isEnabled(String message, Object... params) {
final Object[] newParams;
if (throwable != null) {
newParams = Arrays.copyOf(params, params.length + 1);
newParams[params.length] = throwable;
} else {
newParams = params;
}
return logger.isEnabled(level, marker, message, newParams);
}

protected boolean isEnabled(Object message) {
return logger.isEnabled(level, marker, message, throwable);
}

protected boolean isEnabled(String message, Object p0) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, throwable)
: logger.isEnabled(level, marker, message, p0);
}

protected boolean isEnabled(String message, Object p0, Object p1) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, p1, throwable)
: logger.isEnabled(level, marker, message, p0, p1);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, p1, p2, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2, Object p3) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, p1, p2, p3, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2, p3);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2, Object p3, Object p4) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5,
Object p6) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5,
Object p6, Object p7) {
return throwable != null ? logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6, p7, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6, p7);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5,
Object p6, Object p7, Object p8) {
return throwable != null
? logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6, p7, p8, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6, p7, p8);
}

protected boolean isEnabled(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5,
Object p6, Object p7, Object p8, Object p9) {
return throwable != null
? logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, throwable)
: logger.isEnabled(level, marker, message, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9);
}
}
12 changes: 9 additions & 3 deletions log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2881,14 +2881,20 @@ public LogBuilder always() {
@Override
public LogBuilder atLevel(Level level) {
if (isEnabled(level)) {
return getLogBuilder(level).reset(this, level);
return getLogBuilder(level);
}
return LogBuilder.NOOP;
}

private DefaultLogBuilder getLogBuilder(Level level) {
/**
* Returns a log builder that logs at the specified level.
*
* @since 2.20.0
*/
protected LogBuilder getLogBuilder(Level level) {
DefaultLogBuilder builder = logBuilder.get();
return Constants.ENABLE_THREADLOCALS && !builder.isInUse() ? builder : new DefaultLogBuilder(this, level);
return Constants.ENABLE_THREADLOCALS && !builder.isInUse() ? builder.reset(this, level)
: new DefaultLogBuilder(this, level);
}

}
Loading

0 comments on commit 113a8e8

Please sign in to comment.