調用鏈系列（1）：解讀UAVStack中的貪吃蛇

1、背景

對於分佈式在線服務，一個請求須要通過多個系統中多個模塊，可能多達上百臺機器的協做才能完成單次請求。這種場景下單靠人力沒法掌握整個請求中各個階段的性能開銷，更沒法快速的定位系統中性能瓶頸。當發生故障時一般須要查看大量日誌跨越多個團隊來確認問題。

2、舉個栗子

程序猿小亮做爲一個在職場摸爬滾打多年資深工程師，他可能面臨的系統設計是這個樣子的，以下圖。

（圖片來自於網絡）

藉助良好的系統設計和編碼規範，對於通常有問題的請求處理，小亮依據本身對多個系統的瞭解經過翻閱大量的日誌文件（前提是日誌輸出也須要規範）花費兩個小時來定位到問題。隨着用戶的不斷增加系統複雜度也呈現指數增加，小亮的大部分時間都浪費在了團隊溝通之類的工做上。小亮的幸福指數也像系統複雜度同樣呈現指數降低。

小亮這時可能會想，要是有一個東西能把每次請求通過的系統都記錄下來，要是能把每一個節點消耗時間、處理類神馬的信息也抓出來那這個世界得多麼美好。

一個偶然的機會小亮知道了UAVStack其中一個叫作調用鏈的神奇功能，在對業務代碼沒有任何侵入的前提下輕鬆解決了他的難題。下面就讓咱們一塊兒來開啓一段探索UAVStack的神奇之旅。

UAVStack調用鏈技術棧支持

3、效果展現

輕型調用鏈展現詳情：

重調用鏈開啓之後請求報文體抓取視圖：

更多使用技巧和說明請參閱官網：https://uavorg.github.io/docu..._useroperation/91.html（用戶指南中調用鏈部分）。

4、具體實現

UAVStack調用鏈實現分爲模型設計、服務端信息收集（輕/重）、方法級信息收集（輕/重）、客戶端信息收集（輕/重）、調用鏈協議設計（輕/重）、調用鏈上下文傳遞、調用信息記錄及傳遞、調用數據統計處理等。因爲篇幅限制，本期暫時只分享其中的模型設計及實現調用鏈模型時序圖。

5、模型設計

借鑑前人經驗並揉合具體業務場景需求，抽象出了以下調用鏈模型：

調用鏈元數據：

1）SpanEndpointType：調用類型（Root(「E」),Service(「S」), Client(「C」), Method(「M」)）；

Root指本條調用鏈中的第一個節點，即一條調用鏈的開始位置，能夠是一個服務請求，一次httpclient調用等；

Service指當前調用鏈中非第一個節點且是系統中對外提供的服務，如用戶登陸服務；

Client指當前調用鏈中非第一個節點且是當前系統與外部溝通的一種途徑，如httpclient、mongoclient等；

Method值當前調用鏈中非第一個節點且是系統中的一個函數，如日誌數出函數等。

2）traceId：調用鏈惟一標識符；

3）spanId：一條調用鏈中當前節點的調用順序（與SpanEndpointType 結合惟一）；spanId採用分層設計，形如1.2.1，既能表示調用順序同時又能反應所才調用鏈層級；

4）parentId：一條調用鏈中當前節點的父調用節點。

調用鏈繪製規則：

1）調用者（服務、web）最初調用（無父調用）記爲開始節點E，並生成惟一調用鏈ID，traceID；

2）系統內應用組件調用（如httpclient，方法調用等），spanId末尾數字加1（若爲第一個則末尾加.1）；

3）系統間調用（如A服務調用B服務），A服務與B服務span信息只有SpanEndpointType不一樣（分別對應span的兩個端）。

舉個栗子

背景介紹：用戶小明想經過網絡獲取一些知識，經過網絡他進入了系統O。服務O中部署了服務A和B，A服務使用httpclient與B通信，B服務先會與redis交互而後和myql交互，最後系統O將小明感興趣的內容返回給小明；

完成這次請求UAV抽象出以下調用鏈模型：

1）小明（下圖中的調用方）經過門戶訪問了A服務，此時調用鏈生成惟一traceId並將當前節點的SpanEndpointType置爲N（第一個節點的意思），spanId置爲1（當前調用層中的第一個節點），parentId置爲E（沒有父節點的意思）；

2）A服務經過httpclient向B服務發起一次http請求，此時調用鏈元數據以下traceId（沿用父節點id）;1.1（spanId末尾加.1,由於爲第一次調用）;1（parentId父節點的spanId）;C（調用類型記錄爲C客戶端調用）；

3）B服務接收到來自於A服務經過httpclient的調用，此時調用鏈元數據以下traceId（沿用初始調用時id）;1.1（spanId沿用傳遞過來的spanId）;1（parentId沿用傳遞過來的parentId）;S（調用類型記錄爲S服務端處理請求）；

4）B服務先查詢redis，此時調用鏈元數據以下traceId（沿用初始調用時id）;1.1.1（spanId末尾加.1,由於爲第一次調用）;1.1（parentId父節點的spanId）;C（調用類型記錄爲C客戶端調用）；

5）B服務又發起對mysql的查詢，此時調用鏈元數據以下traceId（沿用初始調用時id）;1.1.2（spanId末尾數字加1，由於爲非第一次調用）;1.1（parentId父節點的spanId）;C（調用類型記錄爲C客戶端調用）；

6）處理結束，調用鏈將記錄的信息進行記錄。

調用鏈時序圖

UAVServer：中間件加強框架，提供在中間件的不一樣生命週期進行劫持的能力，即中間件劫持技術，如tomcat webcontainer啓動開始時刻等；

JEEServiceRunGlobalFilterHandler：藉助中間件劫持技術延伸出的全局filter，可以攔截全部通過中間件（tomcat等）的請求；

ServiceSpanInvokeChainHandler：調用鏈中專一處理歸爲Service類型節點的handler；

ClientSpanInvokeChainHandler：調用鏈中專一處理歸爲Client類型節點的handler；

XXAdapter：泛指調用鏈中全部的adapter，提供在handler（分爲Service、Client、Method三種handler，圖中省略了Method類型）執行動做before和after時刻操做數據的能力。

實現對用戶代碼無任何」侵入」的前提下完成調用鏈的生成，過程大體分爲以下幾個過程：

1）在JEEServiceRunGlobalFilterHandler的doRepuest中包裝解析請求；

2）xxAdapter中的before對數據進行適配；

3）xxHandler處理對應範圍內（Service、Client和Method）內請求數據；

4）xxAdapter中的after對數據進行整理或記錄；

5）在JEEServiceRunGlobalFilterHandler的doResponse中返回處理事後請求。

6、總結

本文主要目的是讓讀者對UAVStack的調用鏈有一個總體的認識，初步瞭解一條調用鏈繪製的大體生命週期，具體的實現將在之後的分享中詳細介紹。

做者：李崇