logback配置文件logback.xml详解

野性酷女 2024-03-16 10:54 122阅读 0赞

logback配置文件XML详解

1.常用配置节点图

58d1e47b7c1c4c94ae04a38278d6ee12.png

logback默认会查找以下文件

logback-test.xml

logback.groovy

logback.xml

2. 配置节点

2.1 根节点

根节点包含以下属性。

  • scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
  • scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。

  • debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

    <?xml version=”1.0” encoding=”UTF-8”?>

2.2 子节点

负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。

常见的appender实现类有以下几种。其他appender使用请参考官方文档

1. ConsoleAppender 日志输出到控制台，子节点包含：

：对日志进行格式化。

：字符串System.out(默认)或者System.err
示例：把>=DEBUG级别的日志都输出到控制台

  1. <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  2.      <encoder charset="UTF-8">
  3.         <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n"</pattern>
  4.      </encoder>
  5. </appender>

2. FileAppender 日志添加到文件(静态文件)

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　　：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　　：对记录事件进行格式化。（具体参数稍后讲解 ）
　　：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

  1. <appender name="DEFAULT_FILE" class="ch.qos.logback.core.FileAppender"> 
  2. 　　<file>defaultFile.log</file> 
  3. 　　<append>true</append> 
  4. 　　<encoder> 
  5.          <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n</pattern> 
  6. 　　</encoder> 
  7. </appender>

3. RollingFileAppender（动态文件）

RollingFileAppender滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　　　 ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　　　 :当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类。

rollingPolicy有一些策略：

class=”ch.qos.logback.core.rolling.TimeBasedRollingPolicy”： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。

：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。

　 :日志文件保留单位数

class=”ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动

:这是活动文件的大小，默认值是10MB。
　　：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
　　: 告知 RollingFileAppender 合适激活滚动。

class=”ch.qos.logback.core.rolling.FixedWindowRollingPolicy” 根据固定窗口算法重命名文件的滚动策略

　:窗口索引最小值
　:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
　:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 console%i.log,会产生归档文件console1.log和console2.log。还可以指定文件压缩选项，例如，console%i.log.gz 或者 console%i.log.zip

  1. <appender name="DEFAULT_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  2. <file>console.log</file>
  3. <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  4.   <!-- 每天一归档 -->
  5.   <fileNamePattern>console.%d{yyyyMMddHH}.%i.log</fileNamePattern>
  6.    <!-- 单个日志文件最多 100MB, 60天的日志周期，最大不能超过20GB,窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志 -->
  7.    <maxFileSize>100MB</maxFileSize>    
  8.    <maxHistory>60</maxHistory>
  9.    <totalSizeCap>20GB</totalSizeCap>
  10.    <minIndex>1</minIndex> 
  11. 　 <maxIndex>3</maxIndex> 
  12. </rollingPolicy>
  13. <encoder>
  14.   <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n</pattern>
  15. </encoder>
  16. </appender>

2.3.root节点，必选节点

  1. <root level="INFO">
  2.     <appender-ref ref="CONSOLE"/>
  3.     <appender-ref ref="INFO_FILE"/>
  4.     <appender-ref ref="WARN_FILE"/>
  5.     <appender-ref ref="ERROR_FILE"/>
  6.  </root>

2.4 logger节点，可选节点

name:用来指定受此logger约束的某一个包或者具体的某一个类。

level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，

additivity：是否继承root节点，默认是true继承。默认情况下子Logger会继承父Logger的appender，也就是说子Logger会在父Logger的appender里输出。若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出。

2.5. 子节点

用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。

  1. <property name="LOG_SAVE_PATH" value="logs"></property>
  2. <property name="DEFAULT_PATTERN"
  3.          value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n">
  4. </property>

2.6子节点

用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

  1. <configuration scan="true" scanPeriod="60 seconds" debug="false"> 
  2.      <contextName>myApp</contextName> 
  3. 　　  <!--其他配置省略-->
  4. </configuration>

2.7子节点

获取时间戳字符串，他有两个属性key和datePattern。

key: 标识此的名字；

datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.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>

3.完整的Logback.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration scan="true" scanPeriod="10 seconds">
  3.     <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
  4.     <!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
  5.     <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
  6.     <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
  7.     <contextName>logback</contextName>
  8.     <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
  9.     <property name="LOG_SAVE_PATH" value="logs"></property>
  10.      <!-- 定义输出日志记录格式 -->
  11.     <property name="DEFAULT_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n"/>
  13.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  14.         <encoder>
  15.             <Pattern>${DEFAULT_PATTERN}</Pattern>
  16.             <!-- 设置字符集 -->
  17.             <charset>UTF-8</charset>
  18.         </encoder>
  19.     </appender>
  21.     <!-- 时间滚动输出 level为 INFO 日志 -->
  22.     <appender name="RollingFileInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
  23.         <file>${LOG_SAVE_PATH}/console.log</file>
  24.         <encoder>
  25.             <pattern>${DEFAULT_PATTERN}</pattern>
  26.             <charset>UTF-8</charset>
  27.         </encoder>
  28.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  29.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  30.             <!-- 每天日志归档路径以及格式 -->
  31.             <fileNamePattern>${LOG_SAVE_PATH}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  32.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  33.                 <maxFileSize>100MB</maxFileSize>
  34.             </timeBasedFileNamingAndTriggeringPolicy>
  35.             <!--日志文件保留单位数-->
  36.             <maxHistory>15</maxHistory>
  37.         </rollingPolicy>
  38.         <!-- 此日志文件只记录info级别的 -->
  39.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  40.             <level>INFO</level>
  41.             <onMatch>ACCEPT</onMatch>
  42.             <onMismatch>DENY</onMismatch>
  43.         </filter>
  44.     </appender>
  46.     <!-- 时间滚动输出 level为 WARN 日志 -->
  47.     <appender name="RollingFileWarn" class="ch.qos.logback.core.rolling.RollingFileAppender">
  48.         <file>${LOG_SAVE_PATH}/warn.log</file>
  49.         <encoder>
  50.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
  51.             <charset>UTF-8</charset>
  52.         </encoder>
  53.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  54.             <fileNamePattern>${LOG_SAVE_PATH}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  55.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  56.                 <maxFileSize>100MB</maxFileSize>
  57.             </timeBasedFileNamingAndTriggeringPolicy>
  58.             <maxHistory>15</maxHistory>
  59.         </rollingPolicy>
  60.         <!-- 此日志文件只记录warn级别的 -->
  61.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  62.             <level>warn</level>
  63.             <onMatch>ACCEPT</onMatch>
  64.             <onMismatch>DENY</onMismatch>
  65.         </filter>
  66.     </appender>
  68.     <!-- 时间滚动输出 level为 ERROR 日志 -->
  69.     <appender name="RollingFileError" class="ch.qos.logback.core.rolling.RollingFileAppender">
  70.         <file>${LOG_SAVE_PATH}/error.log</file>
  71.         <encoder>
  72.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
  73.             <charset>UTF-8</charset>
  74.         </encoder>
  75.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  76.             <fileNamePattern>${LOG_SAVE_PATH}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  77.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  78.                 <maxFileSize>100MB</maxFileSize>
  79.             </timeBasedFileNamingAndTriggeringPolicy>
  80.             <!--日志文件保留单位数-->
  81.             <maxHistory>15</maxHistory>
  82.         </rollingPolicy>
  83.         <!-- 此日志文件只记录ERROR级别的 -->
  84.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  85.             <level>ERROR</level>
  86.             <onMatch>ACCEPT</onMatch>
  87.             <onMismatch>DENY</onMismatch>
  88.         </filter>
  89.     </appender>
  91.     <!--additivity:是否继承root节点，默认是true继承。默认情况下子Logger会继承父Logger的appender，
  92.     也就是说子Logger会在父Logger的appender里输出。
  93.     若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出。-->
  94.     <logger name="org.springframework" level="INFO" additivity="false">
  95.         <appender-ref ref="CONSOLE"/>
  96.         <appender-ref ref="RollingFileInfo"/>
  97.     </logger>
  98.     <logger name="org.springframework.security" level="INFO"></logger>
  99.     <Logger name="org.apache.ibatis.io.DefaultVFS" level="INFO"/>
  100.     <Logger name="org.apache.ibatis.io" level="INFO"/>
  101.     <!-- 设置日志输出级别，从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF-->
  102.     <root level="ALL">
  103.         <appender-ref ref="CONSOLE"/>
  104.         <appender-ref ref="DEFAULT_FILE"/>
  105.         <appender-ref ref="RollingFileWarn"/>
  106.         <appender-ref ref="RollingFileError"/>
  107.     </root>
  110. </configuration>

4. $的使用

$可以直接从property节点加载配置，也可以直接从环境变量加载。直接使用${keyname}

5. 总结

1、输出源选择

logback的配置，需要配置输出源appender，打日志的logger（子节点）和root（根节点），实际上，它输出日志是从子节点开始，子节点如果有输出源直接输入，如果无，判断配置的addtivity，是否向上级传递，即是否向root传递，传递则采用root的输出源，否则不输出日志。

2、日志级别Level

日志记录器（Logger）的行为是分等级的： 分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。
Log4j建议只使用四个级别，优先级从高到低分别是 ERROR、WARN、INFO、DEBUG，优先级高的将被打印出来。（logback通用）
通过定义级别，可以作为应用程序中相应级别的日志信息的开关。
比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。（设置INFO级别，即：>=INFO 生效）
项目上生产环境的时候一定得把debug的日志级别重新调为warn或者更高，避免产生大量日志。

发表评论

表情：
评论列表 （有 0 条评论，122人围观）

还没有评论，来说两句吧...

相关阅读

    相关 logback配置文件

    -输出到控制台-->--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->--临界值过滤器，过滤掉低于指定临界值的...

    短命女短命女/ 0 赞/ 132 阅读

    相关 logback配置详解

    一：根节点包含的属性： scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 scanPeriod: 设置监测配置文件是否有修

    蔚落蔚落/ 0 赞/ 276 阅读

    相关 logback 配置详解

    概览 简单地说，Logback 是一个 Java 领域的日志框架。它被认为是 Log4J 的继承人。 Logback 主要由三个模块组成： logback-c

    悠悠悠悠/ 0 赞/ 329 阅读