日志打印规范

  • 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中间件异常应该降级处理。
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值