Spring Boot logback 日志配置

Logback 使用:

默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台。在运行应用程序和其他例子时,你应该已经看到很多INFO级别的日志了。
这里写图片描述
从上图可以看到,日志输出内容元素具体如下:

  • 时间日期:精确到毫秒
  • 日志级别:ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID
  • 分隔符:— 标识实际日志的开始
  • 线程名:方括号括起来(可能会截断控制台输出)
  • Logger名:通常使用源代码的类名
  • 日志内容

添加日志依赖

确保 maven 依赖中添加了 spring-boot-starter-logging


    org.springframework.boot
    spring-boot-starter-logging

一般情况下,我们不需要直接添加该依赖。spring-boot-starter 中包含了 spring-boot-starter-logging,该依赖内容就是 Spring Boot 默认的日志框架 logback。

控制台输出

日志级别从低到高分为:

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

如果设置为 WARN ,则低于 WARN 的信息都不会输出。Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。还可以在启动过程中使用 --debug 标志来启用“调试”模式(开发的时候推荐开启),以下两种方式皆可:

  • 在运行命令后加入–debug标志,如:$ java -jar springTest.jar --debug
  • 在application.properties中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是应用本身的日志并不会输出为DEBUG级别。

日志格式化和文件输出

在 application.yml 可以自定义日志输出的格式和输出文件路径。

logging:
	pattern:
		console: "%d - %msg%n"      # 格式化
	# path: /data/log/                # 日志路径
	file: /data/log/run.log         # 日志名称

设置logging.file或logging.path属性来输出日志到文件中:

  • logging.file:设置文件,可以是绝对路径,也可以是相对路径。如:logging.file=my.log
  • logging.path:设置目录,会在该目录下创建spring.log文件
    如果只配置 logging.file,会在项目的当前路径下生成一个 xxx.log 日志文件。
    如果只配置 logging.path,在 /var/log文件夹生成一个日志文件为 spring.log

注:二者不能同时使用,如若同时使用,则只有logging.file生效
默认情况下,日志文件的大小达到10MB时会切分一次,产生新的日志文件,默认级别为:ERROR、WARN、INFO

级别控制

所有支持的日志记录系统都可以在 Spring 环境中设置记录级别,格式为:logging.level.* = LEVEL

  • logging.level:日志级别控制前缀,*为包名或Logger名
  • LEVEL:选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
    举例:
logging.level.com.dudu=DEBUG       # com.dudu包下所有class以DEBUG级别输出
logging.level.root=WARN                  # root日志以WARN级别输出
  • 1
  • 2

自定义日志配置

根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:

  • Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j:log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2:log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging):logging.properties

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项。日志配置文件放在 src/main/resources 目录下面

如果想日志配置文件名字,可以通过 logging.config 属性指定自定义的名字:

logging.config=classpath:logging-config.xml

针对不同运行时 Profile 使用不同的日志配置,这个功能会很有用。但一般不这么用,而是直接在 logback-spring.xml 中使用springProfile 配置,不需要 logging.config 指定不同环境使用不同配置文件。

logback-spring.xml详解

configuration 根节点

根节点有三个属性:

  • scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
  • scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
  • debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

root 子节点

root 节点是必选节点,用来指定最基础的日志输出级别,只有一个 level 属性,用来设置打印级别,其值不区分大小写:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,默认是DEBUG。
包含多个 appender:


  
  

contextName 子节点

每个 logger 都关联一个上下文,默认上下文名称为 “default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称,一般来说我们不用这个属性,可有可无。

logback

property 子节点

用来定义变量的标签, 有两个属性:name 、value;其中name的是变量名,value 是变量值。定义变量后,可以使 ${} 来使用变量。



appender 子节点

appender 用来格式化日志输出节点,主要属性: name 、 class,class 用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。

控制台输出ConsoleAppender



    logback-demo

    
    
        
        
            %d -1 %msg%n
        
    

    
    
        
            %d -2 %msg%n
        
    

    
    
        
        
        
    


这里写图片描述
可以看到 layout 和 encoder,都可以将事件转换为格式化后的日志记录,但是控制台输出使用layout,文件输出使用encoder。
具体原因可以看:logback和slf4j的使用之encoder和Layout

另一种示例:




    logback-demo

    
    
        
        
            
                %d{HH:mm:ss.SSS} %contextName [%t] %level %logger{36} - %msg%n
            
        
        
    

    
    
        
        
        
    

encoder 表示对日志格式化:

  • %d{HH: mm:ss.SSS}——日志输出时间
  • %thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
  • %-5level——日志级别,并且使用5个字符靠左对齐
  • %logger{36}——日志输出者的名字
  • %msg——日志消息
  • %n——平台的换行符
    ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志~

输出到文件 RollingFileAppender

应用长时间运行,日志肯定会越来越多,将他们输出到同一个文件可不行,而 RollingFileAppender 的功能就是用于切分文件:


    
    
        
        ERROR
        
        DENY
        
        ACCEPT
    
    
    ${logback.logdir}/info.${logback.appname}.log
    
    
        
        ${logback.logdir}/info.${logback.appname}.%d{yyyy-MM-dd}.log
        
        90
        
        
    
    
    
        UTF-8
        %d [%t] %-5level %logger{36} - %msg%n
    




    
    
        Error
    
    
    ${logback.logdir}/error.${logback.appname}.log
    
    
        
        ${logback.logdir}/error.${logback.appname}.%d{yyyy-MM-dd}.log
        
        90
        
        
    
    
    
        UTF-8
        %d [%t] %level %logger{36} - %msg%n
    

注意:如果要区分 Info 和 Error 级别的日志,那么需要注意使用过滤规则的策略
关于 encoder 元素中 pattern 的格式说明请参考文章:logback 常用配置详解

logger 子节点五

logger 用来设置某一个包或者具体的某一个类的日志打印级别、以及指定 appender。logger仅有一个 name 属性,一个可选的 level 和一个可选的 addtivity 属性。

  • name:用来指定受此loger约束的某一个包或者具体的某一个类。
  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。
  • addtivity:是否向上级loger传递打印信息。默认是true。

logger在实际使用的时候有两种情况
先来看一看代码中如何使用

package com.app.controller;

@Controller
public class ActionController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping(value = "/action",method = RequestMethod.POST)
    @ResponseBody
    public Object action(HttpServletRequest request, HttpServletResponse response){
        //日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。
        logger.trace("日志输出 trace");
        logger.debug("日志输出 debug");
        logger.info("日志输出 info");
        logger.warn("日志输出 warn");
        logger.error("日志输出 error");
        
        return “”;
    }
}

这是一个 Controller,根据配置来看看打印了哪几种级别日志。

第一种:logger 配置,不指定级别,不指定 appender,使用 root 节点的打印级别设置为 info,指定了输出到控制台的 appender



	

上面配置将控制 controller 包下的所有类的日志的打印,但是并没用设置打印级别,所以继承 root 的日志级别 info;addtivity默认为 true,将此 logger 的打印信息向上级传递;注意 logger 本身没有设置 appender,因此不会干扰打印相关作用。

当执行 com.app.controller.ActionController 类的方法时,ActionController 在包 com.app.controller 中,所以首先执行  ,将级别为 info 及大于 info 的日志信息传递给 root节点,本身不打印;root 接到传递的信息,交给指定的 appender 进行处理,将信息打印到控制台;

打印结果如下:

16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.dudu.controller.LearnController - 日志输出 info
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController -

第二种:具体logger的配置,指定级别,指定appender :



    

控制com.app.controller 包的日志打印,打印级别为“WARN”;
additivity属性为false,表示此loger的打印信息不再向上级传递;指定了appender;

这时候执行com.app.controller.ActionController类的login方法时,先执行,将级别大于等于 WARN 的日志信息交给此 logger 指定的 appender 处理,在控制台中打出日志,不再向root 传递打印信息。

打印结果如下:

16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.app.controller.ActionController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.ActionController - 日志输出 error

注意如果把 additivity="false" 改成 additivity="true" 的话,就会打印两次,因为打印信息向上级传递,logger 本身打印一次,root 接到后又打印一次。

注意:范围有重叠的话,范围小的,有效。


    ...
    
    
       
    
    
    
    
    

多环境日志输出


    ...
    
    
    
        
            
        
    
    
    
    
        
            
        
    

application.yml 文件中增加环境选择的配置:active: dev

server:
  port: 9010

spring:
  profiles:
    active: dev

active: 【prep、dev、prod】,根据 active 的环境,自动采用上面配置的 springProfile 的 logger 配置。

获取 application.yml 中配置

application.yml 增加日志相关自定义配置

logback:
  logdir: /Users/inke/dev/log/tomcat/sell
  appname: sell

在logback-spring.xml




    
    
    

    ${appname}

    
    
        
        
            
                %d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
            
        
    

你可能感兴趣的:(日志-Logback,SpringBoot-实战,1024程序员节)