logback使用配置詳解

時間  2020-08-09
標籤 logback 使用 配置 詳解 简体版
原文   原文鏈接

title: logback使用配置詳解
date: 2017-04-25 16:42:49
tags: 日誌

1.介紹

　Logback是由log4j創始人設計的另外一個開源日誌組件,它當前分爲下面下個模塊：html

  • 　　logback-core：其它兩個模塊的基礎模塊
  • 　　logback-classic：它是log4j的一個改良版本，同時它完整實現了slf4j API使你能夠很方便地更換成其它日誌系統如log4j或JDK14 Logging
  • 　　logback-access：訪問模塊與Servlet容器集成提供經過Http來訪問日誌的功能（非必須的包）
  • 　　注意：還要一個slf4j的包

2.配置介紹

2.1Logger、appender及layout

Logger做爲日誌的記錄器，把它關聯到應用的對應的context上後，主要用於存放日誌對象，也能夠定義日誌類型、級別。
Appender主要用於指定日誌輸出的目的地，目的地能夠是控制檯、文件、遠程套接字服務器、 MySQL、PostreSQL、 Oracle和其餘數據庫、 JMS和遠程UNIX Syslog守護進程等。
Layout 負責把事件轉換成字符串，格式化的日誌信息的輸出。java

2.2logger context

各個logger 都被關聯到一個 LoggerContext，LoggerContext負責製造logger，也負責以樹結構排列各logger。其餘全部logger也經過org.slf4j.LoggerFactory 類的靜態方法getLogger取得。 getLogger方法以 logger名稱爲參數。用同一名字調用LoggerFactory.getLogger 方法所獲得的永遠都是同一個logger對象的引用。web

2.3有效級別及級別的繼承

Logger 能夠被分配級別。級別包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定義於ch.qos.logback.classic.Level類。若是 logger沒有被分配級別，那麼它將從有被分配級別的最近的祖先那裏繼承級別。root logger 默認級別是 DEBUG。算法

2.4打印方法與基本的選擇規則

打印方法決定記錄請求的級別。例如，若是 L 是一個 logger 實例，那麼，語句 L.info("..")是一條級別爲 INFO的記錄語句。記錄請求的級別在高於或等於其 logger 的有效級別時被稱爲被啓用，不然，稱爲被禁用。記錄請求級別爲 p，其 logger的有效級別爲 q，只有則當 p>=q時，該請求才會被執行。
該規則是 logback 的核心。級別排序爲： TRACE < DEBUG < INFO < WARN < ERRORsql

3.logback的默認配置

若是配置文件 logback-test.xml 和 logback.xml 都不存在，那麼 logback 默認地會調用BasicConfigurator ，建立一個最小化配置。最小化配置由一個關聯到根 logger 的ConsoleAppender 組成。輸出用模式爲%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進行格式化。root logger 默認級別是 DEBUG。
　　### 3.1Logback的配置文件
Logback 配置文件的語法很是靈活。正由於靈活，因此沒法用 DTD 或 XML schema 進行定義。儘管如此，能夠這樣描述配置文件的基本結構：以 開頭，後面有零個或多個 元素，有零個或多個 元素，有最多一個 元素。
　　### 3.2Logback默認配置的步驟
　　1. JVM參數指定 -Dlogback.configurationFile=D:\PSS\PssCenter\config\logback.xml
　　2. 嘗試在 classpath下查找文件logback-test.xml；
　　3. 若是文件不存在，則查找文件logback.xml；
　　4. 若是兩個文件都不存在，logback用BasicConfigurator自動對本身進行配置，這會致使記錄輸出到控制檯。 數據庫

4.logback.xml經常使用配置詳解

4.1根節點configuration，包含下面三個屬性：

　　　　scan: 當此屬性設置爲true時，配置文件若是發生改變，將會被從新加載，默認值爲true。
　　　　scanPeriod: 設置監測配置文件是否有修改的時間間隔，若是沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。
　　　　debug: 當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。
　　例如：apache

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

4.2子節點contextName：用來設置上下文名稱，每一個logger都關聯到logger上下文，默認上下文名稱爲default。但可使用 設置成其餘名字，用於區分不一樣應用程序的記錄。一旦設置，不能修改。

　　例如：api

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

4.3子節點property：用來定義變量值，它有兩個屬性name和value，經過property定義的值會被插入到logger上下文中，可使「${}」來使用變量。

　　　　name: 變量的名稱
　　　　value: 的值時變量定義的值
　　例如：數組

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

4.4子節點timestamp：獲取時間戳字符串，他有兩個屬性key和datePattern

　　　　key: 標識此timestamp的名字；
　　　　datePattern: 設置將當前時間（解析配置文件的時間）轉換爲字符串的模式，遵循java.txt.SimpleDateFormat的格式。
　　例如：安全

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

4.5子節點appender：負責寫日誌的組件，它有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名

4.5.1ConsoleAppender 把日誌輸出到控制檯，有如下子節點：

　　　　　　encoder：對日誌進行格式化。（具體參數稍後講解 ）
　　　　　　target：字符串System.out(默認)或者System.err（區別很少說了）
　　　　例如：

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

　　　　　　<root level="DEBUG"> 
　　　　　　　　<appender-ref ref="STDOUT" /> 
　　　　　　</root> 
　　　　</configuration>

　　　　上述配置表示把>=DEBUG級別的日誌都輸出到控制檯

4.5.2FileAppender：把日誌添加到文件，有如下子節點：

　　　　　　file：被寫入的文件名，能夠是相對目錄，也能夠是絕對目錄，若是上級目錄不存在會自動建立，沒有默認值。
　　　　　　append：若是是 true，日誌被追加到文件結尾，若是是 false，清空現存文件，默認是true。
　　　　　　encoder：對記錄事件進行格式化。（具體參數稍後講解 ）
　　　　　　prudent：若是是 true，日誌會被安全的寫入文件，即便其餘的FileAppender也在向此文件作寫入操做，效率低，默認是 false。
　　　　例如：

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

　　　　　　<root level="DEBUG"> 
　　　　　　<appender-ref ref="FILE" /> 
　　　　　　</root> 
　　　　</configuration>

　　　　上述配置表示把>=DEBUG級別的日誌都輸出到testFile.log
　　　　

4.5.3RollingFileAppender：滾動記錄文件，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其餘文件。有如下子節點：

　　　　　　file：被寫入的文件名，能夠是相對目錄，也能夠是絕對目錄，若是上級目錄不存在會自動建立，沒有默認值。
　　　　　　append：若是是 true，日誌被追加到文件結尾，若是是 false，清空現存文件，默認是true。
　　　　　　rollingPolicy:當發生滾動時，決定RollingFileAppender的行爲，涉及文件移動和重命名。屬性class定義具體的滾動策略類
　　　　　　class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最經常使用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。有如下子節點：
　　　　　fileNamePattern：必要節點，包含文件名及「%d」轉換符，「%d」能夠包含一個java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。
若是直接使用 %d，默認格式是 yyyy-MM-dd。RollingFileAppender的file字節點無關緊要，經過設置file，能夠爲活動文件和歸檔文件指定不一樣位置，當前日誌老是記錄到file指定的文件（活動文件），活動文件的名字不會改變；
若是沒設置file，活動文件的名字會根據fileNamePattern 的值，每隔一段時間改變一次。「/」或者「\」會被當作目錄分隔符。
　　　　　　　　maxHistory:
可選節點，控制保留的歸檔文件的最大數量，超出數量就刪除舊文件。假設設置每月滾動，且maxHistory是6，則只保存最近6個月的文件，刪除以前的舊文件。注意，刪除舊文件是，那些爲了歸檔而建立的目錄也會被刪除。

　　　　　　class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看當前活動文件的大小，若是超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動。只有一個節點:
　　　　　　　　maxFileSize:這是活動文件的大小，默認值是10MB。
　　　　　　　　prudent：當爲true時，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，可是有兩個限制，1不支持也不容許文件壓縮，2不能設置file屬性，必須留空。

　　　　　　triggeringPolicy : 告知 RollingFileAppender 合適激活滾動。
　　　　　　class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根據固定窗口算法重命名文件的滾動策略。有如下子節點：
　　　　　　　　minIndex:窗口索引最小值
　　　　　　　　maxIndex:窗口索引最大值，當用戶指定的窗口過大時，會自動將窗口設置爲12。
　　　　　　　　fileNamePattern:必須包含「%i」例如，假設最小值和最大值分別爲1和2，命名模式爲 mylog%i.log,會產生歸檔文件mylog1.log和mylog2.log。還能夠指定文件壓縮選項，例如，mylog%i.log.gz 或者 沒有log%i.log.zip
　　　　　　例如：

　　　　　　　　<configuration> 
　　　　　　　　　　<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> 

　　　　　　　　　　<root level="DEBUG"> 
　　　　　　　　　　　　<appender-ref ref="FILE" /> 
　　　　　　　　　　</root> 
　　　　　　　　</configuration>

　　　　　　　　上述配置表示天天生成一個日誌文件，保存30天的日誌文件。

　　　　　　　　<configuration> 
　　　　　　　　　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
　　　　　　　　　　　　<file>test.log</file> 

　　　　　　　　　　　　<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> 
　　　　　　　　　　　　　　<fileNamePattern>tests.%i.log.zip</fileNamePattern> 
　　　　　　　　　　　　　　<minIndex>1</minIndex> 
　　　　　　　　　　　　　　<maxIndex>3</maxIndex> 
　　　　　　　　　　　　</rollingPolicy> 

　　　　　　　　　　　　<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> 
　　　　　　　　　　　　　　<maxFileSize>5MB</maxFileSize> 
　　　　　　　　　　　　</triggeringPolicy> 
　　　　　　　　　　　　<encoder> 
　　　　　　　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
　　　　　　　　　　　　</encoder> 
　　　　　　　　　　</appender> 

　　　　　　　　　　<root level="DEBUG"> 
　　　　　　　　　　　　<appender-ref ref="FILE" /> 
　　　　　　　　　　</root> 
　　　　　　　　</configuration>

　　　　　　　　上述配置表示按照固定窗口模式生成日誌文件，當文件大於20MB時，生成新的日誌文件。窗口大小是1到3，當保存了3個歸檔文件後，將覆蓋最先的日誌。
　　　　　　encoder：對記錄事件進行格式化。負責兩件事，一是把日誌信息轉換成字節數組，二是把字節數組寫入到輸出流。
PatternLayoutEncoder 是惟一有用的且默認的encoder ，有一個pattern節點，用來設置日誌的輸入格式。使用「%」加「轉換符」方式，若是要輸出「%」，則必須用「\」對「%」進行轉義。

4.5.4還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，並不經常使用，這裏就不詳解了。

你們能夠參考官方文檔（http://logback.qos.ch/documentation.html），還能夠編寫本身的Appender。

4.六、子節點loger：用來設置某一個包或具體的某一個類的日誌打印級別、以及指定appender。loger僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。

能夠包含零個或多個appender-ref元素，標識這個appender將會添加到這個loger
　　　　name: 用來指定受此loger約束的某一個包或者具體的某一個類。
　　　　level: 用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，還有一個特俗值INHERITED或者同義詞NULL，表明強制執行上級的級別。 若是未設置此屬性，那麼當前loger將會繼承上級的級別。
addtivity: 是否向上級loger傳遞打印信息。默認是true。同loger同樣，能夠包含零個或多個appender-ref元素，標識這個appender將會添加到這個loger。

4.七、子節點root:它也是loger元素，可是它是根loger,是全部loger的上級。只有一個level屬性，由於name已經被命名爲"root",且已是最上級了。

　　　　level: 用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能設置爲INHERITED或者同義詞NULL。 默認是DEBUG。

5.經常使用logger配置

<!-- show parameters for hibernate sql 專爲 Hibernate 定製 -->
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
<logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
<logger name="org.hibernate.SQL" level="DEBUG" />
<logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
<logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />

<!--myibatis log configure-->
<logger name="com.apache.ibatis" level="TRACE"/>
<logger name="java.sql.Connection" level="DEBUG"/>
<logger name="java.sql.Statement" level="DEBUG"/>
<logger name="java.sql.PreparedStatement" level="DEBUG"/>

6.Demo

　一、添加依賴包logback使用須要和slf4j一塊兒使用，因此總共須要添加依賴的包有slf4j-api
logback使用須要和slf4j一塊兒使用，因此總共須要添加依賴的包有slf4j-api.jar，logback-core.jar，logback-classic.jar，logback-access.jar這個暫時用不到因此不添加依賴了，maven配置

　　<properties>
　　　　<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
　　　　<logback.version>1.1.7</logback.version>
　　　　<slf4j.version>1.7.21</slf4j.version>
　　</properties>

　　<dependencies>
　　　　<dependency>
　　　　　　<groupId>org.slf4j</groupId>
　　　　　　<artifactId>slf4j-api</artifactId>
　　　　　　<version>${slf4j.version}</version>
　　　　　　<scope>compile</scope>
　　　　</dependency>
　　　　<dependency>
　　　　　　<groupId>ch.qos.logback</groupId>
　　　　　　<artifactId>logback-core</artifactId>
　　　　　　<version>${logback.version}</version>
　　　　</dependency>
　　　　<dependency>
　　　　　　<groupId>ch.qos.logback</groupId>
　　　　　　<artifactId>logback-classic</artifactId>
　　　　　　<version>${logback.version}</version>
　　　　　　</dependency>
　　</dependencies>

　　二、logback.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定義日誌文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
<property name="LOG_HOME" value="/home" />
<!-- 控制檯輸出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<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>
</encoder>
</appender>
<!-- 按照天天生成日誌文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日誌文件輸出的文件名-->
<FileNamePattern>${LOG_HOME}/TestWeb.log.%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>
</encoder>
<!--日誌文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>

<!-- 日誌輸出級別 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
</root>
</configuration>

　　三、java代碼

　　/**
　　* Hello world!
　　*/
　　public class App {

　　private final static Logger logger = LoggerFactory.getLogger(App.class);

　　　　public static void main(String[] args) {
　　　　　　logger.info("logback 成功了");
　　　　　　logger.error("logback 成功了");
　　　　　　logger.debug("logback 成功了");
　　　　}
　　}

個人logback.xml經常使用配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds">
<property name="LOG_HOME" value="../log2" />
	<!-- Simple file output -->
	<appender name="FILE"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<!-- encoder defaults to ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
		<encoder>
			<pattern>
				[ %-5level] [%date{yyyy-MM-dd HH:mm:ss.SSS}] %logger{96} [%line] [%thread]- %msg%n
			</pattern>

			<charset>UTF-8</charset> <!-- 此處設置字符集 -->
		</encoder>
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<!-- rollover daily 配置日誌所生成的目錄以及生成文件名的規則 -->
			<fileNamePattern>${LOG_HOME}/log_%d{yyyyMMdd}.%i.log</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy
				class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
				<!-- or whenever the file size reaches 64 MB -->
				<maxFileSize>64 MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy>
			<maxHistory>30</maxHistory>
		</rollingPolicy>


		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>INFO</level>
		</filter>
		<!-- Safely log to the same file from multiple JVMs. Degrades performance! -->
		<prudent>false</prudent>
	</appender>


	<!-- Console output -->
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<!-- encoder defaults to ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
		<encoder>
			<pattern>
				[ %-5level] [%date{yyyy-MM-dd HH:mm:ss.SSS}] %logger{96} [%line] [%thread]- %msg%n
			</pattern>
			<charset>UTF-8</charset> <!-- 此處設置字符集 -->
		</encoder>
		<!-- Only log level WARN and above -->
		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>INFO</level>
		</filter>
	</appender>
	
	<!-- 郵件監控異常 -->
<!--	<appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
		<smtpHost>smtp.163.com</smtpHost>
		<username>cairs-2w010@163.com</username>
		<password>zxc1s2dsa46</password>
		<from>cairs-2010@163.com</from>
		<to>403411d876@qq.com</to>
		<subject>【web-ext-Error】: %logger</subject>
	 <layout class="ch.qos.logback.classic.html.HTMLLayout"/>	
		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>ERROR</level>
		</filter>
	</appender>-->

	<!-- Enable FILE and STDOUT appenders for all log messages. By default, 
		only log at level INFO and above. -->
	<root level="INFO">
		<appender-ref ref="FILE" />
		<!--<appender-ref ref="STDOUT" />-->
		<!--<appender-ref ref="EMAIL" />-->
	</root>

	<!-- For loggers in the these namespaces, log at all levels. -->
	<!-- <logger name="pedestal" level="ALL" /> <logger name="hammock-cafe" 
		level="ALL" /> <logger name="user" level="ALL" /> -->
</configuration>
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程