[Spring-Cloud-Alibaba] Sentinel 規則持久化

IsaacZhang發表於2019-07-22

在之前的練習中，只要應用重啟，就需要重新配置，這樣在我們實際的專案是非常不實用的，那麼有沒有辦法把我們配置的規則儲存下來呢？答案是YES，那麼接下來，給大家來介紹如何將Sentinel規則持久化。

File Datasource(檔案儲存)
- Pull 模式
- Push 模式
Nacos configuration
Apollo

File Datasource

Pull 模式

原理：
擴充套件寫資料來源（WritableDataSource），客戶端主動向某個規則管理中心定期輪詢拉取規則，這個規則中心可以是 RDBMS、檔案等
pull 模式的資料來源（如本地檔案、RDBMS 等）一般是可寫入的。使用時需要在客戶端註冊資料來源：將對應的讀資料來源註冊至對應的 RuleManager，將寫資料來源註冊至 transport 的 WritableDataSourceRegistry 中。

過程如下：
[Spring-Cloud-Alibaba] Sentinel 規則持久化

Pull Demo

Step 1: 新增配置

    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-extension</artifactId>
    </dependency>

Step 2: 編寫持久化程式碼，實現com.alibaba.csp.sentinel.init.InitFunc

程式碼參考自：傳送門

import com.alibaba.csp.sentinel.command.handler.ModifyParamFlowRulesCommandHandler;
import com.alibaba.csp.sentinel.datasource.*;
import com.alibaba.csp.sentinel.init.InitFunc;
import com.alibaba.csp.sentinel.slots.block.authority.AuthorityRule;
import com.alibaba.csp.sentinel.slots.block.authority.AuthorityRuleManager;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowRuleManager;
import com.alibaba.csp.sentinel.slots.system.SystemRule;
import com.alibaba.csp.sentinel.slots.system.SystemRuleManager;
import com.alibaba.csp.sentinel.transport.util.WritableDataSourceRegistry;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;

import java.io.File;
import java.io.IOException;
import java.util.List;

/**
 * FileDataSourceInit for : 自定義Sentinel儲存檔案資料來源載入類
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
 * @since 2019/7/21
 */
public class FileDataSourceInit implements InitFunc {
    @Override
    public void init() throws Exception {
        // TIPS: 如果你對這個路徑不喜歡，可修改為你喜歡的路徑
        String ruleDir = System.getProperty("user.home") + "/sentinel/rules";
        String flowRulePath = ruleDir + "/flow-rule.json";
        String degradeRulePath = ruleDir + "/degrade-rule.json";
        String systemRulePath = ruleDir + "/system-rule.json";
        String authorityRulePath = ruleDir + "/authority-rule.json";
        String hotParamFlowRulePath = ruleDir + "/param-flow-rule.json";

        this.mkdirIfNotExits(ruleDir);
        this.createFileIfNotExits(flowRulePath);
        this.createFileIfNotExits(degradeRulePath);
        this.createFileIfNotExits(systemRulePath);
        this.createFileIfNotExits(authorityRulePath);
        this.createFileIfNotExits(hotParamFlowRulePath);
        // 流控規則
        ReadableDataSource<String, List<FlowRule>> flowRuleRDS = new FileRefreshableDataSource<>(
                flowRulePath,
                flowRuleListParser
        );
        // 將可讀資料來源註冊至FlowRuleManager
        // 這樣當規則檔案發生變化時，就會更新規則到記憶體
        FlowRuleManager.register2Property(flowRuleRDS.getProperty());
        WritableDataSource<List<FlowRule>> flowRuleWDS = new FileWritableDataSource<>(
                flowRulePath,
                this::encodeJson
        );
        // 將可寫資料來源註冊至transport模組的WritableDataSourceRegistry中
        // 這樣收到控制檯推送的規則時，Sentinel會先更新到記憶體，然後將規則寫入到檔案中
        WritableDataSourceRegistry.registerFlowDataSource(flowRuleWDS);

        // 降級規則
        ReadableDataSource<String, List<DegradeRule>> degradeRuleRDS = new FileRefreshableDataSource<>(
                degradeRulePath,
                degradeRuleListParser
        );
        DegradeRuleManager.register2Property(degradeRuleRDS.getProperty());
        WritableDataSource<List<DegradeRule>> degradeRuleWDS = new FileWritableDataSource<>(
                degradeRulePath,
                this::encodeJson
        );
        WritableDataSourceRegistry.registerDegradeDataSource(degradeRuleWDS);

        // 系統規則
        ReadableDataSource<String, List<SystemRule>> systemRuleRDS = new FileRefreshableDataSource<>(
                systemRulePath,
                systemRuleListParser
        );
        SystemRuleManager.register2Property(systemRuleRDS.getProperty());
        WritableDataSource<List<SystemRule>> systemRuleWDS = new FileWritableDataSource<>(
                systemRulePath,
                this::encodeJson
        );
        WritableDataSourceRegistry.registerSystemDataSource(systemRuleWDS);

        // 授權規則
        ReadableDataSource<String, List<AuthorityRule>> authorityRuleRDS = new FileRefreshableDataSource<>(
                flowRulePath,
                authorityRuleListParser
        );
        AuthorityRuleManager.register2Property(authorityRuleRDS.getProperty());
        WritableDataSource<List<AuthorityRule>> authorityRuleWDS = new FileWritableDataSource<>(
                authorityRulePath,
                this::encodeJson
        );
        WritableDataSourceRegistry.registerAuthorityDataSource(authorityRuleWDS);

        // 熱點引數規則
        ReadableDataSource<String, List<ParamFlowRule>> hotParamFlowRuleRDS = new FileRefreshableDataSource<>(
                hotParamFlowRulePath,
                hotParamFlowRuleListParser
        );
        ParamFlowRuleManager.register2Property(hotParamFlowRuleRDS.getProperty());
        WritableDataSource<List<ParamFlowRule>> paramFlowRuleWDS = new FileWritableDataSource<>(
                hotParamFlowRulePath,
                this::encodeJson
        );
        ModifyParamFlowRulesCommandHandler.setWritableDataSource(paramFlowRuleWDS);
    }

    /**
     * 流控規則物件轉換
     */
    private Converter<String, List<FlowRule>> flowRuleListParser = source -> JSON.parseObject(
            source,
            new TypeReference<List<FlowRule>>() {
            }
    );
    /**
     * 降級規則物件轉換
     */
    private Converter<String, List<DegradeRule>> degradeRuleListParser = source -> JSON.parseObject(
            source,
            new TypeReference<List<DegradeRule>>() {
            }
    );
    /**
     * 系統規則物件轉換
     */
    private Converter<String, List<SystemRule>> systemRuleListParser = source -> JSON.parseObject(
            source,
            new TypeReference<List<SystemRule>>() {
            }
    );

    /**
     * 授權規則物件轉換
     */
    private Converter<String, List<AuthorityRule>> authorityRuleListParser = source -> JSON.parseObject(
            source,
            new TypeReference<List<AuthorityRule>>() {
            }
    );

    /**
     * 熱點規則物件轉換
     */
    private Converter<String, List<ParamFlowRule>> hotParamFlowRuleListParser = source -> JSON.parseObject(
            source,
            new TypeReference<List<ParamFlowRule>>() {
            }
    );

    /**
     * 建立目錄
     *
     * @param filePath
     */
    private void mkdirIfNotExits(String filePath) {
        File file = new File(filePath);
        if (!file.exists()) {
            file.mkdirs();
        }
    }

    /**
     * 建立檔案
     *
     * @param filePath
     * @throws IOException
     */
    private void createFileIfNotExits(String filePath) throws IOException {
        File file = new File(filePath);
        if (!file.exists()) {
            file.createNewFile();
        }
    }

    private <T> String encodeJson(T t) {
        return JSON.toJSONString(t);
    }
}

Step 3: 啟用上述程式碼

resource 目錄下建立 resources/META-INF/services 目錄並建立檔案com.alibaba.csp.sentinel.init.InitFunc ，內容為：
```
com.sxzhongf.sharedcenter.configuration.sentinel.datasource.FileDataSourceInit
```

Pull 優缺點

優點
1. 簡單，無任何依賴
2. 沒有額外依賴
缺點
1. 不保證一致性（規則是使用FileRefreshableDataSource定時更新，會有延遲）
2. 實時性不保證（規則是使用FileRefreshableDataSource定時更新）
3. 拉取過於頻繁也可能會有效能問題
4. 由於檔案儲存於本地，容易丟失
參考資料：
1. ITMUCH
2. Sentinel WIKI

Push 模式

推薦通過控制檯設定規則後將規則推送到統一的規則中心，客戶端實現 ReadableDataSource介面端監聽規則中心實時獲取變更，流程如下：

[Spring-Cloud-Alibaba] Sentinel 規則持久化

實現原理
1. 控制檯推送規則到Nacos/遠端配置中心
2. Sentinel client 艦艇Nacos配置變化，更新本地快取

shared_center service 加工

新增依賴

  <dependency>
      <groupId>com.alibaba.csp</groupId>
      <artifactId>sentinel-datasource-nacos</artifactId>
  </dependency>

新增配置

spring:
  cloud:
    sentinel:
      datasource:
        sxzhongf_flow:
          nacos:
            server-addr: localhost:8848
            dataId: ${spring.application.name}-flow-rules
            groupId: SENTINEL_GROUP
            # 規則型別，取值見：org.springframework.cloud.alibaba.sentinel.datasource.RuleType
            rule_type: flow
        sxzhongf_degrade:
          nacos:
            server-addr: localhost:8848
            dataId: ${spring.application.name}-degrade-rules
            groupId: SENTINEL_GROUP
            rule-type: degrade

Sentinel dashboard 加工

Dashboard 規則改造主要通過2個介面：

com.alibaba.csp.sentinel.dashboard.rule.DynamicRuleProvider & com.alibaba.csp.sentinel.dashboard.rule.DynamicRulePublisher

Download Sentinel Source Code

修改原sentinel-dashboard專案下的POM檔案

    <!-- for Nacos rule publisher sample -->
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-nacos</artifactId>
        <!--註釋掉原檔案中的scope，讓其不僅在test的時候生效-->
        <!--<scope>test</scope>-->
    </dependency>

偷懶模式：複製sentinel-dashboard專案下test下的nacos包（

src/test/java/com/alibaba/csp/sentinel/dashboard/rule/nacos到 src/main/java/com/alibaba/csp/sentinel/dashboard/rule下

修改controller中的預設provider & publisher

com.alibaba.csp.sentinel.dashboard.controller.v2.FlowControllerV2中

    @Autowired
    // @Qualifier("flowRuleDefaultProvider")
        @Qualifier("flowRuleNacosProvider")
    private DynamicRuleProvider<List<FlowRuleEntity>> ruleProvider;
    @Autowired
        // @Qualifier("flowRuleDefaultPublisher")
    @Qualifier("flowRuleNacosPublisher")
    private DynamicRulePublisher<List<FlowRuleEntity>> rulePublisher;

開啟 /Sentinel-1.6.2/sentinel-dashboard/src/main/webapp/resources/app/scripts/directives/sidebar/sidebar.html檔案，修改程式碼：

<!--<li ui-sref-active="active">-->
            <!--<a ui-sref="dashboard.flow({app: entry.app})">-->
              <!--<i class="glyphicon glyphicon-filter"></i>&nbsp;&nbsp;流控規則 V1</a>-->
<!--</li>-->

---

改為

  <li ui-sref-active="active">
    <a ui-sref="dashboard.flow({app: entry.app})">
      <i class="glyphicon glyphicon-filter"></i>&nbsp;&nbsp;NACOS 流控規則 V1</a>
  </li>

Dashboard中要修改的程式碼已經好了。

重新啟動 Sentinel-dashboard mvn clean package -DskipTests
測試效果

Sentinel 新增流控規則：

Nacos 檢視同步的配置：

Sentinel 實戰-規則持久化
2019-01-09
持久化
Sentinel規則基於Apollo(阿波羅)持久化
2020-10-23
持久化
SpringCloud使用Sentinel，Sentinel持久化，Sentinel使用nacos持久化
2024-08-02
SpringGCCloud持久化
Sentinel Dashboard（基於1.8.1）流控規則持久化到Nacos——涉及部分Sentinel Dashboard原始碼改造
2020-12-15
持久化原始碼
Spring-Cloud-Alibaba之Sentinel
2021-04-29
SpringCloud
Sentinel之流控規則
2021-12-13
Debian使用iptables-persistent持久化iptables規則
2018-03-13
持久化
Spring Cloud Alibaba(11)---Sentinel+Nacos持久化
2021-05-20
SpringCloud持久化
Sentinel Dashboard中修改規則同步到Nacos
2019-05-21
Sentinel進化指南：dashbaord改造，叢集流控，監控持久化
2024-11-11
持久化
sentinel流控規則校驗之原始碼分析
2021-02-05
原始碼
Spring Cloud Alibaba - Sentinel入門案例（四）（熱點規則）
2020-07-06
SpringCloud
微服務構建持久API的7大規則
2020-02-11
微服務API
Spring Cloud Alibaba基礎教程：Sentinel使用Nacos儲存規則
2019-04-17
SpringCloud
Spring Cloud Alibaba基礎教程：Sentinel使用Apollo儲存規則
2019-04-21
SpringCloud
Spring Cloud Alibaba基礎教程：Sentinel Dashboard同步Apollo儲存規則
2019-05-07
SpringCloud
Spring Cloud Alibaba系列——Sentinel降級規則簡介與實踐
2020-12-15
SpringCloud
一個名叫Sentinel-Rules-SDK的元件，使得Sentinel的流控&熔斷規則的配置更加方便
2021-03-15
元件
Spring Cloud Alibaba基礎教程：Sentinel Dashboard中修改規則同步到Nacos
2019-05-22
SpringCloud
Sentinel上生產環境只差一步，監控資料持久化
2021-04-19
持久化
Redis資料持久化—RDB持久化與AOF持久化
2021-05-20
Redis持久化
最佳化器-RBO 的規則轉化
2023-03-14
redis系列：RDB持久化與AOF持久化
2019-03-02
Redis持久化
第2-4-4章規則引擎Drools規則屬性-業務規則管理系統-元件化-中臺
2022-11-25
元件化
MySQL 優化三（優化規則）（高階篇）
2020-04-10
MySql優化
VSCode 使用 eslint 規則格式化 js
2019-05-09
VSCodeEsLintJS
SpringBoot專案校驗規則優化
2019-02-12
Spring Boot優化
語義化版本 2.0.0 - 版本控制規則
2021-07-23
redisaof持久化
2018-06-17
Redis持久化
redis持久化
2024-04-13
Redis持久化
Docker 持久化
2024-05-01
Docker持久化
Redis 持久化
2020-06-10
Redis持久化
[Redis]持久化
2024-07-06
Redis持久化
Redis - 持久化
2021-05-16
Redis持久化
規則
2019-07-02
Spring-Cloud-Alibaba之Seata
2021-05-06
SpringCloud
HexMap學習筆記(四)——不規則化
2019-03-20
筆記
數字化轉型中的規則引擎
2022-02-11

[Spring-Cloud-Alibaba] Sentinel 規則持久化

File Datasource

Pull 模式

Pull Demo

Pull 優缺點

Push 模式

相關文章