json - Json 格式的 API 日志记录

Question

我想将 API 请求/响应记录为 json 格式。

预期的 LogEntry 类似于

{ 
 "timestamp" : "...",
 "level" : "DEBUG",
 "headers" : [
    "header1" : "value1",
    "header2" : "value2",
    "header3" : "value3"
 ],
 "requestPayload" : "<Request Json>"   // prefereablly as sub-document, worst case string is fine.   
 "labels" : [        //key fields which can be used for searching the logentry
     "searchField1" : "....",
     "searchField2" : "....",
     "searchField3" : "...."
  ]
}

我的问题是:

使用 Logback，如何将嵌套字段(例如上面示例中的 header 、标签、requestPaylod)记录为 json 子文档。我尝试过 MDC，但仅限于
'String, String' 仅映射，并将第一级之后的所有字段视为字符串。

我讨厌为此编写自定义记录器，并希望使用经过验证的日志记录框架(logback/log4j)的优点来控制日志记录级别、时间戳日志事件等。

Answer 1

对于请求/响应日志，请尝试 Logbook和 logstash-logback-encoder .您将能够使用标记来添加结构化内容。

为了在 JSON 结构中添加“您自己的”字段，我编写了一个您可能会感兴趣的代码生成器，它添加了构建器支持:json-log-domain