You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by li...@apache.org on 2023/11/10 08:11:36 UTC
(servicecomb-docs) branch master updated (615f4a0 -> a933572)
This is an automated email from the ASF dual-hosted git repository.
liubao pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-docs.git
from 615f4a0 update service definition (#296)
new c2cdde0 remove redundant packaging catalog
new a933572 update Filters related docs
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../zh_CN/docs/assets/loadbalance-001.png | Bin 39048 -> 0 bytes
.../zh_CN/docs/packaging/standalone.md | 25 -----
.../zh_CN/docs/packaging/web-container.md | 20 ----
.../docs/references-handlers/common-governance.png | Bin 0 -> 61539 bytes
.../docs/references-handlers/discovery-tree.png | Bin 0 -> 25140 bytes
.../zh_CN/docs/references-handlers/fail-retry.md | 119 ++++++++-------------
.../docs/references-handlers/fault-injection.md | 10 --
.../docs/references-handlers/flow-consumer.png | Bin 0 -> 18888 bytes
.../zh_CN/docs/references-handlers/flow-edge.png | Bin 0 -> 24332 bytes
.../docs/references-handlers/flow-provider.png | Bin 0 -> 26675 bytes
.../zh_CN/docs/references-handlers/governance.md | 28 -----
.../zh_CN/docs/references-handlers/intruduction.md | 100 +++++++----------
.../zh_CN/docs/references-handlers/loadbalance.md | 30 ++----
.../zh_CN/docs/references-handlers/publickey.md | 23 +---
.../zh_CN/docs/references-handlers/ratelimit.md | 36 +------
.../zh_CN/docs/references-handlers/router.md | 70 +++++-------
.../zh_CN/docs/start/terminology.md | 34 +++---
java-chassis-reference/zh_CN/mkdocs.yml | 6 +-
18 files changed, 141 insertions(+), 360 deletions(-)
delete mode 100644 java-chassis-reference/zh_CN/docs/assets/loadbalance-001.png
delete mode 100644 java-chassis-reference/zh_CN/docs/packaging/standalone.md
delete mode 100644 java-chassis-reference/zh_CN/docs/packaging/web-container.md
create mode 100644 java-chassis-reference/zh_CN/docs/references-handlers/common-governance.png
create mode 100644 java-chassis-reference/zh_CN/docs/references-handlers/discovery-tree.png
create mode 100644 java-chassis-reference/zh_CN/docs/references-handlers/flow-consumer.png
create mode 100644 java-chassis-reference/zh_CN/docs/references-handlers/flow-edge.png
create mode 100644 java-chassis-reference/zh_CN/docs/references-handlers/flow-provider.png
(servicecomb-docs) 02/02: update Filters related docs
Posted by li...@apache.org.
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
commit a93357262809485dbdd1bd56a6a42753b6f755fb
Author: liubao <bi...@qq.com>
AuthorDate: Fri Nov 10 16:06:37 2023 +0800
update Filters related docs
---
.../zh_CN/docs/assets/loadbalance-001.png | Bin 39048 -> 0 bytes
.../docs/references-handlers/common-governance.png | Bin 0 -> 61539 bytes
.../docs/references-handlers/discovery-tree.png | Bin 0 -> 25140 bytes
.../zh_CN/docs/references-handlers/fail-retry.md | 119 ++++++++-------------
.../docs/references-handlers/fault-injection.md | 10 --
.../docs/references-handlers/flow-consumer.png | Bin 0 -> 18888 bytes
.../zh_CN/docs/references-handlers/flow-edge.png | Bin 0 -> 24332 bytes
.../docs/references-handlers/flow-provider.png | Bin 0 -> 26675 bytes
.../zh_CN/docs/references-handlers/governance.md | 28 -----
.../zh_CN/docs/references-handlers/intruduction.md | 100 +++++++----------
.../zh_CN/docs/references-handlers/loadbalance.md | 30 ++----
.../zh_CN/docs/references-handlers/publickey.md | 23 +---
.../zh_CN/docs/references-handlers/ratelimit.md | 36 +------
.../zh_CN/docs/references-handlers/router.md | 70 +++++-------
java-chassis-reference/zh_CN/mkdocs.yml | 3 +-
15 files changed, 123 insertions(+), 296 deletions(-)
diff --git a/java-chassis-reference/zh_CN/docs/assets/loadbalance-001.png b/java-chassis-reference/zh_CN/docs/assets/loadbalance-001.png
deleted file mode 100644
index 6852bf7..0000000
Binary files a/java-chassis-reference/zh_CN/docs/assets/loadbalance-001.png and /dev/null differ
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/common-governance.png b/java-chassis-reference/zh_CN/docs/references-handlers/common-governance.png
new file mode 100644
index 0000000..ea9d2f1
Binary files /dev/null and b/java-chassis-reference/zh_CN/docs/references-handlers/common-governance.png differ
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/discovery-tree.png b/java-chassis-reference/zh_CN/docs/references-handlers/discovery-tree.png
new file mode 100644
index 0000000..8e1c790
Binary files /dev/null and b/java-chassis-reference/zh_CN/docs/references-handlers/discovery-tree.png differ
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/fail-retry.md b/java-chassis-reference/zh_CN/docs/references-handlers/fail-retry.md
index 7fde294..72e80e8 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/fail-retry.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/fail-retry.md
@@ -10,7 +10,7 @@
快速失败的问题。
使用`请求超时`配置来控制快速失败是非常常见的手段,因为它简洁无侵入,适用于大多数对于性能要求不高的场景。但是对于大规模应用系统,以及
-对于请求时延要求非常高的系统,`请求超时`并不是一个快速失败的有效手段。
+对于请求时延要求非常高的系统,`请求超时`并不是快速失败的有效手段,有如下原因:
* 请求超时在使用HTTP协议的情况下,会关闭连接。连接重连是非常耗时的操作,大量重连会导致系统性能的严重恶化。
* 在多线程系统,请求超时都是通过独立的线程进行检测的。这里涉及一个实时计算的问题。JDK并不能很好的应用于实时计算。简单的讲就是超时
@@ -23,85 +23,56 @@
## 如何应用重试和快速失败
-* 在网关进行重试一般是比较推荐的做法,除了重试,网关还需要加入流量控制和流量梳理功能,过滤超出系统处理能力的流量,并将突发的流量
- 转换为平滑的流量。微服务系统内部的请求进行重试可以作为补充,但是超时等错误场景,不应该进行重试。
+* 重试的最佳发起方是直接的消费者,比如对于WEB浏览器、手机APP等前端应用。
+* 如果前端应用无法重试,在网关进行重试一般是比较推荐的做法,除了重试,网关还需要加入流量控制和流量梳理功能,过滤超出系统处理能力的流量,并将突发的流量
+ 转换为平滑的流量。
+* 微服务系统内部的请求进行重试可以作为补充,建议限制重试次数为2,超时等错误场景,重试可能带来性能恶化。
* 当业务的平均时延在1ms~10ms,建议超时时间配置不小于1s;10~100ms,超时时间配置不小于5s;大于100ms,超时时间配置不小于10s。
不建议超时时间超过30s(缺省值)。当业务某些请求需要超过30s的时候,应该对这些业务逻辑进行特殊处理,比如修改为独立线程池执行,
并设置独立的超时时间;或者修改为异步执行,请求来的时候立即返回,通过异步的方式查询任务执行结果。
-通常业务都能够容忍超时给用户带来的偶然操作错误,无需对超时场景重试,依赖于超时设置进行快速失败是非常简单易用的技术手段。有些业务系统对用户体验
-提出了更高的要求,比如快速失败控制在100ms以下,网关能够对超时的场景也进行重试。由于超时时间设置并不能很好的处理这种精度,侵入式的
-超时检测就变得非常重要。
+Java Chassis建议在应用中搭配使用提供者流控和消费者隔离仓,来实现快速失败和重试。 下面是一个微服务的典型治理结构:
-侵入式超时检测在业务执行线程中执行,当业务逻辑执行到某个点,就进行一个超时检测,如果发现超时,就立即停止处理并返回超时错误。侵入式
-超时检测有非常多的优点:
+
-* 不会导致HTTP连接关闭。因此应用可以设置更大的非侵入式超时时间,更小的侵入式超时时间,避免网络请求超时时间过小,引起的随机故障。
-* 侵入式检测可以由业务在合理的执行点进行检测,能够更加优雅的进行资源清理,防止程序状态不一致带来的问题。
-
-侵入式超时检测需要额外在业务代码中插入检测代码,会给代码带来一定的复杂性,可以采用切面等技术将这些逻辑进行有效隔离。
-
-
-## Java Chassis的侵入式超时检测机制
-
-Java Chassis 将请求的执行分为很多阶段,以客户端A将REST请求发送到服务端B为例,请求执行包括如下阶段:
-
-* 开始
-* A 执行 Handler
-* A 执行 HttpClientFilter
-* A 发送请求
-* B 收到请求
-* B 执行 HttpServerFilter
-* B 执行 Handler
-* B 执行 业务逻辑
-* B 执行 Handler
-* B 执行 HttpServerFilter
-* B 发送响应
-* A 收到响应
-* A 执行 HttpClientFilter
-* A 执行 Handler
-* 结束
-
-Java Chassis 会在上述过程的开始阶段,执行超时检测,如果发现请求超时,会返回 InvocationException, 并包含 408 错误码。
-
-侵入式超时机制在 2.3.0 版本提供, 控制侵入式超时有如下配置:
-
-| 配置项 | 默认值 | 含义 |
-| :--- | :--- | :--- |
-| servicecomb.invocation.timeout.check.enabled | false | 功能开关,默认关闭 |
-| servicecomb.invocation.timeout.check.strategy | passing-time | 全局时间计算策略,可选 passing-time 和 processing-time|
-| servicecomb.invocation.${op-any-priority}.timeout | -1 | 请求超时时间,默认为-1,表示不超时 |
-
-侵入式超时时间支持全局配置和针对某个具体接口配置, Producer 和 Consumer 配置不同。 比如:
+该治理结构对应的配置为:
```yaml
-# 指定默认的超时时间为 60 秒
-servicecomb.invocation.timeout: 60000
-
-# 指定 Producer 的 ${schema_id}.${operation_id} 的执行时间为 1 秒
-servicecomb.invocation.${schema_id}.${operation_id}.timeout: 1000
-
-# 指定 Consumer 的 ${target_service}.${schema_id}.${operation_id} 的执行时间为 1 秒
-servicecomb.invocation.${target_service}.${schema_id}.${operation_id}.timeout: 1000
-```
-
-侵入式超时检测具备传播机制。 比如客户端->A->B的场景,当B判断是否已经超时的时候,会加上在A已经处理的时间。因此可以用侵入式超时时间控制
-请求链路的全局超时。 由于机器时间同步问题,全局超时包括两种计算方式,第一种是 passing-time,这种方式依赖于服务器的时间同步,B计算
-运行时间通过A记录的开始时间与B当前时间的差值;第二种是 processing-time,B在计算超时的时候,A的请求在网络传输的时间被忽略掉了,只计算实际
-在A已经处理的时间加上B已经处理的时间。第一种方式适合于服务器之间的时间非常同步,可以忽略差异的场景。第二种方式更加适合于不考虑时间同步,但是
-对于实际计算时间精度要求不高的场景。
-
-开发者也可以在自定义 Filter, Handler, 业务逻辑(比如执行数据库操作前和操作后)增加超时检测。 具体方式是先获取 `Invocation` 对象, 然后调用
-`ensureInvocationNotTimeout` 方法。
-
-```java
-public String testInvocationTimeout(InvocationContext context) {
- someTimeConsumingOperartion();
-
- Invocation invocation = (Invocation) context;
- invocation.ensureInvocationNotTimeout();
-
- otherOpertions();
-}
+## 服务治理配置
+servicecomb:
+ matchGroup:
+ allOperation:
+ matches:
+ - apiPath:
+ prefix: "/"
+ rateLimiting:
+ ## 限流器每10毫秒允许通过100个请求,如果一个请求超过1000毫秒没有获取到
+ ## 许可,将被拒绝
+ allOperation: |
+ rate: 10
+ limitRefreshPeriod: 1
+ timeoutDuration: 1000
+ retry:
+ ## 重试器最多重试2次,并且尽可能选择不同于失败的实例进行重试。
+ allOperation: |
+ maxAttempts: 2
+ retryOnSame: 0
+ instanceIsolation:
+ ## 熔断器错误率达到50%或者耗时请求达到100%,将开启。
+ ## 开启时间为5000毫秒,然后会放通10个请求。
+ allOperation: |
+ minimumNumberOfCalls: 10
+ slidingWindowSize: 100
+ slidingWindowType: COUNT_BASED
+ failureRateThreshold: 50
+ slowCallRateThreshold: 50
+ slowCallDurationThreshold: 5000
+ waitDurationInOpenState: 5000
+ permittedNumberOfCallsInHalfOpenState: 10
+ instanceBulkhead:
+ ## 隔离仓限制正在处理的请求数为20个,新来的请求等待1000毫秒没有获取到
+ ## 许可,将被拒绝。
+ allOperation: |
+ maxConcurrentCalls: 20
+ maxWaitDuration: 1000
```
-
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/fault-injection.md b/java-chassis-reference/zh_CN/docs/references-handlers/fault-injection.md
index f0b9796..a0f0a71 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/fault-injection.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/fault-injection.md
@@ -8,16 +8,6 @@
## 配置说明
-故障注入配置在microservice.yaml文件中,相关配置项见下表。要开启服务消费者端的故障注入,还需要在处理链中配置消费端故障注入handler,配置示例如下:
-
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: loadbalance,fault-injection-consumer
-```
-
故障注入配置项说明
\[scope\]代表故障注入的生效范围,可配置值包括全局配置\_global,或指定微服务的服务名\[ServiceName\]。
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/flow-consumer.png b/java-chassis-reference/zh_CN/docs/references-handlers/flow-consumer.png
new file mode 100644
index 0000000..5ae5b75
Binary files /dev/null and b/java-chassis-reference/zh_CN/docs/references-handlers/flow-consumer.png differ
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/flow-edge.png b/java-chassis-reference/zh_CN/docs/references-handlers/flow-edge.png
new file mode 100644
index 0000000..83d5087
Binary files /dev/null and b/java-chassis-reference/zh_CN/docs/references-handlers/flow-edge.png differ
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/flow-provider.png b/java-chassis-reference/zh_CN/docs/references-handlers/flow-provider.png
new file mode 100644
index 0000000..fe3b47a
Binary files /dev/null and b/java-chassis-reference/zh_CN/docs/references-handlers/flow-provider.png differ
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/governance.md b/java-chassis-reference/zh_CN/docs/references-handlers/governance.md
index 957c668..3fe5bbe 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/governance.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/governance.md
@@ -19,16 +19,6 @@
## 使用客户端熔断
-在 `Handler` 中包含客户端熔断处理链:
-
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: loadbalance,instance-isolation-consumer
-```
-
配置参数:
```
@@ -49,16 +39,6 @@ servicecomb:
## 使用客户端隔离仓
-在 `Handler` 中包含客户端熔断处理链:
-
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: loadbalance,instance-bulkhead-consumer
-```
-
配置参数:
```
@@ -93,14 +73,6 @@ maxAttempts表示最大重试次数(不包括第1次调用),retryOnSame表
一个比较好的实践是组合使用 `重试` 、 `客户端熔断` 和 `客户端隔离仓`。
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: loadbalance,instance-isolation-consumer,instance-bulkhead-consumer
-```
-
这种组合可以防止偶然的实例错误导致的失败,也可以防止单个实例处理能力下降(比如刚刚启动的实例、故障的实例等场景)导致的整体故障。
```
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/intruduction.md b/java-chassis-reference/zh_CN/docs/references-handlers/intruduction.md
index 5619aab..293a971 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/intruduction.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/intruduction.md
@@ -1,86 +1,68 @@
-# 处理链参考
+# 处理链介绍
-处理链(Handlers)是ServiceComb的核心组成部分,它们构成服务运行管控的基础。ServiceComb通过处理链来处理负载均衡、熔断容错、流量控制等。
+处理链定义了一个请求的处理流程,包括编解码、服务治理、网络发送等。Java Chassis的核心处理流程分为 `Provider处理流程`、`Consumer处理流程`、`Edge处理流程`。
-## 处理链配置
+* Provider处理流程
-处理链分为Consumer和Provider,分别配置如下:
+
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: qps-flowcontrol-consumer,loadbalance
- Provider:
- default: qps-flowcontrol-provider
-```
+* Consumer处理流程
-通过名字配置处理链,可以根据需要调整处理链的顺序,配置在前面的处理链先执行。不同的处理链可能存在一定的逻辑关联,处理链的顺序
-不同,程序运行的效果会存在差异。
+
-上述配置指定目标微服务缺省处理链,开发者还可以对特定的微服务配置不同的处理链,比如:
+* Edge处理流程
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: auth,qps-flowcontrol-consumer,loadbalance
- service:
- authentication-server: qps-flowcontrol-consumer,loadbalance
-```
+
-对于转发到authentication-server的请求,不经过auth处理链,转发到其他的微服务的请求,则经过auth处理链。
+Java Chassis提供了 `ProviderFilter`、`ConsumerFilter`、`EdgeFilter` 分别对应上述处理流程。
## 开发新的处理链
-开发者自定义处理链包含如下几个步骤。由于ServiceComb的核心组成就是处理链,开发者可以参考handlers目录的实现详细了解处理链。下面简单总结下几个关键步骤:
+`ProviderFilter`、`ConsumerFilter`、`EdgeFilter`的开发流程一样。开发者只需要实现上述接口,并将其声明为 Bean 即可。
-* 实现Handler接口
+* 实现Filter接口
```java
-public class AuthHandler implements Handler {
+public class EmptyFilter extends AbstractFilter implements ProviderFilter, ConsumerFilter, EdgeFilter {
+ @Override
+ public String getName() {
+ return "empty";
+ }
+
@Override
- public void handle(Invocation invocation, AsyncResponse asyncResponse) throws Exception {
- String token = invocation.getContext(Constants.CONTEXT_HEADER_AUTHORIZATION);
- if (token == null) {
- asyncResponse.consumerFail(new InvocationException(403, "forbidden", "not authenticated"));
- return;
- }
- Jwt jwt = JwtHelper.decode(token);
- try {
- jwt.verifySignature(BeanUtils.getBean("authSigner"));
- } catch (InvalidSignatureException e) {
- asyncResponse.consumerFail(new InvocationException(403, "forbidden", "not authenticated"));
- return;
- }
- invocation.next(asyncResponse);
+ public CompletableFuture<Response> onFilter(Invocation invocation, FilterNode nextNode) {
+ return CompletableFuture.completedFuture(Response.ok(null));
+ }
+
+ @Override
+ public int getOrder() {
+ return 0;
}
}
```
-* 增加*.handler.xml文件,给Handler取一个名字,并且文件要放在```classpath*:config/```路径下
+* 声明为 Bean
-```xml
-<config>
- <handler id="auth"
- class="org.apache.servicecomb.authentication.gateway.AuthHandler" />
-</config>
+```java
+@Configuration
+public class EmptyFilterConfiguration {
+ @Bean
+ public EmptyFilter emptyFilter() {
+ return new EmptyFilter();
+ }
+}
```
-* 在microservice.yaml中启用新增加的处理链
+上述开发完成的处理链会在 `Provider处理流程`、`Consumer处理流程`、`Edge处理流程` 执行。 它的 order 是 0。 由于它继承了 `AbstractFilter`, 还可以在配置文件中
+定义是否启用,或者定义其优先级。
```yaml
servicecomb:
- handler:
- chain:
- Consumer:
- default: auth,loadbalance
- service:
- authentication-server: loadbalance
+ filter:
+ # Filter名称
+ empty:
+ # 应用名 + 服务名
+ ${application}.${name}.order: 10
+ ${application}.${name}.enabled: false
```
-
-
-
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/loadbalance.md b/java-chassis-reference/zh_CN/docs/references-handlers/loadbalance.md
index c941055..b08a6a1 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/loadbalance.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/loadbalance.md
@@ -1,31 +1,11 @@
# 负载均衡
-## 场景描述
+Java Chassis提供了强大的负载均衡能力, 在实例数非常多的场景,也能提供很好的性能。负载均衡的核心数据结构是 `DiscoveryTree`,`DiscoveryTree` 包含了一系列 `DiscoveryFilter`。 下图展示了负载均衡的处理过程:
-ServiceComb提供了非常强大的负载均衡能力。它的核心包括两部分,第一部分是DiscoveryTree,通过将微服务实例根据接口兼容性、数据中心、实例状态等分组,DiscoveryFilter是其主要组成部分;第二部分是基于Ribbon的负载均衡方案,支持随机、顺序、基于响应时间的权值等多种负载均衡路由策略IRule,以及可以支持Invocation状态的ServerListFilterExt。
-
-DiscoveryTree的逻辑比较复杂,可以通过下面的处理流程了解其处理过程。
-
-
-负载均衡适用于Consumer处理链,名称为loadbalance,示例如下:
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: loadbalance
-```
-
-POM依赖:
-```xml
- <dependency>
- <groupId>org.apache.servicecomb</groupId>
- <artifactId>handler-loadbalance</artifactId>
- </dependency>
-```
+
## 按照数据中心信息进行路由转发
-服务提供者和消费者都可以通过在microservice.yaml中声明自己的服务中心信息:
+服务提供者和消费者都可以通过在microservice.yaml中声明自己的数据中心信息:
```yaml
servicecomb:
datacenter:
@@ -38,9 +18,10 @@ servicecomb:
这里的region和availableZone是一般性的概念,用户可以自行确定其业务含义以便应用于资源隔离的场景中。可以参见[微服务实例之间的逻辑隔离关系](../build-provider/definition/isolate-relationship.md),了解更多其他实例发现相关的隔离机制。
-该规则默认启用,如果不需要使用,可以通过servicecomb.loadbalance.filter.zoneaware.enabled进行关闭。数据中心信息隔离功能在ZoneAwareDiscoveryFilter实现。
+该规则默认启用,如果不需要使用,可以通过 `servicecomb.loadbalance.filter.zoneaware.enabled` 进行关闭。数据中心信息隔离功能在 `ZoneAwareDiscoveryFilter` 实现。
## 根据实例属性进行路由转发
+
微服务可以指定实例的属性。实例属性可以在microservice.yaml中指定,也可以通过服务中心的API进行修改。
```yaml
instance_description:
@@ -66,6 +47,7 @@ servicecomb:
该规则默认启用,如果不需要使用,可以通过`servicecomb.loadbalance.filter.instanceProperty.enabled`进行关闭。根据实例属性进行路由转发功能在`InstancePropertyDiscoveryFilter`实现。
## 根据实例属性值的层级进行路由转发
+
实例属性优先级匹配可以看做是针对实例属性匹配的一种逻辑扩展。
微服务的实例属性可以定义为具备优先级的格式,通过`.`符号进行分割。
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/publickey.md b/java-chassis-reference/zh_CN/docs/references-handlers/publickey.md
index 14ace35..583e9e6 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/publickey.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/publickey.md
@@ -8,27 +8,6 @@
2. 消费者访问提供者之前,使用自己的私钥对消息进行签名。
3. 提供者从服务中心获取消费者公钥,对签名的消息进行校验。
-公钥认证需要在消费者、提供者都启用。
-
-```
-servicecomb:
- handler:
- chain:
- Consumer:
- default: auth-consumer
- Provider:
- default: auth-provider
-```
-
-POM依赖:
-
-* 在pom.xml中增加依赖:
-
- <dependency>
- <groupId>org.apache.servicecomb</groupId>
- <artifactId>handler-publickey-auth</artifactId>
- </dependency>
-
## 配置黑白名单
基于公钥认证机制,ServiceComb提供了黑白名单功能。通过黑白名单,可以控制微服务允许其他哪些服务访问。目前支持通过配置服务属性来控制,配置项如下:
@@ -54,4 +33,4 @@ servicecomb:
以上规则配置了黑名单,不允许微服务名称为hacker的访问;白名单,允许微服务名称为cust前缀的服务访问。
-ServiceComb提供了[trust-sample](https://github.com/apache/servicecomb-samples/tree/master/java-chassis-samples/trust-sample)来演示黑白名单功能。
\ No newline at end of file
+ServiceComb提供了[trust-sample](https://github.com/apache/servicecomb-samples/tree/master/java-chassis-samples/trust-sample)来演示黑白名单功能。
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/ratelimit.md b/java-chassis-reference/zh_CN/docs/references-handlers/ratelimit.md
index ace9f83..5a7320f 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/ratelimit.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/ratelimit.md
@@ -8,13 +8,10 @@ java-chassis 支持 Provider 限流和 Consumer 限流。 Provider 限流控制
2. 流量控制是业务层面的功能,不是安全意义上的流量控制,如需防止DDoS攻击,需要结合其他的一系列措施。
3. 流量控制是微服务级的,不是实例级的。例如一个consumer服务有三个实例,当对它们依赖的provider实例配置限流策略后,
provider不会区分consumer的请求具体是由哪个实例发出的,而是汇总成微服务级的统计数据进行限流判断。
+4. 本模块介绍的限流机制是基于 `operation` 的, 使用起来比较简单。后续推荐使用[流量特征治理](governance.md) 来限制流量。
## 流控算法说明
-2.1.3 版本之前,不提供流控策略的选择,默认流控实现算法是固定窗口算法。
-
-2.1.3 版本以及之后,提供流控测流供选择,默认提供固定窗口算法、漏桶算法、令牌桶算法,且支持用户自定义流控策略实现。
-
* 算法说明:
* 固定窗口算法:默认窗口大小为1s,最大可能产生2倍于指定流量设置大小的误差。
* 令牌桶算法:令牌桶的主要思想是,设置一个固定大小的桶,以恒定速率向里面加入令牌,每次新
@@ -33,26 +30,8 @@ java-chassis 支持 Provider 限流和 Consumer 限流。 Provider 限流控制
### 配置说明
-限流策略配置在microservice.yaml文件中,相关配置项见表**QPS流控配置项说明**。要开启服务提供者端的限流策略,还需要在处理链中配置服
-务端限流handler,并添加pom依赖。
-
-* microservice.yaml配置示例如下:
-
- servicecomb:
- handler:
- chain:
- Provider:
- default: qps-flowcontrol-provider
-
-* 添加handler-flowcontrol-qps的pom依赖:
+限流策略配置在microservice.yaml文件中,相关配置项如下:
- <dependency>
- <groupId>org.apache.servicecomb</groupId>
- <artifactId>handler-flowcontrol-qps</artifactId>
- </dependency>
-
-
-**QPS流控配置项说明**
| 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 |
| :--- | :--- | :--- | :--- | :--- | :--- |
@@ -80,17 +59,6 @@ java-chassis 支持 Provider 限流和 Consumer 限流。 Provider 限流控制
### 配置说明
-限流策略配置在microservice.yaml文件中,相关配置项见下表。要开启服务消费者端的限流策略,还需要在处理链中配置消费端限流handler,配置示例如下:
-
-```yaml
-servicecomb:
- handler:
- chain:
- Consumer:
- default: qps-flowcontrol-consumer
-```
-
-QPS流控配置项说明
| 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 |
| :--- | :--- | :--- | :--- | :--- | :--- |
diff --git a/java-chassis-reference/zh_CN/docs/references-handlers/router.md b/java-chassis-reference/zh_CN/docs/references-handlers/router.md
index ccb9b1c..2d4220b 100644
--- a/java-chassis-reference/zh_CN/docs/references-handlers/router.md
+++ b/java-chassis-reference/zh_CN/docs/references-handlers/router.md
@@ -6,65 +6,47 @@
* 前提条件:灰度发布依赖负载均衡管理模块, 参考[负载均衡](./loadbalance.md) 。
-使用灰度发布,需要在项目中引入如下依赖:
-
-```xml
-<dependency>
- <groupId>org.apache.servicecomb</groupId>
- <artifactId>handler-router</artifactId>
-</dependency>
-```
-
-在配置文件中增加配置项:
| 配置项名 | 描述 |
| ------------------------------------------ | ---------------------- |
| servicecomb.routeRule.[targetService] | 目标服务的路由管理规则 |
| servicecomb.router.type | 填写'router' |
-| servicecomb.router.header | 从HTTP请求头中提取额外的可以用于匹配HTTP Header信息。 以逗号分隔的多个 Header 名称。|
-
-* 说明:路由规则里面的 headers 来源分为如下几部分:(1)servicecomb.router.header 配置的 Header 信息;(2)Invocation Arguments,即
- 业务接口的参数列表。关于Invocation Arguments和Swagger Arguments的差异,请参考 Invocation 类。 Invocation Arguments的优先级
- 高于 servicecomb.router.header。
灰度发布规则示例如下:
```yaml
-servicecomb:
- routeRule:
- provider: | #服务名
- - precedence: 2 #优先级
- match: #匹配策略
- headers: #header匹配
- region:
- regex: 'regoin[0-9]*'
- caseInsensitive: false # 是否区分大小写,默认为false,区分大小写
- type:
- exact: gray
- route: #路由规则
- - weight: 100 #权重值
- tags:
- version: {version1}
- app: {appId}
- - precedence: 1
- route:
- - weight: 20
- tags:
- version: 0.01
- tags: tag
- - weight: 80
- tags:
- version: 0.02
+servicecomb:
+ router:
+ type: router
+ routeRule:
+ business: |
+ - precedence: 2
+ match:
+ apiPath:
+ prefix: "/business/v2"
+ route:
+ - weight: 100
+ tags:
+ version: 2.0.0
+ - precedence: 1
+ match:
+ apiPath:
+ prefix: "/business/v1/dec"
+ route:
+ - weight: 50
+ tags:
+ version: 1.1.0
+ - weight: 50
+ tags:
+ version: 2.0.0
+
```
#### 规则说明
-- 匹配特定请求由match配置,匹配条件是headers。
-- Header中的字段的匹配支持正则匹配、精准匹配。
-- 如果未定义match,则可匹配任何请求。
+- 匹配特定请求由match配置, match的配置逻辑和 [流量特征治理](governance.md) 一致。
- 转发权重定义在routeRule.{targetServiceName}.route下,由weight配置,weight数值表示百分数,需要满足加和等于100,不满足100的部分会用最新版本填充。
- 服务分组定义在routeRule.{targetServiceName}.route下,由tags配置,配置内容有version和app。
-- caseInsensitive 配置条件是否区分大小写,默认false区分大小写,true则不区分大小写。
- 优先级数量越大优先级越高。
#### 匹配流程
diff --git a/java-chassis-reference/zh_CN/mkdocs.yml b/java-chassis-reference/zh_CN/mkdocs.yml
index 39cca9a..e3753d5 100644
--- a/java-chassis-reference/zh_CN/mkdocs.yml
+++ b/java-chassis-reference/zh_CN/mkdocs.yml
@@ -19,6 +19,8 @@ nav:
- 与Spring Web MVC开发习惯的差异: spring-boot/diff-spring-mvc.md
- 开发服务提供者: build-provider/catalog.md
- 开发服务消费者: build-consumer/catalog.md
+- 定制请求处理流程:
+ - 处理链介绍: references-handlers/intruduction.md
- 通用功能开发: general-development/catalog.md
- 多样化的通信协议功能:
- 多协议介绍: transports/introduction.md
@@ -38,7 +40,6 @@ nav:
- 在程序中读取配置信息: config/read-config.md
- 配置中心参考: config/config-service.md
- 服务治理功能参考:
- - 处理链介绍: references-handlers/intruduction.md
- 负载均衡: references-handlers/loadbalance.md
- 限流: references-handlers/ratelimit.md
- 灰度发布: references-handlers/router.md
(servicecomb-docs) 01/02: remove redundant packaging catalog
Posted by li...@apache.org.
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
commit c2cdde0c5783ad3d1209d5a000157c348e2675ad
Author: liubao <bi...@qq.com>
AuthorDate: Fri Nov 10 14:35:46 2023 +0800
remove redundant packaging catalog
---
.../zh_CN/docs/packaging/standalone.md | 25 ----------------
.../zh_CN/docs/packaging/web-container.md | 20 -------------
.../zh_CN/docs/start/terminology.md | 34 ++++++++++++----------
java-chassis-reference/zh_CN/mkdocs.yml | 3 --
4 files changed, 18 insertions(+), 64 deletions(-)
diff --git a/java-chassis-reference/zh_CN/docs/packaging/standalone.md b/java-chassis-reference/zh_CN/docs/packaging/standalone.md
deleted file mode 100644
index cff8b42..0000000
--- a/java-chassis-reference/zh_CN/docs/packaging/standalone.md
+++ /dev/null
@@ -1,25 +0,0 @@
-## 概念阐述
-
-一个Standalone的容器,以简单的Main加载Spring启动,因为服务通常不需要Tomcat/JBoss等Web容器的特性,没必要用Web容器去加载服务。微框架提供了standalone部署运行模式,服务容器只是一个简单的Main方法,并加载一个简单的Spring容器,用于暴露服务。
-
-## 操作步骤
-
-* **步骤1** 编写Main函数,初始化日志和加载服务配置,内容如下:
-
-```java
-import org.apache.servicecomb.foundation.common.utils.BeanUtils;
-import org.apache.servicecomb.foundation.common.utils.Log4jUtils;
-public class MainServer {
-public static void main(String[] args) throws Exception {
- Log4jUtils.init(); # 日志初始化
- BeanUtils.init(); # Spring bean初始化
- }
-}
-```
-
-* **步骤2** 运行MainServer即可启动该微服务进程,向外暴露服务。
-
-## 注意事项
-
-如果使用的是rest网络通道,需要将pom中的transport改为使用cse-transport-rest-vertx包
-
diff --git a/java-chassis-reference/zh_CN/docs/packaging/web-container.md b/java-chassis-reference/zh_CN/docs/packaging/web-container.md
deleted file mode 100644
index 7b11276..0000000
--- a/java-chassis-reference/zh_CN/docs/packaging/web-container.md
+++ /dev/null
@@ -1,20 +0,0 @@
-## 概念阐述
-
-如果需要将该微服务加载到web容器中启动运行时,需要新建一个servlet工程包装一下,该servlet工程,根据需要,可以不写或写少量的引导代码即可。
-
-## 开发示例
-
-参考“开发服务提供者” -> “通信协议" -> "REST over Servlet"章节。
-
-## 注意事项
-
-Restful调用应该与web容器中其他静态资源调用(比如html、js等等)隔离开来,所以webroot后一段应该还有一层关键字,比如上面web.xml中举的例子(/test/rest)中的rest。
-
-以tomcat为例,默认每个war包都有不同的webroot,这个webroot需要是basePath的前缀,比如webroot为test,则该微服务所有的契约都必须以/test打头。
-
-当微服务加载在web容器中,并直接使用web容器开的http、https端口时,因为是使用的web容器的通信通道,所以需要满足web容器的规则。
-
-##
-
-
-
diff --git a/java-chassis-reference/zh_CN/docs/start/terminology.md b/java-chassis-reference/zh_CN/docs/start/terminology.md
index 69ea07b..782f5ac 100644
--- a/java-chassis-reference/zh_CN/docs/start/terminology.md
+++ b/java-chassis-reference/zh_CN/docs/start/terminology.md
@@ -1,20 +1,22 @@
# 术语表
-| 缩略语 | 英文词汇 | 中文词汇 | 解释 |
-|:----------------| :--- | :--- | :--- |
-| Application | Application | 应用 | 应用代表一个软件应用的逻辑实体,表示一个有业务功能呈现给用户的计算机软件应用。一个以微服务化架构构建的应用通常由多个微服务组成。 |
-| Service | Service | 微服务 | 微服务是一种轻量级SOA架构,通常用来描述广泛用于云应用、互联网应用的一种松耦合分布式架构。 |
-| Instance | Instance | 微服务实例 | 一个微服务的最小运行和部署单元,通常对应一个应用进程。 |
-| Provider | Provider | 服务提供者 | 在微服务调用关系中处于被调用一方的服务。 |
-| Consumer | Consumer | 服务消费者 | 在微服务调用关系中处于调用发起方的服务。 |
-| IAM | Identity and Access Management | 身份及权限管理 | 负责PaaS系统中管理层级、用户、角色、授权关系,用户的组织归性等信息的维护。并实施授权和授权检查。 |
-| AK/SK | AK/SK | AK/SK密钥 | Access key/Secret key是一组密钥对,用于API的身份认证和访问控制。 |
-| Load Balance | Load Balance | 负载均衡 | 当应用访问一个具有多个实例的微服务时,会涉及到路由负载均衡。可以通过配置文件配置负载均衡策略,支持随机,轮询、会话保持和基于响应时间的权值等多种负载均衡路由策略。 |
-| Rate limit | Rate limit | 限流 | 当资源成为瓶颈时,服务框架需要对消费者的访问请求做限流,启动流控保护机制。在服务消费者端和提供者端均可进行流量控制。在服务消费端,可以限制发往某个微服务提供者的请求频率;在服务提供端,可以限制每个微服务消费端发过来的请求频率,也可以根据服务提供端资源消耗情况确定总的请求频率限制,防止服务因资源耗尽而崩溃。 |
-| Service Degrade | Service Degrade | 降级 | 服务降级主要包括屏蔽降级和容错降级两种策略:屏蔽降级是指当外界的触发条件达到某个临界值时,由运维人员/开发人员决策,对某类或者某个服务进行强制降级。容错降级是指当非核心服务不可用时,可以对故障服务做业务逻辑放通,以保障核心服务的运行。 |
-| Fault tolarance | Fault tolarance | 容错 | 容错是消费者访问服务时出现异常的场景下的一种处理策略,出现异常后由服务框架自动选择新的服务路由进行调用。 |
-| Circuit Breaker | Circuit Breaker | 熔断 | 微服务之间通常存在依赖关系,服务调用链路可能包含多个微服务,如果链路中一个或多个服务访问延迟过高,会导致入口服务的请求不断堆积,持续消耗更多的线程、io资源,最终由于资源累积使系统出现瓶颈,造成更多服务不可用,产生雪崩效应。熔断机制就是针对上述场景设计的,当某个目标服务响应缓慢或者有大量超时情况发生时,熔断该服务的调用,对于后续调用请求,不再继续调用目标服务,直接返回,快速释放资源,等到该目标服务情况好转再恢复调用。 |
-| Isolation | Isolation | 隔离 | 服务隔离是一种异常检测机制,常用的检测方法是请求超时、流量过大等。一般的设置参数包括超时时间、最大并发请求数等,当超过超时时间或最大并发请求数时,记录一次异常,并用于在熔断机制中计算错误率和错误请求数。 |
-
+| 缩略语 | 英文词汇 | 中文词汇 | 解释 |
+|:------------------:|:------------------:|:-----:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Application | Application | 应用 | 应用代表一个软件应用的逻辑实体,表示一个有业务功能呈现给用户的计算机软件应用。一个以微服务化架构构建的应用通常由多个微服务组成。 |
+| Service | Service | 微服务 | 微服务是一种轻量级SOA架构,通常用来描述广泛用于云应用、互联网应用的一种松耦合分布式架构。 |
+| Instance | Instance | 微服务实例 | 一个微服务的最小运行和部署单元,通常对应一个应用进程。 |
+| Provider | Provider | 服务提供者 | 在微服务调用关系中处于被调用一方的服务。 |
+| Consumer | Consumer | 服务消费者 | 在微服务调用关系中处于调用发起方的服务。 |
+| Schema | Schema | 微服务契约 | 微服务契约是对外接口的OpenAPI表示。OpenAPI增强了微服务的可见性,方便服务的分发、使用和治理。 |
+| Code Style | Code Style | 编程模型 | 编程模型指如何进行服务接口开发和调用,Java Chassis提供了Spring Web MVC、JAX RS等编程模型。编程模型独立于处理链和通信模型 |
+| Filter | Filter | 处理链 | 处理链定义了一个请求的处理流程,包括编解码、服务治理、网络发送等。 |
+| Transport | Transport | 通信模型 | 通信模型定义了对象如何编解码,使用什么协议传输等。Java Chassis提供了REST、HIGHWAY等通信模型。 |
+| Load Balance | Load Balance | 负载均衡 | 当应用访问一个具有多个实例的微服务时,会涉及到路由负载均衡。可以通过配置文件配置负载均衡策略,支持随机,轮询、会话保持和基于响应时间的权值等多种负载均衡路由策略。 |
+| Rate Limiting | Rate Limiting | 限流 | 当资源成为瓶颈时,服务框架需要对消费者的访问请求做限流,启动流控保护机制。在服务消费者端和提供者端均可进行流量控制。在服务消费端,可以限制发往某个微服务提供者的请求频率;在服务提供端,可以限制每个微服务消费端发过来的请求频率,也可以根据服务提供端资源消耗情况确定总的请求频率限制,防止服务因资源耗尽而崩溃。 |
+| Service Degrade | Service Degrade | 降级 | 服务降级主要包括屏蔽降级和容错降级两种策略:屏蔽降级是指当外界的触发条件达到某个临界值时,由运维人员/开发人员决策,对某类或者某个服务进行强制降级。容错降级是指当非核心服务不可用时,可以对故障服务做业务逻辑放通,以保障核心服务的运行。 |
+| Fault Tolerance | Fault Tolerance | 容错 | 容错是消费者访问服务时出现异常的场景下的一种处理策略,出现异常后由服务框架自动选择新的服务路由进行调用。 |
+| Circuit Breaker | Circuit Breaker | 熔断 | 微服务之间通常存在依赖关系,服务调用链路可能包含多个微服务,如果链路中一个或多个服务访问延迟过高,会导致入口服务的请求不断堆积,持续消耗更多的线程、io资源,最终由于资源累积使系统出现瓶颈,造成更多服务不可用,产生雪崩效应。熔断机制就是针对上述场景设计的,当某个目标服务响应缓慢或者有大量超时情况发生时,熔断该服务的调用,对于后续调用请求,不再继续调用目标服务,直接返回,快速释放资源,等到该目标服务情况好转再恢复调用。 |
+| Bulkhead | Bulkhead | 隔离仓 | 隔离仓是一种异常检测机制,常用的检测方法是请求超时、流量过大等。一般的设置参数包括超时时间、最大并发请求数等,当超过超时时间或最大并发请求数时,记录一次异常,在熔断、实例隔离机制中,用于计算错误率。 |
+| Instance Isolation | Instance Isolation | 实例隔离 | 实例隔离通过检测实例的错误率、超时请求数等指标,短暂的屏蔽故障实例的访问,降低错误率以及防止发生雪崩效应。 |
diff --git a/java-chassis-reference/zh_CN/mkdocs.yml b/java-chassis-reference/zh_CN/mkdocs.yml
index 9a20287..39cca9a 100644
--- a/java-chassis-reference/zh_CN/mkdocs.yml
+++ b/java-chassis-reference/zh_CN/mkdocs.yml
@@ -54,9 +54,6 @@ nav:
- 公钥认证: references-handlers/publickey.md
- 使用TLS通信: security/tls.md
- 使用RSA认证: security/shi-yong-rsa-ren-zheng.md
-- 服务打包和运行:
- - 以standalone模式打包: packaging/standalone.md
- - 以WEB容器模式打包: packaging/web-container.md
- 专题文章:
- 新功能介绍系列文章: featured-topics/features.md
- 兼容问题和兼容性策略: featured-topics/compatibility.md