如何让嵌入式Tomcat 9的Log4J2日志输出到GUI指定OutputStream？

接手了一个嵌入式Tomcat 9服务器的监控管理GUI代码库，GUI包含日志面板用于查看日志及排查问题。当前已实现将GUI应用日志绑定到一个面板的OutputStream，但无法将Tomcat服务器实例的日志绑定到另一个面板。推测原因是Tomcat拥有独立的日志上下文，无法感知主应用的上下文及OutputStream。技术栈为Log4j2-2.26.0、Tomcat 9、Java 1.8。

相关代码片段：

LogPanel类 #

public LogPanel(WebserverProperties properties) {
    initComponents();

    Level logLevel = properties.getServerLogLevel();

    PluginLogInfo[] logs = new PluginLogInfo[] {
        new PluginLogInfo("org.apache.catalina", logLevel),
        new PluginLogInfo("org.apache.coyote", logLevel),
        new PluginLogInfo("org.apache.log4j", logLevel),
        new PluginLogInfo("path.to.application", logLevel)
    };

    PluginLogScrollPane serverLogPane = new PluginLogScrollPane(logs);

    logTabbedPane.addTab("Web Server", serverLogPane);

    pluginMap = new HashMap<String, PluginLogScrollPane>();

    PluginLogScrollPane exploreLogPane = new PluginLogScrollPane(new PluginLogInfo[] {
        new PluginLogInfo("path.to.webserver", logLevel)
    });
    logTabbedPane.addTab("Explore", exploreLogPane);
    pluginMap.put("Explore", exploreLogPane);
    exploreLogPane.requestFocusInWindow();
    logTabbedPane.setSelectedComponent(exploreLogPane);
}

PluginLogScrollPane类 #

public PluginLogScrollPane(PluginLogInfo[] logPackages) {
    this.myPackages = ObjectUtils.firstNonNull(logPackages, new PluginLogInfo[0]);

    // Setup the visual elements
    this.myLog = new StreamedJTextArea(20, 40);
    this.myLog.setFont(new Font(Font.MONOSPACED, Font.PLAIN, 10));
    this.setViewportView(this.myLog);

    if (this.myPackages.length == 0) {
        this.myLog.append("No logging information is available for this plugin.");
        return;
    }

    this.myAppender = ImatLoggerConfig.createAppender("PanelAppender", this.myLog.getOutputStream());

    for (PluginLogInfo logPackage : this.myPackages) {
        ImatLoggerConfig.createConfig(logPackage.getPackageName(), logPackage.getLogLevel(), myAppender);
    }
}

ImatLoggerConfig核心方法 #

public static OutputStreamAppender createAppender(String name, OutputStream output) {
    OutputStreamAppender.Builder<?> appenderBuilder = OutputStreamAppender.newBuilder();
    appenderBuilder.setName(name + panelCount);

    appenderBuilder.setTarget(output);
    appenderBuilder.setLayout(ImatLoggerConfig.getPatternLayout());
    appenderBuilder.setIgnoreExceptions(true);
    OutputStreamAppender result = appenderBuilder.build();
    result.start();

    getContext().getConfiguration().addAppender(result);

    panelCount++;
    return result;
}

public static void createConfig(String packageName, Level level, Appender appender) {
    Configuration config = getContext().getConfiguration();

    Configurator.setLevel(packageName, level);
    LoggerConfig.Builder<?> loggerConfigBuilder = LoggerConfig.newBuilder();
    loggerConfigBuilder.setLevel(level);
    loggerConfigBuilder.setAdditivity(false);
    loggerConfigBuilder.setLoggerName(packageName);
    loggerConfigBuilder.setConfig(config);

    config.addLogger(packageName, loggerConfigBuilder.build());
    config.addLoggerAppender(context.getLogger(packageName), appender);

    context.getLogger(ImatLoggerConfig.class).info("Created configs for {} | {}", packageName, appender.getName());

    context.updateLoggers();
}

1. 统一Tomcat与主应用的日志上下文 #

Tomcat默认通过独立类加载器加载日志组件，导致与主应用Log4j2上下文隔离，可通过以下方式统一：

• 排除Tomcat自带的日志依赖（如tomcat-juli、tomcat-juli-adapters），确保全应用仅使用主应用的Log4j2依赖。
• 在嵌入式Tomcat启动前，设置系统属性强制Tomcat使用主应用的LogManager：

System.setProperty("java.util.logging.manager", "org.apache.logging.log4j.jul.LogManager");

• 确保Log4j2上下文在Tomcat启动前完成初始化，让Tomcat启动时直接复用该上下文。

2. 手动为Tomcat日志记录器绑定自定义Appender #

若不想修改类加载器，可在Tomcat启动完成后，重新获取Tomcat核心日志包对应的LoggerConfig，手动添加OutputStreamAppender：

• 新增绑定Tomcat日志的方法：

// Tomcat启动完成后调用此方法
public static void bindTomcatLogsToPanel(OutputStream outputStream, Level logLevel) {
    OutputStreamAppender appender = createAppender("TomcatPanelAppender", outputStream);
    String[] tomcatLogPackages = {"org.apache.catalina", "org.apache.coyote", "org.apache.tomcat"};
    for (String pkg : tomcatLogPackages) {
        createConfig(pkg, logLevel, appender);
        // 强制更新日志上下文
        LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
        ctx.updateLoggers();
    }
}

• 调整LogPanel初始化逻辑，延迟绑定Tomcat日志：

private OutputStream tomcatLogOutputStream;
private WebserverProperties properties;

public LogPanel(WebserverProperties properties) {
    this.properties = properties;
    initComponents();
    Level logLevel = properties.getServerLogLevel();

    // 先初始化应用日志面板
    PluginLogScrollPane exploreLogPane = new PluginLogScrollPane(new PluginLogInfo[] {
        new PluginLogInfo("path.to.webserver", logLevel)
    });
    logTabbedPane.addTab("Explore", exploreLogPane);
    pluginMap = new HashMap<>();
    pluginMap.put("Explore", exploreLogPane);
    exploreLogPane.requestFocusInWindow();
    logTabbedPane.setSelectedComponent(exploreLogPane);

    // 初始化Tomcat日志面板，暂不绑定日志
    PluginLogScrollPane serverLogPane = new PluginLogScrollPane(new PluginLogInfo[0]);
    logTabbedPane.addTab("Web Server", serverLogPane);
    tomcatLogOutputStream = serverLogPane.myLog.getOutputStream();
}

// 在Tomcat启动完成后调用
public void bindTomcatLogs() {
    Level logLevel = properties.getServerLogLevel();
    ImatLoggerConfig.bindTomcatLogsToPanel(tomcatLogOutputStream, logLevel);
}

3. 调整Tomcat类加载器配置 #

确保Tomcat使用主应用的类加载器加载日志相关类，避免上下文隔离：

Tomcat tomcat = new Tomcat();
// 其他Tomcat初始化逻辑...
Context context = tomcat.addWebapp("", new File("webapp").getAbsolutePath());
// 设置Tomcat Web应用的父类加载器为主应用类加载器
context.setParentClassLoader(getClass().getClassLoader());

• 确保Log4j2配置文件中未覆盖Tomcat日志包的Logger配置，保持additivity=false以避免日志重复输出。
• 确认log4j-jul依赖已引入，保证JUL（Tomcat默认日志框架）的日志能桥接到Log4j2处理。

内容的提问来源于stack exchange，提问作者Nathan S