開發(fā)者必知的日志記錄最佳實踐
當前位置：點晴教程→知識管理交流
→『 技術文檔交流 』
??對程序來說，良好的日志風格能夠極大的降低排錯的成本，增強程序的健壯性與可運維性，但大多數(shù)開發(fā)同學并沒有將日志的重要性提的和代碼本身一樣高，本文討論我個人記錄日志的一些最佳實踐 基本原則將日志作為程序的第二個UI??軟件的第一UI當然是使用方或API調(diào)用方，而日志作為第二UI，用于開發(fā)、運維、合作方進行線上應用狀態(tài)的檢測與問題排查。日志的質(zhì)量是代碼質(zhì)量的一部分。 寫日志時，考慮看日志的人無法訪問代碼??通常來說，看日志的角色不僅僅是開發(fā)代碼的人員，包括線上值班人員、售后人員、其他合作方系統(tǒng)的人員，可能都需要依賴日志排查問題。今天的IT系統(tǒng)日志更容易收集后中心化，使得不同角色可以更容易訪問日志。對于API，尤其是涉及其他多個子系統(tǒng)調(diào)用的復雜API，良好的日志可以為調(diào)用方、線上值班提供豐富的問題排查依據(jù)，在代碼中打印日志時要考慮無法訪問代碼的角色。 日志的主要用戶是Human，次要用戶是機器，所以可讀性很重要??可讀性包含的內(nèi)容很多，下面會解釋一些原則，但最基本的原則是縮進、空格等需要讓閱讀者易于閱讀。同時日志格式也保證易于模式化解析（簡單的字符串匹配，而不是復雜的正則） 考慮日志的目的是什么??日志的目的不僅僅是線上Debug，也可以是記錄性能或是收集后做數(shù)據(jù)分析，考慮日志在系統(tǒng)的目的，寫日志時具備一定針對性。 最佳實踐為日志添加上下文??非常General的日志是非常糟糕的，不僅無助于定位問題，更容易造成混淆。比如下面這個日志：
無法定位是哪段代碼，連接什么失敗，也不知道失敗的參數(shù)是什么，更好的日志格式如下：
類似問題還比如:
對于日志，盡量避免太general的日志，記得我們的原則，知道我們的第二個UI的目標受眾是誰，看日志的人大多數(shù)可能無法訪問代碼。 端到端的日志&并發(fā)線程日志問題每個請求都需要有一個唯一標識符與之對應，通常是一個GUID，主要用于兩個用途
1.在不同系統(tǒng)或微服務間唯一標識一個請求
2.同一個應用內(nèi)不同并發(fā)線程唯一標識一個請求 比如我們可以通過下面一個GUID追蹤的一個請求完整的過程 變量值與常量值分開將變量值與常量值分開可以使得日志更容易閱讀，無論在代碼還是日志本身的搜索也會變的簡單，如果用工具抽取參數(shù)值也變的簡單，下面是一個示例: 如果URL是一個很長的串，那么閱讀的體驗將會非常糟糕。 區(qū)分Warn與Error日志按照嚴重性同樣也會分級，業(yè)界標準使用最多的還是Info、Warn與Error。Info通常沒什么說的，程序符合預期正常工作，在過程中記錄相關信息，就是Info，Warn和Error值得提一下。
Warn意味著程序正常工作，但存在一些問題，這種問題通常在我們預期之內(nèi)。
Error意味著程序異常，且這種異常不在我們預期內(nèi)。 下面是一個程序中調(diào)用其他服務的簡單例子：
如果可能，出錯時附上KB或錯誤代號寫程序的人通常對程序所代表的業(yè)務有一定了解，但其他日志用戶可能并沒有背景知識以及業(yè)務限制，在有限的日志中通常很難說清楚，如果有對應KB或幫助文檔，以及錯誤代號，可以附在日志中，幫助日志用戶快速了解背景。比如下面這個例子：
避免記錄敏感信息??日志并不會像數(shù)據(jù)庫那樣有高安全等級，也就是訪問日志的安全權限通常遠遠低于其他應用，且今天的日志更多是上傳后中心化，更無法控制日志的擴散范圍，因此對于敏感信息請不要記錄，包括密碼信息、Security Token信息、敏感身份信息等。 使用英文記錄日志??英文記錄不僅僅是標準化和易于閱讀的問題，而是今天的IT系統(tǒng)，日志可能經(jīng)過多個系統(tǒng)中心化，這些系統(tǒng)只要有一個不支持UTF格式，就可能導致亂碼，使用英文可以盡量避免這些麻煩。 小結(jié)??對于程序來說，代碼質(zhì)量除了代碼本身，還包括日志。將日志當做程序的第二UI認真對待，不僅能使得我們的程序調(diào)試與開發(fā)成本大幅下降，還能使得程序的運維排錯更加簡潔，Bug更早發(fā)現(xiàn)。 ?轉(zhuǎn)自https://www.cnblogs.com/CareySon/p/18757020/Logging_best_practice_for_developer 該文章在 2025/3/10 9:43:32 編輯過 |
關鍵字查詢
相關文章
正在查詢... 
|
400 186 1886
