SpringBoot内置支持的Web容器有Tomcat、Undertow、Jetty和Netty,默认情况下,这些Web服务的Access日志是不开启的,而Access日志对于我们做接口统计尤为重要。如果我们想开启这些日志,需要作如下配置:
1,Tomcat容器日志配置
SpringBoot 2.x默认支持的是Tomcat Web容器,如果我们想开启Access日志,只需要添加若干配置文件即可:
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
属性是必须要配置的,如果不配置该属性,日志也是不会输出的。
配置完毕,Access日志就会在/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
配置完毕,Access日志会生成在/var/undertow/logs目录下。
server.undertow.accesslog.dir=./logs/access_log //日志路径 server.undertow.accesslog.enabled=true //开启accesslog server.undertow.accesslog.pattern=%t %a "%r" %s (%D ms) 但是问题来了,改了以后自己测试发现pattern生效了,但是那个%D竟然打不出来,查看undertow文档 Undertow
没办法,继续在文档里找线索,搜一下request time看看,然后就搜到了这一条配置:
也就是说必须要开启这个配置,才能在访问日志里打印响应时间,至于undertow为什么不默认开启这个配置,是因为开启后会对性能造成影响 在spring boot(2.0)要开启这个配置需要通过代码进行配置:
import io.undertow.Undertow;
import io.undertow.UndertowOptions;
import org.springframework.boot.web.embedded.undertow.UndertowBuilderCustomizer;
import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class UndertowConfig {
@Bean
public UndertowServletWebServerFactory undertowServletWebServerFactory() {
UndertowServletWebServerFactory factory = new UndertowServletWebServerFactory();
factory.addBuilderCustomizers(new UndertowBuilderCustomizer() {
@Override
public void customize(Undertow.Builder builder) {
builder.setServerOption(UndertowOptions.RECORD_REQUEST_START_TIME, true);
}
});
return factory;
}
}
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
配置完成后,Access日志文件会生成在/var/jetty/logs目录下。
4,Netty容器日志配置
这个容器比较特殊,说其实容器,倒不如说是一种协议。启用这个作为“容器”的话,需要引入reactor-netty.jar。这个版本管理也比较乱,注意与netty版本匹配!并且在reactor-netty早期版本(低于0.7.8版本)是不支持Access日志的!(我这里用的是0.7.13版本,当然你也可以用更高版本,但是注意与netty版本要保持兼容!)
首先加入reactor-netty依赖:
io.projectreactor.ipc
reactor-netty
0.7.13.RELEASE
其次,需要开启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),参照配置如下:
/var/netty/log/access_log.log
/var/netty/log/access/access_log.log.%d{yyyyMMdd}
20
%msg%n
这里要注意几点:
logger名称必须用“reactor.netty.http.server.AccessLog”;
encoder的pattern无需自己定义,使用系统定义即可(%msg%n);
生成日志存放路径/var/netty/log.
目前系统内置的支持的这几种Web容器的Access日志配置就是这些,如果想使用自定义Web容器,那可以参照
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration
该文件来配置自定义Web容器和其Access日志。
SpringBoot各种Web容器服务的AccessLog配置_随风心境的博客-CSDN博客_access日志配置
accesslog在springboot中开启,表达式介绍,配置详情,使用undertow容器时%D接口耗时不打印问题解决。_酸菜鱼(szy)的博客-CSDN博客_springboot开启accesslog
SpringBoot--Undertow AccessLog 响应时长的打印 - javaeelwh - 博客园