View a markdown version of this page

Configuration OpenTelemetry pour GitHub Copilot - Amazon CloudWatch
Conditions préalablesConfiguration de l'exportateur de métriquesAjouter des attributs d'identité et d'organisationVérifiez et visualisez

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configuration OpenTelemetry pour GitHub Copilot

GitHub Copilot émet des métriques OpenTelemetry (OTel) concernant l'utilisation des jetons, les demandes, les appels aux outils et la latence. Lorsque vous envoyez ces métriques à Amazon CloudWatch, elles s'affichent dans l'onglet GitHub Copilot des tableaux de bord de Coding Agent Insights. Pour plus d'informations sur les tableaux de bord, consultezInformations sur les agents de codage.

Copilot envoie les métriques OTLP directement au point de terminaison des métriques OTLP CloudWatch natif et s'authentifie à l'aide d'un jeton porteur (une clé API de métriques). CloudWatch Aucun OpenTelemetry collecteur n'est requis. Le jeton porteur est la voie prise en charge par Copilot aujourd'hui.

Note

Ce guide explique uniquement comment émettre les métriques OTel de Copilot CloudWatch, indépendamment de la façon dont Copilot appelle un modèle à des fins d'inférence. Copilot utilise ses propres modèles par défaut, mais les entreprises peuvent apporter leurs propres clés de fournisseur de modèles, y compris Amazon Bedrock. Pour plus d'informations, consultez Utiliser vos propres clés d'API dans la documentation de GitHub Copilot.

Important

Les jetons au porteur sont des informations d'identification à long terme. Nous les recommandons uniquement lorsque les AWS informations d'identification à court terme ne sont pas réalisables, comme les ordinateurs portables pour développeurs extérieurs AWS. Pour les compromis en matière de sécurité et les conseils de rotation des clés, voirConfiguration de l'authentification par jeton porteur pour Metrics.

Conditions préalables

  • GitHub Copilot installé, sur une version qui prend en charge l'exportation OpenTelemetry des métriques.

  • Un abonnement GitHub Copilot actif pour l'inférence de modèles. Copilot utilise ses propres modèles par défaut ; pour utiliser Amazon Bedrock à la place, configurez une clé de modèle personnalisée comme décrit dans la section Utiliser vos propres clés d'API dans la GitHub documentation Copilot.

  • Une clé d'API de CloudWatch métriques (jeton porteur), créée par un utilisateur IAM autorisé à utiliser CloudWatch des métriques. Pour connaître la procédure de création de l'utilisateur IAM et de génération de la clé, consultezConfiguration de l'authentification par jeton porteur pour Metrics.

Configuration de l'exportateur de métriques

Configurez l' OpenTelemetry exportateur de Copilot pour envoyer les métriques au point de terminaison CloudWatch des métriques avec votre jeton porteur dans l'en-tête. Authorization Définissez les variables d'environnement suivantes dans l'environnement qui lance Copilot. COPILOT_OTEL_ENABLED=trueRéglé pour s'allumer OpenTelemetry. Copilot utilise les OpenTelemetry variables standard pour tous les signaux ; il ne prend pas en charge les remplacements spécifiques aux métriques. Défini OTEL_EXPORTER_OTLP_ENDPOINT sur le point de terminaison de base sans le /v1/metrics chemin : l'exportateur ajoute le chemin du signal pour vous.

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

Traitez le jeton porteur comme un secret. Évitez de l'affecter au contrôle de source ou à des profils de shell partagés, et faites pivoter la clé périodiquement, comme décrit dansConfiguration de l'authentification par jeton porteur pour Metrics.

Ajouter des attributs d'identité et d'organisation

Les tableaux de bord Coding Agent Insights regroupent l'utilisation par développeur, équipe, département et autres dimensions organisationnelles. Fournissez-les sous forme d'attributs de ressource OTel via la variable d'OTEL_RESOURCE_ATTRIBUTESenvironnement. Définissez les valeurs à partir de l'identité de votre développeur et de la structure de votre organisation.

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"

Vérifiez et visualisez

Utilisez Copilot pour générer des métriques, puis confirmez les données atteintes. CloudWatch

Pour vérifier les métriques

  1. Utilisez Copilot pour effectuer des tâches qui génèrent de la télémétrie.

  2. Dans la CloudWatch console, choisissez GenAI Observability, Coding Agent Insights, puis l'onglet GitHub Copilot. Les métriques apparaissent généralement en quelques minutes.

  3. Vous pouvez éventuellement interroger les métriques directement avec ProMQL. Pour de plus amples informations, veuillez consulter Requête ProMAL.