自建团队 Wiki 出问题时的排查顺序:从现象到根因

自建服务 · 3 分钟阅读· 399 次阅读

BookStack 正文存在 MySQL 页表里,图片在 storage 目录,备份要一起做

正确的第一步是分类:起不来、连不上、跑得慢,三条路完全不同。

先说结论

先分三类,再由外向内查:网络、进程、配置、依赖、资源。

  • 先确认现象能复现,且能描述清楚
  • 由外向内:端口、进程、配置、依赖、资源
  • 读第一条错误,不是最后一条
  • 改一个变量,验证一次,别一次改五处
  • 留下记录:现象、假设、验证、结论

第一类:起不来

先看进程在不在,再看它为什么退出:BookStack 正文存在 MySQL 页表里,图片在 storage 目录,备份要一起做。

  • 查看服务状态与最近日志(不是全部日志)
  • 确认端口是否被占用、权限是否足够
  • 确认配置文件语法(多数服务支持 test 模式)
  • 确认依赖的数据目录存在且可写

第二类:连不上

按「本机、网络、代理、应用」四层查:

层级 验证方式 典型原因
本机 本机 curl / telnet 端口 没监听、只听 127.0.0.1
网络 从另一台机器访问 防火墙、安全组、VLAN
代理 检查反代配置与证书 路径、超时、头部大小
应用 看访问日志与错误日志 鉴权、限流、连接池耗尽

第三类:跑得慢

Wiki 的附件增长比正文快,图片一年能占几 GB。

慢的问题先分清是「等」还是「算」:CPU 高是算,CPU 低但延迟高是等(IO、锁、网络)。

自建团队 Wiki 出问题时的排查顺序

这个服务的高频故障点

同类的坑基本集中在这些位置:

  • Postgres 默认全文检索不切中文词,中文搜索要靠 zhparser 或 pg_jieba
  • BookStack 正文存在 MySQL 页表里,图片在 storage 目录,备份要一起做
  • Wiki 的附件增长比正文快,图片一年能占几 GB
  • 全文索引是异步更新的,刚写的文档可能要几秒才搜得到

别做的事

用默认检索搜中文,怎么搜都只有标题命中

把 Wiki 放在没有身份源的环境,最后全员共用一个账号

一次改多个参数,会让下一次故障更难查。

把结论写下来

排查记录不是给别人看的,是给三个月后的自己看的。全文索引是异步更新的,刚写的文档可能要几秒才搜得到。

还有几处容易忽略的

都是小地方,但出问题时往往就卡在这里。

  • Outline 必须接 OIDC 或第三方登录,没有本地账号,部署前要先有身份源
  • 导出 Markdown 能保底,但层级和附件链接通常要手工修
  • 只备份了数据库,恢复后所有图片都是裂的

排障能力不是知道更多命令,是知道先查什么。

评论 (3)

阿
阿哲

排查顺序那段直接抄进值班手册了。

K
Kevin

版本差异要强调,我照着做结果参数名全变了。

老
老吴

备份没验证过等于没有,这条我认。

发表评论

验证码

提交后需站长审核,通过后才会显示。