View a markdown version of this page

設定 GitHub Copilot 的 OpenTelemetry - Amazon CloudWatch
先決條件設定指標匯出工具新增身分和組織屬性驗證和檢視

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

設定 GitHub Copilot 的 OpenTelemetry

GitHub Copilot 會發出有關字符用量、請求、工具呼叫和延遲的 OpenTelemetry (OTel) 指標。當您將這些指標傳送至 Amazon CloudWatch 時，它們會填入編碼客服人員洞見儀表板的 GitHub Copilot 索引標籤。如需儀表板的詳細資訊，請參閱 編碼客服人員洞見。

Copilot 會將 OTLP 指標直接傳送至 CloudWatch 原生 OTLP 指標端點，並使用承載字符 (CloudWatch 指標 API 金鑰） 進行驗證。不需要 OpenTelemetry 收集器。承載字符是 Copilot 目前支援的路徑。

注意

本指南僅介紹如何向 CloudWatch 發出 Copilot 的 OTel 指標，這與 Copilot 如何呼叫模型進行推論無關。Copilot 預設會使用自己的模型，但企業可以攜帶自己的模型提供者金鑰，包括 Amazon Bedrock。如需詳細資訊，請參閱 GitHub Copilot 文件中的使用您自己的 API 金鑰。

重要

承載字符是長期憑證。我們建議僅在短期 AWS 登入資料不可行的情況下使用，例如外部的開發人員筆記型電腦 AWS。如需安全權衡和金鑰輪換指引，請參閱 設定指標的承載字符身分驗證。

先決條件

  • 在支援 OpenTelemetry 指標匯出的版本上安裝 GitHub Copilot。

  • 模型推論的作用中 GitHub Copilot 訂閱。Copilot 預設使用自己的模型；請改為使用 Amazon Bedrock，如 GitHub Copilot 文件中的使用您自己的 API 金鑰所述來設定自訂模型金鑰。

  • CloudWatch 指標 API 金鑰 （承載字符），從具有 CloudWatch 指標許可的 IAM 使用者建立。如需建立 IAM 使用者並產生金鑰的程序，請參閱 設定指標的承載字符身分驗證。

設定指標匯出工具

設定 Copilot 的 OpenTelemetry 匯出工具，以使用 Authorization標頭中的承載字符將指標傳送至 CloudWatch 指標端點。在啟動 Copilot 的環境中設定下列環境變數。設定 COPILOT_OTEL_ENABLED=true 以開啟 OpenTelemetry。Copilot 對所有訊號使用標準 OpenTelemetry 變數；它不支援指標特定覆寫。OTEL_EXPORTER_OTLP_ENDPOINT 設定為沒有/v1/metrics路徑的基本端點 — 匯出者會為您附加訊號路徑。

export COPILOT_OTEL_ENABLED=true
export OTEL_EXPORTER_OTLP_ENDPOINT="https://monitoring.region.amazonaws.com"
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer YOUR_API_KEY"
注意

將承載字符視為秘密。避免將其遞交至來源控制或共用 Shell 設定檔，並定期輪換金鑰，如中所述設定指標的承載字符身分驗證。

新增身分和組織屬性

編碼 Agent Insights 儀表板會依開發人員、團隊、部門和其他組織維度將用量分組。透過OTEL_RESOURCE_ATTRIBUTES環境變數提供這些做為 OTel 資源屬性。從開發人員的身分和組織的結構設定值。

export OTEL_RESOURCE_ATTRIBUTES="\
user.id=alias,\
user.email=developer@example.com,\
user.name=Jane Doe,\
department=engineering,\
team.id=platform,\
cost_center=cc-1234,\
organization=example-corp,\
location=us-seattle,\
role=software-engineer,\
manager=manager@example.com"

驗證和檢視

使用 Copilot 產生指標，然後確認到達 CloudWatch 的資料。

驗證指標

  1. 使用 Copilot 執行一些產生遙測的工作。

  2. 在 CloudWatch 主控台中，選擇 GenAI 可觀測性、編碼客服人員洞見，然後選擇 GitHub Copilot 標籤。指標通常會在幾分鐘內顯示。

  3. 或者，直接使用 PromQL 查詢指標。如需詳細資訊，請參閱PromQL 查詢。