SkyWalking Java 插件貢獻實踐

時間 2019-11-07

原文原文鏈接

引言

《SkyWalking Java 插件貢獻實踐》：本文將基於SkyWalking 6.0.0-GA-SNAPSHOT版本，以編寫Redis客戶端Lettuce的SkyWalking Java Agent 插件爲例，與你們分享我貢獻PR的過程，但願對你們瞭解SkyWalking Java Agent插件有所幫助。java

基礎概念

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

Span:可理解爲一次方法調用，一個程序塊的調用，或一次RPC/數據庫訪問。只要是一個具備完整時間週期的程序訪問，均可以被認爲是一個span。SkyWalking Span對象中的重要屬性github

屬性	名稱	備註
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組成。redis
Trace segment:Segment是SkyWalking中的一個概念，它應該包括單個OS進程中每一個請求的全部範圍，一般是基於語言的單線程。由多個歸屬於本線程操做的Span組成。docker

核心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。

詳盡的核心API相關知識，可點擊閱讀《插件開發指南-中文版本》數據庫

插件實踐

Lettuce操做redis代碼

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