• 对 Sentinel 进行相关配置并进行初始化
  • 埋点(定义资源)
  • 配置规则

使用 Sentinel 时需要在应用启动时对 Sentinel 进行相关配置并触发初始化。 包下提供如下函数:

  • InitDefault():从环境变量中读取相应配置来初始化 Sentinel,若环境变量不存在则使用默认值。
  • :将日志目录初始化为 logDir,并从给定的 YAML 文件中读取相应配置来初始化 Sentinel。

通用配置项加载策略和配置项请参考

示例代码:

使用 Sentinel 的 Entry API 将业务逻辑封装起来,这一步称为“埋点”。每个埋点都有一个资源名称(resource),代表触发了这个资源的调用或访问。

埋点 API 位于 api 包中:

  • Entry(resource string, opts …Option) (base.SentinelEntry, base.BlockError)

其中 resource 代表埋点资源名, 代表埋点配置。目前支持以下埋点配置:

  • WithTrafficType(entryType base.TrafficType):标记该埋点资源的流量类型,其中 Inbound 代表入口流量,Outbound 代表出口流量。若不指定,默认为 Outbound。
  • WithResourceType(resourceType base.ResourceType):标记该埋点资源的分类。
  • :埋点携带的参数列表,为热点参数统计预留。

若该次调用被拒绝,则 Entry API 会返回 BlockError 代表被 Sentinel 限流。BlockError 提供了限流原因以及触发的规则等信息,可以方便开发者获取相关信息进行记录和处理。

(规划中)Sentinel 提供动态数据源接口进行扩展,用户可以通过动态文件或 etcd 等配置中心来动态地配置规则。

硬编码方式

Sentinel 也支持原始的硬编码方式加载规则,可以通过各个模块的 LoadRules(rules) 方法加载规则。以流控规则为例: