API 總覽

本頁簡要介紹 Observability API 和 Telemetry (OTLP) API。

關於 Observability API

Observability API 可讓您執行下列操作:

  • 為專案、資料夾和機構設定可觀測性 bucket 的預設設定。這些設定有助於您符合法規遵循和監管需求。您可以設定下列項目:

    • 新可觀測性 bucket 的預設儲存位置。
    • 每個位置的預設 Cloud Key Management Service 金鑰。該金鑰用於加密新的可觀測性值區。

    詳情請參閱「設定可觀測性 bucket 的預設值」。

  • 設定專案的可觀測性範圍。這個範圍會控管探索器頁面搜尋記錄、指標和追蹤資料的資源。詳情請參閱「設定可觀測性範圍」。

  • 列出 Google Cloud 專案中可觀測性值區的相關資訊。追蹤記錄資料會儲存在觀測 bucket 中。如要瞭解資料模型,請參閱「儲存空間總覽」。

  • 在資料集上建立連結,讓 BigQuery 擁有資料集的讀取權限。如要瞭解如何建立連結的資料集,請參閱「管理儲存空間」。

Service 端點

服務端點是能指定 API 服務網路位址的基準網址。Observability API 支援全域端點和區域端點:

  • 全域端點:observability.googleapis.com

    您可以使用全域服務端點,執行 Observability API 支援的任何作業。此外,對於這個端點,您可以使用清單可觀測性 bucket 指令,將路徑參數中的位置欄位替換為萬用字元 (-)。

  • 區域端點:observability.REGION.rep.googleapis.com,其中 REGION 是支援的區域。如需端點清單,請參閱「地區服務端點」。

    只有在路徑參數中提供的位置與端點的區域相符時,才能使用區域服務端點。如果傳送至這些服務端點的指令包含萬用字元,或位置與端點的區域不同,就會失敗。

API 參考資料

關於 Telemetry API

Telemetry (OTLP) API 是 OpenTelemetry OTLP 通訊協定的實作項目。Telemetry API 支援開放原始碼 OpenTelemetry 生態系統,並與其相容:

  • 記錄:Telemetry API 可讓您將 OTLP 格式的記錄項目擷取至專案。詳情請參閱「將 OTLP 記錄寫入 Telemetry API」。

  • 指標:Telemetry API 可讓您使用 otlphttp 匯出工具和 OpenTelemetry Collector 或 OpenTelemetry SDK,將 OTLP 格式的指標擷取至 Cloud Monitoring。詳情請參閱「OTLP 指標擷取總覽」。

  • 追蹤記錄:您可以透過 Telemetry API,將 OTLP 格式的追蹤記錄資料傳送至專案。此外,Telemetry API 的追蹤記錄限制通常比 Cloud Trace API 的限制寬鬆。

Service 端點

服務端點是能指定 API 服務網路位址的基準網址。Telemetry API 支援全域端點和區域端點:

  • 全域端點:telemetry.googleapis.com。對於這個端點,Google Cloud Observability 成功完成所有驗證步驟後,會將資料傳送至後端服務進行儲存。

  • 區域端點:telemetry.REGION.rep.googleapis.com,其中 REGION 是支援的區域。對於這些端點,Google Cloud Observability 成功完成所有驗證步驟後,就會將資料傳送至後端服務。這項服務會儲存或捨棄資料:

    • 系統會儲存記錄和追蹤資料。後端服務會在必要時自動在區域之間移動資料。
    • 只有當附加至資料的位置標籤與端點的區域或該區域內的可用區相符時,系統才會儲存指標資料。

    如需支援的區域端點清單,請參閱 API 參考資料頁面。

擷取追蹤記錄資料可能會觸發建立觀測功能 bucket。不過,使用區域端點不會影響系統建立可觀測性 bucket 的位置。系統會根據預設設定、機構政策和支援的值區位置組合,判斷可觀測性值區的位置。

API 參考資料

如要進一步瞭解 Telemetry API,請參閱下列文件: