diff --git a/README.md b/README.md index 6199a5d..fced1b4 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,9 @@ ## 框架目录 ### 0. 故障案例 +###### [【必读】故障案例征集 & Demo 模板.md](docs/case/【必读】故障案例征集&Demo模板.md) ###### [【案例】Dubbo 稳定性：Nacos 注册中心可用性问题复盘](docs/case/【案例】Dubbo稳定性：Nacos注册中心可用性问题复盘.md) -###### [【案例】记一次线上内存报警排查过程](docs/diagnosis/system/memory/case/【案例】记一次线上内存报警排查过程.md) +###### [【案例】记一次线上内存报警排查过程](docs/case/【案例】记一次线上内存报警排查过程.md) ### 1. 事前防范 @@ -100,6 +101,8 @@ ## 版本迭代 +* 2021-11-17 + * [【必读】故障案例征集 & Demo 模板.md](docs/case/【必读】故障案例征集&Demo模板.md)@涯海 * 2021-11-08 * [链路分析 K.O “五大经典问题”](docs/diagnosis/tracing/链路分析K.O“五大经典问题”.md)@涯海 * 2021-09-23 @@ -117,7 +120,7 @@ * 2019-11-07 * [链路追踪（Tracing）其实很简单——单链路诊断](docs/diagnosis/tracing/链路追踪（Tracing）其实很简单——单链路诊断.md)@涯海 * [Spring Boot 常见错误及解决方法](docs/diagnosis/plugin/microservice/SpringBoot常见错误及解决方法.md)@洛夜 - * [【案例】记一次线上内存报警排查过程](docs/diagnosis/system/memory/case/【案例】记一次线上内存报警排查过程.md)@神帅 + * [【案例】记一次线上内存报警排查过程](docs/case/【案例】记一次线上内存报警排查过程.md)@神帅 * [饿了么监控系统 EMonitor 与 CAT 的对比](docs/processing/monitor/饿了么监控系统EMonitor与CAT的对比.md)@李刚 * 2019-09-19 * [Nacos常见问题及解决方法](docs/diagnosis/plugin/slb/Nacos常见问题及解决方法.md)@敦谷 diff --git "a/docs/case/\343\200\220\345\277\205\350\257\273\343\200\221\346\225\205\351\232\234\346\241\210\344\276\213\345\276\201\351\233\206&Demo\346\250\241\346\235\277.md" "b/docs/case/\343\200\220\345\277\205\350\257\273\343\200\221\346\225\205\351\232\234\346\241\210\344\276\213\345\276\201\351\233\206&Demo\346\250\241\346\235\277.md" new file mode 100644 index 0000000..4e9423f --- /dev/null +++ "b/docs/case/\343\200\220\345\277\205\350\257\273\343\200\221\346\225\205\351\232\234\346\241\210\344\276\213\345\276\201\351\233\206&Demo\346\250\241\346\235\277.md" @@ -0,0 +1,22 @@ +# 【必读】故障案例征集 & Demo 模板 +案例是最生动的理论，为了更好的指导生产环境实践，诚邀大家共建 【StabilityGuide 故障案例库】，你的分享能够帮助到他人，而他们的分享也能在最危急的时候给你指导。我为人人，人人为我，让我们一起加入分享！ + +## 故障案例写作模板（推荐） + +* 标题：统一以【案例】开头，直观体现出问题的现象或结论，比如【案例】记一次线上内存不足告警排查过程 +* 内容： + * 问题现象描述：客观描述系统问题表象，不加主观判断和分析性结论。 + * 问题排查过程：按时间线逐步讲解，图文结合效果更好。 + * 问题根因定位：归纳问题产生的根本原因，如果没有定位到根因可以明确说明。 + * 解决方案：通常分为短期解决方案和长期解决方案。 + * 最终效果：与解决方案前后呼应。 +* 扩展 + * 个人思考：比如对问题的延伸思考，对相关技术的深度探索。 + * 推荐工具/阅读：对相关的技术、工具和其他文章进行分享。 + + + +## 故障案例 Demo + +* [【案例】Dubbo 稳定性：Nacos 注册中心可用性问题复盘](https://github.com/StabilityMan/StabilityGuide/blob/master/docs/case/%E3%80%90%E6%A1%88%E4%BE%8B%E3%80%91Dubbo%E7%A8%B3%E5%AE%9A%E6%80%A7%EF%BC%9ANacos%E6%B3%A8%E5%86%8C%E4%B8%AD%E5%BF%83%E5%8F%AF%E7%94%A8%E6%80%A7%E9%97%AE%E9%A2%98%E5%A4%8D%E7%9B%98.md) @岛风 +* [【案例】记一次线上内存报警排查过程](https://github.com/StabilityMan/StabilityGuide/blob/master/docs/case/%E3%80%90%E6%A1%88%E4%BE%8B%E3%80%91%E8%AE%B0%E4%B8%80%E6%AC%A1%E7%BA%BF%E4%B8%8A%E5%86%85%E5%AD%98%E6%8A%A5%E8%AD%A6%E6%8E%92%E6%9F%A5%E8%BF%87%E7%A8%8B.md) @神帅 \ No newline at end of file diff --git "a/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221Dubbo\347\250\263\345\256\232\346\200\247\357\274\232Nacos\346\263\250\345\206\214\344\270\255\345\277\203\345\217\257\347\224\250\346\200\247\351\227\256\351\242\230\345\244\215\347\233\230.md" "b/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221Dubbo\347\250\263\345\256\232\346\200\247\357\274\232Nacos\346\263\250\345\206\214\344\270\255\345\277\203\345\217\257\347\224\250\346\200\247\351\227\256\351\242\230\345\244\215\347\233\230.md" index 8dd3e6c..31b830f 100644 --- "a/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221Dubbo\347\250\263\345\256\232\346\200\247\357\274\232Nacos\346\263\250\345\206\214\344\270\255\345\277\203\345\217\257\347\224\250\346\200\247\351\227\256\351\242\230\345\244\215\347\233\230.md" +++ "b/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221Dubbo\347\250\263\345\256\232\346\200\247\357\274\232Nacos\346\263\250\345\206\214\344\270\255\345\277\203\345\217\257\347\224\250\346\200\247\351\227\256\351\242\230\345\244\215\347\233\230.md" @@ -3,7 +3,7 @@ > 作者：徐靖峰（岛风） > 创作日期：2019-12-02 > 专栏地址：[【稳定大于一切】](https://github.com/StabilityMan/StabilityGuide) -> PDF 格式：[【案例】Dubbo 稳定性：Nacos 注册中心可用性问题复盘](https://github.com/StabilityMan/StabilityGuide/blob/master/docs/diagnosis/plugin/rpc/pdf/【案例】Dubbo稳定性：Nacos注册中心可用性问题复盘.pdf) +> PDF 格式：[【案例】Dubbo 稳定性：Nacos 注册中心可用性问题复盘](https://github.com/StabilityMan/StabilityGuide/blob/master/docs/case/pdf/【案例】Dubbo稳定性：Nacos注册中心可用性问题复盘.pdf) ## 问题描述 diff --git "a/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221\350\256\260\344\270\200\346\254\241\347\272\277\344\270\212\345\206\205\345\255\230\346\212\245\350\255\246\346\216\222\346\237\245\350\277\207\347\250\213.md" "b/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221\350\256\260\344\270\200\346\254\241\347\272\277\344\270\212\345\206\205\345\255\230\346\212\245\350\255\246\346\216\222\346\237\245\350\277\207\347\250\213.md" index ff17bb6..9dba04c 100644 --- "a/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221\350\256\260\344\270\200\346\254\241\347\272\277\344\270\212\345\206\205\345\255\230\346\212\245\350\255\246\346\216\222\346\237\245\350\277\207\347\250\213.md" +++ "b/docs/case/\343\200\220\346\241\210\344\276\213\343\200\221\350\256\260\344\270\200\346\254\241\347\272\277\344\270\212\345\206\205\345\255\230\346\212\245\350\255\246\346\216\222\346\237\245\350\277\207\347\250\213.md" @@ -3,7 +3,7 @@ > 作者：樊春帅（神帅） > 创作日期：2019-08-14 > 专栏地址：[【稳定大于一切】](https://github.com/StabilityMan/StabilityGuide) -> PDF 格式：[【案例】记一次线上内存报警排查过程](https://github.com/StabilityMan/StabilityGuide/blob/master/docs/diagnosis/system/memory/case/pdf/【案例】记一次线上内存报警排查过程.pdf) +> PDF 格式：[【案例】记一次线上内存报警排查过程](https://github.com/StabilityMan/StabilityGuide/blob/master/docs/case/pdf/【案例】记一次线上内存报警排查过程.pdf) 今天风和日丽，刚到公司，看看博客，微信&钉钉消息。突然发现报警群里有很多报警说 xx.xx.16.28 机器的内存不够，报警信息如下：