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

时间:2018-08-17 14:14:11

标签: java log4j2

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输出日期?

1 个答案:

答案 0 :(得分:5)

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

出于示例目的,我创建了一个使用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毫秒为单位的当前时间的所有不同方式的细节,因为我敢肯定您可以自己研究该细节。我只是想提供一个示例,说明如何实现将毫秒级时间戳添加到log4j2 JSONLayout中的主要目标。

希望这会有所帮助!

相关问题