一、configuration
根节点:configuration,作为顶级标签, 可以用来配置一些lockback的全局属性,常见的属性如下:
(1)scan=“true” :scan是否开启自动扫描,监控配置文件更新,生效。
(2)scanPeriod=“60 seconds” :扫描的频率
(3)debug=“false”:是否开启logback的debug模式,注意这里和日志的debug无关,开启后启动之前会打印一些logback自身的信息。
二、property
1、作用:
property 标签可以定义一些属性变量,供其他配置地方通过${xxx}
使用。
springProperty 标签可以获取spring上下文里的属性。
三、conversionRule
1、作用:
定义转换器,可以用来对日志进行特殊的转换,比如,SpringBoot后启动项目控制台默认会带有彩色日志样式,是因为使用了org.springframework.boot.logging.logback.ColorConverter
颜色转换器,会把日志用AnsiOutput
进行输出。如果自定义了logback,会覆盖默认的配置。
conversionRule一般在property中引用
2、自定义conversionRule
demo:
import ch.qos.logback.classic.pattern.MessageConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;
public class LogabckMessageConverter extends MessageConverter {
@Override
public String convert(ILoggingEvent event) {
String msg = event.getMessage();
if ("ERROR".equals(event.getLevel().toString())) {
msg = "系统异常";
}
return msg;
}
}
<configuration>
<conversionRule conversionWord="mycon" converterClass="org.demo.annotation.convert.LogabckMessageConverter"/>
<!-- 格式化输出:%date表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->
<property name="LOG_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS}[%t][%highlight(%p)][%green(%c).%M:%yellow(%L)] %ex{3}- %mycon %n"/>
<!-- 定义日志存储的路径,不要配置相对路径 -->
<property name="FILE_PATH" value="usr/logs/demo.%d{yyyy-MM-dd}.%i.log" />
<!-- 控制台输出日志 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<!-- 按照上面配置的LOG_PATTERN来打印日志 -->
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
<!--每天生成一个日志文件,保存15天的日志文件。rollingFile是用来切分文件的 -->
<appender name="FILE"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${FILE_PATH}</fileNamePattern>
<!-- keep 15 days' worth of history -->
<maxHistory>15</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 日志文件的最大大小,超过这个大小重新生成一个文件 -->
<maxFileSize>1MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
<!-- project default level -->
<logger name="src" level="INFO" />
<!-- 日志输出级别 常用的日志级别按照从高到低依次为:ERROR、WARN、INFO、DEBUG。 -->
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</configuration>
测试:
@RequestMapping("/test")
public String test(@Valid ParamDTO paramDTO) {
log.info("paramDTO:{}", paramDTO);
log.error ("出错了paramDTO:{}", paramDTO);
return codes;
}
查看控制台打印:
四、appender
1、作用:
<appender>是<configuration>的子节点,是负责写日志的组件。Appender是logback中的最核心组件之一,写日志渠道包括:控制台、日志文件、网络输出等。<appender>有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
2、结构
借用一张官方的继承体系图:
途中可以看出常用的appender有三个:
2.1、ConsoleAppender
日志写入到控制台,底层会调用jdk的 System.out
和 System.err。
有以下子节点:
<encoder> : 对日志进行格式化。
<target> : 字符串 System.out 或者 System.err ,默认 System.out ;
<appender name="CONSOLE_OUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- 表示打印到控制台 -->
<appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
<!-- encoder 默认配置为PatternLayoutEncoder -->
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
<target>System.err</target>
</appender>
2.2、FileAppender
日志写入到指定文件,有以下子节点:
<file> : 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append> : 如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder> : 对记录事件进行格式化。
<prudent> : 如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
immediateFlush:默认情况下true,每个日志事件都会立即刷新到文件输出流中。这种方法更安全,因为如果应用程序退出时没有正确关闭appender,则不会丢失日志记录事件。但是,想显著提高日志的吞吐量,可以将 limateFlush 属性设置为 false。
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>testFile.log</file>
<append>true</append>
<immediateFlush>true</immediateFlush>
<encoder>
<pattern>${FILE_LOG_PATTERN}</pattern>
</encoder>
</appender>
2.3、RollingFileAppender
实际生产环境写文件日志的首选appender,可以实现滚动式写日志,在写日志的过程中如果符合某些条件策略时,会重新写入到新的文件,还可以将历史日志进行归档、定期删除等。解决了FileAppender方式会导致日志都在一个文件中,文件会越来越大,难以打开。常用属性配置:
<file>
被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append>
如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder> : 对记录事件进行格式化。
<rollingPolicy>
当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。常见的有:
① TimeBasedRollingPolicy
常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责触发滚动。有以下子节点:
<fileNamePattern> : 必要节点,包含文件名及“%d”转换符, “%d”可以包含一个Java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。如果直接使用 %d,默认格式是 yyyy-MM-dd。
RollingFileAppender 的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<maxHistory> : 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且<maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。
② FixedWindowRollingPolicy : 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
<minIndex> : 窗口索引最小值。
<maxIndex> : 窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
<fileNamePattern > : 必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip。
<triggeringPolicy>
告知 RollingFileAppender 何时激活滚动。
<prudent> : 当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1、不支持也不允许文件压缩,2、不能设置file属性,必须留空。
<appender name="FILE_OUT" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${FILE_LOG_PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<file>${LOG_FILE}</file>
<!-- 滚动日志策略: SizeAndTimeBasedRollingPolicy 根据文件大小和时间进行分割归档-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 指定滚动文件名称的生成规则 -->
<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
<!-- 超过最大磁盘限制后是否删除归档文件 -->
<cleanHistoryOnStart>true</cleanHistoryOnStart>
<!-- 单个日志文件大小 -->
<maxFileSize>20MB</maxFileSize>
<!-- 归档文件占用磁盘总大小,超过后会根据cleanHistoryOnStart实行,决定是否删除 -->
<totalSizeCap>1GB</totalSizeCap>
<!-- 保留的历史归档日志文件个数 -->
<maxHistory>10</maxHistory>
</rollingPolicy>
</appender>
2.4、AsyncAppender
异步写日志,本身不做真是的日志写入,需要配置包裹其它appender,在于高并发下,加如日志队列缓存,减少写磁盘日志的IO次数。可以根据实际情况决定是否使用 。
2.5、不常用的appender
SocketAppender 写入socket、SMTPAppender 写入邮件、DBAppender 写入数据库
五、encoder
1、作用
节点<appender>的子节点<encoder>,<encoder> 负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。
Encoder在0.9.19中引入,作用负责将日志事件转换为字节数组,并将字节数组输出到输出流中(具体的appender输出流)。在此之前的版本主要使用Layout,Layout只能将日志事件转换为String。Layout还无法控制何时写出日志,因此Layout无法对日志事件进行批量控制,相比之下,Encoder不仅可以完全控制写出的字节的格式,而且还可以控制何时(以及是否)写出这些字节内容。
目前PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个<pattern>节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“\%”进行转义。
最常用的编码器,通常指定:编码和日志打印规则
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } [%15.15t] %-40.40logger{39} %-4line : %m%n%wEx</pattern>
<charset>UTF-8</charset>
</encoder>
<pattern>里面的转换符说明: ‘
转换符 | 作用 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
c {length } lo {length } logger {length } | 输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。
| ||||||||||||||||||||||||
C {length } class {length } | 输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。 | ||||||||||||||||||||||||
contextName cn | 输出上下文名称。 | ||||||||||||||||||||||||
d {pattern } date {pattern } | 输出日志的打印日志,模式语法与java.text.SimpleDateFormat 兼容。
| ||||||||||||||||||||||||
F 或 file | 输出执行记录请求的java源文件名。尽量避免使用,除非执行速度不造成任何问题。 | ||||||||||||||||||||||||
caller{depth}caller{depth, evaluator-1, ... evaluator-n} | 输出生成日志的调用者的位置信息,整数选项表示输出信息深度。 例如, %caller{2} 输出为: 0 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17) 例如, %caller{3} 输出为: 16 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17) Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38) | ||||||||||||||||||||||||
L 或 line | 输出执行日志请求的行号。尽量避免使用,除非执行速度不造成任何问题。 | ||||||||||||||||||||||||
m 或msg 或 message | 输出应用程序提供的信息。 | ||||||||||||||||||||||||
M 或者method | 输出执行日志请求的方法名。尽量避免使用,除非执行速度不造成任何问题。 | ||||||||||||||||||||||||
n | 输出平台先关的分行符“\n”或者“\r\n”。 | ||||||||||||||||||||||||
p 或者 le 或者 level | 输出日志级别。 | ||||||||||||||||||||||||
r 或者 relative | 输出从程序启动到创建日志记录的时间,单位是毫秒 | ||||||||||||||||||||||||
t 或者thread | 输出产生日志的线程名。 | ||||||||||||||||||||||||
replace(p ){r, t} | p 为日志内容,r 是正则表达式,将p 中符合r 的内容替换为t 。 例如, "%replace(%msg){'\s', ''}" |
格式修饰符,与转换符共同使用:
可选的格式修饰符位于“%”和转换符之间。
第一个可选修饰符是左对齐 标志,符号是减号“-”;接着是可选的最小宽度 修饰符,用十进制数表示。如果字符小于最小宽度,则左填充或右填充,默认是左填充(即右对齐),填充符为空格。如果字符大于最小宽度,字符永远不会被截断。最大宽度 修饰符,符号是点号"."后面加十进制数。如果字符大于最大宽度,则从前面截断。点符号“.”后面加减号“-”在加数字,表示从尾部截断。
例如:%-4relative 表示,将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。
六、Layout
layout根据pattern规则,将日志事件转换为具体的日志字符串,我们配置的各种日志打印格式,都是由layout解析翻译成字符串。由于官方规则太多,我们以一个具体的例介绍一些常用的规则符号:
七、Filters
1、作用
过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL,有序列表里的下个过滤器过接着处理日志;返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。
过滤器被添加到<appender> 中,为<appender> 添加一个或多个过滤器后,可以用任意条件对日志进行过滤。<appender> 有多个过滤器时,按照配置顺序执行。
2、常用的过滤器
(1)LevelFilter
级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据 onMath 和 onMismatch 接收或拒绝日志。
有以下子节点 :
<level> : 设置过滤级别。
<onMatch> : 用于配置符合过滤条件的操作。
<onMismatch> : 用于配置不符合过滤条件的操作。
例如:将过滤器的日志级别配置为info,所有info级别的日志交给appender处理,非info级别的日志,被过滤掉。
(2)ThresholdFilter
临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。
有以下子节点 :
<level> : 设置过滤级别。
例如:过滤掉所有低于info级别的日志。
(3)EvaluatorFilter
求值过滤器,评估、鉴别日志是否符合指定条件。
有以下子节点:
<evaluator> : 鉴别器,常用的鉴别器是JaninoEventEvaluato,也是默认的鉴别器,它以任意的Java布尔值表达式作为求值条件,求值条件在配置文件解释过成功被动态编译,布尔值表达式返回true就表示符合过滤条件。
evaluator有个子标签<expression>,用于配置求值条件。
求值表达式作用于当前日志,logback向求值表达式暴露日志的各种字段:
Name | Type | Description |
---|---|---|
event | LoggingEvent | 与记录请求相关联的原始记录事件,下面所有变量都来自event,例如,event.getMessage()返回下面"message"相同的字符串 |
message | String | 日志的原始消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello {}"就是原始消息。 |
formatedMessage | String | 日志被各式化的消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello Aub"就是格式化后的消息。 |
logger | String | logger 名。 |
loggerContext | LoggerContextVO | 日志所属的logger上下文。 |
level | int | 级别对应的整数值,所以 level > INFO 是正确的表达式。 |
timeStamp | long | 创建日志的时间戳。 |
marker | Marker | 与日志请求相关联的Marker对象,注意“Marker”有可能为null,所以你要确保它不能是null。 |
mdc | Map | 包含创建日志期间的MDC所有值得map。访问方法是:mdc.get("myKey") 。mdc.get()返回的是Object不是String,要想调用String的方法就要强转,例如,
|
throwable | java.lang.Throwable | 如果没有异常与日志关联"throwable" 变量为 null. 不幸的是, "throwable" 不能被序列化。在远程系统上永远为null,对于与位置无关的表达式请使用下面的变量throwableProxy |
throwableProxy | IThrowableProxy | 与日志事件关联的异常代理。如果没有异常与日志事件关联,则变量"throwableProxy" 为 null. 当异常被关联到日志事件时,"throwableProxy" 在远程系统上不会为null |
<onMatch>:用于配置符合过滤条件的操作
<onMismatch>:用于配置不符合过滤条件的操作
例如:过滤掉所有日志消息中不包含“billing”字符串的日志。
<matcher> :
匹配器,尽管可以使用String类的matches()方法进行模式匹配,但会导致每次调用过滤器时都会创建一个新的Pattern对象,为了消除这种开销,可以预定义一个或多个matcher对象,定以后就可以在求值表达式中重复引用。<matcher>是<evaluator>的子标签。
<matcher>中包含两个子标签,一个是<name>,用于定义matcher的名字,求值表达式中使用这个名字来引用matcher;另一个是<regex>,用于配置匹配条件。
filter 日志过滤器,
logback 的内置 filter 有一下几种:
级别过滤器 ch.qos.logback.classic.filter.LevelFilter。对指定级别的日志进行具体的操作
阀值过滤器 ch.qos.logback.classic.filter.ThresholdFilter。
表达式过滤器 ch.qos.logback.core.filter.EvaluatorFilter。
Groovy的表达式 ch.qos.logback.classic.boolex.GEventEvaluator。
Java的表达式ch.qos.logback.classic.boolex.JaninoEventEvaluator。使用 Janino 解析java script。
包含标记 ch.qos.logback.classic.boolex.OnMarkerEvaluator
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 过滤的级别 -->
<level>INFO</level>
<!-- 匹配时的操作:接收(记录) -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配时的操作:拒绝(不记录) -->
<onMismatch>DENY</onMismatch>
</filter>
八、root
<root level="WARN">
<appender-ref ref="FILE"/>
<appender-ref ref="ERROR"/>
<if condition='property("env").contains("local")'>
<then>
<!-- this only enable in local -->
<appender-ref ref="CONSOLE"/>
</then>
</if>
</root>
1、定义日志文件的存储地址
<!-- 应用名称 -->
<property name="APP_NAME" value="log-test"/>
<!--定义日志文件的存储地址-->
<property name="LOG_HOME" value="/logs/${APP_NAME}"/>
2、定义日志格式
(1)普通格式
<!-- 定义日志格式 -->
<property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] [%-30.30logger{30}] %msg%n"/>
参数 | 含义 |
---|---|
%d | 表示日期(也可以使用"%date") |
%-5level | 表示级别从左显示5个字符宽度 |
%thread | 表示线程名称 |
%-30.30logger{30} | 表示如果logger的名称小于30,就“-”指定左对齐;如果其名称长于30字符,就从左边较远输出的字符截掉,保持logger的名字长度最终限制为30个字符 |
%msg | 表示日志消息 |
%n | 表示换行符 |
(2)高亮
<!-- 高亮日志格式 -->
<property name="HIGHLIGHT_PATTERN" value="%yellow(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%thread] %highlight(%-5level) %green(%logger{50}) - %highlight(%msg) %n"/>
参数 | 含义 |
---|---|
%yellow()%green(%highlight() | 颜色高亮 |
%d | 表示日期(也可以使用"%date") |
%-5level | 表示级别从左显示5个字符宽度 |
%thread | 表示线程名称 |
%-30.30logger{30} | 表示如果logger的名称小于30,就“-”指定左对齐;如果其名称长于30字符,就从左边较远输出的字符截掉,保持logger的名字长度最终限制为30个字符 |
%msg | 表示日志消息 |
%n | 表示换行符 |
3、定义日志的输出级别
<!-- 日志输出级别 -->
<logger name="org.springframework" level="INFO"/>
<logger name="com.wtyy.*" level="INFO"/>
<root level="INFO">
<appender-ref ref="CONSOLE-WITH-HIGHLIGHT"/>
<appender-ref ref="FILE"/>
</root>
(1) 标签:logger
仅有一个name属性,一个可选的level和一个可选的additivity属性
属性name: 用来指定受此logger约束的某一个包或者具体的某一个类。
属性level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。 如果未设置此属性,那么当前logger将会继承上级的级别
属性additivity: 是否向上级logger传递打印信息。默认是true。同一样,可以包含零个或多个元素,标识这个appender将会添加到这个logger
(2)标签:root
root也是logger元素,但是它是根loger并且只有一个level属性,可以包含零个或多个元素,标识这个appender将会添加到这个loger
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。
trace(跟踪):一般用来追踪详细的程序运行流,比如程序的运行过程中,运行到了哪一个方法,进入了哪一条分支。通过 trace程序的运行流程,可以判断程序是否按照期望的逻辑在运行
debug(调试 ):这类日志往往用在判断是否有出现bug的场景,且往往记录了代码运行的详细信息,比如方法调用传入的参数信息
info(消息):用来记录程序运行的一些关键信息,它不像trace那样记录程序运行的整个流程,也不像debug那样为了解决问题而记录详细的信息。info记录的是整个系统的运行信息,比如系统运行到了哪一个阶段,到达了哪一个状态
warn(警告):用来记录一些警告信息。警告信息表示,程序进入了一个特殊的状态,在该状态下程序可以继续运行,但是不建议让程序进入该状态,因为该状态可能导致结果出现问题
error(错误):用来记录运行时的错误信息,表示程序运行过程中出现了需要被解决的问题,往往是一些异常。使用error日志的时候,一般会将详细的异常出现的原因记录
日志优先级从高到低依次为trace、debug、info、warn、error。相对而言,打印的日志会越来越少。
4、定义控制台输出
<!-- 控制台输出-高亮 -->
<appender name="CONSOLE-WITH-HIGHLIGHT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${HIGHLIGHT_PATTERN}</pattern>
</encoder>
</appender>
标签 | 含义 |
---|---|
appender | 负责写日志的组件,它有两个必要属性name和class。name指定appender名称,class指定appender的全限定名 |
encoder | 对日志进行格式化 |
pattern | 用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“%”进行转义 |
5、 定义日志文件输出参数
<!--文件输出的格式设置 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false -->
<prudent>false</prudent>
<!-- 日志日常打印日志文件,生成日志示例:/logs/log-test/info.log -->
<file>${LOG_HOME}/info.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 压缩日志的路径和日志格式,示例:info-2023-05-26_21.log.zip,%d{yyyy-MM-dd}:表示文件名称包含日期,%i:表示当前是第几个压缩文件 -->
<fileNamePattern>${LOG_HOME}/info-%d{yyyy-MM-dd}_%i.log.zip</fileNamePattern>
<!-- 如果按天来回滚,则最大保存时间为7天,7天之前的都将被清理掉 -->
<maxHistory>7</maxHistory>
<!-- 日志总保存量为10GB,超过该日志总量的日志压缩包会被清除 -->
<totalSizeCap>10GB</totalSizeCap>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!--文件达到 最大100MB时会被压缩和切割 -->
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 文件输出的日志 的格式 -->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>