logback常见配置

发布时间 2023-05-06 12:51:03作者: JaxYoun

logback常见配置

  1. 依赖jar包
   <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-core -->
   <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-core</artifactId>
       <version>1.1.7</version>
   </dependency>

   <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
   <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
       <version>1.1.7</version>
   </dependency>
  1. logback配置文件加载,根据以下步骤寻找配置文件:

1.在 classpath 中寻找 logback-test.xml文件
2.如果找不到 logback-test.xml,则在 classpath 中寻找 logback.groovy 文件
3.如果找不到 logback.groovy,则在 classpath 中寻找 logback.xml文件

  1. 日志级别 从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。

  2. Appender 为日志输出目的地,常用的几种如下:

  • ch.qos.logback.core.ConsoleAppender:把日志添加到控制台
  • ch.qos.logback.core.FileAppender:把日志添加到文件
  • ch.qos.logback.core.rolling.RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。

rollingPolicy告知当发生滚动时,决定RollingFileAppender的行为。rollingPolicy有:TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略;SizeAndTimeBasedRollingPolicy :有时候你不仅想通过时间来规定滚动策略,还希望同时限制每个日志文件的大小就用它了。
triggeringPolicy:告知 RollingFileAppender 激活滚动。triggeringPolicy中SizeBasedTriggeringPolicy: 查看当前活动文件的大小,如果超过指定大小会告知激活滚动

  1. pattern 控制输出的内容
    %c,%c{参数},%C{参数},%class{参数},%lo{参数},%logger{参数}:输出类名称:

%c org.apache.com.te.Foo org.apache.com.te.Foo
%c{1} org.apache.com.te.Foo Foo
%c{2} org.apache.com.te.Foo te.Foo
%c{1.} org.apache.com.te.Foo o.a.c.t.Foo
%c{1.1.!} org.apache.com.te.Foo o.a.!.!.Foo
%c{.} org.apache.com.te.Foo ….Foo

%d{参数},%date{参数}:输出时间。参数可以是text.SimpleDateFormat字符拼接而成,也可以使用系统默认:

%d 2006-10-20 14:06:49,812
%date 2006-10-20 14:06:49,812
%date{ISO8601} 2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS} 14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS} 20 oct. 2006;14:06:49.812

%L,%line:输出执行日志请求的行号。尽量避免使用,除非执行速度不造成任何问题。
%m或%msg或%message:输出日志信息
%M或%method:输出方法名
%p,%le,%level:输出日志级别
%t,%thread:输出产生日志的线程名。

  1. logback.xml配置文件
<?xml version="1.0" encoding="UTF-8"?>    
<configuration>  
   
    <!-- 可以引入配置文件中的变量logback.properties 定义了一个值log_path-->
    <property resource="logback.properties" />

    <!-- 也可以自己声明一个变量 -->
    <!-- <property name="log_path" value="${catalina.home}" /> -->


​    <!-- 1.控制台输出 -->
​    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
​        <encoder>
​            <pattern>%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
​        </encoder>
​    </appender>
​     
​    <!-- 2.按分钟时间滚动输出 level为 INFO 日志 -->
​    <appender name="file—debug" class="ch.qos.logback.core.rolling.RollingFileAppender">
​        <File>${log_path}/logs/debug.log</File>
​        <!--控制台只输出level级别的信息(onMatch),其他的直接拒绝(onMismatch) -->  
​        <filter class="ch.qos.logback.classic.filter.LevelFilter">
​            <level>INFO</level>
​            <onMatch>ACCEPT</onMatch>
​            <onMismatch>DENY </onMismatch>
​        </filter>
​        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
​            <FileNamePattern>${log_path}/logs/debug.%d{yyyy-MM-dd_HH-mm}.log</FileNamePattern>
​            <!-- 保留的归档文件的最大数量,超出数量就删除旧文件,此处是按分钟滚动,30则代表30分钟 -->
​            <MaxHistory>30</MaxHistory>
​        </rollingPolicy>
​        <encoder>
​            <pattern>%date [%thread] %-5level %logger{80} - %msg%n</pattern>
​        </encoder>
​    </appender>
​     
​    <!-- 3.特定过滤含有某字符串的日志 -->
​    <appender name="file-str" class="ch.qos.logback.core.rolling.RollingFileAppender">
​        <File>${log_path}/logs/contains.log</File>
​        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
​            <evaluator>
​                <!-- 日志信息中需要包含指定的字符串 -->
​                <expression>message.contains("abc")</expression>
​            </evaluator>
​            <onMatch>ACCEPT</onMatch>
​            <onMismatch>DENY</onMismatch>
​        </filter>
​        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
​            <FileNamePattern>${log_path}/logs/contains.%d{yyyy-MM-dd}.log </FileNamePattern>
​            <MaxHistory>30</MaxHistory>
​        </rollingPolicy>
​        <encoder>
​            <pattern>%date [%thread] %-5level %logger{80} - %msg%n</pattern>
​        </encoder>
​    </appender>
​     
​    <!-- 4.按照每天和每个日志文件大小生成日志文件 -->   
​    <appender name="audioDist"  class="ch.qos.logback.core.rolling.RollingFileAppender">   
​        <File>${log_path}/logs/audioDist.log</File>
​        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
​            <!--日志文件输出的文件名-->
​            <FileNamePattern>${log_path}/logs/audioDist.%d{yyyy-MM-dd}.%i.log</FileNamePattern> 
​            <!--日志文件保留天数-->
​            <MaxHistory>30</MaxHistory>
​            <!-- 单个日志文件的大小 单位KB,MB,GB -->
​            <maxFileSize>1KB</maxFileSize> 
​            <!-- 所有日志文件的总大小空间。当日志文件的空间超过了设置的最大空间数量,就会删除旧的文件。注意:这个标签必须和maxHistory标签一起使用。 -->
​            <totalSizeCap>10MB</totalSizeCap> 
​        </rollingPolicy>   
​        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
​            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--> 
​            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>   
​        </encoder> 
​    </appender> 
​     
​    <!-- 5.指定包输出指定级别日志 -->
​    <logger name="com.gavin">
​        <level value="warn" />
​    </logger>
​         
    <root level="DEBUG">
        <appender-ref ref="stdout" />
        <appender-ref ref="audioDist"/>
        <appender-ref ref="file—debug"/>
        <appender-ref ref="file-str"/>
    </root>   
</configuration>