轉自:http://www.crazyant.net/1931.html
隨着項目規模的越來越大,會不斷的引入新的模塊,不同的模塊都會打印自己的日志,最后就造成日志根本沒法查看,比如我自己的項目中,就存在以下這些日志:
- 接收外界消息的日志、對外發送消息的日志;
- 后台常駐線程的處理日志;
- 外部接口訪問的參數、返回結果等接口日志;
- Service訪問數據庫產生的SQL日志;
這其中,消息日志和后台線程的日志數據量非常龐大,如果所有日志打印在一個文件中,使用tail -f log.log文件,會發現日志在快速的滾動,根本無法查看甚至定位某一個具體的SQL或者Service訪問日志。
解決方法就是可以將不同的日志加以分類輸出,這樣相互的日志不影響,尤其重要的接口訪問日志,能夠很方便的定位和排查問題。
步驟1:在log4j.properties中配置
先貼一下我自己所有的log4j.properties配置:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
log4j.rootLogger=INFO, console, file
log4j.appender.console=net.czt.log.AsyncConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d [%t] %-5p crazyant-web %-17c{2} (%13F:%L) %X{USER_ID}|%X{USER_IP}|%X{SERVER_ADDRESS}|%X{SERVER_NAME}|%X{REQUEST_URI}|%X{SESSION_ID} - %m%n
log4j.appender.console.bufferSize=10000
log4j.appender.console.encoding=UTF-8
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.file=/home/work/apache-tomcat-6.0.39/logs/crazyant.log
log4j.appender.file.MaxBackupIndex=5
log4j.appender.file.MaxFileSize=1GB
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%-5p] crazyant-web %d{yyyy-MM-dd HH:mm:ss,SSS} %X{USER_ID}|%X{USER_IP}|%X{SERVER_ADDRESS}|%X{SERVER_NAME}|%X{REQUEST_URI}|%X{SESSION_ID} method:%l%n%m%n
log4j.appender.file.bufferSize=10000
log4j.appender.file.encoding=UTF-8
log4j.logger.net.czt.crazyant.msg=DEBUG, message
log4j.additivity.net.czt.crazyant.msg=false
log4j.appender.message=org.apache.log4j.RollingFileAppender
log4j.appender.message.File=/home/work/apache-tomcat-6.0.39/logs/crazyant_message.log
log4j.appender.message.Append=true
log4j.appender.message.MaxFileSize=1GB
log4j.appender.message.MaxBackupIndex=5
log4j.appender.message.layout=org.apache.log4j.PatternLayout
log4j.appender.message.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] [%t] - %m%n
log4j.appender.message.encoding=UTF-8
log4j.logger.net.czt.crazyant.async.service=DEBUG, async
log4j.additivity.net.czt.crazyant.async.service=false
log4j.appender.async=org.apache.log4j.RollingFileAppender
log4j.appender.async.File=/home/work/apache-tomcat-6.0.39/logs/crazyant_async.log
log4j.appender.async.Append=true
log4j.appender.async.MaxFileSize=1GB
log4j.appender.async.MaxBackupIndex=5
log4j.appender.async.layout=org.apache.log4j.PatternLayout
log4j.appender.async.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] [%t] - %m%n
log4j.appender.async.encoding=UTF-8
log4j.logger.net.czt.orm.mybatis.SqlMonitorManager=DEBUG, showsql
log4j.additivity.net.czt.orm.mybatis.SqlMonitorManager=false
log4j.logger.net.czt.transaction.interceptor.SmartTransactionInterceptor=DEBUG, showsql
log4j.additivity.net.czt.transaction.interceptor.SmartTransactionInterceptor=false
log4j.appender.showsql=org.apache.log4j.RollingFileAppender
log4j.appender.showsql.File=/home/work/apache-tomcat-6.0.39/logs/crazyant_sql.log
log4j.appender.showsql.Append=true
log4j.appender.showsql.MaxFileSize=1GB
log4j.appender.showsql.MaxBackupIndex=5
log4j.appender.showsql.layout=org.apache.log4j.PatternLayout
log4j.appender.showsql.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] [%t] - %m%n
log4j.appender.showsql.encoding=UTF-8
log4j.logger.net.czt.crazyant.service=DEBUG, service
log4j.additivity.net.czt.crazyant.service=false
log4j.appender.service=org.apache.log4j.RollingFileAppender
log4j.appender.service.File=/home/work/apache-tomcat-6.0.39/logs/crazyant_service.log
log4j.appender.service.Append=true
log4j.appender.service.MaxFileSize=1GB
log4j.appender.service.MaxBackupIndex=5
log4j.appender.service.layout=org.apache.log4j.PatternLayout
log4j.appender.service.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] [%t] - %m%n
log4j.appender.service.encoding=UTF-8
|
在配置文件的下方,可以方便的看到,我將message(消息)、async(后端線程)、showsql(數據庫日志)、service(接口調用)分別輸出到了不同的日志文件。
其中的一些解釋:
log4j.rootLogger=INFO, console, file
log4j有一個rootLogger和普通Logger的概念,默認情況下我們只需要一個rootLogger,就是所有的日志只會輸出到這一個日志文件中。
看一下普通Logger的配置(以接口日志service為例):
- log4j.logger.net.czt.crazyant.service=DEBUG, service
- 這句中的”net.czt.crazyant.service”,表示該普通logger日志配置生效的package的完全路徑
- 其中色service,表示該普通logger的名字
- log4j.additivity.net.czt.crazyant.service=false
- 其中的”net.czt.crazyant.service”,和上面的相同,表示該配置項針對的package
- 該句配置的意思,是不要將該package的日志輸出到rootLogger日志中,只輸出到自己配置的日志就行了;
- log4j.appender.service=org.apache.log4j.RollingFileAppender,以及該配置段下面的配置項
- 這里的”service”字符串,和上面的第一個配置項的”service”相同,表示對該普通Logger的配置;
- 下方的配置項和rootLogger相同,表示每天輸出文件、編碼UTF8、分片規則、每行的輸出模式等等
我自己遇到的問題,是上面的log4j.properties配置好以后,發現各個日志文件創建了,但是里面都沒有內容,這是為啥呢?來看下面第二個注意的地方;
步驟2、輸出日志時需要設定日志對象對應的具體Class
什么意思呢?上面的配置項中,有一個”net.czt.crazyant.service”的package字符串,那么我們自己想一下,log4j是怎樣將不同package中的logger日志輸出到不同文件呢,想一下會有兩種方法:
- 采用intercepter或者aop的方式,log4j自己檢測日志輸出,檢測到日志產生於哪個package,就將其輸出到對應文件中;
- 由用戶傳一個Class參數,log4j獲取該Class對應的Package,以此為准,來定位不同的日志文件;
看一下代碼,顯然log4j用的是后一種簡單直接的方式:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
public class MyClassImpl implements MyClass {
/**
* loger
*/
private static final Log logger = LogFactory.getLog(MyClassImpl.class);
/**
* my func
*/
public void myfunc() {
logger.info("call method myfunc.");
}
}
|
在logger = LogFactory.getLog(MyClassImpl.class)中,傳入了使用該logger的Class參數,而該Class被反射取到的package地址,就是log4j用來輸出日志的package地址。
這種做法也有強大的地方,方便邏輯上的日志歸類,比如很多代碼不屬於一個package,但是它們邏輯上屬於一起的,舉個例子,消息的處理不只是接口調用Service這個package,可能還會調用發送msg的操作,如果想把msg的package中一些日志也輸出到Service,那么在這個msg的logger初始化的時候,傳入一個Serivice的Class就行了。
或者對於某一類的所有日志來說,它們所有的logger對象,都來自封裝好的單個對象實例即可,而這個單個對象實例傳入的參數只有一個,用於標識這個邏輯歸類即可。
總結
在Log4j.properties中,支持package或者具體class的日志單獨輸出,但是也需要代碼中logger初始化的時候,能和日志配置中的package對應上。