补充通知 、场景配置文档

doc/X-RETRY文档.md

@@ -1,8 +1,7 @@
 ## 《分布式异常重试服务平台 X-RETRY》
 
-
 # 简介
-X-RETRY 基于服务治理的思想我们开发了重试治理的功能，支持动态配置，接入方式基本无需入侵业务代码，并使用多种策略结合的方式在链路层面控制重试放大效应，兼顾易用性、灵活性、安全性的分布式异常重试服务平台
+> X-RETRY 基于服务治理的思想我们开发了重试治理的功能，支持动态配置，接入方式基本无需入侵业务代码，并使用多种策略结合的方式在链路层面控制重试放大效应，兼顾易用性、灵活性、安全性的分布式异常重试服务平台
 
 # 社区
 https://www.byteblogs.com/chat
@@ -130,20 +129,39 @@ http://localhost:8080
 ![group_list.png](./images/group_list.png)
 
 ### 组配置
-组名称: 名称是数字、字母、下划线组合，最长64个字符长度
+- 组名称: 名称是数字、字母、下划线组合，最长64个字符长度
-状态: 开启/关闭, 通过状态开启或关闭组状态
+- 状态: 开启/关闭, 通过状态开启或关闭组状态
-路由策略:
+- 路由策略: 随机算法、一致性hash算法、最近最久未使用算法
-描述: 
+- 描述: 对组进行描述
-知道分区 :
+- 指定分区: 不指定则系统随机分区，指定则使用指定的分区
 ![goup_config.png](./images/goup_config.png)
 
 ### 场景配置
-![goup_config.png](./images/goup_config.png)
+- 场景名称: 名称是数字、字母、下划线组合，最长64个字符长度
+- 场景状态: 开启/关闭, 通过状态开启或关闭场合状态
+- 退避策略: 延迟等级、固定时间、CRON表达式、随机等待
+- 最大重试次数: 重试上限值
+- 描述: 对场景进行描述
+- 操作: 新增-添加场景配置、删除-未提交则删除临时场景配置，已提交则删除数据库中的场景配置
+
+![goup_config.png](./images/scene_config.png)
 
 ### 通知配置
+- 通知类型: 钉钉通知、邮箱通知、企业微信通知
+- 通知场景: 
+  - 重试数量超过阈值: 作用于服务端，重试中的数量到达阈值发送通知
+  - 重试失败数量超过阈值: 作用于服务端，达到最大重试次数的数量到达阈值发送通知
+  - 客户端上报失败: 作用于客户端，上报数据失败 发送 通知 
+  - 客户端组件异常: 作用于客户端，重试组件内部异常，发送通知 
+- 通知阈值: 到达阈值发送通知
+- 通知地址: 发送通知的地址
+- 描述: 对通知进行描述
+- 操作: 新增-添加场景配置、删除-未提交则删除临时通知配置，已提交则删除数据库中的通知配置
+
 ![notify_config.png](images/notify_config.png)
 
 ### 重试列表
+
 ![retry_task_list.png](./images/retry_task_list.png)
 
 ### 重试日志列表