使用 DropWizard 记录一些请求标头答案

【问题标题】：Logging some request headers with DropWizard使用 DropWizard 记录一些请求标头
【发布时间】：2016-02-18 16:58:16
【问题描述】：

我们正在尝试将自定义 http 标头添加到 dropwizard 访问日志。我们尝试了 dropwizard 0.9.1 和 0.9.2，但找不到这样做的方法。我们注意到以下几点：

server.requestlogs.appenders[file].logFormat 被忽略。它始终使用常见的日志记录格式进行记录。
logging.appenders[file].logFormat 很受尊重，但对于 %header{HEADER-NAME}、%A 等内容，Web 特定内容会导致 %PARSER_ERROR[..]。

有没有办法记录这些信息？

【问题讨论】：

嘿。关于如何做到这一点，我会提出一两个建议。你看过MDC吗？ logback.qos.ch/manual/mdc.html 这将是一种半手动的方法。或者我做了类似的事情，我需要在我的日志文件名和日志语句中的主机名，所以我添加了一个“%h”标志。您可以为您的用例做类似的事情。

标签： jersey logback dropwizard

【解决方案1】：

可以使用自定义的org.eclipse.jetty.server.RequestLog 实现，可以通过扩展io.dropwizard.jetty.RequestLogFactory 并替换ServerFactory 中的dropwizard 实现来注册到码头。这是一种可能的实现方式：

import ch.qos.logback.classic.*;
import ch.qos.logback.classic.spi.*;
import ch.qos.logback.core.*;
import ch.qos.logback.core.spi.*;
import com.google.common.collect.ImmutableList;
import io.dropwizard.jetty.*;
import io.dropwizard.logging.*;
import org.eclipse.jetty.server.*;
import org.slf4j.LoggerFactory;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import java.io.IOException;
import java.util.Enumeration;
import java.util.TimeZone;

public class CustomRequestLogFactory extends RequestLogFactory {

    @NotNull
    private TimeZone timeZone = TimeZone.getTimeZone("UTC");

    @Valid
    @NotNull
    private ImmutableList<AppenderFactory> appenders = ImmutableList.<AppenderFactory>of(
        new ConsoleAppenderFactory()
    );

    private static class RequestLogLayout extends LayoutBase<ILoggingEvent> {
        @Override
        public String doLayout(ILoggingEvent event) {
            return event.getFormattedMessage() + CoreConstants.LINE_SEPARATOR;
        }
    }

    private static class CustomRequestLog extends Slf4jRequestLog {

        private static Logger logger = (Logger) LoggerFactory.getLogger(CustomRequestLog.class);
        private static ThreadLocal<StringBuilder> _buffers = new ThreadLocal<StringBuilder>() {
            @Override
            protected StringBuilder initialValue() {
                return new StringBuilder(256);
            }
        };

        public CustomRequestLog(AppenderAttachableImpl<ILoggingEvent> appenders, 
             TimeZone timeZone) {
            super(appenders, timeZone);
        }

        @Override
        public void log(Request request, Response response) {
            StringBuilder buf = _buffers.get();
            buf.setLength(0);
            buf.append(request.getServerName()).append('\n');
            Enumeration<String> headers = request.getHeaderNames();
            while (headers.hasMoreElements()) {
                String header = headers.nextElement();
                buf.append(header).append('=')
                   .append(request.getHeader(header)).append('\n');
            }
            try {
                write(buf.toString());
            } catch (IOException e) {
                logger.error(e.getMessage(), e);
            }
        }
    }

    public RequestLog build(String name) {
        final Logger logger = (Logger) LoggerFactory.getLogger("http.request");
        logger.setAdditive(false);
        final LoggerContext context = logger.getLoggerContext();
        final RequestLogLayout layout = new RequestLogLayout();
        layout.start();
        final AppenderAttachableImpl<ILoggingEvent> attachable = 
            new AppenderAttachableImpl<>();
        for (AppenderFactory output : this.appenders) {
            attachable.addAppender(output.build(context, name, layout));
        }
        return new CustomRequestLog(attachable, timeZone);
    }
}

在ServerFactory中设置RequestLogFactory：

@Override
public void run(ApplicationConfiguration configuration,
                Environment environment) {
...
  ((DefaultServerFactory) configuration.getServerFactory())
        .setRequestLogFactory(new CustomRequestLogFactory());
}

【讨论】：