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