什么是OpenTracing?

现在有许多开源的分布式跟踪库可供选择，其中最受欢迎的库可能是Zipkin²和Jaeger³。 选择哪个是一个令人头疼的问题，因为你现在可以选择最受欢迎的一个，但是如果以后有一个更好的出现呢？OpenTracing⁴可以帮你解决这个问题。它建立了一套跟踪库的通用接口，这样你的程序只需要调用这些接口而不被具体的跟踪库绑定，将来可以切换到不同的跟踪库而无需更改代码。Zipkin和Jaeger都支持OpenTracing。

如何跟踪服务器端点(server endpoints)?

在下面的程序中我使用“Zipkin”作为跟踪库，用“OpenTracing”作为通用跟踪接口。 跟踪系统中通常有四个组件，下面我用Zipkin作为示例：

• recorder(记录器)：记录跟踪数据

• Reporter (or collecting agent)(报告器或收集代理)：从记录器收集数据并将数据发送到UI程序

• Tracer：生成跟踪数据

• UI：负责在图形UI中显示跟踪数据

上面是Zipkin的组件图，你可以在Zipkin Architecture中找到它。

有两种不同类型的跟踪，一种是进程内跟踪（in-process），另一种是跨进程跟踪（cross-process）。 我们将首先讨论跨进程跟踪。

客户端程序:

我们将用一个简单的gRPC程序作为示例，它分成客户端和服务器端代码。 我们想跟踪一个完整的服务请求，它从客户端到服务端并从服务端返回。 以下是在客户端创建新跟踪器的代码。它首先创建“HTTP Collector”(the agent)用来收集跟踪数据并将其发送到“Zipkin” UI， “endpointUrl”是“Zipkin” UI的URL。 其次，它创建了一个记录器(recorder)来记录端点上的信息，“hostUrl”是gRPC(客户端)呼叫的URL。第三，它用我们新建的记录器创建了一个新的跟踪器(tracer)。 最后，它为“OpenTracing”设置了“GlobalTracer”，这样你可以在程序中的任何地方访问它。

const (     endpoint_url = "http://localhost:9411/api/v1/spans"     host_url = "localhost:5051"     service_name_cache_client = "cache service client"     service_name_call_get = "callGet" )  func newTracer () (opentracing.Tracer, zipkintracer.Collector, error) {     collector, err := openzipkin.NewHTTPCollector(endpoint_url)     if err != nil {         return nil, nil, err     }     recorder :=openzipkin.NewRecorder(collector, true, host_url, service_name_cache_client)     tracer, err := openzipkin.NewTracer(         recorder,         openzipkin.ClientServerSameSpan(true))      if err != nil {         return nil,nil,err     }     opentracing.SetGlobalTracer(tracer)      return tracer,collector, nil }

以下是gRPC客户端代码。 它首先调用上面提到的函数“newTrace()”来创建跟踪器，然后，它创建一个包含跟踪器的gRPC调用连接。接下来，它使用新建的gRPC连接创建缓存服务(Cache service)的gRPC客户端。 最后，它通过gRPC客户端来调用缓存服务的“Get”函数。

key:="123"     tracer, collector, err :=newTracer()     if err != nil {         panic(err)     }     defer collector.Close()     connection, err := grpc.Dial(host_url,         grpc.WithInsecure(), grpc.WithUnaryInterceptor(otgrpc.OpenTracingClientInterceptor(tracer, otgrpc.LogPayloads())),         )     if err != nil {         panic(err)     }     defer connection.Close()     client := pb.NewCacheServiceClient(connection)     value, err := callGet(key, client)

Trace 和 Span:

在OpenTracing中，一个重要的概念是“trace”，它表示从头到尾的一个请求的调用链，它的标识符是“traceID”。 一个“trace”包含有许多跨度(span)，每个跨度捕获调用链内的一个工作单元，并由“spanId”标识。 每个跨度具有一个父跨度，并且一个“trace”的所有跨度形成有向无环图(DAG)。 以下是跨度之间的关系图。 你可以从The OpenTracing Semantic Specification中找到它。

以下是函数“callGet”的代码，它调用了gRPC服务端的“Get"函数。 在函数的开头，OpenTracing为这个函数调用开启了一个新的span，整个函数结束后，它也结束了这个span。

 const service_name_call_get = "callGet"  func callGet(key string, c pb.CacheServiceClient) ( []byte, error) {     span := opentracing.StartSpan(service_name_call_get)     defer span.Finish()     time.Sleep(5*time.Millisecond)     // Put root span in context so it will be used in our calls to the client.     ctx := opentracing.ContextWithSpan(context.Background(), span)     //ctx := context.Background()     getReq:=&pb.GetReq{Key:key}     getResp, err :=c.Get(ctx, getReq )     value := getResp.Value     return value, err }

服务端代码:

下面是服务端代码，它与客户端代码类似，它调用了“newTracer()”(与客户端“newTracer()”函数几乎相同)来创建跟踪器。然后，它创建了一个“OpenTracingServerInterceptor”，其中包含跟踪器。 最后，它使用我们刚创建的拦截器(Interceptor)创建了gRPC服务器。

connection, err := net.Listen(network, host_url)     if err != nil {         panic(err)     }     tracer,err  := newTracer()     if err !=