故障案例写作模板¶
复制下面模板创建新案例。建议文件名使用大写英文和短横线,例如 SYSTEMD-SERVICE-FAILED.md。
# 案例标题
## 现象
- 用户看到的报错、告警或异常行为。
- 影响范围,例如单机、某个服务、某个命名空间或全部用户。
## 快速判断
先用 2-5 条低风险命令判断故障大类。
```bash
command --example
```
## 排查命令
按从低风险到高风险、从只读到变更的顺序排列。
```bash
# 查看服务状态
systemctl status <service>
# 查看最近日志
journalctl -u <service> -n 100 --no-pager
```
## 常见原因
- 原因 1。
- 原因 2。
- 原因 3。
## 处理建议
- 先保留日志、配置和现场证据。
- 优先选择可回滚、影响面小的修复方式。
- 修改配置后先做语法检查或灰度验证。
## 高危提醒
- 标记可能造成数据丢失、断连、不可逆变更的命令或操作。
- 生产环境变更前确认备份、回滚和通知机制。
## 相关专题
- [相关专题名称](../manual/linux/BASIC.md)
- 相关案例名称,例如同目录下的另一个故障案例。
编写建议¶
- 命令优先使用只读检查命令,涉及删除、重启、扩容、权限变更时必须写风险提醒。
- 示例中的主机名、IP、用户名、域名、证书路径要脱敏。
- 一个案例只解决一个主要故障,不要把多个无关问题塞进同一篇。
- 如果命令依赖特定环境,例如 Kubernetes、systemd、Docker Desktop,需要在正文中说明。