This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new cb6c482857 [type:refactor] refactor hystrix doc (#692)
cb6c482857 is described below
commit cb6c4828572e48a40f877b1f4de76119f73988a0
Author: moremind <[email protected]>
AuthorDate: Tue Aug 9 23:27:36 2022 +0800
[type:refactor] refactor hystrix doc (#692)
* [type:refactor] refactor hystrix doc
* [type:refactor] refactor hystrix doc
* [type:refactor] refactor hystrix doc
---
.../fault-tolerance/hystrix-plugin.md | 122 ++++++++++++++----
.../fault-tolerance/hystrix-plugin.md | 120 +++++++++++++----
.../fault-tolerance/hystrix-plugin.md | 120 +++++++++++++----
.../fault-tolerance/hystrix-plugin.md | 120 +++++++++++++----
.../fault-tolerance/hystrix-plugin.md | 134 ++++++++++++++-----
.../fault-tolerance/hystrix-plugin.md | 120 +++++++++++++----
.../plugin/hystrix/hystrix-example-rule-en.png | Bin 0 -> 124495 bytes
.../plugin/hystrix/hystrix-example-rule-zh.png | Bin 0 -> 110199 bytes
.../img/shenyu/plugin/hystrix/hystrix-result.png | Bin 0 -> 252395 bytes
.../shenyu/plugin/hystrix/hystrix-send-request.png | Bin 0 -> 172076 bytes
.../fault-tolerance/hystrix-plugin.md | 142 +++++++++++++++------
.../fault-tolerance/hystrix-plugin.md | 142 +++++++++++++++------
.../fault-tolerance/hystrix-plugin.md | 142 +++++++++++++++------
.../fault-tolerance/hystrix-plugin.md | 122 ++++++++++++++----
14 files changed, 990 insertions(+), 294 deletions(-)
diff --git a/docs/plugin-center/fault-tolerance/hystrix-plugin.md
b/docs/plugin-center/fault-tolerance/hystrix-plugin.md
index e4c5f5675e..77f5050270 100644
--- a/docs/plugin-center/fault-tolerance/hystrix-plugin.md
+++ b/docs/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,55 +4,75 @@ keywords: ["Hystrix"]
description: hystrix plugin
---
-## Description
+# 1. Overview
-* `Hystrix` plugin is the core implementation used by gateway to fuse traffic.
-* Support `thread` and `semaphore` .
+## 1.1 Plugin Name
-## Plugin Setting
+* Hystrix Plugin
-Select a mode to start shenyu-admin. For details, see deployment. For
example, with [Local Deployment](../../deployment/deployment-local) starts the
`Apache ShenYu` background management system.
+## 1.2 Appropriate Scenario
-* In BasicConfig --> Plugin --> hystrix, set to enable.
-* If the user don't use, please disable the plugin in the background.
+* The backend service is unstable, use hystrix for protection
-<img src="/img/shenyu/plugin/hystrix/hystrix_open_en.png" width="80%"
height="80%" />
+## 1.3 Plugin functionality
+* Fusing the flow
+* Protect the application behind ShenYu Gateway
+* Isolation mode supports `thread` and `semaphore`.
-## Add hystrix plugin dependency
+## 1.4 Plugin code
+
+* Core Module: `shenyu-plugin-hystrix`
+
+* Core Class: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
* Add `hystrix` dependency in the `pom.xml` file of the gateway.
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
+## 2.3 Enable plugin
+* In `shenyu-admin`--> BasicConfig --> Plugin --> `hystrix` set to enable.
-## Hystrix Config
+## 2.4 Config plugin
+### 2.4.1 Plugin Config
-For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
+* No Config, but you should open hystrix plugin.
-#### Selector Config
+### 2.4.2 Selector Config
It is used to filter traffic for the first time and does not require handle
fields.
-<img src="/img/shenyu/plugin/hystrix/selector_en.png" width="80%" height="80%"
/>
-
-#### Rule Config
+For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
-For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
-<img src="/img/shenyu/plugin/hystrix/rule_en.png" width="80%" height="80%" />
+### 2.4.3 Rule Config
+* For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
* Hystrix handler details:
@@ -69,4 +89,54 @@ For the final filtering of traffic, there is a rule handler
logic, isolation mod
* `CallBackUrl`: default url `/fallback/hystrix`.
* `CommandKey`: generally, it is set to a specific path interface.
-
+
+## 2.5 Examples
+
+### 2.5.1 use hystrix protect application
+
+#### 2.5.1.1 Preparation
+
+- Start ShenYu Admin
+- Start ShenYu Bootstrap
+- Start a backend service
+
+#### 2.5.1.2 Selector Config
+
+
+
+#### 2.5.1.3 Rule Config
+
+* The rules in the pictures below are test examples, actual environment
depends on the specific situation.
+
+
+
+* test example
+
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
+
+#### 2.5.1.4 Send Request With `Apache Jmeter`
+
+
+
+#### 2.5.1.5 Check Result
+
+
+
+# 3. How to disable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `hystrix` set Status
disable.
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/fault-tolerance/hystrix-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/fault-tolerance/hystrix-plugin.md
index 34d9580c35..bb3b4057d2 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,52 +4,75 @@ keywords: ["Hystrix"]
description: hystrix插件
---
+# 1. 概述
-## 说明
+## 1.1 插件名称
-* `hystrix`插件是网关用来对流量进行熔断的核心实现。
-* 隔离模式支持 `thread` 和 `semaphore` 。
+* Hystrix插件
+## 1.2 适用场景
-## 插件设置
+* 服务不稳定，使用hystrix熔断保护服务
-请参考运维部署的内容，选择一种方式启动`shenyu-admin`。比如，通过
[本地部署](../../deployment/deployment-local) 启动`Apache ShenYu`后台管理系统。
+## 1.3 插件功能
-* 在 基础配置 `-->` 插件管理 `-->` `hystrix`，设置为开启。 如果用户不使用，可以将其关闭。
+* 熔断流量
+* 保护网关代理的服务
+* 隔离模式支持 `thread` 和 `semaphore`
-<img src="/img/shenyu/plugin/hystrix/hystrix_open.png" width="80%"
height="80%" />
+## 1.4 插件代码
+* 核心模块: `shenyu-plugin-hystrix`
-## 在网关中引入 hystrix 插件
+* 核心类: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 添加自哪个shenyu版本
+
+ShenYu 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
* 在网关的 `pom.xml` 文件中添加 `hystrix`的依赖。
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
-## hystrix 插件配置
+## 2.3 启用插件
-关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为开启。
+
+## 2.4 配置插件
-#### 选择器配置
+### 2.4.1 插件配置
+
+* 无配置，但你应该打开hystrix插件。
+
+### 2.4.2 选择器配置
用于对流量第一次筛选，不需要特殊处理字段。
-<img src="/img/shenyu/plugin/hystrix/selector.png" width="80%" height="80%" />
+关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
-#### 规则配置
+
-用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+### 2.4.3 规则配置
-<img src="/img/shenyu/plugin/hystrix/rule.png" width="80%" height="80%" />
+用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+
* `hystrix`处理详解：
@@ -67,3 +90,54 @@ description: hystrix插件
* 命令`Key`： 一般设置为具体的路径接口。
+
+## 2.5 示例
+
+### 2.5.1 使用hystrix熔断保护服务
+
+#### 2.5.1.1 准备工作
+
+- 启动 ShenYu Admin
+- 启动 ShenYu Bootstrap
+- 启动一个后端服务
+
+#### 2.5.1.2 选择器配置
+
+
+
+#### 2.5.1.3 规则配置
+
+* 以下图片的规则仅为测试使用，实际情况取决于特定的场景而定。
+
+
+
+* 测试案例
+
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
+
+#### 2.5.1.4 使用`Apache Jmeter`发送请求
+
+
+
+#### 2.5.1.5 验证结果
+
+
+
+# 3. 如何禁用插件
+
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为关闭。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
index 34d9580c35..bb3b4057d2 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,52 +4,75 @@ keywords: ["Hystrix"]
description: hystrix插件
---
+# 1. 概述
-## 说明
+## 1.1 插件名称
-* `hystrix`插件是网关用来对流量进行熔断的核心实现。
-* 隔离模式支持 `thread` 和 `semaphore` 。
+* Hystrix插件
+## 1.2 适用场景
-## 插件设置
+* 服务不稳定，使用hystrix熔断保护服务
-请参考运维部署的内容，选择一种方式启动`shenyu-admin`。比如，通过
[本地部署](../../deployment/deployment-local) 启动`Apache ShenYu`后台管理系统。
+## 1.3 插件功能
-* 在 基础配置 `-->` 插件管理 `-->` `hystrix`，设置为开启。 如果用户不使用，可以将其关闭。
+* 熔断流量
+* 保护网关代理的服务
+* 隔离模式支持 `thread` 和 `semaphore`
-<img src="/img/shenyu/plugin/hystrix/hystrix_open.png" width="80%"
height="80%" />
+## 1.4 插件代码
+* 核心模块: `shenyu-plugin-hystrix`
-## 在网关中引入 hystrix 插件
+* 核心类: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 添加自哪个shenyu版本
+
+ShenYu 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
* 在网关的 `pom.xml` 文件中添加 `hystrix`的依赖。
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
-## hystrix 插件配置
+## 2.3 启用插件
-关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为开启。
+
+## 2.4 配置插件
-#### 选择器配置
+### 2.4.1 插件配置
+
+* 无配置，但你应该打开hystrix插件。
+
+### 2.4.2 选择器配置
用于对流量第一次筛选，不需要特殊处理字段。
-<img src="/img/shenyu/plugin/hystrix/selector.png" width="80%" height="80%" />
+关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
-#### 规则配置
+
-用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+### 2.4.3 规则配置
-<img src="/img/shenyu/plugin/hystrix/rule.png" width="80%" height="80%" />
+用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+
* `hystrix`处理详解：
@@ -67,3 +90,54 @@ description: hystrix插件
* 命令`Key`： 一般设置为具体的路径接口。
+
+## 2.5 示例
+
+### 2.5.1 使用hystrix熔断保护服务
+
+#### 2.5.1.1 准备工作
+
+- 启动 ShenYu Admin
+- 启动 ShenYu Bootstrap
+- 启动一个后端服务
+
+#### 2.5.1.2 选择器配置
+
+
+
+#### 2.5.1.3 规则配置
+
+* 以下图片的规则仅为测试使用，实际情况取决于特定的场景而定。
+
+
+
+* 测试案例
+
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
+
+#### 2.5.1.4 使用`Apache Jmeter`发送请求
+
+
+
+#### 2.5.1.5 验证结果
+
+
+
+# 3. 如何禁用插件
+
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为关闭。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
index 34d9580c35..bb3b4057d2 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,52 +4,75 @@ keywords: ["Hystrix"]
description: hystrix插件
---
+# 1. 概述
-## 说明
+## 1.1 插件名称
-* `hystrix`插件是网关用来对流量进行熔断的核心实现。
-* 隔离模式支持 `thread` 和 `semaphore` 。
+* Hystrix插件
+## 1.2 适用场景
-## 插件设置
+* 服务不稳定，使用hystrix熔断保护服务
-请参考运维部署的内容，选择一种方式启动`shenyu-admin`。比如，通过
[本地部署](../../deployment/deployment-local) 启动`Apache ShenYu`后台管理系统。
+## 1.3 插件功能
-* 在 基础配置 `-->` 插件管理 `-->` `hystrix`，设置为开启。 如果用户不使用，可以将其关闭。
+* 熔断流量
+* 保护网关代理的服务
+* 隔离模式支持 `thread` 和 `semaphore`
-<img src="/img/shenyu/plugin/hystrix/hystrix_open.png" width="80%"
height="80%" />
+## 1.4 插件代码
+* 核心模块: `shenyu-plugin-hystrix`
-## 在网关中引入 hystrix 插件
+* 核心类: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 添加自哪个shenyu版本
+
+ShenYu 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
* 在网关的 `pom.xml` 文件中添加 `hystrix`的依赖。
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
-## hystrix 插件配置
+## 2.3 启用插件
-关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为开启。
+
+## 2.4 配置插件
-#### 选择器配置
+### 2.4.1 插件配置
+
+* 无配置，但你应该打开hystrix插件。
+
+### 2.4.2 选择器配置
用于对流量第一次筛选，不需要特殊处理字段。
-<img src="/img/shenyu/plugin/hystrix/selector.png" width="80%" height="80%" />
+关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
-#### 规则配置
+
-用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+### 2.4.3 规则配置
-<img src="/img/shenyu/plugin/hystrix/rule.png" width="80%" height="80%" />
+用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+
* `hystrix`处理详解：
@@ -67,3 +90,54 @@ description: hystrix插件
* 命令`Key`： 一般设置为具体的路径接口。
+
+## 2.5 示例
+
+### 2.5.1 使用hystrix熔断保护服务
+
+#### 2.5.1.1 准备工作
+
+- 启动 ShenYu Admin
+- 启动 ShenYu Bootstrap
+- 启动一个后端服务
+
+#### 2.5.1.2 选择器配置
+
+
+
+#### 2.5.1.3 规则配置
+
+* 以下图片的规则仅为测试使用，实际情况取决于特定的场景而定。
+
+
+
+* 测试案例
+
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
+
+#### 2.5.1.4 使用`Apache Jmeter`发送请求
+
+
+
+#### 2.5.1.5 验证结果
+
+
+
+# 3. 如何禁用插件
+
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为关闭。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
index 8e7fcd4227..bb3b4057d2 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,66 +4,140 @@ keywords: ["Hystrix"]
description: hystrix插件
---
+# 1. 概述
-## 说明
+## 1.1 插件名称
-* `hystrix`插件是网关用来对流量进行熔断的核心实现。
-* 隔离模式支持 `thread` 和 `semaphore` 。
+* Hystrix插件
+## 1.2 适用场景
-## 插件设置
+* 服务不稳定，使用hystrix熔断保护服务
-请参考运维部署的内容，选择一种方式启动`shenyu-admin`。比如，通过
[本地部署](../../deployment/deployment-local) 启动`Apache ShenYu`后台管理系统。
+## 1.3 插件功能
-* 在 基础配置 `-->` 插件管理 `-->` `hystrix`，设置为开启。 如果用户不使用，可以将其关闭。
+* 熔断流量
+* 保护网关代理的服务
+* 隔离模式支持 `thread` 和 `semaphore`
-<img src="/img/shenyu/plugin/hystrix/hystrix_open.png" width="80%"
height="80%" />
+## 1.4 插件代码
+* 核心模块: `shenyu-plugin-hystrix`
-## 在网关中引入 hystrix 插件
+* 核心类: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 添加自哪个shenyu版本
+
+ShenYu 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
* 在网关的 `pom.xml` 文件中添加 `hystrix`的依赖。
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
-## hystrix 插件配置
+## 2.3 启用插件
-关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为开启。
+
+## 2.4 配置插件
-#### 选择器配置
+### 2.4.1 插件配置
+
+* 无配置，但你应该打开hystrix插件。
+
+### 2.4.2 选择器配置
用于对流量第一次筛选，不需要特殊处理字段。
-<img src="/img/shenyu/plugin/hystrix/selector.png" width="80%" height="80%" />
+关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
-#### 规则配置
+
-用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+### 2.4.3 规则配置
-<img src="/img/shenyu/plugin/hystrix/rule.png" width="80%" height="80%" />
+用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+
* `hystrix`处理详解：
- * `MinimumRequests`(跳闸最小请求数量)：最小的请求量，至少要达到这个量才会触发熔断。
+ * 跳闸最小请求数量：最小的请求量，至少要达到这个量才会触发熔断。
+
+ * 错误百分比阀值： 这段时间内，发生异常的百分比。
+
+ * 最大并发量： 最大的并发量。
+
+ * 跳闸休眠时间`(ms)`：熔断以后恢复的时间。
+
+ * 分组`Key`： 一般设置为:`contextPath` 。
+
+ * 失败降级`URL`： 默认为 `/fallback/hystrix`。
+
+ * 命令`Key`： 一般设置为具体的路径接口。
+
+
+## 2.5 示例
+
+### 2.5.1 使用hystrix熔断保护服务
+
+#### 2.5.1.1 准备工作
+
+- 启动 ShenYu Admin
+- 启动 ShenYu Bootstrap
+- 启动一个后端服务
+
+#### 2.5.1.2 选择器配置
+
+
+
+#### 2.5.1.3 规则配置
+
+* 以下图片的规则仅为测试使用，实际情况取决于特定的场景而定。
+
+
+
+* 测试案例
- * `ErrorThresholdPercentage`(错误百分比阀值)： 这段时间内，发生异常的百分比。
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
- * `MaxConcurrentRequests`(最大并发量)： 最大的并发量。
+#### 2.5.1.4 使用`Apache Jmeter`发送请求
- * `Sleep`(跳闸休眠时间ms)：熔断以后恢复的时间。
+
- * `GroupKey`(分组Key)： 一般设置为:`contextPath` 。
+#### 2.5.1.5 验证结果
- * `CallBackUrl`(失败降级URL)： 默认为 `/fallback/hystrix`。
+
- * `CommandKey`(命令Key)： 一般设置为具体的路径接口。
+# 3. 如何禁用插件
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为关闭。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
index 34d9580c35..bb3b4057d2 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,52 +4,75 @@ keywords: ["Hystrix"]
description: hystrix插件
---
+# 1. 概述
-## 说明
+## 1.1 插件名称
-* `hystrix`插件是网关用来对流量进行熔断的核心实现。
-* 隔离模式支持 `thread` 和 `semaphore` 。
+* Hystrix插件
+## 1.2 适用场景
-## 插件设置
+* 服务不稳定，使用hystrix熔断保护服务
-请参考运维部署的内容，选择一种方式启动`shenyu-admin`。比如，通过
[本地部署](../../deployment/deployment-local) 启动`Apache ShenYu`后台管理系统。
+## 1.3 插件功能
-* 在 基础配置 `-->` 插件管理 `-->` `hystrix`，设置为开启。 如果用户不使用，可以将其关闭。
+* 熔断流量
+* 保护网关代理的服务
+* 隔离模式支持 `thread` 和 `semaphore`
-<img src="/img/shenyu/plugin/hystrix/hystrix_open.png" width="80%"
height="80%" />
+## 1.4 插件代码
+* 核心模块: `shenyu-plugin-hystrix`
-## 在网关中引入 hystrix 插件
+* 核心类: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 添加自哪个shenyu版本
+
+ShenYu 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
* 在网关的 `pom.xml` 文件中添加 `hystrix`的依赖。
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
-## hystrix 插件配置
+## 2.3 启用插件
-关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为开启。
+
+## 2.4 配置插件
-#### 选择器配置
+### 2.4.1 插件配置
+
+* 无配置，但你应该打开hystrix插件。
+
+### 2.4.2 选择器配置
用于对流量第一次筛选，不需要特殊处理字段。
-<img src="/img/shenyu/plugin/hystrix/selector.png" width="80%" height="80%" />
+关于选择器和规则配置的更多说明，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)，
这里只对部分字段进行了介绍。
-#### 规则配置
+
-用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+### 2.4.3 规则配置
-<img src="/img/shenyu/plugin/hystrix/rule.png" width="80%" height="80%" />
+用于对流量最终筛选，有规则处理逻辑，隔离模式支持 `thread` 和 `semaphore` 。
+
* `hystrix`处理详解：
@@ -67,3 +90,54 @@ description: hystrix插件
* 命令`Key`： 一般设置为具体的路径接口。
+
+## 2.5 示例
+
+### 2.5.1 使用hystrix熔断保护服务
+
+#### 2.5.1.1 准备工作
+
+- 启动 ShenYu Admin
+- 启动 ShenYu Bootstrap
+- 启动一个后端服务
+
+#### 2.5.1.2 选择器配置
+
+
+
+#### 2.5.1.3 规则配置
+
+* 以下图片的规则仅为测试使用，实际情况取决于特定的场景而定。
+
+
+
+* 测试案例
+
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
+
+#### 2.5.1.4 使用`Apache Jmeter`发送请求
+
+
+
+#### 2.5.1.5 验证结果
+
+
+
+# 3. 如何禁用插件
+
+在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `hystrix` 设置为关闭。
diff --git a/static/img/shenyu/plugin/hystrix/hystrix-example-rule-en.png
b/static/img/shenyu/plugin/hystrix/hystrix-example-rule-en.png
new file mode 100644
index 0000000000..29cc6db0e0
Binary files /dev/null and
b/static/img/shenyu/plugin/hystrix/hystrix-example-rule-en.png differ
diff --git a/static/img/shenyu/plugin/hystrix/hystrix-example-rule-zh.png
b/static/img/shenyu/plugin/hystrix/hystrix-example-rule-zh.png
new file mode 100644
index 0000000000..6de030eec5
Binary files /dev/null and
b/static/img/shenyu/plugin/hystrix/hystrix-example-rule-zh.png differ
diff --git a/static/img/shenyu/plugin/hystrix/hystrix-result.png
b/static/img/shenyu/plugin/hystrix/hystrix-result.png
new file mode 100644
index 0000000000..7ae3c2d830
Binary files /dev/null and
b/static/img/shenyu/plugin/hystrix/hystrix-result.png differ
diff --git a/static/img/shenyu/plugin/hystrix/hystrix-send-request.png
b/static/img/shenyu/plugin/hystrix/hystrix-send-request.png
new file mode 100644
index 0000000000..e85d7b41a2
Binary files /dev/null and
b/static/img/shenyu/plugin/hystrix/hystrix-send-request.png differ
diff --git
a/versioned_docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
b/versioned_docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
index b5e26b7944..77f5050270 100644
---
a/versioned_docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/versioned_docs/version-2.4.0/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,77 +4,139 @@ keywords: ["Hystrix"]
description: hystrix plugin
---
-## Description
+# 1. Overview
-* Hystrix plugin is the core implementation used by gateway to fuse traffic.
-* Support `thread` and `semaphore` .
+## 1.1 Plugin Name
-## Plugin Setting
+* Hystrix Plugin
-Select a mode to start shenyu-admin. For details, see deployment. For
example, with [Local Deployment](../../deployment/deployment-local) starts the
`Apache ShenYu` background management system.
+## 1.2 Appropriate Scenario
-* In BasicConfig --> Plugin --> hystrix, set to enable.
-* If the user don't use, please disable the plugin in the background.
+* The backend service is unstable, use hystrix for protection
-<img src="/img/shenyu/plugin/hystrix/hystrix_open_en.png" width="80%"
height="80%" />
+## 1.3 Plugin functionality
+* Fusing the flow
+* Protect the application behind ShenYu Gateway
+* Isolation mode supports `thread` and `semaphore`.
-## Add hystrix plugin dependency
+## 1.4 Plugin code
+
+* Core Module: `shenyu-plugin-hystrix`
+
+* Core Class: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
* Add `hystrix` dependency in the `pom.xml` file of the gateway.
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
+## 2.3 Enable plugin
+* In `shenyu-admin`--> BasicConfig --> Plugin --> `hystrix` set to enable.
-## Hystrix Config
+## 2.4 Config plugin
+### 2.4.1 Plugin Config
-For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
+* No Config, but you should open hystrix plugin.
-#### Selector Config
+### 2.4.2 Selector Config
It is used to filter traffic for the first time and does not require handle
fields.
-<img src="/img/shenyu/plugin/hystrix/selector_en.png" width="80%" height="80%"
/>
-
-#### Rule Config
+For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
-For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
-<img src="/img/shenyu/plugin/hystrix/rule_en.png" width="80%" height="80%" />
+### 2.4.3 Rule Config
+* For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
* Hystrix handler details:
- * Trip minimum request quantity: the minimum request quantity, which must be
reached at least before the fuse is triggered
- * Error half-score threshold: the percentage of exceptions in this period of
time.
- * Maximum concurrency: the maximum concurrency
- * Trip sleep time (ms): the recovery time after fusing.
- * Grouping Key: generally set as: contextPath
- * Command Key: generally set to specific path interface.
- * CallBackUrl: default url: /fallback/hystrix.
+ * `MinimumRequests`: the minimum number of requests required to trigger a
circuit breaker.
+
+ * `ErrorThresholdPercentage`: percentage of exception occurring during that
time.
+
+ * `MaxConcurrentRequests`: max concurrent requests.
+
+ * `Sleep`(ms): The recovery time after the circuit breaker.
+
+ * `GroupKey`: It is generally set to: `contextPath`.
+
+ * `CallBackUrl`: default url `/fallback/hystrix`.
+
+ * `CommandKey`: generally, it is set to a specific path interface.
+
+## 2.5 Examples
+
+### 2.5.1 use hystrix protect application
+
+#### 2.5.1.1 Preparation
+
+- Start ShenYu Admin
+- Start ShenYu Bootstrap
+- Start a backend service
+
+#### 2.5.1.2 Selector Config
+
+
+
+#### 2.5.1.3 Rule Config
+
+* The rules in the pictures below are test examples, actual environment
depends on the specific situation.
+
+
+
+* test example
- * MinimumRequests: the minimum number of requests required to trigger a
circuit breaker.
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
- * ErrorThresholdPercentage: percentage of exception occurring during that
time.
+#### 2.5.1.4 Send Request With `Apache Jmeter`
- * MaxConcurrentRequests: max concurrent requests.
+
- * Sleep`(ms)`: The recovery time after the circuit breaker.
+#### 2.5.1.5 Check Result
- * GroupKey: It is generally set to: `contextPath`.
+
- * CallBackUrl: default url `/fallback/hystrix`.
+# 3. How to disable plugin
- * CommandKey: generally, it is set to a specific path interface.
-
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `hystrix` set Status
disable.
diff --git
a/versioned_docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
b/versioned_docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
index b5e26b7944..77f5050270 100644
---
a/versioned_docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/versioned_docs/version-2.4.1/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,77 +4,139 @@ keywords: ["Hystrix"]
description: hystrix plugin
---
-## Description
+# 1. Overview
-* Hystrix plugin is the core implementation used by gateway to fuse traffic.
-* Support `thread` and `semaphore` .
+## 1.1 Plugin Name
-## Plugin Setting
+* Hystrix Plugin
-Select a mode to start shenyu-admin. For details, see deployment. For
example, with [Local Deployment](../../deployment/deployment-local) starts the
`Apache ShenYu` background management system.
+## 1.2 Appropriate Scenario
-* In BasicConfig --> Plugin --> hystrix, set to enable.
-* If the user don't use, please disable the plugin in the background.
+* The backend service is unstable, use hystrix for protection
-<img src="/img/shenyu/plugin/hystrix/hystrix_open_en.png" width="80%"
height="80%" />
+## 1.3 Plugin functionality
+* Fusing the flow
+* Protect the application behind ShenYu Gateway
+* Isolation mode supports `thread` and `semaphore`.
-## Add hystrix plugin dependency
+## 1.4 Plugin code
+
+* Core Module: `shenyu-plugin-hystrix`
+
+* Core Class: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
* Add `hystrix` dependency in the `pom.xml` file of the gateway.
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
+## 2.3 Enable plugin
+* In `shenyu-admin`--> BasicConfig --> Plugin --> `hystrix` set to enable.
-## Hystrix Config
+## 2.4 Config plugin
+### 2.4.1 Plugin Config
-For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
+* No Config, but you should open hystrix plugin.
-#### Selector Config
+### 2.4.2 Selector Config
It is used to filter traffic for the first time and does not require handle
fields.
-<img src="/img/shenyu/plugin/hystrix/selector_en.png" width="80%" height="80%"
/>
-
-#### Rule Config
+For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
-For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
-<img src="/img/shenyu/plugin/hystrix/rule_en.png" width="80%" height="80%" />
+### 2.4.3 Rule Config
+* For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
* Hystrix handler details:
- * Trip minimum request quantity: the minimum request quantity, which must be
reached at least before the fuse is triggered
- * Error half-score threshold: the percentage of exceptions in this period of
time.
- * Maximum concurrency: the maximum concurrency
- * Trip sleep time (ms): the recovery time after fusing.
- * Grouping Key: generally set as: contextPath
- * Command Key: generally set to specific path interface.
- * CallBackUrl: default url: /fallback/hystrix.
+ * `MinimumRequests`: the minimum number of requests required to trigger a
circuit breaker.
+
+ * `ErrorThresholdPercentage`: percentage of exception occurring during that
time.
+
+ * `MaxConcurrentRequests`: max concurrent requests.
+
+ * `Sleep`(ms): The recovery time after the circuit breaker.
+
+ * `GroupKey`: It is generally set to: `contextPath`.
+
+ * `CallBackUrl`: default url `/fallback/hystrix`.
+
+ * `CommandKey`: generally, it is set to a specific path interface.
+
+## 2.5 Examples
+
+### 2.5.1 use hystrix protect application
+
+#### 2.5.1.1 Preparation
+
+- Start ShenYu Admin
+- Start ShenYu Bootstrap
+- Start a backend service
+
+#### 2.5.1.2 Selector Config
+
+
+
+#### 2.5.1.3 Rule Config
+
+* The rules in the pictures below are test examples, actual environment
depends on the specific situation.
+
+
+
+* test example
- * MinimumRequests: the minimum number of requests required to trigger a
circuit breaker.
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
- * ErrorThresholdPercentage: percentage of exception occurring during that
time.
+#### 2.5.1.4 Send Request With `Apache Jmeter`
- * MaxConcurrentRequests: max concurrent requests.
+
- * Sleep`(ms)`: The recovery time after the circuit breaker.
+#### 2.5.1.5 Check Result
- * GroupKey: It is generally set to: `contextPath`.
+
- * CallBackUrl: default url `/fallback/hystrix`.
+# 3. How to disable plugin
- * CommandKey: generally, it is set to a specific path interface.
-
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `hystrix` set Status
disable.
diff --git
a/versioned_docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
b/versioned_docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
index b5e26b7944..77f5050270 100644
---
a/versioned_docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/versioned_docs/version-2.4.2/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,77 +4,139 @@ keywords: ["Hystrix"]
description: hystrix plugin
---
-## Description
+# 1. Overview
-* Hystrix plugin is the core implementation used by gateway to fuse traffic.
-* Support `thread` and `semaphore` .
+## 1.1 Plugin Name
-## Plugin Setting
+* Hystrix Plugin
-Select a mode to start shenyu-admin. For details, see deployment. For
example, with [Local Deployment](../../deployment/deployment-local) starts the
`Apache ShenYu` background management system.
+## 1.2 Appropriate Scenario
-* In BasicConfig --> Plugin --> hystrix, set to enable.
-* If the user don't use, please disable the plugin in the background.
+* The backend service is unstable, use hystrix for protection
-<img src="/img/shenyu/plugin/hystrix/hystrix_open_en.png" width="80%"
height="80%" />
+## 1.3 Plugin functionality
+* Fusing the flow
+* Protect the application behind ShenYu Gateway
+* Isolation mode supports `thread` and `semaphore`.
-## Add hystrix plugin dependency
+## 1.4 Plugin code
+
+* Core Module: `shenyu-plugin-hystrix`
+
+* Core Class: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
* Add `hystrix` dependency in the `pom.xml` file of the gateway.
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
+## 2.3 Enable plugin
+* In `shenyu-admin`--> BasicConfig --> Plugin --> `hystrix` set to enable.
-## Hystrix Config
+## 2.4 Config plugin
+### 2.4.1 Plugin Config
-For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
+* No Config, but you should open hystrix plugin.
-#### Selector Config
+### 2.4.2 Selector Config
It is used to filter traffic for the first time and does not require handle
fields.
-<img src="/img/shenyu/plugin/hystrix/selector_en.png" width="80%" height="80%"
/>
-
-#### Rule Config
+For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
-For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
-<img src="/img/shenyu/plugin/hystrix/rule_en.png" width="80%" height="80%" />
+### 2.4.3 Rule Config
+* For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
* Hystrix handler details:
- * Trip minimum request quantity: the minimum request quantity, which must be
reached at least before the fuse is triggered
- * Error half-score threshold: the percentage of exceptions in this period of
time.
- * Maximum concurrency: the maximum concurrency
- * Trip sleep time (ms): the recovery time after fusing.
- * Grouping Key: generally set as: contextPath
- * Command Key: generally set to specific path interface.
- * CallBackUrl: default url: /fallback/hystrix.
+ * `MinimumRequests`: the minimum number of requests required to trigger a
circuit breaker.
+
+ * `ErrorThresholdPercentage`: percentage of exception occurring during that
time.
+
+ * `MaxConcurrentRequests`: max concurrent requests.
+
+ * `Sleep`(ms): The recovery time after the circuit breaker.
+
+ * `GroupKey`: It is generally set to: `contextPath`.
+
+ * `CallBackUrl`: default url `/fallback/hystrix`.
+
+ * `CommandKey`: generally, it is set to a specific path interface.
+
+## 2.5 Examples
+
+### 2.5.1 use hystrix protect application
+
+#### 2.5.1.1 Preparation
+
+- Start ShenYu Admin
+- Start ShenYu Bootstrap
+- Start a backend service
+
+#### 2.5.1.2 Selector Config
+
+
+
+#### 2.5.1.3 Rule Config
+
+* The rules in the pictures below are test examples, actual environment
depends on the specific situation.
+
+
+
+* test example
- * MinimumRequests: the minimum number of requests required to trigger a
circuit breaker.
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
- * ErrorThresholdPercentage: percentage of exception occurring during that
time.
+#### 2.5.1.4 Send Request With `Apache Jmeter`
- * MaxConcurrentRequests: max concurrent requests.
+
- * Sleep`(ms)`: The recovery time after the circuit breaker.
+#### 2.5.1.5 Check Result
- * GroupKey: It is generally set to: `contextPath`.
+
- * CallBackUrl: default url `/fallback/hystrix`.
+# 3. How to disable plugin
- * CommandKey: generally, it is set to a specific path interface.
-
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `hystrix` set Status
disable.
diff --git
a/versioned_docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
b/versioned_docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
index e4c5f5675e..77f5050270 100644
---
a/versioned_docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
+++
b/versioned_docs/version-2.4.3/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -4,55 +4,75 @@ keywords: ["Hystrix"]
description: hystrix plugin
---
-## Description
+# 1. Overview
-* `Hystrix` plugin is the core implementation used by gateway to fuse traffic.
-* Support `thread` and `semaphore` .
+## 1.1 Plugin Name
-## Plugin Setting
+* Hystrix Plugin
-Select a mode to start shenyu-admin. For details, see deployment. For
example, with [Local Deployment](../../deployment/deployment-local) starts the
`Apache ShenYu` background management system.
+## 1.2 Appropriate Scenario
-* In BasicConfig --> Plugin --> hystrix, set to enable.
-* If the user don't use, please disable the plugin in the background.
+* The backend service is unstable, use hystrix for protection
-<img src="/img/shenyu/plugin/hystrix/hystrix_open_en.png" width="80%"
height="80%" />
+## 1.3 Plugin functionality
+* Fusing the flow
+* Protect the application behind ShenYu Gateway
+* Isolation mode supports `thread` and `semaphore`.
-## Add hystrix plugin dependency
+## 1.4 Plugin code
+
+* Core Module: `shenyu-plugin-hystrix`
+
+* Core Class: `org.apache.shenyu.plugin.hystrix.HystrixPlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
* Add `hystrix` dependency in the `pom.xml` file of the gateway.
```xml
- <!-- apache shenyu hystrix plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!-- apache shenyu hystrix plugin end-->
-```
+<!-- apache shenyu hystrix plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-hystrix</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!-- apache shenyu hystrix plugin end-->
+```
+## 2.3 Enable plugin
+* In `shenyu-admin`--> BasicConfig --> Plugin --> `hystrix` set to enable.
-## Hystrix Config
+## 2.4 Config plugin
+### 2.4.1 Plugin Config
-For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
+* No Config, but you should open hystrix plugin.
-#### Selector Config
+### 2.4.2 Selector Config
It is used to filter traffic for the first time and does not require handle
fields.
-<img src="/img/shenyu/plugin/hystrix/selector_en.png" width="80%" height="80%"
/>
-
-#### Rule Config
+For more information on selectors and rules configuration, see [Selector And
Rule Config](../../user-guide/admin-usage/selector-and-rule) , only some of the
fields are covered here.
-For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
-<img src="/img/shenyu/plugin/hystrix/rule_en.png" width="80%" height="80%" />
+### 2.4.3 Rule Config
+* For the final filtering of traffic, there is a rule handler logic, isolation
mode supports `thread` and `semaphore`.
+
* Hystrix handler details:
@@ -69,4 +89,54 @@ For the final filtering of traffic, there is a rule handler
logic, isolation mod
* `CallBackUrl`: default url `/fallback/hystrix`.
* `CommandKey`: generally, it is set to a specific path interface.
-
+
+## 2.5 Examples
+
+### 2.5.1 use hystrix protect application
+
+#### 2.5.1.1 Preparation
+
+- Start ShenYu Admin
+- Start ShenYu Bootstrap
+- Start a backend service
+
+#### 2.5.1.2 Selector Config
+
+
+
+#### 2.5.1.3 Rule Config
+
+* The rules in the pictures below are test examples, actual environment
depends on the specific situation.
+
+
+
+* test example
+
+```java
+@RestController
+@RequestMapping("/test")
+@ShenyuSpringMvcClient("/test/**")
+public class HttpTestController {
+ @PostMapping("/testHystrix")
+ public ResultBean ok() {
+ Random random = new Random();
+ int num = random.nextInt(100);
+ if (num > 20) {
+ throw new RuntimeException();
+ }
+ return new ResultBean(200, "ok", null);
+ }
+}
+```
+
+#### 2.5.1.4 Send Request With `Apache Jmeter`
+
+
+
+#### 2.5.1.5 Check Result
+
+
+
+# 3. How to disable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `hystrix` set Status
disable.
