日志
核心流程
- 每个 starter 场景,都会导入一个核心场景 spring-boot-starter
- 核心场景引入了日志的所用功能 spring-boot-starter-logging
- 默认使用了 logback + slf4j 组合作为默认底层日志
- 日志是系统一启动就要用,xxxAutoConfiguration 是系统启动好了以后放好的组件,后来用的。
- 日志是利用监听器机制配置好的。ApplicationListener。
- 日志所有的配置都可以通过修改配置文件实现。以 logging 开始的所有配置。
日志格式
默认输出格式:
- 时间和日期:毫秒级精度
- 日志级别:ERROR, WARN, INFO, DEBUG, or TRACE.
- 进程 ID
- —: 消息分割符
- 线程名: 使用[]包含
- Logger 名: 通常是产生日志的类名
- 消息: 日志记录的内容
注意: logback 没有 FATAL 级别,对应的是 ERROR
默认值:参照:spring-boot 包 additional-spring-configuration-metadata.json 文件
默认输出格式值:%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}可修改为:'%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} ===> %msg%n'
日志级别
- 由低到高:ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF;
- 只会打印指定级别及以上级别的日志
- ALL:打印所有日志
- TRACE:追踪框架详细流程日志,一般不使用
- DEBUG:开发调试细节日志
- INFO:关键、感兴趣信息日志
- WARN:警告但不是错误的信息日志,比如:版本过时
- ERROR:业务错误日志,比如出现各种异常
- FATAL:致命错误日志,比如 jvm 系统崩溃
- OFF:关闭所有日志记录
- 不指定级别的所有类,都使用 root 指定的级别作为默认级别
- SpringBoot 日志默认级别是 INFO
- 在 application.properties/yaml 中配置 logging.level.=指定日志级别
- level 可取值范围:TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF,定义在 LogLevel 类中
- root 的 logger-name 叫 root,可以配置 logging.level.root=warn,代表所有未指定日志级别都使用 root 的 warn 级别
日志分组
将相关的 logger 分组在一起,统一配置。SpringBoot 也支持。比如:Tomcat 相关的日志统一设置
logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat
logging.level.tomcat=trace
文件输出
SpringBoot 默认只把日志写在控制台,如果想额外记录到文件,可以在 application.properties 中添加 logging.file.name or logging.file.path 配置项。
文件归档与滚动切割
归档:每天的日志单独存到一个文档中。
切割:每个文件 10MB,超过大小切割成另外一个文件。
- 每天的日志应该独立分割出来存档。如果使用 logback(SpringBoot 默认整合),可以通过 application.properties/yaml 文件指定日志滚动规则。
- 如果是其他日志系统,需要自行配置(添加 log4j2.xml 或 log4j2-spring.xml)
- 支持的滚动规则设置如下
logging.logback.rollingpolicy.file-name-pattern 日志存档的文件名格式(默认值:${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz)
logging.logback.rollingpolicy.clean-history-on-start 应用启动时是否清除以前存档(默认值:false)
logging.logback.rollingpolicy.max-file-size 存档前,每个日志文件的最大大小(默认值:10MB)
logging.logback.rollingpolicy.total-size-cap 日志文件被删除之前,可以容纳的最大大小(默认值:0B)。设置 1GB 则磁盘存储超过 1GB 日志后就会删除旧日志文件
logging.logback.rollingpolicy.max-history 日志文件保存的最大天数(默认值:7).