闭关修炼31天之第六天---谈谈异常处理与日志(下)

日志规约：

目录

日志规约：

一.日志的功能

二.日志实效规约

三.日志输出规约

四.日志记录规约

五.扩展日志规约

---

一.日志的功能

二.日志实效规约

• 当天日志命名应以“应用名.log“来保存。
• 过往的日志以{logname}.log.(保存日期)命名，日期格式为：yyyy-mm-dd。
• 日志文件至少保存15天，便于排查某些以周为频次发生的异常。
• 敏感操作信息联机存储6个月，网络安全的相关规定。

三.日志输出规约

• 系统应依赖使用日志框架(SLF4J、JCL)的API而不是具体日志库中的。
• 在日志输出时，字符串变量之间的拼接使用占位符的方式。
• 日志打印时禁止直接用JSON工具将对象转换为String。
• 尽量用英文来描述日志错误信息。

四.日志记录规约

异常错误日志实时通知：

 整合Sentry将错误异常日志发送至钉钉消息：

日志输出规约：

• 日志级别开关判断：对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。
• 异常日志信息要完整：异常日志信息应该包括两类信息，案发现场信息、异常堆栈信息。
• 避免打印重复日志：重复打印日志浪费磁盘空间，要在日志配置文件中设置additibity=false。 

五.扩展日志规约

• 扩展日志单独存储如打点、临时监控、访问日志等。
• 错误日志单独存储，业务日志与错误日志分开存储。