<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<!-- 定义日志的根目录 -->
<property name="LOG_HOME" value="F:\\日志存放\\manager" />
<!-- 定义日志文件名称 -->
<property name="debug" value="manager-codekiller-debug"></property>
<property name="info" value="manager-codekiller-info"></property>
<property name="error" value="manager-codekiller-error"></property>
<property name="warn" value="manager-codekiller-warn"></property>
<property name="job" value="manager-codekiller-job"></property>
<property name="fileName" value="logback"></property>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
%-15.15():如果记录的线程字符长度小于15(第一个)则用空格在右侧补齐,如果字符长度大于15(第二个),则从开头开始截断多余的字符
%-50.50():如果记录的logger字符长度小于50(第一个)则用空格在右侧补齐,如果字符长度大于50(第二个),则从开头开始截断多余的字符
%highlight():颜色,info为蓝色,warn为浅红,error为加粗红,debug为黑色
%boldMagenta:粗红
%magenta:洋红
$cyan:青色
%white:白色
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta([%-15.15(%thread)]) %cyan( %-50.50(%logger{50} )) : %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta([%-15.15(%thread)]) %cyan( %-50.50(%logger{50} )) : %msg%n</pattern>
</springProfile>
</layout>
</appender>
<!--控制台打印警告信息的单独处理-->
<appender name="consoleWarn" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%magenta(%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta([%-15.15(%thread)]) %cyan( %-50.50(%logger{50} )) : %msg%n)</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%magenta(%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta([%-15.15(%thread)]) %cyan( %-50.50(%logger{50} )) : %msg%n)</pattern>
</springProfile>
</layout>
</appender>
<!--控制台打印错误信息的单独处理-->
<appender name="consoleError" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%boldMagenta(%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta([%-15.15(%thread)]) %cyan( %-50.50(%logger{50} )) : %msg%n)</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%boldMagenta(%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta([%-15.15(%thread)]) %cyan( %-50.50(%logger{50} )) : %msg%n)</pattern>
</springProfile>
</layout>
</appender>
<!--debug日志存储-->
<appender name="debug" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日志文件的名称 -->
<file>${LOG_HOME}/${debug}/${fileName}.log</file>
<!--过滤,只存储DEBUG级别的日志-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<!--
当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动
%i:当文件大小超过maxFileSize时,按照i进行文件滚动
-->
<fileNamePattern>${LOG_HOME}/${debug}/${fileName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动,
且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是,
那些为了归档而创建的目录也会被删除。
-->
<MaxHistory>365</MaxHistory>
<!--
当日志文件超过maxFileSize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy
是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%-15.15(%thread)] %-50.50(%logger{50}) : %msg%n</pattern>
</layout>
</appender>
<!--info日志存储-->
<appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_HOME}/${info}/${fileName}.log</file>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${info}/${fileName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<MaxHistory>365</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%-15.15(%thread)] %-50.50(%logger{50}) : %msg%n</pattern>
</layout>
</appender>
<!--warn日志存储-->
<appender name="warn" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_HOME}/${warn}/${fileName}.log</file>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>WARN</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${warn}/${fileName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<MaxHistory>365</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%-15.15(%thread)] %-50.50(%logger{50}) : %msg%n</pattern>
</layout>
</appender>
<!--error日志存储-->
<appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_HOME}/${error}/${fileName}.log</file>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${error}/${fileName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<MaxHistory>365</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%-15.15(%thread)] %-50.50(%logger{50}) : %msg%n</pattern>
</layout>
</appender>
<!--job日志存储-->
<appender name="job" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日志文件的名称 -->
<file>${LOG_HOME}/${job}/${fileName}.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${job}/${fileName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<MaxHistory>365</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%-15.15(%thread)] %-50.50(%logger{50}) : %msg%n</pattern>
</layout>
</appender>
<!--
logger主要用于存放日志对象,也可以定义日志类型、级别,并且会先执行。
name:表示匹配的logger类型前缀,也就是包的前半部分
level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出,即是否将信息提交给root
false:表示只用当前logger的appender-ref,
true:表示当前logger的appender-ref和rootLogger的appender-ref都有效
-->
<!--job包的单独输出-->
<logger name="top.codekiller.manager.examination.job" level="debug" additivity="false">
<appender-ref ref="job"></appender-ref>
<appender-ref ref="console"></appender-ref>
</logger>
<!--mapper包的单独输出(输出sql信息,至关重要)-->
<logger name="top.codekiller.manager.examination.mapper" level="debug" additivity="false">
<appender-ref ref="console"></appender-ref>
</logger>
<!--debug的单独输出-->
<logger name="top.codekiller.manager.examination" level="debug" additivity="false">
<appender-ref ref="console"/>
<appender-ref ref="debug" />
</logger>
<!--warn的单独输出-->
<logger name="top.codekiller.manager.examination" level="warn" additivity="false">
<appender-ref ref="consoleWarn"/>
<appender-ref ref="warn" />
</logger>
<!--error的单独输出-->
<logger name="top.codekiller.manager.examination" level="error" additivity="false">
<appender-ref ref="consoleError"/>
<appender-ref ref="error"/>
</logger>
<!--
root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,
要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="console"/>
<appender-ref ref="debug" />
<appender-ref ref="info" />
<appender-ref ref="warn" />
<appender-ref ref="error" />
</root>
</configuration>
Logback配置文件详解
Logback,Java 日志框架。
Logback 如何加载配置的
- logback 首先会查找 logback.groovy 文件
- 当没有找到,继续试着查找 logback-test.xml 文件
- 当没有找到时,继续试着查找 logback.xml 文件
- 如果仍然没有找到,则使用默认配置(打印到控制台)
configuration
configuration 是配置文件的根节点,他包含的属性:
• scan
当此属性设置为 true 时,配置文件如果发生改变,将会被重新加载,默认值为 true
• scanPeriod
设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。但 scan 为 true 时,此属性生效,默认的时间间隔为 1 分钟
• debug
当此属性设置为 true 时,将打印出 logback 内部日志信息,实时查看 logback 运行状态,默认值为 false。
1. <configuration scan="true" scanPeriod="60 seconds" debug="false">
2. <!-- 其他配置省略-->
3. </configuration>
configuration 的子节点
设置上下文名称:contextName
每个 logger 度关联到 logger 上下文,默认上下文名称为 “default”。可以通过设置 contextName 修改上下文名称,用于区分不同应该程序的记录
1. <configuration scan="true" scanPeriod="60 seconds" debug="false">
2. <contextName>myAppName</contextName>
3. <!-- 其他配置省略-->
4. </configuration>
设置变量:property
用于定义键值对的变量, property 有两个属性 name 和 value,name 是键,value 是值,通过 property 定义的键值对会保存到logger 上下文的 map 集合内。定义变量后,可以使用 “${}” 来使用变量
1. <configuration scan="true" scanPeriod="60 seconds" debug="false">
2. <property name="APP_Name" value="myAppName" />
3. <contextName>${APP_Name}</contextName>
4. <!-- 其他配置省略-->
5. </configuration>
获取时间戳字符串:timestamp
timestamp 有两个属性,key:标识此 timestamp 的名字;datePattern:时间输出格式,遵循SimpleDateFormat 的格式
1. <configuration scan="true" scanPeriod="60 seconds" debug="false">
2. <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
3. <contextName>${bySecond}</contextName>
4. <!-- 其他配置省略-->
5. </configuration>
logger
logger 有两种级别,一种是 root,一种是普通的 logger,logger 是用来设置某一个包或者具体的某一个类的日志打印机级别,以及制定的 appender。
logger 有三个属性
• name:用来指定此 logger 约束的某一个包或者具体的某一个类
• level:用来设置打印机别,
• addtivity:是否向上级 logger 传递打印信息。默认是 true
每个 logger 都有对应的父级关系,它通过包名来决定父级关系,root 是最高级的父元素。
下面定义了四个 logger,他们的父子关系从小到大为:
com.lwc.qg.test.logbackDemo → com.lwc.qg.tes → com.lwc.qg → root
1. <!-- 根 logger -->
2. <root level="info">
3. <appender-ref ref="STDOUT"/>
4. </root>
5.
6. <!--
7. 普通的 logger
8. name:类名或包名,标志该 logger 与哪个包或哪个类绑定
9. level:该 logger 的日志级别
10. additivity:是否将日志信息传递给上一级
11. -->
12. <logger name="com.lwc.qg.test.logbackDemo" level="debug" additivity="true">
13. <appender-ref ref="STDOUT"/>
14. </logger>
15.
16. <logger name="com.lwc.qg.test" level="info" additivity="true">
17. <appender-ref ref="STDOUT"/>
18. </logger>
19.
20. <logger name="com.lwc.qg" level="info" additivity="true">
21. <appender-ref ref="STDOUT"/>
22. </logger>
从该种级别来看,如果此时在最低层的 logger 输出日志信息,以该配置作为基础,它将会向父级的所有 logger 依次传递,所以按理来说一个打印信息将会打印四次
从控制台上看,的确每条日志信息都被打印出了四次,但是细心从配置文件上来看,root 的日志级别配置的为 info,但是却输出 debug 级别的日志信息,所以从测试结果可以看出,向上传递的日志信息的日志级别将由最底层的子元素决定(最初传递信息的 logger),因为子元素设置的日志级别为 debug,所以也输出了 debug 级别的信息。
因此,从理论上来说,如果子元素日志级别设置高一点,那么也将会只输出高级别的日志信息。实际上也是如此,如果我们把 com.lwc.qg.test.logbackDemo 对应的 logger 日志级别设为 warn,那么将只会输出 warn 及其以上的信息
root
root 也是 logger 元素,但它是根 logger。只有一个 level 属性
appender
appender 是负责写日志的组件,常用的组件有:
• ConsoleAppender
• FileAppender
• RollingFileAppender
ConsoleAppender
控制台日志组件,该组件将日志信息输出到控制台,该组件有以下节点
• encoder:对日志进行格式化
• target:System.out 或者 System.err,默认是 System.out
1. <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
2. <encoder>
3. <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
4. </encoder>
5. <target>System.out</target>
6. </appender>
FileAppender
文件日志组件,该组件将日志信息输出到日志文件中,该组件有以下节点
• file:被写入的文件名,可以是相对路径,也可以是绝对路径。如果上级目录不存在会自动创建,没有默认值
• append:如果是 true,日志被追加到文件结尾;如果是 false,清空现存文件,默认是 true。
• encoder:格式化
• prudent:如果是 true,日志会被安全的写入文件,即使其他的 FileAppender 也在向此文件做写入操作,效率低,默认是 false。
1. <appender name="FILE" class="ch.qos.logback.core.FileAppender">
2. <file>testFile.log</file>
3. <append>true</append>
4. <encoder>
5. <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
6. </encoder>
7. <prudent>true</prudent>
8. </appender>
RollingFileAppender
滚动记录文件日志组件,先将日志记录记录到指定文件,当符合某个条件时,将日志记录到其他文件,该组件有以下节点
• file:文件名
• encoder:格式化
• rollingPolicy:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
• triggeringPolicy:告知 RollingFileAppender 合适激活滚动
• prudent:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。
rollingPolicy
滚动策略
- TimeBasedRollingPolicy:最常用的滚动策略,它根据时间来制定滚动策略,即负责滚动也负责触发滚动,包含节点:
- fileNamePattern:文件名模式
- maxHistoury:控制文件的最大数量,超过数量则删除旧文件
- FixedWindowRollingPolicy:根据固定窗口算法重命名文件的滚动策略,包含节点
- minInedx:窗口索引最小值
- maxIndex:串口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12
- fileNamePattern:文件名模式,必须包含%i,命名模式为 log%i.log,会产生 log1.log,log2.log 这样的文件
- triggeringPolicy:根据文件大小的滚动策略,包含节点
- maxFileSize:日志文件最大大小
1. <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
2.
3. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
4. <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
5. <maxHistory>30</maxHistory>
6. </rollingPolicy>
7.
8. <encoder>
9. <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
10. </encoder>
11. </appender>
filter 过滤器
过滤器是用于日志组件中的,每经过一个过滤器都会返回一个确切的枚举值,分别是
• DENY:返回 DENY,日志将立即被抛弃不再经过其他过滤器
• NEUTRAL:有序列表的下个过滤器接着处理日志
• ACCEPT:日志会被立即处理,不再经过剩余过滤器
常用过滤器
常用的过滤器有以下:
• LevelFilter
级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据 omMatch 和 omMismatch 接受或拒绝日志。他有以下节点
level:过滤级别
onMatch:配置符合过滤条件的操作
onMismatch:配置不符合过滤条件的操作
例:该组件设置一个 INFO 级别的过滤器,那么所有非 INFO 级别的日志都会被过滤掉
1. <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
2. <filter class="ch.qos.logback.classic.filter.LevelFilter">
3. <level>INFO</level>
4. <onMatch>ACCEPT</onMatch>
5. <onMismatch>DENY</onMismatch>
6. </filter>
7. <encoder>
8. <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
9. </encoder>
10. <target>System.out</target>
11. </appender>
• ThresholdFilter
临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器会返回 NEUTRAL;当日志级别低于临界值时,日志会被拒绝
例:过滤掉所有低于 INFO 级别的日志
1. <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
2. <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
3. <level>INFO</level>
4. </filter>
5. <encoder>
6. <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
7. </encoder>
8. <target>System.out</target>
9. </appender>
• EvaluatorFilter
求值过滤器,评估、鉴别日志是否符合指定条件,包含节点:
evaluator:鉴别器,通过子标签 expression 配置求值条件
onMatch:配置符合过滤条件的操作
onMismatch:配置不符合过滤条件的操作