在 JsonLayout 中添加 MDC 变量 - log4j2

Question

如何在log4j2的JsonLayout生成的json日志中添加MDC变量。我使用 KeyValuePair 标记将主机名等属性添加到日志中，但我没有找到任何方法将 MDC 变量添加到其中。在模式布局中，我使用了 %X{traceId} 但我确定 JsonLayout 无法解析那些转换字符（据我所知，转换字符仅由模式布局使用）。我进入了 JsonLayout 的源代码，但没有找到实际上将所有数据放入日志消息的函数。

谢谢。

Answer 1

您正在寻找的是您提到的 MDC（现在在 log4j2 中称为 ThreadContext）的 log4j2 lookup. It sounds like you're interested specifically in the Context Map Lookup。

这是一个简单的例子：

package example;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;

public class ThreadContextExample {

    private static final Logger log = LogManager.getLogger();

    public static void main(String[] args) {
        ThreadContext.put("myKey", "myValue");
        log.info("Here's a message!");
    }
}

这里是 log4j2.xml 配置：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <JsonLayout compact="false" eventEol="false" stacktraceAsString="true">
                <KeyValuePair key="myJsonKey" value="${ctx:myKey}"/>
            </JsonLayout>
        </Console>

    </Appenders>

    <Loggers>
        <Root level="debug">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

最后是一些示例输出（为了便于阅读而缩短）：

{
  "thread" : "main",
  "level" : "INFO",
  "loggerName" : "example.ThreadContextExample",
  "message" : "Here's a message!",
  ...
  "myJsonKey" : "myValue"
}

在 JsonLayout 中添加 MDC 变量 - log4j2

Add MDC variables in JsonLayout - log4j2

logging

mdc

log4j2

spring-boot