SpringBoot 各种 Web 容器服开启 AccessLog 日志

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: SpringBoot 各种 Web 容器服开启 AccessLog 日志

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 日志。

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
|
1月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
358 2
|
2月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
535 5
|
3月前
|
运维 数据可视化 C++
2025 热门的 Web 化容器部署工具对比:Portainer VS Websoft9
2025年热门Web化容器部署工具对比:Portainer与Websoft9。Portainer以轻量可视化管理见长,适合技术团队运维;Websoft9则提供一站式应用部署与容器管理,内置丰富开源模板,降低中小企业部署门槛。两者各有优势,助力企业提升容器化效率。
350 1
2025 热门的 Web 化容器部署工具对比:Portainer VS Websoft9
|
2月前
|
运维 监控 安全
EventLog Analyzer:高效的Web服务器日志监控与审计解决方案
ManageEngine EventLog Analyzer是一款企业级Web服务器日志监控与审计工具,支持Apache、IIS、Nginx等主流服务器,实现日志集中管理、实时威胁检测、合规报表生成及可视化分析,助力企业应对安全攻击与合规挑战,提升运维效率。
179 0
|
8月前
|
存储 Java 文件存储
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— logback.xml 配置文件解析
本文解析了 `logback.xml` 配置文件的详细内容,包括日志输出格式、存储路径、控制台输出及日志级别等关键配置。通过定义 `LOG_PATTERN` 和 `FILE_PATH`,设置日志格式与存储路径;利用 `&lt;appender&gt;` 节点配置控制台和文件输出,支持日志滚动策略(如文件大小限制和保存时长);最后通过 `&lt;logger&gt;` 和 `&lt;root&gt;` 定义日志级别与输出方式。此配置适用于精细化管理日志输出,满足不同场景需求。
2121 1
|
8月前
|
Java 微服务 Spring
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录——使用Logger在项目中打印日志
本文介绍了如何在项目中使用Logger打印日志。通过SLF4J和Logback,可设置不同日志级别(如DEBUG、INFO、WARN、ERROR)并支持占位符输出动态信息。示例代码展示了日志在控制器中的应用,说明了日志配置对问题排查的重要性。附课程源码下载链接供实践参考。
1005 0
|
8月前
|
SQL Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— application.yml 中对日志的配置
在 Spring Boot 项目中,`application.yml` 文件用于配置日志。通过 `logging.config` 指定日志配置文件(如 `logback.xml`),实现日志详细设置。`logging.level` 可定义包的日志输出级别,例如将 `com.itcodai.course03.dao` 包设为 `trace` 级别,便于开发时查看 SQL 操作。日志级别从高到低为 ERROR、WARN、INFO、DEBUG,生产环境建议调整为较高级别以减少日志量。本课程采用 yml 格式,因其层次清晰,但需注意格式要求。
798 0
|
8月前
|
Java API 开发者
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录——slf4j 介绍
在软件开发中,`System.out.println()`常被用于打印信息,但大量使用会增加资源消耗。实际项目推荐使用slf4j结合logback输出日志,效率更高。Slf4j(Simple Logging Facade for Java)是一个日志门面,允许开发者通过统一方式记录日志,无需关心具体日志系统。它支持灵活切换日志实现(如log4j或logback),且具备简洁占位符和日志级别判断等优势。阿里巴巴《Java开发手册》强制要求使用slf4j,以保证日志处理方式的统一性和维护性。使用时只需通过`LoggerFactory`创建日志实例即可。
622 0
|
4月前
|
机器学习/深度学习 XML Java
【spring boot logback】日志logback格式解析
在 Spring Boot 中,Logback 是默认的日志框架,它支持灵活的日志格式配置。通过配置 logback.xml 文件,可以定义日志的输出格式、日志级别、日志文件路径等。
768 5
|
10月前
|
开发框架 运维 监控
Spring Boot中的日志框架选择
在Spring Boot开发中,日志管理至关重要。常见的日志框架有Logback、Log4j2、Java Util Logging和Slf4j。选择合适的日志框架需考虑性能、灵活性、社区支持及集成配置。本文以Logback为例,演示了如何记录不同级别的日志消息,并强调合理配置日志框架对提升系统可靠性和开发效率的重要性。
400 5