View a markdown version of this page

Siapkan OpenTelemetry untuk GitHub Copilot - Amazon CloudWatch
PrasyaratKonfigurasikan pengekspor metrikTambahkan identitas dan atribut organisasiVerifikasi dan lihat

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Siapkan OpenTelemetry untuk GitHub Copilot

GitHub Copilot memancarkan metrik OpenTelemetry (OTel) tentang penggunaan token, permintaan, panggilan alat, dan latensi. Saat Anda mengirim metrik ini ke Amazon CloudWatch, metrik tersebut mengisi tab GitHub Copilot pada dasbor Coding Agent Insights. Untuk informasi selengkapnya tentang dasbor, lihatWawasan Agen Pengkodean.

Copilot mengirimkan metrik OTLP langsung ke titik akhir metrik OTLP CloudWatch asli dan mengautentikasi dengan token pembawa (kunci API metrik). CloudWatch Tidak diperlukan OpenTelemetry kolektor. Token pembawa adalah jalur yang didukung untuk Copilot hari ini.

catatan

Panduan ini hanya mencakup cara memancarkan metrik OTel Copilot CloudWatch, yang tidak tergantung pada bagaimana Copilot memanggil model untuk inferensi. Copilot menggunakan modelnya sendiri secara default, tetapi perusahaan dapat membawa kunci penyedia model mereka sendiri—termasuk Amazon Bedrock. Untuk informasi selengkapnya, lihat Menggunakan kunci API Anda sendiri dalam dokumentasi GitHub Copilot.

penting

Token pembawa adalah kredensil jangka panjang. Kami merekomendasikan mereka hanya jika AWS kredensi jangka pendek tidak layak, seperti laptop pengembang di luar. AWS Untuk panduan pertukaran keamanan dan rotasi kunci, lihat. Menyiapkan otentikasi token pembawa untuk Metrik

Prasyarat

  • GitHub Copilot diinstal, pada versi yang mendukung ekspor OpenTelemetry metrik.

  • Langganan GitHub Copilot aktif untuk inferensi model. Copilot menggunakan modelnya sendiri secara default; untuk menggunakan Amazon Bedrock sebagai gantinya, konfigurasikan kunci model kustom seperti yang dijelaskan dalam Gunakan kunci API Anda sendiri dalam dokumentasi Copilot. GitHub

  • Kunci API CloudWatch metrik (token pembawa), dibuat dari pengguna IAM yang memiliki CloudWatch izin metrik. Untuk prosedur yang membuat pengguna IAM dan menghasilkan kunci, lihatMenyiapkan otentikasi token pembawa untuk Metrik.

Konfigurasikan pengekspor metrik

Konfigurasikan OpenTelemetry eksportir Copilot untuk mengirim metrik ke titik akhir CloudWatch metrik dengan token pembawa Anda di header. Authorization Atur variabel lingkungan berikut di lingkungan yang meluncurkan Copilot. Setel COPILOT_OTEL_ENABLED=true untuk menghidupkan OpenTelemetry. Copilot menggunakan OpenTelemetry variabel standar untuk semua sinyal; itu tidak mendukung penggantian spesifik metrik. Setel OTEL_EXPORTER_OTLP_ENDPOINT ke titik akhir dasar tanpa /v1/metrics jalur — eksportir menambahkan jalur sinyal untuk Anda.

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"
catatan

Perlakukan token pembawa sebagai rahasia. Hindari melakukan itu ke kontrol sumber atau profil shell bersama, dan putar kunci secara berkala seperti yang dijelaskan dalamMenyiapkan otentikasi token pembawa untuk Metrik.

Tambahkan identitas dan atribut organisasi

Dasbor Coding Agent Insights mengelompokkan penggunaan oleh pengembang, tim, departemen, dan dimensi organisasi lainnya. Berikan ini sebagai atribut sumber daya OTel melalui variabel OTEL_RESOURCE_ATTRIBUTES lingkungan. Tetapkan nilai dari identitas pengembang dan struktur organisasi Anda.

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"

Verifikasi dan lihat

Gunakan Copilot untuk menghasilkan metrik, lalu konfirmasikan data yang dicapai. CloudWatch

Untuk memverifikasi metrik

  1. Gunakan Copilot untuk melakukan beberapa pekerjaan yang menghasilkan telemetri.

  2. Di CloudWatch konsol, pilih GenAI Observability, Coding Agent Insights, dan kemudian tab Copilot. GitHub Metrik biasanya muncul dalam beberapa menit.

  3. Secara opsional, kueri metrik secara langsung dengan PromQL. Lihat informasi yang lebih lengkap di Kueri PromQL.