logback配置文件---logback.xml详解

目录

一、logback.xml常用配置详解

二、logback.xml配置示例

三、总结

1、输出源选择

2、日志级别Level


一、logback.xml常用配置详解

常用节点结构图:

logback配置文件---logback.xml详解_第1张图片

1、根节点,包含下面三个属性:

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

示例:

 
     
 

2、子节点:负责写日志的组件,它有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。

下文只简述常见的appender,其他appender使用请参考官方文档。

2.1、ConsoleAppender 把日志输出到控制台,有以下子节点:
:对日志进行格式化。
:字符串System.out(默认)或者System.err
示例:把>=DEBUG级别的日志都输出到控制台

 
    
       
         %-4relative [%thread] %-5level %logger{35} - %msg %n 
       
    

    
       
    

2.2、FileAppender:把日志添加到文件,有以下子节点:
     :被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
     :如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
     :对记录事件进行格式化。(具体参数稍后讲解 )
     :如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
示例:把>=DEBUG级别的日志都输出到testFile.log

     
       
        testFile.log 
        true 
         
          %-4relative [%thread] %-5level %logger{35} - %msg%n 
         
       

       
       
       
    

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

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

<1> class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:
      :必要节点,包含文件名及“%d”转换符,“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。
如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;
如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
        :
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。

<2> class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看当前活动文件的大小,如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
     :这是活动文件的大小,默认值是10MB。
     :当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。
     : 告知 RollingFileAppender 合适激活滚动。

<3> class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
     :窗口索引最小值
     :窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
     :必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip

 示例:每天生成一个日志文件,保存30天的日志文件。

         
           
             
              logFile.%d{yyyy-MM-dd}.log 
              30 
             
             
              %-4relative [%thread] %-5level %logger{35} - %msg%n 
             
           

           
             
           
        

3、子节点:用来设置某一个包或具体的某一个类的日志打印级别、以及指定

仅有一个name属性,一个可选的level和一个可选的addtivity属性。

可以包含零个或多个元素,标识这个appender将会添加到这个logger。
    name: 用来指定受此loger约束的某一个包或者具体的某一个类。
    level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,还有一个特殊值INHERITED或者同义词NULL,代表强制执行上级的级别。 如果未设置此属性,那么当前loger将会继承上级的级别。
    addtivity: 是否向上级logger传递打印信息。默认是true。可以包含零个或多个元素,标识这个appender将会添加到这个logger。

4、子节点:它也是元素,但是它是根loger,是所有的上级。只有一个level属性,因为name已经被命名为"root",且已经是最上级了。

    level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能设置为INHERITED或者同义词NULL。 默认是DEBUG。

一样,可以包含零个或多个元素,标识这个appender将会添加到这个logger。

示例:常用logger配置












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

 示例:

 
     myAppName 
    
    

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

    name: 变量的名称
    value: 的值时变量定义的值

 示例:

 
    
   ${APP_Name} 
    

7、子节点:获取时间戳字符串,他有两个属性key和datePattern。    

    key: 标识此 的名字;
    datePattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。

示例:

     
       
      ${bySecond} 
       
    

二、logback.xml配置示例




    
    

    
    
        
            
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
        
    

    
    
        
            
            ${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log
            
            30
        
        
            
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
        
        
        
            10MB
        
    

    
    
    
    
    
    

    
    
    
    
    

    
    
        
        
    

三、总结

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或者更高,避免产生大量日志。

你可能感兴趣的:(日志/异常,1024程序员节)