166. Spring Boot 开启access_log日志输出

 

 

需求缘起：

       使用Tomcat的，都知道tomcat有一个logs目录，在此目录下有一个访问日志，文件名称形如localhost_access_log.2017-09-24.txt，这个名称的话，前缀是：localhost_access_log，后缀2017-09-24是根据当前的时间进行形成的。那么我们的问题是：在spring boot如何开启access_log日志输出呢？

本节知识：

       通过本节博客，你将会获得如下技能：

写道

（1）在spring boot中开启access_log日志输出
（2）日志格式模式配置项
（3）别名设置日志格式
（4）请求参数设置日志格式

 

       接下来看下本节具体的内容：

一、在spring boot中开启access_log日志输出

       首先我们需要支持spring boot默认的web容器是tomcat，如果使用不同的web容器，这里开启的配置项是不一样的。这里我们介绍的是tomcat是如何开启的。

       在调试的时候，如果我们需要查看访问日志，在spring boot中进行开启是很简单的事情，只是spring boot默认没有开启。那么怎么开启呢？只需要在application.properties文件添加如下配置：

 

#日志开关

server.tomcat.access-log-enabled=true

#日志格式

server.tomcat.access-log-pattern=%h %l %u %t "%r" %s %b %D

#日志输出目录，这里是设置为当前目录下

server.tomcat.basedir=./

 

 

二、测试

       随便访问一个请求：http://127.0.0.1:8080/test ，在项目上刷新（或者按F5），可以看到一个logs目录：access_log.2017-09-24.log，打开文件查看日志：

127.0.0.1 - - [24/Sep/2017:13:55:46 +0800] "GET /test HTTP/1.1" 200 2 123

127.0.0.1 - - [24/Sep/2017:13:55:46 +0800] "GET /favicon.ico HTTP/1.1" 200 946 18

127.0.0.1 - - [24/Sep/2017:13:56:03 +0800] "GET /test HTTP/1.1" 200 2 9

127.0.0.1 - - [24/Sep/2017:13:56:03 +0800] "GET /favicon.ico HTTP/1.1" 200 946 3

       从这里访问/test请求，同时也会访问/favicon.ico，这个是浏览器在显示title的地方需要显示的一个图标。

 

三、日志格式模式配置项

#日志格式

server.tomcat.access-log-pattern=%h %l %u %t "%r" %s %b %D

       这里都有什么可配置项的呢？

％a - 远程IP地址
    ％A - 本地IP地址
    ％b - 发送的字节数，不包括HTTP头，或“ - ”如果没有发送字节
    ％B - 发送的字节数，不包括HTTP头
    ％h - 远程主机名
    ％H - 请求协议
    ％l (小写的L)- 远程逻辑从identd的用户名（总是返回' - '）
    ％m - 请求方法
    ％p - 本地端口
    ％q - 查询字符串（在前面加上一个“？”如果它存在，否则是一个空字符串
    ％r - 第一行的要求
    ％s - 响应的HTTP状态代码
    ％S - 用户会话ID
    ％t - 日期和时间，在通用日志格式

    ％u - 远程用户身份验证
    ％U - 请求的URL路径
    ％v - 本地服务器名
    ％D - 处理请求的时间（以毫秒为单位）
    ％T - 处理请求的时间（以秒为单位）
    ％I （大写的i） - 当前请求的线程名称

 

四、别名设置日志格式

此外，可以指定以下别名来设置为普遍使用的模式之一：

common - %h %l %u %t "%r" %s %b

combined - %h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i"

       那么在application.properties文件就可以这么配置：

#日志格式

server.tomcat.access-log-pattern=common

 

五、请求参数设置日志格式

另外，还可以将request请求的查询参数、session会话变量值、cookie值或HTTP请求/响应头内容的变量值等内容写入到日志文件。

它仿照了apache的语法：

    ％{XXX}i xxx代表传入的头(HTTP Request)

    ％{XXX}o xxx代表传出​​的响应头(Http Resonse)

    ％{XXX}c  xxx代表特定的Cookie名

    ％{XXX}r  xxx代表ServletRequest属性名

    ％{XXX}s xxx代表HttpSession中的属性名

       例如：

%{X-Real-IP}i %u %t %r %s %b

 

 

 à悟空学院：https://t.cn/Rg3fKJD

学院中有Spring Boot相关的课程！点击「阅读原文」进行查看！

SpringBoot视频：http://t.cn/A6ZagYTi

Spring Cloud视频：http://t.cn/A6ZagxSR

SpringBoot Shiro视频：http://t.cn/A6Zag7IV

SpringBoot交流平台：https://t.cn/R3QDhU0

SpringData和JPA视频：http://t.cn/A6Zad1OH

SpringSecurity5.0视频：http://t.cn/A6ZadMBe

Sharding-JDBC分库分表实战：http://t.cn/A6ZarrqS

分布式事务解决方案「手写代码」：http://t.cn/A6ZaBnIr