工作總結!日誌打印的 15 個建議
前言
大家好,我是程序員田螺。日誌是快速定位問題的好幫手,是撕逼和甩鍋的利器!打印好日誌非常重要。今天我們來聊聊日誌打印的 15 個好建議~
- 選擇恰當的日誌級別
常見的日誌級別有 5 種,分別是 error、warn、info、debug、trace。日常開發中,我們需要選擇恰當的日誌級別,不要反手就是打印 info 哈~
-
error:錯誤日誌,指比較嚴重的錯誤,對正常業務有影響,需要運維配置監控的;
-
warn:警告日誌,一般的錯誤,對業務影響不大,但是需要開發關注;
-
info:信息日誌,記錄排查問題的關鍵信息,如調用時間、出參入參等等;
-
debug:用於開發 DEBUG 的,關鍵邏輯裏面的運行時數據;
-
trace:最詳細的信息,一般這些信息只記錄到日誌文件中。
- 日誌要打印出方法的入參、出參
我們並不需要打印很多很多日誌,只需要打印可以快速定位問題的有效日誌。有效的日誌,是甩鍋的利器!
哪些算得的上有效關鍵的日誌呢?比如說,方法進來的時候,打印入參。再然後呢,在方法返回的時候,就是打印出參,返回值。入參的話,一般就是 userId 或者 bizSeq 這些關鍵信息。正例如下:
public String testLogMethod(Document doc, Mode mode){
log.debug(“method enter param:{}”,userId);
String id = "666";
log.debug(“method exit param:{}”,id);
return id;
}
- 選擇合適的日誌格式
理想的日誌格式,應當包括這些最基本的信息:如當前時間戳(一般毫秒精確度)、日誌級別,線程名字等等。在 logback 日誌裏可以這麼配置:
<appender >
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern>
</encoder>
</appender>
如果我們的日誌格式,連當前時間都沒有記錄,那連請求的時間點都不知道了?
- 遇到 if...else... 等條件時,每個分支首行都儘量打印日誌
當你碰到 if...else... 或者 switch 這樣的條件時,可以在分支的首行就打印日誌,這樣排查問題時,就可以通過日誌,確定進入了哪個分支,代碼邏輯更清晰,也更方便排查問題了。
正例:
if(user.isVip()){
log.info("該用戶是會員,Id:{},開始處理會員邏輯",user,getUserId());
//會員邏輯
}else{
log.info("該用戶是非會員,Id:{},開始處理非會員邏輯",user,getUserId())
//非會員邏輯
}
- 日誌級別比較低時,進行日誌開關判斷
對於 trace/debug 這些比較低的日誌級別,必須進行日誌級別的開關判斷。
正例:
User user = new User(666L, "公衆號", "撿田螺的小男孩");
if (log.isDebugEnabled()) {
log.debug("userId is: {}", user.getId());
}
因爲當前有如下的日誌代碼:
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
如果配置的日誌級別是 warn 的話,上述日誌不會打印,但是會執行字符串拼接操作,如果symbol
是對象, 還會執行toString()
方法,浪費了系統資源,執行了上述操作,最終日誌卻沒有打印,因此建議加日誌開關判斷。
- 不能直接使用日誌系統(Log4j、Logback)中的 API,而是使用日誌框架 SLF4J 中的 API。
SLF4J 是門面模式的日誌框架,有利於維護和各個類的日誌處理方式統一,並且可以在保證不修改代碼的情況下,很方便的實現底層日誌框架的更換。
正例:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(TianLuoBoy.class);
- 建議使用參數佔位 {},而不是用 + 拼接。
反例:
logger.info("Processing trade with id: " + id + " and symbol: " + symbol);
上面的例子中,使用+
操作符進行字符串的拼接,有一定的性能損耗。
正例如下:
logger.info("Processing trade with id: {} and symbol : {} ", id, symbol);
我們使用了大括號{}
來作爲日誌中的佔位符,比於使用+
操作符,更加優雅簡潔。並且,相對於反例,使用佔位符僅是替換動作,可以有效提升性能。
- 建議使用異步的方式來輸出日誌。
-
日誌最終會輸出到文件或者其它輸出流中的,IO 性能會有要求的。如果異步,就可以顯著提升 IO 性能。
-
除非有特殊要求,要不然建議使用異步的方式來輸出日誌。以 logback 爲例吧,要配置異步很簡單,使用 AsyncAppender 就行
<appender >
<appender-ref ref="ASYNC"/>
</appender>
- 不要使用 e.printStackTrace()
反例:
try{
// 業務代碼處理
}catch(Exception e){
e.printStackTrace();
}
正例:
try{
// 業務代碼處理
}catch(Exception e){
log.error("你的程序有異常啦",e);
}
理由:
-
e.printStackTrace() 打印出的堆棧日誌跟業務代碼日誌是交錯混合在一起的,通常排查異常日誌不太方便。
-
e.printStackTrace() 語句產生的字符串記錄的是堆棧信息,如果信息太長太多,字符串常量池所在的內存塊沒有空間了, 即內存滿了,那麼,用戶的請求就卡住啦~
- 異常日誌不要只打一半,要輸出全部錯誤信息
反例 1:
try {
//業務代碼處理
} catch (Exception e) {
// 錯誤
LOG.error('你的程序有異常啦');
}
- 異常 e 都沒有打印出來,所以壓根不知道出了什麼類型的異常。
反例 2:
try {
//業務代碼處理
} catch (Exception e) {
// 錯誤
LOG.error('你的程序有異常啦', e.getMessage());
}
e.getMessage()
不會記錄詳細的堆棧異常信息,只會記錄錯誤基本描述信息,不利於排查問題。
正例:
try {
//業務代碼處理
} catch (Exception e) {
// 錯誤
LOG.error('你的程序有異常啦', e);
}
- 禁止在線上環境開啓 debug
禁止在線上環境開啓 debug,這一點非常重要。
因爲一般系統的 debug 日誌會很多,並且各種框架中也大量使用 debug 的日誌,線上開啓 debug 不久可能會打滿磁盤,影響業務系統的正常運行。
- 不要記錄了異常,又拋出異常
反例如下:
log.error("IO exception", e);
throw new MyException(e);
-
這樣實現的話,通常會把棧信息打印兩次。這是因爲捕獲了 MyException 異常的地方,還會再打印一次。
-
這樣的日誌記錄,或者包裝後再拋出去,不要同時使用!否則你的日誌看起來會讓人很迷惑。
- 避免重複打印日誌
避免重複打印日誌,醬紫會浪費磁盤空間。如果你已經有一行日誌清楚表達了意思,避免再冗餘打印,反例如下:
if(user.isVip()){
log.info("該用戶是會員,Id:{}",user,getUserId());
//冗餘,可以跟前面的日誌合併一起
log.info("開始處理會員邏輯,id:{}",user,getUserId());
//會員邏輯
}else{
//非會員邏輯
}
如果你是使用 log4j 日誌框架,務必在log4j.xml
中設置 additivity=false,因爲可以避免重複打印日誌
正例:
<logger >
- 日誌文件分離
-
我們可以把不同類型的日誌分離出去,比如 access.log,或者 error 級別 error.log,都可以單獨打印到一個文件裏面。
-
當然,也可以根據不同的業務模塊,打印到不同的日誌文件裏,這樣我們排查問題和做數據統計的時候,都會比較方便啦。
- 核心功能模塊,建議打印較完整的日誌
-
我們日常開發中,如果核心或者邏輯複雜的代碼,建議添加詳細的註釋,以及較詳細的日誌。
-
日誌要多詳細呢?腦洞一下,如果你的核心程序哪一步出錯了,通過日誌可以定位到,那就可以啦。
本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源:https://mp.weixin.qq.com/s/D7rye88cki8rXMg0v1-dVw