Sentinel 是阿里开源的一款高性能的限流框架。这里将对 Sentinel 的使用和实现进行介绍。
这里先介绍下 Sentinel 中涉及到的基本概念,包括使用上或者实现上。主要是笔者在阅读文档和源码时经常会接触到的对象。
Resource
资源是整个 Sentinel 最基本的一个概念。可以是一段代码,一个 http 请求,一个微服务,总而言之,他是 Sentinel 需要保证的实体。大部分情况下,我们可以使用方法签名,URL 或者是服务名称来作为资源的名称。它在 Sentinel 中的体现是:ResourceWrapper,他有两个子类:
- StringResourceWrapper 使用 string 来标识一个资源
- MethodResouceWrapper 使用一个函数签名来标识一个资源
Node
节点是用来存储统计数据的基本数据单元,Node 本身只是一个接口,它有多个实现:
- StatisticNode 唯一的直接实现类,实现了流量统计的基本方法,在 StatisticSlot 中使用
- ClusterNode 继承自 StatisticNode,对于某一个资源的全局统计
- DefaultNode 继承自 StatisticNode,对于某一个资源在相应上下文中的实现,保存了一个指向 ClusterNode 的引用。另外还保存了子节点列表,当在同一个 context 下多次调用 SphU.entry 不同资源时会创建子节点
- EntranceNode 继承自 DefaultNode,代表一个调用的根节点,一个 Context 会对应到一个 EntranceNode
Context
上下文是用来保存当前调用的元数据,存储在 ThreadLocal 中,它包含了几个信息:
- EntranceNode 整个调用树的根节点,即入口
- Entry 当前的调用点
- Node 关联到当前调用点的统计信息
- Origin 通常用来标识调用方,这在我们需要按照调用方来区分流控策略的时候会非常有用
每当我们调用 SphU.entry() 或者 SphO.entry() 获取访问资源许可的时候都需要当前线程处在某个 context 中,如果我们没有显式调用 ContextUtil.enter(),默认会使用 Default context。如果我们在一个上下文中多次调用 SphU.entry() 来获取多个资源,一个调用树就会被创建出来
NullContext
超过系统能够创建的最大会话数则返回 NullContext,后续不对该会话做过滤校验,直接放过。
Entry
每次 SphU.entry() 调用都会返回一个 Entry,Entry 保持了所有关于当前资源调用的信息:
- createTime 这个资源调用的创建时间
- currentNode SphU.entry 请求进入的资源在当前上下文中的统计数据 Node
- originNode SphU.entry 请求进入的资源对于特定 origin 调用方的统计数据 node
Entry 的实现类为 CtEntry,它其中除了上述信息之外,还保存了额外的信息:
- parent 调用树链条中上一个 entry
- child 调用树链条中的下一个 entry
- chain 当前调用资源所使用的限流工作责任链,包括各个 Slot
- context 当前调用点所属的上下文
EntryType
EntryType 说的是这次请求的流量类型,共有两种类型:IN 和 OUT。
IN:是指进入我们系统的入口流量,比如 http 请求或者是其他的 rpc 之类的请求。
OUT:是指我们系统调用其他第三方服务的出口流量。
入口、出口流量只有在配置了系统规则时才有效。
设置 Type 为 IN 是为了统计整个系统的流量水平,防止系统被打垮,用以自我保护的一种方式。
设置 Type 为 OUT 一方面是为了保护第三方系统,比如我们系统依赖了一个生成订单号的接口,而这个接口是核心服务,如果我们的服务是非核心应用的话需要对他进行限流保护;另一方面也可以保护自己的系统,假设我们的服务是核心应用,而依赖的第三方应用老是超时,那这时可以通过设置依赖的服务的 rt 来进行降级,这样就不至于让第三方服务把我们的系统拖垮。
Slot
Entry 创建的时候,同时也会创建一系列功能插槽(slot chain),这些插槽有不同的职责,例如:
- NodeSelectorSlot 负责收集资源的路径,并将这些资源的调用路径,以树状结构存储起来,用于根据调用路径来限流降级;
- ClusterBuilderSlot 则用于存储资源的统计信息以及调用者信息,例如该资源的 RT, QPS,thread count 等等,这些信息将用作为多维度限流,降级的依据;
- LogSlot 用于打印日志
- StatisticSlot 则用于记录、统计不同纬度的 runtime 指标监控信息;
- SystemSlot 则通过系统的状态,例如 load1 等,来控制总的入口流量;
- AuthoritySlot 则根据配置的黑白名单和调用来源信息,来做黑白名单控制;
- FlowSlot 则用于根据预设的限流规则以及前面 slot 统计的状态,来进行流量控制;
- DegradeSlot 则通过统计信息以及预设的规则,来做熔断降级;
Slot 只绑定在 CtEntry 上
ProcessorSlotChain
功能槽处理链,entry 进入一个槽可以添加自己的动作,之后后 fire 动作会 entry 下一个槽,exit 同理
注意,实现上相同资源共享一个 ProcessorSlotChain,可以跨 Context
LimitApp
流控规则中的 limitApp 字段用于根据调用来源进行流量控制。该字段的值有以下三种选项,分别对应不同的场景:
- default:表示不区分调用者,来自任何调用者的请求都将进行限流统计。如果这个资源名的调用总和超过了这条规则定义的阈值,则触发限流。
- {some_origin_name}:表示针对特定的调用者,只有来自这个调用者的请求才会进行流量控制。例如 NodeA 配置了一条针对调用者 caller1 的规则,那么当且仅当来自 caller1 对 NodeA 的请求才会触发流量控制。
- other:表示针对除 {some_origin_name} 以外的其余调用方的流量进行流量控制。例如,资源 NodeA 配置了一条针对调用者 caller1 的限流规则,同时又配置了一条调用者为 other 的规则,那么任意来自非 caller1 对 NodeA 的调用,都不能超过 other 这条规则定义的阈值。
同一个资源名可以配置多条规则,规则的生效顺序为:{some_origin_name} > other > default
介绍完了上面的基本概念,下面给出 Sentinel 的基本用法:
List<FlowRule> rules = new ArrayList<FlowRule>();
FlowRule rule1 = new FlowRule();
rule1.setResource(KEY);
// set limit qps to 20
rule1.setCount(20);
rule1.setGrade(RuleConstant.FLOW_GRADE_QPS);
rule1.setLimitApp("default");
rules.add(rule1);
Entry entry = null;
try {entry = SphU.entry(KEY);
// token acquired, means pass,do biz logic
} catch (BlockException e1) {//block,handle block logic} catch (Exception e2) {// biz exception,handle biz exception logic} finally {if (entry != null) {entry.exit();
}
}
如上,为 sentinel 的基本用法:
先设定好规则,在进入需要受保护的资源前,尝试获取 token,若成功获取 token,则可以执行相关逻辑,否则抛出异常进行处理,最后释放所获得的 token。
个人公众号:啊驼