Make MockLogAppender threadsafe #108206
Make MockLogAppender threadsafe #108206
Conversation
Adding and removing appenders in Log4j is not threadsafe. Yet some tests rely on capturing logging by adding an in memory appender, MockLogAppender. This commit makes the mock logging threadsafe by creating a new, singular appender for mock logging that delegates, in a threadsafe way, to the existing appenders created. Confusingly MockLogAppender is no longer really an appender, but I'm leaving clarifying that for a followup so as to limit the scope of this PR. closes elastic#106425
rjernst
added
>test
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
elasticsearchmachine
added
Team:Core/Infra
| @@ -31,12 +33,35 @@ | |||
| /** | |||
| * Test appender that can be used to verify that certain events were logged correctly | |||
| */ | |||
| public class MockLogAppender extends AbstractAppender { | |||
| public class MockLogAppender { | |||
There was a problem hiding this comment.
Q: since this is no longer an appender, could this break things in serverless? (if tests there use something like Loggers.addAppender(mockAppender))
There was a problem hiding this comment.
It will "break" things, but I have the necessary changes ready.
| mockAppenders.compute(logger, (k, v) -> { | ||
| assert v != null; | ||
| v.remove(this); | ||
| return v.isEmpty() ? null : v; |
There was a problem hiding this comment.
TIL: compute remappingFunction returning null removes the mapping. Nice!
|
|
||
| private static final Logger logger = LogManager.getLogger(MockLogAppender.class); |
There was a problem hiding this comment.
I don't understand why do we need this. What I'm missing?
There was a problem hiding this comment.
Leftover from debugging, will remove
| @@ -259,6 +259,7 @@ public static void resetPortCounter() { | |||
| // TODO: consolidate logging initialization for tests so it all occurs in logconfigurator | |||
| LogConfigurator.loadLog4jPlugins(); | |||
| LogConfigurator.configureESLogging(); | |||
| MockLogAppender.init(); | |||
There was a problem hiding this comment.
This needs to be called every time we (re) configure log4j in tests, right?
So besides the special case above, ESTestCase (should) cover all, correct?
There was a problem hiding this comment.
Yep, any tests subclassing LuceneTestCase directly will need to call it if they use MockLogAppender.
| private final List<WrappedLoggingExpectation> expectations; | ||
| private final AtomicBoolean isAlive = new AtomicBoolean(true); |
There was a problem hiding this comment.
Does this need to be an AtomicBoolean? Couldnt it just be a volatile boolean?
There was a problem hiding this comment.
Same in WrappedLoggingExpectation
|
(btw, CI test failure looks related but should be fixable) |
Adding and removing appenders in Log4j is not threadsafe. Yet some tests rely on capturing logging by adding an in memory appender, MockLogAppender. This commit makes the mock logging threadsafe by creating a new, singular appender for mock logging that delegates, in a threadsafe way, to the existing appenders created. Confusingly MockLogAppender is no longer really an appender, but I'm leaving clarifying that for a followup so as to limit the scope of this PR. closes elastic#106425
Adding and removing appenders in Log4j is not threadsafe. Yet some tests rely on capturing logging by adding an in memory appender, MockLogAppender. This commit makes the mock logging threadsafe by creating a new, singular appender for mock logging that delegates, in a threadsafe way, to the existing appenders created. Confusingly MockLogAppender is no longer really an appender, but I'm leaving clarifying that for a followup so as to limit the scope of this PR.
closes #106425