diff --git a/doc/X-RETRY文档.md b/doc/X-RETRY文档.md index f7a77fb29..d8b4c2a14 100644 --- a/doc/X-RETRY文档.md +++ b/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) ### 重试日志列表 diff --git a/doc/images/nofity_config.png b/doc/images/nofity_config.png deleted file mode 100644 index a09f42c0c..000000000 Binary files a/doc/images/nofity_config.png and /dev/null differ diff --git a/doc/images/scene_config.png b/doc/images/scene_config.png new file mode 100644 index 000000000..8196cf71f Binary files /dev/null and b/doc/images/scene_config.png differ