logback logback.xml 常用配置詳解

參考網址:https://my.oschina.net/looly/blog/298675



一:根節點<configuration>包含的屬性:

  • scan: 當此屬性設置爲true時,配置文件如果發生改變,將會被重新加載,默認值爲true。

  • scanPeriod: 設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan爲true時,此屬性生效。默認的時間間隔爲1分鐘。

  • debug: 當此屬性設置爲true時,將打印出logback內部日誌信息,實時查看logback運行狀態。默認值爲false。

例如:

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

二:根節點<configuration>的子節點:

根節點<configuration>的子節點

2.1設置上下文名稱:&lt;contextName>

每個logger都關聯到logger上下文,默認上下文名稱爲default。但可以使用&lt;contextName>設置成其他名字,用於區分不同應用程序的記錄。一旦設置,不能修改。

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

2.2設置變量: &lt;property>

用來定義變量值的標籤,&lt;property> 有兩個屬性name和value;

  • name: 變量的名稱

  • value: 的值時變量定義的值。

通過&lt;property>定義的值會被插入到logger上下文中。定義變量後,可以使“${}”來使用變量。

例如使用&lt;property>定義上下文名稱,然後在&lt;contentName>設置logger上下文時使用。

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

2.3獲取時間戳字符串:&lt;timestamp>

兩個屬性:

  • key: 標識此&lt;timestamp> 的名字;

  • datePattern: 設置將當前時間(解析配置文件的時間)轉換爲字符串的模式,遵循java.txt.SimpleDateFormat的格式。

例如將解析配置文件的時間作爲上下文名稱:

<!-- lang: xml--><configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
      <contextName>${bySecond}</contextName>  
      <!-- 其他配置省略-->  </configuration>

2.4設置loger:

&lt;loger>

用來設置某一個包或者具體的某一個類的日誌打印級別、以及指定&lt;appender>&lt;loger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。

  • name: 用來指定受此loger約束的某一個包或者具體的某一個類。

  • level: 用來設置打印級別,大小寫無關:TRACEDEBUG, INFO,WARN,ERROR,ALLOFF,還有一個特俗值INHERITED或者同義詞NULL`,代表強制執行上級的級別。 如果未設置此屬性,那麼當前loger將會繼承上級的級別。

  • addtivity: 是否向上級loger傳遞打印信息。默認是true。

&lt;root>

也是<loger>元素,但是它是根loger。只有一個level屬性,應爲已經被命名爲"root".

  • level: 用來設置打印級別,大小寫無關:TRACEDEBUGINFOWARNERRORALL 和 OFF,不能設置爲INHERITED或者同義詞NULL。 默認是DEBUG。

&lt;loger>&lt;root>可以包含零個或多個&lt;appender-ref>元素,標識這個appender將會添加到這個loger

例如: LogbackDemo.java類

<!-- lang: java-->
package logback;  
  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class LogbackDemo {  
    private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
    public static void main(String[] args) {  
        log.trace("======trace");  
        log.debug("======debug");  
        log.info("======info");  
        log.warn("======warn");  
        log.error("======error");  
    }  
}

三、logback.xml配置文件

第1種:只配置root

<!-- lang: xml--><configuration>   
   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默認配置爲PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
   
  <root level="INFO">             
    <appender-ref ref="STDOUT" />   
  </root>     
     </configuration>

其中appender的配置表示打印到控制檯(稍後詳細講解appender ); &lt;root level="INFO">將root的打印級別設置爲“INFO”,指定了名字爲“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時,root將級別爲“INFO”及大於“INFO”的日誌信息交給已經配置好的名爲“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制檯;

打印結果如下:

13:30:38.484 [main] INFO  logback.LogbackDemo - ======info  13:30:38.500 [main] WARN  logback.LogbackDemo - ======warn  13:30:38.500 [main] ERROR logback.LogbackDemo - ======error

第2種:帶有loger的配置,不指定級別,不指定appender:

<!-- lang: xml--><configuration>   
   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默認配置爲PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
   
  <!-- logback爲java中的包 -->   
  <logger name="logback"/>   
   
  <root level="DEBUG">             
    <appender-ref ref="STDOUT" />   
  </root>     
     </configuration>

其中appender的配置表示打印到控制檯(稍後詳細講解appender ); &lt;logger name="logback" />將控制logback包下的所有類的日誌的打印,但是並沒用設置打印級別,所以繼承他的上級&lt;root>的日誌級別“DEBUG”; 沒有設置addtivity,默認爲true,將此loger的打印信息向上級傳遞; 沒有設置appender,此loger本身不打印任何信息。&lt;root level="DEBUG">將root的打印級別設置爲“DEBUG”,指定了名字爲“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時,因爲LogbackDemo 在包logback中,所以首先執行&lt;logger name="logback" />,將級別爲“DEBUG”及大於“DEBUG”的日誌信息傳遞給root,本身並不打印; root接到下級傳遞的信息,交給已經配置好的名爲“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制檯;

打印結果如下:

13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug  13:19:15.406 [main] INFO  logback.LogbackDemo - ======info  13:19:15.406 [main] WARN  logback.LogbackDemo - ======warn  13:19:15.406 [main] ERROR logback.LogbackDemo - ======error

第3種:帶有多個loger的配置,指定級別,指定appender:

<!-- lang: xml--><configuration>   
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默認配置爲PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
   
  <!-- logback爲java中的包 -->   
  <logger name="logback"/>   
  <!--logback.LogbackDemo:類的全路徑 -->   
  <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
    <appender-ref ref="STDOUT"/>  
  </logger>   
    
  <root level="ERROR">             
    <appender-ref ref="STDOUT" />   
  </root>     </configuration>

其中appender的配置表示打印到控制檯(稍後詳細講解appender );

&lt;logger name="logback" />將控制logback包下的所有類的日誌的打印,但是並沒用設置打印級別,所以繼承他的上級&lt;root>的日誌級別“DEBUG”; 沒有設置addtivity,默認爲true,將此loger的打印信息向上級傳遞; 沒有設置appender,此loger本身不打印任何信息。

&lt;logger name="logback.LogbackDemo" level="INFO" additivity="false">控制logback.LogbackDemo類的日誌打印,打印級別爲“INFO”; additivity屬性爲false,表示此loger的打印信息不再向上級傳遞, 指定了名字爲“STDOUT”的appender。

&lt;root level="DEBUG">將root的打印級別設置爲“ERROR”,指定了名字爲“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時,先執行&lt;logger name="log此loger指定的名爲“STDOUT”的appender處理,在控制檯中打出日誌,不再向次loger的上級 &lt;logger name="logback"/> 傳遞打印信息; &lt;logger name="logback"/>未接到任何打印信息,當然也不會給它的上級root傳遞任何打印信息;back.LogbackDemo" level="INFO" additivity="false">,將級別爲“INFO”及大於“INFO”的日誌信息交給

打印結果如下:

14:09:01.531 [main] INFO  logback.LogbackDemo - ======info 
14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error


總結:logback是使用<loger>標籤打印對應的日誌文件或者打印到控制檯,它的子標籤<appender-ref ref=""/>是指定打印日誌具體方式,打印到控制檯或者輸出流到具體日誌文件路徑。


具體loger標籤 三個屬性name制定類名或者包名,root根loger不需要指定name,level="INFO" 制定日誌等級,一般是INFO或者DEBUG就是tomcat之類啓動日誌之外黑色字體日誌部分  additivity="false"是否上傳到根也就是root  loger,一般是false,如果是true ,那麼root標籤裏面最好只選擇打印控制檯的appender,不然日誌可能會被打印2便,比如一個loger標籤注入了一個控制檯appender,但是additivity="true",root也注入了控制檯appender,那麼控制檯就會打印2次,又或者都注入了一個寫到某個目錄下的appender日誌文件,那麼一樣會寫2次


<!-- 告警日誌記錄文件(包含WARN和ERROR級別)end -->

<logger name="com.cmsz.controlstation.logging.system.SystemLogHandler" level="INFO"additivity="false">

<appender-ref ref="SYSTEM_APPENDER_ROOT" />

</logger>

制定system目錄下的日誌類SystemLogHandler.java打印日誌,那麼

代碼那邊只要


private static SystemLogHandler logger = SystemLogHandler.getLogger(FileAlarmController.class);


loger.info("日誌info")

loger.warn("日誌warn")

loger.error("日誌error")



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章