From 54dcd7eaec540b0ae97a33707b1da94c3a568e0b Mon Sep 17 00:00:00 2001
From: fangjian0423 <fangjian0423@gmail.com>
Date: Thu, 6 Dec 2018 16:11:42 +0800
Subject: [PATCH] update sentinel docs

---
 .../src/main/asciidoc-zh/sentinel.adoc        | 71 +++++++++++++++++--
 1 file changed, 66 insertions(+), 5 deletions(-)

diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc
index e8c575ac..ed1b0d83 100644
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc
@@ -100,7 +100,53 @@ spring:
 
 ### Feign 支持
 
-DOING
+Sentinel 适配了 https://github.com/OpenFeign/feign[Feign] 组件。如果想使用，除了引入 `sentinel-starter` 的依赖外还需要 3 个步骤：
+
+* 配置文件打开 sentinel 对 feign 的支持：`feign.sentinel.enabled=true`
+* 加入 `feign starter` 依赖触发 `sentinel starter` 的配置类生效：
+```xml
+<dependency>
+    <groupId>org.springframework.cloud</groupId>
+    <artifactId>spring-cloud-starter-openfeign</artifactId>
+</dependency>
+```
+* `feign` 内部的 `loadbalance` 功能依赖 Netflix 的 `ribbon` 模块(如果不使用 `loadbalance` 功能可不引入)：
+```xml
+<dependency>
+    <groupId>org.springframework.cloud</groupId>
+    <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
+</dependency>
+```
+
+这是一个 `FeignClient` 对应的接口：
+
+```java
+@FeignClient(name = "service-provider", fallback = EchoServiceFallback.class, configuration = FeignConfiguration.class)
+public interface EchoService {
+    @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
+    String echo(@PathVariable("str") String str);
+}
+
+class FeignConfiguration {
+    @Bean
+    public EchoServiceFallback echoServiceFallback() {
+        return new EchoServiceFallback();
+    }
+}
+
+class EchoServiceFallback implements EchoService {
+    @Override
+    public String echo(@PathVariable("str") String str) {
+        return "echo fallback";
+    }
+}
+```
+
+NOTE: Feign 对应的接口中的资源名策略定义：httpmethod:http://requesturl
+
+`EchoService` 接口中方法 `echo` 对应的资源名为 `GET:http://service-provider/echo/{str}`。
+
+请注意：`@FeignClient` 注解中的所有属性，Sentinel 都做了兼容。
 
 ### RestTemplate 支持
 
@@ -124,10 +170,11 @@ public RestTemplate restTemplate() {
 
 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个步骤：
+#### 在版本 0.2.0.RELEASE 或 0.1.0.RELEASE 之前
+
+需要3个步骤才可完成数据源的配置：
 
 * 配置文件中定义数据源信息。比如使用文件：
 
@@ -173,7 +220,9 @@ private ReadableDataSource dataSource;
 [Sentinel Starter] load 3 flow rules
 ```
 
-*在版本 0.2.0.RELEASE 或 0.1.0.RELEASE 之后*，要在 Spring Cloud Alibaba Sentinel 下使用动态数据源，只需要1个步骤：
+#### 在版本 0.2.0.RELEASE 或 0.1.0.RELEASE 之后
+
+只需要1个步骤就可完成数据源的配置：
 
 * 直接在 `application.properties` 配置文件中配置数据源信息即可
 
@@ -236,6 +285,16 @@ NOTE: 默认情况下，xml 格式是不支持的。需要添加 `jackson-datafo
 
 ### More
 
+下表显示当应用的 `ApplicationContext` 中存在对应的Bean的类型时，会进行的一些操作：
+
+:frame: topbot
+[width="60%",options="header"]
+|====
+^|存在Bean的类型 ^|操作 ^|作用
+|`UrlCleaner`|`WebCallbackManager.setUrlCleaner(urlCleaner)`|资源清理(资源（比如将满足 /foo/:id 的 URL 都归到 /foo/* 资源下）)
+|`UrlBlockHandler`|`WebCallbackManager.setUrlBlockHandler(urlBlockHandler)`|自定义限流处理逻辑
+|====
+
 下表显示 Spring Cloud Alibaba Sentinel 的所有配置信息：
 
 :frame: topbot
@@ -244,14 +303,16 @@ NOTE: 默认情况下，xml 格式是不支持的。需要添加 `jackson-datafo
 ^|配置项 ^|含义 ^|默认值
 |`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.charset`|metric文件字符集|UTF-8
 |`spring.cloud.sentinel.metric.fileSingleSize`|Sentinel metric 单个文件的大小|
 |`spring.cloud.sentinel.metric.fileTotalCount`|Sentinel metric 总文件数量|
+|`spring.cloud.sentinel.log.dir`|Sentinel 日志文件所在的目录|
+|`spring.cloud.sentinel.log.switch-pid`|Sentinel 日志文件名是否需要带上pid|false
 |`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
 |====