在 dubbo-go 中使用 sentinel

时至今日，Apache/dubbo-go（以下简称 dubbo-go ）项目在功能上已经逐步对齐 java 版本，稳定性也在不同的生产环境得到了验证。社区便开始再服务治理、监控等方向发力。随着 1.2 和 1.3 版本发布， dubbo-go 新增了大量此类新 feature。

今天我们聊一聊限流相关话题，此前 dubbo-go 已经支持了tps limit、execute limit 、hystrix 的内置 filter，用户只要简单配置就能马上用上。但我们知道，在 java 的 dubbo 生态中，有一项限流工具被广泛使用，那就是 sentinel。sentinel 因为强大的动态规划配置、优秀的 dashboard 以及对 dubbo 的良好适配，成为众多使用 dubbo 的企业选用限流工具的不二之选。

就在前些日子，社区非常高兴得知 Sentinel Golang 首个版本 0.1.0 正式发布，这使得 dubbo-go 也可以使用 sentinel 作为工具进行一些服务治理、监控的工作了。随着 sentinel golang 的健壮，我们相信用户马上可以像 sentinel 管理 java dubbo 服务那样管理 dubbo-go 的服务了。

完成 sentinel golang 的 dubbo-adapter 其实非常简单，这得益于 dubbo-go 早就完成了 filter 链的构造，用户可以自定义 filter，并且灵活的安排其执行顺序。在 1.3 发布后，增加了 filter 中的 context 传递，构建 sentinel/adapter/dubbo 更为方便。

我们以其中的 provider filter 适配为例:

此 filter 实现了 dubbo-go 的 filter 接口，只要用户在服务启动时将此 filter 加载到 dubbo-go 中，即可使用此 filter。 sentinel 实现原理与其他限流、熔断库大同小异，底层是用的滑动窗口算法。与 hystrix 等框架相比不同点是设计理念，Sentinel 的设计理念是让您自由选择控制的角度，并进行灵活组合，从而达到想要的效果。

下面我整理了完整的使用流程：(注意：dubbo-go 版本请使用 1.3.0-rc3 及其以上版本)

在 dubbo-go 中使用 sentinel 主要分为以下几步：

1.初始化 sentinel

2.将 sentinel 注入 dubbo-go 的 filter

3.初始化 dubbo-go

4.配置规划

初始化 sentinel

示例代码：

import (
	sentinel "github.com/alibaba/sentinel-golang/api"
)

func initSentinel() {
	err := sentinel.InitWithLogDir(confPath, logDir)
	if err != nil {
		// 初始化 Sentinel 失败
	}
}

将 sentinel 注入 dubbo-go 的 filter

你可以通过 import 包的形式执行，执行其中的 init()来注入 filter

import (
	_ "github.com/alibaba/sentinel-golang/adapter/dubbo"
)

也可以手动执行，给你的 filter 取上自己想要的名字

import (
  "github.com/apache/dubbo-go/common/extension"
  sd "github.com/alibaba/sentinel-golang/adapter/dubbo"
)

func main(){
  extension.SetFilter("myConsumerFilter",sd.GetConsumerFilter())
  extension.SetFilter("myProviderFilter",sd.GetConsumerFilter())
}

完成以上步骤，你就可以在需要的 dubbo 接口配置里写入 sentinel 的 filterName,构建起接口的 filter 链条。比如以下以 consumer.yml 配置文件为例

references:
  "UserProvider":
    registry: "hangzhouzk"
    protocol: "dubbo"
    interface: "com.ikurento.user.UserProvider"
    cluster: "failover"
    filter: "myConsumerFilter"
    methods:
      - name: "GetUser"
        retries: 3

初始化 dubbo-go

到这一步，你只需要正常启动 dubbo-go 程序就完成了服务启动。用以下代码做一个较为完整举例

import (
	hessian "github.com/apache/dubbo-go-hessian2"
	sd "github.com/alibaba/sentinel-golang/adapter/dubbo"
)

import (
	"github.com/apache/dubbo-go/common/logger"
	_ "github.com/apache/dubbo-go/common/proxy/proxy_factory"
	"github.com/apache/dubbo-go/config"
	_ "github.com/apache/dubbo-go/filter/impl"
	_ "github.com/apache/dubbo-go/protocol/dubbo"
	_ "github.com/apache/dubbo-go/registry/protocol"

	_ "github.com/apache/dubbo-go/cluster/cluster_impl"
	_ "github.com/apache/dubbo-go/cluster/loadbalance"
	_ "github.com/apache/dubbo-go/registry/zookeeper"
	"github.com/apache/dubbo-go/common/extension"
)

func main() {

	hessian.RegisterPOJO(&User{})
  extension.SetFilter("myConsumerFilter",sd.GetConsumerFilter())
  extension.SetFilter("myProviderFilter",sd.GetConsumerFilter())
	config.Load()

	// init finish, do your work
	test()
}

规划配置

sentinel 以强大的规划配置吸引了很多使用者，其提供动态数据源接口进行扩展，用户可以通过动态文件或 etcd 等配置中心来动态地配置规则。但目前 sentinel-golang 作为破蛋版本，动态配置还在开发中

动态数据源

（开发中）Sentinel 提供动态数据源接口进行扩展，用户可以通过动态文件或 etcd 等配置中心来动态地配置规则。

硬编码方式

Sentinel 也支持原始的硬编码方式加载规则，可以通过各个模块的 LoadRules(rules) 方法加载规则。以下是硬编码方式对某个 method 在 consumer 端的 QPS 流控：

_, err := flow.LoadRules([]*flow.FlowRule{
	{
		ID:                666,
		Resource:         "dubbo:consumer:com.ikurento.user.UserProvider:myGroup:1.0.0:hello()",
		MetricType:        flow.QPS,
		Count:             10,
		ControlBehavior:   flow.Reject,
	},
})
if err != nil {
	// 加载规则失败，进行相关处理
}

总结

更加具体的实现，我就不详细论述，大家可以去看源码进一步了解。

最后，欢迎大家持续关注，或者贡献代码，期待 dubbo-go 在 2020 年在云原生领域继续突破。

dubbo-go 仓库地址：https://github.com/apache/dubbo-go