使用 OpenTelemetry 檢測 ADK 應用程式

本文說明如何為使用 Agent Development Kit (ADK) 架構建構的 AI 代理進行儀表化。ADK 框架包含 OpenTelemetry 檢測功能，可從代理程式的主要動作收集遙測資料。啟用內建檢測功能後，該功能會將文字提示和代理程式回覆等資訊傳送至您的 Google Cloud 專案。本文將說明必要變更，並提供範例應用程式的連結。

使用 ADK 的應用程式也能收集多模態提示和回覆。 本文說明如何收集文字提示和回覆。如要收集多模態資料，則必須進行額外設定。詳情請參閱「收集及查看多模態提示和回覆」。

ADK 提供的預設可觀測性可能不足以滿足應用程式的使用案例。您可以使用 OpenTelemetry 新增其他檢測程式庫，從應用程式的其他部分擷取遙測資料，也可以使用自訂檢測擷取應用程式專屬資料，取得更精細的觀測能力。舉例來說，您可以在應用程式中編寫檢測程式碼，以執行下列操作：

• 追蹤代理程式叫用工具的資源用量。
• 追蹤應用程式專屬的驗證失敗、業務規則違規或自訂錯誤復原機制。
• 根據領域專屬條件追蹤專員回覆的品質分數。

注意： 本文假設您使用的是 1.17.0 以上版本的 ADK 架構。

檢測生成式 AI 應用程式，收集遙測資料

如要為 AI 代理程式進行檢測，以收集記錄、指標和追蹤記錄資料，請執行下列操作：

1. 安裝 OpenTelemetry 套件。
2. 設定 ADK 環境。

本節的其餘部分會說明上述步驟。

安裝 OpenTelemetry 套件

新增下列 OpenTelemetry 檢測和匯出工具套件：

uv add 'google-adk>=1.17.0' \
  'opentelemetry-instrumentation-google-genai>=0.4b0' \
  'opentelemetry-instrumentation-sqlite3' \
  'opentelemetry-exporter-gcp-logging' \
  'opentelemetry-exporter-otlp-proto-grpc' \
  'opentelemetry-instrumentation-vertexai>=2.0b0'

記錄檔資料會透過 Cloud Logging API 或 Cloud Monitoring API 傳送至您的 Google Cloud 專案。opentelemetry-exporter-gcp-logging 程式庫會叫用 Cloud Logging API 中的端點。

系統不會收集指標資料。通常，未使用以收集器為基礎解決方案的應用程式會包含 opentelemetry-exporter-gcp-monitoring 程式庫。這個程式庫會叫用 Cloud Monitoring API 中的端點。

追蹤記錄資料會使用 Google Cloud 遙測 (OTLP) API 傳送至，該 API 會實作 OpenTelemetry Line Protocol。opentelemetry-exporter-otlp-proto-grpc 程式庫會叫用遙測 (OTLP) API 端點。

追蹤資料的儲存格式通常與 OpenTelemetry Line Protocol 定義的 proto 檔案一致。不過，欄位可能會先從 OpenTelemetry 專屬資料類型轉換為 JSON 資料類型，再進行儲存。如要進一步瞭解儲存格式，請參閱「追蹤資料的結構定義」。

設定 ADK 環境

ADK 架構 1.17.0 以上版本內建支援 OpenTelemetry，並可將 OpenTelemetry 遙測資料傳送至Google Cloud Observability。如要啟用這項功能，請設定 ADK 環境：

• 如果使用 adk web 指令執行應用程式，請加入 --otel_to_cloud 旗標。

• 在 opentelemetry.env 檔案中，設定下列環境變數：

  OTEL_SERVICE_NAME='adk-sql-agent'
  OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED='true'
  

• 設定 OpenTelemetry，使用生成式 AI 的最新語意慣例。

  OTEL_SEMCONV_STABILITY_OPT_IN='gen_ai_latest_experimental'
  

• 設定 OpenTelemetry，將訊息附加為事件。

  OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT='EVENT_ONLY'
  

  注意： 請勿將這個變數的值設為 true。使用最新的語意慣例時，將這個變數的值設為 true 會導致設定無效。因此不會收集記錄和追蹤資料。

  如要進一步瞭解允許的列舉值，請參閱 genai/types.py。

• 建議您也在 opentelemetry.env 檔案中加入下列環境變數：

  ADK_CAPTURE_MESSAGE_CONTENT_IN_SPANS='false'
  

  這個環境變數具有以下功用：

  • 防止 ADK 檢測功能附加超出屬性大小限制的範圍屬性。
  • 防止個人識別資訊 (PII) 以屬性形式附加至範圍。

• 您可能需要設定其他環境變數。舉例來說，如果您要部署至 Gemini Enterprise Agent Platform，也請設定下列環境變數：

  GOOGLE_CLOUD_AGENT_ENGINE_ENABLE_TELEMETRY='true'
  

下載並執行範例應用程式

這個程式碼範例會實作使用 ADK 建構的生成式 AI 代理。代理程式會使用 OpenTelemetry 進行檢測，並設定為將指標、追蹤記錄和記錄檔傳送至您的 Google Cloud 專案。傳送至專案的遙測資料包括生成式 AI 提示和回覆。

ADK 代理角色

生成式 AI 代理程式定義為 SQL 專家，可完整存取暫時性 SQLite 資料庫。這個代理是使用 Agent Development Kit 建構而成，並透過 SQLDatabaseToolkit 存取資料庫。資料庫一開始是空的。

事前準備

登入 Google Cloud 帳戶。如果您是 Google Cloud新手，歡迎 建立帳戶，親自評估產品在實際工作環境中的成效。新客戶還能獲得價值 $300 美元的免費抵免額，可用於執行、測試及部署工作負載。

安裝 Google Cloud CLI。

若您採用的是外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

執行下列指令，初始化 gcloud CLI：

gcloud init

建立或選取 Google Cloud 專案。

選取或建立專案所需的角色

• 選取專案：選取專案時，不需要具備特定 IAM 角色，只要您在專案中獲派角色，即可選取該專案。
• 建立專案：如要建立專案，您需要專案建立者角色 (roles/resourcemanager.projectCreator)，其中包含 resourcemanager.projects.create 權限。瞭解如何授予角色。

注意：如果您不打算保留在這項程序中建立的資源，請建立新專案，而不要選取現有專案。因此您在完成這些步驟之後，就可以刪除專案，並移除與該專案相關聯的所有資源。

• 建立 Google Cloud 專案：

  gcloud projects create PROJECT_ID

  將 PROJECT_ID 替換為您要建立的 Google Cloud 專案名稱。

• 選取您建立的 Google Cloud 專案：

  gcloud config set project PROJECT_ID

  將 PROJECT_ID 替換為 Google Cloud 專案名稱。

確認專案已啟用計費功能 Google Cloud 。

啟用 Vertex AI、服務使用情形、Telemetry、Cloud Logging、Cloud Monitoring 和 Cloud Trace API：

啟用 API 時所需的角色

您必須具備 serviceusage.services.enable 權限，才能啟用 API。如果您建立了專案，可能已透過「擁有者」角色 (roles/owner) 取得這項權限。否則，您可以透過「服務使用情形管理員」角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。

gcloud services enable aiplatform.googleapis.com serviceusage.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com

安裝 Google Cloud CLI。

若您採用的是外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

執行下列指令，初始化 gcloud CLI：

gcloud init

建立或選取 Google Cloud 專案。

選取或建立專案所需的角色

• 選取專案：選取專案時，不需要具備特定 IAM 角色，只要您在專案中獲派角色，即可選取該專案。
• 建立專案：如要建立專案，您需要專案建立者角色 (roles/resourcemanager.projectCreator)，其中包含 resourcemanager.projects.create 權限。瞭解如何授予角色。

注意：如果您不打算保留在這項程序中建立的資源，請建立新專案，而不要選取現有專案。因此您在完成這些步驟之後，就可以刪除專案，並移除與該專案相關聯的所有資源。

• 建立 Google Cloud 專案：

  gcloud projects create PROJECT_ID

  將 PROJECT_ID 替換為您要建立的 Google Cloud 專案名稱。

• 選取您建立的 Google Cloud 專案：

  gcloud config set project PROJECT_ID

  將 PROJECT_ID 替換為 Google Cloud 專案名稱。

確認專案已啟用計費功能 Google Cloud 。

啟用 Vertex AI、服務使用情形、Telemetry、Cloud Logging、Cloud Monitoring 和 Cloud Trace API：

啟用 API 時所需的角色

您必須具備 serviceusage.services.enable 權限，才能啟用 API。如果您建立了專案，可能已透過「擁有者」角色 (roles/owner) 取得這項權限。否則，您可以透過「服務使用情形管理員」角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。

gcloud services enable aiplatform.googleapis.com serviceusage.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com

1. 如要取得讓範例應用程式寫入記錄、指標和追蹤資料所需的權限，請要求管理員授予您專案的下列 IAM 角色：

   • Cloud 遙測資料追蹤記錄寫入者 (roles/telemetry.tracesWriter)
   • 記錄檔寫入者 (roles/logging.logWriter)
   • Monitoring 指標寫入者 (roles/monitoring.metricWriter)
   • Vertex AI 使用者 (roles/aiplatform.user)

   如果您在 Cloud Shell、 Google Cloud 資源或本機開發環境中執行範例，這些權限就已足夠。

   重要事項：正式版應用程式通常會依賴服務帳戶，提供寫入記錄、指標和追蹤資料所需的憑證。在這些情況下，請將先前的角色授予服務帳戶。

2. 請務必指定配額專案。Vertex AI API (aiplatform.googleapis.com) 必須指定配額專案。詳情請參閱「設定配額專案」。舉例來說，下列指令可以設定配額專案。

   gcloud config set billing/quota_project PROJECT_ID

啟動應用程式

如要啟動範例應用程式，請按照下列步驟操作：

1. 在 Cloud Shell 中複製存放區：

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

2. 前往範例目錄：

   cd opentelemetry-samples/python/adk-sql-agent
   

   範例包含 .env 檔案，其中設定了兩個環境變數。一個變數會控管 SDK 使用的端點。另一個變數會設定位置。

   如要改用其他模型，請編輯 main.py。請確認所選模型支援 .env 檔案中指定的位置。如要瞭解模型，請參閱「Google 模型」。

3. 建立虛擬環境並執行範例：

   uv run --env-file opentelemetry.env adk web --otel_to_cloud
   

   應用程式會顯示類似以下的訊息：

   Appplication startup complete
   Uvicorn running on http://127.0.0.1:8080
   

4. 如要與代理程式互動，請選取上一個步驟輸出內容中顯示的網址。

5. 展開「選取應用程式」，然後從代理程式清單中選取 sql_agent。

   注意： 這個應用程式需要跨源資源共享 (CORS)。如果輸入提示，但 CORS 遭到封鎖，應用程式會顯示 Failed to create session 訊息，且指令列會顯示指令遭到拒絕，POST /apps/sql_agent/users/user/sessions HTTP/1.1" 403 Forbidden。
   如要啟用 CORS，請在執行範例的指令中附加下列內容：
   

   --allow_origins="regex:.*"

與代理互動

如要與代理互動，請向代理提問或下達指令。舉例來說，你可以問：

What can you do for me ?

同樣地，由於 sql_agent 的角色是 SQL 專家，您可以要求它為應用程式建立資料表，並編寫查詢來操作所建立的資料表。代理程式只能建立由 .db 檔案支援的暫時性資料庫，該檔案是在執行應用程式的電腦上建立。

下圖說明 sql_agent 與使用者之間的互動範例：

生成式 AI 代理執行的動作並非確定性，因此即使輸入相同的提示，回覆也可能會有差異。

結束應用程式

如要結束應用程式，請在用於啟動應用程式的殼層中輸入 Ctrl-C。

查看追蹤記錄、指標和記錄

本節說明如何查看生成式 AI 事件。

事前準備

如要取得查看記錄、指標和追蹤資料所需的權限，請要求管理員在專案中授予您下列 IAM 角色：

• 記錄檢視器 (roles/logging.viewer)
• Monitoring 檢視者 (roles/monitoring.viewer)
• Cloud Trace 使用者 (roles/cloudtrace.user)

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色，取得必要權限。

查看遙測資料

如要查看應用程式建立的生成式 AI 事件，請使用「Trace Explorer」頁面：

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

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

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

2. 在工具列中，依序選取「新增篩選器」和「範圍名稱」，然後選取 call_llm。

   下圖顯示篩選資料後的「Trace Explorer」頁面：

   

   如果您從未使用過 Cloud Trace，Google Cloud Observability 就需要建立資料庫來儲存追蹤資料。建立資料庫可能需要幾分鐘，這段期間無法查看任何追蹤資料。

3. 如要探索時距和記錄資料，請在「Spans」(時距) 表格中選取時距。

   「詳細資料」頁面隨即開啟。這個頁面會顯示相關聯的追蹤記錄及其範圍。頁面上的表格會顯示所選範圍的詳細資訊。這類資訊包括：

   • 「輸入/輸出」分頁會顯示生成式 AI 代理程式的事件。如要進一步瞭解這些事件，請參閱「查看生成式 AI 事件」一文。

     下圖顯示追蹤記錄，其中一個時距的名稱為 call_llm。該範圍會叫用為這個代理提供支援的 LLM (大型語言模型)。在本範例中，這是指 Gemini。 Gemini 範圍包含生成式 AI 事件：

     

   • 「記錄和事件」分頁會列出與時距相關聯的記錄項目和事件。如要在 Logs Explorer 中查看記錄資料，請在這個分頁的工具列中選取「查看記錄」。

     記錄資料包括 sql_agent 的回應。舉例來說，在範例執行中，JSON 酬載包含下列內容：

     {
       "logName": "projects/my-project/logs/otel_python_inprocess_log_name_temp",
       "jsonPayload": {
         "content": {
           "parts": [
             0: {
               "text": "Now I can create the table."
             }
             1: {1}
             ],
           "role": "model"
         }
       },
       ...
     }
     

這個範例已完成儀表化，可將指標資料傳送至您的 Google Cloud 專案，但不會產生任何指標。