• 引言
  • 规则管理及推送
    • 原始模式
    • Pull模式
    • Push模式
  • 监控
  • 最佳实践
  • 其它

    引言

    Sentinel 核心库目前已可用于生产环境,目前除了阿里巴巴以外,也有多家企业在生产环境中使用它们。

    生产环境的 Sentinel Dashboard 需要具备下面几个特性:

    • 规则管理及推送,集中管理和推送规则。sentinel-core 提供 API 和扩展接口来接收信息。开发者需要根据自己的环境,选取一个可靠的推送规则方式;同时,规则最好在控制台中集中管理。
    • 监控,支持可靠、快速的实时监控和历史监控数据查询。sentinel-core 记录秒级的资源运行情况,并且提供 API 来拉取资源运行信息。当机器大于一台以上的时候,可以通过 Dashboard 来拉取,聚合,并且存储这些信息。这个时候,Dashboard 需要有一个存储媒介,来存储历史运行情况。
    • 鉴权,区分用户角色,来进行操作。生产环境下的权限控制是非常重要的,理论上只有管理员等高级用户才有权限去修改应用的规则。由于开发者有各自不一样的环境和需求,我们会对“规则管理和推送”,“监控”这两个方面给出建议以及最佳实践;对于鉴权,由于每个开发者的环境都不一样,我们在最佳实践中仅仅使用了简单的认证。开发者可以依循自己的需求,生产环境,选择最适合自己的方式。

    规则管理及推送

    一般来说,规则的推送有下面三种模式:

    推送模式说明优点缺点
    原始模式API 将规则推送至客户端并直接更新到内存中,扩展写数据源(WritableDataSource简单,无任何依赖不保证一致性;规则保存在内存中,重启即消失。严重不建议用于生产环境
    Pull 模式扩展写数据源(WritableDataSource), 客户端主动向某个规则管理中心定期轮询拉取规则,这个规则中心可以是 RDBMS、文件 等简单,无任何依赖;规则持久化不保证一致性;实时性不保证,拉取过于频繁也可能会有性能问题。
    Push 模式扩展读数据源(ReadableDataSource),规则中心统一推送,客户端通过注册监听器的方式时刻监听变化,比如使用 Nacos、Zookeeper 等配置中心。这种方式有更好的实时性和一致性保证。生产环境下一般采用 push 模式的数据源。规则持久化;一致性;快速引入第三方依赖

    原始模式

    如果不做任何修改,Dashboard的推送规则方式是通过 API 将规则推送至客户端并直接更新到内存中:

    Original push rules from Sentinel Dashboard

    这种做法的好处是简单,无依赖;坏处是应用重启规则就会消失,仅用于简单测试,不能用于生产环境。

    Pull模式

    pull 模式的数据源(如本地文件、RDBMS 等)一般是可写入的。使用时需要在客户端注册数据源:将对应的读数据源注册至对应的 RuleManager,将写数据源注册至 transport 的 WritableDataSourceRegistry 中。以本地文件数据源为例:

    1. public class FileDataSourceInit implements InitFunc {
    2.  
    3. @Override
    4. public void init() throws Exception {
    5. String flowRulePath = "xxx";
    6.  
    7. ReadableDataSource<String, List<FlowRule>> ds = new FileRefreshableDataSource<>(
    8. flowRulePath, source -> JSON.parseObject(source, new TypeReference<List<FlowRule>>() {})
    9. );
    10. // 将可读数据源注册至 FlowRuleManager.
    11. FlowRuleManager.register2Property(ds.getProperty());
    12.  
    13. WritableDataSource<List<FlowRule>> wds = new FileWritableDataSource<>(flowRulePath, this::encodeJson);
    14. // 将可写数据源注册至 transport 模块的 WritableDataSourceRegistry 中.
    15. // 这样收到控制台推送的规则时,Sentinel 会先更新到内存,然后将规则写入到文件中.
    16. WritableDataSourceRegistry.registerFlowDataSource(wds);
    17. }
    18.  
    19. private <T> String encodeJson(T t) {
    20. return JSON.toJSONString(t);
    21. }
    22. }

    本地文件数据源会定时轮询文件的变更,读取规则。这样我们既可以在应用本地直接修改文件来更新规则,也可以通过 Sentinel 控制台推送规则。以本地文件数据源为例,推送过程如下图所示:

    Push rules from Sentinel Dashboard to local file

    首先 Sentinel 控制台通过 API 将规则推送至客户端并更新到内存中,接着注册的写数据源会将新的规则保存到本地的文件中。使用 pull 模式的数据源时一般不需要对 Sentinel 控制台进行改造。

    这种实现方法好处是简单,不引入新的依赖,坏处是无法保证监控数据的一致性

    Push模式

    生产环境下一般更常用的是 push 模式的数据源。对于 push 模式的数据源,如远程配置中心(ZooKeeper, Nacos, Apollo等等),推送的操作不应由 Sentinel 客户端进行,而应该经控制台统一进行管理,直接进行推送,数据源仅负责获取配置中心推送的配置并更新到本地。因此推送规则正确做法应该是 配置中心控制台/Sentinel 控制台 → 配置中心 → Sentinel 数据源 → Sentinel,而不是经 Sentinel 数据源推送至配置中心。这样的流程就非常清晰了:

    Remote push rules to config center

    我们提供了 ZooKeeper, Apollo, Nacos 等的动态数据源实现。以 ZooKeeper 为例子,如果要使用第三方的配置中心作为配置管理,您需要做下面的几件事情:

    • 实现一个公共的 ZooKeeper 客户端用于推送规则,在 Sentinel 控制台配置项中需要指定 ZooKeeper 的地址,启动时即创建 ZooKeeper Client。
    • 我们需要针对每个应用(appName),每种规则设置不同的 path(可随时修改);或者约定大于配置(如 path 的模式统一为 /sentinel_rules/{appName}/{ruleType},e.g. sentinel_rules/appA/flowRule)。
    • 规则配置页需要进行相应的改造,直接针对应用维度进行规则配置;修改同个应用多个资源的规则时可以批量进行推送,也可以分别推送。Sentinel 控制台将规则缓存在内存中(如 InMemFlowRuleStore),可以对其进行改造使其支持应用维度的规则缓存(key 为 appName),每次添加/修改/删除规则都先更新内存中的规则缓存,然后需要推送的时候从规则缓存中获取全量规则,然后通过上面实现的 Client 将规则推送到 ZooKeeper 即可。
    • 应用客户端需要注册对应的读数据源以监听变更,可以参考 相关文档。从 Sentinel 1.4.0 开始,Sentinel 控制台提供 DynamicRulePublisherDynamicRuleProvider 接口用于实现应用维度的规则推送和拉取,并提供了相关的示例。Sentinel 提供应用维度规则推送的示例页面(/v2/flow),用户改造控制台对接配置中心后可直接通过 v2 页面推送规则至配置中心。改造详情可参考 应用维度规则推送示例。

    监控

    Sentinel 会记录资源访问的秒级数据(若没有访问则不进行记录)并保存在本地日志中,具体格式请见 秒级监控日志文档。Sentinel 控制台可以通过 Sentinel 客户端预留的 HTTP API 从秒级监控日志中拉取监控数据,并进行聚合。

    目前 Sentinel 控制台中监控数据聚合后直接存在内存中,未进行持久化,且仅保留最近 5 分钟的监控数据。若需要监控数据持久化的功能,可以自行扩展实现 MetricsRepository 接口(0.2.0 版本),然后注册成 Spring Bean 并在相应位置通过 @Qualifier 注解指定对应的 bean name 即可。MetricsRepository 接口定义了以下功能:

    • savesaveAll:存储对应的监控数据
    • queryByAppAndResourceBetween:查询某段时间内的某个应用的某个资源的监控数据
    • listResourcesOfApp:查询某个应用下的所有资源其中默认的监控数据类型为 MetricEntity,包含应用名称、时间戳、资源名称、异常数、请求通过数、请求拒绝数、平均响应时间等信息。

    同时用户可以自行进行扩展,适配 Grafana 等可视化平台,以便将监控数据更好地进行可视化。

    对于监控数据的存储,用户需要根据自己的存储精度,来考虑如何存储这些监控数据。

    最佳实践

    我们提供了一个 Demo,这个版本目前部署在阿里云上。通过这个版本,开发者可以看到一个完整的生产环境的控制台的功能全集。它主要包括:

    • 可靠的实时监控和历史监控数据查询:该 Demo 将会示范 Sentinel 的监控能做成什么样子,请参考“监控”以及“簇点链路”模块。
    • 动态规则管理/推送:该 Demo 将会示范如何做一个合理的 push 结构的实现,请参考“规则”模块。
    • 机器列表:如何利用 Sentinel 上报的机器信息进行管理,请参考“机器列表”模块。使用这个 Demo,您需要申请阿里云的帐号(免费),下载一个 JAR 包。这个 JAR 包主要包含 sentinel-core、配置中心 ACM 的客户端(与 Nacos 同源)以及阿里云控制台的认证功能,认证功能保证您的机器信息等只能被您自己看到,别人无法看到。如果您不想使用这个 Demo,停止并删除这个 JAR 包即可。这个 JAR 包在运行的时候不会在您的机器上留下任何的记录。

    请参考这个链接来参考如何在生产环境中使用控制台。

    其它

    Awesome Sentinel 里记录非常多的社区用户的一些扩展和解决方案,也欢迎大家将一些比较好的扩展实现添加进来。