Afficher l'historique d'une tâche via les événements d'état

Ce document explique comment afficher des événements d'état pour Batch des emplois et des tâches. Les événements d'état fournissent un historique que vous pouvez utiliser pour analyser et contiennent souvent des messages d'erreur utiles que vous pouvez utiliser le dépannage.

Chaque job et chacune de ses tâches ont des événements d'état qui sont automatiquement créés par Batch pendant l'exécution du job. Chacun de ces événements d'état décrit un état changement et des détails sur les raisons pour lesquelles cet état a été atteint. Pour en savoir plus sur les états des tâches et des tâches, consultez Cycle de vie des tâches. Vous pouvez également configurer une tâche pour qu'elle comporte des événements d'état personnalisés, qui décrivent la progression des exécutables. Pour en savoir plus sur les événements d'état personnalisés, consultez Configurer des événements d'état personnalisés

Avant de commencer

  1. Si vous n'avez jamais utilisé Batch auparavant, consultez Premiers pas avec Batch et activez Batch en suivant la les conditions préalables pour les projets et les utilisateurs.

  2. Pour obtenir les autorisations nécessaires pour afficher les jobs et les tâches, demandez à votre administrateur de vous accorder le Lecteur de jobs par lot (roles/batch.jobsViewer) ou éditeur de jobs par lot (roles/batch.jobsEditor) rôle IAM sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

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

Afficher les événements d'état

Différents états peuvent s'afficher au niveau du job. (Champ statusEvents[] pour le poste) et au niveau de la tâche (champ statusEvents[] pour chaque tâche)

Les instructions suivantes expliquent comment afficher les événements d'état à l'aide de la méthode la console Google Cloud, gcloud CLI et l'API Batch. Pour utiliser un langage de bibliothèque cliente, procédez comme suit : Afficher les détails d'une mission afficher les détails d'une tâche puis consultez le champ statusEvents[] correspondant.

Afficher les événements d'état d'une tâche

Console

Pour afficher les événements de statut d'une tâche dans le projet en cours à l'aide de la console Google Cloud, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Liste des tâches.

    Accéder à la liste des jobs

  2. Dans la colonne Job name (Nom de la tâche), cliquez sur le nom d'une tâche.

    La page "Job Details" (informations sur le job) s'ouvre alors.

    L'onglet Détails est ouvert par défaut.

  3. Cliquez sur l'onglet Événements.

gcloud

Pour afficher les événements d'état d'une tâche à l'aide de gcloud CLI, exécutez la commande gcloud batch jobs describe, puis consultez le champ statusEvents[].

gcloud batch jobs describe JOB_NAME \
    --location=LOCATION

Remplacez les éléments suivants :

  • JOB_NAME: nom d'une tâche existante.

  • LOCATION: emplacement où le job existe.

API

Pour afficher les événements d'état d'une tâche à l'aide de l'API Batch, envoyez une requête GET à la méthode jobs.get, puis consultez le champ statusEvents[].

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME

Remplacez les éléments suivants :

  • PROJECT_ID: le ID du projet du projet en cours.

  • LOCATION : emplacement de la tâche.

  • JOB_NAME : nom d'une tâche existante.

Afficher les événements de statut d'une tâche

gcloud

Pour afficher les événements d'état d'une tâche à l'aide de gcloud CLI, utilisez la Commande gcloud batch tasks describe, puis consultez le champ statusEvents[].

gcloud batch tasks describe TASK_INDEX \
  --location=LOCATION \
  --job=JOB_NAME \
  --task_group=TASK_GROUP_NAME

Remplacez les éléments suivants :

  • TASK_INDEX : indice de la tâche dont vous souhaitez afficher les détails. Dans un groupe de tâches, l'index de la tâche commence à 0 pour le premier tâche et augmente de 1 à chaque tâche supplémentaire. Par exemple, un groupe de tâches contenant quatre tâches possède les indices 0, 1, 2 et 3.

  • JOB_NAME: nom d'une tâche existante.

  • LOCATION: emplacement où le job existe.

  • TASK_GROUP_NAME: nom du groupe de tâches que contient la tâche dont vous souhaitez afficher les détails. La valeur doit être définie sur group0.

API

Pour afficher les événements d'état d'une tâche à l'aide de l'API Batch, envoyez une requête GET au Méthode tasks.get, puis consultez le champ statusEvents[].

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX

Remplacez les éléments suivants :

  • PROJECT_ID: le ID du projet du projet en cours.

  • LOCATION : emplacement de la tâche.

  • JOB_NAME: nom d'une tâche existante.

  • TASK_GROUP_NAME: nom du groupe de tâches que contient la tâche dont vous souhaitez afficher les détails. La valeur doit être définie sur group0.

  • TASK_INDEX: index de la tâche que vous souhaitez afficher. dans les détails. Dans un groupe de tâches, l'index de la tâche commence à 0 pour le premier tâche et augmente de 1 à chaque tâche supplémentaire. Par exemple, une tâche qui contient quatre tâches possède les index 0, 1, 2 et 3.

Étape suivante