This is an automated email from the ASF dual-hosted git repository.
liubao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-docs.git
The following commit(s) were added to refs/heads/master by this push:
new c16d0ba [SCB-2027]Refactor to add dedicated Section for Service
Governance
c16d0ba is described below
commit c16d0baeab6eb0fe5da20b3d8f17af30917b597a
Author: Jun Gan <[email protected]>
AuthorDate: Sun Jun 28 13:00:03 2020 -0400
[SCB-2027]Refactor to add dedicated Section for Service Governance
---
.../zh_CN/docs/references-handlers/ratelimit.md | 69 ++++++++++++++++++++++
java-chassis-reference/zh_CN/docs/toc.md | 31 +++++-----
java-chassis-reference/zh_CN/mkdocs.yml | 35 +++++------
3 files changed, 103 insertions(+), 32 deletions(-)
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/ratelimit.md
b/java-chassis-reference/zh_CN/docs/references-handlers/ratelimit.md
new file mode 100644
index 0000000..aa9d3ab
--- /dev/null
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/ratelimit.md
@@ -0,0 +1,69 @@
+# 限流
+
+## Provider端使用限流
+
+用户在provider端使用限流策略，可以限制指定微服务向其发送请求的频率，达到限制每秒钟最大请求数量的效果。
+
+### 注意事项
+
+1. 限流策略的控制并不是绝对精确的，可能会有少量误差。
+2. provider端的流量控制是业务层面的功能，不是安全意义上的流量控制，如需防止DDoS攻击，需要结合其他的一系列措施。
+3.
流量控制是微服务级的，不是实例级的。例如一个consumer服务有三个实例，当对它们依赖的provider实例配置限流策略后，provider不会区分consumer的请求具体是由哪个实例发出的，而是汇总成微服务级的统计数据进行限流判断。
+
+### 配置说明
+
+限流策略配置在microservice.yaml文件中，相关配置项见表**QPS流控配置项说明**。要开启服务提供者端的限流策略，还需要在处理链中配置服务端限流handler，并添加pom依赖。
+
+* microservice.yaml配置示例如下：
+ ```yaml
+ servicecomb:
+ handler:
+ chain:
+ Provider:
+ default: qps-flowcontrol-provider
+ ```
+* 添加handler-flowcontrol-qps的pom依赖：
+ ```xml
+ <dependency>
+ <groupId>org.apache.servicecomb</groupId>
+ <artifactId>handler-flowcontrol-qps</artifactId>
+ </dependency>
+ ```
+
+**QPS流控配置项说明**
+
+| 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 |
+| :--- | :--- | :--- | :--- | :--- | :--- |
+| servicecomb.flowcontrol.Provider.qps.enabled | true | true/false | 否 |
是否启用Provider流控 | - |
+|
servicecomb.flowcontrol.Provider.qps.limit.\[ServiceName\].\[Schema\].\[operation\]
| 2147483647（max int） | \(0,2147483647\]，整形 | 否 | 每秒钟允许的请求数 |
支持microservice/schema/operation三个级别的配置，后者的优先级高于前者 |
+| servicecomb.flowcontrol.Provider.qps.global.limit | 2147483647（max int） |
\(0,2147483647\]，整形 | 否 | provider接受请求流量的全局配置 | 没有具体的流控配置时，此配置生效 |
+
+> **注意：**
+>
provider端限流策略配置中的`ServiceName`指的是调用该provider的consumer，而`schema`、`operation`指的是provider自身的。即provider端限流配置的含义是，限制指定consumer调用本provider的某个schema、operation的流量。
+
+## Consumer端使用限流
+
+用户在consumer端使用限流策略，可以限制发往指定微服务的请求的频率。
+
+### 配置说明
+
+限流策略配置在microservice.yaml文件中，相关配置项见下表。要开启服务消费者端的限流策略，还需要在处理链中配置消费端限流handler，配置示例如下：
+
+```yaml
+servicecomb:
+ handler:
+ chain:
+ Consumer:
+ default: qps-flowcontrol-consumer
+```
+
+QPS流控配置项说明
+
+| 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 |
+| :--- | :--- | :--- | :--- | :--- | :--- |
+| servicecomb.flowcontrol.Consumer.qps.enabled | true | Boolean | 否 |
是否启用Consumer流控 | - |
+|
servicecomb.flowcontrol.Consumer.qps.limit.\[ServiceName\].\[Schema\].\[operation\]
| 2147483647 \(max int\) | \(0,2147483647\]，整形 | 否 | 每秒钟允许的请求数 |
支持microservice、schema、operation三个级别的配置 |
+
+
+
+
diff --git a/java-chassis-reference/zh_CN/docs/toc.md
b/java-chassis-reference/zh_CN/docs/toc.md
index 154a2ae..6cd781a 100644
--- a/java-chassis-reference/zh_CN/docs/toc.md
+++ b/java-chassis-reference/zh_CN/docs/toc.md
@@ -63,42 +63,43 @@
* [异常处理](general-development/error-handling.md)
* [微服务实例间多环境隔离](general-development/multienvironment.md)
* [线程模型](general-development/thread-model.md)
-* Transports:
+* 多样化的通信协议功能参考:
* [REST over Servlet](transports/rest-over-servlet.md)
* [REST over Vertx](transports/rest-over-vertx.md)
* [Highway](transports/highway-rpc.md)
* [HTTP2](transports/http2.md)
-* 管理注册发现:
+* 多样化的服务注册与发现功能参考:
* [注册发现说明](registry/introduction.md)
* [本地注册发现](registry/local-registry.md)
* [去中心化注册发现](registry/distributed.md)
* [连接多个服务中心](registry/multi-registries.md)
-* 管理服务配置:
- * [通用配置说明](config/general-config.md)
- * [配置注入机制](config/inject-config.md)
-- 服务能力开放:
+- 服务治理功能参考::
+ - [处理链介绍](references-handlers/intruduction.md)
+ - [负载均衡](references-handlers/loadbalance.md)
+ - [限流](references-handlers/ratelimit.md)
+ - [路由管理](references-handlers/router.md)
+ - [隔离熔断容错](references-handlers/bizkeeper.md)
+- 网关功能参考:
- [介绍](edge/open-service.md)
- [使用 Edge Service 做网关](edge/by-servicecomb-sdk.md)
- [使用 `zuul` 和 `spring cloud gateway` 做网关](edge/zuul.md)
- [nginx 网关简单介绍](edge/nginx.md)
+- 安全特性参考:
+ - [使用TLS通信](security/tls.md)
+ - [使用RSA认证](security/shi-yong-rsa-ren-zheng.md)
+ - [公钥认证](references-handlers/publickey.md)
+* 管理服务配置:
+ * [通用配置说明](config/general-config.md)
+ * [配置注入机制](config/inject-config.md)
- 服务打包和运行:
- [以standalone模式打包](packaging/standalone.md)
- [以WEB容器模式打包](packaging/web-container.md)
-- 微服务安全:
- - [使用TLS通信](security/tls.md)
- - [使用RSA认证](security/shi-yong-rsa-ren-zheng.md)
- 专题文章:
- [在Spring Boot中使用java
chassis](using-java-chassis-in-spring-boot/using-java-chassis-in-spring-boot.md)
- [使用 inspector 模块查看契约](featured-topics/using-inspector.md)
- [兼容问题和兼容性策略](featured-topics/compatibility.md)
- [新功能介绍系列文章](featured-topics/features.md)
- [升级指导系列文章](featured-topics/upgrading.md)
-- 处理链参考:
- - [处理链介绍](references-handlers/intruduction.md)
- - [负载均衡](references-handlers/loadbalance.md)
- - [路由管理](references-handlers/router.md)
- - [隔离熔断容错](references-handlers/bizkeeper.md)
- - [公钥认证](references-handlers/publickey.md)
- 常用配置项参考:
- [REST Transport Client 配置项](config-reference/rest-transport-client.md)
- [Config Center Client 配置项](config-reference/config-center-client.md)
diff --git a/java-chassis-reference/zh_CN/mkdocs.yml
b/java-chassis-reference/zh_CN/mkdocs.yml
index 682ee2c..ab91d4c 100644
--- a/java-chassis-reference/zh_CN/mkdocs.yml
+++ b/java-chassis-reference/zh_CN/mkdocs.yml
@@ -10,42 +10,44 @@ nav:
- 开发服务消费者: build-consumer/catalog.md
- 通用功能开发: general-development/catalog.md
-- Transports:
+- 多样化的通信协议功能参考:
- REST over Servlet: transports/rest-over-servlet.md
- REST over Vertx: transports/rest-over-vertx.md
- Highway: transports/highway-rpc.md
- HTTP2: transports/http2.md
-- 管理注册发现:
+- 多样化的服务注册与发现功能参考:
- 注册发现说明: registry/introduction.md
- 本地注册发现: registry/local-registry.md
- 去中心化注册发现: registry/distributed.md
- 连接多个服务中心: registry/multi-registries.md
+- 服务治理功能参考:
+ - 处理链介绍: references-handlers/intruduction.md
+ - 负载均衡: references-handlers/loadbalance.md
+ - 限流: references-handlers/ratelimit.md
+ - 路由管理: references-handlers/router.md
+ - 隔离熔断容错: references-handlers/bizkeeper.md
+- 网关功能参考:
+ - 介绍: edge/open-service.md
+ - 使用 Edge Service 做网关: edge/by-servicecomb-sdk.md
+ - 使用 `zuul` 和 `spring cloud gateway` 做网关: edge/zuul.md
+ - nginx 网关简单介绍: edge/nginx.md
+- 安全特性参考:
+ - 公钥认证: references-handlers/publickey.md
+ - 使用TLS通信: security/tls.md
+ - 使用RSA认证: security/shi-yong-rsa-ren-zheng.md
- 管理服务配置:
- 通用配置说明: config/general-config.md
- 配置注入机制: config/inject-config.md
-- 服务能力开放:
- - 介绍: edge/open-service.md
- - 使用 Edge Service 做网关: edge/by-servicecomb-sdk.md
- - 使用 `zuul` 和 `spring cloud gateway` 做网关: edge/zuul.md
- - nginx 网关简单介绍: edge/nginx.md
+
- 服务打包和运行:
- 以standalone模式打包: packaging/standalone.md
- 以WEB容器模式打包: packaging/web-container.md
-- 微服务安全:
- - 使用TLS通信: security/tls.md
- - 使用RSA认证: security/shi-yong-rsa-ren-zheng.md
- 专题文章:
- 在Spring Boot中使用java chassis:
using-java-chassis-in-spring-boot/using-java-chassis-in-spring-boot.md
- 使用 inspector 模块查看契约: featured-topics/using-inspector.md
- 新功能介绍系列文章: featured-topics/features.md
- 兼容问题和兼容性策略: featured-topics/compatibility.md
- 升级指导系列文章: featured-topics/upgrading.md
-- 处理链参考:
- - 处理链介绍: references-handlers/intruduction.md
- - 负载均衡: references-handlers/loadbalance.md
- - 路由管理: references-handlers/router.md
- - 隔离熔断容错: references-handlers/bizkeeper.md
- - 公钥认证: references-handlers/publickey.md
- 常用配置项参考:
- REST Transport Client 配置项: config-reference/rest-transport-client.md
- Config Center Client 配置项: config-reference/config-center-client.md
@@ -55,7 +57,6 @@ nav:
- 'Q & A' : question-and-answer/question_answer.md
- 'FAQ' : question-and-answer/faq.md
- 微服务接口兼容常见问题: question-and-answer/interface-compatibility.md
-
theme: readthedocs
plugins:
- search:
