Alibaba Sentinel 规则参数总结

柔光的暖阳◎ 2021-06-10 20:39 649阅读 0赞

## 一、流控规则 ##

1.1 配置

![流控规则][8672bccfac819f6c75f2a2dc825ea3e0.png]

1.2 参数

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>resource</td> 
   <td>资源名，资源名是限流规则的作用对象</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>count</td> 
   <td>限流阈值</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>grade</td> 
   <td>限流阈值类型，QPS 或线程数模式</td> 
   <td>QPS 模式</td> 
  </tr> 
  <tr> 
   <td>limitApp</td> 
   <td>流控针对的调用来源</td> 
   <td><code>default</code>，代表不区分调用来源</td> 
  </tr> 
  <tr> 
   <td>strategy</td> 
   <td>判断的根据是资源自身，还是根据其它关联资源 (<code>refResource</code>)，还是根据链路入口</td> 
   <td>根据资源本身</td> 
  </tr> 
  <tr> 
   <td>controlBehavior</td> 
   <td>流控效果（直接拒绝 / 排队等待 / 慢启动模式）</td> 
   <td>直接拒绝</td> 
  </tr> 
 </tbody> 
</table>

1.3 代码配置示例

private void initFlowQpsRule() {
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule(resourceName);
        // set limit qps to 20
        rule.setCount(20);
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setLimitApp("default");
        rules.add(rule);
        FlowRuleManager.loadRules(rules);
    }

1.4 参考：`https://github.com/alibaba/Sentinel/wiki/如何使用#流量控制规则-flowrule`

1.5 参考：[流量控制][Link 1]

## 二、降级规则 ##

2.1 配置

![降级规则][24fb534e4426f0762a50eacbe5a5c985.png]

2.2 参数

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

2.3 代码配置示例

private void initDegradeRule() {
        List<DegradeRule> rules = new ArrayList<>();
        DegradeRule rule = new DegradeRule();
        rule.setResource(KEY);
        // set threshold RT, 10 ms
        rule.setCount(10);
        rule.setGrade(RuleConstant.DEGRADE_GRADE_RT);
        rule.setTimeWindow(10);
        rules.add(rule);
        DegradeRuleManager.loadRules(rules);
    }

2.4 参考：`https://github.com/alibaba/Sentinel/wiki/如何使用#熔断降级规则-degraderule`

## 三、热点规则 ##

3.1 配置

![热点规则][78344bdef6186e8fca80e12fd366da8e.png]

3.2 参数

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

3.3 代码配置示例

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

3.4 参考：`https://github.com/alibaba/Sentinel/wiki/热点参数限流`

## 四、系统规则 ##

4.1 配置

![系统规则][239614e6e10060c92c2f5c2746de15fa.png]

4.2 参数

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>highestSystemLoad</td> 
   <td>最大的&nbsp;<code>load1</code></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>qps</td> 
   <td>所有入口资源的 QPS</td> 
   <td>-1 (不生效)</td> 
  </tr> 
 </tbody> 
</table>

4.3 代码配置示例

private void initSystemRule() {
        List<SystemRule> rules = new ArrayList<>();
        SystemRule rule = new SystemRule();
        rule.setHighestSystemLoad(10);
        rules.add(rule);
        SystemRuleManager.loadRules(rules);
    }

4.4 参考：`https://github.com/alibaba/Sentinel/wiki/如何使用#系统保护规则-systemrule`

## 五、授权规则 ##

5.1 配置

![授权规则][46baf4844046d1f6588d1ad7c19de058.png]

5.2 参数

<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 用&nbsp;<code>,</code>&nbsp;分隔，如&nbsp;<code>appA,appB</code></td> 
   <td>default，代表不区分调用来源</td> 
  </tr> 
  <tr> 
   <td>strategy</td> 
   <td>限制模式，<code>AUTHORITY_WHITE</code>&nbsp;为白名单模式，<code>AUTHORITY_BLACK</code>&nbsp;为黑名单模式，默认为白名单模式</td> 
   <td>AUTHORITY_WHITE</td> 
  </tr> 
 </tbody> 
</table>

5.3 代码配置示例

AuthorityRule rule = new AuthorityRule();
    rule.setResource("test");
    rule.setStrategy(RuleConstant.AUTHORITY_WHITE);
    rule.setLimitApp("appA,appB");
    AuthorityRuleManager.loadRules(Collections.singletonList(rule));

5.4 参考：`https://github.com/alibaba/Sentinel/wiki/如何使用#访问控制规则-authorityrule`

[8672bccfac819f6c75f2a2dc825ea3e0.png]: /images/20210527/b8f997fedc97467596dd22531ffac517.png
[Link 1]: https://github.com/alibaba/Sentinel/wiki/%E6%B5%81%E9%87%8F%E6%8E%A7%E5%88%B6
[24fb534e4426f0762a50eacbe5a5c985.png]: /images/20210527/ab1cf58628ae4af394957da6ab516107.png
[78344bdef6186e8fca80e12fd366da8e.png]: /images/20210527/75929cd4e77542f9870a2b4564ba77af.png
[239614e6e10060c92c2f5c2746de15fa.png]: /images/20210527/a7adfc0cd0044d24b75c65a348472d69.png
[46baf4844046d1f6588d1ad7c19de058.png]: /images/20210527/603fc30254da4eaf8c2fdf685fcfd7e4.png