Springboot-2.1 系列 - 1、日志配置和动态日志等级设置
Spring Boot
内部采用的是Commons Logging
进行日志记录,但在底层为Java Util Logging、Log4J2、Logback等日志框架提供了默认配置 。Java 虽然有很多可用的日志框架,但请不要担心,一般来说,使用SpringBoot
默认的Logback
就可以了。
注意点
springboot默认的日志等级是
INFO
要通过
logging.file
或者logging.path
配置springboot日志的输出
文件保存
默认情况下,SpringBoot
仅将日志输出到控制台,不会写入到日志文件中去。如果除了控制台输出之外还想写日志文件,则需要在application.properties
设置logging.file
或logging.path
属性。
-
logging.file:将日志写入到指定的文件中,默认为相对路径,可以设置成绝对路径。
如:
logging.file=my.log
-
logging.path:将名为
spring.log
写入到指定的文件夹中,如(/var/log
)
如果只配置 logging.file
,会在项目的当前路径下生成一个 xxx.log
日志文件。 如果只配置 logging.path
,在 /var/log
文件夹生成一个日志文件为 spring.log
日志文件在达到10MB
时进行切割,产生一个新的日志文件(如:spring.1.log、spring.2.log
),新的日志依旧输出到spring.log
中去,默认情况下会记录ERROR
、WARN
、INFO
级别消息。
-
logging.file.max-size:限制日志文件大小
-
logging.file.max-history:限制日志保留天数
日志输出
SpringBoot
默认为我们输出的日志级别为INFO
、WARN
、ERROR
,如需要输出更多日志的时候,可以通过以下方式开启
-
命令模式配置:
java -jar app.jar --debug=true
, 这种命令会被SpringBoot
解析,且优先级最高 -
资源文件配置:
application.properties
配置debug=true
即可。该配置只对 嵌入式容器、Spring、Hibernate生效,我们自己的项目想要输出DEBUG需要额外配置(配置规则:logging.level.<logger-name>=<level>)
日志输出级别配置
logging.level.root = WARN
logging.level.org.springframework.web = DEBUG
logging.level.org.hibernate = ERROR
#比如 mybatis sql日志
logging.level.org.mybatis = INFO
logging.level.mapper所在的包 = DEBUG
日志输出格式配置
-
logging.pattern.console:定义输出到控制台的格式(不支持JDK Logger)
-
logging.pattern.file:定义输出到文件的格式(不支持JDK Logger)
Logback扩展配置
该扩展配置仅适用logback-spring.xml
或者设置logging.config
属性的文件,因为logback.xml
加载过早,因此无法获取SpringBoot
的一些扩展属性
使用扩展属性springProfile
与springProperty
让你的logback-spring.xml
配置显得更有逼格,当别人还在苦苦挣扎弄logback-{profile}.xml的时候 你一个文件就搞定了
springProfile
<springProfile name="dev">
<!-- 开发环境时激活 -->
</springProfile>
<springProfile name="dev,test">
<!-- 开发,测试的时候激活-->
</springProfile>
<springProfile name="!prod">
<!-- 当 "生产" 环境时,该配置不激活-->
</springProfile>
springProperty
<springProperty>
标签可以让我们在Logback中使用 Spring Environment 中的属性。如果想在logback-spring.xml
中回读application.properties
配置的值时,这是一个非常好的解决方案
<!-- 读取 spring.application.name 属性来生成日志文件名
scope:作用域
name:在 logback-spring.xml 使用的键
source:application.properties 文件中的键
defaultValue:默认值
-->
<springProperty scope="context" name="logName" source="spring.application.name" defaultValue="myapp.log"/>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/${logName}.log</file>
</appender>
动态修改日志级别
方法一
import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import org.slf4j.LoggerFactory;
import java.util.List;
/**
* @Author: ynz
* @Date: 2018/12/22/022 8:48
*/
public class LogUtil {
public static void setAllLogLevel(String level){
LoggerContext loggerContext= (LoggerContext) LoggerFactory.getILoggerFactory();
List<Logger> loggerList = loggerContext.getLoggerList();
for(Logger logger : loggerList){
logger.setLevel(Level.toLevel(level));
}
}
测试类
@RestController
@Slf4j
public class LogController {
/**
* 测试日志等级
* @return
*/
@RequestMapping("/loglevel")
public String logLevel(){
log.debug("debug log");
log.info("info log");
log.error("error log");
return "success";
}
/**
* 设置日志等级
* @param level
* @param packages
* @return
*/
@RequestMapping("/changeLog/{level}")
public String changeLevel(@PathVariable String level, @RequestBody String packages){
if(StringUtils.isEmpty(packages)){
LogUtil.setAllLogLevel(level);
}else{
LogUtil.setLogLevel(packages,level);
}
return "success";
}
访问http://127.0.0.1:8080/changeLog/debug
,消息体为cn
,可以看到日志等级已经为debug
方法二
添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
application.yml添加配置
management.endpoints.web.exposure.include: loggers
#显示健康具体信息 默认不会显示详细信息
management.endpoint.health.show-details: always
现在修改cn
包下的所有日志等级改为DEBUG实现:
通过以送Post请求到http://127.0.0.1:8080/actuator/loggers/cn端点,请求体body内容
"configuredLevel": "DEBUG"
源码地址:https://github.com/c0Alan/Repo-IDEA/tree/master/springboot-demo/springboot-2-1-x