slf4j：如何记录格式化消息、对象数组、异常

Question

记录填充消息和异常堆栈跟踪的正确方法是什么？

logger.error(
    "\ncontext info one two three: {} {} {}\n",
    new Object[] {"1", "2", "3"},
    new Exception("something went wrong"));

我想产生与此类似的输出：

context info one two three: 1 2 3
java.lang.Exception: something went wrong
stacktrace 0
stacktrace 1
stacktrace ...

slf4j 版本 1.6.1

Answer 1

从 SLF4J 1.6.0 开始，在存在多个参数的情况下，如果日志语句中的最后一个参数是异常，那么 SL​​F4J 将假定用户希望将最后一个参数视为异常而不是简单参数。 另请参阅相关的常见问题解答条目。

所以，写作（在 SLF4J 1.7.x 及更高版本中）

 logger.error("one two three: {} {} {}", "a", "b", 
              "c", new Exception("something went wrong"));

或写作（在 SLF4J 版本 1.6.x 中）

 logger.error("one two three: {} {} {}", new Object[] {"a", "b", 
              "c", new Exception("something went wrong")});

会屈服

one two three: a b c
java.lang.Exception: something went wrong
    at Example.main(Example.java:13)
    at java.lang.reflect.Method.invoke(Method.java:597)
    at ...

确切的输出将取决于底层框架（例如 logback、log4j 等）以及底层框架的配置方式。 但是，如果最后一个参数是异常，则无论底层框架如何，它都会被解释为异常。

Answer 2

除了@Ceki 的回答，如果您在项目中使用 logback 并设置配置文件（通常是 logback.xml），您还可以定义日志以绘制堆栈跟踪

<encoder>
    <pattern>%date |%-5level| [%thread] [%file:%line] - %msg%n%ex{full}</pattern> 
</encoder>

模式中的 %ex 是与众不同的

Answer 3

接受的答案很棒。 我只是在这里添加我现在正在工作的案例，感谢您的回答。 这可能会帮助其他人。

我正在使用SLF4J和带有 JSON 编码器的logback 。 此外，我使用marker和arguments来丰富我的输出。

    logger.error(getMarker("errorEvent"),
                 "An error occurred",
                 entries(mapOf("someKey" to "someValue")),
                 new Exception())

输出：

{
   "level": "ERROR",
   "event": "errorEvent",
   "eventData": {
      "someKey": "someValue"
   },
   "stacktrace": "...omitted...",
   "message": "An error occurred"
}

当然在幕后有很多logstash的配置，但我只是想表明作为entries传递的arguments显示在配置的eventData标签中。