Google 建構的 OpenTelemetry 收集器總覽

Google 建構的 OpenTelemetry Collector 是 Google 的開放原始碼 OpenTelemetry Collector 版本，使用 Google 基礎架構上的安全供應鏈，從上游元件建構而成。OpenTelemetry 是雲端原生運算基金會的一部分，提供開放原始碼 API、程式庫和 SDK，可收集分散式 OpenTelemetry Protocol (OTLP) 追蹤記錄、指標和記錄，用於監控應用程式。

Google 建構的 OpenTelemetry Collector 可讓您將相關的 OTLP 追蹤記錄、指標和記錄，從使用 OpenTelemetry SDK 檢測的應用程式傳送至 Google Cloud Observability 和其他後端。收集器也會擷取 Google Cloud 資源的中繼資料，方便您將應用程式成效資料與基礎架構遙測資料建立關聯。搭配使用 Google 建構的收集器和 Google Cloud Observability，可取得深入分析資訊，改善應用程式和基礎架構的效能。如要進一步瞭解收集器，請參閱「Google 建構的 OpenTelemetry 收集器說明」。

自 0.134.0 版起，Google 建構的 OpenTelemetry Collector 是依據軟體構件供應鏈級別 (SLSA) 第 3 級標準建構。系統會持續掃描收集器程式碼及其依附元件，找出安全漏洞。詳情請參閱「安全防護功能」。

使用 Google 建構的 OpenTelemetry Collector

您可以使用 Google 建構的收集器，從在 Kubernetes (包括 Google Kubernetes Engine (GKE))、Container-Optimized OS、獨立容器或直接在主機環境 (包括 Compute Engine) 中執行的應用程式收集遙測資料。下列文件說明如何在以下環境中設定及部署 Google 建構的收集器：

您也可以按照這些操作說明，設定開放原始碼上游 OpenTelemetry 收集器，將資料匯出至 Google Cloud Observability。

如果沒有準備好使用收集器的應用程式，可以使用 Google 建構的收集器部署 OpenTelemetry 示範。詳情請參閱「試用 OpenTelemetry 示範」。

如要瞭解如何使用 OpenTelemetry 檢測功能，從應用程式產生追蹤記錄、指標和記錄，請參閱下列文件：

Google 建構的 OpenTelemetry Collector 說明

Google 建構的 OpenTelemetry Collector 是使用上游 OpenTelemetry 元件和工具建構而成，同時完全從 Google 建構測試發布基礎架構 (Artifact Registry) 建構及擷取。Google 建構的收集器與上游存放區的 OpenTelemetry 收集器建構作業相容。此外，它也以 Docker 映像檔的形式託管，可彈性部署在任何容器式系統上，包括 Kubernetes 和 GKE。

Google 建構的收集器提供 Google 精選套件，內含大多數使用者在 Google Cloud上享有豐富觀測能力體驗所需的元件。您不必選取元件並手動建構自己的收集器。使用 Google 打造的收集器，您可以：

  • 收集 Google Cloud 資源的中繼資料，以便將應用程式成效資料與基礎架構遙測資料建立關聯。
  • 使用匯出工具，將遙測資料轉送至 Google Cloud Observability 或您選擇的後端，包括原生支援 OpenTelemetry 的後端。
  • 運用建議設定和最佳做法自我監控功能 (包括健康狀態檢查和批次處理)，簡化新手上路流程。
  • 使用代管 Docker 映像檔，在任何容器式系統 (包括 Kubernetes 和 GKE) 上彈性部署。

最佳做法

OpenTelemetry 提供設定 OpenTelemetry Collector 和擴充 Collector 的最佳做法清單。本節提供一些額外建議。

使用 OTLP gRPC 匯出工具

使用 OTLP gRPC 匯出工具連線至 Telemetry (OTLP) API (telemetry.googleapis.com)。Telemetry API 接受所有遙測資料 (記錄、指標和追蹤記錄)，格式為不限供應商的 OTLP。將遙測資料傳送至 Telemetry API，代表從 OpenTelemetry Collector 流出的資料會以最高擬真度保留在 Google Cloud 儲存空間中。

使用健康狀態檢查擴充功能

健康狀態檢查擴充功能會啟用 HTTP 網址，可供探測 OpenTelemetry Collector 的狀態。使用這項擴充功能有以下好處：

  • 及早偵測問題：健康狀態檢查可主動監控收集器狀態，在潛在問題對遙測資料造成負面影響前偵測到問題。這項預防措施有助於確保觀測能力管道的可靠性。
  • 改善疑難排解：發生問題時，健康狀態檢查可提供有關收集器目前狀態的重要洞察資料。這項資訊可簡化診斷和解決程序、縮短停機時間，並簡化疑難排解作業。
  • 提高可靠性：持續監控收集器的健康狀態，確保運作穩定，並防止發生非預期的故障。這項主動措施可提升觀測能力系統的整體可靠性，並盡可能降低資料遺失或遙測資料缺漏的風險。

在 Kubernetes 和 GKE 上，健康狀態檢查擴充功能與 Kubernetes liveness 和 readiness 探測相容。如要瞭解如何設定這些探測，請參閱「Kubernetes 最佳做法：設定健康狀態檢查來探測 readiness 和 liveness」。

在 Cloud Run 中，單一健康狀態檢查擴充功能可做為 Cloud Run 服務設定中啟動和 liveness 探測的端點。

使用批次處理器

批次處理器會收集追蹤記錄、指標或記錄，並將其彙整成批次傳輸。使用批次處理器有下列好處：

  • 盡可能減少傳出連線：OpenTelemetry Collector 會將資料傳輸作業分批處理，大幅減少傳出連線數量。這種整合式方法可降低配額用量，並可能降低整體網路費用。
  • 改善資料壓縮：批次處理可提高資料壓縮效率，減少傳輸的資料總量。
  • 批次處理策略彈性：支援依大小和時間批次處理，可彈性針對不同情境進行最佳化。依大小批次處理可確保批次達到特定大小後再傳送，而依時間批次處理則會在特定時間間隔後傳送批次。這種彈性可讓您根據資料的特定特性和應用程式的特定需求，微調批次處理策略。

使用 googlesecretmanager 供應器

googlesecretmanager 供應商可讓您將設定檔所需的機密資訊儲存在 Secret Manager，這項服務專門用於安全儲存、存取及管理機密資料。使用 googlesecretmanager 供應器有以下優點：

  • 強化安全性：設定檔不含密碼等機密資訊。
  • 降低資料外洩風險：Secret Manager 會在初始化收集器時擷取 Secret，避免明文 Secret 意外記錄在記錄檔中。

如要瞭解如何使用這個供應器，請參閱「管理 Collector 設定中的密鑰」。

版本資訊

Google 建構的 OpenTelemetry Collector 版本與上游 OpenTelemetry Collector 同步。目前版本為 v0.163.1；對應的 Docker 映像檔儲存在 Artifact Registry，路徑為 us-docker.pkg.dev/cloud-ops-agents-artifacts/google-cloud-opentelemetry-collector/otelcol-google:0.163.1。每個新版本中與 Google Cloud 使用者最相關的變更，都會列在這個頁面上。

安全防護功能

從 0.134.0 版開始，Google 建構的 OpenTelemetry Collector 提供 Docker 映像檔，這些映像檔是根據軟體構件供應鏈級別 (SLSA) 第 3 級標準建構，並提供下列安全防護功能：

  • 安全建構：Google 建構的 OpenTelemetry Collector CI/CD 管道會為每個容器映像檔版本產生認證。這些證明包括驗證摘要證明 (VSA)，會以資產形式附加至 GitHub 上的每個版本。

  • 安全漏洞掃描和修補：Google 建構的 OpenTelemetry 收集器會持續掃描安全漏洞，我們也會盡力遵循 FedRamp 服務等級目標來修復安全漏洞。我們優先考量使用者安全性，會定期使用更新後的套件依附元件重新建構收集器。我們的 CI/CD 管道經過精心設計，可快速整合重要的安全性修正和依附元件更新。這項承諾可大幅降低已知安全漏洞的風險，確保產品持續安全且符合最新標準。

  • 經過驗證的安全版本：我們強制執行 Google 內部程式碼完整性政策，確保只有符合嚴格安全性標準的構件，才能發布至正式環境。這項程序可確保您收到的軟體一律通過廣泛的內部安全性檢查。

支援性

如要回報 Google 建構的 OpenTelemetry Collector 用戶端問題，包括功能要求、錯誤報告和一般問題，請在適當的 GitHub 存放區中建立問題。Google 會監控這些存放區，並盡可能分類及解決問題。

  • Google 建構的 OpenTelemetry Collector 封裝存放區，適用於下列相關問題：

    • 包裝
    • 部署於 Google Cloud
    • Google Cloud中的驗證
    • 要求新增 OpenTelemetry 元件

  • OpenTelemetry Collector Contrib 存放區，適用於下列相關問題：

    • Google 專屬的 OpenTelemetry 元件，例如：
      • googlecloudexporter
      • googlemanagedprometheusexporter
      • googleclientauthextension
      • resourcedetectionprocessor
    • 由上游社群管理的非 Google 專屬 OpenTelemetry 元件

如果 Google 建構的 OpenTelemetry Collector 在使用 Google Cloud Observability 服務和 API 時發生問題，例如伺服器錯誤或配額問題，請與 Cloud Customer Care 聯絡。

定價

部署及使用 Google 建構的 OpenTelemetry Collector 不會產生任何費用。

將遙測資料傳送至 Google Cloud時，系統會依擷取量計費。如要瞭解擷取追蹤記錄、記錄和 Google Cloud Managed Service for Prometheus 指標的相關費用，請參閱「Google Cloud Observability 定價」。

試用 OpenTelemetry 示範

本節說明如何使用 Google 建構的 OpenTelemetry Collector，部署及執行 Google Cloud的 OpenTelemetry 示範。

這個部分為選用。如果您已準備好將 Google 建構的收集器整合至自己的部署作業，請參閱下列文件：

事前準備

OpenTelemetry 示範需要已設定 Workload Identity Federation 的 Kubernetes 叢集。如要瞭解如何為叢集設定 Workload Identity Federation，請參閱「使用 Workload Identity Federation for GKE」。

更新示範，改用 Google 建構的收集器

根據預設，OpenTelemetry 示範會使用上游 OpenTelemetry Collector。如要改用 Google 建構的 OpenTelemetry Collector，請按照下列步驟操作：

  1. 複製 OpenTelemetry 示範存放區：

    git clone https://github.com/GoogleCloudPlatform/opentelemetry-demo.git

  2. 前往 kubernetes 目錄。

    cd kubernetes

  3. 編輯檔案 opentelemetry-demo.yaml，取代要使用的收集器映像檔行。該行內容大致如下，但版本可能不同：

    image: "otel/opentelemetry-collector-contrib:0.108.0"

    將 image: 欄位的值替換為 us-docker.pkg.dev/cloud-ops-agents-artifacts/google-cloud-opentelemetry-collector/otelcol-google:0.163.1，讓該行看起來像以下內容，然後儲存檔案：

    image: "us-docker.pkg.dev/cloud-ops-agents-artifacts/google-cloud-opentelemetry-collector/otelcol-google:0.163.1"

部署示範

套用更新後的 opentelemetry-demo.yaml 檔案，部署示範：

kubectl apply --namespace otel-demo -f opentelemetry-demo.yaml

連線至示範

套用更新後的設定後，即可將資料轉送至本機通訊埠。舉例來說，如要連線至 localhost:8080 的試用版，請發出下列指令：

kubectl port-forward --n otel-demo svc/opentelemetry-demo-frontendproxy 8080:8080

接著，您可以使用瀏覽器連線至 localhost:8080 的示範。

查看遙測資料

OpenTelemetry 示範會使用 Google 建構的 OpenTelemetry 收集器，將指標、追蹤記錄和記錄傳送至 Google Cloud 。如要瞭解示範傳送的特定遙測資料，請參閱示範說明文件中的「查看遙測資料」一節。

查看指標

Google 建構的 OpenTelemetry 收集器會收集 Prometheus 指標，您可以使用 Metrics Explorer 查看這些指標。收集的指標取決於應用程式的檢測，但 Google 建構的收集器也會寫入一些自我指標。

如要查看 Google 建構的 OpenTelemetry Collector 收集的指標，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的「Metrics Explorer」頁面：

    前往「Metrics Explorer」

    如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

  2. 在 Google Cloud 控制台的工具列中，選取 Google Cloud 專案。如果是 App Hub 設定，請選取 App Hub 主專案，或已啟用應用程式管理功能的資料夾管理專案。
  3. 在「Metric」(指標) 元素中，展開「Select a metric」(選取指標) 選單，在篩選列中輸入 Prometheus Target，然後使用子選單選取特定資源類型和指標：
    1. 在「Active resources」(使用中的資源) 選單中，選取「Prometheus Target」(Prometheus 目標)。
    2. 如要選取指標，請使用「使用中的指標類別」和「使用中的指標」選單。 Google 建構的 OpenTelemetry Collector 收集的指標具有 prometheus.googleapis.com 前置字元。
    3. 按一下「套用」。

  4. 如要新增篩選器，從查詢結果中移除時間序列，請使用「Filter」(篩選器) 元素。

  5. 設定資料的查看方式。

    如果指標的測量結果是累計值，Metrics Explorer 會自動依據校正週期正規化測量資料，並在圖表中顯示比率。詳情請參閱「種類、類型和轉換」。

    測量整數或雙精度值時 (例如使用 counter 指標)，Metrics Explorer 會自動加總所有時間序列。如要變更這項行為，請將「Aggregation」(匯總) 項目的第一個選單設為「None」(無)。

    如要進一步瞭解如何設定圖表，請參閱「在使用 Metrics Explorer 時選取指標」。

查看追蹤記錄

如要查看追蹤記錄資料，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的 「Trace Explorer」頁面：

    前往「Trace explorer」(Trace 探索工具)

    您也可以透過搜尋列找到這個頁面。

  2. 在 Google Cloud 控制台的工具列中，選取 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主專案或管理專案。
  3. 在頁面的表格部分選取資料列。

  4. 在「Trace details」(追蹤記錄詳細資料) 面板的甘特圖中，選取所需時距。

    畫面上會開啟一個面板，顯示追蹤要求的相關資訊。這些詳細資料包括方法、狀態碼、位元組數，以及呼叫端的使用者代理程式。

  5. 如要查看與這個追蹤記錄相關聯的記錄，請選取「Logs & Events」(記錄和事件) 分頁標籤。

    這個分頁會顯示個別記錄。如要查看記錄項目的詳細資料，請展開記錄項目。您也可以點選「View Logs」(查看記錄)，並使用 Logs Explorer 查看記錄。

如要進一步瞭解如何使用 Cloud Trace 探索工具，請參閱「尋找及探索追蹤記錄」。

查看記錄檔

您可以在 Logs Explorer 中檢查記錄檔，也可以查看相關聯的追蹤記錄 (如有)。

  1. 前往 Google Cloud 控制台的 「Logs Explorer」頁面：

    前往「Logs Explorer」(記錄檔探索工具)

    如果您是使用搜尋列尋找這個頁面，請選取子標題為「Logging」的結果。

  2. 找出檢測應用程式的記錄項目，然後展開該項目查看詳細資料。

  3. 在含有追蹤訊息的記錄項目上，按一下「 Traces」(追蹤記錄)，然後選取「View trace details」(查看追蹤記錄詳細資料)。

    「Trace details」(追蹤記錄詳細資料) 面板隨即開啟，並顯示所選追蹤記錄。

如要進一步瞭解如何使用 Logs Explorer，請參閱「使用 Logs Explorer 查看記錄檔」。