Log4J2 JSONLAYOUT 如何添加自定义参数

Question

如何将自定义参数添加到 Log4j2 的 JSONLAYOUT？

还有一种方法可以将模式添加到 JSONLAYOUT 的消息元素中吗？

我已经尝试了这里列出的选项 ->
logging.apache.org/log4j/2.x/manual/layouts.html#JSONLayout

请帮忙！

Answer 1

据我了解，您正在寻找一种方法来自定义 JSON 输出的格式，其JSONLayout方式类似于PatternLayout通过指定“转换模式”自定义 的方式。

我相信答案是您不能JSONLayout以相同的方式自定义。您可以选择要包含在消息中的各种信息。例如，文档显示的参数如下properties：

如果为 true，则 appender 在生成的 JSON 中包含线程上下文映射。默认为假。

因此，您可以设置各种参数以包含某些类型的信息，但您无法直接控制包含的特定项目。

您可以做的是ObjectMessage与 JSON 库一起使用来生成 JSON 消息。但是，这会在 JSON 中生成 JSON（假设您仍然希望使用JSONLayout这种方法）。下面是一些示例代码来说明：

具有生成日志消息的 main 方法的类：

package example;

import java.util.HashMap;
import java.util.Map;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.json.JSONObject;

public class JsonMessageExample {

    private static final Logger log = LogManager.getLogger();
    
    public static void main(String[] args) {
        Map<String,String> msgMap = new HashMap<>();
        msgMap.put("myKey", "myValue");
        JSONObject message = new JSONObject(msgMap);
        log.info(message);
    }
}

log4j2.xml 配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <JSONLayout/>
        </Console>

    </Appenders>

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

上面的输出：

{
  "timeMillis" : 1510429852038,
  "thread" : "main",
  "level" : "INFO",
  "loggerName" : "example.JsonMessageExample",
  "message" : "{\"myKey\":\"myValue\"}",
  "endOfBatch" : false,
  "loggerFqcn" : "org.apache.logging.log4j.spi.AbstractLogger",
  "threadId" : 1,
  "threadPriority" : 5
}

如您所见，消息名称值对的值是 JSON 字符串。为了解析它，您必须将外部对象解析为 JSON，拉取消息字段，然后也将其值解析为 JSON。

但是，如果您使用不同的布局，例如这样的非常基本的布局PatternLayout：<PatternLayout pattern="%m%n"/>

您将只能生成一层 JSON 输出，因此只需解析一次。但是，您必须编写逻辑来获取消息中需要的所有数据并将其填充到地图（和 JSON 对象）中，因为现在您只是在转储地图的内容。

使用相同的 java 代码并将布局更改PatternLayout为如上所述的示例输出：

{"myKey":"myValue"}

编辑：

如果您想使用PatternLayoutJSON 格式的“转换模式”输出日志，并且不必编写逻辑来获取某些细节，您甚至可以执行以下操作：

<PatternLayout>
    <pattern>{"timeMillis":"%d{UNIX_MILLIS}","thread":"%t","level":"%p","loggerName":"%c","message":%m}%n</pattern>
</PatternLayout>

示例输出：

{"timeMillis":"1510455694601","thread":"main","level":"INFO","loggerName":"example.JsonMessageExample","message":{"myKey":"myValue"}}

Answer 2

解决办法是显式添加log4j2的2.10.0版本。此版本支持 JSONLayout 中的自定义参数！

<Appenders>

    <Console name="Console" target="SYSTEM_OUT">
        <JSONLayout compact="true" eventEol="true">
            <KeyValuePair key="application" value="${sys:com.example.appname}"/>
        </JSONLayout>
    </Console>
    <Async name="AsyncAppender" bufferSize="80">
        <AppenderRef ref="Console"/>
    </Async>

</Appenders>