客户定制项目如何优雅地记录日志？

每个项目都存在各种日志。这些日志一方面是开发过程中用来debug调试代码使用；另一方面，也是当系统发生错误的时候，进行代码排查的重要依据之一。

和公司内部的项目能够实时在容器云平台或者本地文件查看不同，定制项目因为需要部署在客户内部，往往受限于客户的安全性和隐私要求，出现问题时获取日志需要客户上级一层层审批，如果在初期不能设计好日志的规范，就会导致客户对排查产生厌烦，从而产生信任危机。 本文尝试总结开发定制项目中，设计日志的思路和实际案例，为后续的开发人员提供一些思路。

1.对日志类型进行区分

定制项目中区分日志类型的目的，是为了及时定位项目的运行情况。一般来说，定制项目分为2种类型的日志：

（1）系统日志。

面向开发人员的日志记录。一般来说，系统日志是直接打印在项目日志目录下，为开发人员提供排查的记录。例如报错的堆栈信息、代码执行的结果等。打印的日志并没有特殊的要求，开发人员按照业务和自己关注点打印即可。

（2）操作日志。

面向用户的日志记录。这种类型的日志需要统一格式。日志内容主要记录的是用户的敏感操作，例如修改密码、登录注销、授权账户等。对于安全审计较强的客户而言，这些数据一方面要进行记录，一方面也要实时入库，防止有人违规操作。

2.做好日志存储规划

在刚开发客户项目的时候，考虑到节省空间和资源，初期我们保留日志的天数是7天。这是一个较为常见的存储天数。但是在后来，我们提升到了31天。一方面是客户的要求；另一方面，由于某些错误可能是周期性出现。1个月的时间，能够动态监控错误出现的时间、操作，方便出现问题的时候进行排查。

在规划日志存储的过程中，需要做好敏感信息加密工作。客户对于项目的隐私性要求极强，尤其是政府、银行类项目。所以为了防止后续因为隐私问题导致的日志无法获取的情况，在初期就要和客户进行脱敏沟通，使用统一的UUID等数字进行查询。

3.打印日志有开关

在开发、测试中，开发人员经常会打印一些关键信息用来debug，也有的会打印时间用来计算程序时间。这些日志在开发过程中十分有用，但是一旦交付客户，或者是项目上线正常运行时，会导致日志记录杂乱。为了保证日志的一致性和出现问题时及时定位。我们建议 打印 trace / debug /info 级别日志的时候有统一的开关，防止出现无效日志一股脑记录的情况。

4.报错日志尽可能详细

对于错误信息，我们除了要给客户提示，更要保证足够的信息打印出来，方便开发人员能够复现。对于后端的 Java 项目来说，一个有效的错误日志，不仅要包含堆栈信息，更要有客户操作的相关参数，如果。

//错误示范
try{
  //TODO
}catch(Exception e) {
  logger.error("系统报错:{}",e.getMessgage());
}

//正确示范
try{
  //TODO
}catch(Exception e) {
  logger.error("系统报错，参数:{},报错信息:{}",ALL_PARAMS,e.getMessgage(),e);
}

5.不要大惊小怪

在平时的项目开发中，出现错误时，我们恨不得打印各种error日志。但是对于客户的定制项目来说，我们需要摒弃这种思想。

一般来说，除非是业务的逻辑报错，判定的确会导致系统异常的情况，建议使用比error第一级的warn。尤其是需要用户传参数的时候，需要项目记录参数，防止客户投诉项目出问题的时候，只看到日志里一大堆error记录，却没有考虑是不是用户本身的错误。

总结

对于客户定制项目，开发人员无论是打印日志，还是在开发过程中，都要记住：

• 敏感日志的保存方式和脱敏方法，一定要事先沟通，保证日志能从客户环境获取；
• 不要相信客户的输入，第一时间确定的永远是客户进行了什么操作；
• 日志是出现问题时最重要的复现工具之一，一定要做好规划，日志内容要足够详细；