SpringCloudAlibaba - Sentinel API 使用示例

目录

  • 前言
    • 概览
    • 环境
  • 应用示例
    • 通过SphU.entry()定义资源
    • 通过Tracer.trace()统计BlockException以外的异常
    • 通过ContextUtil.enter()设置针对来源
  • 项目源码

前言

记录下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接口

SpringCloudAlibaba - Sentinel API 使用示例_第1张图片


  • Sentinel控制台

SpringCloudAlibaba - Sentinel API 使用示例_第2张图片


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

SpringCloudAlibaba - Sentinel API 使用示例_第3张图片

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

SpringCloudAlibaba - Sentinel API 使用示例_第4张图片



通过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接口访问

SpringCloudAlibaba - Sentinel API 使用示例_第5张图片


  • Sentinel控制台

SpringCloudAlibaba - Sentinel API 使用示例_第6张图片

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

SpringCloudAlibaba - Sentinel API 使用示例_第7张图片

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

SpringCloudAlibaba - Sentinel API 使用示例_第8张图片



通过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的流控规则

SpringCloudAlibaba - Sentinel API 使用示例_第9张图片

  • 频繁访问接口触发限流

SpringCloudAlibaba - Sentinel API 使用示例_第10张图片


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

SpringCloudAlibaba - Sentinel API 使用示例_第11张图片

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

SpringCloudAlibaba - Sentinel API 使用示例_第12张图片



项目源码

  • GitHub: https://github.com/Maggieq8324/coisini-cloud-alibaba
  • Gitee: https://gitee.com/maggieq8324/coisini-cloud-alibaba

- End -
- 个人学习笔记 -
- 仅供参考 -

你可能感兴趣的:(SpringCloud,spring,cloud,alibaba,sentinel,api)