《我修复的印象最深的一个bug》--etcd 客户端的使用姿势

简介: 《我修复的印象最深的一个bug》--etcd 客户端的使用姿势

记录一个 etcd 客户端使用的bug,当时折腾了好久。


本文将会按照安装的过程一步步讲述遇到问题以及如何解决。


etcd clientv3 客户端

首先是 etcd clientv3 的初始化,我们根据指定的 etcd 节点,建立客户端与 etcd 集群的连接。


cli,err :=clientv3.New(clientv3.Config{
Endpoints:[]string{"localhost:2379"},
DialTimeout: 5*time.Second,
    })

实例化一个 client,这里需要传入的两个参数:

  • Endpoints:etcd 的多个节点服务地址,因为我是单点本机测试,所以只传 1 个。
  • DialTimeout:创建 client 的首次连接超时,这里传了 5 秒,如果 5 秒都没有连接成功就会返回 err;值得注意的是,一旦 client 创建成功,我们就不用再关心后续底层连接的状态了,client 内部会重连。

Go mod 包依赖冲突处理

我使用了 Go Module 管理依赖。引入相应的第三方依赖,主要是 clientv3 `go.etcd.io/etcd/clientv3`。根据 go.mod 文件来处理依赖关系:


$Gomodtidy


命令执行完,报了如下的错误:

go: github.com/keets2012/etcd-book-code/clientimportsgo.etcd.io/etcd/clientv3testedbygo.etcd.io/etcd/clientv3.testimportsgithub.com/coreos/etcd/authimportsgithub.com/coreos/etcd/mvcc/backendimportsgithub.com/coreos/bbolt: github.com/coreos/bbolt@v1.3.5: parsinggo.mod:
moduledeclaresitspathas: go.etcd.io/bboltbutwasrequiredas: github.com/coreos/bbolt


看起来 coreos 维护的 bbolt 库声明它的 module 名称是 go.etcd.io/bbolt ,结果在使用它的时候使用的 package path 是 github.com/coreos/bbolt ,导致不一致( etcd#11720 , etcd#11739 )、 etcd#11749 。

显然是 etcd 使用的是错误的 bbolt 的路径。冷静下来,考虑解决办法。幸好,go module 提供 replace 的方法,我们可以使用下面的方法替换:

replacegithub.com/coreos/bbolt=>go.etcd.io/bboltv1.3.5


然而这样替换之后,还是会出现如下的错误:

go: go.etcd.io/bbolt@v1.3.5usedfortwodifferentmodulepaths (github.com/coreos/bboltandgo.etcd.io/bbolt)


按照错误的描述,我们需要再加上一条 replace,使其成为不同的依赖路径。

replacego.etcd.io/bboltv1.3.5=>github.com/coreos/bboltv1.3.5


现在我们再执行 `go mod tidy`,bbolt 的问题已经解决了,但是新问题又来了:

github.com/keets2012/etcd-book-code/clientimportsgo.etcd.io/etcd/clientv3testedbygo.etcd.io/etcd/clientv3.testimportsgithub.com/coreos/etcd/integrationimportsgithub.com/coreos/etcd/proxy/grpcproxyimportsgoogle.golang.org/grpc/naming: modulegoogle.golang.org/grpc@latestfound (v1.32.0), butdoesnotcontainpackagegoogle.golang.org/grpc/naming


搜一下 issue,你会看到 etcd#11563 、 etcd#11650 、 etcd#11707

Etcd 的代码和新版本的 grpc(v1.27.0)冲突,再次施展替换大法,让项目使用老的 grpc:

replace (
google.golang.org/grpc=>google.golang.org/grpcv1.26.0)


再次执行依赖之间的关系,终于不再报错。检查我们的 go.mod 文件,发现很多的 indirect 引用的库,居然还有两个 etcd :

github.com/coreos/etcdv3.3.25+incompatiblego.etcd.io/etcdv3.3.25+incompatiblegithub.com/coreos/bboltv1.3.5// indirect


github.com/coreos/bbolt 之所以显示为 indirect 是因为我们的代码中还没有引用这个 package。当引用之后,就可以看到 indirect 标记没了。

我们的项目中引入了 go.etcd.io/etcd,为什么还会有一个 github.com/coreos/etcd?这两个路径的代码应该也是一样。

由此可以判断肯定是某个库引用 github.com/coreos/etcd 了。我们来搜索下是哪个库?go mod 还提供了其他的命令:

gomodwhy依赖//解释为什么需要包或模块gomodgraph依赖//输出 module 需求图


$Gomodwhygithub.com/coreos/etcdgo: findingmoduleforpackagegithub.com/spf13/cobrago: findingmoduleforpackagegithub.com/spf13/pflaggo: foundgithub.com/spf13/cobraingithub.com/spf13/cobrav1.0.0go: foundgithub.com/spf13/pflagingithub.com/spf13/pflagv1.0.5


或者使用 Go mod graph 查找,执行如下的命令筛选:


Gomodgraph|grepgithub.com/coreos/etcdgithub.com/keets2012/etcd-book-codegithub.com/coreos/etcd@v3.3.25+incompatiblegithub.com/spf13/viper@v1.4.0github.com/coreos/etcd@v3.3.10+incompatible


可以看到是与 github.com/spf13/viper@v1.4.0 相关,github.com/coreos/etcd 使用了 github.com/spf13/cobra@v1.0.0 库, cobra 又使用 viper 的 1.4.0 版本,而 viper@v1.4.0 又使用了 etcd@v3.3.10+incompatible。造成了循环依赖,对于引入依赖来说已经面目全非,原先 go.etcd.io/etcd,现在却成了 github.com/coreos/etcd。

由于 Go module 的一些 bug,以及开源项目使用 Go module 的错误姿势,go module 模式下导致使用 Etcd 代码库困难重重。这里我们已经解决了 etcd clientv3 依赖引入的问题。



目录
相关文章
|
6月前
|
人工智能 网络安全 Python
一篇普通的bug日志——bug的尽头是next吗?
[bug 1] TypeError: ‘method’ object is not subscriptable 问题代码:
129 0
一篇普通的bug日志——bug的尽头是next吗?
|
移动开发 前端开发 小程序
不愧是前端老油条,分分钟看出我方案的bug
国庆前刚开发完一个小需求,常规性的做了一次code review,不过这次review有所不同,我们组前端老油条竟然参会了,平时发会邀都不来的。 不过不愧是老油条,竟然分分中发现了问题,老油条的地位又在我们小前端的心里巩固了一下。 和往常一样,review前先过一遍技术方案,一让大家快速的了解需求,二来分析下技术方案是否存在问题,是否合理,一般情况下,技术方案没问题,后面的代码review感觉就没啥必要了,因为很少有人听。
137 0
不愧是前端老油条,分分钟看出我方案的bug
|
开发框架 Java 测试技术
【测试基础】五、这样提bug单,开发小哥还会怼你么?
【测试基础】五、这样提bug单,开发小哥还会怼你么?
【测试基础】五、这样提bug单,开发小哥还会怼你么?
|
测试技术
如何处理不能复现的bug?软件测试工程师避坑指南
软件测试工作中常常会遇到不能复现的bug,遇到这种情况其实很正常,但是很多测试新手都按照自己的想法处理,没有提交bug,或者匆匆关闭bug。线上出现问题,就只能自己背锅了。
554 0
|
Kubernetes 安全 Cloud Native
|
Java 中间件 程序员
最网最全bug定位套路,遇见bug再也不慌了
最网最全bug定位套路,遇见bug再也不慌了
318 0
|
Arthas 监控 Java
看了这篇文章,比同事更快找到bug!
你以为程序员只是闷着头疯狂写bug,写好了发布到服务器就完了? 不,你还要修bug!但在那之前,你还要找bug!
213 0
|
关系型数据库 MySQL Java
从零开始写项目终极【维护网站、修复Bug】
在我使用浏览器收藏了我写的网站的时候,有的时候会访问不了页面。 看了一下原因,是由于url携带了jsessionId,我就奇怪为啥会自动携带jsession了。
417 0
从零开始写项目终极【维护网站、修复Bug】
|
运维 监控 IDE
同事牛逼啊,写了个隐藏 bug,我排查了 3 天才解决问题!
最近线上监控 SFTP 连接频繁爆表,通过重启某个系统,连接数迅速下降,系统就能恢复正常,初步判断是应用程序连接未关闭的问题导致的。
同事牛逼啊,写了个隐藏 bug,我排查了 3 天才解决问题!
|
JSON 前端开发 数据格式
我修复的印象最深的一个bug:数据内有超长整数末尾变0
接口请求json解析时,数字超过一定位数,数据内有超长整数末尾变0的处理方法
我修复的印象最深的一个bug:数据内有超长整数末尾变0