是否有日志备份布局可以创建将消息参数作为属性的 JSON 对象?

2022-09-01 14:20:31

我想将日志事件作为具有参数化字符串消息的JSON对象发送到Loggly。我们的项目目前有很多代码,如下所示:

String someParameter = "1234";
logger.log("This is a log message with a parameter {}", someParameter);

我们目前使用Logback作为我们的SLF4J后端,Logback的JsonLayout将我们的ILogEvent对象序列化为JSON。因此,当我们的日志事件传送到 Loggly 时,它们看起来像这样:

{
    "message": "This is a log message with a parameter 1234",
    "level": INFO,
    ....
}

虽然这确实有效,但它会为每个值发送不同的字符串,从而使 Loggly 的自动过滤器几乎无用。messagesomeParameter

相反,我希望有一个布局来创建如下所示的JSON:

{
    "message": "This is a log message with a parameter {}",
    "level": INFO,
    "parameters": [
        "1234"
    ]
}

此格式将允许 Loggly 将消息的所有日志事件组合在一起,而不考虑 的值。This is a log message with a parametersomeParameter

看起来 Logstash 的 KV 过滤器就是这样做的 - 除了编写自己的布局来执行 ILogEvent 对象的自定义序列化之外,有没有办法使用 Logback 完成此任务?


答案 1

有一个用于Logback的JSON logstash编码器,logstash-logback-encoder


答案 2

所以对我来说,我试图记录执行时间,我创建了一个名为ExpersionTime的pojo,其中包含名称,方法,类,持续时间。

然后我能够创建它:

ExecutionTime time = new ExecutionTime("Controller Hit", methodName, className, sw.getTotalTimeMillis());

对于日志记录,我随后使用了:

private final Logger logger = LoggerFactory.getLogger(this.getClass());
logger.info(append("metric", time), time.toString());

确保您拥有:

import static net.logstash.logback.marker.Markers.append;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

这将记录如下内容:

{  
   "ts":"2017-02-16T07:41:36.680-08:00",
   "msg":"ExecutionTime [name=Controller Hit, method=setupSession, className=class com.xxx.services.controllers.SessionController, duration=3225]",
   "logger":"com.xxx.services.metrics.ExecutionTimeLogger",
   "level":"INFO",
   "metric":{  
      "name":"Controller Hit",
      "method":"setupSession",
      "className":"class com.xxx.services.controllers.SessionController",
      "duration":3225
   }
}

可能是一个不同的设置,因为我使用logback-spring.xml将我的日志输出到json:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>
    <property name="PROJECT_ID" value="my_service"/>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>app/logs/${PROJECT_ID}.json.log</File>
        <encoder class="net.logstash.logback.encoder.LogstashEncoder">
            <fieldNames>
                <timestamp>ts</timestamp>
                <message>msg</message>
                <thread>[ignore]</thread>
                <levelValue>[ignore]</levelValue>
                <logger>logger</logger>
                <version>[ignore]</version>
            </fieldNames>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <maxIndex>10</maxIndex>
            <FileNamePattern>app/logs/${PROJECT_ID}.json.log.%i</FileNamePattern>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>20MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    <logger name="com.xxx" additivity="false" level="DEBUG">
        <appender-ref ref="FILE"/>
        <appender-ref ref="CONSOLE"/>
    </logger>
    <root level="WARN">
        <appender-ref ref="FILE"/>
    </root>
</configuration>