日志规范

tech2022-09-19  104

日志规范

一整体规范 关于现有VSP系统日志无规则现状,架构组提出以下建议: 1.合理分级,如开发用打trace级,debug,info,error 2.联调和测试环境用debug 3.运行时记录业务关键点用info,另运行时记录业务关键点日志不要用序列化方式进行转换日志内容(取出关键数据,不要全体对象) 4.不要连续打两条级别不同的日志,意义不大,如打一条log.error 紧接着打一行 log.info 5.合理加日志,不要打印没有意义的日志。 6.使用SLF4J的格式化功能 logger.debug(" data is :{}",“data info”); 7.使用日志级别可有检查 例如: if(logger.isDebugEnabled()) { logger.debug(" data is :{}",“data info”);}

二业务日志规范: ①切面日志正常打 (本田需求) ②TCP,上下行报文正常打(本田需求) ③ 业务日志: 1.日志内容:businessName:XXXXX+ userid:XXXX+vin:XXXX‘+traceid:XXXXX+step:XXXXX+关键参数+关键点数据

2.日志内容来源:traceid+stepid+userid+vin由共通日志包完成,通过http的header传递

businessName+关键参数+关键点数据由业务组自己决定

****关键点数据包括(处理结果,关键分支判断时的数据如果是内存或缓存或者瞬间被替换的数据等无法回溯的数据)

④业务日志打印方法:

引入1.0.9版本的日志组件

\<dependency\> \<groupId\>com.reachauto.vspcloud\</groupId\> \<artifactId\>vspcloud-common-log\</artifactId\> \<version\>1.0.9\</version\> \</dependency\>

代码例:

VspLog.log( "fota-task-list", new HashMap\<String, String\>(2) { { put("pageNo", pageNo.toString()); put("pageSize", pageSize.toString()); } });
最新回复(0)