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

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

Chaque tâche et chacune de ses tâches ont des événements d'état créés automatiquement par Batch pendant l'exécution de la tâche. Chacun de ces événements d'état décrit un changement d'état et les raisons pour lesquelles cet état a été atteint. Pour en savoir plus sur les états des tâches et des jobs, consultez la section Cycle de vie des jobs. 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, consultez Premiers pas avec Batch et activez Batch en remplissant 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 rôle IAM Lecteur de jobs par lot (roles/batch.jobsViewer) ou Éditeur de jobs par lot (roles/batch.jobsEditor) 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 événements d'état peuvent s'afficher au niveau de la tâche (champ statusEvents[] pour la tâche) 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 consoleGoogle Cloud , de gcloud CLI et de l'API Batch. Pour utiliser un langage de bibliothèque cliente, suivez la procédure permettant d'afficher les détails d'une tâche ou d'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 d'état d'une tâche dans le projet en cours à l'aide de la consoleGoogle Cloud , procédez comme suit:

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

    Accéder à la liste des tâches

  2. Dans la colonne 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 de la tâche.

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: ID de projet du projet en cours.

  • LOCATION: emplacement de la tâche.

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

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

gcloud

Pour afficher les événements d'état d'une tâche à l'aide de gcloud CLI, exécutez 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'indice de tâche commence à 0 pour la première tâche et augmente de 1 pour 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 de la tâche.

  • TASK_GROUP_NAME: nom du groupe de tâches contenant 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, effectuez une requête GET à la 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: ID de 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 contenant la tâche dont vous souhaitez afficher les détails. La valeur doit être définie sur group0.

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

Étape suivante