開始使用 Genkit Monitoring

本快速入門指南將說明如何為已部署的 Genkit 功能設定 Firebase Genkit 監控功能，以便收集及查看即時遙測資料。透過 Firebase Genkit 監控功能，您可以瞭解 Genkit 功能在正式環境中的表現。

Firebase Genkit Monitoring 的主要功能包括：

  • 查看 Genkit 功能延遲時間、錯誤和符記使用情形等定量指標。
  • 檢查追蹤記錄，查看 Genkit 的功能步驟、輸入內容和輸出內容，以利偵錯及改善品質。
  • 匯出正式版追蹤記錄，以便在 Genkit 中執行評估。

如要設定 Genkit Monitoring，您必須在程式碼庫和 Google Cloud 控制台中完成相關工作。

事前準備

  1. 如果您尚未建立 Firebase 專案，請先建立。

    在 Firebase 主控台中，按一下「新增專案」，然後按照畫面上的操作說明進行。您可以建立新專案，或將 Firebase 服務新增至現有的 Google Cloud 專案。

  2. 確認專案採用 Blaze 定價方案。

    Genkit Monitoring 需要將遙測資料寫入 Google Cloud Logging、Metrics 和 Trace 付費服務。歡迎前往 Google Cloud Observability 定價頁面查看定價詳細資料，並瞭解免費方案限制。

  3. 按照入門指南編寫 Genkit 功能，並使用下列任一指南準備要部署的程式碼：

    1. 使用 Cloud Functions for Firebase 部署流程
    2. 使用 Cloud Run 部署流程
    3. 將流程部署至任何 Node.js 平台

步驟 1：新增 Firebase 外掛程式

在專案中安裝 @genkit-ai/firebase 外掛程式：

npm i –save @genkit-ai/firebase

將 enableFirebaseTelemetry 匯入 Genkit 設定檔 (genkit(...) 初始化的檔案)，然後呼叫此設定檔：

import { enableFirebaseTelemetry } from '@genkit-ai/firebase';

enableFirebaseTelemetry();

步驟 2：啟用必要的 API

請確認您已為 GCP 專案啟用下列 API：

這些 API 應列在專案的 API 資訊主頁中。

步驟 3：設定權限

Firebase 外掛程式需要使用服務帳戶，才能驗證 Google Cloud Logging、Metrics 和 Trace 服務。

在 Google Cloud IAM 控制台中，將下列角色授予設定為在該控制台中執行程式的服務帳戶。對於 Cloud Functions for Firebase 和/或 Cloud Run，通常是預設的運算服務帳戶。

  • Monitoring 指標寫入者 (roles/monitoring.metricWriter)
  • Cloud Trace Agent (roles/cloudtrace.agent)
  • Logs Writer (roles/logging.logWriter)

步驟 4：(選用) 在本機測試設定

在部署前，您可以在本機執行 Genkit 程式碼，確認系統是否正在收集遙測資料，並在 Genkit 監控資訊主頁中查看這些資料。

  1. 在 Genkit 程式碼中，將 forceDevExport 設為 true，即可從本機環境傳送遙測資料。

  2. 使用服務帳戶驗證及測試設定。

    使用 Google Cloud CLI 工具，透過服務帳戶進行驗證：

    gcloud auth application-default login --impersonate-service-account <SERVICE_ACCT_EMAIL>

  3. 執行並叫用 Genkit 功能，然後在 Genkit 監控資訊主頁中查看指標。系統最多會花 5 分鐘收集第一個指標。您可以在遙測設定中設定 metricExportIntervalMillis，藉此縮短這段延遲時間。

  4. 如果 Genkit 監控資訊主頁未顯示指標，請參閱疑難排解指南，瞭解如何進行偵錯。

步驟 5：重新建構並部署程式碼

重新建構、部署及叫用 Genkit 功能，開始收集資料。Genkit Monitoring 收到指標後，您可以前往 Genkit Monitoring 資訊主頁查看指標