Version: 2.11

zipkin

目录

名字

zipkin(https://github.com/openzipkin/zipkin) 是一个开源的服务跟踪插件。

它还可以在 “Apache SkyWalking” 上运行,支持 Zipkin v1/v2 格式。

属性

名称类型必选项默认值有效值描述
endpointstring必须Zipkin 的 http 节点,例如http://127.0.0.1:9411/api/v2/spans
sample_rationumber必须[0.00001, 1]监听的比例
service_namestring可选“APISIX”标记当前服务的名称
server_addrstring可选标记当前 APISIX 实例的IP地址,默认值是 nginx 的内置变量server_addr
span_versioninteger可选2[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 是这样:

  1. request
  2. ├── rewrite
  3. ├── access
  4. └── proxy
  5. └── body_filter

注意上述的 span 的名称跟同名的 Nginx phase 没有关系。

如果你需要兼容过去的 span 类型,可以把 span_version 设置成 1。

如何启用

下面是一个示例,在指定的 route 上开启了 zipkin 插件:

  1. curl http://127.0.0.1:9080/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. "39.97.63.215:80": 1
  17. }
  18. }
  19. }'

你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 zipkin 插件:

enable zipkin plugin

测试插件

运行 Zipkin 实例

e.g. 用docker:

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

测试示例:

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

打开浏览器,访问 Zipkin 的 web 页面:

  1. http://127.0.0.1:9411/zipkin

zipkin web-ui

zipkin web-ui list view

禁用插件

当你想去掉插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效:

  1. $ curl http://127.0.0.1:9080/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. "39.97.63.215:80": 1
  11. }
  12. }
  13. }'

现在就已经移除了 Zipkin 插件了。其他插件的开启和移除也是同样的方法。

上游服务是Golang的示例代码

  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. }