如何让LogBack兼容Spring Boot的结构化控制台日志？

当添加自定义logback-spring.xml时，Spring Boot的自动日志配置会被完全覆盖，原来的ECS格式编码器不会自动生效，必须手动配置对应的encoder才能恢复结构化日志输出。

具体配置方法 #

在你的logback-spring.xml中，给控制台appender指定ECS格式的JSON编码器，完整示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 引入Spring Boot默认日志配置，保留基础日志行为 -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

    <root level="INFO">
        <appender-ref ref="ECS_CONSOLE"/>
    </root>

    <!-- 配置ECS格式的控制台输出appender -->
    <appender name="ECS_CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <!-- 启用ECS格式提供者，自动生成符合规范的结构化日志 -->
                <ecs/>
            </providers>
        </encoder>
    </appender>
</configuration>

关键说明 #

• 依赖保障：确保项目已包含spring-boot-starter-logging（Spring Boot项目默认引入），它会自动携带logstash-logback-encoder库，这是ECS格式输出的核心依赖。
• 自定义字段扩展：如果需要在ECS日志中添加自定义字段，可以在<ecs>标签内添加配置，例如：

<ecs>
    <field name="service_name" value="my-spring-boot-app"/>
</ecs>

• 避免冲突：不要同时配置普通的PatternLayoutEncoder（文本格式编码器）和ECS的JSON编码器，否则会导致日志格式混乱。

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