SpringBoot 內置支持的 Web 容器有 Tomcat、Undertow、Jetty 和.NETty。默認情況下,這些 Web 服務的 AccessLog 日志是不開啟的,而 AccessLog 日志對于做接口統計尤為重要。如果要開啟這些日志,需要進行如下配置。
1. Tomcat容器日志配置
SpringBoot 2.x 默認支持的是 Tomcat Web 容器,如果要開啟 AccessLog 日志,只需要添加若干配置文件即可:
server:
tomcat:
basedir: /var/tmp
background-processor-delay: 30
port-header: X-Forwarded-Port
protocol-header: X-Forwarded-Proto
protocol-header-https-value: https
redirect-context-root: true
remote-ip-header: X-Forwarded-For
uri-encoding: UTF-8
accesslog:
enabled: true
buffered: true
directory: ./log
file-date-format: .yyyy-MM-dd
pattern: '%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i" %D ms'
prefix: access_log
rename-on-rotate: false
request-attributes-enabled: false
rotate: true
suffix: .log
其中
server:
tomcat:
basedir: /var/tmp
屬性是必須要配置的,如果不配置該屬性,日志也是不會輸出的。配置完畢,AccessLog 日志就會在 /var/tmp/log 目錄下生成,名稱是 access_log.yyyy-MM-dd.log
2. Undertow容器日志配置
引入 Undertow 依賴包后,在配置文件添加如下配置。另外,注意需要排除 Tomcat 依賴包
server:
undertow:
max-http-post-size: 10MB
buffer-size: 1024KB
io-threads: 8
worker-threads: 64
direct-buffers: true
eager-filter-init: true
accesslog:
enabled: true
pattern: common
prefix: access_log.
suffix: log
dir: /var/undertow/logs
rotate: true
配置完畢,AccessLog 日志會生成在 /var/undertow/logs 目錄下。
3. Jetty容器日志配置引入 Jetty 依賴包后,在配置文件添加如下配置。另外,注意需要排除 Tomcat 依賴包
server:
jetty:
max-http-post-size: 4MB
acceptors: 32
selectors: 32
accesslog:
enabled: true
filename: /var/jetty/logs/access_log.yyyy_MM_dd.log
file-date-format: yyyy-MM-dd
retention-period: 20
Append: true
extended-format: true
date-format: 'dd/MMM/yyyy:HH:mm:ss Z'
locale: zh
timeZone: GMT+8
log-cookies: false
log-server: true
log-latency: true
配置完成后,AccessLog 日志文件會生成在 /var/jetty/logs 目錄下。
4. Netty容器日志配置
這個容器比較特殊,說其是容器,倒不如說是一種協議。啟用這個作為“容器”的話,需要引入reactor-netty.jar。這個版本管理也比較亂,注意與 netty 版本匹配!并且在reactor-netty早期版本(低于0.7.8版本)是不支持 AccessLog 日志的!(這里用的是0.7.13版本,當然也可以用更高版本,但是注意與netty版本要保持兼容!)首先加入reactor-netty依賴:
<dependency>
<groupId>io.projectreactor.ipc</groupId>
<artifactId>reactor-netty</artifactId>
<version>0.7.13.RELEASE</version>
</dependency>
其次,需要開啟netty日志支持,需要添加系統屬性
reactor.netty.http.server.accessLogEnabled=true。注意,這個屬性不能通過SpringBoot配置添加,但可以使用下面方法:
public static void main(String[] args) throws Exception {
System.setProperty("reactor.netty.http.server.accessLogEnabled", "true");
configureApplication(new SpringApplicationBuilder()).run(args);
}
最后,需要借助系統日志實現該日志的輸出(這里用的是 logback),參照配置如下:
<!-- [Netty Appender] Access日志 -->
<appender name="ACCESS-APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>/var/netty/log/access_log.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>/var/netty/log/access/access_log.log.%d{yyyyMMdd}</fileNamePattern>
<maxHistory>20</maxHistory>
</rollingPolicy>
<encoder charset="UTF-8">
<pattern>%msg%n</pattern>
</encoder>
</appender>
<appender name="ASYNC-APPENDER" class="ch.qos.logback.classic.AsyncAppender">
<appender-ref ref="ACCESS-APPENDER" />
</appender>
<!-- ===== [Access Logger] ===== -->
<logger name="reactor.netty.http.server.AccessLog" additivity="false">
<level value="INFO"/>
<appender-ref ref="ASYNC-APPENDER"/>
</logger>
這里要注意幾點:
- logger名稱必須用reactor.netty.http.server.AccessLog;
- encoder的pattern無需自己定義,使用系統定義即可(%msg%n);
- 生成日志存放路徑/var/netty/log;
目前系統內置的支持的這幾種 Web 容器的 AccessLog 日志配置就是這些,如果想使用自定義Web容器,那可以參照
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration
該文件來配置自定義 Web 容器和其AccessLog 日志。