Logback中KeyValuePairs无法在日志中输出问题求助

核心原因 #

你遇到的问题主要来自两个关键点：

• 依赖缺失或版本不兼容：StructuredArguments和%kvp转换词属于logstash-logback-encoder库，而非SLF4J或Logback原生组件，若未引入该依赖，Logback无法识别%kvp。
• 配置错误：默认的Logback PatternLayout不支持%kvp转换词，必须使用logstash提供的扩展布局类；同时错误的%kvp{}语法（空括号）也会导致无输出。

解决方案 #

1. 确保引入正确依赖

在项目的依赖管理中添加logstash-logback-encoder，版本需与你的Logback版本兼容（Logback 1.2.x对应encoder 7.x，Logback 1.3.x对应encoder 8.x）：

Maven示例：

<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>7.4</version> <!-- 选择与Logback兼容的版本 -->
</dependency>

Gradle示例：

implementation 'net.logstash.logback:logstash-logback-encoder:7.4'

2. 修改Logback配置文件

将控制台appender的布局替换为logstash提供的PatternLayout，并修正%kvp的使用语法：

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <!-- 使用logstash扩展的PatternLayout，而非默认的ch.qos.logback.classic.PatternLayout -->
            <layout class="net.logstash.logback.layout.PatternLayout">
                <!-- %kvp{INCLUDE_MDC=false} 表示只显示通过StructuredArguments传入的键值对，排除MDC内容 -->
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg %kvp{INCLUDE_MDC=false} %mdc%n</pattern>
            </layout>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

3. 验证代码中的参数传递

确保代码中导入的是net.logstash.logback.argument.StructuredArguments的kv方法，传递参数的方式正确：

import net.logstash.logback.argument.StructuredArguments;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

public class LogTest {
    private static final Logger logger = LoggerFactory.getLogger(LogTest.class);

    public static void main(String[] args) {
        // 通过StructuredArguments传递独立键值对
        logger.info("用户登录成功", 
                    StructuredArguments.kv("user_id", "1001"), 
                    StructuredArguments.kv("login_ip", "192.168.0.10"));
        
        // MDC存储链路追踪等全局信息
        MDC.put("trace_id", "trace-abc-123");
        logger.info("数据处理完成", StructuredArguments.kv("data_size", "2048KB"));
    }
}

4. 可选：调整kvp输出格式

若需要自定义键值对的分隔符、引号规则等，可通过%kvp的参数配置，例如：

<pattern>%msg %kvp{SEPARATOR=, KEY_VALUE_SEPARATOR=:, QUOTE_VALUES=true}%n</pattern>

输出会变为：用户登录成功 user_id:"1001", login_ip:"192.168.0.10"

验证效果 #

配置完成后，控制台输出的日志会清晰区分通过StructuredArguments传入的键值对和MDC内容，例如：

2024-05-20 16:05:30.456 [main] INFO  com.example.LogTest - 用户登录成功 user_id="1001" login_ip="192.168.0.10" {}
2024-05-20 16:05:30.457 [main] INFO  com.example.LogTest - 数据处理完成 data_size="2048KB" {trace_id="trace-abc-123"}

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