Instrumenter des applications ADK avec OpenTelemetry

Aperçu

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" de la section "Conditions générales du service" des Conditions spécifiques du service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une prise en charge limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Ce document explique comment instrumenter un agent d'IA créé avec le framework Agent Development Kit (ADK). Le framework ADK inclut l'instrumentation OpenTelemetry qui collecte les données de télémétrie des actions clés de l'agent. Lorsque vous activez l'instrumentation intégrée, elle envoie des informations telles que les requêtes textuelles et les réponses de l'agent à votre projet Google Cloud . Ce document décrit les modifications requises et fournit un lien vers un exemple d'application.

Les applications qui utilisent l'ADK peuvent également collecter des requêtes et des réponses multimodales. Ce document explique comment collecter des requêtes et des réponses textuelles. Si vous souhaitez collecter des données multimodales, une configuration supplémentaire est requise. Pour en savoir plus, consultez Collecter et afficher les requêtes et réponses multimodales.

L'observabilité par défaut fournie par ADK peut ne pas être suffisante pour le cas d'utilisation de votre application. Vous pouvez ajouter des bibliothèques d'instrumentation supplémentaires à l'aide d'OpenTelemetry pour capturer la télémétrie d'autres éléments de votre application, ou votre propre instrumentation personnalisée pour capturer des données spécifiques à l'application afin d'obtenir une observabilité plus précise. Par exemple, dans votre application, vous pouvez écrire du code d'instrumentation pour :

• Suivez la consommation de ressources des outils invoqués par l'agent.
• Suivez les échecs de validation spécifiques à l'application, les non-respects des règles métier ou les mécanismes de récupération d'erreur personnalisés.
• Suivez les scores de qualité des réponses de l'agent en fonction de vos critères spécifiques au domaine.

Remarque : Ce document part du principe que vous utilisez un framework ADK version 1.17.0 ou ultérieure.

Instrumenter votre application d'IA générative pour collecter des données de télémétrie

Pour instrumenter votre agent d'IA afin de collecter des données de journaux, de métriques et de trace, procédez comme suit :

1. Installez les packages OpenTelemetry.
2. Configurez votre environnement ADK.

Le reste de cette section décrit les étapes précédentes.

Installer les packages OpenTelemetry

Ajoutez les packages d'instrumentation et d'exportateur OpenTelemetry suivants :

pip install 'google-adk>=1.17.0' \
  'opentelemetry-instrumentation-google-genai>=0.4b0' \
  'opentelemetry-instrumentation-sqlite3' \
  'opentelemetry-exporter-gcp-logging' \
  'opentelemetry-exporter-gcp-monitoring' \
  'opentelemetry-exporter-otlp-proto-grpc' \
  'opentelemetry-instrumentation-vertexai>=2.0b0'

Les données de journaux et de métriques sont envoyées à votre projet Google Cloud à l'aide de l'API Cloud Logging ou de l'API Cloud Monitoring. Les bibliothèques opentelemetry-exporter-gcp-logging et opentelemetry-exporter-gcp-monitoring appellent les points de terminaison de ces API.

Les données de trace sont envoyées à Google Cloud à l'aide de l'API Telemetry (OTLP), qui implémente le protocole OpenTelemetry Line. La bibliothèque opentelemetry-exporter-otlp-proto-grpc appelle le point de terminaison de l'API de télémétrie (OTLP).

Vos données de trace sont stockées dans un format généralement compatible avec les fichiers proto définis par le protocole OpenTelemetry Line. Toutefois, les champs peuvent être convertis d'un type de données spécifique à OpenTelemetry en type de données JSON avant d'être stockés. Pour en savoir plus sur le format de stockage, consultez Schéma des données de trace.

Configurer votre environnement ADK

Les versions 1.17.0 et ultérieures du framework ADK incluent une compatibilité intégrée avec OpenTelemetry et l'envoi de données de télémétrie OpenTelemetry àGoogle Cloud  Observability. Pour ce faire, configurez votre environnement ADK :

• Si vous exécutez votre application avec la commande adk web, incluez l'indicateur --otel_to_cloud.

• Dans votre fichier opentelemetry.env, définissez les variables d'environnement suivantes :

  OTEL_SERVICE_NAME='adk-sql-agent'
  OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED='true'
  

• Configurez OpenTelemetry pour utiliser les conventions sémantiques les plus récentes pour l'IA générative.

  OTEL_SEMCONV_STABILITY_OPT_IN='gen_ai_latest_experimental'
  

• Configurez OpenTelemetry pour associer les messages en tant qu'événements.

  OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT='EVENT_ONLY'
  

  Remarque : Ne définissez pas la valeur de cette variable sur true. Lorsque vous utilisez les conventions sémantiques les plus récentes, la définition de la valeur de cette variable sur true entraîne une configuration non valide. Par conséquent, les données de journaux et de trace ne sont pas collectées.

  Pour en savoir plus sur les valeurs énumérées autorisées, consultez genai/types.py.

• Nous vous recommandons également d'ajouter la variable d'environnement suivante à votre fichier opentelemetry.env :

  ADK_CAPTURE_MESSAGE_CONTENT_IN_SPANS='false'
  

  Cette variable d'environnement effectue les opérations suivantes :

  • Empêche l'instrumentation ADK d'associer des attributs de portée qui dépassent la limite de taille des attributs.
  • Empêche l'ajout d'informations permettant d'identifier personnellement l'utilisateur aux spans en tant qu'attributs.

• Vous devrez peut-être définir d'autres variables d'environnement. Par exemple, si vous déployez sur Gemini Enterprise Agent Platform, vous devez également définir la variable d'environnement suivante :

  GOOGLE_CLOUD_AGENT_ENGINE_ENABLE_TELEMETRY='true'
  

Télécharger et exécuter l'exemple d'application

Cet exemple de code implémente un agent d'IA générative créé à l'aide de l'ADK. L'agent est instrumenté avec OpenTelemetry et configuré pour envoyer des métriques, des traces et des journaux à votre projet Google Cloud . La télémétrie envoyée à votre projet inclut les requêtes et les réponses de l'IA générative.

Persona d'agent ADK

L'agent d'IA générative est défini comme un expert SQL ayant un accès complet à une base de données SQLite éphémère. L'agent est créé avec l'Agent Development Kit et accède à une base de données à l'aide de l'SQLDatabaseToolkit. La base de données est initialement vide.

Avant de commencer

Connectez-vous à votre compte Google Cloud . Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits sans frais pour exécuter, tester et déployer des charges de travail.

Installez la Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Créez ou sélectionnez un projet Google Cloud .

Rôles requis pour sélectionner ou créer un projet

• Sélectionnez un projet : la sélection d'un projet ne nécessite pas de rôle IAM spécifique. Vous pouvez sélectionner n'importe quel projet pour lequel un rôle vous a été attribué.
• Créer un projet : pour créer un projet, vous devez disposer du rôle Créateur de projet (roles/resourcemanager.projectCreator), qui contient l'autorisation resourcemanager.projects.create. Découvrez comment attribuer des rôles.

Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

• Créez un projet Google Cloud  :

  gcloud projects create PROJECT_ID

  Remplacez PROJECT_ID par le nom du projet Google Cloud que vous créez.

• Sélectionnez le projet Google Cloud que vous avez créé :

  gcloud config set project PROJECT_ID

  Remplacez PROJECT_ID par le nom de votre projet Google Cloud .

Vérifiez que la facturation est activée pour votre projet Google Cloud .

Activez les API Vertex AI, Télémétrie, Cloud Logging, Cloud Monitoring et Cloud Trace :

Rôles requis pour activer les API

Pour activer les API, vous avez besoin du rôle IAM Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin), qui contient l'autorisation serviceusage.services.enable. Découvrez comment attribuer des rôles.

gcloud services enable aiplatform.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com

Installez la Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Créez ou sélectionnez un projet Google Cloud .

Rôles requis pour sélectionner ou créer un projet

• Sélectionnez un projet : la sélection d'un projet ne nécessite pas de rôle IAM spécifique. Vous pouvez sélectionner n'importe quel projet pour lequel un rôle vous a été attribué.
• Créer un projet : pour créer un projet, vous devez disposer du rôle Créateur de projet (roles/resourcemanager.projectCreator), qui contient l'autorisation resourcemanager.projects.create. Découvrez comment attribuer des rôles.

Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

• Créez un projet Google Cloud  :

  gcloud projects create PROJECT_ID

  Remplacez PROJECT_ID par le nom du projet Google Cloud que vous créez.

• Sélectionnez le projet Google Cloud que vous avez créé :

  gcloud config set project PROJECT_ID

  Remplacez PROJECT_ID par le nom de votre projet Google Cloud .

Vérifiez que la facturation est activée pour votre projet Google Cloud .

Activez les API Vertex AI, Télémétrie, Cloud Logging, Cloud Monitoring et Cloud Trace :

Rôles requis pour activer les API

Pour activer les API, vous avez besoin du rôle IAM Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin), qui contient l'autorisation serviceusage.services.enable. Découvrez comment attribuer des rôles.

gcloud services enable aiplatform.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com

1. Si vous exécutez l'exemple dans Cloud Shell, sur des ressources Google Cloudou dans un environnement de développement local, les autorisations listées dans cette section sont suffisantes. Pour les applications de production, un compte de service fournit généralement les identifiants permettant d'écrire des données de journaux, de métriques et de trace.

   Pour obtenir les autorisations nécessaires pour que l'application exemple écrive des données de journaux, de métriques et de trace, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

   • Rédacteur de traces de télémétrie cloud (roles/telemetry.tracesWriter)
   • Rédacteur de journaux (roles/logging.logWriter)
   • Rédacteur de métriques Monitoring (roles/monitoring.metricWriter)
   • Utilisateur Vertex AI (roles/aiplatform.user)

Lancer l'application

Pour lancer l'exemple d'application, procédez comme suit :

1. Dans Cloud Shell, exécutez la commande suivante :

   git clone https://github.com/GoogleCloudPlatform/opentelemetry-operations-python.git
   

2. Accédez au répertoire de l'exemple :

   cd opentelemetry-operations-python/samples/adk-sql-agent
   

3. Créez un environnement virtuel et exécutez l'exemple :

   python -m venv venv/
   source venv/bin/activate
   pip install -r requirements.txt
   env $(cat opentelemetry.env | xargs) adk web --otel_to_cloud
   

   L'application affiche un message semblable à celui-ci :

   Appplication startup complete
   Uvicorn running on http://0.0.0.0:8080
   

4. Pour interagir avec l'agent, sélectionnez l'URL affichée dans le résultat de l'étape précédente.

5. Développez Sélectionner un agent, puis sélectionnez sql_agent dans la liste des agents.

Interagir avec l'agent

Pour interagir avec l'agent, posez-lui une question ou donnez-lui une instruction. Par exemple, vous pouvez poser la question suivante :

What can you do for me ?

De même, puisque sql_agent a la personnalité d'un expert SQL, vous pouvez lui demander de créer des tables pour vos applications et d'écrire des requêtes pour les utiliser. L'agent ne peut créer qu'une base de données éphémère soutenue par un fichier .db créé sur la machine exécutant l'application.

L'exemple suivant illustre une interaction entre sql_agent et l'utilisateur :

Les actions effectuées par les agents d'IA générative ne sont pas déterministes. Vous pouvez donc obtenir une réponse différente pour le même prompt.

Quitter l'application

Pour quitter l'application, saisissez Ctrl-C dans l'interface système utilisée pour la lancer.

Afficher les traces, les métriques et les journaux

Cette section explique comment afficher les événements d'IA générative.

Avant de commencer

Pour obtenir les autorisations nécessaires pour afficher vos données de journaux, de métriques et de traces, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

• Lecteur de journaux (roles/logging.viewer)
• Lecteur Monitoring (roles/monitoring.viewer)
• Utilisateur Cloud Trace (roles/cloudtrace.user)

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Afficher la télémétrie

Pour afficher les événements d'IA générative créés par l'application, utilisez la page Trace Explorer :

1. Dans la console Google Cloud , accédez à la page  Explorateur Trace :

   Accéder à Explorateur Trace

   Vous pouvez également accéder à cette page à l'aide de la barre de recherche.

2. Dans la barre d'outils, sélectionnez Ajouter un filtre, puis Nom du segment, puis call_llm.

   L'illustration suivante montre la page Trace Explorer après le filtrage des données :

   

   Si vous n'avez jamais utilisé Cloud Trace, Google Cloud Observability doit créer une base de données pour stocker vos données de trace. La création de la base de données peut prendre quelques minutes. Pendant cette période, aucune donnée de trace n'est disponible.

3. Pour explorer vos données de segment et de journaux, sélectionnez un segment dans le tableau Segments.

   La page Détails s'affiche. Cette page affiche la trace associée et ses spans. Le tableau sur la page affiche des informations détaillées sur la plage que vous avez sélectionnée. Voici quelques exemples :

   • L'onglet Entrées/Sorties affiche les événements des agents d'IA générative. Pour en savoir plus sur ces événements, consultez Afficher les événements d'IA générative.

     La capture d'écran suivante illustre une trace dans laquelle un segment porte le nom call_llm. Cette étendue appelle le LLM (grand modèle de langage) qui alimente cet agent. Dans cet exemple, il s'agit de Gemini. La couverture Gemini inclut les événements d'IA générative suivants :

     

   • L'onglet Journaux et événements liste les entrées de journaux et les événements associés au segment. Si vous souhaitez afficher les données de journal dans l'explorateur de journaux, sélectionnez Afficher les journaux dans la barre d'outils de cet onglet.

     Les données du journal incluent la réponse de sql_agent. Par exemple, pour l'exécution de l'échantillon, la charge utile JSON inclut le contenu suivant :

     {
       "logName": "projects/my-project/logs/otel_python_inprocess_log_name_temp",
       "jsonPayload": {
         "content": {
           "parts": [
             0: {
               "text": "Now I can create the table."
             }
             1: {1}
             ],
           "role": "model"
         }
       },
       ...
     }
     

L'exemple est instrumenté pour envoyer des données de métriques à votre projet Google Cloud , mais il ne génère aucune métrique.