應用系統日記打印標準理論之道

若是你是一名優(yōu)良的應用系統開(kāi)發(fā)人員，想必應該十分清晰在應用系統運行期間，打印日記有多么重要。它不單可以記錄應用系統運行情況及軌跡，還有助于提拔毛病排查及定位問(wèn)題的效率，以至還能夠對其停止闡發(fā)及監控，洞察系統隱患，提早預警防備。

但并非說(shuō)只要打印盡可能多的日記，就能輕松獲得那些才能。設想一下，若是你毫無(wú)所懼地打印了一堆毫無(wú)價(jià)值的日記，那請問(wèn)日記又何以可以來(lái)為你供給價(jià)值呢。由此可見(jiàn)，那里的核心關(guān)鍵點(diǎn)其實(shí)不在于日記的幾，而在于日記打印能否標準且合理。

不標準合理的日記，不單無(wú)法闡揚感化產(chǎn)生價(jià)值，還會(huì )增加毛病定位難度、降低處理效率，以及額外增加日記存儲成本，消耗應用系統性能。在極端情況下，以至還會(huì )對應用系統形成致命性沖擊，引發(fā)應用系統癱瘓的可能。

講到那，我想你應該大白我想說(shuō)的——應用系統日記打印確實(shí)十分重要，但日記打印標準將更為重要，它就像一把雙刃劍，只要合理運用才氣闡揚其特有的感化及價(jià)值。

但在組織中，若是你想讓你四周的人都能大白那個(gè)事理可其實(shí)不容易，它需要一個(gè)漫長(cháng)的傳布過(guò)程，而在那個(gè)過(guò)程中，你不只需要對峙不竭地宣導來(lái)逐漸加強他們的認知，還應借助需要的治理手段及東西平臺停止輔助，只要利其所器，才氣善其所事。

利器一：標準先行

在你想啟動(dòng)標準化日記打印前，建議先造定一份日記打印標準，它可能無(wú)法八面玲瓏，但沒(méi)有關(guān)系，它的目標僅是為了先突顯日記打印標準的重要性，而且讓那件工作可以正式進(jìn)入正軌。

若是組織中大部門(mén)都是Java應用，那么標準內容能夠次要圍繞Java應用來(lái)寫(xiě)，固然無(wú)法籠蓋所有開(kāi)發(fā)語(yǔ)言，但其核心原則仍是能夠借鑒的。別的，前期請務(wù)必不要將其復雜化，不然它將無(wú)法具備普適性，也無(wú)法被承受和傳布。

Java應用系統日記打印標準

1）Java日記框架

常用的Java日記框架可選擇Log4j/Logback/Log4j2等，但為了制止后續改換日記框架所帶來(lái)的額外革新成本，建議將接口層和實(shí)現層停止別離，將SLF4J做為接口層，將Log4j/Logback/Log4j2做為實(shí)現層，兩者通過(guò)橋接的體例停止集成。

2）Java日記標準

標準一：【強迫】級別只允許利用ERROR、WARN、INFO、DEBUG，定義如下：

標準二：【強迫】制止利用Logback/Log4j2等的API，應利用SLF4J的API。

標準三：【強迫】在接口/辦法的入口/出口處，打印懇求及響應參數日記。

標準四：【強迫】ERROR級別日記需打印倉庫，而非ERROR級別日記則不需要。

標準五：【強迫】制止在代碼輪回體中間接打印非DEBUG級此外日記。

標準六：【強迫】制止日記打印內容中僅打印特殊字符或數字的情況。

標準七：【建議】日記內容中應包羅關(guān)鍵特征類(lèi)信息，例如：用戶(hù)標識或流水號。

標準八：【建議】應接納異步打印形式，且打印時(shí)建議封閉打印位置信息。

標準九：【建議】日記打印若呈現梗塞，建議至少丟棄INFO級別以上的日記。

標準十：【建議】每條日記在語(yǔ)義上可獨立被理解，削減上下文聯(lián)系關(guān)系理解。

*）Java日記字段

注：位置信息包羅類(lèi)(class)/文件(file)/行號(line)/辦法(method)，若打印位置信息，則對性能有所影響。

以上僅是一些標準參考，你能夠按照組織中的現實(shí)情況來(lái)停止調整，但標準僅僅只是標準，有了它其實(shí)不代表你已達成目的，只能申明你已為日記打印標準化那件事，邁出了第一步。

利器二：辦事至上

當造定完應用系統日記打印標準后，請不要夢(mèng)想有任何人會(huì )來(lái)自覺(jué)地遵守它，一是不知它的存在，二是他們無(wú)從下手，三是各人都挺“忙”的。我把它總結為六字實(shí)言，別離是“不知”、“不會(huì )”、“不想”。

我曾見(jiàn)過(guò)組織中的有些標準，出格是手藝標準，在造定完成后就會(huì )被長(cháng)久地封存起來(lái)，沒(méi)有人曉得，也沒(méi)有人想曉得。所以，要落實(shí)好標準，你還得構想一套戰術(shù)才行。不然，那些無(wú)法落實(shí)的標準就和廢紙毫無(wú)兩樣。

在良多人眼里，可能會(huì )將標準視為是一種約束，而又錯誤地將約束理解為貶義詞，從而避而遠之。那種曲解的發(fā)作，其原因其實(shí)不出在他們自己，而更多的出在那些造定例范的人身上。

有些標準造定者不單沒(méi)有身在此中，以至也沒(méi)有去詮釋標準所能帶來(lái)的價(jià)值，而僅僅只是強行推行那份冷冰冰的標準，請問(wèn)此時(shí)誰(shuí)會(huì )愿意在不知其所以然的情況下，無(wú)緣無(wú)故地背上那繁重的“承擔”。

因而，你必需得為那份標準付與更多的“溫度”，而主動(dòng)辦事可能會(huì )是一種比力好的“升溫”體例。但在動(dòng)作前，切忌不要站在他們的對立面，并請做好放低姿勢的覺(jué)悟，你要讓對方深入的意識到你和他們是統一陣營(yíng)的。

在發(fā)布標準后的初期，你能夠測驗考試挑選幾個(gè)日記打印情況最為蹩腳的應用系統，飾演為“VIP私家助理”來(lái)與對方進(jìn)一步傳達標準內容及感化，并為他們一一列舉出當前存在的日記打印問(wèn)題，以及那些問(wèn)題會(huì )對系統形成哪些影響。

那種體例不單可以制止僅用文字傳達所產(chǎn)生的理解誤差，及時(shí)有效地為對方解答各類(lèi)疑問(wèn)，使他們可以更深一步天文解標準內容及感化，還可以讓標準造定者更進(jìn)一步地領(lǐng)會(huì )對方的顧忌及困難，并從同理心視角動(dòng)身，為對方供給更好的建議及處理思緒。

就如許*個(gè)、10個(gè)、1*個(gè)應用系統......在精神有限的前提下逐漸擴大輻射范疇，事實(shí)證明，那種主動(dòng)辦事+循序漸進(jìn)的體例對提拔標準的承受度將會(huì )有所幫忙。不外在過(guò)程中你仍然需要不竭回看標準的合理性及適用性，并對標準做出及時(shí)且有效的調整。

利器三：度量為王

當標準逐步被更多的人承受后，你的任務(wù)并沒(méi)有完成，而實(shí)正的考驗才剛剛起頭。一是承受其實(shí)不代表整改，二是若何驗證整改有效性，三是整改能否可持續性。若是那些問(wèn)題都不在你的考慮范疇內，那你可能會(huì )前功盡棄。

若想要處理以上那些問(wèn)題，借助度量或許會(huì )是一個(gè)不錯的選擇。辦理巨匠德魯克曾說(shuō)過(guò)：“沒(méi)有度量，就沒(méi)有辦理”，它同樣適用于標準的落實(shí)工做，你能夠按照日記打印標準來(lái)造定一些度量目標，并配套研發(fā)響應的度量東西平臺。

通過(guò)度量東西平臺“可視化”和“自助化”的兩種特征，閃開(kāi)發(fā)人員可以及時(shí)發(fā)現日記打印標準的問(wèn)題，還可以讓他們自主驗證日記打印標準整改后的效果，從而讓他們感觸感染到一種“看得見(jiàn)”+“摸得著(zhù)”的平安感。

此中，度量目標的設想將會(huì )尤其重要，往往一個(gè)不合理的目標，會(huì )讓整個(gè)工作朝著(zhù)料想中的反標的目的開(kāi)展。所以，在初期其實(shí)不建議你設想過(guò)多的度量目標，并建議從度量難度、影響水平、達成難度、可解釋性四個(gè)方面停止綜合性評估，以確定較為合理的目標。

如下是其時(shí)初期選擇的8個(gè)目標。

注：以上僅列出目標，目標要求建議你可按照現實(shí)情況停止動(dòng)態(tài)調整，但過(guò)高的目標要求會(huì )變得毫無(wú)意義。

可能會(huì )有人提出，關(guān)于規模較大且日記條數較多的應用系統，能否可放寬目標要求，那聽(tīng)上去仿佛蠻有事理的，但我卻其實(shí)不那么認為。規模越大意味著(zhù)所承載的職責和才能也就越大，一旦發(fā)作毛病影響面也就越大，所以反倒更應該到達目標要求。

那些目標固然有必然的指點(diǎn)性，但似乎其實(shí)不能滿(mǎn)足開(kāi)發(fā)人員的“胃口”，因為那些目標仍然無(wú)法間接表露問(wèn)題根源，也無(wú)法讓他們可快速定位及明白優(yōu)化標的目的。因而，你還得付與目標必然的闡發(fā)才能。

例如：訂單系統單日ERROR級別日記888條（占日記總量0.0*%），（TOP1）*0%在com.OrderService的第88行。（TOP2）10%在com.PayService的第188行。

就如許，你能夠逐漸完美目標系統及配套的闡發(fā)才能，但請在設想每一個(gè)目標時(shí)，遵照先輩行系統現狀摸排，再停止小范疇試點(diǎn)運行，最初停止持續不雅測并調優(yōu)，從而確保每一個(gè)目標的設想都具備必然的合理性和可解釋性。

如下列出了一些目標，僅供參考。

除此之外，你還能夠將差別應用系統的目標停止橫向比照，并接納排行榜的形式在科技內部停止公開(kāi)，它將會(huì )產(chǎn)生一種改動(dòng)行為的驅動(dòng)力，能夠有效激發(fā)“想要贏(yíng)”和“不想失敗”的心理活動(dòng)，那就比如某些產(chǎn)物也會(huì )接納排行榜的體例來(lái)鼓勵用戶(hù)一樣。

通過(guò)設想目標系統+研發(fā)度量平臺+公開(kāi)排行榜單那三個(gè)手段的組合，在必然水平上能夠驅動(dòng)開(kāi)發(fā)人員持續性整改日記打印的問(wèn)題。但萬(wàn)事無(wú)絕對，那些始末無(wú)動(dòng)于衷的人仍然會(huì )存在，不外請不要強行要求對方，究竟結果有時(shí)候存期近合理。

寫(xiě)在最初

日記打印標準當然重要，但也請不要過(guò)火逃捧，它的核心價(jià)值仍是在于可以幫忙開(kāi)發(fā)人員更好地記錄應用系統的“案發(fā)現場(chǎng)”，并可為應用系統供給可持續改良的“線(xiàn)索”。但請服膺，日記打印標準雖不是全能的，但沒(méi)有日記打印標準卻是千萬(wàn)不克不及的。

做者丨陳俊

來(lái)源丨公家號：手藝奇奧物語(yǔ)（ID：gh_cfee2fb*4*bc）

021yin.com

更多出色內容

11月1*日下戰書(shū)14:00，dbaplus社群聯(lián)袂中國銀行，圍繞“中國銀行運維轉型與敏捷開(kāi)發(fā)摸索理論”那一主題開(kāi)展線(xiàn)上曲播分享，針對運維監控、混沌工程、DevOps等內容停止深度切磋，為金融業(yè)的數字化轉型供給更多新思緒。

021yin.com/*t8OC

關(guān)于我們

dbaplus社群是圍繞Database、BigData、AIOps的企業(yè)級專(zhuān)業(yè)社群。資深大咖、手藝干貨，每天精品原創(chuàng )文章推送，每周線(xiàn)上手藝分享，每月線(xiàn)下手藝沙龍，每季度GdevopsDAMS行業(yè)大會(huì )。

存眷公家號【dbaplus社群】，獲取更多原創(chuàng )手藝文章和精選東西下載