关于spring boot的日志研究logback.xml与logback-spring.xml

634 阅读3分钟

SpringBoot配置文件的加载顺序

logback.xml -> application.propertis ->logback-spring.xml

所以Spring官方是建议用logback-spring.xml代替logback.xml这样就可以在application中定义的变量可以被logback-spring.xml所使用,不然logback.xml因为优先级高于application.yml所以它使用不了application.yml设置的内容,例如日志输出路径。

日志级别

日志级别从低到高为:TRACE <DEBUG < INFO < WARN < ERROR < FATAL 如果设置为WARN,则低于WARN的信息都不会输出。

logback-spring.xml的配置项

  • 一个父标签,即configuaration
  • 两种属性,即contextName和property
  • 三个节点,即appender,root,logger

一个父标签 configuaration

<configuration scan="true" scanPeriod="10 seconds"> </configuration>
  • 其实它的属性不需要设置,按缺省即可,即只需要定义一个即可。
  • scan默认是true,当它为true时,配置文件如果发生改变时,将会被重新加载。
  • scanPeriod,默认是时间间隔为1分钟,监测配置是否有修改的时间间隔,如果没有给时间单位,默认单位是毫秒。

两种属性 contextName 和 property

  • contextName一般不会去设置。
    

    如果同时存在logback.xml和logback-spring.xml,或者同时存在logback.xml和自定义的配置文件,则会先加载logback.xml,再根据application配置加载指定配置文件,或加载指定配置文件,或加载logback-spring.xml。如果这两个配置文件的contextName不同,就会报错。 每个logger都关联到logger上下文,默认上下文名称为default,但可以使用设置成其他名字,用于区别不同应用程序的记录,一旦设置,不能修改。

  • property ,用来定义变量值的标签,有两个属性name和value,其中name的值是变量的名称,value定义变量的值,通过定义的变量值会被插入到logger上下文中,定义变量后,可以使用${}来使用变量。

三个节点appender、root、logger

appender节点

追加器,其实就是日志的渲染器(或者说格式化日志输出),常用于渲染console和文件日志的格式。经常用来分别定义console日志和文件日志的输出策略。
appender有name(即渲染器的名字)和class属性策(即输出的策略:RollingFileAppender),有rollingPolicy和encode两个子节点;


<!-- 控制台输出 -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
   <encoder>
      <pattern>${log.pattern}</pattern>
   </encoder>
</appender>
    
    ```

<!-- 文件日志输出 -->
<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.path}/sys-info.log</file>
       <!-- 循环政策:基于时间创建日志文件 -->
   <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           <!-- 日志文件名格式 -->
      <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
      <!-- 日志最大的历史 60天 -->
      <maxHistory>60</maxHistory>
   </rollingPolicy>
   <encoder>
      <pattern>${log.pattern}</pattern>
   </encoder>
   <filter class="ch.qos.logback.classic.filter.LevelFilter">
           <!-- 过滤的级别 -->
           <level>INFO</level>
           <!-- 匹配时的操作:接收(记录) -->
           <onMatch>ACCEPT</onMatch>
           <!-- 不匹配时的操作:拒绝(不记录) -->
           <onMismatch>DENY</onMismatch>
       </filter>
</appender>
    encoder表示输出格式,具体说明如下:
    %d表示时间
    %thread表示线程名 
    %-5level 表示日志级别,允许以五个字符长度输出   
    %logger{50}表示具体的日志输出者,比如类名,括号内表示长度 
    %msg表示具体的日志消息,就是logger.info("xxx")中的xxx 
    %n表示换行
    可以在属性中定义颜色和高亮,然后放到appender中的encoder中的pattern中,如下:
    <property name="pattern-color" value="%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%thread] %highlight(%-5level) %red(%logger{50}) - %yellow(%msg) %n"/>
    
    <appender name="CONSOLE-WITH-COLOR" class="ch.qos.logback.core.ConsoleAppender">
           <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${pattern-color}</pattern>
           </encoder>
  </appender>
    
    定义文件输出的渲染的定义例子:
    <!--输出到文件-->
    <!-- 时间滚动输出 level为 DEBUG 日志 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <!--先将今天的日志保存在这个文件中-->
        <file>${log.path}/log_debug.log</file>
        <!--日志文件输出格式   %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
            %d{HH: mm:ss.SSS}——日志输出时间
            %thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
            %-5level——日志级别,并且使用5个字符靠左对齐
            %logger{36}——日志输出者的名字
            %msg——日志消息
            %n——平台的换行符
           -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
 
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- rollover daily -->
            <!--如果第二天输出日志,会将当天的日志记录在<file>${log.path}/log_debug.log</file>,然后将昨天的日志归档到下面的文件中-->
            <!--以分钟切分  %d{yyyy-MM-dd_HH-mm}-->
            <fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.log</fileNamePattern>
            <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
            <!--单个日志文件最大100M,到了这个值,就会再创建一个日志文件,日志文件的名字最后+1-->
            <maxFileSize>100MB</maxFileSize>
            <!--日志文件保留天数-->
            <maxHistory>30</maxHistory>
            <!--所有的日志文件最大20G,超过就会删除旧的日志-->
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
        <!-- 
            此日志文件只记录debug级别的 
            onMatch和onMismatch都有三个属性值,分别为Accept、DENY和NEUTRAL
            onMatch="ACCEPT" 表示匹配该级别及以上
            onMatch="DENY" 表示不匹配该级别及以上
            onMatch="NEUTRAL" 表示该级别及以上的,由下一个filter处理,如果当前是最后一个,则表        示匹配该级别及以上
            onMismatch="ACCEPT" 表示匹配该级别以下
            onMismatch="NEUTRAL" 表示该级别及以下的,由下一个filter处理,如果当前是最后一个,则不匹配该级别以下的
            onMismatch="DENY" 表示不匹配该级别以下的
        -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

root

前面定义了多个appender日志输出的渲染器,需要启动哪些,就可以通过root来定义,支持启用多个appender:

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

<!--系统操作日志-->
   <root level="info">
       <appender-ref ref="file_info" />
       <appender-ref ref="file_error" />
   </root>

logger

它和root是类似功能,它与root是父子关系,而logger对单个包或者类进行配置,例如:
    <!--
    name:用来指定受此loger约束的某一个包或者具体的某一个类。
    addtivity:是否向上级loger传递打印信息。默认是true,如果false则会覆盖root,只会打印一遍,如果是true则向上层再次传递,不会覆盖,而是打印两遍。
-->
<!-- logback为 com.pikaqiu.logbackdemo 中的包 -->
<logger name="com.pikaqiu.logbackdemo" level="debug" additivity="false">
  <appender-ref ref="CONSOLE" />
</logger>

<!-- logback为 com.pikaqiu.logbackdemo.LogbackdemoApplicationTests 这个类 -->
<logger name="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests" level="INFO" additivity="true">
  <appender-ref ref="STDOUT"/>
</logger>