在開發過程中,我們有時需要將重要的錯誤日志通過郵件發送給相關的責任人,這樣能即時發現錯誤,即時解決。如使用Log4J,一般會做如下配置:
log4j.rootLogger = debug,mail
# 發送日志到指定郵件
log4j.appender.mail=org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold=INFO
log4j.appender.mail.BufferSize=10
log4j.appender.mail.From=from@qq.com
log4j.appender.mail.To=to@163.com
log4j.appender.mail.SMTPHost=smtp.qq.com
#發送郵件箱的用戶
log4j.appender.mail.SMTPUsername=from@qq.com
#郵箱的授權碼
log4j.appender.mail.SMTPPassword=
但是我在使用過程中發現標準的org.apache.log4j.net.SMTPAppender有如下幾個問題。
- 同步發送郵件。這樣會阻塞業務正常進行(比如等待一個SQL查詢,需要等待郵件發送后才顯示結果,顯然不能忍受)
解決辦法: 使用線程池的方式,將發送郵件包裝成Runnable任務,送到線程池中執行。同步隊列我選擇的是設置了固定大小的LinkedBlockingQueue,設置固定大小是因為需要發郵件的重要日志不是太多,二是不能因為郵件任務占用了太多的內存;選擇LinkedBlockingQueue,是因為LinkedBlockingQueue讀寫鎖分離,可以邊添加任務,邊發送郵件;核心線程數和最大線程數,可以根據業務量和CPU核數設定。
- 緩存大小bufferSize(日志事件的個數)只是設置緩存大小,并不能等到緩存滿時才發送(其實是只要有發生ERROR級別及以上的的事件時就將緩存中保存的所有滿足threshold級別的日志都發送,在發送之前緩存滿時會從頭開始,新的日志覆蓋舊的)
解決辦法: 去掉默認實現類CyclicBuffer,改成同步隊列;因為CyclicBuffer線程不安全,添加日志和獲取日志并不是同一個線程,所以采用了線程安全的同步隊列,而且還需要實現當同步隊列中日志快滿時將觸發發送郵件;所以需要自定義同步隊列,加上一個閥值factor,當同步隊列中的日志個數達到bufferSize*factor時就發送郵件,這樣可以預留一部分空間存放后添加進來的日志;同步隊列我選擇的是 LinkedBlockingQueue,可以邊添加日志,邊讀取日志,吞吐量比較大。目前發送郵件觸發的條件是:發生了 ERROR 或 ERROR以上級別 的錯誤時發送郵件,改成當緩存同步隊列中元素個數大于或等于 bufferSize*factor 時,觸發回調函數,啟動發送郵件任務。
改造步驟:
1. 定義回調接口AlertWillBeFull
2. 自定義同步隊列 AlertLinkedBlockingQueue ,繼承 LinkedBlockingQueue ,添加成員變量factor及回調接口,在所有添加動作之前進行判斷是否達到閥值。
3. 去掉SMTPAppender類中的實現類DefaultEvaluator及所有調用它的地方
4. 在創建緩存同步隊列時,傳入回調對象,等待同步隊列調用
5. 添加日志到緩存同步隊列和從緩存同步隊列讀取日志分別使用offer和poll方法,不阻塞線程也不拋異常,以免影響實際業務進行,而且少少量日志影響也不大。
- 發送的日志比較雜亂,需要排除某些包下的日志(比如有些不重要的日志,或者只想看某些包下的日志
解決方法:添加成員變量excludePackages和includePackages,修改checkEntryConditions方法邏輯
這樣就能在log4j.properties配置文件中配置緩存大小,以及添加排除或只關心的記錄日志的包,也可以添加多個發送郵件的配置,將不同包下的日志發送給不同的責任人。
最終配置如下:
log4j.rootLogger = debug,mail
# 發送日志到指定郵件
log4j.appender.mail=org.apache.log4j.net.SMTPAppender
#排除的包(多個包,以英文逗號隔開)
#log4j.appender.mail.excludePackage=com.alibaba.druid
#僅關心的包,一般excludePackage與includePackage任選一即可,多個包以英文逗號隔開
log4j.appender.mail.includePackage=cn.yang.practise.service,cn.yang.practise.controller,com.alibaba.druid
log4j.appender.mail.Threshold=INFO
log4j.appender.mail.BufferSize=16
log4j.appender.mail.From=from@qq.com
log4j.appender.mail.To=to@163.com
log4j.appender.mail.SMTPHost=smtp.qq.com
#發送郵件箱的用戶
log4j.appender.mail.SMTPUsername=from@qq.com
#郵箱的授權碼
log4j.appender.mail.SMTPPassword=
改造后完整后的org.apache.log4j.net.SMTPAppender,AlertLinkedBlockingQueue