View a markdown version of this page

Configurez OpenAI Codex avec un jeton porteur - Amazon CloudWatch

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.

Configurez OpenAI Codex avec un jeton porteur

Sur ce chemin, OpenAI Codex envoie OpenTelemetry (OTel) les métriques directement au point de terminaison des métriques OTLP CloudWatch natif d'Amazon et s'authentifie à l'aide d'un jeton porteur (une clé API de métriques). CloudWatch Aucun OpenTelemetry collecteur n'est requis. C'est le moyen le plus rapide pour un développeur individuel ou une petite équipe d'intégrer les métriques du Codex dans les tableaux de bord de Coding Agent Insights.

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, par exemple lorsque des ordinateurs portables destinés aux développeurs ne sont pas disponibles à l'extérieur AWS. Pour les compromis en matière de sécurité et les conseils relatifs à la rotation des clés, voirConfiguration de l'authentification par jeton porteur pour Metrics. Organisations qui fédérent les identités par le biais du SSO d'entreprise devraient plutôt utiliser le déploiement en entreprise. Consultez Configurez OpenAI Codex pour un déploiement en entreprise.

Conditions préalables

  • OpenAI Codex installé sur la machine du développeur.

  • Une méthode efficace pour le Codex d'appeler un modèle à des fins d'inférence. Cette configuration de télémétrie est indépendante de l'inférence. Vous pouvez donc utiliser un compte OpenAI (le fournisseur Codex par défaut) ou Amazon Bedrock. Pour utiliser Amazon Bedrock à des fins d'inférence, consultez Amazon Bedrock dans la documentation OpenAI Codex.

  • 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

Le Codex lit sa configuration à partir de. ~/.codex/config.toml Ajoutez une [otel.metrics_exporter] section qui pointe vers le point de terminaison OTLP des CloudWatch métriques et envoie votre jeton porteur dans l'Authorizationen-tête. Incluez le /v1/metrics chemin complet ; le Codex ne l'ajoute pas pour vous.

[otel] environment = "production" [otel.metrics_exporter] otlp-http = { endpoint = "https://monitoring.region.amazonaws.com/v1/metrics", protocol = "binary", headers = { "Authorization" = "Bearer YOUR_API_KEY" } }
Note

Certaines versions du Codex n'étendent pas les variables d'environnement dans les valeurs d'en-tête, de sorte que la clé d'API est affichée en ligne. Traitez-le config.toml comme un secret : limitez ses autorisations de fichier (par exemple,chmod 600 ~/.codex/config.toml) et ne le confiez pas au contrôle de source.

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 dans le shell qui lance Codex. 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"
Note

Leur définition en tant qu'attributs de ressource (plutôt qu'en tant qu'attributs par point de données) correspond à la forme attendue par les tableaux de bord. Vous pouvez donc les regrouper par @resource.team.id@resource.department, et par étiquettes similaires. Le Codex estampille automatiquement les dimensions au niveau des métriques, telles que model et token_type sur les métriques.

Vérifiez et visualisez

Exécutez le Codex pendant quelques tours pour générer des métriques, puis confirmez les données atteintes CloudWatch.

Pour vérifier les métriques
  1. Lancez une session Codex qui exécute un certain travail (par exemple, demandez-lui d'exécuter une commande et de modifier un fichier).

  2. Dans la CloudWatch console, choisissez GenAI Observability, Coding Agent Insights, puis l'onglet Codex. 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.

Pour obtenir des conseils complets et continuellement mis à jour, consultez les conseils pour le Codex sur Amazon Bedrock sur. GitHub