在軟體工程中，Tracing指使用特定的日志記錄程式的執行資訊，與之相近的還有兩個概念，它們分別是Logging和Metrics，

Logging：用于記錄離散的事件，包含程式執行到某一點或某一階段的詳細資訊，比如，應用程式的除錯（debug）資訊或錯誤（error）資訊，它是我們診斷問題的依據，
Metrics：用于記錄可聚合的資料，且通常是固定型別的時序資料，每個都是一個邏輯計量單元，或者一個時間段內的柱狀圖，比如，佇列的當前深度可以被定義為一個計量單元，在寫入或讀取時被更新統計；輸入HTTP請求的數量可以被定義為一個計數器，用于簡單累加；請求的執行時間可以被定義為一個柱狀圖，在指定時間片上更新和統計匯總，
Tracing：用于記錄單次請求范圍內的處理資訊，其中包括服務呼叫和處理時長等，比如，一次呼叫遠程服務的RPC執行程序；一次實際的SQL查詢陳述句；一次HTTP請求的業務性ID，它是我們排查系統性能問題的利器，

系統架構從單體轉變為微服務以后，一次請求往往涉及到多個服務之間的呼叫，隨著服務數量的增多和內部呼叫鏈的復雜化，僅憑借日志和性能監控很難做到 “See the Whole Picture”，在進行問題排查或是性能分析的時候，無異于盲人摸象，

分布式追蹤系統（Tracing）旨在分析請求背后呼叫了哪些服務，服務的呼叫順序、耗時、錯誤原因等，幫助開發者直觀分析請求鏈路，快速定位性能瓶頸，逐漸優化服務間依賴，也有助于開發者從更宏觀的角度更好地理解整個分布式系統，

早在 2005 年，Google 就在內部部署了一套分布式追蹤系統 Dapper，并發表了一篇論文《Dapper, a Large-Scale Distributed Systems Tracing Infrastructure》，闡述了該分布式追蹤系統的設計和實作，可以視為分布式追蹤領域的鼻祖，隨后各大廠商紛紛落地了一些優秀的分布式追蹤系統，比如Jaeger（Uber）、Zipkin（twitter）、X-ray（AWS）、SkyWalking等，但各家的分布式追蹤方案很可能是互不兼容的，于是誕生了OpenTracing，

1. OpenTracing

OpenTracing是一個輕量級的標準化層，它位于<應用程式/類別庫>和<追蹤或日志分析程式>之間，通過提供平臺無關、廠商無關的API，使得開發人員能夠方便的添加（或更換）追蹤系統的實作，解決不同的分布式追蹤系統API不兼容的問題，也使得在通用代碼庫增加對分布式追蹤的支持成為可能，

后臺無關的一套介面，被跟蹤的服務只需要呼叫這套介面，就可以被任何實作這套介面的跟蹤后臺（比如Zipkin, Jaeger等等）支持，而作為一個跟蹤后臺，只要實作了個這套介面，就可以跟蹤到任何呼叫這套介面的服務，
標準化了對跟蹤最小單位Span的管理：定義了開始Span，結束Span和記錄Span耗時的API，
標準化了行程間跟蹤資料傳遞的方式：定義了一套API方便跟蹤資料的傳遞，
標準化了行程內當前Span的管理：定義了存盤和獲取當前Span的API，
不對編碼定標準：不對行程間傳遞的跟蹤資料的編碼定標準，不對向后臺發送的跟蹤資料的編碼定標準，讓跟蹤后臺自己決定最適合他們的編碼方式，

OpenTracing已進入 CNCF，正在為全球的分布式追蹤，提供統一的概念和資料標準，支持多種語言：https://github.com/opentracing，其中，OpenTracing API for Java：https://github.com/opentracing/opentracing-java

opentracing-api，是一個純粹的API沒有任何依賴
opentracing-noop，實作了API，但是是空實作什么也不干，依賴opentracing-api
opentracing-util，包含了一個GlobalTracer和基于Thread_local的簡單實作ScopeManager，依賴opentracing-api、opentracing-noop
opentracing-mock，mock測驗，包含一個簡單的MockTracer，將資料存盤進記憶體，依賴opentracing-api、opentracing-noop、opentracing-util
opentracing-testbed，用于測驗和嘗試新特性

OpenTracing資料模型中有三個重要的相互關聯的型別，分別是Tracer，Span和SpanContext，

Trace：一個完整請求鏈路
Span：一次呼叫程序(需要有開始時間和結束時間)
SpanContext：Trace的全域背景關系資訊，如里面有traceId

Trace

一個Trace代表一個事務或者流程在（分布式）系統中的執行程序，一條Trace（呼叫鏈）可以被認為是一個由多個Span組成的有向無環圖（DAG），通過歸屬于此呼叫鏈的Span來隱性的定義，

Tracer介面用來創建Span，以及處理如何處理Inject(serialize) 和 Extract (deserialize)，用于跨行程邊界傳遞，

Span

一個Span代表系統中具有開始時間和執行時長的邏輯運行單元，Span之間通過嵌套或者順序排列建立邏輯因果關系，Span可以被理解為一次方法呼叫, 一個程式塊的呼叫, 或者一次RPC/資料庫訪問，只要是一個具有完整時間周期的程式訪問，都可以被認為是一個span，每個Span包含以下的狀態：

An operation name，操作名稱
A start timestamp，起始時間
A finish timestamp，結束時間
Span Tag，一組鍵值對構成的Span標簽集合，鍵值對中，鍵必須為string，值可以是字串，布爾，或者數字型別
Span Log，一組span的日志集合，每次log操作包含一個鍵值對，以及一個時間戳，鍵值對中，鍵必須為string，值可以是任意型別
SpanContext，Span背景關系物件
References，Span間關系，目前定義了兩種關系：ChildOf（父子，父級span某種程度上取決于子span）和 FollowsFrom（跟隨，父級節點不以任何方式依然他們子節點的執行結果）

SpanContext

Span背景關系物件，代表跨越行程邊界，傳遞到下級span的狀態，每一個SpanContext包含以下狀態：

任何一個OpenTracing的實作，都需要將當前呼叫鏈的狀態（例如：trace和span的id），依賴一個獨特的Span去跨行程邊界傳輸
Baggage Items，Trace的隨行資料，是一個鍵值對集合，它存在于trace中，也需要跨行程邊界傳輸

OpenTracing的使用者僅僅需要，在創建span、向傳輸協議Inject（注入）和從傳輸協議中Extract（提取）時，使用SpanContext和References，

2. Jaeger

Jaeger是Uber開源的一款分布式追蹤系統（https://github.com/jaegertracing/jaeger），兼容OpenTracing API（支持Java語言：https://github.com/jaegertracing/jaeger-client-java），

jaeger-client：Jaeger的客戶端，實作了OpenTracing的API，支持主流編程語言，客戶端直接集成在應用程式中，把trace資訊按指定的采樣策略傳遞給jaeger-agent，這個程序通常被稱為埋點，
jaeger-agent：一個監聽在UDP埠上接收trace資訊的網路守護行程，會將資料批量發送給jaeger-collector，它被設計成一個基礎組件，部署到所有的宿主機上，agent將client和collector解耦，為client屏蔽路由和發現collector的細節，
jaeger-collector：負責接收jaeger-agent發送來的資料，然后異步處理，最終將資料存盤到DB中，它被設計成無狀態的組件，因此可以同時運行任意數量的jaeger-collector，
jaeger-query：接收查詢請求，然后從DB中檢索 trace資訊并通過 UI 進行展示，Query是無狀態的，可以啟動多個實體，把它們部署在nginx這樣的負載均衡器后面，
jaeger-ingester：中文名稱“攝食者”，從kafka讀取資料然后寫到jaeger的后端存盤，比如Cassandra和Elasticsearch，

分布式追蹤系統大體分為三個部分，資料采集、資料持久化、資料展示，

資料采集是指在代碼中埋點，設定請求中要上報的階段，以及設定當前記錄的階段隸屬于哪個上級階段，
資料持久化則是指將上報的資料落盤存盤，例如Jaeger就支持多種存盤后端，可選用Cassandra或者Elasticsearch，
資料展示則是前端根據TraceId查詢與之關聯的請求階段，并在界面上呈現，

3. dd-trace-java

dd-trace-java（https://github.com/DataDog/dd-trace-java）是Datadog開源的一個java版本的APM（應用性能管理）客戶端，它依賴了jaeger-client-java中的jaeger-core，采用位元組碼注入技術（JavaAgent）進行埋點，支持針對不同組件（http、kafka、jdbc等）進行插件化開發，

啟動入口在AgentBootstrap的premain方法：

AgentInstaller.installBytebuddyAgent：注冊各種支持不同組件的埋點插件
TracerInstaller.installGlobalTracer：注冊一個全域的Tracer

public class AgentInstaller {
 
    public static ResettableClassFileTransformer installBytebuddyAgent(final Instrumentation inst) {
        AgentBuilder agentBuilder =
                new AgentBuilder.Default()
                        .disableClassFormatChanges()
                        .with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION)
                        .with(new RedefinitionLoggingListener())
                        .with(AgentBuilder.DescriptionStrategy.Default.POOL_ONLY)
                        .with(AgentTooling.poolStrategy())
                        .with(new TransformLoggingListener())
                        .with(new ClassLoadListener())
                        .with(AgentTooling.locationStrategy())
                        .ignore(any(), skipClassLoader())
                        .or(nameStartsWith("datadog.trace."))
                        .or(nameStartsWith("datadog.opentracing."))
                        .or(nameStartsWith("datadog.slf4j."))
                        .or(nameStartsWith("java.").and(not(nameStartsWith("java.util.concurrent."))))
                        .or(nameStartsWith("com.sun."))
                        .or(nameStartsWith("sun.").and(not(nameStartsWith("sun.net.www."))))
                        .or(nameStartsWith("jdk."))
                        .or(nameStartsWith("org.aspectj."))
                        .or(nameStartsWith("org.groovy."))
                        .or(nameStartsWith("com.p6spy."))
                        .or(nameStartsWith("org.slf4j."))
                        .or(nameContains("javassist"))
                        .or(nameContains(".asm."))
                        .or(nameMatches("com\\.mchange\\.v2\\.c3p0\\..*Proxy"));
 
        for (final Instrumenter instrumenter : ServiceLoader.load(Instrumenter.class)) {
            log.info("Loading instrumentation {}", instrumenter.getClass().getName());
            agentBuilder = instrumenter.instrument(agentBuilder);
        }
        return agentBuilder.installOn(inst);
    }
}

業務方可通過繼承Instrumenter.Default進行插件化開發，以支持不同組件的埋點，

@AutoService(Instrumenter.class)
public class MDCInjectionInstrumentation extends Instrumenter.Default {
    
    private static final String mdcClassName = "org.TMP.MDC".replaceFirst("TMP", "slf4j");
    
    @Override
    protected boolean defaultEnabled() {
        return Config.get().isLogsInjectionEnabled();
    }

    @Override
    public ElementMatcher<? super TypeDescription> typeMatcher() {
        return named(mdcClassName);
    }

    @Override
    public void postMatch(
            final TypeDescription typeDescription,
            final ClassLoader classLoader,
            final JavaModule module,
            final Class<?> classBeingRedefined,
            final ProtectionDomain protectionDomain) {
        if (classBeingRedefined != null) {
            MDCAdvice.mdcClassInitialized(classBeingRedefined);
        }
    }

    @Override
    public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
        return singletonMap(
                isTypeInitializer(), MDCInjectionInstrumentation.class.getName() + "$MDCAdvice");
    }

    @Override
    public String[] helperClassNames() {
        return new String[]{LogContextScopeListener.class.getName()};
    }

    public static class MDCAdvice {
        @Advice.OnMethodExit(suppress = Throwable.class)
        public static void mdcClassInitialized(@Advice.Origin final Class mdcClass) {
            try {
                final Method putMethod = mdcClass.getMethod("put", String.class, String.class);
                final Method removeMethod = mdcClass.getMethod("remove", String.class);
                GlobalTracer.get().addScopeListener(new LogContextScopeListener(putMethod, removeMethod));
            } catch (final NoSuchMethodException e) {
                org.slf4j.LoggerFactory.getLogger(mdcClass).debug("Failed to add MDC span listener", e);
            }
        }
    }
}

End

OpenTracing建立了一套標準，解決了不同的分布式追蹤系統埋點API不兼容的問題（類似SLF4J）；Uber開源的Jaeger提供一套完整的分布式追蹤解決方案（兼容OpenTracing API），包括資料采集、資料持久化、資料展示；Datadog開源的dd-trace-java是一個APM client for Java（依賴jaeger-client-java），采用位元組碼注入技術（JavaAgent）進行埋點，支持針對不同組件進行插件化開發，

轉載請註明出處，本文鏈接：https://www.uj5u.com/ruanti/239652.html

標籤：其他

上一篇：基于Flask的租房、出租系統【原始碼】

下一篇：Spring Boot整合Redis