整合Sentinel

妖狐艹你老母 2023-09-23 20:25 102阅读 0赞

### 应用整合Sentinel ###

在dependencies中添加依赖，即可整合Sentinel

1.  `<dependency>`
2.  `<groupId>com.alibaba.cloud</groupId>`
3.  `<artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>`
4.  `</dependency>`

### 搭建Sentinel控制台 ###

可以从这个地址：[Releases · alibaba/Sentinel · GitHub][Releases _ alibaba_Sentinel _ GitHub] 下载控制台应用。因为下载速度较慢，给出一个我下载的版本（1.6.3）  
  
百度云地址：链接: [百度网盘-链接不存在][-] 密码: i68g  
  
运行命令启动控制台：`java -jar sentinel-dashboard-1.6.3.jar`  
  
打开浏览器，输入http://localhost:8080进入控制台页面（账号密码默认sentinel）

![591b37ae277b0cb9b13c15ae1acb1c86.png][]

### 应用整合Sentinel控制台 ###

添加配置文件：

1.  `spring:`
2.  `cloud:`
3.  `sentinel:`
4.  `transport:`
5.  `# 指定sentinel控制台地址`
6.  `dashboard: localhost:8080`

**PS：**其他的配置项

1.  `spring:`
2.  `cloud:`
3.  `sentinel:`
4.  `transport:`
5.  `# 指定sentinel控制台地址`
6.  `dashboard: localhost:8080`
7.  `# 指定和控制台通信的IP，若不配置，会自动选择一个IP注册`
8.  `client-ip: 127.0.0.1`
9.  `# 指定和控制台通信的端口哦，默认值8719`
10. `# 若不配置，会自动扫猫从8719开始扫猫，依次+1，知道值找到未被占用的端口`
11. `port: 8719`
12. `# 心跳发送周期，默认值null`
13. `# 但在SimpleHttpHeartbeatSender会用默认值10秒`
14. `heartbeat-interval-ms: 10000`

这样，就为应用整合好Sentinel了，应用发生请求后，控制台如下：

![f8c29ce9fc97be13bb33554a9eb1be9a.png][]

## 控制台配置规则 ##

### 流控规则 ###

打开Sentinel控制台，点击**簇点链路**，可以看见微服务曾经被访问过的路径

![4521c87af8ba9634cd147161967699c3.png][]

点击**流控**按钮，便可以为应用设置流控规则

![eb140f6767b532c1c526ac66b980a39e.png][]

*  资源名：唯一名称，默认请求路径
 *  针对来源：Sentinel可以针对调用者进行限流，填写微服务名，默认default（不区分来源）
 *  阈值类型/单机阈值：
    
     *  QPS（每秒钟的请求数量）：当调用该api的QPS达到阈值的时候，进行限流
     *  线程数：当调用该api的线程数达到阈值的时候，进行限流
 *  是否集群：不需要集群，暂不研究
 *  流控模式：
    
     *  直接：api达到限流条件时，直接限流
     *  关联：当关联的资源达到阈值时，就限流自己
     *  链路：只记录指定链路上的流量（指定资源从入口资源进来的流量，如果达到阈值，就进行限流）【api级别的针对来源】
 *  流控效果：
    
     *  快速失败：直接失败，抛异常
     *  Warm Up：根据codeFactor（冷加载因子，默认3）的值，从阈值/codeFactor，经过预热时长，才达到设置的QPS阈值
     *  排队等待：匀速排队，让请求以匀速的速度通过，阈值类型必须设置为QPS，否则无效

### 降级规则（断路器模式） ###

点击**降级**按钮，便可以为应用设置降级规则

![791e997ead817b3888cf4a1258d5b30d.png][]

**降级策略：**

*  RT：平均响应时间（秒级统计）超出阈值且在时间窗口内的请求 >= 5时，触发降级；时间窗口结束后，关闭降级【Sentinel默认最大的RT为4900ms，可以通过-Dcsp.sentinel.statistic.max.rt=xxx修改】
 *  异常比例：QPS >= 5 且异常比例（秒级统计）超过阈值时，触发降级；时间窗口结束后，关闭降级
 *  异常数：异常数（分钟统计）超过阈值时，触发降级；时间窗口结束后，关闭降级【时间窗口 < 60秒可能会出现问题】

### 热点规则（热点参数限流规则） ###

Sentinel默认显示的端点并不支持热点规则，要显示热点规则，需要自己添加代码：

1.  `@GetMapping("test")`
2.  `@SentinelResource("test")`
3.  `public String testHot(@RequestParam(required = false) String a,`
4.  `@RequestParam(required = false) String b) {`
5.  `return a + "-" + b;`
6.  `}`

点击**热点**按钮，便可以为test设置热点规则

![04842f48691f26274c24ea3d7e6fde6a.png][]

**在时间窗口以内，一旦该api指定索引的参数QPS达到了域名，就会触发限流**

*  参数索引：从0开始，上面的代码中：a的参数索引为0；b的参数索引为1【参数索引对应的参数必须时基本类型或者String】

### 系统规则 ###

**阈值类型**

*  LOAD（仅对 Linux/Unix-like 机器生效）：当系统 load1 超过阈值，且系统当前的并发线程数超过系统容量时才会触发系统保护。系统容量由系统的 maxQps \* minRt 计算得出。设定参考值一般是 CPU cores \* 2.5
 *  RT：当单台机器上所有入口流量的平均 RT 达到阈值即触发系统保护，单位是毫秒
 *  线程数：当单台机器上所有入口流量的并发线程数达到阈值即触发系统保护
 *  入口 QPS：当单台机器上所有入口流量的 QPS 达到阈值即触发系统保护
 *  CPU 使用率：当系统 CPU 使用率超过阈值即触发系统保护（取值范围 0.0-1.0）

### 授权规则 ###

点击**授权**按钮，便可以为应用设置授权规则

![67915714314d6dcec46cf55fa2d431f0.png][]

资源名所代表的资源只允许*流控应用*中添加的微服务使用（白名单）、不允许使用（黑名单）

## 代码配置规则 ##

### 流控规则 ###

#### 参数 ####

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>resource</td> 
   <td>资源名，资源名是限流规则的作用对象</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>count</td> 
   <td>限流阈值</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>grade</td> 
   <td>限流阈值类型，QPS 或线程数模式</td> 
   <td>QPS模式</td> 
  </tr> 
  <tr> 
   <td>limitApp</td> 
   <td>流控针对的调用来源</td> 
   <td>default，代表不区分调用来源</td> 
  </tr> 
  <tr> 
   <td>strategy</td> 
   <td>default，代表不区分调用来源</td> 
   <td>根据资源本身</td> 
  </tr> 
  <tr> 
   <td>controlBehavior</td> 
   <td>流控效果（直接拒绝 / 排队等待 / 慢启动模式）</td> 
   <td>直接拒绝</td> 
  </tr> 
 </tbody> 
</table>

#### 代码 ####

1.  `private void initFlowQpsRule() {`
2.  `List<FlowRule> rules = new ArrayList<>();`
3.  `FlowRule rule = new FlowRule(resourceName);`
4.  `// 设置QPS阈值为20`
5.  `rule.setCount(20);`
6.  `rule.setGrade(RuleConstant.FLOW_GRADE_QPS);`
7.  `rule.setLimitApp("default");`
8.  `rules.add(rule);`
9.  `FlowRuleManager.loadRules(rules);`
10. `}`

### 降级规则 ###

#### 参数 ####

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>resource</td> 
   <td>资源名，即限流规则的作用对象</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>count</td> 
   <td>阈值</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>grade</td> 
   <td>降级模式，根据 RT 降级还是根据异常比例降级</td> 
   <td>RT</td> 
  </tr> 
  <tr> 
   <td>timeWindow</td> 
   <td>降级的时间，单位为 s</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

#### 代码 ####

1.  `private void initDegradeRule() {`
2.  `List<DegradeRule> rules = new ArrayList<>();`
3.  `DegradeRule rule = new DegradeRule();`
4.  `rule.setResource(KEY);`
5.  `// set threshold RT, 10 ms`
6.  `rule.setCount(10);`
7.  `rule.setGrade(RuleConstant.DEGRADE_GRADE_RT);`
8.  `rule.setTimeWindow(10);`
9.  `rules.add(rule);`
10. `DegradeRuleManager.loadRules(rules);`
11. `}`

### 热点规则 ###

#### 参数 ####

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>resource</td> 
   <td>资源名，必填</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>count</td> 
   <td>限流阈值，必填</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>grade</td> 
   <td>限流模式</td> 
   <td>QPS 模式</td> 
  </tr> 
  <tr> 
   <td>durationInSec</td> 
   <td>统计窗口时间长度（单位为秒）</td> 
   <td>1s</td> 
  </tr> 
  <tr> 
   <td>controlBehavior</td> 
   <td>流控效果（支持快速失败和匀速排队模式）</td> 
   <td>快速失败</td> 
  </tr> 
  <tr> 
   <td>maxQueueingTimeMs</td> 
   <td>最大排队等待时长（仅在匀速排队模式生效）</td> 
   <td>0ms</td> 
  </tr> 
  <tr> 
   <td>paramIdx</td> 
   <td>热点参数的索引，必填，对应 SphU.entry(xxx, args) 中的参数索引位置</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>paramFlowItemList</td> 
   <td>参数例外项，可以针对指定的参数值单独设置限流阈值，不受前面 count 阈值的限制。仅支持基本类型</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>clusterMode</td> 
   <td>是否是集群参数流控规则</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>clusterConfig</td> 
   <td>集群流控相关配置</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

#### 代码 ####

1.  `ParamFlowRule rule = new ParamFlowRule(resourceName)`
2.  `.setParamIdx(0)`
3.  `.setCount(5);`
4.  `// 针对 int 类型的参数 PARAM_B，单独设置限流 QPS 阈值为 10，而不是全局的阈值 5.`
5.  `ParamFlowItem item = new ParamFlowItem().setObject(String.valueOf(PARAM_B))`
6.  `.setClassType(int.class.getName())`
7.  `.setCount(10);`
8.  `rule.setParamFlowItemList(Collections.singletonList(item));`
9.  
10. `ParamFlowRuleManager.loadRules(Collections.singletonList(rule));`

### 系统规则 ###

#### 参数 ####

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>highestSystemLoad</td> 
   <td>最大的 load1</td> 
   <td>-1(不生效)</td> 
  </tr> 
  <tr> 
   <td>avgRt</td> 
   <td>所有入口流量的平均响应时间</td> 
   <td>-1(不生效)</td> 
  </tr> 
  <tr> 
   <td>maxThread</td> 
   <td>入口流量的最大并发数</td> 
   <td>-1(不生效)</td> 
  </tr> 
  <tr> 
   <td>qpa</td> 
   <td>所有入口资源的 QPS</td> 
   <td>-1(不生效)</td> 
  </tr> 
 </tbody> 
</table>

#### 代码 ####

1.  `private void initSystemRule() {`
2.  `List<SystemRule> rules = new ArrayList<>();`
3.  `SystemRule rule = new SystemRule();`
4.  `rule.setHighestSystemLoad(10);`
5.  `rules.add(rule);`
6.  `SystemRuleManager.loadRules(rules);`
7.  `}`

### 授权规则 ###

#### 参数 ####

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>resource</td> 
   <td>资源名，即限流规则的作用对象</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>limitApp</td> 
   <td>对应的黑名单/白名单，不同 origin 用 , 分隔，如 appA,appB</td> 
   <td>default，代表不区分调用来源</td> 
  </tr> 
  <tr> 
   <td>strategy</td> 
   <td>限制模式，AUTHORITY_WHITE 为白名单模式，AUTHORITY_BLACK 为黑名单模式，默认为白名单模式</td> 
   <td>AUTHORITY_WHITE</td> 
  </tr> 
 </tbody> 
</table>

#### 代码 ####

1.  `AuthorityRule rule = new AuthorityRule();`
2.  `rule.setResource("test");`
3.  `rule.setStrategy(RuleConstant.AUTHORITY_WHITE);`
4.  `rule.setLimitApp("appA,appB");`
5.  `AuthorityRuleManager.loadRules(Collections.singletonList(rule));`

来源：[Spring Cloud Alibaba学习笔记（5） - 整合Sentinel及Sentinel规则][Spring Cloud Alibaba_5_ - _Sentinel_Sentinel]

[Releases _ alibaba_Sentinel _ GitHub]: https://github.com/alibaba/Sentinel/releases
[-]: https://pan.baidu.com/s/1UV4OzfjfuBZQfpPb28z0sw&shfl=sharepset
[591b37ae277b0cb9b13c15ae1acb1c86.png]: https://img-blog.csdnimg.cn/img_convert/591b37ae277b0cb9b13c15ae1acb1c86.png
[f8c29ce9fc97be13bb33554a9eb1be9a.png]: https://img-blog.csdnimg.cn/img_convert/f8c29ce9fc97be13bb33554a9eb1be9a.png
[4521c87af8ba9634cd147161967699c3.png]: https://img-blog.csdnimg.cn/img_convert/4521c87af8ba9634cd147161967699c3.png
[eb140f6767b532c1c526ac66b980a39e.png]: https://img-blog.csdnimg.cn/img_convert/eb140f6767b532c1c526ac66b980a39e.png
[791e997ead817b3888cf4a1258d5b30d.png]: https://img-blog.csdnimg.cn/img_convert/791e997ead817b3888cf4a1258d5b30d.png
[04842f48691f26274c24ea3d7e6fde6a.png]: https://img-blog.csdnimg.cn/img_convert/04842f48691f26274c24ea3d7e6fde6a.png
[67915714314d6dcec46cf55fa2d431f0.png]: https://img-blog.csdnimg.cn/img_convert/67915714314d6dcec46cf55fa2d431f0.png
[Spring Cloud Alibaba_5_ - _Sentinel_Sentinel]: https://www.shuzhiduo.com/A/amd0lBqmdg/