logback各标签详解

最新推荐文章于 2024-01-26 16:12:04 发布

高级泥瓦匠

最新推荐文章于 2024-01-26 16:12:04 发布

阅读量3.2k

点赞数 1

分类专栏： JAVA springboot 文章标签： java

本文链接：https://blog.csdn.net/sihuanghou/article/details/123687512

版权

springboot 同时被 2 个专栏收录

4 篇文章 0 订阅

订阅专栏

JAVA

2 篇文章 0 订阅

订阅专栏

常用配置

logback的配置文件默认为logback.xml，如果配置文件不存在 logback 默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。Logback 配置文件的语法非常灵活，基本结构包括：作为顶级标签，在此标签内配置字标签，字标签包含零个或多个标签，零个或多个标签，有最多一个标签。

根标签 <configuration>

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

<configuration scan="true" scanPeriod="10 seconds" debug="false"> 
　　  <!--子标签配置--> 
</configuration>

子标签 <contextName>

用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

<contextName>AppName</contextName>

子标签 <property>

用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。

<property name="LOG_HOME" value="/var/log/test/" />

子标签 <timestamp>

用于获取时间戳，包含两个属性key：表示时间戳的名称和datePattern：时间戳的格式

<timestamp key="myTime" datePattern="yyyyMMdd HHmmss"/>

子标签 <appender>

负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名，logback已经为我们定义好了标准的appender，包括写控制台的ConsoleAppender，写文件的FileAppender，可回滚的RollingFileAppender
1、ConsoleAppender：把日志输出到控制台，有以下子标签：
<encoder>：对日志进行格式化。
<target>：字符串System.out(默认)或者System.err

2、FileAppender：把日志添加到文件，有以下子节点：
　<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　<encoder>：对记录事件进行格式化。
　<prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

3、RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
　<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　<rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类
class=“ch.qos.logback.core.rolling.TimeBasedRollingPolicy”：最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
<fileNamePattern>：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<maxHistory>:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
class=“ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”：查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
<maxFileSize>:这是活动文件的大小，默认值是10MB。
<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
<triggeringPolicy>: 告知 RollingFileAppender 合适激活滚动。
class=“ch.qos.logback.core.rolling.FixedWindowRollingPolicy” 根据固定窗口算法重命名文件的滚动策略。有以下子节点：
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
<fileNamePattern>:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项.

样例

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">

        <logger name="org.springframework.web" level="INFO" />
        <property name="LOG_HOME" value="/var/log/test/" />
        <springProperty scope="context" name="LOG_NAME" source="spring.application.name" />

        <!-- 控制台输出 -->
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
                <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                        <!--格式化输出：%d：日期，%-4relative：程序启动到创建日志记录的时间，毫秒， %-5level：日志级别，%thread：线程名，%msg：日志消息，%line：行号，%n：换行符 -->
                        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-4relative %-5level [%thread - - - - -][traceId-%X{traceId:-}] %logger{50} >>
                                %msg:%line%n</pattern>
                        <charset>UTF-8</charset>
                </encoder>
        </appender>

        <!-- 按照每天生成日志文件 -->
        <appender name="FILE"
                class="ch.qos.logback.core.rolling.RollingFileAppender">
                <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                        <level>INFO</level>
                </filter>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                        <!--日志文件输出的文件名 -->
                        <FileNamePattern>${LOG_HOME}/${LOG_NAME}/INFO/${LOG_NAME}-info.%d{yyyy-MM-dd}.log
                        </FileNamePattern>
                        <!--日志文件保留天数 -->
                        <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                        <!--格式化输出：%d：日期，%-4relative：程序启动到创建日志记录的时间，毫秒， %-5level：日志级别，%thread：线程名，%msg：日志消息，%line：行号，%n：换行符 -->
                        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-4relative %-5level [%thread - - - - -][traceId-%X{traceId:-}] %logger{50} >>
                                %msg:%line%n</pattern>
                        <charset>UTF-8</charset>
                </encoder>
        </appender>

        <!-- 按照每天生成日志文件 -->
        <appender name="FILE_ERROR"
                class="ch.qos.logback.core.rolling.RollingFileAppender">
                <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                        <level>ERROR</level>
                </filter>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                        <!--日志文件输出的文件名 -->
                        <FileNamePattern>${LOG_HOME}/${LOG_NAME}/ERROR/${LOG_NAME}-error.%d{yyyy-MM-dd}.log
                        </FileNamePattern>
                        <!--日志文件保留天数 -->
                        <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                        <!--格式化输出：%d：日期，%-4relative：程序启动到创建日志记录的时间，毫秒， %-5level：日志级别，%thread：线程名，%msg：日志消息，%line：行号，%n：换行符 -->
                        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-4relative %-5level [%thread - - - - -][traceId-%X{traceId:-}] %logger{50} >>
                                %msg:%line%n</pattern>
                        <charset>UTF-8</charset>
                </encoder>
        </appender>

        <!-- 按照每天生成日志文件 -->
        <appender name="FILE_ERROR"
                class="ch.qos.logback.core.rolling.RollingFileAppender">
                <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                        <level>ERROR</level>
                </filter>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                        <!--日志文件输出的文件名 -->
                        <FileNamePattern>${LOG_HOME}/${LOG_NAME}/ERROR/${LOG_NAME}-error.%d{yyyy-MM-dd}.log
                        </FileNamePattern>
                        <!--日志文件保留天数 -->
                        <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                        <!--格式化输出：%d：日期，%-4relative：程序启动到创建日志记录的时间，毫秒， %-5level：日志级别，%thread：线程名，%msg：日志消息，%line：行号，%n：换行符 -->
                        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-4relative %-5level [%thread - - - - -] %logger{50} >>
                                %msg:%line%n</pattern>
                        <charset>UTF-8</charset>
                </encoder>
                <!--日志文件最大的大小 -->
                <!-- <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                        <MaxFileSize>10MB</MaxFileSize> </triggeringPolicy> -->
        </appender>

        <!-- additivity="false"，不向上冒泡 -->
        <logger name="com.chinamobile.test" level="DEBUG" additivity="true">
                <appender-ref ref="FILE_ERROR" />
        </logger>

        <!-- 日志输出级别 -->
        <root level="INFO">
			<appender-ref ref="FILE" />
                <appender-ref ref="STDOUT" />
        </root>

</configuration>