Skip to content

Implement MessageFactory-namespaced logger registry #2936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Sep 16, 2024
Merged

Implement MessageFactory-namespaced logger registry #2936

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
9a70d3a
Deprecate `AbstractLogger.checkMessageFactory()`
vy Sep 9, 2024
55eb07b
Fix changelog entry
vy Sep 9, 2024
af527a0
Fix Spotless failures
vy Sep 9, 2024
be6c229
Implement `MessageFactory`-namespaced logger registry
vy Sep 11, 2024
e54dd2d
Have weak references to `Logger`s in `LoggerRegistry`
vy Sep 11, 2024
bffd590
Switch version bumps from `2.24.1` to `2.25.0`
vy Sep 11, 2024
c747f4f
Implement `equals()` and `hashCode()` for `LocalizedMessageFactory`
vy Sep 11, 2024
2e443df
Fix Spotless failures
vy Sep 11, 2024
fce83c2
Fix `bnd-baseline` failures
vy Sep 11, 2024
712fe91
Improve `LoggerContext#defaultMessageFactory` docs
vy Sep 12, 2024
f62b5c8
Merge remote-tracking branch 'origin/2.x' into feature/2.x/deprecate-…
vy Sep 13, 2024
cc0e729
Apply review feedback
vy Sep 13, 2024
3668f5d
Improve changelog
vy Sep 13, 2024
8ab9c4d
Merge remote-tracking branch 'origin/2.x' into feature/2.x/deprecate-…
vy Sep 15, 2024
a800776
Lazy initialize the default `MF` in `LC`
vy Sep 15, 2024
c1dff86
Use `Logger#getEffectiveMessageFactory()`
vy Sep 16, 2024
c581239
Fix Mockito failures
vy Sep 16, 2024
3a3e02c
Fix BND typo in `log4j-taglib/pom.xml`
vy Sep 16, 2024
952a9a5
Remove redundant changelog entry
vy Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions log4j-api/src/main/java/org/apache/logging/log4j/simple/SimpleLoggerContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.message.MessageFactory;
import org.apache.logging.log4j.simple.internal.SimpleProvider;
import org.apache.logging.log4j.spi.AbstractLogger;
import org.apache.logging.log4j.spi.ExtendedLogger;
import org.apache.logging.log4j.spi.LoggerContext;
import org.apache.logging.log4j.spi.LoggerRegistry;
Expand Down Expand Up @@ -100,7 +99,6 @@ public ExtendedLogger getLogger(final String name, final MessageFactory messageF
// Note: This is the only method where we add entries to the 'loggerRegistry' ivar.
final ExtendedLogger extendedLogger = loggerRegistry.getLogger(name, messageFactory);
if (extendedLogger != null) {
AbstractLogger.checkMessageFactory(extendedLogger, messageFactory);
return extendedLogger;
}
final SimpleLogger simpleLogger = new SimpleLogger(
Expand Down
3 changes: 3 additions & 0 deletions log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,10 @@ private static MessageFactory2 adaptMessageFactory(final MessageFactory result)
*
* @param logger The logger to check
* @param messageFactory The message factory to check.
* @deprecated Planned to be removed!
* Instead, in {@link LoggerContext#getLogger(String, MessageFactory)} implementations, namespace loggers with message factories.
*/
@Deprecated
public static void checkMessageFactory(final ExtendedLogger logger, final MessageFactory messageFactory) {
final String name = logger.getName();
final MessageFactory loggerMessageFactory = logger.getMessageFactory();
Expand Down
2 changes: 0 additions & 2 deletions log4j-core/src/main/java/org/apache/logging/log4j/core/LoggerContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@
import org.apache.logging.log4j.core.util.NetUtils;
import org.apache.logging.log4j.core.util.ShutdownCallbackRegistry;
import org.apache.logging.log4j.message.MessageFactory;
import org.apache.logging.log4j.spi.AbstractLogger;
import org.apache.logging.log4j.spi.LoggerContextFactory;
import org.apache.logging.log4j.spi.LoggerContextShutdownAware;
import org.apache.logging.log4j.spi.LoggerContextShutdownEnabled;
Expand Down Expand Up @@ -527,7 +526,6 @@ public Logger getLogger(final String name, final MessageFactory messageFactory)
// Note: This is the only method where we add entries to the 'loggerRegistry' ivar.
Logger logger = loggerRegistry.getLogger(name, messageFactory);
if (logger != null) {
AbstractLogger.checkMessageFactory(logger, messageFactory);
return logger;
}

Expand Down
2 changes: 0 additions & 2 deletions log4j-taglib/src/main/java/org/apache/logging/log4j/taglib/Log4jTaglibLoggerContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import javax.servlet.ServletContext;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.message.MessageFactory;
import org.apache.logging.log4j.spi.AbstractLogger;
import org.apache.logging.log4j.spi.ExtendedLogger;
import org.apache.logging.log4j.spi.LoggerContext;
import org.apache.logging.log4j.spi.LoggerRegistry;
Expand Down Expand Up @@ -60,7 +59,6 @@ public Log4jTaglibLogger getLogger(final String name, final MessageFactory messa
// Note: This is the only method where we add entries to the 'loggerRegistry' ivar.
Log4jTaglibLogger logger = this.loggerRegistry.getLogger(name, messageFactory);
if (logger != null) {
AbstractLogger.checkMessageFactory(logger, messageFactory);
return logger;
}

Expand Down
8 changes: 8 additions & 0 deletions src/changelog/.2.x.x/deprecate_AbstractLogger_checkMessageFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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="deprecated">
<issue id="2936" link="https://github.com/apache/logging-log4j2/pull/2936"/>
<description format="asciidoc">Deprecate `AbstractLogger.checkMessageFactory()`, since all created `Logger`s are already `MessageFactory`-namespaced</description>
</entry>