Spring Boot中Logstash JSON Appender换行失效，如何输出可读堆栈？

1. 修正日志打印代码 #

别用ArrayUtils.toString手动转换异常堆栈，直接把异常对象传给日志方法即可，日志框架会自动处理堆栈结构：

// 简单写法
log.error("出问题了", e);
// 带具体业务描述的写法
log.error("处理数据时发生错误", e);

不用自己拼接字符串和换行符，框架会完整保留堆栈的原始格式。

2. 调整Logback配置，让JSON日志包含异常堆栈 #

你当前的logstash-json-appender.xml中，JSON_CONSOLE的编码器只输出了基础字段，未包含异常堆栈，需要补上这部分配置：

方法一：直接在pattern中添加堆栈字段 #

修改JSON_CONSOLE里的<pattern>节点，新增stackTrace字段：

<pattern>
    {
    "level": "%level",
    "service": "${appName:-}",
    "traceId": "%X{traceId:-}",
    "spanId": "%X{spanId:-}",
    "parentSpanId": "%X{parentSpanId:-}",
    "pid": "${PID:-}",
    "thread": "%thread",
    "class": "%logger{40}",
    "message": "%message",
    "stackTrace": "%exception{full}"
    }
</pattern>

%exception{full}会输出完整的异常堆栈，其中的换行符会被JSON编码器正确处理，在支持JSON格式化的工具中会自动显示为换行。

方法二：用专门的堆栈配置（更灵活） #

如果需要自定义堆栈的显示规则（比如限制行数、优先显示根因），可以在<providers>节点中添加<stackTrace>配置：

<providers>
    <timestamp>
        <timeZone>UTC</timeZone>
    </timestamp>
    <pattern>
        <pattern>
            {
            "level": "%level",
            "service": "${appName:-}",
            "traceId": "%X{traceId:-}",
            "spanId": "%X{spanId:-}",
            "parentSpanId": "%X{parentSpanId:-}",
            "pid": "${PID:-}",
            "thread": "%thread",
            "class": "%logger{40}",
            "message": "%message"
            }
        </pattern>
    </pattern>
    <!-- 新增异常堆栈配置 -->
    <stackTrace>
        <fieldName>stackTrace</fieldName>
        <throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
            <maxDepthPerThrowable>30</maxDepthPerThrowable> <!-- 每个异常最多显示30行堆栈 -->
            <rootCauseFirst>true</rootCauseFirst> <!-- 优先打印根异常 -->
            <inlineHash>true</inlineHash> <!-- 添加异常哈希值，方便重复异常排查 -->
        </throwableConverter>
    </stackTrace>
</providers>

为什么之前的方法无效？ #

• 手动用ArrayUtils.toString转换堆栈得到的是逗号分隔的单行字符串，即便替换逗号为\n，JSON编码器会自动将\n转义为\\n，导致换行无法生效。
• 日志框架本身内置了异常处理逻辑，手动转换堆栈属于冗余且错误的操作。

验证效果 #

修改完成后，日志会输出包含stackTrace字段的JSON结构，其中的堆栈轨迹会保留正确的换行格式：

{
  "timestamp": "2024-05-20T12:34:56.789Z",
  "level": "ERROR",
  "service": "你的应用名",
  "traceId": "abc123",
  "message": "处理数据时发生错误",
  "stackTrace": "java.lang.IllegalArgumentException: 输入无效\n    at com.example.YourClass.yourMethod(YourClass.java:42)\n    at ..."
}

使用Kibana、Logstash Dashboard等工具查看日志时，会自动将\n解析为换行，堆栈结构清晰可读。

内容的提问来源于stack exchange，提问作者user1354825