日志规范建设

最新推荐文章于 2023-04-24 23:57:30 发布

行者小朱

最新推荐文章于 2023-04-24 23:57:30 发布

阅读量624

点赞数

本文链接：https://blog.csdn.net/u012050154/article/details/103477730

版权

一、日志

1、日志的作用

日志记录用户操作、系统运行状态，好的日志系统可以帮助研发和运维：

掌握线上服务运行状态；
快速定位线上问题；
发现系统瓶颈；
服务报警；
挖掘数据价值；
……

2、日志级别

基本级别（由低到高）：

DEBUG：The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
INFO：The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
WARN：The WARN level designates potentially harmful situations.
ERROR：The ERROR level designates error events that might still allow the application to continue running.
FATAL：The FATAL level designates very severe error events that will presumably lead the application to abort.

二、日志系统的约定

// servername/2019120917.debug.log
[2019-12-09 19:35:20.0920][server.go:52][DEBUG]traceid=TraceID|spanid=SpandID|K1=V1|K2=V2|....|CostTime=56ms
-----------时间戳--------------代码--行数-日志级别--TaceID--SpanID---KV……

1、日志名字：同一个服务的每个级别日志打印到对应的文件中，可以选择按天/小时分割，示例如下：

2019120917.debug.log
2019120917.info.log
2019120917.warn.log
2019120917.error.log
2019120917.fatal.log

2、时间戳：日志记录产生的时间

日志文件名大概定位日志记录产生时段；
每行日志内时间字段需要十分精确：
- 目前看再不规范的日志系统最起码都打了这个字段；

2、代码文件及行数

定位问题、发现系统瓶颈等；

3、日志级别

如果不同级别的日志打印到不同文件中，这里也可以不打印该字段；

4、TraceId & SpanId：traceid表示所属的调用链，spanid表示本次rpc

TraceId：全链路追踪，贯穿整个调用链传递，从而可以通过traceid一次性取出所有相关日志
- 动作发起方生成 traceId，中间处理服务使用并记录该 traceId；
- 一个完整的请求在各服务处理的 traceId理论是同一个；
SpanId：代表一次rpc调用（一次rpc调用的两头分别关联了1个client和1个server），spanid生成规则体现了调用的层级与时序
- 反正服务调用的层级和时序；
- client端的span应该伴随request的生成而生成，伴随response的收到而释放（写到日志中）；server端的span应该伴随request的收到而生成，伴随response的发出而释放（写到日志中）;

5、annotation：日志正文