Skip to content
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

Jump to bottom

TESTS: Check for Netty resource leaks #31861

Merged
merged 3 commits into from
Jul 20, 2018
Merged

TESTS: Check for Netty resource leaks #31861

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7b0635
TESTS: Check for Netty resource leaks
original-brownbear Jul 5, 2018
2d372cd
Merge remote-tracking branch 'elastic/master' into 20398
original-brownbear Jul 20, 2018
43ed1d8
CR: Stop netty leak logger on shutdown
original-brownbear Jul 20, 2018
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
32 changes: 32 additions & 0 deletions test/framework/src/main/java/org/elasticsearch/test/ESTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,12 @@
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.config.Configurator;
import org.apache.logging.log4j.core.layout.PatternLayout;
import org.apache.logging.log4j.status.StatusConsoleListener;
import org.apache.logging.log4j.status.StatusData;
import org.apache.logging.log4j.status.StatusLogger;
Expand Down Expand Up @@ -179,6 +183,8 @@ public abstract class ESTestCase extends LuceneTestCase {

private static final AtomicInteger portGenerator = new AtomicInteger();

private static final Collection<String> nettyLoggedLeaks = new ArrayList<>();

@AfterClass
public static void resetPortCounter() {
portGenerator.set(0);
Expand All @@ -188,6 +194,25 @@ public static void resetPortCounter() {
System.setProperty("log4j.shutdownHookEnabled", "false");
System.setProperty("log4j2.disable.jmx", "true");

// Enable Netty leak detection and monitor logger for logged leak errors
System.setProperty("io.netty.leakDetection.level", "advanced");
String leakLoggerName = "io.netty.util.ResourceLeakDetector";
Logger leakLogger = LogManager.getLogger(leakLoggerName);
Appender leakAppender = new AbstractAppender(leakLoggerName, null,
PatternLayout.newBuilder().withPattern("%m").build()) {
@Override
public void append(LogEvent event) {
String message = event.getMessage().getFormattedMessage();
if (Level.ERROR.equals(event.getLevel()) && message.contains("LEAK:")) {
synchronized (nettyLoggedLeaks) {
nettyLoggedLeaks.add(message);
}
}
}
};
leakAppender.start();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's stop this on shutdown.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done in 43ed1d8

Loggers.addAppender(leakLogger, leakAppender);

// shutdown hook so that when the test JVM exits, logging is shutdown too
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
LoggerContext context = (LoggerContext) LogManager.getContext(false);
Expand Down Expand Up @@ -432,6 +457,13 @@ protected static void checkStaticState(boolean afterClass) throws Exception {
statusData.clear();
}
}
synchronized (nettyLoggedLeaks) {
try {
assertThat(nettyLoggedLeaks, empty());
} finally {
nettyLoggedLeaks.clear();
}
}
}

// this must be a separate method from other ensure checks above so suite scoped integ tests can call...TODO: fix that
Expand Down