帶入gRPC：分佈式鏈路追蹤 gRPC-Opentracing-Zipkin

時間 2019-11-08

標籤帶入 grpc 分佈式鏈路追蹤 opentracing zipkin 欄目系統架構简体版

原文原文鏈接

原文地址：帶入gRPC：分佈式鏈路追蹤 gRPC + Opentracing + Zipkin
項目地址：https://github.com/EDDYCJY/go...html

前言

在實際應用中，你作了那麼多 Server 端，寫了 N 個 RPC 方法。想看看方法的指標，卻無處下手？git

本文將經過 gRPC + Opentracing + Zipkin 搭建一個分佈式鏈路追蹤系統來實現查看整個系統的鏈路、性能等指標 🤓github

Opentracing

是什麼

OpenTracing 經過提供平臺無關、廠商無關的API，使得開發人員可以方便的添加（或更換）追蹤系統的實現golang

不過 OpenTracing 並非標準。由於 CNCF 不是官方標準機構，可是它的目標是致力爲分佈式追蹤建立更標準的 API 和工具docker

名詞解釋

Trace

一個 trace 表明了一個事務或者流程在（分佈式）系統中的執行過程segmentfault

Span

一個 span 表明在分佈式系統中完成的單個工做單元。也包含其餘 span 的「引用」，這容許將多個 spans 組合成一個完整的 Trace後端

每一個 span 根據 OpenTracing 規範封裝如下內容：api

操做名稱
開始時間和結束時間
key:value span Tags
key:value span Logs
SpanContext

Logs

Span logs（跨度日誌）能夠記錄 Span 內特定時間或事件的日誌信息。主要用於捕獲特定 Span 的日誌信息以及應用程序自己的其餘調試或信息輸出app

SpanContext

SpanContext 表明跨越進程邊界，傳遞到子級 Span 的狀態。常在追蹤示意圖中建立上下文時使用

Baggage Items

Baggage Items 能夠理解爲 trace 全局運行中額外傳輸的數據集合

一個案例

圖中能夠看到如下內容：

執行時間的上下文
服務間的層次關係
服務間串行或並行調用鏈

結合以上信息，在實際場景中咱們能夠經過整個系統的調用鏈的上下文、性能等指標信息，一會兒就可以發現系統的痛點在哪兒

Zipkin

是什麼

Zipkin 是分佈式追蹤系統。它的做用是收集解決微服務架構中的延遲問題所需的時序數據。它管理這些數據的收集和查找

Zipkin 的設計基於 Google Dapper 論文。

運行

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

其餘方法安裝參見：https://github.com/openzipkin...

驗證

訪問 http://127.0.0.1:9411/zipkin/ 檢查 Zipkin 是否運行正常

gRPC + Opentracing + Zipkin

在前面的小節中，咱們作了如下準備工做：

瞭解 Opentracing 是什麼
搭建 Zipkin 提供分佈式追蹤系統的功能

接下來實現 gRPC 經過 Opentracing 標準 API 對接 Zipkin，再經過 Zipkin 去查看數據

目錄結構

新建 simple_zipkin_client、simple_zipkin_server 目錄，目錄結構以下：

go-grpc-example
├── LICENSE
├── README.md
├── client
│   ├── ...
│   ├── simple_zipkin_client
├── conf
├── pkg
├── proto
├── server
│   ├── ...
│   ├── simple_zipkin_server
└── vendor

安裝

$ go get -u github.com/openzipkin/zipkin-go-opentracing
$ go get -u github.com/grpc-ecosystem/grpc-opentracing/go/otgrpc

gRPC

Server

package main

import (
    "context"
    "log"
    "net"

    "github.com/grpc-ecosystem/go-grpc-middleware"
    "github.com/grpc-ecosystem/grpc-opentracing/go/otgrpc"
    zipkin "github.com/openzipkin/zipkin-go-opentracing"
    "google.golang.org/grpc"

    "github.com/EDDYCJY/go-grpc-example/pkg/gtls"
    pb "github.com/EDDYCJY/go-grpc-example/proto"
)

type SearchService struct{}

func (s *SearchService) Search(ctx context.Context, r *pb.SearchRequest) (*pb.SearchResponse, error) {
    return &pb.SearchResponse{Response: r.GetRequest() + " Server"}, nil
}

const (
    PORT = "9005"

    SERVICE_NAME              = "simple_zipkin_server"
    ZIPKIN_HTTP_ENDPOINT      = "http://127.0.0.1:9411/api/v1/spans"
    ZIPKIN_RECORDER_HOST_PORT = "127.0.0.1:9000"
)

func main() {
    collector, err := zipkin.NewHTTPCollector(ZIPKIN_HTTP_ENDPOINT)
    if err != nil {
        log.Fatalf("zipkin.NewHTTPCollector err: %v", err)
    }

    recorder := zipkin.NewRecorder(collector, true, ZIPKIN_RECORDER_HOST_PORT, SERVICE_NAME)

    tracer, err := zipkin.NewTracer(
        recorder, zipkin.ClientServerSameSpan(false),
    )
    if err != nil {
        log.Fatalf("zipkin.NewTracer err: %v", err)
    }

    tlsServer := gtls.Server{
        CaFile:   "../../conf/ca.pem",
        CertFile: "../../conf/server/server.pem",
        KeyFile:  "../../conf/server/server.key",
    }
    c, err := tlsServer.GetCredentialsByCA()
    if err != nil {
        log.Fatalf("GetTLSCredentialsByCA err: %v", err)
    }

    opts := []grpc.ServerOption{
        grpc.Creds(c),
        grpc_middleware.WithUnaryServerChain(
            otgrpc.OpenTracingServerInterceptor(tracer, otgrpc.LogPayloads()),
        ),
    }
    ...
}

zipkin.NewHTTPCollector：建立一個 Zipkin HTTP 後端收集器
zipkin.NewRecorder：建立一個基於 Zipkin 收集器的記錄器
zipkin.NewTracer：建立一個 OpenTracing 跟蹤器（兼容 Zipkin Tracer）
otgrpc.OpenTracingClientInterceptor：返回 grpc.UnaryServerInterceptor，不一樣點在於該攔截器會在 gRPC Metadata 中查找 OpenTracing SpanContext。若是找到則爲該服務的 Span Context 的子節點
otgrpc.LogPayloads：設置並返回 Option。做用是讓 OpenTracing 在雙向方向上記錄應用程序的有效載荷（payload）

總的來說，就是初始化 Zipkin，其又包含收集器、記錄器、跟蹤器。再利用攔截器在 Server 端實現 SpanContext、Payload 的雙向讀取和管理

Client

func main() {
    // the same as zipkin server
    // ...
    conn, err := grpc.Dial(":"+PORT, grpc.WithTransportCredentials(c),
        grpc.WithUnaryInterceptor(
            otgrpc.OpenTracingClientInterceptor(tracer, otgrpc.LogPayloads()),
        ))
    ...
}