Springboot日志-logback
logback-spring.xml的配置项
共有一个父标签、两种属性、三个节点:
一个父标签：configuration
两种属性：contextName和property
三个节点：appender、root、logger
日志级别
日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出
一、一个父标签
- scan
当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true
- scanPeriod
设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
- debug
当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
二、两种属性 contextName和property
-
contextName
每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。
如果同时存在logback.xml和logback-spring.xml，或者同时存在logback.xml和自定义的配置文件，则会先加载logback.xml，再根据application配置加载指定配置文件，或加载logback-spring,xml。如果这两个配置文件的contextName不同，就会报错：
# logback.xml
logback
# logback.xml
logback
# application.properties
logging.config=classpath:logback-spring.xml
ERROR in ch.qos.logback.classic.joran.action.ContextNameAction - Failed to rename context [logback] as [logback_demo] java.lang.IllegalStateException: Context has been already given a name
-
property
用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。
例如使用定义上下文名称，然后在设置logger上下文时使用。
${APP_Name}
三、三个节点 appender、root、logger
-
append节点
appender的意思是追加器，在这里可以理解为一个日志的渲染器（或者说格式化日志输出）。比如渲染console日志为某种格式，渲染文件日志为另一种格式。
appender中有name和class两个属性，有rollingPolicy和encoder两个子节点。
name表示该渲染器的名字，class表示使用的输出策略，常见的有控制台输出策略和文件输出策略。
控制台输出appender
info
%-5p [%d][%mdc{mdc_accNo}] %C:%L - %m %n
UTF-8
标签用于定义日志框架的名称，这里使用的是logback。标签用于定义变量名和变量值，可以在后续的日志配置中使用${}来引用定义的变量。在本例中，定义了变量log.path的值为./fmsdconflog/nmys，表示日志文件的存储路径。标签用于定义日志输出的目标，可以是控制台、文件、数据库等。在本例中，定义了一个名为CONSOLE的appender，用于将日志输出到控制台。class属性指定了appender的实现类，这里使用的是ch.qos.logback.core.ConsoleAppender，表示将日志输出到控制台。标签用于过滤日志，只有符合条件的日志才会被输出。在本例中，使用了ThresholdFilter实现类，表示只输出大于或等于info级别的日志信息。标签表示日志级别，这里设置为info级别。标签用于设置日志格式，定义了输出日志时的具体格式，可以包含时间、线程、日志级别、类名、方法名、日志信息等。在本例中，使用了Pattern模式来定义日志输出格式，其中%-5p表示日志级别，%d表示时间，%mdc{mdc_accNo}表示MDC中名称为mdc_accNo的变量，%C表示输出日志的线程的类名，%L表示输出日志的线程的方法名，%m表示日志信息，%n表示换行符。标签用于设置字符集，这里设置为UTF-8，表示日志信息以UTF-8的编码方式输出。
文件输入appender
文件输出主要包括配置：以指定格式将日志输出到指定文件夹下的文件中，可以配置该文件的名称、最大大小、保存时间等。
${log.path}/log_debug.log
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
UTF-8
${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.log
100MB
30
20GB
debug
ACCEPT
DENY
${log.path}/log_error.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log 100MB 15 error ACCEPT DENY
标签表示日志输出目标，这里定义了一个名为ERROR_FILE的appender。class属性指定了appender的实现类，这里使用的是ch.qos.logback.core.rolling.RollingFileAppender，表示将日志输出到文件。标签指定了正在记录的日志文件的路径及文件名，${log.path}/log_error.log表示日志文件存储在${log.path}变量定义的路径下，文件名为log_error.log。标签用于设置输出日志的格式，与前面的例子类似，但是添加了时间格式化。标签用于设置日志滚动策略，按日期或按大小记录日志。在本例中使用的是按日期记录的策略TimeBasedRollingPolicy。标签指定了日志归档的文件名格式，${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log表示日志文件存储在${log.path}/error路径下，文件名格式为log-error-日期.序号.log。标签用于设置日志文件滚动触发策略，这里使用的是SizeAndTimeBasedFNATP，表示按时间和文件大小来触发滚动。标签设置单个日志文件的最大大小，这里设置为100MB。标签设置保留历史日志文件的天数，这里设置为15天。标签用于过滤日志，只有符合条件的日志才会被输出。在本例中，使用了LevelFilter实现类，表示只输出error级别的日志信息。标签表示日志级别，这里设置为error级别。和标签用于匹配过滤条件时的行为，ACCEPT表示接受，即输出符合条件的日志信息，DENY表示拒绝，即不输出符合条件的日志信息。
root
root节点实际上是配置启动哪种appender，可以添加多个appender
logger和root的关系
- root和logger是父子的关系
logger的appender根据参数additivity决定是否要叠加root的appender，logger的级别是其自身定义的级别，和root的级别没什么关系。
- logger对单个包或类添加配置，相当于局部配置，root相当于全局配置
如果logger里面配置了additivity=“false”，就会覆盖root的，只打印一遍；但是additivity=“true”，就会向上层再次传递，不会覆盖，而是打印两遍！
举例说明：
测试方法：
package com.pikaiqu.logbackdemo;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;@SpringBootTest
class LogbackdemoApplicationTests {
private static Logger log = LoggerFactory.getLogger(LogbackdemoApplicationTests.class);
@Test
void logTest() {
log.trace("======trace");
log.debug("======debug");
log.info("======info");
log.warn("======warn");
log.error("======error");
}
}
只配置root
logback_demo
${pattern-color}}
=================================输出结果============================================
2022-04-26 15:37:48.441 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:37:48.441 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:37:48.441 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
当执行测试方法时，root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；
- 配置root和logger，但logger不指定级别，不指定appender（指logger没有指定appender）
logback_demo
${pattern-color}}
=================================输出结果============================================
2022-04-26 15:39:09.351 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:39:09.351 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:39:09.351 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“INFO”；
没有设置addtivity，默认为true，将此loger的打印信息向上级（root）传递；
没有设置appender，此loger本身不打印任何信息。
将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。
当执行测试方法时，因为LogbackDemo 在包com.pikaiqu.logbackdemo中，所以首先执行，将级别为“INFO”及大于“INFO”的日志信息传递给root，本身并不打印；
root接到下级（即）传递的信息，交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；
配置root和多个logger，指定级别，指定appender
logback_demo
${pattern-color}}
=================================输出结果============================================
2022-04-26 15:41:08.022 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:41:08.023 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“INFO”；
没有设置addtivity，默认为true，将此loger的打印信息向上级传递；
没有设置appender，此loger本身不打印任何信息。
控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印，打印级别为“INFO”；
additivity属性为false，表示此loger的打印信息不再向上级（即）传递，
使用指定了名字为“STDOUT”的appender。
将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。
当执行测试方法时，先执行，将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理，在控制台中打出日志，不再向该loger的上级 传递打印信息；
未接到任何打印信息，当然也不会给它的上级root传递任何打印信息；
如果设置，则结果如下：
logback_demo
${pattern-color}}
=================================输出结果============================================
2022-04-26 15:41:08.022 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:41:08.022 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:41:08.023 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:41:08.023 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“INFO”；
没有设置addtivity，默认为true，将此loger的打印信息向上级传递；
没有设置appender，此loger本身不打印任何信息。
控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印，打印级别为“INFO”；
additivity属性为false，表示此loger的打印信息会向上级（即）传递，
使用指定了名字为“STDOUT”的appender。
将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。
当执行测试方法时，先执行，将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理，在控制台中打出日志。
然后向该loger的上级 传递打印信息；由于没有设置appender，此loger本身不打印任何信息，而且没有设置addtivity，则默认为true，因此将此loger的打印信息向上级(root)传递。
root接到下级（即）传递的信息，交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台。
环境配置
完整的logback-spring.xml配置文件
logback
debug
${CONSOLE_LOG_PATTERN}
UTF-8
${log.path}/log_debug.log
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
UTF-8
${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.log
100MB
30
20GB
debug
ACCEPT
DENY
${log.path}/log_info.log
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
UTF-8
${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log
100MB
30
20GB
info
ACCEPT
DENY
${log.path}/log_warn.log
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
UTF-8
${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log
100MB
30
20GB
warn
ACCEPT
DENY
${log.path}/log_error.log
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
UTF-8
${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log
100MB
30
20GB
ERROR
ACCEPT
DENY