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/incubator-shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new 13eae73 [DOC] Optimize the description of plugin documentation (#475)
13eae73 is described below
commit 13eae733564a9585fe86c46ed3af0c49e39bdd4f
Author: erdengk <[email protected]>
AuthorDate: Mon Mar 7 11:12:32 2022 +0800
[DOC] Optimize the description of plugin documentation (#475)
* fix doc desrcibe
* fix doc desrcibe
---
.../fault-tolerance/hystrix-plugin.md | 24 +++++--------
.../fault-tolerance/rate-limiter-plugin.md | 2 +-
.../fault-tolerance/sentinel-plugin.md | 4 +--
.../fault-tolerance/hystrix-plugin.md | 14 ++++----
.../fault-tolerance/resilience4j-plugin.md | 24 ++++++-------
.../fault-tolerance/sentinel-plugin.md | 39 +++++++++++++---------
6 files changed, 53 insertions(+), 54 deletions(-)
diff --git a/docs/plugin-center/fault-tolerance/hystrix-plugin.md
b/docs/plugin-center/fault-tolerance/hystrix-plugin.md
index b5e26b7..e4c5f56 100644
--- a/docs/plugin-center/fault-tolerance/hystrix-plugin.md
+++ b/docs/plugin-center/fault-tolerance/hystrix-plugin.md
@@ -6,7 +6,7 @@ description: hystrix plugin
## Description
-* Hystrix plugin is the core implementation used by gateway to fuse traffic.
+* `Hystrix` plugin is the core implementation used by gateway to fuse traffic.
* Support `thread` and `semaphore` .
## Plugin Setting
@@ -56,25 +56,17 @@ For the final filtering of traffic, there is a rule handler
logic, isolation mod
* 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.
- * MinimumRequests: the minimum number of requests required to trigger a
circuit breaker.
+ * `ErrorThresholdPercentage`: percentage of exception occurring during that
time.
- * ErrorThresholdPercentage: percentage of exception occurring during that
time.
+ * `MaxConcurrentRequests`: max concurrent requests.
- * MaxConcurrentRequests: max concurrent requests.
+ * `Sleep`(ms): The recovery time after the circuit breaker.
- * Sleep`(ms)`: The recovery time after the circuit breaker.
+ * `GroupKey`: It is generally set to: `contextPath`.
- * GroupKey: It is generally set to: `contextPath`.
+ * `CallBackUrl`: default url `/fallback/hystrix`.
- * CallBackUrl: default url `/fallback/hystrix`.
-
- * CommandKey: generally, it is set to a specific path interface.
+ * `CommandKey`: generally, it is set to a specific path interface.
diff --git a/docs/plugin-center/fault-tolerance/rate-limiter-plugin.md
b/docs/plugin-center/fault-tolerance/rate-limiter-plugin.md
index e9ca1bd..6d41087 100644
--- a/docs/plugin-center/fault-tolerance/rate-limiter-plugin.md
+++ b/docs/plugin-center/fault-tolerance/rate-limiter-plugin.md
@@ -6,7 +6,7 @@ description: rateLimiter plugin
## Description
-* RateLimiter is core implementation of gateway restrictions on network
traffic.
+* `RateLimiter` is core implementation of gateway restrictions on network
traffic.
* the Apache ShenYu gateway provides a variety of current limiting algorithms,
including `token bucket algorithm`, `concurrent token bucket algorithm`, `leaky
bucket algorithm` and `sliding time window algorithm`.
diff --git a/docs/plugin-center/fault-tolerance/sentinel-plugin.md
b/docs/plugin-center/fault-tolerance/sentinel-plugin.md
index 3341dbe..7b1d4c5 100644
--- a/docs/plugin-center/fault-tolerance/sentinel-plugin.md
+++ b/docs/plugin-center/fault-tolerance/sentinel-plugin.md
@@ -7,8 +7,8 @@ description: sentinel plugin
## Description
-* Sentinel is one of the options that supports flow control and circuit
breaking.
-* Sentinel supports flow control and circuit breaking functions for gateway.
+* `Sentinel` is one of the options that supports flow control and circuit
breaking.
+* `Sentinel` supports flow control and circuit breaking functions for gateway.
## Plugin Setting
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 34d9580..8e7fcd4 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
@@ -53,17 +53,17 @@ description: hystrix插件
* `hystrix`处理详解：
- * 跳闸最小请求数量：最小的请求量，至少要达到这个量才会触发熔断。
+ * `MinimumRequests`(跳闸最小请求数量)：最小的请求量，至少要达到这个量才会触发熔断。
- * 错误百分比阀值： 这段时间内，发生异常的百分比。
+ * `ErrorThresholdPercentage`(错误百分比阀值)： 这段时间内，发生异常的百分比。
- * 最大并发量： 最大的并发量。
+ * `MaxConcurrentRequests`(最大并发量)： 最大的并发量。
- * 跳闸休眠时间`(ms)`：熔断以后恢复的时间。
+ * `Sleep`(跳闸休眠时间ms)：熔断以后恢复的时间。
- * 分组`Key`： 一般设置为:`contextPath` 。
+ * `GroupKey`(分组Key)： 一般设置为:`contextPath` 。
- * 失败降级`URL`： 默认为 `/fallback/hystrix`。
+ * `CallBackUrl`(失败降级URL)： 默认为 `/fallback/hystrix`。
- * 命令`Key`： 一般设置为具体的路径接口。
+ * `CommandKey`(命令Key)： 一般设置为具体的路径接口。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/resilience4j-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/resilience4j-plugin.md
index 083d327..009482f 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/resilience4j-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/resilience4j-plugin.md
@@ -52,28 +52,28 @@ description: resilience4j插件
* `resilience4j`处理详解：
- * `limitForPeriod`：每次刷新令牌的数量，默认值：`50`。
+ * `limitForPeriod`(每次刷新令牌的数量): 默认值：`50`。
- * `limitRefreshPeriod`：刷新令牌的时间间隔，单位`ms`，默认值：`500`。
+ * `limitRefreshPeriod`(刷新令牌的时间间隔): 单位`ms`，默认值：`500`。
- * `timeoutDurationRate`：等待获取令牌的超时时间，单位`ms`，默认值：`5000`。
+ * `timeoutDurationRate`(等待获取令牌的超时时间): 单位`ms`，默认值：`5000`。
- * `circuitEnable`：是否开启熔断，`0`：关闭，`1`：开启，默认值：`0`。
+ * `circuitEnable`(是否开启熔断): `0`：关闭，`1`：开启，默认值：`0`。
- * `failureRateThreshold`：错误率百分比，达到这个阈值，熔断器才会开启，默认值：`50`。
+ * `failureRateThreshold`(错误率百分比): 达到这个阈值，熔断器才会开启，默认值：`50`。
- * `fallbackUri`：降级处理的`uri`。
+ * `fallbackUri`：降级处理的`uri`
- * `minimumNumberOfCalls`：开启熔断的最小请求数，超过这个请求数才开启熔断统计，默认值：`100`。
+ * `minimumNumberOfCalls`(开启熔断的最小请求数): 超过这个请求数才开启熔断统计，默认值：`100`。
- * `bufferSizeInHalfOpen`：半开状态下的环形缓冲区大小，必须达到此数量才会计算失败率，默认值：`10`。
+ * `bufferSizeInHalfOpen`(半开状态下的环形缓冲区大小): 必须达到此数量才会计算失败率，默认值：`10`。
- * `slidingWindowSize`：滑动窗口大小，默认值：`100`。
+ * `slidingWindowSize`(滑动窗口大小): 默认值：`100`。
- * `slidingWindowType`：滑动窗口类型，`0`：基于计数，`1`：基于时间，默认值：`0`。
+ * `slidingWindowType`(滑动窗口类型): `0`：基于计数，`1`：基于时间，默认值：`0`。
- * `timeoutDuration`：熔断超时时间，单位`ms`，默认值：`30000`。
+ * `timeoutDuration`(熔断超时时间): 单位`ms`，默认值：`30000`。
- * `waitIntervalInOpen`：熔断器开启持续时间，单位`ms`，默认值：`60000`。
+ * `waitIntervalInOpen`(熔断器开启持续时间): 单位`ms`，默认值：`60000`。
*
`automaticTransitionFromOpenToHalfOpenEnabled`：是否自动从`open`状态转换为`half-open`状态，`true`：是，`false`：否，默认值：`false`。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/sentinel-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/sentinel-plugin.md
index 8028ffd..b75a04e 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/sentinel-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/fault-tolerance/sentinel-plugin.md
@@ -54,19 +54,26 @@ description: sentinel插件
* `sentinel`处理详解：
- * 是否开启流控(1或0) ：是否开启`sentinel`的流控。
-
- * 流控效果 ： 流控效果（直接拒绝 / 排队等待 / 慢启动模式），不支持按调用关系限流。
-
- * 限流阈值类型 ： 限流阈值类型，`QPS` 或线程数模式。
-
- * 是否开启熔断(1或0) ：是否开启`sentinel`熔断。
-
- * 熔断类型： 熔断策略，支持秒级 `RT`/秒级异常比例/分钟级异常数。
-
- * 熔断阈值: 阈值。
-
- * 熔断窗口大小: 降级的时间，单位为 s。
-
- * 熔断`URI`: 熔断后的降级`uri`。
-
+ * `degradeRuleCount`:临界点
+
+ * `degradeRuleEnable`(是否开启流控 (1或0) ) ：是否开启`sentinel`的流控。
+
+ * `degradeRuleGrade`(断路器策略): 支持秒级RT/秒级Error Ratio/分钟级Error Count策略。
+
+ * `degradeRuleMinRequestAmount`：断路器最小请求量。
+
+ * `degradeRuleSlowRatioThreshold`：退化的慢比率阈值。
+
+ * `getDegradeRuleStatIntervals`: 降级的状态间隔。
+
+ * `degradeRuleTimeWindow`：退化时间（单位：秒）。
+
+ * `flowRuleControlBehavior`：效果（直接拒绝/排队/慢启动），不支持调用关系流控。
+
+ * `flowRuleCount`：哨兵流控制计数。
+
+ * `flowRuleEnable (1 or 0)`：是否开启哨兵流控功能。
+
+ * `flowRuleGrade`: 限流阈值的类型（QPS 或 Thread Count）。
+
+ * `fallbackUri`：断路后降级的uri。
