Skip to content

Commit d545e5b

Browse files
committed
debug skill
1 parent a091062 commit d545e5b

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

debug/index.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Debug 调试技巧
9090
RPC/Web 框架
9191
~~~~~~~~~~~~~~~~~~~~~~
9292
- 请求参数限制。比如一般 rpc 请求会限制每次请求的最大的参数个数,如果一次性请求太多可能需要分批并发请求
93-
- debug 模式。注意线上一定要关闭掉 debug 方式防止泄露关键信息
93+
- debug 模式。注意线上一定要关闭掉 debug 方式防止泄露关键信息。很多框架在 debug 模式下会显示一些关键信息,可能会被利用
9494

9595
数据库问题
9696
~~~~~~~~~~~~~~~~~~~~~~
@@ -114,12 +114,12 @@ RPC/Web 框架
114114
日志错误
115115
~~~~~~~~~~~~~~~~~~~~~~
116116
- 日志级别错误。线上使用了 debug 级别,可能导致日志打满,如果没有滚动日志可能会导致服务器磁盘打满。一定要注意不同环境日志级别,推荐集中式日志收集系统
117-
- 日志参数错误。日志语句对应的占位符要和传参的个数一致,类型要匹配,比如本来是数字的使用了 `"%s"`
118-
- 缺少必要信息。如果是为了 debug 加上的日志一定要有足够的上下文信息帮助排查问题,同时也要注意不要泄露敏感数据(密码等)
117+
- 日志参数错误。日志语句对应的占位符要和传参的个数一致,类型要匹配,比如本来是数字的使用了 `"%s"` 而不是 `"%d"`
118+
- 缺少必要信息。如果是为了 debug 加上的日志一定要有足够的上下文信息帮助排查问题,同时也要注意日志不要泄露敏感数据(密码等)
119119

120120
错误/异常处理
121121
~~~~~~~~~~~~~~~~~~~~~~
122-
- 忽略错误/异常。除非你有 100% 的把握可以忽略,否则至少要在发生错误或者异常的地方加上日志,否则出问题之后错误被吞掉极难排查。笔者这个地方吃过亏,吞掉了错误导致排查困难
122+
- 不要忽略任何一个错误/异常。除非你有 100% 的把握可以忽略,否则至少要在发生错误或者异常的地方加上日志,否则出问题之后错误被吞掉极难排查。笔者这个地方吃过亏,吞掉了错误导致排查困难
123123

124124
配置错误
125125
~~~~~~~~~~~~~~~~~~~~~~
@@ -136,6 +136,7 @@ RPC/Web 框架
136136
~~~~~~~~~~~~~~~~~~~~~~
137137
- 分布式锁。分布式服务对于需要数据同步的操作可以使用分布式锁,注意分布式锁的超时问题
138138
- 时钟漂移。如果代码强依赖时间戳在不同的服务器上可能因为时钟差距导致问题,可以采用适当取整对齐时钟。
139+
- 分布式数据库。注意有些分布式数据库插入数据之后不会返回主键
139140

140141
基础组件问题
141142
~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)