logback.xml详解

阿伟在奔跑

已于 2024-12-26 20:23:01 修改

阅读量1.2k

点赞数 18

CC 4.0 BY-SA版权

分类专栏： java交流区文章标签： logback xml

于 2024-12-26 20:07:19 首次发布

本文链接：https://blog.csdn.net/qq_44672668/article/details/144751399

java交流区专栏收录该内容

8 篇文章

订阅专栏

一、总览

在这里插入图片描述

<?xml version="1.0" encoding="UTF-8" ?>
<!-- configuration 是根节点  -->
<!-- scan="true" 配置文件如果发生改变，将会重新加载，默认是true  -->
<!-- scanPeriod="60 second" 重新加载间隔时间，scan=true 时生效，没给时间单位的话，默认是毫秒  -->
<!-- debug="true" 将打印logback的内部日志信息，实时查看logback的运行状态，默认是false  -->
<configuration scan="true" scanPeriod="60 second" debug="true" >
<!-- 日志内容包括 [日志级别][时间戳][日志流水号][交易码][全局流水号][请求渠道][请求系统流水号][交易请求时间][交易响应时间][交易处理时长][交易返回码][交易返回信息] -->
	<!-- 系统名称 -->
    <!-- 定义变量，下方可以通过${serverName} -->
	<property name="serverName" value="lwService" scope="context" />
	<!-- 日志根目录 -->
	<property name="logHome" value="/home/lw/logs" scope="context" />

	<!-- 控制台输出日志 -->
    <!-- appender 定义日志的输出目标 -->
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<layout class="ch.qos.logback.classic.PatternLayout">
			<!--输出的格式，%d代表时间，也可以限定格式%d{{yyyy-MM-dd HH:mm:ss:SSS}} -->
            <!--%thread 执行的线程 -->
            <!--TRANS_SEQ 可以在代码中通过MDC.put() -->
            <!-- %-5level 日志级别 -->
            <!-- %c:%L %c 输出完整的类名-->
			<!-- %L 输入日志时间发生的位置，例如 SomeClass.java.20 精准度指出这是哪个类哪个方法哪一行输出的日志。-->
            <!-- %logger{80} logger名字最长字符，否则按照句点分割，从后往前取用 -->
            <!-- %msg%n %msg%打印你输出的信息，n是代表 -->
			<pattern>[%d] [%thread] [%X{TRANS_SEQ}] [%X{TRANS_CODE}] %-5level %c:%L -%msg%n</pattern>
		</layout>
	</appender>
	
	<appender name="TRANS_LOG" class="ch.qos.logback.classic.sift.SiftingAppender">
		<discriminator>
			<Key>TRANS_LOG</Key>
			<DefaultValue>normal</DefaultValue>
		</discriminator>
		<sift>
			<appender name="TRANS_LOG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
				<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
					<fileNamePattern>${logHome}/${serverName}/%d{yyyy-MM-dd}/TRANS_LOG/${serverName}.%i.log</fileNamePattern>
					<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
						<maxFileSize>100MB</maxFileSize>
					</timeBasedFileNamingAndTriggeringPolicy>
					<maxHistory>10</maxHistory>
					<totalSizeCap>10GB</totalSizeCap>
				</rollingPolicy>
                <!--  -->
				<encoder>
					<pattern>[%d] [%thread] [%X{TRANS_SEQ}] [%X{TRANS_CODE}] %-5level %c:%L -%replace(%msg){'^(.{10000}).*$','$1'}%n</pattern>
					<charset>UTF-8</charset>
				</encoder>
			</appender>
		</sift>
	</appender>
	
	<!-- 错误及警告日志 -->
	<appender name="ERROR_WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>WARN</level>
		</filter>
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 生成日志规则 -->
            <!-- %i自动递增 -->
			<fileNamePattern>${logHome}/${serverName}/%d{yyyy-MM-dd}/ERROR_WARN/error_warn.%i.log</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 单个文件大小  -->
				<maxFileSize>100MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy>
            <!-- 保留最大天数 -->
			<maxHistory>10</maxHistory>
            <!-- 文件总大小 -->
			<totalSizeCap>5GB</totalSizeCap>
		</rollingPolicy>
		<encoder>
			<pattern>[%d] [%thread] [%X{TRANS_SEQ}] [%X{TRANS_CODE}] %-5level %c:%L -%replace(%msg){'^(.{10000}).*$','$1'}%n</pattern>
			<charset>UTF-8</charset>
		</encoder>
	</appender>

	<!-- 以最低的日志级别为准 -->
	<root level="INFO">
		<appender-ref ref="TRANS_LOG"/>
		<appender-ref ref="ERROR_WARN"/>
	</root>

</configuration>

2、常用规则

日志内容包括 [日志级别][时间戳][日志流水号][交易码][全局流水号][请求渠道][请求系统流水号][交易请求时间][交易响应时间][交易处理时长][交易返回码][交易返回信息]

二、节点介绍

1、根节点 configuration

<configuration scan="true" scanPeriod="60 second" debug="true" >
    
</configuration> 
<!-- scan="true" 配置文件如果发生改变，将会重新加载，默认是true  -->
<!-- scanPeriod="60 second" 重新加载间隔时间，scan=true 时生效，没给时间单位的话，默认是毫秒  -->
<!-- debug="true" 将打印logback的内部日志信息，实时查看logback的运行状态，默认是false  -->

2、appender节点

appender是configuration的子节点

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
</appender>

<!-- name 指定appender的名称  -->
<!-- class 指定appender的全限定名  -->
<!--class 可选 -->
<!--class="ch.qos.logback.core.ConsoleAppender" 日志输出到控制台 -->
<!--class="ch.qos.logback.core.FileAppender" 日志添加到文件（静态文件） -->
<!--class="ch.qos.logback.core.rolling.RollingFileAppender" 动态文件 -->
<!--class="ch.qos.logback.classic.sift.SiftingAppender" 内部有同步关键字，容易日志阻塞。 -->

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
    	<pattern></pattern>
    </encoder>
</appender>


<appender name="STDOUT" class="ch.qos.logback.core.FileAppender">
    <file>test.log</file>
    <append>true</append>
    <encoder>
    	<pattern></pattern>
    </encoder>
</appender>

<appender name="STDOUT" class="ch.qos.logback.core.RollingFileAppender">
    <file>test.log</file>
    <append>true</append>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>${logHome}/${serverName}/%d{yyyy-MM-dd}/error.%i.log</fileNamePattern>
         <!-- 保留最大天数 -->
        <maxHistory>10</maxHistory>
        <!-- 文件总大小 -->
        <totalSizeCap>5GB</totalSizeCap>
        <!-- 单个文件大小  -->
        <maxFileSize>100MB</maxFileSize>
    </rollingPolicy>
    <encoder>
    	<pattern></pattern>
    </encoder>
</appender>

2.1 file 节点

被写入的文件名称，可以是相对目录，也可以是绝对目录，如果上级不存在，自动创建，没有默认值

<file>test.log</file>

2.2 append节点

如果是true，日志追加到文件结尾，如果是false，清空现存文件，默认是true。

<append>true</append>

2.3 encoder节点

对记录事件进行格式化

 <encoder>
     <pattern></pattern>
</encoder>

2.3.1 pattern 节点

<pattern>[%d] [%thread] [%X{TRANS_SEQ}] [%X{TRANS_CODE}] %-5level %c:%L -%msg%n</pattern>

%是格式化指令的开始标志

‘-’ 横杠标识左对齐

5是指定宽度为5个字符长度

level 代表日志级别
%-5level 表示，如果此时日志级别是DEBUG 则打印是左对齐显示“DEBUG”，如果是WARN，则显示是“WARN ” 多出一个空格来占满5个字符。视觉上更加整齐。

%c 输出完整的类名
%L 输入日志时间发生的位置，例如 SomeClass.java.20 精准度指出这是哪个类哪个方法哪一行输出的日志。
%i：当文件大小超过maxFileSize时，按照i进行文件滚动

2.3.2 charset

<charset>UTF-8</charset>

2.4 rollingPolicy节点

 <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
 
 </rollingPolicy>

class 可以选择的滚动策略
class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy" 基于大小和时间的滚动策略
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"   最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责发出滚动
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 基于固定窗口的滚动策略
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy" 大小触发

2.4.1 fileNamePattern 节点

定义文件输出的路径及名称，名称必须包含%i，便于产生归档文件，还可以指定文件压缩选项，例如mytest%i.log.gz或mytest%i.log.zip

归档的选择是根据fileNamePattern里面%d来决定的，%d{}后面的日期精确的单位就是maxHistory 的单位，当fileNamePattern中出现多个%d时，以第一个为准。

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    <fileNamePattern>${logHome}/${serverName}/%d{yyyy-MM-dd}/error.%i.log</fileNamePattern>
</rollingPolicy>

2.4.2 maxHistory

保留的最大天数，单位由%d格式的时间决定，例如%d{yyyy-MM-dd} ，这里精确到天，那就是10天。

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    <maxHistory>10</maxHistory>
</rollingPolicy>

2.4.3 maxFileSize

单个文件大小

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    <maxFileSize>100MB</maxFileSize>
</rollingPolicy>

2.4.4 totalSizeCap

文件累计的总大小

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    <totalSizeCap>5GB</totalSizeCap>
</rollingPolicy>

2.4.5 timeBasedFileNamingAndTriggeringPolicy

<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    <!-- 单个文件大小  -->
    <maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>

2.5 filter

<filter class="ch.qos.logback.classic.filter.LevelFilter">
    <!--过滤器,只打ERROR级别的日志 -->
    <level>ERROR</level>
    <!--配置符合过滤条件的操作 -->
    <onMatch>ACCEPT</onMatch>
    <!--配置不合符过滤条件的操作 -->
    <onMismatch>DENY</onMismatch>
</filter>

class 有两种过滤
class="ch.qos.logback.classic.filter.LevelFilter" 增加过滤器，空值日志过滤级别,只输出你空值的这个级别以上的级别的日志。
class="ch.qos.logback.classic.filter.ThresholdFilter" 临界值过滤，过滤掉低于临界值的日志

3、logger节点

logger是configuration的子节点，

name指定受次logger约束的某一个包或具体的某一个类。

level 用来设置打印级别，大小写无关，TRACE、DEBUG 、INFO 、WARN、 ERROR 、ALL

<logger name="org.apache.coyote.http.HttpInputBuffer" level="ERROR"/>

4、root节点

root是configuration的子节点，必选节点。

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

5、property节点

property是configuration的子节点，用来定义变量，

可以通过${}这种来获取，大括号里面是你定义name的字符串，例如：${serverName}
<property name="serverName" value="lwService" scope="context" />

6、contextName节点

contextName是configuration的子节点,用来设置上下文名称，默认上下文为default，用于区分不同应用程序记录。

<contextName>myapp<contextName/>

7、timestamp

获取时间轴字符串

<timestamp key="DATETIME" datePattern="yyyy-MM-dd HH:mm:ss" />

key定义标识的名称

datePattern 指定时间格式