2019-03 服務日志級別調(diào)研

一、日志分級的定義(摘錄)

1. 文林福寫的wiki中提到

log的主要目的:便于觀察線上服務是否正常冀膝、數(shù)據(jù)統(tǒng)計窝剖、問題跟進。
log打印的基本原則:簡明扼要疙描。在能清楚表達所要打印的信息的情況下起胰,越短越好。主要是log打印太多會提高存儲火俄、傳輸和分析的代價

log分級:

  debug:用于調(diào)試時打印的信息,上線時需要關(guān)閉玻熙,如果是前期需要觀察線上數(shù)據(jù),可以臨時打開一段時間枚尼,一個請求可以打多條記錄

  INFO:記錄非常重要的信息,一個請求可以打印1-3條(一般開始1條盯质,結(jié)束一條),能合并的盡量合并朵逝。記錄請求的id、請求類型晋辆,做了什么事情瓶佳、結(jié)果、狀態(tài)厚脉、時間等(根據(jù)自己需要)。log合并的好處是在數(shù)據(jù)分析和統(tǒng)計的時候可以在1條log中獲取所有的信息鸯匹,而信息打印在不同的log記錄中,需要做合并操作科雳,會非常麻煩。此外無論請求成功了還是失敗了尿赚,都需要打一條INFO log,用狀態(tài)碼區(qū)分就行

  WARN:警告日志冰寻,出現(xiàn)了預期之外的信息,但是程序不影響程序運行的划乖。比如:傳遞過來的圖片解碼失敗

  FATAL: 致命錯誤日志:類似磁盤空間不夠了,分配內(nèi)存和端口失敗這種

2. 王健的知乎專欄:最佳日志實踐

FATAL — 表示需要立即被處理的系統(tǒng)級錯誤。這屬于最嚴重的日志級別(必須慎用)庆寺,通常一個進程的生命周期中應該只記錄一次FATAL級別的日志这橙,即該進程遇到無法恢復的錯誤而退出時。
ERROR — 當ERROR錯誤發(fā)生時鹰晨,需要立即處理——表示已經(jīng)影響了用戶的正常訪問,但服務沒有掛掉忍疾。這種級別的日志屬于服務錯誤,而不是用戶自己操作不當,請求參數(shù)錯誤等等士复。
WARN — 該日志表示系統(tǒng)可能出現(xiàn)潛在問題。這個級別表明不需要立即處理澄峰,但也是需要查看并處理的绸硕。因此此種級別的日志也不應太多出嘹。
INFO — 該種日志記錄系統(tǒng)的正常運行狀態(tài)烦秩,例如某個子系統(tǒng)的初始化,某個請求的成功執(zhí)行等等抛寝。通過查看INFO級別的日志,可以很快地對系統(tǒng)中出現(xiàn)的 WARN,ERROR,FATAL錯誤進行定位钻趋。INFO日志不宜過多,通常情況下土至,INFO級別的日志應該不大于TRACE日志的10%垂蜗;
DEBUG or TRACE — 作用是對系統(tǒng)每一步的運行狀態(tài)進行精確的記錄烘苹。可以保證在不重現(xiàn)錯誤的情況下廊鸥,也可以通過DEBUG(或TRACE)級別的日志對問題進行診斷。

3. stackoverflow回答 - Hansaka perera

Trace - Only when I would be "tracing" the code and trying to find one part of a function specifically.

Info - Generally useful information to log (service start/stop, configuration assumptions, etc). Info I want to always have available but usually don't care about under normal circumstances. This is my out-of-the-box config level.

Warn - Anything that can potentially cause application oddities, but for which I am** automatically recovering**. (Such as switching from a primary to backup server, retrying an operation, missing secondary data, etc.)

Error - Any error which is fatal to the operation, but not the service or application (can't open a required file, missing data, etc.). These errors will force user (administrator, or direct user) intervention. These are usually reserved (in my apps) for incorrect connection strings, missing services, etc.

Fatal - Any error that is forcing a shutdown of the service or application to prevent data loss (or further data loss). I reserve these only for the most heinous errors and situations where there is guaranteed to have been data corruption or loss.

4. stackoverflow回答 - Peter Mortensen

Would you want the message to get a system administrator out of bed in the middle of the night?

yes -> error

no -> warn

+ 引用

文林福 涉及公司內(nèi)容啦吧,鏈接隱去

王健 - https://zhuanlan.zhihu.com/p/27363484

stackoverflow問題

二顾犹、正確的對待日志的方式

1. 不斷優(yōu)化日志

源自 - 王健

好的日志就像好的文章一樣,絕不是一遍就可以寫好的,而需要在實際的運維過程中顾彰,結(jié)合線上問題的定位,不斷地進行優(yōu)化厕隧。最關(guān)鍵的一點是,團隊要重視日志優(yōu)化這件事情,不要讓日志的質(zhì)量持續(xù)降低翎朱。

好的實踐:

  • 在定位問題的過程中完善日志,如果定位問題花費了很長時間,那就說明系統(tǒng)日志還存在問題蕉汪,需要進一步完善和優(yōu)化;

  • 需要思考是否可以通過優(yōu)化日志驹马,來提前預判該問題是否可能發(fā)生;

  • 定義好整個團隊記錄日志的規(guī)范,保證每個開發(fā)記錄的日志格式統(tǒng)一;定期對日志內(nèi)容進行Review胖秒;

2. 對現(xiàn)狀做一個個人評價

根據(jù)上述的一些結(jié)論,發(fā)現(xiàn)team的代碼:

  • fatal級別:基本上API服務的處理較好,panic俯邓、runtime-errorr這類問題并不會直接服務重啟,而是會被中間代碼兜住并打出一個error級日志朦蕴,符合預期赴恨;RPC服務未確認雨饺,似乎大多數(shù)沒有做很好的兜底饺窿,也沒有導致服務崩潰時的fatal日志。

  • error:現(xiàn)狀是非常隨意,一些不會引發(fā)接口錯誤糠排、次要的字段、無需立即處理的問題乾闰,往往不合預期就被打上一條error日志。使tce上線時經(jīng)常上得驚心動魄,提示出現(xiàn)嚴重錯誤硫朦,很不友好。

  • warn:基本符合預期,對非重要功能的調(diào)用失敗祷舀、參數(shù)錯誤箕宙、打上warning

  • info:有一些意義不明的內(nèi)容打上了info(到底是想要作為業(yè)務warn還是一條trace哟忍?)

  • trace:用得較少,可以通過CtxPushNotice把鍵值對塞進這個級別中爆安,用于追蹤請求細節(jié)咖耘。

總結(jié)來說版保,還有不少進步空間。

- 引用

王健 - https://zhuanlan.zhihu.com/p/27363484

三、負面場景

  • 避免使用簡單的無意義的字符串輸出日志
    logging.error(u'執(zhí)行錯誤')
  • 避免通過多條日志記錄同一個事件
    # 這種日志可以通過最后的一條日志急鳄,進行整體的記錄触创,將開始和結(jié)束時的關(guān)鍵信息通過變量參數(shù)的形式記錄
    logging.info(u'開始')
    logging.info(u'結(jié)束')
    logging.info(u'消耗時間' + end_time - start_time)
  • 代碼舉例
// 數(shù)據(jù)已影響函數(shù)正常執(zhí)行應該打warning碉咆,且日志信息不足
func work0(ctx context.Context, input int) {
  if input < 0 {
      logs.CtxInfo(ctx, "[CommandTrans] invalid parameter")
      return
}
// 占用日志空間的info日志双谆,應該用trace日志將一次請求的信息匯總成一條
func work1(ctx context.Context) string {
  logs.CtxInfo(ctx, "xxxx")
  return "test"
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末寸谜,一起剝皮案震驚了整個濱河市他爸,隨后出現(xiàn)的幾起案子岭埠,更是在濱河造成了極大的恐慌许赃,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件沟于,死亡現(xiàn)場離奇詭異销睁,居然都是意外死亡,警方通過查閱死者的電腦和手機冗栗,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來挡闰,“玉大人,你說我怎么就攤上這事”窀螅” “怎么了禾进?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵宠纯,是天一觀的道長娇哆。 經(jīng)常有香客問我,道長宵统,這世上最難降的妖魔是什么弄息? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任缨称,我火速辦了婚禮器净,結(jié)果婚禮上宁玫,老公的妹妹穿的比我還像新娘眷射。我一直安慰自己芥被,他們只是感情好冗茸,可當我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布挂绰。 她就那樣靜靜地躺著,像睡著了一般秦士。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上关贵,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天炭剪,我揣著相機與錄音,去河邊找鬼绿鸣。 笑死,一個胖子當著我的面吹牛究流,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼国裳,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蛇数?” 一聲冷哼從身側(cè)響起倚评,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤呢岗,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后焕襟,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年轮洋,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡薇搁,死狀恐怖屎鳍,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情卖宠,我是刑警寧澤,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響拇惋,放射性物質(zhì)發(fā)生泄漏吧兔。R本人自食惡果不足惜灶平,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望侧但。 院中可真熱鬧粥血,春花似錦、人聲如沸抬闷。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽茁裙。三九已至廊宪,卻和暖如春壕翩,著一層夾襖步出監(jiān)牢的瞬間荐操,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工肩民, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留祟蚀,地道東北人鹏溯。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓颜阐,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子萨赁,可洞房花燭夜當晚...
    茶點故事閱讀 44,979評論 2 355

推薦閱讀更多精彩內(nèi)容