序
本文主要研究一下sentinel的FlowSlot
FlowSlot
com/alibaba/csp/sentinel/slots/block/flow/FlowSlot.java
public class FlowSlot extends AbstractLinkedProcessorSlot { @Override public void entry(Context context, ResourceWrapper resourceWrapper, DefaultNode node, int count, Object... args) throws Throwable { FlowRuleManager.checkFlow(resourceWrapper, context, node, count); fireEntry(context, resourceWrapper, node, count, args); } @Override public void exit(Context context, ResourceWrapper resourceWrapper, int count, Object... args) { fireExit(context, resourceWrapper, count, args); }}
FlowRuleManager.checkFlow
com/alibaba/csp/sentinel/slots/block/flow/FlowRuleManager.java
public static void checkFlow(ResourceWrapper resource, Context context, DefaultNode node, int count) throws BlockException { List rules = flowRules.get(resource.getName()); if (rules != null) { for (FlowRule rule : rules) { if (!rule.passCheck(context, node, count)) { throw new FlowException(rule.getLimitApp()); } } } }
FlowRule
com/alibaba/csp/sentinel/slots/block/flow/FlowRule.java
/*** * * Each flow rule is mainly composed of three factors: grade, * strategy and controlBehavior. *
*
* - The {@link #grade} represents the threshold type of flow control (by QPS or thread count).
* - The {@link #strategy} represents the strategy based on invocation relation.
* - The {@link #controlBehavior} represents the QPS shaping behavior (actions on incoming request when QPS * exceeds the threshold).
*
* * @author jialiang.linjl * @author Eric Zhao */public class FlowRule extends AbstractRule { public static final String LIMIT_APP_DEFAULT = "default"; public static final String LIMIT_APP_OTHER = "other"; public FlowRule(){ super(); setLimitApp(LIMIT_APP_DEFAULT); } /** * The threshold type of flow control (0: thread count, 1: QPS). */ private int grade = RuleConstant.FLOW_GRADE_QPS; /** * Flow control threshold count. */ private double count; /** * Flow control strategy based on invocation chain. * * {@link RuleConstant#STRATEGY_DIRECT} for direct flow control (by origin); * {@link RuleConstant#STRATEGY_RELATE} for relevant flow control (with relevant resource); * {@link RuleConstant#STRATEGY_CHAIN} for chain flow control (by entrance resource). */ private int strategy = RuleConstant.STRATEGY_DIRECT; /** * Reference resource in flow control with relevant resource. */ private String refResource; /** * Rate limiter control behavior. * 0. default, 1. warm up, 2. rate limiter */ private int controlBehavior = RuleConstant.CONTROL_BEHAVIOR_DEFAULT; private int warmUpPeriodSec = 10; /** * Max queueing time in rate limiter behavior. */ private int maxQueueingTimeMs = 500; private Controller controller; //...... @Override public boolean passCheck(Context context, DefaultNode node, int acquireCount, Object... args) { String limitApp = this.getLimitApp(); if (limitApp == null) { return true; } String origin = context.getOrigin(); Node selectedNode = selectNodeByRequesterAndStrategy(origin, context, node); if (selectedNode == null) { return true; } return controller.canPass(selectedNode, acquireCount); } private Node selectNodeByRequesterAndStrategy(String origin, Context context, DefaultNode node) { // The limit app should not be empty. String limitApp = this.getLimitApp(); if (limitApp.equals(origin)) { if (strategy == RuleConstant.STRATEGY_DIRECT) { return context.getOriginNode(); } String refResource = this.getRefResource(); if (StringUtil.isEmpty(refResource)) { return null; } if (strategy == RuleConstant.STRATEGY_RELATE) { return ClusterBuilderSlot.getClusterNode(refResource); } if (strategy == RuleConstant.STRATEGY_CHAIN) { if (!refResource.equals(context.getName())) { return null; } return node; } } else if (LIMIT_APP_DEFAULT.equals(limitApp)) { if (strategy == RuleConstant.STRATEGY_DIRECT) { return node.getClusterNode(); } String refResource = this.getRefResource(); if (StringUtil.isEmpty(refResource)) { return null; } if (strategy == RuleConstant.STRATEGY_RELATE) { return ClusterBuilderSlot.getClusterNode(refResource); } if (strategy == RuleConstant.STRATEGY_CHAIN) { if (!refResource.equals(context.getName())) { return null; } return node; } } else if (LIMIT_APP_OTHER.equals(limitApp) && FlowRuleManager.isOtherOrigin(origin, getResource())) { if (strategy == RuleConstant.STRATEGY_DIRECT) { return context.getOriginNode(); } String refResource = this.getRefResource(); if (StringUtil.isEmpty(refResource)) { return null; } if (strategy == RuleConstant.STRATEGY_RELATE) { return ClusterBuilderSlot.getClusterNode(refResource); } if (strategy == RuleConstant.STRATEGY_CHAIN) { if (!refResource.equals(context.getName())) { return null; } if (node != null) { return node; } } } return null; } //......}
- 这里首先通过selectNodeByRequesterAndStrategy查找对应的node
- 之后调用controller.canPass进行限流判断,controller根据不同参数有不同实现类,默认是DefaultController,其余两个为PaceController、WarmUpController
- controlBehavior有3种,分别是RuleConstant.CONTROL_BEHAVIOR_DEFAULT,直接拒绝;RuleConstant.CONTROL_BEHAVIOR_WARM_UP,冷启动;RuleConstant.CONTROL_BEHAVIOR_RATE_LIMITER,均速器。
DefaultController
com/alibaba/csp/sentinel/slots/block/flow/controller/DefaultController.java
public class DefaultController implements Controller { double count = 0; int grade = 0; public DefaultController(double count, int grade) { super(); this.count = count; this.grade = grade; } @Override public boolean canPass(Node node, int acquireCount) { int curCount = avgUsedTokens(node); if (curCount + acquireCount > count) { return false; } return true; } private int avgUsedTokens(Node node) { if (node == null) { return -1; } return grade == RuleConstant.FLOW_GRADE_THREAD ? node.curThreadNum() : (int)node.passQps(); }}
小结
- sentinel的FlowSlot的默认的限流方式有两个维度,一个是基于线程数,一个是基于qps
- 基于qps的还有其他两种限流策略,一种是冷启动,一个是匀速器
- 冷启动适用于需要时间准备资源的请求,匀速器则控制请求以均匀的速度通过
doc