bk-ci icon indicating copy to clipboard operation
bk-ci copied to clipboard

优化程序后台打印的运行日志内容及级别

Open irwinsun opened this issue 2 years ago • 0 comments

背景: 后台程序运行日志打印内容及级别较为随意,ERROR级别的日志较多,中英文混杂以及存在打印一些不安全或敏感的信息,不利于平台的正常监控运营。

因此需要规范日志打印:

日志规范

日志基本原则

  • 思考该行日志的用途
  • 禁止打印带有敏感信息的字段
  • 不用中英文句子,只用英文关键字代替
  • 非紧急必要情况下,要消除为了追踪逻辑而打印的error,warn,info。理清业务逻辑, 仅在必要的平台错误输出error
  • 非紧急必要情况下,禁止直接输出整个对象,随着业务发展,无法知晓后续该对象会不会被加入敏感信息或者嵌入超级大的对象。
  • ERROR日志需要监控,并且出现后开发需要介入

平台错误埋点规范示例:

logger.error("BKSystemErrorMonitor|listenAgentStartUpEvent|${event.buildId}|error=${ignore.message}")

BKSystemErrorMonitor 是固定的,监控平台会采集该字段来表示是系统出现错误,是固定的。
listenAgentStartUpEvent 这个是示例方法名,表示出错的是哪个方法名,可以自定义。
${event.buildId} 这个表示当前关注的信息是什么
error=${ignore.message} 这个表示出错的信息

irwinsun avatar Jul 13 '22 09:07 irwinsun