ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

SpringCloudAlibaba - Sentinel API 使用示例

2021-09-26 15:01:38  阅读:158  来源: 互联网

标签:name BlockException 示例 sentinel API import Sentinel entry 限流


目录

前言

记录下Sentinel API的使用

官方文档:https://github.com/alibaba/Sentinel/wiki/如何使用


概览

  • Sentinel的三个核心API
SphU 定义资源,让资源受到监控且可以保护资源
Tracer 可以对想要的异常进行统计
ContextUtil 可以实现调用来源,还可以标记调用

环境

Spring Cloud Hoxton.SR9 + Spring Cloud Alibaba 2.2.6.RELEASE + Sentinel 1.8.1


应用示例

通过SphU.entry()定义资源

  • SphU.entry定义一个资源后,Sentinel会对该资源进行监控,计算它的QPS,线程数,RT,错误率等,如果超如阈值就抛出BlockException
  • TestSentinelController.java
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/sentinel")
@Slf4j
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class TestSentinelController {

    /**
     * 用SphU.entry定义一个资源后
     * Sentinel会对该资源进行监控,计算它的QPS,线程数,RT,错误率等
     * 如果超如阈值就抛出BlockException
     * @param name
     * @return
     */
    @GetMapping("/sentinel_api_test")
    public String testSentinelAPI(@RequestParam(required = false) String name) {
        String resourceName = "sentinel_api_test";

        // 定义一个sentinel保护的资源,名称是sentinel_api_test
        Entry entry = null;
        try {
            entry = SphU.entry(resourceName);
            return name;
        }
        // 如果被保护的资源被限流或者降级了,就会抛BlockException
        catch (BlockException e) {
            log.warn("限流,或者降级了", e);
            return "限流,或者降级了";
        } finally {
            if (Objects.nonNull(entry)) {
                // 退出entry
                entry.exit();
            }
        }
    }
}
  • 访问/sentinel/sentinel_api_test接口

在这里插入图片描述


  • Sentinel控制台

在这里插入图片描述


  • 添加一条QPS阈值为1的流控规则

在这里插入图片描述

  • 频繁访问接口触发流控规则

在这里插入图片描述



通过Tracer.trace()统计BlockException以外的异常

  • 默认情况下,Sentinel只会统计BlockException及其子类,而我们抛出的其它异常不会参与统计触发降级,想要BlockException以外的异常触发降级需要通过Tracer.trace()参与统计
  • TestSentinelController.java
import com.alibaba.csp.sentinel.Tracer;

/**
 * racer.trace()统计BlockException以外的异常
 * @param name
 * @return
 */
@GetMapping("/sentinel_api_test1")
public String testSentinelAPI1(@RequestParam(required = false) String name) {
    String resourceName = "sentinel_api_test1";

    // 定义一个sentinel保护的资源,名称是sentinel_api_test1
    Entry entry = null;
    try {
        entry = SphU.entry(resourceName);
        // 被保护的业务逻辑
        if (StringUtils.isBlank(name)) {
            throw new IllegalArgumentException("name不能为空");
        }
        return name;
    }
    // 如果被保护的资源被限流或者降级了,就会抛BlockException
    catch (BlockException e) {
        log.warn("限流,或者降级了", e);
        return "限流,或者降级了";
    } catch (IllegalArgumentException e2) {
        // 统计IllegalArgumentException 发生的次数、发生占比...
        Tracer.trace(e2);
        return "非法参数";
    } finally {
        if (Objects.nonNull(entry)) {
            // 退出entry
            entry.exit();
        }
    }
}
  • /sentinel/sentinel_api_test1接口访问

在这里插入图片描述


  • Sentinel控制台

在这里插入图片描述

  • 新增一条异常比例为0.1的降级规则

在这里插入图片描述

  • 频繁访问接口触发降级规则

在这里插入图片描述



通过ContextUtil.enter()设置针对来源

  • TestSentinelController.java
import com.alibaba.csp.sentinel.context.ContextUtil;

/**
 * ContextUtil.enter()设置针对来源
 * @param name
 * @return
 */
@GetMapping("/sentinel_api_test2")
public String testSentinelAPI2(@RequestParam(required = false) String name) {
    String resourceName = "sentinel_api_test2";

    // ContextUtil.enter()设置来源名为test-server的微服务
    ContextUtil.enter(resourceName, "test-server");

    // 定义一个sentinel保护的资源,名称是test-sentinel-api2
    Entry entry = null;
    try {
        entry = SphU.entry(resourceName);
        // 被保护的业务逻辑
        if (StringUtils.isBlank(name)) {
            throw new IllegalArgumentException("name不能为空");
        }
        return name;
    }
    // 如果被保护的资源被限流或者降级了,就会抛BlockException
    catch (BlockException e) {
        log.warn("限流,或者降级了", e);
        return "限流,或者降级了";
    } catch (IllegalArgumentException e2) {
        // 统计IllegalArgumentException 发生的次数、发生占比...
        Tracer.trace(e2);
        return "参数非法!";
    } finally {
        if (Objects.nonNull(entry)) {
            // 退出entry
            entry.exit();
        }
        ContextUtil.exit();
    }
}
  • 配置一条针对来源为test-server的流控规则

在这里插入图片描述

  • 频繁访问接口触发限流

在这里插入图片描述


  • 修改流控规则的针对来源为other-server

在这里插入图片描述

  • 频繁访问接口发现不会触发限流

在这里插入图片描述



- End -
白嫖有风险
点赞加收藏

标签:name,BlockException,示例,sentinel,API,import,Sentinel,entry,限流
来源: https://www.cnblogs.com/maggieq8324/p/15338120.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有