Log4j2 JSON布局：在UTC中添加自定义日期字段

Log4j2支持JSON Layout，其中我在log4j2.xml中添加了一个额外的定制字段：

<JsonLayout compact="true" eventEol="true" stacktraceAsString="true">
    <KeyValuePair key="@timestamp" value="$${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}"/>
</JsonLayout>

一般来说，一切正常，但此日志由Filebeats处理，并假定该日期以UTC表示。

所有日志条目都具有当地时区的日期值。

是否可以以UTC格式输出日期？

---

解决方案

您可以create your own lookup，因为我相信您已经知道，KeyValuePair支持根据manual page you shared在其值属性中进行查找。

出于示例目的，我创建了一个使用System.currentTimeMillis()的简单查找。

以下是示例代码：

首先，查找类：

package utcTime;

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.lookup.StrLookup;

@Plugin(name = "UtcMillis", category = "Lookup")
public class UtcMillisLookup implements StrLookup{
    /**
     * Lookup the value for the key.
     * @param key  the key to be looked up, may be null
     * @return The value for the key.
     */
    public String lookup(String key) {
        return String.valueOf(getUTCMillis());
    }

    /**
     * @return current UTC time in milliseconds
     */
    private long getUTCMillis(){
        return System.currentTimeMillis();
    }

    /**
     * Lookup the value for the key using the data in the LogEvent.
     * @param event The current LogEvent.
     * @param key  the key to be looked up, may be null
     * @return The value associated with the key.
     */
    public String lookup(LogEvent event, String key) {
        return String.valueOf(getUTCMillis());
    }
}

接下来，log4j2.xml配置文件：

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

    </Appenders>

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

请注意，查找没有参数/键，因此您可以将该部分保留为空/空白，但您仍然必须使用冒号(:)，这就是您在上面的配置中看到$${UtcMillis:}的原因。

最后，生成日志事件的简单类：

package utcTime;

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

public class MainUtcLookup {
    private static final Logger log = LogManager.getLogger();
    public static void main(String[] args){
        log.info("Here's some info!");
    }
}

以下是示例输出：

{  
   "thread":"main",
   "level":"INFO",
   "loggerName":"utcTime.MainUtcLookup",
   "message":"Here's some info!",
   "endOfBatch":false,
   "loggerFqcn":"org.apache.logging.log4j.spi.AbstractLogger",
   "instant":{  
      "epochSecond":1534642997,
      "nanoOfSecond":556000000
   },
   "threadId":1,
   "threadPriority":5,
   "@timestamp":"1534642997558"
}

我不打算深入研究您可以获得以UTC毫秒为单位的当前时间的所有不同方法的细节，因为我相信您可以自己研究这一细节。我只是想提供一个示例，说明如何实现将毫秒时间戳添加到log4j2JSONLayout的主要目标。

希望这能有所帮助！