欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

spring boot logback日志打印 详解

程序员文章站 2022-05-22 09:41:33
...

通过借助logback将系统日志保存到日志文件中。如果spring boot添加了spring-boot-starter-web依赖,该依赖包含了spring-boot-starter-logging,然后默认使用logback来记录日志。
spring boot logback日志打印 详解
在项目的resources下新建logback配置文件logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>cacacai</contextName>
    <springProperty scope="context" name="springAppName" source="spring.application.name"/>
    <property name="log.path" value="log" />
    <property name="log.maxHistory" value="15" />
    <property name="log.colorPattern" value="%magenta(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %boldCyan([${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]) %yellow(%thread) %green(%logger) %msg%n"/>
    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5level [${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}] %thread %logger %msg%n"/>

    <!--输出到控制台-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.colorPattern}</pattern>
        </encoder>
    </appender>

    <!--输出到文件-->
    <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <MaxHistory>${log.maxHistory}</MaxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error/error.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <root level="debug">
        <appender-ref ref="console" />
    </root>

    <root level="info">
        <appender-ref ref="file_info" />
        <appender-ref ref="file_error" />
    </root>
</configuration>

logback配置文件大致结构如下所示:

<configuration>
   <property/>
   <appender/>
   <root/>
</configuration>

下面详细介绍下这些标签的作用,介绍完后,再回来看这个配置文件,你应该就能看懂它的含义了。

<configuration>

<configuration>为logback配置文件的根标签,该标签包含三个属性:

  1. scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
  2. scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
  3. debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

<property>

用来定义变量值的标签,有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使${}来使用变量。

`<springProperty scope="context" name="springAppName" source="spring.application.name"/>

这段配置用于引用Spring上下文的变量。通过这段配置,我们可以在logback配置文件中使用${springAppName}来引用配置文件application.yml里的spring.application.name配置值。

<property name="log.path" value="log/path" />

上面这段配置定义了log.path变量,用于指定日志文件存储路径。

<property name="log.maxHistory" value="15" />

上面这段配置定义了log.maxHistory变量,用于指定日志文件存储的天数,这里指定为15天。

 <property name="log.colorPattern" value="%magenta(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %boldCyan([${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]) %yellow(%thread) %green(%logger) %msg%n"/>

这段配置定义了彩色日志打印的格式。在logback配置文件中,我们可以使用%magenta()%boldCyan()等标识指定日志的颜色;%d{yyyy-MM-dd HH:mm:ss}用于格式化日志打印时间;%highlight(%-5level)配置了不同日志级别使用不同的颜色高亮显示;
%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}用于打印Spring Cloud Sleuth提供的TraceId和SpanId等信息,这配置信息用来追踪Zipkin Server请求链了。

 <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5level [${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}] %thread %logger %msg%n"/>

这段配置定义了普通日志打印格式,大体上和上面彩色日志配置差不多,却别就是去掉了颜色配置。

如果项目没有使用Spring Cloud Sleuth进行请求追踪,那么TraceId和SpanId打印出来都是空的,可以用下面这段配置来替代:

<property name="log.colorPattern" value="%magenta(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %yellow(%thread) %green(%logger) %msg%n"/>
<property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5level %thread %logger %msg%n"/>
<appender>

appender

用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。

<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>${log.colorPattern}</pattern>
    </encoder>
</appender>

上面这段配置用于指定日志输出到控制台,日志打印格式采用上面定义的彩色日志打印(IDEA控制台支持彩色日志输出),这样在开发的时候,控制台输出的日志会更为美观,易于分析问题。

<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>${log.path}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern>
        <MaxHistory>${log.maxHistory}</MaxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>${log.pattern}</pattern>
    </encoder>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>INFO</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>
<appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>${log.path}/error/error.%d{yyyy-MM-dd}.log</fileNamePattern>
    </rollingPolicy>
    <encoder>
        <pattern>${log.pattern}</pattern>
    </encoder>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>ERROR</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>

这两段配置用于指定日志输出到日志文件。其中,名称为file_info的appender指定了INFO级别的日志输出到log/info目录下,文件名称为info.日期.log,并且日志格式为普通格式,因为文件一般不支持彩色显示;名称为file_error的appender指定了ERROR级别的日志输出到log/error目录下,文件名称为error.日期.log,日志格式也为普通格式。

<root>

root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性,用来设置打印级别。如果在appender里制定了日志打印的级别,那么root指定的级别将会被覆盖。

启动项目之后
控制台输出
spring boot logback日志打印 详解
自动创建了目录
spring boot logback日志打印 详解

文章参考来源https://www.kancloud.cn/mrbird/spring-cloud/1263714