SpringBoot学习历程(五):集成Logback日志配置

默认情况下,SpringBoot会用Logback来记录日志,并用INFO级别输出到控制台。

1. 引入日志依赖



    org.springframework.boot
    spring-boot-starter-web

在Spring Boot中,Logback是默认的日志记录框架,只需添加spring-boot-starter-web,它就能引入logback依赖项。

2. 日志输出

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。 Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。
开启调试模式:

  1. 在运行命令后加入–debug标志;
  2. 在application.properties/yml中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别。

彩虹色输出日志:
通过在application.properties/yml中设置spring.output.ansi.enabled参数来支持。

  1. NEVER:禁用ANSI-colored输出(默认项)
  2. DETECT:会检查终端是否支持ANSI,是的话就采用彩色输出(推荐项)
  3. ALWAYS:总是使用ANSI-colored格式输出,若终端不支持的时候,会有很多干扰信息,不推荐使用

当有多处指定了要记录的日志的最下日志级别时,走优先级最高的,优先级: logback-spring.xml中 > 启动jar包时 > xxx.properties/xxx.yml中

3. 自定义日志配置

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

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

SpringBoot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml)。

4. spring对日志的配置文件属性支持

#LOGGING 
#日志配置文件的位置。例如,Logback的classpath:logback.xml
logging.config = classpath:logging-config.xml
#记录异常时使用的转换字。
logging.exception-conversion-word =%wEx 
#日志文件名(例如`myapp.log`)。名称可以是确切的位置或相对于当前目录。
logging.file = 
#要保留的归档日志文件的最大数量。仅支持默认的登录设置。
logging.file.max-history = 0 
#最大日志文件大小。仅支持默认的登录设置。
logging.file.max-size = 10MB 
#日志级别严重性映射。例如`logging.level.org.springframework = DEBUG`。
logging.level。* =
#日志文件的位置。例如,`/ var / log`。
logging.path = 
#输出到控制台的Appender模式。仅使用默认的Logback设置支持。
logging.pattern.console = 
#日志格式的Appender模式。仅使用默认的Logback设置支持。
logging.pattern.dateformat = yyyy-MM-dd HH:mm:ss.SSS 
#输出到文件的Appender模式。仅使用默认的Logback设置支持。
logging.pattern.file = 
#日志级别的Appender模式。仅使用默认的Logback设置支持。
logging.pattern.level =%5p 
#为日志记录系统初始化时注册一个关闭钩子。
logging.register-shutdown-hook = false 

5. 整合Logback

5.1 logback-spring.xml

在resources目录下新建一个logback-spring.xml文件。
配置示例:





    RabbitsInTheGrass_XJ

    
    

    
    
    
    
    
    
    
    
    

    
    
        
            
            ${CONSOLE_LOG_PATTERN}
            
            UTF-8
        
        
        
            DEBUG
        
    

    
    
    
        
        
            ${FILE_LOG_PATTERN}
            UTF-8
        
        
        ${log.path}/log_debug.log
        
        
            debug
            ACCEPT
            DENY
        
        
        
            
            ${log.path}/debug/log-debug-%d{yyyy-MM-dd}.%i.log
            
                100MB
            
            
            15
        
    

    
    
        
        
            ${FILE_LOG_PATTERN}
            UTF-8
        
        
        ${log.path}/log_info.log
        
        
            info
            ACCEPT
            DENY
        
        
        
            
            ${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log
            
                100MB
            
            
            15
        
    

    
    
        
        
            ${FILE_LOG_PATTERN}
            UTF-8
        
        
        ${log.path}/log_warn.log
        
        
            warn
            ACCEPT
            DENY
        
        
        
            ${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log
            
                100MB
            
            
            15
        
    

    
    
        
        
            ${FILE_LOG_PATTERN}
            UTF-8
        
        
        ${log.path}/log_error.log
        
        
            ERROR
            ACCEPT
            DENY
        
        
        
            ${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log
            
                100MB
            
            
            15
        
    

    

    
    
        
        
            
        
    
    
    
        
        
            
            
            
            
        
    

详解:

5.1.1 根节点configuration标签

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

5.1.2 属性一:contextName 设置上下文名称

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

5.1.3 属性二:property 设置变量

用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。

5.1.4 子节点一:appender 标签

appender用来格式化日志输出节点,有俩个属性name和class,name自定义,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。

5.1.4.1 控制台输出ConsoleAppender

encoder表示对日志进行编码:

  • %d{HH: mm:ss.SSS}——日志输出时间。
  • %thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用。
  • %-5level——日志级别,并且使用5个字符靠左对齐。
  • %logger{36}——日志输出者的名字。
  • %msg——日志消息。
  • %n——平台的换行符。

ThresholdFilter为系统定义的拦截器,可以过滤某个级别以下的日志不输出到文件中。

5.1.4.2 输出到文件RollingFileAppender

其中重要的是rollingPolicy的定义:

  • < file>${log.path} 正在记录的日志文件的路径及文件名;
  • < fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log 定义了日志的切分方式——把每一天的日志归档到一个文件中;
  • < maxHistory>30表示只保留最近30天的日志,以防止日志填满整个磁盘空间。同理,可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式;
  • < totalSizeCap>1GB用来指定日志文件的上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志。
  • 可以在rollingPolicy中嵌套滚动策略:

    100MB

SizeAndTimeBasedFNATP策略是: 在每天都会拆分日志的前提下,当该天的日志大于规定大小时进行拆分并以【%i】进行区分,i从0开始。

5.1.5 子节点二:loger 标签

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

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

5.1.6 子节点三:root 标签

root节点是必须配置的节点,用来指定最基础的日志输出级别,只有一个level属性。

  • level:设置打印级别,跟大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。
  • 一般都默认是DEBUG。
    可以包含零个或多个元素,标识这个appender将会添加到这个loger。

5.2 多环境日志配置

根据不同的环境(prod:生产环境,test:测试环境,dev:开发环境)来定义不同的日志输出,在 logback-spring.xml中使用 springProfile 节点来定义,方法如下:



    
    
        
        
        
        
        
    



    
    
        
        
        
        
    

多个环境使用同一个在name中用逗号隔开。springProfile 标签的 name 属性对应 application.properties 中的 spring.profiles.active 的配置。即 spring.profiles.active 的值可以看作是日志配置文件中对应的 springProfile 是否生效的开关。

使用中的问题

  1. 建议使用占位符的方式参数化记录日志
  2. logback 内部机制保证 logger 在记录日志时,不必每一次都去遍历它的父辈以获得关于日志级别、Appender 的信息
  3. 在 logback 中,将日志信息格式化,以及输出到目的地,是最损耗性能的操作

你可能感兴趣的:(SpringBoot学习历程(五):集成Logback日志配置)