- code为-500的日志要打印异常堆栈, 除此之外不能使用-500的错误码
- 参数校验错误, 需要给出具体的参数名. 使用MessageFormat实现参数精细化.
- aop切面的try catch异常捕获不能是catch exception, 而应该是catch throwable. 防止出现栈溢出等Error 而无法捕获.
- 自定义业务异常BusinessException, 需要继承RuntimeException, 而不是继承Exception.
- 非预期异常需要接入告警.
- 禁止打印过长日志
- 调用链路要清晰. 上游服务调用下游需要带上当前的应用标识. 下游api_client日志中需要打印哪个上游调用了api.
- requestId全链路透传
- 调用第三方服务需要写入api_client日志
- api日志和api_client日志需要记录: url、请求参数、返回结果、请求耗时、requestId
- 日志记录请求参数的方式:
- 方式一: post & application/json请求用request#getInputStream(), 其他请求用request#getParametorMap(), 并且要重写HttpServletRequestWrapper.因为httpServletRequest中的流只能读取一次, 因此需要实现可重复读取流数据.
- 方式二: post & application/json请求用ProceedingJoinPoint#getArgs(), 其他请求用request#getParametorMap().
- 详尽和细粒度的错误码描述, 能帮助快速排查问题. 可参考阿里云文档的错误码描述
- 异常的大类划分: 数据异常、业务异常、系统异常、第三方服务异常.
- 强依赖应该抛出异常中断处理(也可以catch异常再抛出自定义异常给出详尽的自定义错误信息), 弱依赖应该catch异常降级处理. 读取redis中间件异常应该降级处理。
日志打印规范
于 2017-01-23 04:14:32 首次发布