如何基於 Nacos 和 Sentinel ，實現灰度路由和流量防禦一體化

時間 2019-11-06

標籤如何基於 nacos sentinel 實現灰度路由流量防禦一體化欄目系統網絡简体版

原文原文鏈接

Nepxion Discovery框架在實現灰度發佈和路由功能前提下，結合Nacos和Sentinel，對流量再實施一層防禦措施，更能達到企業級的流量安全控制的目的。它的功能包括：

封裝遠程配置中心和本地規則文件的讀取邏輯，即優先讀取遠程配置，若是不存在或者規則錯誤，則讀取本地規則文件。動態實現遠程配置中心對於規則的熱刷新
封裝NacosDataSource和ApolloDataSource，支持Nacos和Apollo兩個遠程配置中心，零代碼實現Sentinel功能。更多的遠程配置中心，請參照Sentinel官方的DataSource並自行集成
支持原生的流控規則、降級規則、受權規則、系統規則、熱點參數流控規則
支持擴展LimitApp的機制，經過動態的Http Header方式實現組合式防禦機制，包括基於服務名、基於灰度組、基於灰度版本、基於灰度區域、基於機器地址和端口等防禦機制，支持自定義任意的業務參數組合實現該功能，例如，根據傳入的微服務灰度版本號+用戶名，組合在一塊兒進行熔斷
支持微服務側Actuator、Swagger和Rest三種方式的規則寫入
支持控制檯側基於微服務名的Actuator、Swagger和Rest三種方式的批量規則寫入
支持開關關閉上述功能spring.application.strategy.sentinel.enabled=true，默認是關閉的

[Nacos] 阿里巴巴中間件部門開發的新一代集服務註冊發現中心和配置中心爲一體的中間件。它是構建以「服務」爲中心的現代應用架構 (例如微服務範式、雲原生範式) 的服務基礎設施，支持幾乎全部主流類型的「服務」的發現、配置和管理，更敏捷和容易地構建、交付和管理微服務平臺

[Sentinel] 阿里巴巴中間件部門開發的新一代以流量爲切入點，從流量控制、熔斷降級、系統負載保護等多個維度保護服務的穩定性的分佈式系統的流量防衛兵。它承接了阿里巴巴近10年的雙十一大促流量的核心場景，例如秒殺（即突發流量控制在系統容量能夠承受的範圍）、消息削峯填谷、集羣流量控制、實時熔斷下游不可用應用等

環境搭建及依賴引入

服務端在Discovery框架原有依賴的基礎上，再引入以下依賴

<dependency>
    <groupId>com.nepxion</groupId>
    <artifactId>discovery-plugin-strategy-starter-service-sentinel</artifactId>
    <version>${discovery.version}</version>
</dependency>

<dependency>
    <groupId>com.nepxion</groupId>
    <artifactId>discovery-plugin-strategy-sentinel-starter-nacos</artifactId>
    <!-- <artifactId>discovery-plugin-strategy-sentinel-starter-apollo</artifactId> -->
    <version>${discovery.version}</version>
</dependency>複製代碼

原生Sentinel註解

參照下面代碼，爲接口方法增長@SentinelResource註解，value爲sentinel-resource，blockHandler和fallback是防禦其做用後須要執行的方法

@RestController
@ConditionalOnProperty(name = DiscoveryConstant.SPRING_APPLICATION_NAME, havingValue = "discovery-guide-service-b")
public class BFeignImpl extends AbstractFeignImpl implements BFeign {
    private static final Logger LOG = LoggerFactory.getLogger(BFeignImpl.class);

    @Override
    @SentinelResource(value = "sentinel-resource", blockHandler = "handleBlock", fallback = "handleFallback")
    public String invoke(@PathVariable(value = "value") String value) {
        value = doInvoke(value);

        LOG.info("調用路徑：{}", value);

        return value;
    }

    public String handleBlock(String value, BlockException e) {
        return value + "-> B server sentinel block, cause=" + e.getClass().getName() + ", rule=" + e.getRule() + ", limitApp=" + e.getRuleLimitApp();
    }

    public String handleFallback(String value) {
        return value + "-> B server sentinel fallback";
    }
}複製代碼

原生Sentinel規則

Sentinel在配置中心訂閱的Key格式，以下：

1. Nacos的Key格式：Group爲元數據中配置的[組名]，Data Id爲[服務名]-[規則類型]
2. Apollo的Key格式：[組名]-[服務名]-[規則類型]複製代碼

Sentinel規則的用法，請參照Sentinel官方文檔

流控規則

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-flow，規則內容以下：

[
    {
        "resource": "sentinel-resource",
        "limitApp": "default",
        "grade": 1,
        "count": 1,
        "strategy": 0,
        "refResource": null,
        "controlBehavior": 0,
        "warmUpPeriodSec": 10,
        "maxQueueingTimeMs": 500,
        "clusterMode": false,
        "clusterConfig": null
    }
]複製代碼

如圖所示

降級規則

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-degrade，規則內容以下：

[
    {
        "resource": "sentinel-resource",
        "limitApp": "default",
        "count": 2,
        "timeWindow": 10,
        "grade": 0,
        "passCount": 0
    }
]複製代碼

如圖所示

受權規則

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-authority，規則內容以下：

[
    {
        "resource": "sentinel-resource",
        "limitApp": "discovery-guide-service-a",
        "strategy": 0
    }
]複製代碼

如圖所示

系統規則

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-system，規則內容以下：

[
    {
        "resource": null,
        "limitApp": null,
        "highestSystemLoad": -1.0,
        "highestCpuUsage": -1.0,
        "qps": 200.0,
        "avgRt": -1,
        "maxThread": -1
    }
]複製代碼

如圖所示

熱點參數流控規則

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-param-flow，規則內容以下：

[
    {
        "resource": "sentinel-resource",
        "limitApp": "default",
        "grade": 1,
        "paramIdx": 0,
        "count": 1,
        "controlBehavior": 0,
        "maxQueueingTimeMs": 0,
        "burstCount": 0,
        "durationInSec": 1,
        "paramFlowItemList": [],
        "clusterMode": false
    }
]複製代碼

如圖所示

基於灰度路由和Sentinel-LimitApp擴展的防禦機制

該方式對於上面5種規則都有效，這裏以受權規則展開闡述

受權規則中，limitApp，若是有多個，能夠經過「,」分隔。"strategy": 0 表示白名單，"strategy": 1 表示黑名單

基於服務名的防禦機制

修改配置項Sentinel Request Origin Key爲服務名的Header名稱，修改受權規則中limitApp爲對應的服務名，可實現基於服務名的防禦機制

配置項，該配置項默認爲n-d-service-id，能夠不配置

spring.application.strategy.service.sentinel.request.origin.key=n-d-service-id複製代碼

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-authority，規則內容以下，表示全部discovery-guide-service-a服務容許訪問discovery-guide-service-b服務

[
    {
        "resource": "sentinel-resource",
        "limitApp": "discovery-guide-service-a",
        "strategy": 0
    }
]複製代碼

基於灰度組的防禦機制

修改配置項Sentinel Request Origin Key爲灰度組的Header名稱，修改受權規則中limitApp爲對應的組名，可實現基於組名的防禦機制

配置項

spring.application.strategy.service.sentinel.request.origin.key=n-d-service-group複製代碼

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-authority，規則內容以下，表示隸屬my-group組的全部服務都容許訪問服務discovery-guide-service-b

[
    {
        "resource": "sentinel-resource",
        "limitApp": "my-group",
        "strategy": 0
    }
]複製代碼

基於灰度版本的防禦機制

修改配置項Sentinel Request Origin Key爲灰度版本的Header名稱，修改受權規則中limitApp爲對應的版本，可實現基於版本的防禦機制

配置項

spring.application.strategy.service.sentinel.request.origin.key=n-d-service-version複製代碼

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-authority，規則內容以下，表示版本爲1.0的全部服務都容許訪問服務discovery-guide-service-b

[
    {
        "resource": "sentinel-resource",
        "limitApp": "1.0",
        "strategy": 0
    }
]複製代碼

基於灰度區域的防禦機制

修改配置項Sentinel Request Origin Key爲灰度區域的Header名稱，修改受權規則中limitApp爲對應的區域，可實現基於區域的防禦機制

配置項

spring.application.strategy.service.sentinel.request.origin.key=n-d-service-region複製代碼

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-authority，規則內容以下，表示區域爲dev的全部服務都容許訪問服務discovery-guide-service-b

[
    {
        "resource": "sentinel-resource",
        "limitApp": "dev",
        "strategy": 0
    }
]複製代碼

基於機器地址和端口的防禦機制

修改配置項Sentinel Request Origin Key爲灰度區域的Header名稱，修改受權規則中limitApp爲對應的區域值，可實現基於機器地址和端口的防禦機制

配置項

spring.application.strategy.service.sentinel.request.origin.key=n-d-service-address複製代碼

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-authority，規則內容以下，表示地址和端口爲192.168.0.88:8081和192.168.0.88:8082的服務都容許訪問服務discovery-guide-service-b

[
    {
        "resource": "sentinel-resource",
        "limitApp": "192.168.0.88:8081,192.168.0.88:8082",
        "strategy": 0
    }
]複製代碼

自定義業務參數的組合式防禦機制

經過適配類實現自定義業務參數的組合式防禦機制

// 版本號+用戶名，實現組合式熔斷
public class MyServiceSentinelRequestOriginAdapter extends DefaultServiceSentinelRequestOriginAdapter {
    @Override
    public String parseOrigin(HttpServletRequest request) {
        String version = request.getHeader(DiscoveryConstant.N_D_SERVICE_VERSION);
        String user = request.getHeader("user");

        return version + "&" + user;
    }
}複製代碼

在配置類裏@Bean方式進行適配類建立

@Bean
public ServiceSentinelRequestOriginAdapter ServiceSentinelRequestOriginAdapter() {
    return new MyServiceSentinelRequestOriginAdapter();
}複製代碼

增長服務discovery-guide-service-b的規則，Group爲discovery-guide-group，Data Id爲discovery-guide-service-b-sentinel-authority，規則內容以下，表示版本爲1.0且傳入的Http Header的user=zhangsan，同時知足這兩個條件下的全部服務都容許訪問服務discovery-guide-service-b

[
    {
        "resource": "sentinel-resource",
        "limitApp": "1.0&zhangsan",
        "strategy": 0
    }
]複製代碼

運行效果

當傳遞的Http Header中user=zhangsan，當全鏈路調用中，API網關負載均衡discovery-guide-service-a服務到1.0版本後再去調用discovery-guide-service-b服務，最終調用成功

如圖所示

當傳遞的Http Header中user=lisi，不知足條件，最終調用在discovery-guide-service-b服務端被拒絕掉

如圖所示

當傳遞的Http Header中user=zhangsan，知足條件之一，當全鏈路調用中，API網關負載均衡discovery-guide-service-a服務到1.1版本後再去調用discovery-guide-service-b服務，不知足version=1.0的條件，最終調用在discovery-guide-service-b服務端被拒絕掉

如圖所示

基於Swagger的Sentinel規則推送

分爲基於單個服務實例和基於服務名對應的多個服務實例的Sentinel規則推送

基於單個服務實例的Sentinel規則推送

直接訪問該服務實例的Swagger主頁便可

如圖所示

基於服務名對應的多個服務實例的Sentinel規則推送

須要開啓discovery-console服務，並訪問其Swagger主頁便可

如圖所示

本文做者：任浩軍， 10 多年開源經歷，Github ID：@HaojunRen，Nepxion 開源社區創始人，Nacos Group Member，Spring Cloud Alibaba & Nacos & Sentinel Committer ，曾就任於平安銀行平臺架構部，負責銀行 PaaS 系統基礎服務框架研發。王偉華， 10 餘年 Java 開發，Github ID：@vipweihua，對微服務架構研究多年，當前更多關注於微服務中的網關、限流熔斷、灰度路由等，現就任於平安銀行平臺架構部，從事銀行 PaaS 系統基礎服務框架研發。

原文連接

本文爲雲棲社區原創內容，未經容許不得轉載。