zipkin

描述

Zipkin 是一个开源的分布调用链追踪系统。zipkin 插件基于 Zipkin API 规范,支持收集跟踪信息并上报给 Zipkin Collector。

该插件也支持 Apache SkyWalkingJaeger,因为它们都支持了 Zipkin v1v2 API。当然 zipkin 插件也可以与其他支持了 Zipkin v1 和 v2 API 格式的调用链追踪系统集成。

属性

名称类型必选项默认值有效值描述
endpointstringZipkin 的 HTTP 节点。例如:http://127.0.0.1:9411/api/v2/spans
sample_rationumber[0.00001, 1]对请求进行采样的比例。当设置为 1 时,将对所有请求进行采样。
service_namestring“APISIX”需要在 Zipkin 中显示的服务名称。
server_addrstring$server_addr当前 APISIX 实例的 IPv4 地址。
span_versioninteger2[1, 2]span 类型的版本。

在当前版本中,每个被跟踪的请求都会创建如下所示的 span:

  1. request
  2. ├── proxy: from the beginning of the request to the beginning of header filter
  3. └── response: from the beginning of header filter to the beginning of log

在旧版本(将 span_version 属性设置为 1)中,将创建如下 span:

  1. request
  2. ├── rewrite
  3. ├── access
  4. └── proxy
  5. └── body_filter
zipkin - 图1note

上述 span 的名称与同名的 NGINX phase 没有联系。

上游服务示例

Go with Gin

  1. func GetTracer(serviceName string, port int, enpoitUrl string, rate float64) *zipkin.Tracer {
  2. // create a reporter to be used by the tracer
  3. reporter := httpreporter.NewReporter(enpoitUrl)
  4. // set-up the local endpoint for our service host is ip:host
  5. thisip, _ := GetLocalIP()
  6. host := fmt.Sprintf("%s:%d", thisip, port)
  7. endpoint, _ := zipkin.NewEndpoint(serviceName, host)
  8. // set-up our sampling strategy
  9. sampler, _ := zipkin.NewCountingSampler(rate)
  10. // initialize the tracer
  11. tracer, _ := zipkin.NewTracer(
  12. reporter,
  13. zipkin.WithLocalEndpoint(endpoint),
  14. zipkin.WithSampler(sampler),
  15. )
  16. return tracer
  17. }
  18. func main(){
  19. r := gin.Default()
  20. tracer := GetTracer(...)
  21. // use middleware to extract parentID from http header that injected by APISIX
  22. r.Use(func(c *gin.Context) {
  23. span := this.Tracer.Extract(b3.ExtractHTTP(c.Request))
  24. childSpan := this.Tracer.StartSpan(spanName, zipkin.Parent(span))
  25. defer childSpan.Finish()
  26. c.Next()
  27. })
  28. }

启用插件

以下示例展示了如何在指定路由中启用 zipkin 插件:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uri": "/index.html",
  5. "plugins": {
  6. "zipkin": {
  7. "endpoint": "http://127.0.0.1:9411/api/v2/spans",
  8. "sample_ratio": 1,
  9. "service_name": "APISIX-IN-SG",
  10. "server_addr": "192.168.3.50"
  11. }
  12. },
  13. "upstream": {
  14. "type": "roundrobin",
  15. "nodes": {
  16. "127.0.0.1:1980": 1
  17. }
  18. }
  19. }'

测试插件

首先你需要通过以下命令创建一个 Zipkin 实例:

  1. docker run -d -p 9411:9411 openzipkin/zipkin

接下来你可以通过以下命令发起请求,该请求记录会出现在 Zipkin 中:

  1. curl http://127.0.0.1:9080/index.html
  1. HTTP/1.1 200 OK
  2. ...

最后你可以在浏览器中输入 http://127.0.0.1:9411/zipkin 访问 Zipkin UI 查询 traces:

zipkin web-ui

zipkin web-ui list view

上报到 Jaeger

除了对接 Zipkin,该插件也支持将 traces 上报到 Jaeger。

首先,请使用以下命令运行 Jaeger 后端服务:

  1. docker run -d --name jaeger \
  2. -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
  3. -p 16686:16686 \
  4. -p 9411:9411 \
  5. jaegertracing/all-in-one:1.31

通过以下命令创建路由并启用插件:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uri": "/index.html",
  5. "plugins": {
  6. "zipkin": {
  7. "endpoint": "http://127.0.0.1:9411/api/v2/spans",
  8. "sample_ratio": 1,
  9. "service_name": "APISIX-IN-SG",
  10. "server_addr": "192.168.3.50"
  11. }
  12. },
  13. "upstream": {
  14. "type": "roundrobin",
  15. "nodes": {
  16. "127.0.0.1:1980": 1
  17. }
  18. }
  19. }'

接下来你可以通过以下命令发起请求,该条请求记录将会出现在 Jaeger 中:

  1. curl http://127.0.0.1:9080/index.html
  1. HTTP/1.1 200 OK
  2. ...

最后你可以在浏览器中输入 http://127.0.0.1:16686 访问 Jaeger UI 查看 traces:

jaeger web-ui

jaeger web-ui trace

删除插件

当你需要禁用 zipkin 插件时,可以通过以下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uri": "/index.html",
  5. "plugins": {
  6. },
  7. "upstream": {
  8. "type": "roundrobin",
  9. "nodes": {
  10. "127.0.0.1:1980": 1
  11. }
  12. }
  13. }'