追蹤記錄 (OTLP) API 總覽

本文說明遙測 (OTLP) API,該 API 會實作 OpenTelemetry OTLP 通訊協定。這個 API 適用於使用 OpenTelemetry SDK 檢測的應用程式。

使用 Telemetry API 的好處

OpenTelemetry 是 Google Cloud支援的開放原始碼專案,並有 Google Cloud工程師團隊負責確保支援擷取及顯示追蹤記錄資料。

使用 Telemetry API 時,資料會以一般與 OpenTelemetry OTLP 通訊協定定義的 proto 檔案一致的格式儲存。不過,欄位可能會先從 OpenTelemetry 專屬資料類型轉換為 JSON 資料類型,再進行儲存。此外,Telemetry API 的限制也適用。 這些限制通常比 Cloud Trace API 的限制寬鬆。最後,您的檢測工具不依賴 Google Cloud專屬的匯出工具。

如要進一步瞭解儲存格式,請參閱追蹤資料的結構定義

Telemetry API 的使用時機

建議您使用 Telemetry API,將追蹤資料傳送至專案 Google Cloud 。這個 API 與開放原始碼 OpenTelemetry 生態系統相容,且限制通常比 Cloud Trace API (專屬Google Cloud API) 更寬鬆。部分功能 (例如應用程式監控) 需仰賴僅在追蹤資料傳送至 Telemetry API 時提供的資訊。

將應用程式檢測結果傳送至Google Cloud 專案時,建議您採取下列任一做法:

  • 使用將 OTLP 寫入 Collector 的匯出工具,然後將追蹤記錄資料傳送至 Telemetry API。
  • 使用 OpenTelemetry 程式庫支援的程序內 OTLP 匯出器,將遙測資料傳送至 Telemetry API。沒有符合這項設定的收集器。

如要瞭解如何使用 Telemetry API,請參閱「從 Cloud Trace 匯出工具遷移至 OTLP 端點」。

查看擷取資料的位置

透過 Telemetry API 擷取的追蹤資料,可使用「追蹤記錄探索工具」頁面查看。如要瞭解如何查看追蹤記錄資料,請參閱「尋找及探索追蹤記錄」。

驗證

匯出者必須獲得授權,才能將資料傳送至您的 Google Cloud 專案。舉例來說,您可以將語言專屬的 Google Auth 程式庫新增至應用程式,藉此使用 Google Cloud 應用程式預設憑證 (ADC) 設定匯出工具。如需詳細資訊和程式碼範例,請參閱「設定驗證」。

VPC Service Controls 支援

服務名稱為 telemetry.googleapis.com 的 Telemetry API 服務支援 VPC Service Controls。您為 Telemetry API 服務建立的任何 VPC Service Controls 限制,只會套用至該服務。這些限制不適用於任何其他服務,包括 cloudtrace.googleapis.com 服務等,這些服務也能擷取追蹤資料。

如要瞭解詳情,請參考下列資源:

Cloud Trace 和資料落地

如果您因為有資料落地或影響等級 4 (IL4) 的需求而使用 Assured Workloads,請勿使用 Telemetry API 傳送追蹤範圍。