Logback日志框架

1、日志有什么用

日志是用来记录追踪程序在运行过程中的信息的,我们可以利用日志很快定位问题。

2、什么是Logback

Logback是由log4j创始人设计的又一个开源日志组件

3、Logback的主要组成部分

Logback主要由三个模块组成:

① logback-access
logback-access模块与Servlet容器继承,以提供HTTP访问日志功能,我们可以使用logback-access来替换Tomcat的访问日志

② logback-classic
log4j的改良版,同时它提供了slf4j API,让我们可以很方便的更换成其他日志系统,如:log4j。(slf4j:即门面日志接口,提供了一套标准的日志功能接口,没有具体实现,log4j,logback都是slf4j的具体实现)

③ logback-core
其他两个模块的基础模块

4、Logback主要标签

Logback主要用到的三个标签:

① logger

日志记录器,用于存放日志对象,定义日志的类型和级别等

② appender

用于指定日志输出的目的地,也就是日志存放的媒介,这个媒介可以是控制台,可以是文件,也可以是远程套接字服务器

③ layout

用来格式化日志信息的输出的

5、Logback的具体配置

1、引入logback依赖

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>

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

2、创建logback配置文件logback.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!--
configuration是logback的根标签;
scan="true" 表示配置文件发生了改变会自动加载;
scanPeriod="60 seconds" 检测配置文件修改的时间间隔,默认的单位是毫秒,这里我们设置的表示每分钟检测;

debug="false" debug如果设置为true,表示我们会打印出logback自身实时的运行信息,这里我们就不需要了,
    因为logback自身运行时非常稳定的,我们不需要对它做日志。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />

    <!--定义一些参数常量-->
    <!--定义日志的输出位置-->
    <property name="log.filepath" value="log"/>

    <!--
    定义日志展示的格式
    %d{yyyy-MM-dd HH:mm:ss.SSS} 定义一条日志的展示时间
    [%thread] 表示执行日志的线程名称
    %-5level 我们空出5个空格,然后显示我们的日志级别
    %logger{100} 显示我们再哪个类(全限定类名)里面记录的日志,后面的{100}表示这个类名展示的最大长度是100
    %msg 表示我们的日志信息
    %n 表示换行
    -->
    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{100} %msg%n"/>

    <property name="stdlog.pattern" value="%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>

    <!--定义日志输出的媒介-->
    <!--定义控制台输出,class指定的是我们具体输出位置要使动的类-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!--appender负责 统一调度日志的输出工作,而具体的日志的格式化工作和输出的工作会交给encoder-->
        <encoder>
            <!--定义日志输出的格式-->
            <pattern>${stdlog.pattern}</pattern>
        </encoder>
    </appender>

    <!--定义error级别的日志的appender,RollingFileAppender表示滚动日志,我们可以按天或者按月来生成不同的日志文件-->
    <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--文件路径-->
        <file>log/tc-order-server.log</file>
        <!--定义滚动策略,TimeBasedRollingPolicy是一个基于时间的滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            设置按每分钟的方式来生成文件,如果我们的文件名是用.gz结尾的,那么logback会自动帮我们压缩日志文件,
            如果我们不需要压缩,我们可以直接把.gz删除就行了
            -->
            <fileNamePattern>log/tc-order-server-%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--设置文件最大保存的历史数据,这里就默认30份就行了-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!--定义日志格式-->
        <encoder>
            <!--定义日志输出的格式-->
            <pattern>${log.pattern}</pattern>
        </encoder>
        <!--因为我们的ROLLING只需要记录error级别的日志,对于其他的日志我们不需要,所以我们要加一个过滤器,对于其他级别的日志,直接过滤-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <!--如果是ERROR日志,我们同意记录-->
            <onMatch>ACCEPT</onMatch>
            <!--如果不是ERROR日志,我们直接忽略-->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--
    对于日志框架来说,日志是有级别的,logback的日志级别有如下:
    trace(追踪) < debug(调试) < info(记录信息) < warn(警告) < error(错误)

    配置我们自己写的代码的日志记录器
    name="com.vgxit.logback.kkdm" 表示对应包(包含子包)里面的类中的代码产生的日志才会被下面的日志记录器记录,否则不会
    level="DEBUG" 表示我们的日志记录的级别是DEBUG,如果我们不指定level的时候,我们这个日志记录器对应的级别自动继承根记录器
    additivity="true" 表示我们自定义的记录器日志输出
    -->
    <logger name="com.itc.order" level="DEBUG" additivity="true">
        <appender-ref ref="ROLLING"/>
    </logger>

    <!--根日志记录器,所有包下面的日志都会被记录-->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>

</configuration>

6、过滤某个级别的日志

在对应的appender标签中添加以下filter

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>INFO</level>
</filter>

7、补充,日志拆分,通过时间或大小

image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容