如何在Dropwizard中实现支持自定义字段的结构化日志？

核心问题说明 #

你当前用log.info("Unauthorized user", "email", userEmail)的写法，SLF4J会把后续参数当成消息模板占位符处理，而非结构化字段。要实现预期的JSON输出，需要用正确的API传递结构化属性，同时调整日志配置。

方法1：使用SLF4J 2.x结构化参数（推荐） #

Dropwizard 2.x及以上版本默认依赖SLF4J 2.x，支持KeyValuePair或Map形式的结构化参数，能直接将键值对嵌入JSON根节点。

代码示例

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.event.KeyValuePair;

public class YourServiceClass {
    private static final Logger log = LoggerFactory.getLogger(YourServiceClass.class);

    public void handleUnauthorizedUser(String userEmail) {
        // 用KeyValuePair传递结构化字段
        log.info("Unauthorized user", KeyValuePair.of("email", userEmail));
    }
}

调整日志配置

修改layout部分，添加arguments到includes列表，并开启flattenArguments：

appenders:
  - type: console
    target: stderr
    layout:
      type: json
      timestampFormat: "yyyy-MM-dd'T'HH:mm:ss.SSSZ"
      prettyPrint: false
      appendLineSeparator: true
      includes: [timestamp, threadName, level, loggerName, message, mdc, exception, arguments] # 新增arguments
      customFieldNames:
        timestamp: "@timestamp"
      additionalFields:
        service-name: "user-service"
      includesMdcKeys: [userId]
      flattenMdc: true
      flattenArguments: true # 新增：展开结构化参数到JSON根节点

方法2：使用MDC（适合上下文属性） #

如果属性和请求/线程上下文绑定，可临时将字段放入MDC，日志后自动清理：

代码示例

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

public class YourServiceClass {
    private static final Logger log = LoggerFactory.getLogger(YourServiceClass.class);

    public void handleUnauthorizedUser(String userEmail) {
        // 用try-with-resources自动移除MDC字段，避免污染上下文
        try (MDC.MDCCloseable ignored = MDC.putCloseable("email", userEmail)) {
            log.info("Unauthorized user");
        }
    }
}

调整日志配置

只需在includesMdcKeys中新增email：

includesMdcKeys: [userId, email] # 新增email

因为你已经开启flattenMdc: true，MDC中的email会自动展开到JSON根节点。

方法3：自定义日志事件装饰器（复杂场景） #

如果需要自定义参数解析逻辑，可实现JsonLogEventDecorator来提取参数并添加为JSON字段：

自定义装饰器代码

import ch.qos.logback.classic.spi.ILoggingEvent;
import com.fasterxml.jackson.core.JsonGenerator;
import io.dropwizard.logging.json.JsonLogEventDecorator;

import java.io.IOException;

public class CustomStructuredFieldDecorator implements JsonLogEventDecorator {
    @Override
    public void decorate(JsonGenerator generator, ILoggingEvent event) throws IOException {
        Object[] args = event.getArgumentArray();
        // 假设参数是成对的键值（如"email", userEmail）
        if (args != null && args.length % 2 == 0) {
            for (int i = 0; i < args.length; i += 2) {
                if (args[i] instanceof String && args[i+1] != null) {
                    generator.writeFieldName((String) args[i]);
                    generator.writeObject(args[i+1]);
                }
            }
        }
    }
}

注册装饰器到配置

layout:
  type: json
  # 其他原有配置...
  decorators:
    - type: com.yourpackage.CustomStructuredFieldDecorator # 替换为你的类路径

版本兼容性注意 #

• 若使用Dropwizard 1.x（依赖SLF4J 1.x），无法使用方法1的结构化参数，推荐用方法2或方法3。
• 升级到Dropwizard 2.x能获得更简洁的结构化日志支持。

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