Spring Boot项目中为特定日志添加额外键值对的标准方案

针对你的需求，Log4j2官方推荐的实现方式主要有以下几种，无需单纯依赖过滤器，而是结合日志上下文或标记来精准控制：

方法一：使用MDC（ThreadContext）手动标记（推荐，灵活可控） #

这是最常用的显式标记方式，适合在业务代码中明确指定哪些日志需要添加标签：

1. 业务代码中添加MDC标记：
   在输出特殊日志的代码块中，将键值对存入MDC，日志输出后务必移除（避免线程池复用导致的上下文污染）：

// 注入Logger
private static final Logger logger = LogManager.getLogger(YourClass.class);

// 标记特殊日志并输出
ThreadContext.put("log_type", "special_business");
try {
    logger.info("这是一条用于特殊业务场景的日志");
} finally {
    // 必须清理MDC，防止线程复用残留
    ThreadContext.remove("log_type");
}

2. 修改Logstash模板读取MDC字段：
   打开你的LogstashLayout.json模板，添加MDC字段的解析逻辑，比如：

"log_type": "${mdc:log_type:-}"

模板会自动读取MDC中的log_type值，不存在则输出空字符串（可根据需求调整默认值）。

方法二：使用自定义Marker标记（适合统一管理特殊日志类型） #

如果希望通过日志标记统一识别特殊日志，无需在业务代码中操作MDC，可以采用这种方式：

1. 定义全局Marker：

import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.MarkerManager;

public class LogMarkers {
    // 定义特殊日志的Marker
    public static final Marker SPECIAL_BUSINESS = MarkerManager.getMarker("SPECIAL_BUSINESS");
}

2. 输出日志时携带Marker：

logger.info(LogMarkers.SPECIAL_BUSINESS, "这是一条带专属标记的特殊日志");

3. 修改Logstash模板根据Marker添加标签：
   在模板中加入条件判断，识别指定Marker并添加标签：

"log_type": "${marker:contains(SPECIAL_BUSINESS) ? 'special_business' : ''}"

方法三：使用RewriteAppender结合规则过滤（无侵入式自动标记） #

如果不需要修改业务代码，希望通过日志内容、Logger名称等规则自动标记，可以用RewriteAppender修改日志事件：

1. 修改log4j2.xml配置：
   添加RewriteAppender作为代理，将原始Console Appender作为目标：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <!-- 原始Console Appender -->
        <Console name="consoleOriginal" target="SYSTEM_OUT">
            <JsonTemplateLayout eventTemplateUri="classpath:LogstashLayout.json"/>
        </Console>
        <!-- RewriteAppender用于修改日志事件 -->
        <Rewrite name="rewriteAppender">
            <AppenderRef ref="consoleOriginal"/>
            <!-- 自定义规则策略 -->
            <SpecialLogRewritePolicy/>
        </Rewrite>
    </Appenders>
    <Loggers>
        <AsyncRoot level="info" additivity="false">
            <!-- 引用RewriteAppender -->
            <AppenderRef ref="rewriteAppender"/>
        </AsyncRoot>
    </Loggers>
</Configuration>

2. 实现自定义RewritePolicy：

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.appender.rewrite.RewritePolicy;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.impl.MutableLogEvent;

@Plugin(name = "SpecialLogRewritePolicy", category = "Core", elementType = "rewritePolicy", printObject = true)
public class SpecialLogRewritePolicy implements RewritePolicy {

    @PluginFactory
    public static SpecialLogRewritePolicy create() {
        return new SpecialLogRewritePolicy();
    }

    @Override
    public LogEvent rewrite(LogEvent event) {
        MutableLogEvent mutableEvent = new MutableLogEvent(event);
        // 自定义匹配规则：比如包含特定关键词、Logger名称匹配等
        if (event.getMessage().getFormattedMessage().contains("[SPECIAL]") 
            || event.getLoggerName().startsWith("com.example.special")) {
            mutableEvent.getContextData().put("log_type", "special_business");
        }
        return mutableEvent;
    }
}

方案选择建议 #

• 优先选方法一或方法二：这两种都是Log4j2官方推荐的显式标记方式，可控性强，能精准定位特殊日志，避免规则匹配的误判。
• 方法三适合无侵入式场景：不需要业务代码修改，但需要维护规则逻辑，适合批量匹配固定模式的日志。

内容的提问来源于stack exchange，提问作者V John