如何自定义Dropwizard默认访问日志格式并添加请求头

Dropwizard基于Jetty构建，自定义访问日志格式本质是配置Jetty的RequestLog组件，通过指定格式字符串即可将请求头信息加入日志。以下是具体操作步骤：

1. 修改配置文件 #

在Dropwizard的配置文件（通常为config.yml/config.yaml）中，找到server节点下的requestLog配置块，替换默认的format值为自定义格式，其中用%{请求头名称}i来引用目标请求头。

2. 格式语法说明 #

Jetty访问日志支持多种占位符，常用的包括：

• %h：客户端IP地址
• %t：请求时间（格式为[dd/MMM/yyyy:HH:mm:ss Z]）
• %r：完整请求行（方法、路径、协议）
• %s：响应状态码
• %{HeaderName}i：指定请求头的值，将HeaderName替换为你需要的请求头名称（如X-Request-ID）

3. 完整配置示例 #

假设需要将X-Request-ID和User-Agent两个请求头加入日志，配置如下：

server:
  requestLog:
    appenders:
      - type: file
        currentLogFilename: ./logs/access.log
        archivedLogFilenamePattern: ./logs/access-%d.log.gz
        archivedFileCount: 5
    format: "%h %t \"%r\" %s %b \"%{User-Agent}i\" \"%{X-Request-ID}i\""

4. 验证配置 #

启动Dropwizard服务后，发送携带指定请求头的请求：

curl -H "X-Request-ID: abc123" http://localhost:8080/your-api-endpoint

查看access.log文件，日志行末尾会出现abc123，说明配置生效。

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