logback配置参数详解

最新推荐文章于 2025-03-28 09:32:29 发布

hfwangyl

最新推荐文章于 2025-03-28 09:32:29 发布

阅读量1.1k

点赞数 27

文章标签： logback java

本文链接：https://blog.youkuaiyun.com/hfwangyl/article/details/144376464

版权

logback.xml

configuration

logback是项目中最常用的日志框架，本文主要记录一下logback中一些常用的标签和属性使用方法。

configuration

configuration标签是logback.xml配置文件的根节点，在configuration标签中有如下几个常用的属性：

scan
该属性是boolean类型值，默认值为true。当此属性设置为 true 时，配置文件如果发生改变，将会被重新加载。
scanPeriod
该属性是用来设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。如果 scan属性为 true 时，scanPeriod属性生效，默认的时间间隔为 1min。
debug
该属性是boolean类型值，默认值为true。当此属性设置为 true 时，将打印出 logback 内部日志信息，实时查看 logback 运行状态。

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <!-- 其他配置省略-->  
</configuration>

contextName

设置上下文名称，每个 logger 都关联到 logger 上下文，默认上下文名称为 “default”。可以通过设置 contextName 修改上下文名称，用于区分不同应用程序的记录。

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <contextName>serviceName</contextName>  
      <!-- 其他配置省略-->  
</configuration>

property

用于定义键值对的变量， property 有两个属性 name 和 value，name 是键，value 是值，通过 property 定义的键值对会保存到logger 上下文的 map 集合内。定义变量后，可以使用 “${}” 来使用变量

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <property name="service_name" value="serviceName" />   
      <contextName>${service_name}</contextName>  
      <!-- 其他配置省略-->  
</configuration>

timestamp

获取时间戳字符串，timestamp 有两个属性，key：标识此 timestamp 的名字；datePattern：时间输出格式，遵循SimpleDateFormat 的格式，定义变量后，可以使用 “${}” 来使用变量。

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <timestamp key="changeTime" datePattern="yyyy-MM-dd HH:mm:ss"/>   
      <contextName>${changeTime}</contextName>  
      <!-- 其他配置省略-->  
</configuration>

logger

logger有两个级别，一个是root，一个是logger。root 也是 logger 元素，但它是根 logger，只有一个 level 属性。logger 是用来设置某一个包或者具体的某一个类的日志打印机级别，以及制定的 appender。每个 logger 都有对应的父级关系，它通过包名来决定父级关系，root 是最高级的父元素。
logger 有三个属性：

name：用来指定此 logger 约束的某一个包或者具体的某一个类
level：用来设置打印机别
addtivity：是否向上级 logger 传递打印信息。默认是 true

下面例子中定义了四个 logger，他们的父子关系从小到大为：
com.wangyl.test.logbackDemo < com.wangyl.test < com.wangyl < root

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

<logger name="com.wangyl.test.logbackDemo" level="debug" additivity="true">
	<appender-ref ref="STDOUT"/>
</logger>

<logger name="com.wangyl.test" level="info" additivity="true">
    <appender-ref ref="STDOUT"/>
</logger>

<logger name="com.wangyl" level="info" additivity="true">
    <appender-ref ref="STDOUT"/>
</logger>

在这个例子中，如果此时在最低层的 logger (com.wangyl.test.logbackDemo)输出日志信息，以该配置作为基础，它将会向父级的所有 logger 依次传递，所以按理来说一个log信息将会打印四次。
　　从控制台上看，的确每条日志信息都被打印出了四次，但是细心从配置文件上来看，root 的日志级别配置的为 info，但是却输出 debug 级别的日志信息，所以从测试结果可以看出，向上传递的日志信息的日志级别将由最底层的子元素决定（最初传递信息的 logger），因为子元素设置的日志级别为 debug，所以也输出了 debug 级别的信息。
　　因此，从理论上来说，如果子元素日志级别设置高一点，那么也将会只输出高级别的日志信息。实际上也是如此，如果我们把 com.wangyl.test.logbackDemo 对应的 logger 日志级别设为 warn，那么将只会输出 warn 及其以上的信息。

appender

appender 是负责写日志的组件，常用的组件有：

ConsoleAppender
FileAppender
RollingFileAppender

ConsoleAppender

控制台日志组件，该组件将日志信息输出到控制台,该组件有以下节点：

encoder：对日志进行格式化
- pattern：转换格式详细内容参考这一篇文章
target：System.out 或者 System.err，默认是 System.out

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
    </encoder>
    <target>System.out</target>
</appender>

FileAppender

FileAppender是文件日志组件，该组件将日志信息输出到日志文件中，该组件有以下节点：

file：被写入的文件名，可以是相对路径，也可以是绝对路径。如果上级目录不存在会自动创建，没有默认值，也可以引入yml配置文件中的参数。
append：如果是 true，日志被追加到文件结尾；如果是 false，清空现存文件，默认是 true。
encoder：格式化
- pattern：转换格式详细内容参考这一篇文章
prudent：如果是 true，日志会被安全的写入文件，即使其他的 FileAppender 也在向此文件做写入操作，效率低，默认是 false。

<configuration>
	<property name="bashPath" value="./log" />
	<appender name="FILE" class="ch.qos.logback.core.FileAppender">
	    <file>${bashPath}/${spring.application.name}.log</file>
	    <append>true</append>
	    <encoder>
	        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
	    </encoder>
	    <prudent>true</prudent>
	</appender>
</configuration>

RollingFileAppender

RollingFileAppender是滚动记录文件日志组件，先将日志记录记录到指定文件，当符合某个条件时，将日志记录到其他文件，该组件有以下节点：

file：文件名
encoder：格式化
- pattern：转换格式详细内容参考这一篇文章
rollingPolicy：当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
- TimeBasedRollingPolicy：最常用的滚动策略，它根据时间来制定滚动策略，即负责滚动也负责触发滚动，包含节点：
  - fileNamePattern：文件名模式
  - maxHistoury：控制文件的最大数量，超过数量则删除旧文件
- FixedWindowRollingPolicy：根据固定窗口算法重命名文件的滚动策略，包含节点：
  - minInedx：窗口索引最小值
  - maxIndex：串口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12
  - fileNamePattern：文件名模式，必须包含%i，命名模式为 log%i.log，会产生 log1.log，log2.log 这样的文件
- triggeringPolicy：根据文件大小的滚动策略，包含节点：
  - maxFileSize：日志文件最大大小
triggeringPolicy：告知 RollingFileAppender 合适激活滚动
prudent：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
</appender>

filter

过滤器是用于日志组件中的，每经过一个过滤器都会返回一个确切的枚举值，分别是：

DENY：返回 DENY，日志将立即被抛弃不再经过其他过滤器
NEUTRAL：有序列表的下个过滤器接着处理日志
ACCEPT：日志会被立即处理，不再经过剩余过滤器

常用的过滤器有以下：

LevelFilter

级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据 omMatch 和 omMismatch 接受或拒绝日志。他有以下节点
- level：过滤级别
- onMatch：配置符合过滤条件的操作
- onMismatch：配置不符合过滤条件的操作

例：该组件设置一个 INFO 级别的过滤器，那么所有非 INFO 级别的日志都会被过滤掉

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
	<!-- 将过滤器的日志级别配置为INFO，所有INFO级别的日志交给appender处理，非INFO级别的日志，被过滤掉。 -->
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>  
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
    </encoder> 
    <target>System.out</target> 
</appender>

ThresholdFilter

临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器会返回 NEUTRAL；当日志级别低于临界值时，日志会被拒绝。
例：过滤掉所有低于 INFO 级别的日志

<!--记录error级别的日志到文件-->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <append>true</append>
        <!-- 过滤器，只记录 error 级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>error</level>
        </filter>
        <!-- 每天生成一个日志文件，保存30天的日志文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名:按天回滚 daily -->
            <FileNamePattern>${LOG_HOME}/error.production-procedure-trace.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </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>
            <!-- 编码 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

EvaluatorFilter

求值过滤器，评估、鉴别日志是否符合指定条件，包含节点：
- evaluator：鉴别器，通过子标签 expression 配置求值条件
- onMatch：配置符合过滤条件的操作
- onMismatch：配置不符合过滤条件的操作

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">         
      <evaluator>   
        <expression>return message.contains("billing");</expression>   
      </evaluator>   
      <OnMatch>ACCEPT</OnMatch>  
      <OnMismatch>DENY</OnMismatch>  
    </filter>   
    <encoder>   
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
    </encoder>   
  </appender>