Net和Java基于zipkin的全鍊路追蹤

　　在各大廠分布式鍊路跟蹤系統架構對比中已經介紹了幾大架構的對比，如果想用免費的可以用zipkin和pinpoint還有一個忘了介紹：SkyWalking，具體介紹可參考：https://github.com/apache/incubator-skywalking/blob/master/README_ZH.md

　　由于追蹤的要求是Net平台和Java平台都要支援，對于java平台各元件都是天生的支援的，但對于net的支援找了些開源元件，發現Pinpoint和SkyWalking給出的Demo都是基于NetCore（SkyWalking可以在github上搜skywalking-netcore，Pinpoint沒有好的推薦），版本要求比較高，但不可能更改現有平台的FW架構，Zipkin有開源項目 Medidata.zipkinTracerModule 、zipkin.net、zipkin-csharp，網上依次推薦是從前到後，經過測試發現Medidata.zipkinTracerModule、zipkin.net也是用于Net Core的，在NuGet上安裝報錯。最後測試zipkin-csharp（https://github.com/openzipkin-attic/zipkin-csharp）可以成功，在NuGet中搜尋Zipkin.Core，現在版本也隻有一個，如下：

然後檢視給出的demo中代碼：zipkin-csharp/examples/ZipkinExample/Program.cs

using System;
using System.Net;
using System.Threading;
using Zipkin;
using Zipkin.Tracer.Kafka;

namespace ZipkinExample
{
    class Program
    {
        static void Main(string[] args)
        {
            var random = new Random();
            // make sure Zipkin with Scribe client is working
            //var collector = new HttpCollector(new Uri("http://localhost:9411/"));
            var collector = new KafkaCollector(KafkaSettings.Default);
            var traceId = new TraceHeader(traceId: (ulong)random.Next(), spanId: (ulong)random.Next());
            var span = new Span(traceId, new IPEndPoint(IPAddress.Loopback, 9000), "test-service");
            span.Record(Annotations.ClientSend(DateTime.UtcNow));
            Thread.Sleep(100);
            span.Record(Annotations.ServerReceive(DateTime.UtcNow));
            Thread.Sleep(100);
            span.Record(Annotations.ServerSend(DateTime.UtcNow));
            Thread.Sleep(100);
            span.Record(Annotations.ClientReceive(DateTime.UtcNow));

            collector.CollectAsync(span).Wait();
        }
    }
}

　　可以看出這裡的traceId和spanId都是随機生成的，在這裡推薦自己生成ID，注意是ulong型，這裡毫秒數隻格式化兩位（資料庫的位數20位，會超），也可以用更保險的其它方法。

/// <summary>
        /// 獲得随機數
        /// </summary>
        /// <returns></returns>
        private static ulong getRandom()
        {
            var random = new Random();
            return ulong.Parse(DateTime.Now.ToString("yyyyMMddHHmmssff") + random.Next(100, 999));
        }
    }

　　collector這裡使用Http來接收，注釋kafka的，放開http的。去掉 collector.CollectAsync(span).Wait(); 中的Wait。

Zipkin的幾個基本概念

Span：基本工作單元，一次鍊路調用（可以是RPC，DB等沒有特定的限制）建立一個span，通過一個64位ID辨別它， span通過還有其他的資料，例如描述資訊，時間戳，key-value對的（Annotation）tag資訊，parent-id等，其中parent-id 可以表示span調用鍊路來源，通俗的了解span就是一次請求資訊

Trace：類似于樹結構的Span集合，表示一條調用鍊路，存在唯一辨別，即TraceId

Annotation：注解，用來記錄請求特定事件相關資訊（例如時間），通常包含四個注解資訊

cs - Client Start，表示用戶端發起請求

sr - Server Receive，表示服務端收到請求

ss - Server Send，表示服務端完成處理，并将結果發送給用戶端

cr - Client Received，表示用戶端擷取到服務端傳回資訊

BinaryAnnotation：提供一些額外資訊，一般以key-value對出現

啟動服務端測試

下載下傳 https://github.com/openzipkin/zipkin/releases 最近的穩定版 release-2.7.1的jar包，這裡采用mysql的型式儲存記錄，是以需要建立資料庫zipkin，建立表：

SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for `zipkin_annotations`
-- ----------------------------
DROP TABLE IF EXISTS `zipkin_annotations`;
CREATE TABLE `zipkin_annotations` (
  `trace_id_high` bigint(20) NOT NULL DEFAULT '0' COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
  `trace_id` bigint(20) NOT NULL COMMENT 'coincides with zipkin_spans.trace_id',
  `span_id` bigint(20) NOT NULL COMMENT 'coincides with zipkin_spans.id',
  `a_key` varchar(255) NOT NULL COMMENT 'BinaryAnnotation.key or Annotation.value if type == -1',
  `a_value` blob COMMENT 'BinaryAnnotation.value(), which must be smaller than 64KB',
  `a_type` int(11) NOT NULL COMMENT 'BinaryAnnotation.type() or -1 if Annotation',
  `a_timestamp` bigint(20) DEFAULT NULL COMMENT 'Used to implement TTL; Annotation.timestamp or zipkin_spans.timestamp',
  `endpoint_ipv4` int(11) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',
  `endpoint_ipv6` binary(16) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null, or no IPv6 address',
  `endpoint_port` smallint(6) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',
  `endpoint_service_name` varchar(255) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',
  UNIQUE KEY `trace_id_high` (`trace_id_high`,`trace_id`,`span_id`,`a_key`,`a_timestamp`) COMMENT 'Ignore insert on duplicate',
  UNIQUE KEY `trace_id_high_4` (`trace_id_high`,`trace_id`,`span_id`,`a_key`,`a_timestamp`) COMMENT 'Ignore insert on duplicate',
  KEY `trace_id_high_2` (`trace_id_high`,`trace_id`,`span_id`) COMMENT 'for joining with zipkin_spans',
  KEY `trace_id_high_3` (`trace_id_high`,`trace_id`) COMMENT 'for getTraces/ByIds',
  KEY `endpoint_service_name` (`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames',
  KEY `a_type` (`a_type`) COMMENT 'for getTraces',
  KEY `a_key` (`a_key`) COMMENT 'for getTraces',
  KEY `trace_id` (`trace_id`,`span_id`,`a_key`) COMMENT 'for dependencies job',
  KEY `trace_id_high_5` (`trace_id_high`,`trace_id`,`span_id`) COMMENT 'for joining with zipkin_spans',
  KEY `trace_id_high_6` (`trace_id_high`,`trace_id`) COMMENT 'for getTraces/ByIds',
  KEY `endpoint_service_name_2` (`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames',
  KEY `a_type_2` (`a_type`) COMMENT 'for getTraces',
  KEY `a_key_2` (`a_key`) COMMENT 'for getTraces',
  KEY `trace_id_2` (`trace_id`,`span_id`,`a_key`) COMMENT 'for dependencies job'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

-- ----------------------------
-- Records of zipkin_annotations
-- ----------------------------

-- ----------------------------
-- Table structure for `zipkin_dependencies`
-- ----------------------------
DROP TABLE IF EXISTS `zipkin_dependencies`;
CREATE TABLE `zipkin_dependencies` (
  `day` date NOT NULL,
  `parent` varchar(255) NOT NULL,
  `child` varchar(255) NOT NULL,
  `call_count` bigint(20) DEFAULT NULL,
  `error_count` bigint(20) DEFAULT NULL,
  UNIQUE KEY `day` (`day`,`parent`,`child`),
  UNIQUE KEY `day_2` (`day`,`parent`,`child`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

-- ----------------------------
-- Records of zipkin_dependencies
-- ----------------------------

-- ----------------------------
-- Table structure for `zipkin_spans`
-- ----------------------------
DROP TABLE IF EXISTS `zipkin_spans`;
CREATE TABLE `zipkin_spans` (
  `trace_id_high` bigint(20) NOT NULL DEFAULT '0' COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
  `trace_id` bigint(20) NOT NULL,
  `id` bigint(20) NOT NULL,
  `name` varchar(255) NOT NULL,
  `parent_id` bigint(20) DEFAULT NULL,
  `debug` bit(1) DEFAULT NULL,
  `start_ts` bigint(20) DEFAULT NULL COMMENT 'Span.timestamp(): epoch micros used for endTs query and to implement TTL',
  `duration` bigint(20) DEFAULT NULL COMMENT 'Span.duration(): micros used for minDuration and maxDuration query',
  UNIQUE KEY `trace_id_high` (`trace_id_high`,`trace_id`,`id`) COMMENT 'ignore insert on duplicate',
  UNIQUE KEY `trace_id_high_4` (`trace_id_high`,`trace_id`,`id`) COMMENT 'ignore insert on duplicate',
  KEY `trace_id_high_2` (`trace_id_high`,`trace_id`,`id`) COMMENT 'for joining with zipkin_annotations',
  KEY `trace_id_high_3` (`trace_id_high`,`trace_id`) COMMENT 'for getTracesByIds',
  KEY `name` (`name`) COMMENT 'for getTraces and getSpanNames',
  KEY `start_ts` (`start_ts`) COMMENT 'for getTraces ordering and range',
  KEY `trace_id_high_5` (`trace_id_high`,`trace_id`,`id`) COMMENT 'for joining with zipkin_annotations',
  KEY `trace_id_high_6` (`trace_id_high`,`trace_id`) COMMENT 'for getTracesByIds',
  KEY `name_2` (`name`) COMMENT 'for getTraces and getSpanNames',
  KEY `start_ts_2` (`start_ts`) COMMENT 'for getTraces ordering and range'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

-- ----------------------------
-- Records of zipkin_spans
-- ----------------------------

啟動

進入程式的目前目錄啟動，注意參數内容，如果想要儲存到elasticsearch，需要按官方文檔更改。

java -jar zipkin-server-2.7.1.jar --STORAGE_TYPE=mysql --MYSQL_DB=zipkin --MYSQL_USER=root --MYSQL_PASS=123456 --MYSQL_HOST=localhost --MYSQL_TCP_PORT=3306

啟動後看到如下内容表明成功。

啟動成功後浏覽器通路 http://localhost:9411/

　　至此服務端和展示頁面已經啟動，不過功能還是很簡單的，具體的使用可另行查詢資料。

　　這裡用來測試的服務采用網友提供的源碼：mircoservice分布式跟蹤系統（zipkin+springboot） https://github.com/dreamerkr/mircoservice，文章可參考：微服務之分布式跟蹤系統（springboot+zipkin）https://blog.csdn.net/qq_21387171/article/details/53787019

用預設配置分别運作4個用戶端服務後運作效果：

（1）分别啟動每個服務，然後通路服務1，浏覽器通路（http://localhost:8081/service1/test）

（2）輸入zipkin位址，每次trace的清單

點選其中的trace，可以看trace的樹形結構，包括每個服務所消耗的時間：

點選每個span可以擷取延遲資訊：

同時可以檢視服務之間的依賴關系：

測試Net平台程式

将demo代碼改為：

static void Main(string[] args)
        {
            var random = new Random();
            // make sure Zipkin with Scribe client is working
            var collector = new HttpCollector(new Uri("http://localhost:9411/"));
            //var collector = new KafkaCollector(KafkaSettings.Default);
            var traceId = new TraceHeader(traceId: (ulong)random.Next(), spanId: (ulong)random.Next());
            var span = new Span(traceId, new IPEndPoint(IPAddress.Loopback, 9000), "zipkinweb");
            span.Record(Annotations.ClientSend(DateTime.UtcNow));
            Thread.Sleep(100);
            span.Record(Annotations.ServerReceive(DateTime.UtcNow));
            Thread.Sleep(100);
            span.Record(Annotations.ServerSend(DateTime.UtcNow));
            Thread.Sleep(100);
            span.Record(Annotations.ClientReceive(DateTime.UtcNow));

            collector.CollectAsync(span);
        }

然後運作一次再檢視，會多出一條資訊

點進去會看到請求的詳細資訊和備注資訊：

右上角檢視json

　　驗證了NET平台下是可以成功調用的，而且可以看到zipkin服務前端展示是通過api請求的，前背景分開的，是以我們可以以此來做二次開發，我們知道了資料結構或者通過自己請求資料庫内容做更複雜的業務前端。

　　這裡強調一點的是net最好用framework4.5以上的版本，由net的demo來看其實封裝性不高，是以靈活性能很高，需要自己進一步封裝才能達到代碼的侵入性更少，性能更高。後面考慮到性能和資料量可改用kafka接收和ES儲存資料。

作者：歡醉

公衆号【一個碼農的日常】技術群：319931204 1号群： 437802986 2号群： 340250479

出處：http://zhangs1986.cnblogs.com/

碼雲：https://gitee.com/huanzui

本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接配接，否則保留追究法律責任的權利。

Top

Net和Java基于zipkin的全鍊路追蹤

繼續閱讀

鍊路追蹤之sleuth全生命周期分析

springcloud-sleuth & zipkin 初步配置Sleuth & zipkin

SpringCloud系列十：使用zipkin進行服務鍊路追蹤

部署Zipkin分布式性能追蹤日志系統的操作記錄(npm安裝)

微服務AlibabaCloud第十三講——微服務AlibabaCloud中的鍊路追蹤系統詳解和實操（已完結）一、微服務調用鍊路常見問題二、什麼是鍊路追蹤系統

spring cloud zipkin 頁面詳解

Spring Cloud Sleuth-Zipkin鍊路追蹤使用說明1.簡介2.術語3.架構4.實戰

zipkin連接配接mysql時出現的一點小問題記錄zipkin連接配接mysql時出現的一點小問題記錄

Spring Cloud(七)可視化鍊路追蹤Zipkin

Mac下安裝zipkin-server位址及配置

Springboot 整合 SpringCloud元件-ZipKin &Sleuth 服務鍊路追蹤 (五)

Spring Cloud Sleuth--服務鍊路追蹤(二)

Spring Cloud（十九）：Sleuth分布式請求鍊路追蹤

SpringCloud-鍊路追蹤sleuth

SpringCloud（九）Sleuth 分布式請求鍊路跟蹤前言一、安裝 zipkin-server二、使用步驟總結感謝B站尚矽谷的老師 ~~~