2019-03 服务日志级别调研

一、日志分级的定义(摘录)

1. 文林福写的wiki中提到

log的主要目的:便于观察线上服务是否正常、数据统计、问题跟进。
log打印的基本原则:简明扼要。在能清楚表达所要打印的信息的情况下,越短越好。主要是log打印太多会提高存储、传输和分析的代价

log分级:

  debug:用于调试时打印的信息,上线时需要关闭,如果是前期需要观察线上数据,可以临时打开一段时间,一个请求可以打多条记录

  INFO:记录非常重要的信息,一个请求可以打印1-3条(一般开始1条,结束一条),能合并的尽量合并。记录请求的id、请求类型,做了什么事情、结果、状态、时间等(根据自己需要)。log合并的好处是在数据分析和统计的时候可以在1条log中获取所有的信息,而信息打印在不同的log记录中,需要做合并操作,会非常麻烦。此外无论请求成功了还是失败了,都需要打一条INFO log,用状态码区分就行

  WARN:警告日志,出现了预期之外的信息,但是程序不影响程序运行的。比如:传递过来的图片解码失败

  FATAL: 致命错误日志:类似磁盘空间不够了,分配内存和端口失败这种

2. 王健的知乎专栏:最佳日志实践

FATAL — 表示需要立即被处理的系统级错误。这属于最严重的日志级别(必须慎用),通常一个进程的生命周期中应该只记录一次FATAL级别的日志,即该进程遇到无法恢复的错误而退出时。
ERROR — 当ERROR错误发生时,需要立即处理——表示已经影响了用户的正常访问,但服务没有挂掉。这种级别的日志属于服务错误,而不是用户自己操作不当,请求参数错误等等。
WARN — 该日志表示系统可能出现潜在问题。这个级别表明不需要立即处理,但也是需要查看并处理的。因此此种级别的日志也不应太多。
INFO — 该种日志记录系统的正常运行状态,例如某个子系统的初始化,某个请求的成功执行等等。通过查看INFO级别的日志,可以很快地对系统中出现的 WARN,ERROR,FATAL错误进行定位。INFO日志不宜过多,通常情况下,INFO级别的日志应该不大于TRACE日志的10%;
DEBUG or TRACE — 作用是对系统每一步的运行状态进行精确的记录。可以保证在不重现错误的情况下,也可以通过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

+ 引用

文林福 涉及公司内容,链接隐去

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

stackoverflow问题

二、正确的对待日志的方式

1. 不断优化日志

源自 - 王健

好的日志就像好的文章一样,绝不是一遍就可以写好的,而需要在实际的运维过程中,结合线上问题的定位,不断地进行优化。最关键的一点是,团队要重视日志优化这件事情,不要让日志的质量持续降低。

好的实践:

  • 在定位问题的过程中完善日志,如果定位问题花费了很长时间,那就说明系统日志还存在问题,需要进一步完善和优化;

  • 需要思考是否可以通过优化日志,来提前预判该问题是否可能发生;

  • 定义好整个团队记录日志的规范,保证每个开发记录的日志格式统一;定期对日志内容进行Review;

2. 对现状做一个个人评价

根据上述的一些结论,发现team的代码:

  • fatal级别:基本上API服务的处理较好,panic、runtime-errorr这类问题并不会直接服务重启,而是会被中间代码兜住并打出一个error级日志,符合预期;RPC服务未确认,似乎大多数没有做很好的兜底,也没有导致服务崩溃时的fatal日志。

  • error:现状是非常随意,一些不会引发接口错误、次要的字段、无需立即处理的问题,往往不合预期就被打上一条error日志。使tce上线时经常上得惊心动魄,提示出现严重错误,很不友好。

  • warn:基本符合预期,对非重要功能的调用失败、参数错误、打上warning

  • info:有一些意义不明的内容打上了info(到底是想要作为业务warn还是一条trace?)

  • trace:用得较少,可以通过CtxPushNotice把键值对塞进这个级别中,用于追踪请求细节。

总结来说,还有不少进步空间。

- 引用

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

三、负面场景

  • 避免使用简单的无意义的字符串输出日志
    logging.error(u'执行错误')
  • 避免通过多条日志记录同一个事件
    # 这种日志可以通过最后的一条日志,进行整体的记录,将开始和结束时的关键信息通过变量参数的形式记录
    logging.info(u'开始')
    logging.info(u'结束')
    logging.info(u'消耗时间' + end_time - start_time)
  • 代码举例
// 数据已影响函数正常执行应该打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"
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容