简介
Sentinel可以简单的分为Sentinel核心库和Dashboard.核心库不依赖Dashboard.
使用Sentinel进行资源保护,主要分为几个步骤:
1.定义资源
2.定义规则
3.校验规则是否生效
定义资源
1.主流框架默认适配
对Web Servlet ,Dubbo, Spring Cloud,gRPC,Spring WebFlux,Reactor等都做了适配.
https://github.com/alibaba/Sentinel/wiki/%E4%B8%BB%E6%B5%81%E6%A1%86%E6%9E%B6%E7%9A%84%E9%80%82%E9%85%8D
2.抛出异常的方式定义资源
SphU包含了try-catch风格的API.用这种方式,当资源发生了限流之后会抛出BlockException.这个时候可以扑捉异常,进行限流之后的逻辑处理
// 1.5.0 版本开始可以利用 try-with-resources 特性
// 资源名可使用任意有业务语义的字符串，比如方法名、接口名或其它可唯一标识的字符串。
try (Entry entry = SphU.entry("resourceName")) {
// 被保护的业务逻辑
// do something here...
} catch (BlockException ex) {
// 资源访问阻止，被限流或被降级
// 在此处进行相应的处理操作
}
3.返回布尔值方式定义资源
Sph0 提供if-else风格的API.用这种方式,当资源发生了限流之后会返回false,这个时候可以根据返回值,进行限流之后的逻辑.
// 资源名可使用任意有业务语义的字符串
if (SphO.entry("自定义资源名")) {
// 务必保证finally会被执行
try {
/**
* 被保护的业务逻辑
*/
} finally {
SphO.exit();
}
} else {
// 资源访问阻止，被限流或被降级
// 进行相应的处理操作
}
4.注解方式定义资源
Sentinel支持通过@SentinelResource注解定义资源并配置blockHandler 和fallback函数来进行限流之后的处理.
文档 https://github.com/alibaba/Sentinel/wiki/%E6%B3%A8%E8%A7%A3%E6%94%AF%E6%8C%81
// 原本的业务方法.
@SentinelResource(blockHandler = "blockHandlerForGetUser")
public User getUserById(String id) {
throw new RuntimeException("getUserById command failed");
}
// blockHandler 函数，原方法调用被限流/降级/系统保护的时候调用
public User blockHandlerForGetUser(String id, BlockException ex) {
return new User("admin");
}
5.异步调用支持
Sentinel 支持异步调用链路统计.在异步调用中,需要通过SphU.asyncEntry(xxx)方法定义资源,并通过需要在异步的回调函数中调用exit方法.
https://github.com/alibaba/Sentinel/blob/master/sentinel-demo/sentinel-demo-basic/src/main/java/com/alibaba/csp/sentinel/demo/AsyncEntryDemo.java
try {
AsyncEntry entry = SphU.asyncEntry(resourceName);
// 异步调用.
doAsync(userId, result -> {
try {
// 在此处处理异步调用的结果.
} finally {
// 在回调结束后 exit.
entry.exit();
}
});
} catch (BlockException ex) {
// Request blocked.
// Handle the exception (e.g. retry or fallback).
}
若在异步回调中需要嵌套其他的资源(无论是entry还是asyncEntry),只需要借助Sentinel提供的上下文切换功能,在对应的地方通过ContextUtil.runOnContext(context,f)进行Context变换,将对应资源调用处的Context切换为生成的异步Context,即可维持正确的调用链路关系
public void handleResult(String result) {
Entry entry = null;
try {
entry = SphU.entry("handleResultForAsync");
// Handle your result here.
} catch (BlockException ex) {
// Blocked for the result handler.
} finally {
if (entry != null) {
entry.exit();
}
}
}
public void someAsync() {
try {
AsyncEntry entry = SphU.asyncEntry(resourceName);
// Asynchronous invocation.
doAsync(userId, result -> {
// 在异步回调中进行上下文变换，通过 AsyncEntry 的 getAsyncContext 方法获取异步 Context
ContextUtil.runOnContext(entry.getAsyncContext(), () -> {
try {
// 此处嵌套正常的资源调用.
handleResult(result);
} finally {
entry.exit();
}
});
});
} catch (BlockException ex) {
// Request blocked.
// Handle the exception (e.g. retry or fallback).
}
}
规则的种类
Sentinel的所有规则都可以在内存中动态的查询及修改,修改后立即生效.
Sentinel支持以下几种规则:流量控制规则,熔断降级规则,系统保护规则,来源访问控制规则和热点参数规则.
流量控制规则(FlowRule)
流量规则定义
重要属性
通过代码定义流量控制规则
理解上面规则的定义之后,我们可以通过调用FlowRuleManager.loadRules()方法来用硬编码的方式定义流量控制规则.
https://github.com/alibaba/Sentinel/wiki/%E6%B5%81%E9%87%8F%E6%8E%A7%E5%88%B6
private void initFlowQpsRule() {
List rules = new ArrayList<>();
FlowRule rule = new FlowRule(resourceName);
// set limit qps to 20
rule.setCount(20);
rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
rule.setLimitApp("default");
rules.add(rule);
FlowRuleManager.loadRules(rules);
}
熔断降级规则(DegradeRule)
https://github.com/alibaba/Sentinel/wiki/%E7%86%94%E6%96%AD%E9%99%8D%E7%BA%A7
熔断降级规则包含下面几个重要的属性
通过调用DegradeRuleManager.loadRules()方法来用硬编码的方式定义流量控制规则
private void initDegradeRule() {
List rules = new ArrayList<>();
DegradeRule rule = new DegradeRule();
rule.setResource(KEY);
// set threshold RT, 10 ms
rule.setCount(10);
rule.setGrade(RuleConstant.DEGRADE_GRADE_RT);
rule.setTimeWindow(10);
rules.add(rule);
DegradeRuleManager.loadRules(rules);
}
系统保护规则(SystemRule)
https://github.com/alibaba/Sentinel/wiki/%E7%B3%BB%E7%BB%9F%E8%87%AA%E9%80%82%E5%BA%94%E9%99%90%E6%B5%81
可以通过调用
SystemRuleManager.loadRules()方法来用硬编码的方式定义流量控制规则
private void initSystemRule() {
List rules = new ArrayList<>();
SystemRule rule = new SystemRule();
rule.setHighestSystemLoad(10);
rules.add(rule);
SystemRuleManager.loadRules(rules);
}
访问控制规则(AuthorityRule)
https://github.com/alibaba/Sentinel/wiki/%E9%BB%91%E7%99%BD%E5%90%8D%E5%8D%95%E6%8E%A7%E5%88%B6
很多时候,我们需要根据调用方来限制资源是否通过,这时候可以使用Sentinel的访问控制(黑白名单)的功能.黑白名单根据资源的请求来源(origin)限制资源是否通过,若配置白名单则只有请求来源位于白名单内时才可以通过.若配置黑名单则请求来源位于黑名单时不通过,其余请求通过.
授权规则,即黑白名单规则(AuthorityRule)非常简单,主要有以下配置:
resource:资源名,即限流规则的作用对象
limitApp:对应的黑名单/白名单,不同origin用 逗号(,) 分隔
strategy:限制模式,AUTHORITY_WHITE 为白名单模式，AUTHORITY_BLACK 为黑名单模式，默认为白名单模式
热点规则(ParamFlowRule)
https://github.com/alibaba/Sentinel/wiki/%E7%83%AD%E7%82%B9%E5%8F%82%E6%95%B0%E9%99%90%E6%B5%81
查询更改规则
运行下面命令,则会返回现有生效的规则:
curl http://localhost:8719/getRules?type=
其中,type=flow 以JSON格式返回现有的限流规则;degrade则返回现有生效的规则列表;system则返回系统保护规则.
运行下面命令可修改已有规则:
curl http://localhost:8719/setRules?type=
其中,type可以输入flow,degrade等方式指定更改的规则种类,data则是对应的JSON格式的规则
定制自己的持久化规则
https://github.com/alibaba/Sentinel/wiki/%E5%8A%A8%E6%80%81%E8%A7%84%E5%88%99%E6%89%A9%E5%B1%95
上面的规则配置,都是存在内存中的.即如果应用重启,这个规则就会失效.
可以通过实现DataSource接口方式,来自定义规则的存储数据源.通常可以
1.整合动态配置系统,如Zookeeper,Nacos等,动态的实时刷新配置规则.
2.结合RDBMS,NoSQL,VCS等来实现该规则
3.配合Sentinel Dashboard使用
规则生效的效果
1.判断限流降级异常
BlockException.isBlockException(Throwable t);
2.暴露的HTTP接口:通过运行下面的命令
curl http://localhost:8719/cnode?id=<资源名称>
规则如果生效,返回数据中block以及block(m)会有显示
3.日志:Sentinel提供秒级的资源运行日志以及限流日志
https://github.com/alibaba/Sentinel/wiki/%E6%97%A5%E5%BF%97
其他API
1.业务异常统计Tracer
业务异常记录类Tracer用于记录业务异常,相关方法:
1)记录业务异常（非 BlockException 异常）
public static void trace(Throwable e)
2)记录业务异常,异常数目为传入的count
public static void trace(Throwable e, int count)
如果用户通过SphU或Sph0手动定义资源,则Sentinel不能感知上层业务的异常,需要手动调用Tracer.trace(ex)来记录业务异常,否则对应的异常不会统计到Sentinel异常计数中.注意不要在try-with-resources形式的SphU.entry(xxx)中使用,否则统计不上.
从1.3.1版本开始,注解方式定义资源支持自动统计业务异常,无须手动调用Tracer.trace(ex)来记录业务异常,1.3.1之前的版本需要手动记录
2.上线文工具类ContextUtil
相关静态方法:
1)标识进入调用链入口(上下文)
以下静态方法用于标识调用链路入口,用于区分不同的调用链路:
public static Context enter(String contextName)
public static Context enter(String contextName, String origin)
其中,contextName代表调用链路入口名称(上线文名称),origin代表调用来源名称.默认调用来源为null.返回值类型为Context,即生成的调用链路上下文对象.
注意:ContextUtil.enter(xxx)方法仅在调用链路入口生效,即仅在当前线程的初次调用生效,后面在调用不会覆盖当前线程的调用链路,直到exit.Context存在ThreadLocal中,因此切换线程时可能会丢掉,如果需要跨线程使用可以结合runOnContext方法使用.
留空规则中若选择"流控方式"为链路方式,则入口资源名即为上面的contextName.
2)退出调用链(清空上下文)
public static void exit()
3)获取当前线程的调用链上下文
public static Context getContext();
4)在某个调用链上下文中执行代码
public static void runOnContext(Context context, Runnable f)
常用于异步调用链路中 context 的变换。
5)指标统计配置
Sentinel底层采用高性能的滑动窗口数据结构来统计实时的秒级指标数据,并支持对滑动窗口进行配置.
a) windowIntervalMs : 滑动窗口的总的时间长度,默认为1000ms
b)sampleCount : 滑动窗口华为的格子数目,默认为2;格子数目越多则精度越高,但内存占的越多
我们可以通过sampleCountProperty来动态的变更滑动窗口的格子数目,通过IntervalProperty来动态的变更滑动窗口的总时间长度.两个配置都是全局生效的,会影响所有资源的所有指标统计.
6)Dashboard
https://github.com/alibaba/Sentinel/wiki/%E6%8E%A7%E5%88%B6%E5%8F%B0