首页 > 编程语言 > 使用Logback设置日志级别
2021
12-09

使用Logback设置日志级别

Logback设置日志级别

使用Logback设置日志的设置方式现在已经有很多文章说明，本文重点说明不同设置方式的区别和用途。首先列举常用的三种方式，接下来说明其区别。

appender中的LevelFilter：

级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志

 <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">   
   <filter class="ch.qos.logback.classic.filter.LevelFilter">   
     <level>INFO</level>   
     <onMatch>ACCEPT</onMatch>   
     <onMismatch>DENY</onMismatch>   
   </filter>   
   ...
 </appender>

appender中的ThresholdFilter：

临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL。跟LevelFilter的区别在于一个是区间，一个是单点。

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

logger中的Level：

用来设置指定名称的日志级别，如果不设定，那么采用父类的level，最顶级的父类是ROOT，一般用来调整指定类的日志级别，其规则为等于或者高于设定level的日志才可能输出（注意是可能，因为还要看appender的设置）

<logger level="TRACE" name="com.test.pk1"/>

那么以上几种应该如何使用，如何生效？

如何生效：可以这样理解日志的处理流水线：

先判断logger的level，如果不满足直接丢弃不打印，如果满足进入下一步

1、找到关联的appender，根据appender的filter对日志进行过滤

2、如何应用：通过logger设置日志的level比较常见，也比较容易理解。既然已经能够通过logger的level控制日志按照级别输出，appender的filter什么时候用？

主要应用的场景是：按照日志级别保存不同的文件。比如等于或高于error级别保存到log_error.log文件，等于或高于warn级别保存到log_warn.log文件（深究一下：为什么要按照级别保存不同的文件？方便发现问题，因为实际应用中DEBUG级别的日志量往往很大，通过日志分级别保存，可以直接看error级别的日志，快速发现问题）。

Example：

<appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="WarnLogFile">
        ...
        <file>${LOGS_DIR}/log-warn.log</file>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level>
        </filter>
        ...
    </appender>
    
    <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="InfoLogFile">
        ...
        <file>${LOGS_DIR}/log-info.log</file>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        ...
    </appender>
    
    <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="DebugLogFile">
        ...
        <file>${LOGS_DIR}/log-debug.log</file>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        ...
    </appender>

Logback日志-分日志等级别输出

一 logback的介绍

Logback是由log4j创始人设计的另一个开源日志组件,官方网站： http://logback.qos.ch。它当前分为下面下个模块：

  • logback-core：其它两个模块的基础模块
  • logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging
  • logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能

二 logback的配置介绍

Logger、appender及layout

Logger作为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。

Appender主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。

Layout 负责把事件转换成字符串，格式化的日志信息的输出。

logger context

各个logger 都被关联到一个 LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger名称为参数。用同一名字调用LoggerFactory.getLogger 方法所得到的永远都是同一个logger对象的引用。

有效级别及级别的继承

Logger 可以被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于ch.qos.logback.classic.Level类。如果 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。

打印方法与基本的选择规则

打印方法决定记录请求的级别。例如，如果 L 是一个 logger 实例，那么，语句 L.info("…")是一条级别为 INFO的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用，否则，称为被禁用。记录请求级别为 p，其 logger的有效级别为 q，只有则当 p>=q时，该请求才会被执行。

该规则是 logback 的核心。级别排序为： TRACE < DEBUG < INFO < WARN < ERROR

分日志等级别输出

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="log"/>
    <property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{TRACE_ID}] %-5level %logger{20}[%L] - %msg%n"/>
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>${PATTERN}</pattern>
            <!-- 设置输出字符集编码 -->
            <charset>UTF-8</charset>　　
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <append>true</append>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>${PATTERN}</pattern>
            <!-- 设置输出字符集编码 -->
            <charset>UTF-8</charset>　　
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>50MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    <!-- ERROR 文件输出日志 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_HOME}/log_error.log</File>
        <append>true</append>
        <prudent>false</prudent>
        <!-- 日志文件rolling策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/log_error_%d{yyyy-MM-dd}.log.gz</FileNamePattern>
            <!-- 日志在磁盘上保留天数 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 过滤器，只ACCEPT接收ERROR级别的日志，其它日志级别都DENY拒绝 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 日志输出格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- INFO 文件输出日志 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_HOME}/log_info.log</File>
        <append>true</append>
        <prudent>false</prudent>
        <!-- 日志文件rolling策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/log_info_%d{yyyy-MM-dd}.log.gz</FileNamePattern>
            <!-- 日志在磁盘上保留天数 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 过滤器，只ACCEPT接收ERROR级别的日志，其它日志级别都DENY拒绝 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 日志输出格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- DEBUG 文件输出日志 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_HOME}/log_debug.log</File>
        <append>true</append>
        <prudent>false</prudent>
        <!-- 日志文件rolling策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/log_debug_%d{yyyy-MM-dd}.log.gz</FileNamePattern>
            <!-- 日志在磁盘上保留天数 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 过滤器，只ACCEPT接收ERROR级别的日志，其它日志级别都DENY拒绝 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 日志输出格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 把日志异步输出到磁盘文件中，避免每次都进行磁盘IO操作 -->
    <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>10000</queueSize>
        <appender-ref ref="FILE" />
    </appender>
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
<!--        <appender-ref ref="ASYNC"/>-->
<!--        <appender-ref ref="ERROR_FILE"/>-->
<!--        <appender-ref ref="INFO_FILE"/>-->
<!--        <appender-ref ref="DEBUG_FILE"/>-->
    </root>
</configuration>

以上为个人经验，希望能给大家一个参考，也希望大家多多支持自学编程网。

编程技巧