Surveiller l'état

Les instances Gemini Enterprise Agent Platform Workbench fournissent plusieurs méthodes de surveillance de l'état de vos notebooks. Cette page explique comment utiliser chaque méthode.

Méthodes de surveillance de l'état de fonctionnement

Vous pouvez surveiller l'état de vos instances Agent Platform Workbench de différentes manières. Cette page explique comment utiliser les méthodes suivantes :

• Utiliser les attributs d'invité pour signaler l'état du système

• Transmettre des métriques personnalisées à Cloud Monitoring

• Transmettre les métriques du système et des applications à Monitoring en installant Monitoring sur une instance Agent Platform Workbench

• Utiliser l'outil de diagnostic

Avant de commencer

1. In the Cloud de Confiance console, on the project selector page, select or create a Cloud de Confiance project.

   Roles required to select or create a project

   • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
   • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

   Go to project selector

2. Verify that billing is enabled for your Cloud de Confiance project.

3. Enable the Notebooks API, if it is not already enabled.

   Roles required to enable APIs

   To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

   Enable the API

4. Install the Google Cloud CLI.

5. Configure the gcloud CLI to use your federated identity.

   For more information, see Sign in to the gcloud CLI with your federated identity.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

Utiliser les attributs d'invité pour signaler l'état du système

Vous pouvez utiliser les attributs d'invité pour signaler l'état du système des services principaux suivants :

• Service Docker
• Agent de proxy inverse Docker
• Service Jupyter
• API Jupyter

Les attributs d'invité sont un type spécifique de métadonnées personnalisées auxquelles vos applications peuvent accéder en écriture alors qu'elles sont en cours d'exécution sur votre instance Agent Platform Workbench. Pour en savoir plus sur les attributs d'invité, consultez la page À propos des métadonnées de VM.

Comment les instances utilisent les attributs d'invité pour signaler l'état du système

Le service notebooks-collection-agent exécute un processus Python en arrière-plan qui vérifie l'état des services principaux de l'instance Agent Platform Workbench et met à jour les attributs invités en tant que 1 si aucun problème n'est détecté ou -1 en cas de défaillance.

Pour utiliser le service notebooks-collection-agent afin de générer des rapports sur l'état de votre instance Agent Platform Workbench, vous devez activer les attributs d'invité suivants lors de la création d'une instance Agent Platform Workbench :

• enable-guest-attributes=TRUE : active les attributs d'invité sur votre instance Agent Platform Workbench. Toutes les nouvelles instances activent cet attribut par défaut.
• report-event-health=TRUE : enregistre les résultats de la vérification de l'état du système dans vos attributs d'invité.

Le service notebooks-collection-agent ne nécessite aucune autorisation spéciale pour écrire dans les attributs d'invité de l'instance.

Créer une instance Agent Platform Workbench avec les attributs d'invité de l'état du système activés

Pour utiliser les attributs d'invité de l'état du système pour générer des rapports sur l'état de l'instance Agent Platform Workbench, vous devez cocher la case Activer les rapports sur l'état du système lorsque vous créez une instance Agent Platform Workbench.

Vous pouvez activer les rapports d'état du système à l'aide de la console Cloud de Confiance ou de Google Cloud CLI.

Surveiller l'état du système via les attributs d'invité

Pour les instances Agent Platform Workbench sur lesquelles les attributs d'invité associés sont activés, vous pouvez récupérer les valeurs des attributs d'invité de l'état du système à l'aide de la console Cloud de Confiance , de Google Cloud CLI avec les commandes Compute Engine ou de Google Cloud CLI avec les commandes Gemini Enterprise Agent Platform Workbench.

gcloud compute instances get-guest-attributes INSTANCE_NAME \
    --zone ZONE

 NAMESPACE   KEY                         VALUE
 notebooks   docker_proxy_agent_status   1
 notebooks   docker_status               1
 notebooks   jupyterlab_api_status       1
 notebooks   jupyterlab_status           1
 notebooks   system-health               1
 notebooks   updated                     2023-06-20 17:00:00.12345

 NAMESPACE   KEY                         VALUE
 notebooks   docker_proxy_agent_status   -1
 notebooks   docker_status               -1
 notebooks   jupyterlab_api_status       1
 notebooks   jupyterlab_status           1
 notebooks   system-health               -1
 notebooks   updated                     2023-06-20 17:00:00.12345

Transmettre des métriques personnalisées à Monitoring

Les instances Agent Platform Workbench vous permettent de collecter l'état du système et les métriques JupyterLab, et de les transmettre à Cloud Monitoring. Ces métriques personnalisées sont différentes des métriques standards transmises lorsque vous installez Monitoring sur votre instance Agent Platform Workbench.

Les métriques personnalisées transmises à Monitoring incluent les éléments suivants :

• L'état du système de ces services principaux Agent Platform Workbench :

  • Service Docker
  • Agent de proxy inverse Docker
  • Service Jupyter
  • API Jupyter

• Les métriques JupyterLab suivantes :

  • Nombre de noyaux
  • Nombre de terminaux
  • Nombre de connexions
  • Nombre de sessions
  • Taille maximale de la mémoire
  • Haute capacité de mémoire
  • Mémoire actuelle

Transmettre des métriques personnalisées à Monitoring à l'aide d'instances

Pour transmettre des métriques personnalisées à Monitoring, vous devez activer le paramètre de métadonnées report-notebook-metrics lors de la création d'une instance Agent Platform Workbench.

Vous devez également vous assurer que le compte de service de l'instance Agent Platform Workbench dispose des autorisations du rôle "Rédacteur de métriques Monitoring" (roles/monitoring.metricWriter). Pour en savoir plus, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Créer une instance Gemini Enterprise Agent Platform Workbench qui transmet des métriques personnalisées à Monitoring

Pour signaler des métriques personnalisées à Monitoring, vous devez cocher la case Signaler des métriques personnalisées à Cloud Monitoring lorsque vous créez une instance Agent Platform Workbench.

Vous pouvez activer la création de rapports personnalisés sur les métriques dans Cloud Monitoring à l'aide de la console Cloud de Confiance ou de gcloud CLI.

Accorder les autorisations du rôle "Rédacteur de métriques Monitoring" au compte de service

Après avoir créé votre instance Agent Platform Workbench, accordez les autorisations du rôle "Rédacteur de métriques Monitoring" (roles/monitoring.metricWriter) au compte de service pour l'instance Agent Platform Workbench. Pour en savoir plus, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Surveiller des métriques personnalisées à l'aide de Monitoring

Pour les instances Agent Platform Workbench sur lesquelles les rapports sur les métriques personnalisées sont activés, vous pouvez surveiller les métriques personnalisées à l'aide de la console Cloud de Confiance .

1. Dans la console Cloud de Confiance , accédez à la page Instances.

   Accéder à la page "Instances"

2. Cliquez sur le nom de l'instance pour laquelle vous souhaitez afficher les métriques personnalisées.

3. Sur la page Détails de l'instance, cliquez sur l'onglet Monitoring. Examinez les métriques personnalisées de votre instance.

Installer Monitoring sur une instance

Cette option installe automatiquement Monitoring. L'installation nécessite 256 Mo d'espace disque. Une connexion Internet est nécessaire pour la transmission des métriques à Monitoring.

Créer des métriques du système et des applications à l'aide d'instances

Pour créer des rapports sur les métriques du système et des applications en installant Cloud Monitoring sur votre instance Agent Platform Workbench, vous devez cocher la case Installer l'agent Cloud Monitoring lorsque vous créez une instance Agent Platform Workbench. Ces métriques sont différentes des métriques personnalisées qui sont transmises lorsque vous activez le paramètre de métadonnées report-notebook-metrics.

Créer une instance Agent Platform Workbench qui transmet les métriques du système et des applications à Monitoring

Pour installer Monitoring sur votre instance Agent Platform Workbench, vous pouvez utiliser la console Cloud de Confiance ou la gcloud CLI.

Surveiller les métriques du système et des applications à l'aide de Monitoring

Pour les instances Agent Platform Workbench sur lesquelles Monitoring est installé, vous pouvez surveiller les métriques du système et des applications à l'aide de la console Cloud de Confiance  :

1. Dans la console Cloud de Confiance , accédez à la page Instances.

   Accéder à la page "Instances"

2. Cliquez sur le nom de l'instance pour laquelle vous souhaitez afficher les métriques du système et de l'application.

3. Sur la page Détails de l'instance, cliquez sur l'onglet Monitoring. Examinez les métriques du système et des applications de votre instance. Pour apprendre à interpréter ces métriques, consultez la page Examiner les métriques de ressources.

Surveiller l'état du système à l'aide de l'outil de diagnostic

Les instances Agent Platform Workbench incluent un outil de diagnostic intégré qui permet de surveiller l'état du système de vos instances.

Tâches effectuées par l'outil de diagnostic

L'outil de diagnostic effectue les tâches suivantes :

• Il vérifie l'état des services principaux Agent Platform Workbench suivants :

  • Service Docker
  • Agent de proxy inverse Docker
  • Service Jupyter
  • API Jupyter

• Cet attribut permet de vérifier si l'espace disque des disques de démarrage et de données est utilisé au-delà d'un seuil de 85 %.

• Il installe lsof (connexion Internet requise).

• Il collecte les journaux d'instance suivants :

  • Informations sur le réseau (ifconfig, netstat)
  • Journaux dans le dossier /var/log/
  • Informations sur l'état de Docker
  • Données lsof (ouvrir les fichiers)
  • État du service Docker
  • État de l'agent de proxy inverse
  • État du service Jupyter
  • État de l'API Jupyter
  • Fichier de configuration de l'agent de proxy
  • Processus Python

• Exécute les commandes suivantes et collecte les résultats :

  • pip freeze
  • conda list
  • gcloud compute instances describe INSTANCE_NAME
  • gcloud config list

Lancer l'outil de diagnostic

Si votre instance utilise un conteneur personnalisé, consultez Exécuter l'outil de diagnostic dans la documentation sur les conteneurs personnalisés Agent Platform Workbench.

Pour exécuter l'outil de diagnostic dans une instance qui n'utilise pas de conteneur personnalisé, procédez comme suit :

1. Utilisez ssh pour vous connecter à votre instance Agent Platform Workbench.

2. Dans le terminal SSH, exécutez les commandes suivantes :

   sudo -i
   cd /opt/deeplearning/bin/
   ./diagnostic_tool.sh

   L'outil de diagnostic collecte les journaux, les compresse dans un fichier .tar.gz, puis place le fichier dans le dossier /tmp/.

3. Extrayez le fichier, puis évaluez le contenu. Contenu :

   • Dossier log : journaux du dossier var/log/
   • report.log : sortie de toutes les commandes collectées
   • proxy-agent-config.json : informations de configuration du proxy
   • Journal Docker : fichier -json.log incluant les journaux de conteneurs Docker

Vous pouvez utiliser les options suivantes avec l'outil de diagnostic.

Étapes suivantes

• Apprenez-en plus sur les métadonnées des VM.

• En savoir plus sur Monitoring