devbox
菜鸟追梦旅行
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Sentinel持久化到nacos 举例流控和熔断规则_sentinel-datasource-nacos

作者：菜鸟追梦旅行 | 2024-04-30 09:11:28

赞

踩

sentinel-datasource-nacos

环境准备：
Nacos2.2.0集群搭建
版本说明：https://github.com/alibaba/spring-cloud-alibaba/wiki/版本说明

安装，配置nacos不多说

1.下载Sentinel源代码

地址：Sentinel1.8.6：https://github.com/alibaba/Sentinel/releases/tag/1.8.6

解压后使用IDEA打开sentinel-dashboard

 2.修改代码

1.修改pom.xml

104行注释掉： test

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

 2.复制一份test中的nacos到rule中

复制：

 放入：

 3.新建 NacosConfigProperties.java 文件

  1. package com.alibaba.csp.sentinel.dashboard.rule.nacos;
  2.  
  3. import org.springframework.boot.context.properties.ConfigurationProperties;
  4. import org.springframework.stereotype.Component;
  5.  
  6. @Component
  7. @ConfigurationProperties(prefix = "sentinel.nacos")
  8. public class NacosConfigProperties {
  9.     // nacos地址
  10.     private String serverAddr;
  11.     // nacos登录名
  12.     private String username;
  13.     // nacos 登录密码
  14.     private String password;
  15.     // nacos命名空间
  16.     private String namespace;
  17.  
  18.     public String getServerAddr() {
  19.         return serverAddr;
  20.     }
  21.  
  22.     public void setServerAddr(String serverAddr) {
  23.         this.serverAddr = serverAddr;
  24.     }
  25.  
  26.     public String getUsername() {
  27.         return username;
  28.     }
  29.  
  30.     public void setUsername(String username) {
  31.         this.username = username;
  32.     }
  33.  
  34.     public String getPassword() {
  35.         return password;
  36.     }
  37.  
  38.     public void setPassword(String password) {
  39.         this.password = password;
  40.     }
  41.  
  42.     public String getNamespace() {
  43.         return namespace;
  44.     }
  45.  
  46.     public void setNamespace(String namespace) {
  47.         this.namespace = namespace;
  48.     }
  49. }

4.修改NacosConfig.java文件

  1. /*
  2.  * Copyright 1999-2018 Alibaba Group Holding Ltd.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *      http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16. package com.alibaba.csp.sentinel.dashboard.rule.nacos;
  17.  
  18. import com.alibaba.csp.sentinel.dashboard.datasource.entity.rule.FlowRuleEntity;
  19. import com.alibaba.csp.sentinel.datasource.Converter;
  20. import com.alibaba.fastjson.JSON;
  21. import com.alibaba.nacos.api.PropertyKeyConst;
  22. import com.alibaba.nacos.api.config.ConfigFactory;
  23. import com.alibaba.nacos.api.config.ConfigService;
  24. import org.springframework.beans.factory.annotation.Autowired;
  25. import org.springframework.context.annotation.Bean;
  26. import org.springframework.context.annotation.Configuration;
  27.  
  28. import java.util.List;
  29. import java.util.Properties;
  30.  
  31. /**
  32.  * @author Eric Zhao
  33.  * @since 1.4.0
  34.  */
  35. @Configuration
  36. public class NacosConfig {
  37.     // 注入刚新建的nacos配置文件
  38.     @Autowired
  39.     private NacosConfigProperties nacosConfigProperties;
  40.  
  41.     @Bean
  42.     public Converter<List<FlowRuleEntity>, String> flowRuleEntityEncoder() {
  43.         return JSON::toJSONString;
  44.     }
  45.  
  46.     @Bean
  47.     public Converter<String, List<FlowRuleEntity>> flowRuleEntityDecoder() {
  48.         return s -> JSON.parseArray(s, FlowRuleEntity.class);
  49.     }
  50.  
  51.     @Bean
  52.     public ConfigService nacosConfigService() throws Exception {
  53.         // 注释
  54.         // return ConfigFactory.createConfigService("localhost");
  55.         // 新增
  56.         Properties properties = new Properties();
  57.         properties.put(PropertyKeyConst.SERVER_ADDR,nacosConfigProperties.getServerAddr());
  58.         properties.put(PropertyKeyConst.USERNAME,nacosConfigProperties.getUsername());
  59.         properties.put(PropertyKeyConst.PASSWORD,nacosConfigProperties.getPassword());
  60.         properties.put(PropertyKeyConst.NAMESPACE,nacosConfigProperties.getNamespace());
  61.         return ConfigFactory.createConfigService(properties);
  62.     }
  63. }

5.修改FlowControllerV2，将注解换成我们定义的类

 6.修改前端代码：修改sidebar.html

修改resources/app/scripts/directives/sidebar/sidebar.html
直接搜dashboard.flowV1定位57行去掉V1

 7.修改js：修改identity.js

// 'FlowServiceV1' 替换为 'FlowServiceV2'

 8.直接搜/dashboard/flow/定位第101行

let url = '/dashboard/flow/' + $scope.app; 替换为：let url = '/dashboard/v2/flow/' + $scope.app;

 9.项目application.properties 新增配置

  1. # 服务端口、控制台地址、名称
  2. server.port=9100
  3. csp.sentinel.dashboard.server=127.0.0.1:9100
  4. project.name=sentinel-dashboard
  5. # Nacos地址、账号、密码
  6. sentinel.nacos.serverAddr=192.168.20.128:8999
  7. sentinel.nacos.username=nacos
  8. sentinel.nacos.password=nacos
  9. # 默认命名空间就是 public，不用填写，填了public反而找不到，所以这个置空就行。
  10. sentinel.nacos.namespace=

效果：

10.熔断改造，前面跟着走的可以直接复制代码

第一步：

在【com.alibaba.csp.sentinel.dashboard.rule.nacos.degrade】包下增加【DegradeRuleNacosProvider】类

  1. /*
  2.  * Copyright 1999-2018 Alibaba Group Holding Ltd.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *      http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16. package com.alibaba.csp.sentinel.dashboard.rule.nacos;
  17.  
  18. import com.alibaba.csp.sentinel.dashboard.datasource.entity.rule.FlowRuleEntity;
  19. import com.alibaba.csp.sentinel.dashboard.rule.DynamicRuleProvider;
  20. import com.alibaba.csp.sentinel.datasource.Converter;
  21. import com.alibaba.csp.sentinel.util.StringUtil;
  22. import com.alibaba.nacos.api.config.ConfigService;
  23. import org.springframework.beans.factory.annotation.Autowired;
  24. import org.springframework.stereotype.Component;
  25.  
  26. import java.util.ArrayList;
  27. import java.util.List;
  28.  
  29. /**
  30.  * @author Eric Zhao
  31.  * @since 1.4.0
  32.  */
  33. @Component("flowRuleNacosProvider")
  34. public class FlowRuleNacosProvider implements DynamicRuleProvider<List<FlowRuleEntity>> {
  35.  
  36.     @Autowired
  37.     private ConfigService configService;
  38.     @Autowired
  39.     private Converter<String, List<FlowRuleEntity>> converter;
  40.  
  41.     @Override
  42.     public List<FlowRuleEntity> getRules(String appName) throws Exception {
  43.         String rules = configService.getConfig(appName + NacosConfigUtil.FLOW_DATA_ID_POSTFIX,
  44.             NacosConfigUtil.GROUP_ID, 3000);
  45.         if (StringUtil.isEmpty(rules)) {
  46.             return new ArrayList<>();
  47.         }
  48.         return converter.convert(rules);
  49.     }
  50. }

第二步：在【com.alibaba.csp.sentinel.dashboard.rule.nacos.degrade】包下增加【DegradeRuleNacosPublisher】类

  1. /**
  2.  * @author Eric Zhao
  3.  * @since 1.4.0
  4.  */
  5. @Component("flowRuleNacosPublisher")
  6. public class FlowRuleNacosPublisher implements DynamicRulePublisher<List<FlowRuleEntity>> {
  7.  
  8.     @Autowired
  9.     private ConfigService configService;
  10.     @Autowired
  11.     private Converter<List<FlowRuleEntity>, String> converter;
  12.  
  13.     @Override
  14.     public void publish(String app, List<FlowRuleEntity> rules) throws Exception {
  15.         AssertUtil.notEmpty(app, "app name cannot be empty");
  16.         if (rules == null) {
  17.             return;
  18.         }
  19.         configService.publishConfig(app + NacosConfigUtil.FLOW_DATA_ID_POSTFIX,
  20.             NacosConfigUtil.GROUP_ID, converter.convert(rules));
  21.     }
  22. }

第三步：改造

  1. /*
  2.  * Copyright 1999-2018 Alibaba Group Holding Ltd.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *      http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16. package com.alibaba.csp.sentinel.dashboard.controller;
  17.  
  18. import java.util.Date;
  19. import java.util.List;
  20.  
  21. import com.alibaba.csp.sentinel.dashboard.auth.AuthAction;
  22. import com.alibaba.csp.sentinel.dashboard.auth.AuthService;
  23. import com.alibaba.csp.sentinel.dashboard.client.SentinelApiClient;
  24. import com.alibaba.csp.sentinel.dashboard.controller.v2.DegradeControllerV1;
  25. import com.alibaba.csp.sentinel.dashboard.discovery.AppManagement;
  26. import com.alibaba.csp.sentinel.dashboard.discovery.MachineInfo;
  27. import com.alibaba.csp.sentinel.dashboard.auth.AuthService.PrivilegeType;
  28. import com.alibaba.csp.sentinel.dashboard.repository.rule.RuleRepository;
  29. import com.alibaba.csp.sentinel.dashboard.rule.DynamicRuleProvider;
  30. import com.alibaba.csp.sentinel.dashboard.rule.DynamicRulePublisher;
  31. import com.alibaba.csp.sentinel.slots.block.RuleConstant;
  32. import com.alibaba.csp.sentinel.slots.block.degrade.circuitbreaker.CircuitBreakerStrategy;
  33. import com.alibaba.csp.sentinel.util.StringUtil;
  34.  
  35. import com.alibaba.csp.sentinel.dashboard.datasource.entity.rule.DegradeRuleEntity;
  36. import com.alibaba.csp.sentinel.dashboard.domain.Result;
  37.  
  38. import org.slf4j.Logger;
  39. import org.slf4j.LoggerFactory;
  40. import org.springframework.beans.factory.annotation.Autowired;
  41. import org.springframework.beans.factory.annotation.Qualifier;
  42. import org.springframework.web.bind.annotation.DeleteMapping;
  43. import org.springframework.web.bind.annotation.GetMapping;
  44. import org.springframework.web.bind.annotation.PathVariable;
  45. import org.springframework.web.bind.annotation.PostMapping;
  46. import org.springframework.web.bind.annotation.PutMapping;
  47. import org.springframework.web.bind.annotation.RequestBody;
  48. import org.springframework.web.bind.annotation.RequestMapping;
  49. import org.springframework.web.bind.annotation.RestController;
  50.  
  51. import javax.servlet.http.HttpServletRequest;
  52.  
  53. /**
  54.  * Controller regarding APIs of degrade rules. Refactored since 1.8.0.
  55.  *
  56.  * @author Carpenter Lee
  57.  * @author Eric Zhao
  58.  */
  59. @RestController
  60. @RequestMapping("/degrade")
  61. public class DegradeController {
  62.  
  63.     private final Logger logger = LoggerFactory.getLogger(DegradeController.class);
  64.  
  65.     @Autowired
  66.     private RuleRepository<DegradeRuleEntity, Long> repository;
  67.  
  68.     @Autowired
  69.     private AuthService<HttpServletRequest> authService;
  70.  
  71.     @Autowired
  72.     @Qualifier("degradeRuleNacosProvider")
  73.     private DynamicRuleProvider<List<DegradeRuleEntity>> ruleProvider;
  74.  
  75.     @Autowired
  76.     @Qualifier("degradeRuleNacosPublisher")
  77.     private DynamicRulePublisher<List<DegradeRuleEntity>> rulePublisher;
  78.  
  79.     @Autowired
  80.     private SentinelApiClient sentinelApiClient;
  81.  
  82.     @GetMapping("/rules.json")
  83.     @AuthAction(PrivilegeType.READ_RULE)
  84.     public Result<List<DegradeRuleEntity>> apiQueryMachineRules(HttpServletRequest request, String app, String ip, Integer port) {
  85.         AuthService.AuthUser authUser = authService.getAuthUser(request);
  86.         authUser.authTarget(app, PrivilegeType.READ_RULE);
  87.  
  88.         if (StringUtil.isEmpty(app)) {
  89.             return Result.ofFail(-1, "app can't be null or empty");
  90.         }
  91.         if (StringUtil.isEmpty(ip)) {
  92.             return Result.ofFail(-1, "ip can't be null or empty");
  93.         }
  94.         if (port == null) {
  95.             return Result.ofFail(-1, "port can't be null");
  96.         }
  97.         try {
  98.             List<DegradeRuleEntity> rules = ruleProvider.getRules(app);
  99.             rules = repository.saveAll(rules);
  100.             return Result.ofSuccess(rules);
  101.         } catch (Throwable throwable) {
  102.             logger.error("queryApps error:", throwable);
  103.             return Result.ofThrowable(-1, throwable);
  104.         }
  105.     }
  106.  
  107.     @PostMapping("/rule")
  108.     @AuthAction(PrivilegeType.WRITE_RULE)
  109.     public Result<DegradeRuleEntity> apiAddRule(@RequestBody DegradeRuleEntity entity) {
  110.         Result<DegradeRuleEntity> checkResult = checkEntityInternal(entity);
  111.         if (checkResult != null) {
  112.             return checkResult;
  113.         }
  114.         Date date = new Date();
  115.         entity.setGmtCreate(date);
  116.         entity.setGmtModified(date);
  117.         try {
  118.             entity = repository.save(entity);
  119.             publishRules(entity.getApp());
  120.         } catch (Throwable t) {
  121.             logger.error("Failed to add new degrade rule, app={}, ip={}", entity.getApp(), entity.getIp(), t);
  122.             return Result.ofThrowable(-1, t);
  123.         }
  124.         return Result.ofSuccess(entity);
  125.     }
  126.  
  127.     @PutMapping("/rule/{id}")
  128.     @AuthAction(PrivilegeType.WRITE_RULE)
  129.     public Result<DegradeRuleEntity> apiUpdateRule(@PathVariable("id") Long id,
  130.                                                    @RequestBody DegradeRuleEntity entity) {
  131.         if (id == null || id <= 0) {
  132.             return Result.ofFail(-1, "id can't be null or negative");
  133.         }
  134.         DegradeRuleEntity oldEntity = repository.findById(id);
  135.         if (oldEntity == null) {
  136.             return Result.ofFail(-1, "Degrade rule does not exist, id=" + id);
  137.         }
  138.         entity.setApp(oldEntity.getApp());
  139.         entity.setIp(oldEntity.getIp());
  140.         entity.setPort(oldEntity.getPort());
  141.         entity.setId(oldEntity.getId());
  142.         Result<DegradeRuleEntity> checkResult = checkEntityInternal(entity);
  143.         if (checkResult != null) {
  144.             return checkResult;
  145.         }
  146.         entity.setGmtCreate(oldEntity.getGmtCreate());
  147.         entity.setGmtModified(new Date());
  148.         try {
  149.             entity = repository.save(entity);
  150.             publishRules(entity.getApp());
  151.         } catch (Throwable t) {
  152.             logger.error("Failed to save degrade rule, id={}, rule={}", id, entity, t);
  153.             return Result.ofThrowable(-1, t);
  154.         }
  155.         return Result.ofSuccess(entity);
  156.     }
  157.  
  158.     @DeleteMapping("/rule/{id}")
  159.     @AuthAction(PrivilegeType.DELETE_RULE)
  160.     public Result<Long> delete(@PathVariable("id") Long id) {
  161.         if (id == null) {
  162.             return Result.ofFail(-1, "id can't be null");
  163.         }
  164.  
  165.         DegradeRuleEntity oldEntity = repository.findById(id);
  166.         if (oldEntity == null) {
  167.             return Result.ofSuccess(null);
  168.         }
  169.  
  170.         try {
  171.             repository.delete(id);
  172.             publishRules(oldEntity.getApp());
  173.         } catch (Throwable throwable) {
  174.             logger.error("Failed to delete degrade rule, id={}", id, throwable);
  175.             return Result.ofThrowable(-1, throwable);
  176.         }
  177.         return Result.ofSuccess(id);
  178.     }
  179.  
  180.     private void publishRules(String app) throws Exception {
  181.         List<DegradeRuleEntity> rules = repository.findAllByApp(app);
  182.         rulePublisher.publish(app, rules);
  183.     }
  184.  
  185.  
  186.     private <R> Result<R> checkEntityInternal(DegradeRuleEntity entity) {
  187.         if (StringUtil.isBlank(entity.getApp())) {
  188.             return Result.ofFail(-1, "app can't be blank");
  189.         }
  190.         if (StringUtil.isBlank(entity.getIp())) {
  191.             return Result.ofFail(-1, "ip can't be null or empty");
  192.         }
  193.         if (entity.getPort() == null || entity.getPort() <= 0) {
  194.             return Result.ofFail(-1, "invalid port: " + entity.getPort());
  195.         }
  196.         if (StringUtil.isBlank(entity.getLimitApp())) {
  197.             return Result.ofFail(-1, "limitApp can't be null or empty");
  198.         }
  199.         if (StringUtil.isBlank(entity.getResource())) {
  200.             return Result.ofFail(-1, "resource can't be null or empty");
  201.         }
  202.         Double threshold = entity.getCount();
  203.         if (threshold == null || threshold < 0) {
  204.             return Result.ofFail(-1, "invalid threshold: " + threshold);
  205.         }
  206.         Integer recoveryTimeoutSec = entity.getTimeWindow();
  207.         if (recoveryTimeoutSec == null || recoveryTimeoutSec <= 0) {
  208.             return Result.ofFail(-1, "recoveryTimeout should be positive");
  209.         }
  210.         Integer strategy = entity.getGrade();
  211.         if (strategy == null) {
  212.             return Result.ofFail(-1, "circuit breaker strategy cannot be null");
  213.         }
  214.         if (strategy < CircuitBreakerStrategy.SLOW_REQUEST_RATIO.getType()
  215.                 || strategy > RuleConstant.DEGRADE_GRADE_EXCEPTION_COUNT) {
  216.             return Result.ofFail(-1, "Invalid circuit breaker strategy: " + strategy);
  217.         }
  218.         if (entity.getMinRequestAmount() == null || entity.getMinRequestAmount() <= 0) {
  219.             return Result.ofFail(-1, "Invalid minRequestAmount");
  220.         }
  221.         if (entity.getStatIntervalMs() == null || entity.getStatIntervalMs() <= 0) {
  222.             return Result.ofFail(-1, "Invalid statInterval");
  223.         }
  224.         if (strategy == RuleConstant.DEGRADE_GRADE_RT) {
  225.             Double slowRatio = entity.getSlowRatioThreshold();
  226.             if (slowRatio == null) {
  227.                 return Result.ofFail(-1, "SlowRatioThreshold is required for slow request ratio strategy");
  228.             } else if (slowRatio < 0 || slowRatio > 1) {
  229.                 return Result.ofFail(-1, "SlowRatioThreshold should be in range: [0.0, 1.0]");
  230.             }
  231.         } else if (strategy == RuleConstant.DEGRADE_GRADE_EXCEPTION_RATIO) {
  232.             if (threshold > 1) {
  233.                 return Result.ofFail(-1, "Ratio threshold should be in range: [0.0, 1.0]");
  234.             }
  235.         }
  236.         return null;
  237.     }
  238. }

第四步：添加应用服务配置，注意不是sentinel服务的配置。

  1. --- #################### Sentinel配置 ####################
  2. spring:
  3.   cloud:
  4.     # Sentinel 配置项，对应 SentinelProperties 配置属性类
  5.     sentinel:
  6.       enabled: true # 是否开启。默认为 true 开启
  7.       eager: true # 是否饥饿加载。默认为 false 关闭
  8.       transport:
  9.         dashboard: 10.205.30.1:7070 # Sentinel 控制台地址
  10.       filter:
  11.         url-patterns: /** # 拦截请求的地址。默认为 /*
  12.       datasource:
  13.         flow:
  14.           nacos:
  15.             server-addr: 10.30.225.112:8848
  16.             username: nacos
  17.             password: nacos
  18.             namespace: test
  19.             dataId: operation-server-flow-rules
  20.             groupId: DEFAULT_GROUP
  21.             rule-type: flow
  22.             data-type: json
  23.         degrade:
  24.           nacos:
  25.             server-addr: 10.30.225.112:8848
  26.             username: nacos
  27.             password: nacos
  28.             namespace: test
  29.             dataId: operation-server-degrade-rules
  30.             groupId: DEFAULT_GROUP
  31.             rule-type: degrade
  32.             data-type: json

效果：

 

 

11.热点，系统，授权同熔断规则 

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/菜鸟追梦旅行/article/detail/512595
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号