注:适配模块仅提供相应适配功能,若希望接入 Sentinel 控制台,请务必参考 Sentinel 控制台文档。
Web Servlet
Sentinel 提供与 Servlet 的整合,可以对 Web 请求进行流量控制。使用时需引入以下模块(以 Maven 为例):
- <dependency>
- <groupId>com.alibaba.csp</groupId>
- <artifactId>sentinel-web-servlet</artifactId>
- <version>x.y.z</version>
- </dependency>
您只需要在 Web 容器中的 web.xml
配置文件中进行如下配置即可开启 Sentinel 支持:
- <filter>
- <filter-name>SentinelCommonFilter</filter-name>
- <filter-class>com.alibaba.csp.sentinel.adapter.servlet.CommonFilter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>SentinelCommonFilter</filter-name>
- <url-pattern>/*</url-pattern>
- </filter-mapping>
默认情况下,当请求被限流时会返回默认的提示页面。您也可以通过 WebServletConfig.setBlockPage(blockPage)
方法设定自定义的跳转 URL,当请求被限流时会自动跳转至设定好的 URL。同样也可以实现 UrlBlockHandler
接口并编写定制化的限流处理逻辑,然后将其注册至 WebCallbackManager
中。
如果您正在使用 Spring Boot / Spring Cloud,那么可以通过引入 Spring Cloud Sentinel Starter 来更方便地整合 Sentinel,详情请见 Spring Cloud Alibaba。
Dubbo
Sentinel 提供 Dubbo 的相关适配 Sentinel Dubbo Adapter,主要包括针对 Service Provider 和 Service Consumer 实现的 Filter。使用时需引入以下模块(以 Maven 为例):
- <dependency>
- <groupId>com.alibaba.csp</groupId>
- <artifactId>sentinel-dubbo-adapter</artifactId>
- <version>x.y.z</version>
- </dependency>
引入此依赖后,Dubbo 的服务接口和方法(包括调用端和服务端)就会成为 Sentinel 中的资源,在配置了规则后就可以自动享受到 Sentinel 的防护能力。
注:若希望接入 Dashboard,请参考 接入控制台的步骤。只引入 Sentinel Dubbo Adapter 无法接入控制台!
若不希望开启 Sentinel Dubbo Adapter 中的某个 Filter,可以手动关闭对应的 Filter,比如:
- <!-- 关闭 Sentinel 对应的 Service Consumer Filter -->
- <dubbo:consumer filter="-sentinel.dubbo.consumer.filter"/>
限流粒度可以是服务接口和服务方法两种粒度:
- 服务接口:resourceName 为 接口全限定名,如 com.alibaba.csp.sentinel.demo.dubbo.FooService
- 服务方法:resourceName 为 接口全限定名:方法签名,如 com.alibaba.csp.sentinel.demo.dubbo.FooService:sayHello(java.lang.String)
从 0.1.1 版本开始,Sentinel Dubbo Adapter 还支持配置全局的 fallback 函数,可以在 Dubbo 服务被限流/降级/负载保护的时候进行相应的 fallback 处理。用户只需要实现自定义的DubboFallback
接口,并通过DubboFallbackRegistry
注册即可。默认情况会直接将BlockException
包装后抛出。同时,我们还可以配合 Dubbo 的 fallback 机制 来为降级的服务提供替代的实现。
注:一般情况下熔断降级 / fallback 用于调用端(客户端)。
我们提供了 Dubbo 的相关示例,请见 sentinel-demo-dubbo。
有关 Sentinel 在 Dubbo 中的最佳实践,请参考 Sentinel: Dubbo 服务的流量哨兵。
关于 Dubbo Filter 的更多信息,请参考 Dubbo Filter 文档。
Spring Cloud
Spring Cloud Alibaba 致力于提供分布式应用服务开发的一站式解决方案。Sentinel 与 Spring Cloud 的整合见 Spring Cloud Alibaba。
gRPC
Sentinel 提供与 gRPC Java 的整合,以 gRPC ServerInterceptor 和 ClientInterceptor 的形式保护 gRPC 服务资源。使用时需引入以下模块(以 Maven 为例):
- <dependency>
- <groupId>com.alibaba.csp</groupId>
- <artifactId>sentinel-grpc-adapter</artifactId>
- <version>x.y.z</version>
- </dependency>
在使用 Sentinel gRPC Adapter 时,只需要将对应的 Interceptor
注册至对应的客户端或服务端中。其中客户端的示例如下:
- public class ServiceClient {
- private final ManagedChannel channel;
- ServiceClient(String host, int port) {
- this.channel = ManagedChannelBuilder.forAddress(host, port)
- .intercept(new SentinelGrpcClientInterceptor()) // 在此处注册拦截器
- .build();
- // 在此处初始化客户端 stub 类
- }
- }
服务端的示例如下:
- import io.grpc.Server;
- Server server = ServerBuilder.forPort(port)
- .addService(new MyServiceImpl()) // 添加自己的服务实现
- .intercept(new SentinelGrpcServerInterceptor()) // 在此处注册拦截器
- .build();
注意:由于 gRPC 拦截器中 ClientCall/ServerCall 以回调的形式进行请求响应信息的获取,每次 gRPC 服务调用计算出的 RT 可能会不准确。Sentinel gRPC Adapter 目前只支持 unary call。
Apache RocketMQ
在 Apache RocketMQ 中,当消费者去消费消息的时候,无论是通过 pull 的方式还是 push 的方式,都可能会出现大批量的消息突刺。如果此时要处理所有消息,很可能会导致系统负载过高,影响稳定性。但其实可能后面几秒之内都没有消息投递,若直接把多余的消息丢掉则没有充分利用系统处理消息的能力。我们希望可以把消息突刺均摊到一段时间内,让系统负载保持在消息处理水位之下的同时尽可能地处理更多消息,从而起到“削峰填谷”的效果:
上图中红色的部分代表超出消息处理能力的部分。我们可以看到消息突刺往往都是瞬时的、不规律的,其后一段时间系统往往都会有空闲资源。我们希望把红色的那部分消息平摊到后面空闲时去处理,这样既可以保证系统负载处在一个稳定的水位,又可以尽可能地处理更多消息。Sentinel 专门为这种场景提供了匀速器的特性,可以把突然到来的大量请求以匀速的形式均摊,以固定的间隔时间让请求通过,以稳定的速度逐步处理这些请求,起到“削峰填谷”的效果,从而避免流量突刺造成系统负载过高。同时堆积的请求将会排队,逐步进行处理;当请求排队预计超过最大超时时长的时候则直接拒绝,而不是拒绝全部请求。
比如在 RocketMQ 的场景下配置了匀速模式下请求 QPS 为 5,则会每 200 ms 处理一条消息,多余的处理任务将排队;同时设置了超时时间为 5 s,预计排队时长超过 5 s 的处理任务将会直接被拒绝。示意图如下图所示:
RocketMQ 用户可以根据不同的 group 和不同的 topic 分别设置限流规则,限流控制模式设置为匀速器模式(RuleConstant.CONTROL_BEHAVIOR_RATE_LIMITER
),比如:
- private void initFlowControlRule() {
- FlowRule rule = new FlowRule();
- rule.setResource(KEY); // 对应的 key 为 `groupName:topicName`
- rule.setCount(5);
- rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
- rule.setLimitApp("default");
- // 匀速器模式下,设置了 QPS 为 5,则请求每 200 ms 允许通过 1 个
- rule.setControlBehavior(RuleConstant.CONTROL_BEHAVIOR_RATE_LIMITER);
- // 如果更多的请求到达,这些请求会被置于虚拟的等待队列中。等待队列有一个 max timeout,如果请求预计的等待时间超过这个时间会直接被 block
- // 在这里,timeout 为 5s
- rule.setMaxQueueingTimeMs(5 * 1000);
- FlowRuleManager.loadRules(Collections.singletonList(rule));
- }
结合 RocketMQ Client 使用 Sentinel 时,用户需要在处理消息时手动埋点。详情请见 Sentinel RocketMQ Demo。相关 Blog 见 Sentinel 为 RocketMQ 保驾护航。