update sentinel example and add sentinel reference doc

6 years ago · 4539ed7183
parent 3c33b234c8
commit 4539ed7183
8 changed files with 342 additions and 10 deletions
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc
@ -1 +1,250 @@
 == Spring Cloud Alibaba Sentinel
+
+### Sentinel介绍
+
+随着微服务的流行，服务和服务之间的稳定性变得越来越重要。Sentinel 以流量为切入点，从流量控制、熔断降级、系统负载保护等多个维度保护服务的稳定性。
+
+Sentinel 具有以下特征:
+
+
+* *丰富的应用场景*：Sentinel 承接了阿里巴巴近 10 年的双十一大促流量的核心场景，例如秒杀（即突发流量控制在系统容量可以承受的范围）、消息削峰填谷、实时熔断下游不可用应用等。
+* *完备的实时监控*：Sentinel 同时提供实时的监控功能。您可以在控制台中看到接入应用的单台机器秒级数据，甚至 500 台以下规模的集群的汇总运行情况。
+* *广泛的开源生态*：Sentinel 提供开箱即用的与其它开源框架/库的整合模块，例如与 Spring Cloud、Dubbo、gRPC 的整合。您只需要引入相应的依赖并进行简单的配置即可快速地接入 Sentinel。
+* *完善的 SPI 扩展点*：Sentinel 提供简单易用、完善的 SPI 扩展点。您可以通过实现扩展点，快速的定制逻辑。例如定制规则管理、适配数据源等。
+
+### 如何使用Sentinel
+
+如果要在您的项目中引入Sentinel，使用group ID为 `org.springframework.cloud` 和artifact ID为 `spring-cloud-starter-alibaba-sentinel` 的starter。
+
+```xml
+<dependency>
+    <groupId>org.springframework.cloud</groupId>
+    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
+</dependency>
+```
+
+下面这个例子就是一个最简单的使用Sentinel的例子:
+
+```java
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(ServiceApplication.class, args);
+    }
+
+}
+
+@RestController
+public class TestController {
+
+    @GetMapping(value = "/hello")
+    @SentinelResource("hello")
+    public String hello() {
+        return "Hello Sentinel";
+    }
+
+}
+```
+
+@SentinelResource注解用来标识资源是否被限流、降级。上述例子上该注解的属性'hello'表示资源名。
+
+@SentinelResource还提供了其它额外的属性如 `blockHandler`，`blockHandlerClass`，`fallback` 用于表示限流或降级的操作，更多内容可以参考 https://github.com/alibaba/Sentinel/wiki/%E6%B3%A8%E8%A7%A3%E6%94%AF%E6%8C%81[Sentinel注解支持]。
+
+##### Sentinel 控制台
+
+Sentinel 控制台提供一个轻量级的控制台，它提供机器发现、单机资源实时监控、集群资源汇总，以及规则管理的功能。您只需要对应用进行简单的配置，就可以使用这些功能。
+
+*注意*: 集群资源汇总仅支持 500 台以下的应用集群，有大概 1 - 2 秒的延时。
+
+.Sentinel Dashboard
+image::https://github.com/alibaba/Sentinel/wiki/image/dashboard.png[]
+
+开启该功能需要3个步骤：
+
+###### 获取控制台
+
+您可以从 https://github.com/alibaba/Sentinel/releases[release 页面] 下载最新版本的控制台 jar 包。
+
+您也可以从最新版本的源码自行构建 Sentinel 控制台：
+
+* 下载 https://github.com/alibaba/Sentinel/tree/master/sentinel-dashboard[控制台] 工程
+* 使用以下命令将代码打包成一个 fat jar: `mvn clean package`
+
+
+###### 启动控制台
+
+Sentinel 控制台是一个标准的SpringBoot应用，以SpringBoot的方式运行jar包即可。
+
+```shell
+java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar
+```
+
+如若8080端口冲突，可使用 `-Dserver.port=新端口` 进行设置。
+
+#### 配置控制台信息
+
+.application.yml
+----
+spring:
+  cloud:
+    sentinel:
+      transport:
+        port: 8719
+        dashboard: localhost:8080
+----
+
+这里的 `spring.cloud.sentinel.transport.port` 端口配置会在应用对应的机器上启动一个Http Server，该Serve会与Sentinel控制台做交互。比如Sentinel控制台添加了1个限流规则，会把规则数据push给这个Http Server接受，Http Server再将规则注册到Sentinel中。
+
+更多Sentinel控制台的使用及问题参考： https://github.com/alibaba/Sentinel/wiki/%E6%8E%A7%E5%88%B6%E5%8F%B0[Sentinel控制台]
+
+### Feign支持
+
+DOING
+
+### RestTemplate支持
+
+Spring Cloud Alibaba Sentinel支持对 `RestTemplate` 的服务调用使用Sentinel进行保护，在构造 `RestTemplate` bean的时候需要加上 `@SentinelProtect` 注解。
+
+```java
+@Bean
+@SentinelProtect(blockHandler = "handleException", blockHandlerClass = ExceptionUtil.class)
+public RestTemplate restTemplate() {
+    return new RestTemplate();
+}
+```
+
+`@SentinelProtect` 注解的参数跟 `@SentinelResource` 一致，使用方式也一致。
+
+限流的资源规则提供两种粒度：
+
+* `schema://host:port/path`：协议、主机、端口和路径
+
+* `schema://host:port`：协议、主机和端口
+
+NOTE: 以 `https://www.taobao.com/test` 这个url为例。对应的资源名有两种粒度，分别是 `https://www.taobao.com:80` 以及 `https://www.taobao.com:80/test`
+
+
+### 动态数据源支持
+
+*在版本 0.2.0.RELEASE 或 0.1.0.RELEASE 之前*，要在Spring Cloud Alibaba Sentinel下使用动态数据源，需要3个步骤：
+
+* 配置文件中定义数据源信息。比如使用文件：
+
+.application.properties
+----
+spring.cloud.sentinel.datasource.type=file
+spring.cloud.sentinel.datasource.recommendRefreshMs=3000
+spring.cloud.sentinel.datasource.bufSize=4056196
+spring.cloud.sentinel.datasource.charset=utf-8
+spring.cloud.sentinel.datasource.converter=flowConverter
+spring.cloud.sentinel.datasource.file=/Users/you/yourrule.json
+----
+
+* 创建一个Converter类实现 `com.alibaba.csp.sentinel.datasource.Converter` 接口，并且需要在 `ApplicationContext` 中有该类的一个Bean
+
+```java
+@Component("flowConverter")
+public class JsonFlowRuleListParser implements Converter<String, List<FlowRule>> {
+	@Override
+	public List<FlowRule> convert(String source) {
+		return JSON.parseObject(source, new TypeReference<List<FlowRule>>() {
+		});
+	}
+}
+```
+
+这个Converter的bean name需要跟 `application.properties` 配置文件中的converter配置一致
+
+* 在任意一个 Spring Bean 中定义一个被 `@SentinelDataSource` 注解修饰的 `ReadableDataSource` 属性
+
+```java
+@SentinelDataSource("spring.cloud.sentinel.datasource")
+private ReadableDataSource dataSource;
+```
+
+`@SentinelDataSource` 注解的value属性表示数据源在 `application.properties` 配置文件中前缀。 该在例子中，前缀为 `spring.cloud.sentinel.datasource` 。
+
+如果 `ApplicationContext` 中存在超过1个 `ReadableDataSource` bean，那么不会加载这些 `ReadableDataSource` 中的任意一个。 只有在 `ApplicationContext` 存在一个 `ReadableDataSource` 的情况下才会生效。
+
+如果数据库生效并且规则成功加载，控制台会打印类似如下信息：
+
+```
+[Sentinel Starter] load 3 flow rules
+```
+
+*在版本 0.2.0.RELEASE 或 0.1.0.RELEASE 之后*，要在Spring Cloud Alibaba Sentinel下使用动态数据源，只需要1个步骤：
+
+* 直接在 `application.properties` 配置文件中配置数据源信息即可
+
+比如配置了4个数据源：
+
+```
+spring.cloud.sentinel.datasource.ds1.file.file=classpath: degraderule.json
+
+spring.cloud.sentinel.datasource.ds2.nacos.server-addr=localhost:8848
+spring.cloud.sentinel.datasource.ds2.nacos.dataId=sentinel
+spring.cloud.sentinel.datasource.ds2.nacos.groupId=DEFAULT_GROUP
+spring.cloud.sentinel.datasource.ds2.nacos.data-type=json
+
+spring.cloud.sentinel.datasource.ds3.zk.path = /Sentinel-Demo/SYSTEM-CODE-DEMO-FLOW
+spring.cloud.sentinel.datasource.ds3.zk.server-addr = localhost:2181
+
+spring.cloud.sentinel.datasource.ds4.apollo.namespace-name = application
+spring.cloud.sentinel.datasource.ds4.apollo.flow-rules-key = sentinel
+spring.cloud.sentinel.datasource.ds4.apollo.default-flow-rule-value = test
+
+```
+
+这样配置方式参考了Spring Cloud Stream Binder的配置，内部使用了 `TreeMap` 进行存储，comparator为 `String.CASE_INSENSITIVE_ORDER` 。
+
+NOTE: d1, ds2, ds3, ds4 是 `ReadableDataSource` 的名字，可随意编写。后面的 `file` ，`zk` ，`nacos` , `apollo` 就是对应具体的数据源。 它们后面的配置就是这些数据源各自的配置。
+
+每种数据源都有两个共同的配置项： `data-type` 和 `converter-class` 。
+
+`data-type` 配置项表示 `Converter`，Spring Cloud Alibaba Sentinel默认提供两种内置的值，分别是 `json` 和 `xml` (不填默认是json)。 如果不想使用内置的 `json` 或 `xml` 这两种 `Converter`，可以填写 `custom` 表示自定义 `Converter`，然后再配置 `converter-class` 配置项，该配置项需要写类的全路径名。
+
+这两种内置的 `Converter` 只支持解析 json数组 或 xml数组。内部解析的时候会自动判断每个json对象或xml对象属于哪4种Sentinel规则(`FlowRule`，`DegradeRule`，`SystemRule`，`AuthorityRule`)。
+
+比如10个规则数组里解析出5个限流规则和5个降级规则。 这种情况下该数据源不会注册，日志里页会进行警告。
+
+如果10个规则里有9个限流规则，1个解析报错了。这种情况下日志会警告有个规则格式错误，另外9个限流规则会注册上去。
+
+这里json或xml解析用的是 `jackson`。`ObjectMapper` 或 `XmlMapper` 使用默认的配置，遇到不认识的字段会解析报错。 因为不这样做的话限流 json 也会解析成 系统规则(系统规则所有的配置都有默认值)，所以需要这样严格解析。
+
+当然还有一种情况是json对象或xml对象可能会匹配上所有4种规则(比如json对象里只配了 `resource` 字段，那么会匹配上4种规则)，这种情况下日志里会警告，并且过滤掉这个对象。
+
+用户使用这种配置的时候只需要填写正确的json或xml就行，有任何不合理的信息都会在日志里打印出来。
+
+NOTE: 默认情况下，xml格式是不支持的。需要添加 `jackson-dataformat-xml` 依赖后才会自动生效。
+
+关于Sentinel动态数据源的实现原理，参考： https://github.com/alibaba/Sentinel/wiki/%E5%8A%A8%E6%80%81%E8%A7%84%E5%88%99%E6%89%A9%E5%B1%95[动态规则扩展]
+
+### Endpoint支持
+
+在使用Endpoint特性之前需要在 Maven 中添加 `spring-boot-starter-actuator` 依赖，并在配置中允许 Endpoints 的访问。
+
+* Spring Boot 1.x 中添加配置 `management.security.enabled=false`。暴露的endpoint路径为 `/sentinel`
+* Spring Boot 2.x 中添加配置 `management.endpoints.web.exposure.include=*`。暴露的endpoint路径为 `/actuator/sentinel`
+
+### More
+
+下表显示 Spring Cloud Alibaba Sentinel 的所有配置信息：
+
+:frame: topbot
+[width="60%",options="header"]
+|====
+^|配置项 ^|含义 ^|默认值
+|`spring.cloud.sentinel.enabled`|Sentinel自动化配置是否生效|true
+|`spring.cloud.sentinel.eager`|取消Sentinel控制台懒加载|false
+|`spring.cloud.sentinel.charset`|metric文件字符集|UTF-8
+|`spring.cloud.sentinel.transport.port`|应用与Sentinel控制台交互的端口，应用本地会起一个该端口占用的HttpServer|8721
+|`spring.cloud.sentinel.transport.dashboard`|Sentinel 控制台地址|
+|`spring.cloud.sentinel.transport.heartbeatIntervalMs`|应用与Sentinel控制台的心跳间隔时间|
+|`spring.cloud.sentinel.filter.order`|Servlet Filter的加载顺序。Starter内部会构造这个filter|Integer.MIN_VALUE
+|`spring.cloud.sentinel.filter.spring.url-patterns`|数据类型是数组。表示Servlet Filter的url pattern集合|/*
+|`spring.cloud.sentinel.metric.fileSingleSize`|Sentinel metric 单个文件的大小|
+|`spring.cloud.sentinel.metric.fileTotalCount`|Sentinel metric 总文件数量|
+|`spring.cloud.sentinel.servlet.blockPage`| 自定义的跳转 URL，当请求被限流时会自动跳转至设定好的 URL |
+|`spring.cloud.sentinel.flow.coldFactor`| https://github.com/alibaba/Sentinel/wiki/%E9%99%90%E6%B5%81---%E5%86%B7%E5%90%AF%E5%8A%A8[冷启动因子] |3
+|====
--- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/pom.xml
+++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/pom.xml
@ -30,6 +30,24 @@
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
+
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-nacos</artifactId>-->
+        <!--</dependency>-->
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-zookeeper</artifactId>-->
+        <!--</dependency>-->
+        <!--<dependency>-->
+        <!--<groupId>com.alibaba.csp</groupId>-->
+        <!--<artifactId>sentinel-datasource-apollo</artifactId>-->
+        <!--</dependency>-->
+        <!-- define in spring-boot-autoconfigure module -->
+        <!--<dependency>-->
+        <!--<groupId>com.fasterxml.jackson.dataformat</groupId>-->
+        <!--<artifactId>jackson-dataformat-xml</artifactId>-->
+        <!--</dependency>-->
    </dependencies>

    <build>
--- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/JsonFlowRuleListConverter.java
+++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/JsonFlowRuleListConverter.java
@ -10,7 +10,7 @@ import com.alibaba.fastjson.TypeReference;
 /**
 * @author fangjian
 */
-public class JsonFlowRuleListParser implements Converter<String, List<FlowRule>> {
+public class JsonFlowRuleListConverter implements Converter<String, List<FlowRule>> {
 	@Override
 	public List<FlowRule> convert(String source) {
 		return JSON.parseObject(source, new TypeReference<List<FlowRule>>() {
--- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ServiceApplication.java
+++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ServiceApplication.java
@ -25,8 +25,8 @@ public class ServiceApplication {
 	}

 	@Bean
-    public Converter myParser() {
-	    return new JsonFlowRuleListParser();
+    public Converter myConverter() {
+	    return new JsonFlowRuleListConverter();
    }

 	public static void main(String[] args) {
--- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/application.properties
+++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/application.properties
@ -2,13 +2,15 @@ spring.application.name=sentinel-example
 server.port=18083
 management.endpoints.web.exposure.include=*
 spring.cloud.sentinel.transport.port=8721
-spring.cloud.sentinel.transport.dashboard=localhost:8080
+spring.cloud.sentinel.transport.dashboard=localhost:9999
+spring.cloud.sentinel.eager=true

+spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json
+spring.cloud.sentinel.datasource.ds1.file.data-type=json

+#spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json
+#spring.cloud.sentinel.datasource.ds1.file.data-type=custom
+#spring.cloud.sentinel.datasource.ds1.file.converter-class=org.springframework.cloud.alibaba.cloud.examples.JsonFlowRuleListConverter

-spring.cloud.sentinel.datasource.type=file
-spring.cloud.sentinel.datasource.recommendRefreshMs=3000
-spring.cloud.sentinel.datasource.bufSize=4056196
-spring.cloud.sentinel.datasource.charset=utf-8
-spring.cloud.sentinel.datasource.converter=myParser
-spring.cloud.sentinel.datasource.file=/Users/you/rule.json
+spring.cloud.sentinel.datasource.ds2.file.file=classpath: degraderule.json
+spring.cloud.sentinel.datasource.ds2.file.data-type=json
--- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/degraderule.json
+++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/degraderule.json
@ -0,0 +1,16 @@
+[
+  {
+    "resource": "abc0",
+    "count": 20.0,
+    "grade": 0,
+    "passCount": 0,
+    "timeWindow": 10
+  },
+  {
+    "resource": "abc1",
+    "count": 15.0,
+    "grade": 0,
+    "passCount": 0,
+    "timeWindow": 10
+  }
+]
--- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/flowrule.json
+++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/flowrule.json
@ -0,0 +1,26 @@
+[
+  {
+    "resource": "resource",
+    "controlBehavior": 0,
+    "count": 1,
+    "grade": 1,
+    "limitApp": "default",
+    "strategy": 0
+  },
+  {
+    "resource": "p",
+    "controlBehavior": 0,
+    "count": 1,
+    "grade": 1,
+    "limitApp": "default",
+    "strategy": 0
+  },
+  {
+    "resource": "abc",
+    "controlBehavior": 0,
+    "count": 1,
+    "grade": 1,
+    "limitApp": "default",
+    "strategy": 0
+  }
+]
--- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/flowrule.xml
+++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/resources/flowrule.xml
@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Rules>
+    <FlowRule>
+        <resource>resource</resource>
+        <controlBehavior>0</controlBehavior>
+        <count>1</count>
+        <grade>1</grade>
+        <limitApp>default</limitApp>
+        <strategy>0</strategy>
+    </FlowRule>
+    <FlowRule>
+        <resource>test</resource>
+        <controlBehavior>0</controlBehavior>
+        <count>1</count>
+        <grade>1</grade>
+        <limitApp>default</limitApp>
+        <strategy>0</strategy>
+    </FlowRule>
+</Rules>
+
+