【日志使用规范】

北冥有瑜

已于 2023-06-26 18:58:52 修改

阅读量35

点赞数

文章标签： java servlet

于 2023-06-26 18:57:48 首次发布

本文链接：https://blog.csdn.net/weixin_43489232/article/details/131403641

版权

日志规范

记录日志时需要注意 placeholder 占位符

背景：梳理历史代码以及日志时，发现一个 NPE 异常，定位之后发现该方法长达 500 多行，且记录的异常日志关键信息极少，很难定位具体问题，因此记录此案例方便后续开发

反例：

try {
    // xxx
} catch (Exception e) {
    logger.warn("数据转化异常，e:{}", e);
}

问题：

此代码中的 {} 会导致异常 e 进行 toString 转换之后记录，从而无法获取到异常的堆栈信息，如下日志所示

[23:55:46:506]  [172.25.90.181]  [WARN]  [JSF-BZ...90-T-9]  [GoldenEyeIOUConvetor]  [null]  - 数据转化异常，e:{} java.lang.NullPointerException: null

这会导致排查代码时很难定位问题。建议异常时使用以下方式记录

try {
    // xxx
} catch (Exception e) {
    logger.warn("数据转化异常，param: {}, e:", "当前方法参数", e);
}

通过上游方法的日志，本地复现之后定位到问题出在具体哪一行，最终解决了问题并完善了日志。

关注