logback日志配置详解

偏执的太偏执、 2023-09-27 16:33 185阅读 0赞

这里对 logback 的日志配置文件做了一下总结。logback 整体的运行机制是非常复杂而庞大的，这里只对 配置文件的一些节点，做简单的介绍，希望能对大家 ，有所帮助！

1.根节点 包含的属性：

scan

当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true

scanPeriod

设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟

debug

当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false

  1. <!-- 一般的配置如下-->
  2. <configurationscan="true"scanPeriod="60 seconds"debug="false">
  3. <!-- 其他配置省略-->
  4. </configuration>

2.根节点 的子节点

35c3c3a4f5cbfe5ef3ef08aa10c677e5.png

1.logger

logger

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

name 用来指定受此 loger 约束的某一个包或者具体的某一个类

level 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特殊值 INHERITED 或者同义词 NULL ，代表强制执行上级的级别。

如果未设置此属性，那么当前 logger 将会继承上级的日志级别

addtivity 是否向上级 logger 传递打印信息。默认是true

  1. <!-- 如这个例子，打印 org.mybatis 下的 INFO 级别的日志-->  
  2. <logger name="org.mybatis" level="INFO"/>

2.appender

appender

是 的子节点，是负责写日志的组件。该标签负责以适当的格式将日志记录事件输出到适当的输出设备

name 指定appender名称

class 指定appender的全限定名

  1. <!-- 如这个例子，name 为 ERROR-LOG-->
  2. <!-- class 为 RollingFileAppender -->
  3. <appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
  5. </appender>

常用的 appender 类型

RollingFileAppender

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

appender 的子标签

encoder 对日志进行格式化

target

rollingPolicy 当发生滚动时，决定RollingFileAppender 的行为，涉及文件移动和重命名(设置滚动策略)

class ：

为 rollingPolicy 的属性，设置 日志的滚动策略，最常用的滚动策略为

TimeBasedRollingPolicy ：它根据时间来制定滚动策略，既负责滚动也负责出发滚动

rollingPolicy 的 子节点

: 为一个必要的子节点，设置日志文件的名称 。一般包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。

: 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。

  1. <!--滚动策略-->
  2. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  3.     <!--设置日志文件保存路径，以及 日志文件的名称-->
  4.     <fileNamePattern>${log.home}/%d{yyyy-MM,aux}/soi-%d{yyyy-MM-dd}.error.log</fileNamePattern>
  5.     <!--默认保存 30 天的 日志文件-->
  6.     <maxHistory>30</maxHistory>
  7. </rollingPolicy>

filter :

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

class ：为 filter 设置指定的过滤器 ，下面列举几个常见的 过滤器

几个常见的日志过滤器

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

例如，下面这个例子，将 所有 degug 级别的日志交给 他的 父节点 appender 去处理

  1. <!--示例-->
  2. <filter class="ch.qos.logback.classic.filter.LevelFilter">
  3.     <!--设置过滤级别 为 DEBUG-->
  4.     <level>DEBUG</level>
  5.      <!--用于配置符合过滤条件的操作-->
  6.     <onMatch>ACCEPT</onMatch>
  7.     <!--用于配置不符合过滤条件的操作-->
  8.     <onMismatch>DENY</onMismatch>
  9. </filter>

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

例如，下面这个例子，将 所有 低于 WARN 级别的日志过滤掉

  1. <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  2.      <level>WARN</level>
  3. </filter>

EvaluatorFilter ：求值过滤器，评估、鉴别日志是否符合指定条件。需要额外的两个JAR包，commons-compiler.jar和janino.jar。用的比较少，这里不详细展开

3.root

root 为根元素，只有一个level属性。 可以包含零个或多个 元素
level 设置日志级别。

  1. <!--root 节点中，引用了 名为 ASYNC-INFO 的 appender-->
  2. <root level="INFO">
  3.     <appender-ref ref="ASYNC-INFO"/>
  4. </root>

3.springBoot如何整合 logback

springBoot已经帮我们引入了，使用logback的相关 jar 包，所以我们不需要 再去引用

查找 日志 依赖所在位置

springboot的pom文件都会引一个parent

  1. <parent>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-parent</artifactId>
  4.     <version>2.0.0.RELEASE</version>
  5. </parent>

点进去这个parent，会有一个这个dependency

  1. <parent>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-dependencies</artifactId>
  4.     <version>2.0.0.RELEASE</version>
  5.     <relativePath>../../spring-boot-dependencies</relativePath>
  6. </parent>

再点进去就是2.0版本，所谓的它给你集成的各种包依赖，而且规定了版本号，其中有一个包如下

  1. <dependency>
  2.      <groupId>org.springframework.boot</groupId>
  3.      <artifactId>spring-boot-starter</artifactId>
  4.      <version>2.0.0.RELEASE</version>
  5. </dependency>

再点进去

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-logging</artifactId>
  4.     <version>2.0.0.RELEASE</version>
  5.     <scope>compile</scope>
  6. </dependency>

再点，这些都是原有的日志包，所以，不必再引依赖了，直接用就ok了，用法如下：

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>ch.qos.logback</groupId>
  4.         <artifactId>logback-classic</artifactId>
  5.         <version>1.2.3</version>
  6.         <scope>compile</scope>
  7.     </dependency>
  8.     <dependency>
  9.         <groupId>org.apache.logging.log4j</groupId>
  10.         <artifactId>log4j-to-slf4j</artifactId>
  11.         <version>2.11.1</version>
  12.         <scope>compile</scope>
  13.     </dependency>
  14.     <dependency>
  15.         <groupId>org.slf4j</groupId>
  16.         <artifactId>jul-to-slf4j</artifactId>
  17.         <version>1.7.25</version>
  18.         <scope>compile</scope>
  19.     </dependency>
  20. </dependencies>

在项目 资源文件夹 resources 下 创建 logback-spring.xml 文件。logback 将会自动读取该配置文件文件，下面给出 配置文件 样例。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration scan="true" scanPeriod="60 seconds">
  5.   <appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
  6.     <layout class="ch.qos.logback.classic.PatternLayout">
  7.       <pattern>${CONSOLE_LOG_PATTERN}</pattern>
  8.     </layout>
  9.   </appender>
  10.   <!--获取比info级别高(包括info级别)但除error级别的日志-->
  11.   <appender name="INFO-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
  12.     <filter class="ch.qos.logback.classic.filter.LevelFilter">
  13.       <level>DEBUG</level>
  14.       <onMatch>DENY</onMatch>
  15.       <onMismatch>ACCEPT</onMismatch>
  16.     </filter>
  17.     <encoder>
  18.       <pattern>${CONSOLE_LOG_PATTERN}</pattern>
  19.     </encoder>
  21.     <!--滚动策略-->
  22.     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  23.       <!--路径-->
  24.       <fileNamePattern>${log.home}/%d{yyyy-MM,aux}/soi-%d{yyyy-MM-dd}.info.log</fileNamePattern>
  25.       <maxHistory>30</maxHistory>
  26.     </rollingPolicy>
  27.   </appender>
  29.   <appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
  30.     <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  31.       <level>ERROR</level>
  32.     </filter>
  33.     <encoder>
  34.       <pattern>${CONSOLE_LOG_PATTERN}</pattern>
  35.     </encoder>
  36.     <!--滚动策略-->
  37.     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  38.       <!--路径-->
  39.       <fileNamePattern>${log.home}/%d{yyyy-MM,aux}/soi-%d{yyyy-MM-dd}.error.log</fileNamePattern>
  40.       <maxHistory>30</maxHistory>
  41.     </rollingPolicy>
  42.   </appender>
  43.   <!-- 异步输出 -->
  44.   <appender name="ASYNC-ERROR" class="ch.qos.logback.classic.AsyncAppender">
  45.     <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
  46.     <discardingThreshold>0</discardingThreshold>
  47.     <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
  48.     <queueSize>256</queueSize>
  49.     <!-- 添加附加的appender,最多只能添加一个 -->
  50.     <appender-ref ref="ERROR-LOG"/>
  51.   </appender>
  53.   <!-- 输出到控制台和文件，可定义更多的 Appender -->
  54.   <springProfile name="dev,loc">
  55.     <root level="DEBUG">
  56.       <appender-ref ref="CONSOLE-LOG"/>
  57.     </root>
  58.   </springProfile>
  60.   <springProfile name="test,uat">
  61.     <root level="INFO">
  62.       <appender-ref ref="ASYNC-INFO"/>
  63.     </root>
  64.   </springProfile>
  66.   <!-- 下面配置一些第三方包的日志过滤级别 -->
  67.   <logger name="org.mybatis" level="INFO"/>
  69. </configuration>

发表评论

表情：
评论列表 （有 0 条评论，185人围观）

还没有评论，来说两句吧...

相关阅读