以編寫Redis客戶端Agent 插件為例SkyWalking之Java 插件貢獻實踐技术頭條網

以編寫Redis客戶端Agent 插件為例SkyWalking之Java 插件貢獻實踐

2019-01-23 14:50:08 Java小可愛

基礎概念

OpenTracing和SkyWalking鏈路模塊幾個很重要的語義概念。

Span:可理解為一次方法調用，一個程序塊的調用，或一次RPC/數據庫訪問。只要是一個具有完整時間週期的程序訪問，都可以被認為是一個span。SkyWalking Span對象中的重要屬性
屬性名稱備註 component 組件插件的組件名稱，如：Lettuce，詳見:ComponentsDefine.Class。 tag 標籤 k-v結構，關鍵標籤，key詳見：Tags.Class。 peer 對端資源用於拓撲圖，若DB組件，需記錄集群信息。 operationName 操作名稱若span=0，operationName將會搜索的下拉列表。 layer 顯示在鏈路頁顯示，詳見SpanLayer.Class。
Trace:調用鏈，通過歸屬於其的Span來隱性的定義。一條Trace可被認為是一個由多個Span組成的有向無環圖（DAG圖），在SkyWalking鏈路模塊你可以看到，Trace又由多個歸屬於其的trace segment組成。
Trace segment:Segment是SkyWalking中的一個概念，它應該包括單個OS進程中每個請求的所有範圍，通常是基於語言的單線程。由多個歸屬於本線程操作的Span組成。

核心API

跨進程ContextCarrier核心API

為了實現分佈式跟蹤，需要綁定跨進程的跟蹤，並且應該傳播上下文整個過程。這就是ContextCarrier的職責。

以下是實現有關跨進程傳播的步驟：
在客戶端，創建一個新的空的ContextCarrier，將ContextCarrier所有信息放到HTTP heads、Dubbo attachments 或者Kafka messages。
通過服務調用，將ContextCarrier傳遞到服務端。
在服務端，在對應組件的heads、attachments或messages獲取ContextCarrier所有消息。將服務端和客戶端的鏈路信息綁定。

跨線程ContextSnapshot核心API

除了跨進程，跨線程也是需要支持的，例如異步線程（內存中的消息隊列）和批處理在Java中很常見，跨進程和跨線程十分相似，因為都是需要傳播上下文。唯一的區別是，不需要跨線程序列化。
以下是實現有關跨線程傳播的步驟：
使用ContextManager＃capture獲取ContextSnapshot對象。
讓子線程以任何方式，通過方法參數或由現有參數攜帶來訪問ContextSnapshot。
在子線程中使用ContextManager#continued。

插件實踐

Lettuce操作redis代碼

@PostMapping("/ping")
public String ping(HttpServletRequest request) throws ExecutionException, InterruptedException {
 RedisClient redisClient = RedisClient.create("redis://" + "127.0.0.1" + ":6379");
 StatefulRedisConnection<string> connection0 = redisClient.connect();
 RedisAsyncCommands<string> asyncCommands0 = connection0.async();
 AsyncCommand<string> future = (AsyncCommand<string>)asyncCommands0.set("key_a", "value_a");
 future.onComplete(s -> OkHttpClient.call("http://skywalking.apache.org"));
 future.get();
 connection0.close();
 redisClient.shutdown();
 return "pong";
}

/<string>/<string>/<string>/<string>

插件源碼架構

Lettuce對Redis封裝與Redisson Redisson 類似，目的均是實現簡單易用，且無學習曲線的Java的Redis客戶端。所以要是先對Redis操作的攔截，需要學習對應客戶端的源碼。

設計插件