Logback日志小记

最新推荐文章于 2023-06-14 10:59:05 发布
最新推荐文章于 2023-06-14 10:59:05 发布
阅读量669 收藏
点赞数
分类专栏： Java基础 文章标签： 日志
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/myt0929/article/details/105400737
版权

日志系统

Java中常用的日志系统有很多，比如logging、log4j、logback等等。广泛使用的是logback+slf4j，同时代码里加入Lombok的插件，这样快速方便的使用日志。

一、包引入

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>

这个包已经包括了logback-core、slf4j-api，所以只要包含一个包就可以了。

二、配置文件

Logback默认配置的步骤：

  • 检查是否配置了系统变量logback.configurationFile，有则使用此配置的路径中的logback配置文件
  • 在classpath下查找 logback-test.xml文件
  • 第二步没找到，则在classpath下查找logback.groovy文件
  • 第三步没找到，则在classpath下查找logback.xml文件，推荐。
  • 第四步没找到，通过spi机制，查找META-INF\services\ch.qos.logback.classic.spi.Configurator 配置的 com.qos.logback.classic.spi.Configurator（此类在logback-classic jar中）的实现类，调用他的configure方法进行配置。
  • 第五步没找到，使用默认的BasicConfigurator（实现了Configurator接口）进行配置。以上的寻找配置的代码在ch.qos.logback.classic.util.ContextInitializer.autoConfig中可以找到。

三、组件
LogBack
appender
logger
layout
  • logger：作为日志的记录器，拥有自己的日志级别。
  • appender：主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。
  • layout：格式化日志的样式，可以搭载在不同的appender中。

四、配置文件例子

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="60 seconds">

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <target>System.out</target>
        <encoder>
            <pattern><![CDATA[
				%-20(%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] ) %-5level %logger{80}[%L] - %msg%n
          ]]></pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    
    <appender name="AppenderError" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${catalina.base}/logs/error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${catalina.base}/logs/error.%d{yyyy-MM-dd}.log</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <append>true</append>
        <encoder>
            <pattern><![CDATA[
                        %-20(%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] ) %-5level %logger{80} - %msg%n
                  ]]></pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    
    <appender name="AppenderInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${catalina.base}/logs/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${catalina.base}/logs/info.%d{yyyy-MM-dd}.log</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <append>true</append>
        <encoder>
            <pattern><![CDATA[
                        %-20(%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] ) %-5level %logger{80} - %msg%n
                  ]]></pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    
    <appender name="AppenderDebug" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${catalina.base}/logs/debug.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${catalina.base}/logs/debug.%d{yyyy-MM-dd}.log</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <append>true</append>
        <encoder>
            <pattern><![CDATA[
                        %-20(%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] ) %-5level %logger{80} - %msg%n
                  ]]></pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
    </appender>
    
    <shutdownHook class="ch.qos.logback.core.hook.DelayingShutdownHook"/>
    
    <logger name="com.demo.service" level="error"/>

    <root level="${log.level}">
        <appender-ref ref="AppenderError"/>
        <appender-ref ref="AppenderInfo"/>
        <appender-ref ref="AppenderDebug"/>
    </root>
</configuration>

1、configuration

配置的结构，以configuration包含块为文件，带有3个参数。

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

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

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

2、appender

日志输出的目的地，常用的有ConsoleAppender-输出到控制台、FileAppender-输出到文件、RollingFileAppender-滚动记录文件。

2.1 ConsoleAppender-输出到控制台
  • <encoder>：对日志进行格式化。作用等同于layout
  • <target>：输出控制台日志，字符串 System.out 或者 System.err ，默认 System.out
2.2 FileAppender-输出到文件
  • <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
  • <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
  • <encoder>：对日志进行格式化。作用等同于layout
  • <prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。
2.3 RollingFileAppender-滚动记录文件

最为常见的日志方式。滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。这里的条件可以是时间、文件大小等等。

  • <file>、<append>、<encoder>和之前都一样
  • <rollingPolicy>指定滚动策略：TimeBasedRollingPolicy-基于时间的回滚、FixedWindowRollingPolicy-基于窗口滚动、SizeAndTimeBasedRollingPolicy-按照时间和大小滚动
  • <filter> 过滤策略，根据条件输出：LevelFilter-根据日志级别进行过滤、ThresholdFilter-过滤掉低于指定临界值的日志、 EvaluatorFilter-评估、鉴别日志是否符合指定条件

例子：

<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    	<fileNamePattern>/logback/log/test-%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
</appender>

时间回滚策略。

  • <FileNamePattern>设置滚动生成文件的格式,这里设置的精确到天，也就是按照天滚动，如果时间设置精确到秒，就按秒来滚动。
  • <maxHistory>设定最大的文件数，比如按天滚动，这里设置了30天，在第31天日志生成的时候，第一天的日志就会被删掉
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
        <fileNamePattern>/logback/log/test-%i.log</fileNamePattern>
        <minIndex>1</minIndex>
        <maxIndex>3</maxIndex>
    </rollingPolicy>
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
	    <maxFileSize>1MB</maxFileSize>
    </triggeringPolicy>
</appender>

固定文件大小回滚策略。

  • <fileNamePattern>定义文件名称的时候使用%i作为占位符，滚动后会数值替换
  • <minIndex> 开始的索引
  • <maxIndex> 最大索引，听说有最大值12，还没验证过
  • <triggeringPolicy> 触发器：SizeBasedTriggeringPolicy文件大小触发器，maxFileSize：最大文件大小
<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <!-- rollover daily -->
      <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
       <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
       <maxFileSize>100MB</maxFileSize>    
       <maxHistory>60</maxHistory>
       <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
</appender>

固定文件大小和时间回滚策略。很多人认为TimeBasedRollingPolicy搭配SizeBasedTriggeringPolicy可以使用固定大小和时间的回滚，但是官网说了，这两个有冲突，会导致并不能按照原先的想法去做，必须使用SizeAndTimeBasedRollingPolicy的回滚策略。

  • <maxFileSize> 文件最大大小，每次当前日志文件在当前时间段结束之前达到maxFileSize时，将使用从0开始的递增索引进行归档。
  • <maxHistory> 最大周期数，您需要使用maxHistory属性指定要保留的周期数。
  • <totalSizeCap> 可选，控制所有存档文件的总大小。当超过总大小上限时，最早的档案将被异步删除。 totalSizeCap属性还需要设置maxHistory属性。此外，始终首先应用“最大历史记录”限制，然后应用“总大小上限”限制。
2.4 Filter

filter按照上诉的介绍，是appender的记入日志的过滤器。

filter过滤器，执行一个过滤器会有返回个枚举值，即DENY，NEUTRAL，ACCEPT其中之一。返回DENY，日志将立即被抛弃不再经过其他过滤器；返回NEUTRAL，有序列表里的下个过滤器过接着处理日志；返回ACCEPT，日志会被立即处理，不再经过剩余过滤器。

过滤器被添加到appender中，为appender添加一个或多个过滤器后，可以用任意条件对日志进行过滤。 有多个过滤器时，按照配置顺序执行。

2.4.1 LevelFilter

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

  • <level>:设置过滤级别
  • <onMatch>:用于配置符合过滤条件的操作
  • <onMismatch>:用于配置不符合过滤条件的操作
<appender name="AppenderDebug" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <filter class="ch.qos.logback.classic.filter.LevelFilter">
    <level>DEBUG</level>
    <onMatch>ACCEPT</onMatch>   
    <onMismatch>DENY</onMismatch> 
  </filter>
</appender>

将过滤器的日志级别配置为INFO，所有INFO级别的日志交给appender处理，非INFO级别的日志，被过滤掉。

2.4.2 ThresholdFilter

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

<appender name="AppenderDebug" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>INFO</level>
  </filter>
</appender>

过滤掉所有低于INFO级别的日志。

2.4.3 EvaluatorFilter

求值过滤器，评估、鉴别日志是否符合指定条件。

  • <evaluator>:鉴别器，常用的鉴别器是JaninoEventEvaluator，也是默认的鉴别器，它以任意的java布尔值表达式作为求值条件，求值条件在配置文件解释过成功被动态编译，布尔值表达式返回true就表示符合过滤条件。evaluator有个子标签<expression>，用于配置求值条件。
  • <onMatch>:用于配置符合过滤条件的操作
  • <onMismatch>:用于配置不符合过滤条件的操作
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
  <filter class="ch.qos.logback.core.filter.EvaluatorFilter">         
    <evaluator> <!-- 默认为 ch.qos.logback.classic.boolex.JaninoEventEvaluator -->   
      <expression>return message.contains("billing");</expression>   
    </evaluator>   
    <OnMatch>ACCEPT </OnMatch>  
    <OnMismatch>DENY</OnMismatch>  
  </filter>   
</appender>

过滤掉所有日志消息中不包含“billing”字符串的日志。

3、logger

<configuration debug="true" scan="true" scanPeriod="60 seconds">
    <logger name="com.example.logback.logger" level="info">
      	<!-- 指定输出的appender -->
        <appender-ref ref="logger_stdout"/>
    </logger>
</configuration>

可以根据logger中的name属性指定某个文件或者文件夹输出的日志级别，并通过appender-ref指定日志的输出appender。还有一个additivity属性，如果设置为false的话就不会向上传递。什么意思呢？就是你在name中指定地方产生日志，这个日志会根据当前的logger配置输出，如果additivity=true，并且有上一级（包括root级别），则向上传递，可能还会再打印一遍。

4、root

整个项目的根级别日志设置

 <root level="${logLevel}">
        <appender-ref ref="AppenderError"/>
        <appender-ref ref="AppenderInfo"/>
        <appender-ref ref="AppenderDebug"/>
 </root>

上面这种，想使用yml或者properties里的参数，就得将logback.xml更名成logback-spring.xml，因为spring先加载logback.xml然后再加载配置，然后再加载logback-spring.xml。

<configuration debug="false" scan="true" scanPeriod="60 seconds">
    <springProperty scope="context" name="logLevel" source="log.level"/>
</configuration>

五、案例

1、巧妙运用logger和root

<configuration debug="false" scan="true" scanPeriod="60 seconds">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <target>System.out</target>
        <encoder>
            <pattern><![CDATA[
				%-20(%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] ) %-5level %logger{80}[%L] - %msg%n
          ]]></pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
  
    <logger name="org.example.logback.logger" level="ERROR"/>

    <root level="INFO">
        <appender-ref ref="STDOUT"/>    
    </root>
</configuration>

在上面这个配置中，在org.example.logback.logger包下的日志，日志级别是ERROR，但是没有appender，说明ERROR日志会被传到上级被记录，本logger不起任何作用。如果是INFO日志，因为和本级日志级别优先级低，所以被抛弃也不传送到上层。所以这种写法很好的限制某个包下日志级别，但又不阻碍其他包的日志传递。

正经黑天鹅
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Logback (7) | Missing integer token, that is %i, in FileNamePattern
Web3 & Basketball
01-29 1万+
logback.xml配置日志的时候 appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender"> filter class="ch.qos.logback.classic.filter.LevelFilter"> lev
Logback日志
一个孤独漫步者的遐想的博客
08-13 2522
Logback日志 1、配置logback日志2、创建 logback-spring.xml3、压缩日志 1、配置logback日志 删除application.properties中的日志配置（删除这两个） 2、创建 logback-spring.xml 安装idea彩色日志插件：grep-console resources 中创建 logback-spring.xml <?xml version="1.0" encoding="UTF-8"?> <!-- 日志配置 --> &l
在logback的fileNamePattern配置%i 带来的异常
runwuwushengxiyu的博客
05-07 1224
在logback的fileNamePattern配置%i 带来的异常
springboot logback 日志配置。
yuanquanl的博客
06-15 8351
下面的引用 SizeAndTimeBasedRollingPolicy  只能是1.2版本以上 ，如果是spring starter 中已经引用了，直接修改日志版本号即可 即在pom中加入：    1.2.1 注意1：TimeBasedRollingPolicy 和 SizeAndTimeBasedRollingPolicy  的区别。 使用TimeBasedRolling
logback-spring.xml
mis_huang的博客
01-28 202
<?xml version="1.0" encoding="UTF-8"?> <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 --> <!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true --> <!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如.
Springboot2整合logback.xml动态修改日志打印级别
z69183787的专栏
11-06 3395
今天找bug烦到了，生产上的日志级别不能修改，非常不利于排查问题，于是想到了动态修改日志打印级别，因为上一周把项目升级成springboot2，并且使用logback.xml管理日志打印，所以修改也很方便。 1.在pom.xml引入日志依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-s..
Logback日志详解
weixin_49983224的博客
03-27 1058
解析Logback日志文件以及完整的Logback日志文件
Logback日志系统文件
03-01
Logback是由log4j创始人设计的另一个开源日志组件，基于slf4j的日志规范实现的框架,性能比log4j要好。 Logback主要分为三个技术模块： logback-core：该模块为其他两个模块奠定了基础。 logback-classic：是log4j...
logback日志配置
10-30
logback是在log4j的基础上衍生出来的日志管理技术，现在外面用的也非常广，这里给大家分享一个我们经常用的配置，我们公司项目中已经在使用了，亲测可行，需要的下载看看，希望对你有帮助
java的Logback日志框架jar包
07-11
Logback 是一个在Java开发中广泛使用的日志记录框架，由Ceki Gülcü创造，他是之前流行的log4j框架的创始人。Logback是作为log4j的替代品设计的，它提供了更高的性能和更多的特性。这个压缩包包含了Logback框架的...
springboot配置logback日志管理过程详解
08-25
SpringBoot 配置 Logback 日志管理过程详解 本文将详细介绍 SpringBoot 配置 Logback 日志管理过程的知识点，通过示例代码，帮助读者更好地理解Logback日志管理在 SpringBoot 中的应用。 Logback 简介 Logback 是...
logback日志框架包
11-25
Logback 是一个广泛使用的日志记录框架，由 Ceki Gülcü 创建，他是早期流行的日志框架 Log4j 的创始人。Logback 主要分为三个组件：logback-core、logback-classic 和 logback-access，分别提供了核心功能、SLF4J...
Logback日志配置
sssxlxwbwz的博客
08-24 9746
Logback配置文件解析
logback配置文件分析
m0_64053569的博客
06-14 166
在springboot项目中无需引入其它依赖，因为spring-boot-starter依赖中包含了spring-boot-starter-logging。在resource目录下新建logback.xml文件，如下就可以直接使用了。
logback-spring.xml配置日志记录
GG丶shy
03-26 1275
<?xml version="1.0" encoding="UTF-8"?> <configuration debug="false" scan="true" scanPeriod="1 seconds"> <!-- debug : 默认为false ，设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。 scan : 配置...
logback--进阶--04--配置
zhou920786312的博客
06-22 2513
1、加载配置的步骤 1.1、步骤 步骤1 Logback 尝试在 classpath 中找一个名为 logback-test.xml 的文件 。如果找不到此类文件，则 logback 尝试在 classpath 中找一个名为 logback.groovy 的文件 。如果找不到这样的文件，它将在 classpath 中找一个名为 logback.xml 的文件。如果还没有找到这样的文件， ServiceLoader会通过 META-INF\services\ch.qos.logback.classic.spi
logback的使用和配置详解
繁华落烬命入戏
11-26 1142
前言 &nbsp;&nbsp;本文主要记录下logback中配置日志的时效性,和对输出日志进行按级别分包切割,按照时间进行切割,以及限制单个文件大小,和总文件大小,配置可保存的日志天数,还有配置控制台的输出格式和颜色 &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;configuration debug="false" scan="true&quo
pillow-10.4.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl
最新发布
07-27
基本介绍 名称与起源：Pillow，原名为PIL（Python Imaging Library），但PIL只支持Python 2版本。随着Python 3的普及，Pillow作为PIL的一个分支出现，兼容Python 3并提供更多的功能和改进。 主要功能：Pillow支持多种图像格式的打开、保存、显示以及基本的图像操作和处理，如裁剪、缩放、旋转、翻转、滤镜应用等。 跨平台性：Pillow库可以在不同的操作系统上运行，包括Windows、Linux和MacOS等。 主要功能模块 Pillow库包含多个功能模块，每个模块都提供了特定的图像处理功能。以下是一些常用的模块： Image：用于处理图像文件，提供打开、保存、调整大小、旋转、裁剪、滤镜等功能。 ImageDraw：提供在图像上绘制各种形状（如线条、矩形、圆形）和文本的功能。 ImageFont：用于加载和使用TrueType字体文件，以便在图像上绘制文本时设置字体样式、大小和颜色。 ImageFilter：提供各种滤镜效果，如模糊、锐化、边缘增强等，用于图像增强、特效处理和图像识别等应用。 ImageEnhance：用于调整图像的亮度、对比度、颜色饱和度等参数，使图像更加清晰、明亮或具有特定的调色效果。 高级功能 除了基本的图像处理功能外，Pillow还支持一些高级功能，如色彩空间转换、直方图均衡化等。这些功能可以帮助用户进行更复杂的图像处理和分析。
logback日志框架详解与配置指南
"Logback日志使用 - Logback是log4j的升级版，提供完整的配置例子和丰富的资料" Logback是Java世界中的一个强大的日志框架，由log4j的创始人Ceki Gülcü设计。它被视为log4j的升级版，提供了更高效的性能和更多...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值