基于go-micro微服务的实战-zipkin实现全链路追踪(九)

基于go-micro微服务的实战-zipkin实现全链路追踪(九)

---

文章最后附带完整代码

Zipkin是 Twitter 的一个开源项目，基于 Google Dapper实现。可以使用它来收集各个服务器上请求链路的跟踪数据。除了面向开发的API接口之外，它也提供了方便的 UI 组件帮助我们直观的搜索跟踪信息和分析请求链路明细。

这一节主要是引入zipkin实现微服务调用的全链路追踪，调用发起后，记录请求经过的服务以及，延迟，耗时等信息，方便定位问题和追踪。

设计流程：通过使用go-micro装饰器接入客户端发起和服务端接收的链路追踪相关处理。

---

第一步：docker安装并启动容器

相关的记录信息的存储方式，这里用默认的内存存储方式，可以指定es等

docker run --name ezipkin -d -p 9411:9411 openzipkin/zipkin

指定es

docker run --name ezipkin -d -p 9411:9411 -e STORAGE_TYPE=elasticsearch -e ES_HOSTS=127.0.0.1:9200 openzipkin/zipkin

把容器添加到监控命令配置文件grpc_util/monitor_process/process.conf

...
docker:ezipkin

第二步：添加zipkin配置信息

在grpc_server/user/conf/service.conf中增加配置信息

...
##zipkin全链路追踪
zipkin_addr = "127.0.0.1"
zipkin_port = 9411
zipkin_url = "http://127.0.0.1:9411/api/v2/spans"

第三步：追踪处理器文件

在wrapper目录下新增ezipkin.go追踪处理器文件。 无论客户端请求还是服务端接收都是通过下方的func GetTracer()初始化追踪器

具体的代码

import(
    ...
	"github.com/opentracing/opentracing-go"
	zipkinot "github.com/openzipkin-contrib/zipkin-go-opentracing"
	"github.com/openzipkin/zipkin-go"
	zipkinhttp "github.com/openzipkin/zipkin-go/reporter/http"
)

//初始化追踪器
func GetTracer(serviceName string, host string, config config.Configer) opentracing.Tracer {
	
	url := config.String("zipkin_url")
	zipkinReporter := zipkinhttp.NewReporter(url)
	
	endpoint, err := zipkin.NewEndpoint(serviceName, host)
	log.Println("GetTracer:", serviceName, host, url)

	if err != nil {
		log.Fatalf("unable to create local endpoint: %+v\n", err)
	}
	
	nativeTracer, err := zipkin.NewTracer(zipkinReporter, zipkin.WithLocalEndpoint(endpoint))

	if err != nil {
		log.Fatalf("unable to create tracer: %+v\n", err)

	}
	
	tracer := zipkinot.Wrap(nativeTracer)
	opentracing.InitGlobalTracer(tracer)

	return tracer

}

第四步：在服务的装饰器中增加客户端和服务端的追踪处理

客户端装饰器，client_wrapper.go

import "github.com/go-micro/plugins/v3/wrapper/trace/opentracing"

...
func ClientTrace(service *common.EmicroService) client.Wrapper{
	tracer := GetTracer(common.ServerName, service.Addr, common.Config)
	tracerHandler := opentracing.NewClientWrapper(tracer)
	return tracerHandler
}

服务端装饰器，server_wrapper.go

import "github.com/go-micro/plugins/v3/wrapper/trace/opentracing"
...
func ServerTrace(service *common.EmicroService) server.HandlerWrapper{
	tracer := GetTracer(common.ServerName, service.Addr, common.Config)
	tracerHandler := opentracing.NewHandlerWrapper(tracer)
	return tracerHandler
}

在服务初始化处新增装饰器声明，server.go

...
	otherOpts := []micro.Option{
		micro.WrapHandler(wrapper.ServerTrace(service)),
		micro.WrapClient(wrapper.ClientTrace(service)),
	}
	service.Service.Init(otherOpts...)
...

注意

如果go版本是1.17下，使用go module导入github.com/openzipkin/zipkin-go包高版本会报 undefined：unsafe.Slice。所以需要在go.mod中指定zipkin-go的低版本，

第五步：测试验证

发起一个客户端注册请求，发起两次，一次注册成功，一次注册失败

访问zipkin的可视化web网页，http://127.0.0.1:9411，如下图所示，上面测试只有一个服务，估追踪链只显示一个服务调用，如果请求调用多个服务，追踪链则会显示多个，这里不举相应例子。

gitee完整代码链接