你如何告诉 Spring Boot 将嵌入式 Tomcat 的访问日志发送到标准输出？

Question

在独立的 Spring Boot Web 应用程序（可执行 jar）中，如何告诉 Spring Boot 我们希望将嵌入式 Tomcat 实例的 HTTP 访问日志发送到标准输出？

Answer 1

2019.02.11 更新：

这些墨水应该有助于映射您应该在application.properties 中设置的属性：

• tomcat
• undertow

---

@acohen 的回答稍微正确。如果您提供空的双引号，它将不起作用。我将扩展他的答案，因为我认为这对于不想添加依赖项或修改代码的人来说很重要：

config/application.properties

# here we say that we want to enable accesslog
server.tomcat.accesslog.enabled=true

# it is important to understand what the options means:
# 'directory/prefix + suffix + file-date-format' will be
# the file that tomcat will try to open.
# /dev/stdout is standard output, so we want tomcat
# to write to that fd. Then, we need to play with
# directory, prefix, suffix and file-date-format to match our desired path.
server.tomcat.accesslog.directory=/dev
server.tomcat.accesslog.prefix=stdout
server.tomcat.accesslog.buffered=false

# Don't use empty double quotes, see below
server.tomcat.accesslog.suffix=
server.tomcat.accesslog.file-date-format=

注意事项

1. 如果将file-date-format和suffix设置为双引号，就会出现这个错误：

java.io.FileNotFoundException: /dev/stdout"""" (Permission denied)

1. 如果您不将它们包含在配置文件中，那么您将使用默认值并出现此错误：

java.io.FileNotFoundException: /dev/stdout.2019-02-07.log (Permission denied)

1. 如果您将它们留空，那么它会起作用。

Answer 2

如果你使用 Logback，你可以使用logback-access。

添加依赖ch.qos.logback:logback-access

添加 TeeFilter 的可选 Javaconfig（请求和响应日志记录）：

@Bean(name = "TeeFilter")
public Filter teeFilter() {
    return new ch.qos.logback.access.servlet.TeeFilter();
}

嵌入式 tomcat 的 Javaconfig：

@Bean
public EmbeddedServletContainerFactory servletContainer() {
    TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();

    // put logback-access.xml in src/main/resources/conf
    tomcat.addContextValves(new LogbackValve());

    return tomcat;
}

logback-access.xml 的内容（保存在src/main/resources/conf）

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <Pattern>combined</Pattern>
      <Pattern>%fullRequest%n%n%fullResponse</Pattern>
    </encoder>
  </appender>

  <appender-ref ref="STDOUT" />

</configuration>

Answer 3

这是在 Spring Boot 2.x 上为我完成的：

server.tomcat.accesslog.enabled=true
server.tomcat.accesslog.directory=/dev
server.tomcat.accesslog.prefix=stdout
server.tomcat.accesslog.buffered=false
server.tomcat.accesslog.suffix=""
server.tomcat.accesslog.file-date-format=""

Answer 4

以下是 JohanB 针对 Spring Boot 2.0.0+ 的出色回答的后续行动。

在 Spring Boot 2.0.0 中，EmbeddedServletContainerFactory 被替换为 TomcatServletWebServerFactory。 JohanB 的答案的所有其他方面仍然可以正常工作，只需要修改工厂 bean 创建：

@Bean
public TomcatServletWebServerFactory servletContainer() {
    TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory();
    // put logback-access.xml in src/main/resources/conf
    tomcat.addContextValves(new LogbackValve());
    return tomcat;
}

Answer 5

JohanB 的解决方案有效，但如果您不想编写代码，有人会做得更好并包装 Server access logs in a nice Spring Boot starter。它涵盖了 Tomcat、Jetty 和 Undertow。

只需添加依赖即可：

<dependency>
    <groupId>net.rakugakibox.spring.boot</groupId>
    <artifactId>logback-access-spring-boot-starter</artifactId>
    <version>2.7.1</version>
</dependency>

还有一个位于类路径根目录的 logback-access.xml 文件：

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>common</pattern>
        </encoder>
    </appender>
    <appender-ref ref="CONSOLE" />
</configuration>

并将访问日志打印到标准输出：

127.0.0.1 - - [08/févr./2019:11:23:30 +0100] "GET /password HTTP/1.1" 200 32

此时，如果您想打印完整的 HTTP 请求和响应以进行调试，则需要 create the TeeFilter Bean on your own。