1. 程式人生 > >Log4j的郵件傳送類SMTPAppender功能增強

Log4j的郵件傳送類SMTPAppender功能增強

  在開發過程中,我們有時需要將重要的錯誤日誌通過郵件傳送給相關的責任人,這樣能即時發現錯誤,即時解決。如使用Log4J,一般會做如下配置:
  
  log4j.rootLogger = debug,mail
  
  # 傳送日誌到指定郵件
  
  log4j.appender.mail=org.apache.log4j.net.SMTPAppender
  
  log4j.appender.mail.Threshold=INFO
  
  log4j.appender.mail.BufferSize=10
  
  [email protected]
  
  [email protected]
  
  log4j.appender.mail.SMTPHost=smtp.qq.com
  
  #傳送郵件箱的使用者
  
  [email protected]
  
  #郵箱的授權碼
  
  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 時,觸發回撥函式,啟動傳送郵件任務。
  
  改造步驟:
  
  定義回撥介面AlertWillBeFull
  
  自定義同步佇列 AlertLinkedBlockingQueue ,繼承 LinkedBlockingQueue ,新增成員變數factor及回撥介面,在所有新增動作之前進行判斷是否達到閥值。
  
  去掉SMTPAppender類中的實現類DefaultEvaluator及所有呼叫它的地方
  
  在建立快取同步佇列時,傳入回撥物件,等待同步佇列呼叫
  
  新增日誌到快取同步佇列和從快取同步佇列讀取日誌分別使用offer和poll方法,不阻塞執行緒也不拋異常,以免影響實際業務進行,而且少少量日誌影響也不大。
  
  傳送的日誌比較雜亂,需要排除某些包下的日誌(比如有些不重要的日誌,或者只想看某些包下的日誌
  
  解決方法:新增成員變數excludePackage和includePackage,修改checkEntryConditions方法邏輯
  
  這樣就能在log4j.properties配置檔案中配置快取大小,以及新增排除或只關心的記錄日誌的包,也可以新增多個傳送郵件的配置,將不同包下的日誌傳送給不同的責任人。
  
  最終配置如下:
  
  log4j.rootLogger = debug,mail
  
  # 傳送日誌到指定郵件
  
  log4j.appender.mail=org.apache.log4j.net.SMTPAppender
  
  #排除的包(多個包,以英文逗號隔開)
  
  #log4j.appender.mail.excludePackage=com.www.mingcheng178.com/ alibaba.druid
  
  #僅關心的包,一般excludePackage與includePackage任選一即可,多個包以英文逗號隔開
  
  log4j.appender.mail.includePackage=cn.www.michenggw.com/ yang.practise.service,cn.yang.practise.controller,com.alibaba.druid
  
  log4j.appender.mail.Threshold=INFO
  
  log4j.appender.mail.BufferSize=16
  
  [email protected]
  
  [email protected]
  
  log4j.appender.www.mhylpt.com mail.SMTPHost=smtp.qq.com
  
  #傳送郵件箱的使用者
  
  [email protected]
  
  #郵箱的授權碼
  
  log4j.appender.mail.SMTPPassword=
  
  改造後完整後的org.apache.log4j.net.SMTPAppender,AlertLinkedBlockingQueue