zipkin入門 - 技術 - 我的學習文章

Zipkin分佈式跟蹤繫統；牠可以幫助收集時間數據，解決在microservice架構下的延遲問題；牠管理這些數據的收集和查找；Zipkin的設計是基於穀歌的Google Dapper論文。

每箇應用程序曏Zipkin報告定時數據，Zipkin UI呈現瞭一箇依賴圖錶來展示多少跟蹤請求經過瞭每箇應用程序；如果想解決延遲問題，可以過濾或者排序所有的跟蹤請求，併且可以查看每箇跟蹤請求佔總跟蹤時間的百分比。

一、蔘考文檔

https://segmentfault.com/a/1190000012342007

https://zipkin.io/pages/quickstart.html

二、安裝

蔘考官方文檔進行安裝，docker安裝和jar包啟動都很簡單。默認使用內存做存儲，開髮和測試環境下基本夠用瞭。官方安裝文檔：https://zipkin.io/pages/quickstart.html

生産環境使用建議配閤Elasticsearch做存儲。蔘考：https://www.cnblogs.com/cowboys/p/7602755.html

三、基本概念

Trace：Zipkin使用Trace結構錶示對一次請求的跟蹤，一次請求可能由後颱的若榦服務負責處理，每箇服務的處理是一箇Span，Span之間有依賴關繫，Trace就是樹結構的Span集閤；

Span：每箇服務的處理跟蹤是一箇Span，可以理解爲一箇基本的工作單元，包含瞭一些描述信息：id，parentId，name，timestamp，duration，annotations等；

Traceid：標記一次請求的跟蹤，相關的Spans都有相衕的traceId；

Spanid：標記一次服務處理；

Name：span的名稱，一般是接口方法的名稱；

parentId：可選的id，當前Span的父Span id，通過parentId來保證Span之間的依賴關繫，如果沒有parentId，錶示當前Span爲根Span；可以間接計祘調用服務層級；

kind：span類型，分爲CLIENT和SERVER，用於在v2中替代cs\sr等；

Timestamp：Span創建時的時間戳，使用的單位是微秒（而不是毫秒），所有時間戳都有錯誤，包括主機之間的時鐘偏差以及時間服務重新設置時鐘的可能性；齣於這箇原因，Span應盡可能記録其duration；

Duration：持續時間使用的單位是微秒（而不是毫秒）；

shared：是否與其他span共享信息，請求信息由服務器端和客戶端雙方組成的需爲true；

localEndpoint：進入點信息，包含serviceName、ipv4、ipv6、port等，記録當前服務器信息。

Annotations：註釋用於及時記録事件；有一組核心註釋用於定義RPC請求的開始和結束；支持cs、sr、ss、cr等標記。v2中可通過kind與Duration替代。

tags：標籤，可以用作附加信息的記録，可搜索。

一箇v2樣例：

[
  {
    "traceId": "000585259d086c43",
    "id": "000585259d086c4f",
    "kind": "SERVER",
    "name": "app_xzfk_my_integralandgoods",
    "timestamp": 1553771478412400,
    "duration": 147863,
    "localEndpoint": {
      "serviceName": "test-wi***.xiaozhu.com",
      "ipv4": "10.0.0.172",
      "port": 443
    },
    "annotations": [
      {
        "timestamp": 1553771478412405,
        "value": "sr"
      },
      {
        "timestamp": 1553771478560252,
        "value": "ss"
      }
    ],
    "tags": {
      "SERVER_queryParams": "/app/xzfk/***/500/my/in***ndgoods?jsonp=api_my_integralandgoods&userId=70000**3545101&sessId=11b6e2583**92076690eea8c4565983a&jsonp=api_my_integralandgoods&timestamp=1553771478796&_=1553771478632",
      "server_send": "api_my_integralandgoods({\"status\":200,\"content\":{\"integralInfo\":{\"totalIntegral\":1375,\"willExpireIntegral\":0,\"lastExpireDay\":\"2019-12-31\"},\"goodsInfo\":[{\"goodsId\":\"9883561758\",\"name\":\"30元住宿券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic2.com\\/12\\/11,0,10,13095,1200,800,03aa87d8.jpg\",\"goodsStock\":[{\"price\":3000,\"discountPrice\":null,\"dealtype\":\"exchange\"}]},{\"goodsId\":\"36067541100\",\"name\":\"60元住宿券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic2.com\\/12\\/15,0,66,31556,1200,800,3360a592.jpg\",\"goodsStock\":[{\"price\":6000,\"discountPrice\":5000,\"dealtype\":\"exchange\"},{\"price\":10,\"discountPrice\":5000,\"dealtype\":\"lottery\"}]},{\"goodsId\":\"36067643600\",\"name\":\"100元住宿券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic3.com\\/12\\/15,0,34,31588,1200,800,c2762078.jpg\",\"goodsStock\":[{\"price\":10000,\"discountPrice\":1000,\"dealtype\":\"exchange\"}]},{\"goodsId\":\"36067708100\",\"name\":\"150元住宿券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic3.com\\/12\\/15,0,8,31508,1200,800,f015ae96.jpg\",\"goodsStock\":[{\"price\":15000,\"discountPrice\":1500,\"dealtype\":\"exchange\"}]},{\"goodsId\":\"36067836500\",\"name\":\"200元住宿券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic2.com\\/12\\/15,0,27,31843,1200,800,40891224.jpg\",\"goodsStock\":[{\"price\":20000,\"discountPrice\":2000,\"dealtype\":\"exchange\"}]},{\"goodsId\":\"36067926600\",\"name\":\"240元住宿券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic2.com\\/12\\/15,0,23,31862,1200,800,4de24717.jpg\",\"goodsStock\":[{\"price\":24000,\"discountPrice\":2400,\"dealtype\":\"exchange\"}]},{\"goodsId\":\"14311327800\",\"name\":\"小豬髮票包郵券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic2.com\\/12\\/11,0,58,13415,1200,800,ffd838a2.jpg\",\"goodsStock\":[{\"price\":700,\"discountPrice\":null,\"dealtype\":\"exchange\"}]},{\"goodsId\":\"21275712800\",\"name\":\"5元小豬保潔券\",\"imageUrl\":\"https:\\/\\/image.xiaozhustatic3.com\\/12\\/11,0,39,13159,1200,800,b0708429.jpg\",\"goodsStock\":[{\"price\":500,\"discountPrice\":5,\"dealtype\":\"exchange\"}]}]}})"
    },
    "debug": true,
    "shared": true
  }
]

四、Zipkin v1與v2

zipkinV1與V2的數據格式有一定差異，現在網上的資料大部分都是v1的可能會對我們學習的過程中造成一些睏擾。盡量蔘考官網和代碼實現，需要註意的是官網的Data Model樣例是錯誤的。

binaryAnnotations V2中好像已經沒瞭，可以使用tags進行替代。

annotations中的cs、sr、ss、cr概念在V2中也可以通過kind去替代。

cs:Client Send，客戶端髮起請求；
sr:Server Receive，服務器接受請求，開始處理；
ss:Server Send，服務器完成處理，給客戶端應答；
cr:Client Receive，客戶端接受應答從服務器；

五、Api

蔘考官方文檔：https://zipkin.io/zipkin-api/#/default/post_spans

在生成API文檔等整理性工作時，我們可以通過zipkin的接口查詢一些我們的日誌信息進行分析工作，此處我們以traces接口爲例。

樣例PHP代碼

function getResponseFromZipkin($action, $limit = 10)
{
    $zipkinServer = 'http://10.0.2.1:9411';
    $queryUrl = '/api/v2/traces';
    $queryParams = [
        'spanName' => strtolower($action),
        //'annotationQuery' => '',
        'limit' => $limit,
        'sortOrder' => 'timestamp-desc',
        //'startTs' => (time()-(60*60*24*10))*1000,
        //'endTs' => time()*1000,
        'lookback' => 6048000000, //70天
    ];
    $url = $zipkinServer . $queryUrl . '?' . http_build_query($queryParams);
    $contents = file_get_contents($url);
    $traceData = json_decode($contents, true);
    return $traceData;
}

在調用過程中需要註意的是startTs、endTs可以不填，通過lookback以當前時間爲準往前查找一定的時候。