View a markdown version of this page

OpenTelemetry Für GitHub Copilot einrichten - Amazon CloudWatch
VoraussetzungenKonfigurieren Sie den Metrik-ExporterFügen Sie Identitäts- und Organisationsattribute hinzuVerifizieren und ansehen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

OpenTelemetry Für GitHub Copilot einrichten

GitHub Copilot sendet OpenTelemetry (OTel) -Metriken zur Token-Nutzung, zu Anfragen, Toolaufrufen und zur Latenz aus. Wenn Sie diese Metriken an Amazon senden CloudWatch, werden sie auf der Registerkarte GitHub Copilot der Coding Agent Insights-Dashboards angezeigt. Weitere Informationen zu den Dashboards finden Sie unter. Einblicke in Coding Agent

Copilot sendet OTLP-Metriken direkt an den CloudWatch systemeigenen OTLP-Metriken-Endpunkt und authentifiziert sich mit einem Inhaber-Token (einem Metrik-API-Schlüssel). CloudWatch OpenTelemetry Es ist kein Collector erforderlich. Das Inhaber-Token ist heute der unterstützte Pfad für Copilot.

Anmerkung

In diesem Handbuch wird nur beschrieben, wie Copilots OTel-Metriken ausgegeben werden. Dies ist unabhängig davon CloudWatch, wie Copilot ein Inferenzmodell nennt. Copilot verwendet standardmäßig seine eigenen Modelle, aber Unternehmen können ihre eigenen Modelanbieterschlüssel mitbringen — einschließlich Amazon Bedrock. Weitere Informationen finden Sie in der Copilot-Dokumentation unter Verwenden Sie Ihre eigenen API-Schlüssel. GitHub

Wichtig

Inhaber-Token sind langfristige Anmeldeinformationen. Wir empfehlen sie nur, wenn kurzfristige AWS Anmeldedaten nicht möglich sind, wie z. B. Entwickler-Laptops im Freien AWS. Hinweise zu Sicherheitsabwägungen und Anleitungen zur Schlüsselrotation finden Sie unter. Inhaber-Token-Authentifizierung für Metriken einrichten

Voraussetzungen

  • GitHub Copilot ist auf einer Version installiert, die den Export von Messwerten unterstützt. OpenTelemetry

  • Ein aktives GitHub Copilot-Abonnement für Modellinferenz. Copilot verwendet standardmäßig seine eigenen Modelle. Um stattdessen Amazon Bedrock zu verwenden, konfigurieren Sie einen benutzerdefinierten Modellschlüssel, wie in Verwenden Sie Ihre eigenen API-Schlüssel in der Copilot-Dokumentation beschrieben. GitHub

  • Ein CloudWatch Metrik-API-Schlüssel (Bearer-Token), der von einem IAM-Benutzer mit Metrikberechtigungen erstellt wurde. CloudWatch Informationen zum Verfahren, das den IAM-Benutzer erstellt und den Schlüssel generiert, finden Sie unter. Inhaber-Token-Authentifizierung für Metriken einrichten

Konfigurieren Sie den Metrik-Exporter

Konfigurieren Sie den OpenTelemetry Copilot-Exporter so, dass er Metriken mit Ihrem Bearer-Token im CloudWatch Header an den Metrik-Endpunkt sendet. Authorization Legen Sie die folgenden Umgebungsvariablen in der Umgebung fest, in der Copilot gestartet wird. Auf „Einschalten“ einstellenCOPILOT_OTEL_ENABLED=true. OpenTelemetry Copilot verwendet die OpenTelemetry Standardvariablen für alle Signale; metrikspezifische Überschreibungen werden nicht unterstützt. Auf OTEL_EXPORTER_OTLP_ENDPOINT den Basisendpunkt ohne Pfad setzen — das Exportprogramm hängt den /v1/metrics Signalpfad für Sie an.

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

Behandeln Sie das Inhaber-Token als Geheimnis. Vermeiden Sie es, es der Quellcodeverwaltung oder gemeinsam genutzten Shell-Profilen zuzuweisen, und drehen Sie den Schlüssel regelmäßig, wie unter beschrieben. Inhaber-Token-Authentifizierung für Metriken einrichten

Fügen Sie Identitäts- und Organisationsattribute hinzu

Die Coding Agent Insights-Dashboards gruppieren die Nutzung nach Entwickler, Team, Abteilung und anderen organisatorischen Dimensionen. Stellen Sie diese als OTel-Ressourcenattribute über die OTEL_RESOURCE_ATTRIBUTES Umgebungsvariable bereit. Legen Sie die Werte fest, die sich aus der Identität Ihres Entwicklers und der Struktur Ihrer Organisation ergeben.

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"

Verifizieren und ansehen

Verwenden Sie Copilot, um Metriken zu generieren, und bestätigen Sie dann, dass die Daten erreicht wurden. CloudWatch

Um Metriken zu verifizieren

  1. Verwenden Sie Copilot, um einige Arbeiten zur Generierung von Telemetrie durchzuführen.

  2. Wählen Sie in der CloudWatch Konsole GenAI Observability, Coding Agent Insights und dann den Copilot-Tab aus. GitHub Metriken werden in der Regel innerhalb weniger Minuten angezeigt.

  3. Optional können Sie die Metriken direkt mit PromQL abfragen. Weitere Informationen finden Sie unter PromQL-Abfrage.