在JsonLayout中添加MDC变量-log4j2

时间:2018-09-21 15:08:48

标签: spring-boot logging log4j2 mdc

如何在log4j2的JsonLayout生成的json日志中添加MDC变量。我已经使用KeyValuePair标记将诸如主机名之类的属性添加到日志中,但是我没有找到将MDC变量添加到其中的任何方法。在模式布局中,我使用了%X {traceId},但我确定JsonLayout不能解析这些转换字符(据我所知,转换字符仅由模式布局使用)。我进入了JsonLayout的源代码,但没有找到实际将所有数据放入日志消息的功能。

谢谢。

1 个答案:

答案 0 :(得分:2)

您要寻找的是log4j2 lookup。听起来像您提到MDC时对Context Map Lookup特别感兴趣(顺便说一句,现在在log4j2中将其称为ThreadContext)。

这是一个简单的示例:

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"
}