是否有一个Logback布局来创建以消息参数作为属性的JSON对象？

Question

我想将日志事件作为带有参数化字符串消息的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,
    ....
}

虽然这确实有效，但它为someParameter的每个值发送不同的消息字符串，这使得Loggly的自动过滤器几乎无用。

相反，我希望有一个创建JSON的Layout，它看起来像这样：

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

此格式允许Loggly将所有日志事件与消息一起分组这是一条带有参数的日志消息，而不管someParameter的值是多少。

看起来Logstash的KV过滤器是这样做的-除了编写自己的布局来执行ILogEvent对象的自定义序列化之外，有没有其他方法可以通过Logback完成这项任务？

Answer 1

您可以使用映射诊断上下文为每种类型的日志消息设置一个标记，然后您可以对其进行一次日志过滤。

根据JsonLayout的来源，戳记作为单独的值存储在JSON中。

Answer 2

所以对我来说，我试图记录执行时间，我创建了一个名为执行时间的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。将日志输出到json的xml：

<?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>

Answer 3

Logback有一个JSON logstash编码器，logstash-logback编码器