SpringBoot logback日志配置

190 阅读3分钟

日志级别
A:off 最高等级,用于关闭所有日志记录。
B:fatal 指出每个严重的错误事件将会导致应用程序的退出。
C:error 指出虽然发生错误事件,但仍然不影响系统的继续运行。
D:warm 表明会出现潜在的错误情形。
E:info 一般和在粗粒度级别上,强调应用程序的运行全程。
F:debug 一般用于细粒度级别上,对调试应用程序非常有帮助。
G:all 最低等级,用于打开所有日志记录。

日志输出

  • 命令模式配置: java -jar *.jar --debug=true , 这种命令会被 SpringBoot 解析,且优先级最高
  • 项目想要输出 DEBUG 需要额外配置(配置规则:logging.level.<logger-name>=<level>

configuration 标签

configuration 主要包含appdender、logger、root标签

<?xml version="1.0" encoding="UTF-8"?>

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

	<!-- 用来设置上下文名称,每个logger都关联到logger上下文,默认上下文名称为default。但可以使用<contextName>设置成其他名字,
	用于区分不同应用程序的记录。一旦设置,不能修改。-->
    <contextName>myApplicationName</contextName>


	<!--用来定义变量值,它有两个属性name和value,通过<property>定义的值会被插入到logger上下文中,可以使用“${}”来使用变量。
	name: 变量的名称,value: 的值时变量定义的值-->
    <property name="LOG_HOME" value="${catalina.base}/logs/cloudTest/" />
    
    
	<!--获取时间戳字符串,他有两个属性key和datePattern     key: 标识此<timestamp> 的名字;datePattern: 设置将当前时间(解析配置
	文件的时间)转换为字符串的模式,遵循	java.txt.SimpleDateFormat的格式。这个属性很少使用	-->
    <timestamp key="keyValue" datePattern="yyyy-MM-dd" />    
    <contextName>${keyValue}</contextName>

</configuration>

logger、root 标签

logger

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定appender。 name: 用来指定受此logger约束的某一个包或者具体的某一个类
level: 用来设置打印级别,大小写无关
addtivity: 是否向上级logger传递打印信息。默认是true。
logger可以包含零个或多个appender-ref元素,标识这个appender将会添加到这个logger。

root

root也是logger元素,但是它是logger
root可以包含零个或多个appender-ref元素,标识这个appender将会添加到这个logger。

appender

name指定appender名称
class指定appender的全限定名
encoder:负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。

 <!--控制台日志 -->
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <!--格式化输出(配色):%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
        <pattern>%yellow(%d{yyyy-MM-dd HH:mm:ss}) %red([%thread]) %highlight(%-5level) %cyan(%logger{50}) - %magenta(%msg) %n</pattern>
        <charset>UTF-8</charset>
    </encoder>
</appender>

%d表示日期  
%thread表示线程名  
%-5level表示级别从左显示5个字符宽度  
%msg是日志消息  
%n是换行符

RollingFileAppender

滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。

<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。

<filter>: 表示过滤器,用法稍后讲解。

<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。

<encoder>:对记录日志进行格式化。

<rollingPolicy>: 当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。

<triggeringPolicy >: 告知 RollingFileAppender 何时激活滚动。

<prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1.不支持也不允许文件压缩,2.不能设置file属性,必须留空

SizeAndTimeBasedRollingPolicy(根据时间和文件大小的滚动策略)

根据时间再根据文件大小来滚动生成文件

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- rollover daily -->
            <fileNamePattern>${LOG_HOME}/mylog-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 每个文件最多5MB,保存60天的历史记录,但最多20GB -->
            <maxFileSize>5MB</maxFileSize>
            <maxHistory>60</maxHistory>
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>

TimeBasedRollingPolicy(根据时间的滚动策略)

fileNamePattern 必要节点,文件名必须包含“%d”转换符, “%d”可以包含一个 java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM},如果直接使用 %d,默认格式是 yyyy-MM-dd。

RollingFileAppender 的file子节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;

maxHistory 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且 maxHistory是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件时,那些为了归档而创建的目录也会被删除。

filter

过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。

返回DENY,日志将立即被抛弃不再经过其他过滤器;
返回NEUTRAL,有序列表里的下个过滤器过接着处理日志; 返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。

LevelFilter

level:设置过滤级别

onMatch:用于配置符合过滤条件的操作

onMismatch:用于配置不符合过滤条件的操作

    <filter class="ch.qos.logback.classic.filter.LevelFilter">   
      <level>INFO</level>   
      <onMatch>ACCEPT</onMatch>   
      <onMismatch>DENY</onMismatch>   
    </filter>   

ThresholdFilter

临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。

  <!-- 过滤掉 TRACE 和 DEBUG 级别的日志-->   
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">   
      <level>INFO</level>   
    </filter>   

参考资料
zhuanlan.zhihu.com/p/474844021