OpenTelemetry初識及呼叫鏈Trace詳解

2022-12-21 14:01:18

前言

OpenTelemetry作為一個分散式追蹤的專案，他支援非常多的語言，如Java，Golang，Python等，鑑於筆者的主力語言為Java，並且後續需要介紹OpenTelemetry的Java Agent實現，所以後續文章中的相關知識點都以Java或者Java Sdk的方式為主。

初識OpenTelemetry

在微服務廣泛發展和使用的當下，對於整個微服務體系的使用情況的觀察以及服務依賴呼叫情況都不再像以往那麼清晰明瞭。而這正是OpenTelemetry能夠為我們提供的能力。

OpenTelemetry源自OpenSencuc和OpenTracing的合併，它的目標是整合Trace，Metrics，Logging能力來提供可觀測性。過去的分散式追蹤往往是各做各的，沒有固定的標準，各個分散式追蹤方案各顯神通，使用不同的協定，不同的標準。但是OpenTelemetry不同，它提供了一系列的標準，並且他的可插拔式的架構為將來的協定和資料結構擴充套件提供了便利的方式。

呼叫鏈Trace

分散式呼叫鏈，俗稱呼叫鏈，用來記錄請求的路徑整體路徑。下圖是一個典型的的請求以及其RPC呼叫的鏈路：

從圖中我們可以很清晰的瞭解到剛才的請求是怎麼一個流轉過程，經過了什麼元件和服務，介面。這就是呼叫鏈的作用之一，讓我們的請求鏈路更加透明清晰。

Span

Span在呼叫鏈中是一個基礎的單元，一個呼叫鏈是由很多的Span組成的。在一個Span中會包含如下資訊：

名稱
父Span的ID，root節點的父Span為空
開始與結束時間戳
Span Context
Attributes
Span事件
Span Links
Span狀態
Span Kind

以下是一個典型的Span結構：

{
  "trace_id": "7bba9f33312b3dbb8b2c2c62bb7abe2d",
  "parent_id": "",
  "span_id": "086e83747d0e381e",
  "name": "/v1/sys/health",
  "start_time": "2021-10-22 16:04:01.209458162 +0000 UTC",
  "end_time": "2021-10-22 16:04:01.209514132 +0000 UTC",
  "status_code": "STATUS_CODE_OK",
  "status_message": "",
  "attributes": {
    "net.transport": "IP.TCP",
    "net.peer.ip": "172.17.0.1",
    "net.peer.port": "51820",
    "net.host.ip": "10.177.2.152",
    "net.host.port": "26040",
    "http.method": "GET",
    "http.target": "/v1/sys/health",
    "http.server_name": "mortar-gateway",
    "http.route": "/v1/sys/health",
    "http.user_agent": "Consul Health Check",
    "http.scheme": "http",
    "http.host": "10.177.2.152:26040",
    "http.flavor": "1.1"
  },
  "events": [
    {
      "name": "",
      "message": "OK",
      "timestamp": "2021-10-22 16:04:01.209512872 +0000 UTC"
    }
  ]
}

Span Context

Span Context可以理解為上下文，是Span中包含的不可變的物件。在Span Context中包含了：

traceId：呼叫鏈ID
spanId：Span的ID
traceFlag：二進位制形式的呼叫鏈標誌位，一般用於表示呼叫鏈是否取樣（isSampled）
traceState：承載呼叫鏈資訊的K-V結構列表

Attributes

Attributes是一個用來攜帶資訊的K-V結構。

在java sdk中可以通過：

Span.current().setAttribute("My Attributes", "attr");

來自定義你想要設定的Attributes。當然在OpenTelemetry中預設內建的那些Instrumentation都會有定義一些指定標準化的的Attributes，詳情可以參照Semantic Attributes

Span事件

Span事件（Events）是一種事件機制，可以將事件觸發與具體的Span進行繫結，然後在呼叫鏈頁面展示出來。如下事例：

Span.current().addEvent("My Event");

Span Links

Span Links是一種能夠將呼叫鏈關聯起來的技術，通過設定關聯的Span，可以在頁面中展現關聯的呼叫鏈資訊。不過請注意Span Links必須要在Span建立時才能新增，不像Events和Attributes一樣能在Span建立之後新增。例子如下：

Tracer tracer = GlobalOpenTelemetry.getTracer("1111");
Span span = tracer.spanBuilder("start")
        .addLink(SpanContext.create("ee868088dfd10adbaa459c9aa353b112", "53b11b6c55010604",
                TraceFlags.getDefault(), TraceState.getDefault())).startSpan();
span.end();

Span狀態

Span狀態（Status）是定義好的Span的狀態，有如下幾種：

Unset
Ok
Error

Span Kind

Span Kind是指Span型別，有如下幾種：

Server
Client
Producer
Consumer
Internal

顧名思義Server/Client指的是伺服器端/使用者端，Producer/Consumer指的是生產者/消費者，顯然這個一般適用於訊息佇列，Internal是內部元件產生的Span

Trace構建的原理

簡單來說的話Trace是由眾多的Span組成的，而Span則是由眾多的Instrumentation庫組成的，這些庫由開源作者構建，用於支援不同的元件，如http請求，kafka，redis等等。依託於這些Instrumentation，呼叫鏈可以生成對應的Span。

生成Span自然不是難題，問題在於是如何將這些Span串聯起來的。在Trace中有一個唯一的標識TraceID，而且在Span中也有一個SpanId和ParentSpanId，藉助這些資訊，在Span將所有資料推播到伺服器端後，伺服器端就能根據這些資訊進行重組，然後在介面上進行展示。

但是又存在一個問題，TraceId以及ParentSpanId是如何在Span間進行傳遞的呢？

這裡就涉及到了Trace的底層原理了。在這裡以Java Sdk來舉例。在Sdk中會定義一個Context類用於建立一個記憶體中的執行緒隔離的儲存機制來儲存上游傳遞的資料。一般來說上游往下游傳遞資料每個外掛都是不同的形式。例如如果是http請求，那就藉助Header，如果是Kafka，也是藉助於Kafka自帶的prop來進行資料傳遞。之後在下游獲取到資料後利用Context將其存放入記憶體中，這個過程被稱為extract，在資料要再往下傳遞時，需要將記憶體中資料取出，在解析成Header或是其他的形式，這個被稱為inject。呼叫鏈資訊正是以此來傳遞的。

Trace就是依靠traceparent來進行傳遞的，traceparent不僅包含了traceId，還包含了一些isSample等等的基礎資訊。

Metrics

Metrics是一種度量標準，用於展現應用的CPU，記憶體等等指標級的度量資訊。

OpenTelemetry定義了三種metrics儀器：

counter: 累加值，這類指標不會減少，只會不斷的累加上去
measure: 一段時間的資料聚合值，表示的是一段時間內的資料累加值
observer: 抓取當前時間的一系列特定值

實際上OpenTelemetry提供了許多基礎的指標計算方式，例如：LongCounter，LongUpDownCounter，DoubleHistogram，DoubleGauge等等。

Meter meter = GlobalOpenTelemetry.meterBuilder("my-meter-instrumentation")
                .setInstrumentationVersion("1.0.0")
                .build();
LongCounter counter = meter
        .counterBuilder("my_metrics")
        .setDescription("My Metrics")
        .setUnit("1")
        .build();
counter.add(100);

上述程式碼是一個簡單的建立指標的的例子，這裡建立了一個固定值為100的名為my_metrics的指標，由於是counter，所以最終指標名為my_metrics_total

Logs

紀錄檔也是OpenTelemetry的一大功能之一，不過截止到本文釋出前，Logs功能還未GA，因此存在變數，後續我們在聊到Agent相關內容時會再簡單聊聊這部分內容，在這裡就先一筆帶過。

Baggage

Baggage用於在Span間傳遞資料。

設想一個場景，你希望在鏈路的當前的Span中將某些資料傳遞下去，使用attributes顯示然是不行的，因此需要一些手段將其傳遞下去，Baggage就是為此而設計的。

其實Baggage的原理基本和呼叫鏈的traceId的傳遞基本相似，不同之處是它定義了一個名為baggage的key，而這個key中包含的值是以K-V形式組織的，因此你可以傳遞自己想要的值下去。

在早期Baggage底層維護了一個Map來儲存這些資料，後來在某個版本後改成了用陣列的形式，每兩個陣列位置分別儲存一對K-V，並且做了一些特殊的處理來實現刪除等操作，有興趣的可以去看看原始碼。

總結

在本文中我們簡單的介紹了OpenTelemetry的一些使用和實現的原理，在後續的文章中會更多的介紹整個OpenTelemetry的體系，請期待後續！

參考檔案：

[1] opentelemetry.io/docs

以上就是OpenTelemetry初識及呼叫鏈Trace詳解的詳細內容，更多關於OpenTelemetry Trace呼叫鏈的資料請關注it145.com其它相關文章！