Afficher l'historique d'un projet à l'aide des événements d'état

Ce document explique comment afficher les événements d'état des tâches et des tâches 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 pour le dépannage.

Chaque tâche et chacune de ses tâches comportent des événements d'état qui sont automatiquement créés par Batch pendant l'exécution de la tâche. Chacun de ces événements d'état décrit un changement d'état et explique pourquoi cet état a été atteint. Pour en savoir plus sur les états des tâches, consultez la page 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

Si vous n'avez jamais utilisé Batch, consultez la page Premiers pas avec Batch et activez Batch en remplissant les conditions préalables pour les projets et les utilisateurs.
Pour obtenir les autorisations nécessaires pour afficher les tâches et les tâches, demandez à votre administrateur de vous attribuer le rôle IAM Lecteur de tâches par lot (roles/batch.jobsViewer) ou Éditeur de tâches par lot (roles/batch.jobsEditor) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

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

Les instructions suivantes expliquent comment afficher les événements d'état à l'aide de la console Google Cloud, de gcloud CLI et de l'API Batch. Pour utiliser un langage de bibliothèque cliente, suivez les étapes pour afficher les détails d'une tâche ou afficher les détails d'une tâche, puis consultez le champ statusEvents[] correspondant.

Afficher les événements d'état d'un job

Console

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

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

Accéder à la liste des jobs
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.
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 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

Console

Si une tâche ne comporte qu'une seule tâche, vous pouvez afficher ses événements d'état à l'aide de la console Google Cloud pour afficher les événements d'état d'une tâche.
Sinon, si une tâche comporte plusieurs tâches, vous ne pouvez pas afficher les événements d'état d'une tâche à l'aide de la console Google Cloud.

gcloud

Pour afficher les événements d'état d'une tâche à l'aide de la 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: index de la tâche dont vous souhaitez afficher les détails. Dans un groupe de tâches, l'index de tâches commence à 0 pour la première 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 index 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, envoyez 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 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: index de la tâche dont vous souhaitez afficher les détails. Dans un groupe de tâches, l'index de tâches commence à 0 pour la première 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 index 0, 1, 2 et 3.

Étapes suivantes

Pour comprendre les événements d'état de Batch décrivant les erreurs, consultez la section Dépannage.
Si vous souhaitez obtenir un historique plus détaillé de votre tâche, tel que des événements d'état pour le début et la fin de l'exécution, configurez des événements d'état personnalisés.
Découvrez comment analyser une tâche à l'aide des journaux.