如何将Log4j2 JSONLayout生成的默认JSON日志嵌套到自定义JSON中

Log4j2 2.24版本提供的JsonTemplateLayout可以完美实现你的需求——它支持自定义JSON结构模板，既能保留原JSON日志的完整内容作为嵌套字段，又能在外层添加自定义字段，完全避开MDC字段混入原日志结构的问题。

1. 补充依赖 #

如果是Maven项目，确保引入log-template-json模块（Log4j2的JSON模板布局依赖）：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-layout-template-json</artifactId>
    <version>2.24.0</version>
</dependency>

2. 编写自定义JSON模板 #

在类路径下创建模板文件（比如log-nested-template.json），定义外层JSON结构，将原日志内容映射到payload字段：

{
  "mycustomfield": "固定自定义标识",
  "thecustombusinessflow": "${ctx:businessFlow}",
  "payload": "$.event"
}

• mycustomfield：可直接写固定字符串，也支持用${ctx:xxx}从MDC/ThreadContext取动态值
• thecustombusinessflow：示例从MDC中读取businessFlow字段的值，你可替换为固定值或其他动态变量
• payload：$.event是固定语法，代表引用Log4j2生成的原始日志事件的完整JSON结构，也就是原JSONLayout输出的内容

3. 修改Log4j2配置文件 #

替换原有的JSONLayout为JsonTemplateLayout，指定模板文件并配置KafkaAppender：

<Configuration status="WARN">
  <Appenders>
    <Kafka name="KafkaNestedLogAppender" topic="your-target-topic">
      <JsonTemplateLayout templateLocation="classpath:log-nested-template.json" />
      <Property name="bootstrap.servers">kafka-host:9092</Property>
    </Kafka>
  </Appenders>
  <Loggers>
    <Root level="info">
      <AppenderRef ref="KafkaNestedLogAppender"/>
    </Root>
  </Loggers>
</Configuration>

4. 动态设置自定义字段（可选） #

如果thecustombusinessflow这类字段需要在业务代码中动态赋值，依然可以用MDC：

import org.apache.logging.log4j.ThreadContext;

// 业务流程中设置动态字段
ThreadContext.put("businessFlow", "user-checkout-flow");

// 输出日志
logger.info("用户完成支付");

// 线程复用场景下建议清除，避免字段污染
ThreadContext.remove("businessFlow");

为什么之前MDC不符合需求？ #

默认的JSONLayout会把MDC字段直接合并到日志JSON的根节点，无法实现嵌套结构。而JsonTemplateLayout通过模板完全自定义JSON结构，精准控制每个字段的位置，完美匹配你把原日志作为payload嵌套的需求。

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