Sentinel Logo

Sentinel: 分布式系统的流量防卫兵

Sentinel 是什么?

随着微服务的流行,服务和服务之间的稳定性变得越来越重要。Sentinel 以流量为切入点,从流量控制、熔断降级、系统负载保护等多个维度保护服务的稳定性。

Sentinel 具有以下特征:

  • 丰富的应用场景:Sentinel承接了阿里巴巴近10年的双十一大促流量的核心场景,例如秒杀,即突发流量控制在系统容量可以承受的范围;消息削峰填谷;实时熔断下游不可用应用,等等。
  • 完备的监控功能:Sentinel同时提供最实时的监控功能,您可以在控制台中看到接入应用的单台机器秒级数据,甚至 500 台以下规模的集群的汇总运行情况。
  • 简单易用的扩展点:Sentinel提供简单易用的扩展点,您可以通过实现扩展点,快速的定制逻辑。例如定制规则管理,适配数据源等。
    Sentinel分为两个部分:

  • 服务端基于Spring Boot开发,打包后可以直接运行,不需要额外安装Tomcat等应用容器。

  • Java客户端不依赖任何框架,能够运行于所有Java运行时环境,同时对Spring/Spring Boot环境也有较好的支持。服务端基于Spring Boot和Spring Cloud开发,打包后可以直接运行,不需要额外安装Tomcat等应用容器。

    详细文档

请移步 Wiki,查阅详细的文档、示例以及使用说明。

请移步 Javadoc 查阅 API。

请移步 README for Readme in English。

如果您正在使用 Sentinel,欢迎在 这里 留言告诉我们您的使用场景,以便我们更好地去改进。

Quick Start

下面的例子将展示应用如何 3 步接入 Sentinel。同时,Sentinel 也提供一个所见即所得的控制台,可以实时监控资源以及管理规则。

1.在应用中引入Sentinel Jar包

注意: Sentinel JAR 包仅支持 Java 6 或者以上版本。

如果应用使用 pom 工程,则在 pom.xml 文件中加入以下代码即可:

  1. <dependency>
  2. <groupId>com.alibaba.csp</groupId>
  3. <artifactId>sentinel-core</artifactId>
  4. <version>x.y.z</version>
  5. </dependency>

如果您未使用依赖管理工具,请到 Maven Center Repository 直接下载 JAR 包。

2.定义资源

接下来,把需要控制流量的代码用 Sentinel API SphU.entry("HelloWorld")entry.exit() 包围起来即可。在下面的例子中,我们将 System.out.println("hello wolrd"); 作为资源,用 API 包围起来。参考代码如下:

  1. public static void main(String[] args) {
  2. initFlowRules();
  3. while (true) {
  4. Entry entry = null;
  5. try {
  6. entry = SphU.entry("HelloWorld");
  7. System.out.println("hello world");
  8. } catch (BlockException e1) {
  9. System.out.println("block!");
  10. } finally {
  11. if (entry != null) {
  12. entry.exit();
  13. }
  14. }
  15. }
  16. }

完成以上两步后,代码端的改造就完成了。

3.定义规则

接下来,通过规则来指定允许该资源通过的请求次数,例如下面的代码定义了资源"hello world"每秒最多只能通过 20 个请求。

  1. private static void initFlowRules(){
  2. List<FlowRule> rules = new ArrayList<FlowRule>();
  3. FlowRule rule = new FlowRule();
  4. rule.setResource("HelloWorld");
  5. rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
  6. // Set limit QPS to 20.
  7. rule.setCount(20);
  8. rules.add(rule);
  9. FlowRuleManager.loadRules(rules);
  10. }

完成上面 3 步,Sentinel 就能够正常工作了。

4.检查效果

Demo 运行之后,我们可以在日志 ~/logs/csp/metrics.log.xXXX 里看到下面的输出:

  1. |--timestamp-|------date time----|--resource-|p |block|s |e|rt
  2. 1529998904000|2018-06-26 15:41:44|hello world|20|0 |20|0|0
  3. 1529998905000|2018-06-26 15:41:45|hello world|20|5579 |20|0|728
  4. 1529998906000|2018-06-26 15:41:46|hello world|20|15698|20|0|0
  5. 1529998907000|2018-06-26 15:41:47|hello world|20|19262|20|0|0
  6. 1529998908000|2018-06-26 15:41:48|hello world|20|19502|20|0|0
  7. 1529998909000|2018-06-26 15:41:49|hello world|20|18386|20|0|0
  8. p代表通过的请求, block代表被阻止的请求, s代表成功处理的请求个数, e代表用户自定义的议程, rt代表平均相应时长。

可以看到,这个程序每秒稳定输出 "hello world" 20 次,和规则中预先设定的阈值是一样的。

更详细的说明可以参考: 如何使用

更多的例子可以参考: Demo

5.启动 Sentinel 控制台

Sentinel 同时提供控制台,可以实时监控各个资源的运行情况,并且可以实时地修改限流规则。

更多的信息请参考:控制台

Bugs 和反馈

反馈 bugs、相关问题或者讨论,请提交 GitHub Issues

联系我们: sentinel@linux.alibaba.com

贡献

我们随时都欢迎开发者来贡献!详情请参考开源贡献指南

相关讨论也可以加钉钉群:Dingtalk Group

原文: https://github.com/alibaba/Sentinel/wiki/%E4%BB%8B%E7%BB%8D