Ce document explique comment afficher les événements d'état des tâches et des tâches Batch. 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 à utiliser pour le dépannage.
Chaque tâche et chacune de ses tâches présentent des événements d'état qui sont automatiquement créés par Batch pendant son exécution. 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 section Cycle de vie des tâches. Vous pouvez également configurer une tâche avec des événements d'état personnalisés décrivant 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 auparavant, 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
Différents événements d'état peuvent apparaître 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 des événements d'état à l'aide de la console Google Cloud, de gcloud CLI et de l'API Batch.
Pour utiliser le langage d'une 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 liés à l'é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.
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 où se trouve 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 coursLOCATION
: emplacement où se trouve 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 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 la tâche 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 index0
,1
,2
et3
.JOB_NAME
: nom d'une tâche existante.LOCATION
: emplacement où se trouve le job.TASK_GROUP_NAME
: nom du groupe de tâches qui contient la tâche dont vous souhaitez afficher les détails. La valeur doit être définie surgroup0
.
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 coursLOCATION
: emplacement où se trouve la tâche.JOB_NAME
: nom d'une tâche existante.TASK_GROUP_NAME
: nom du groupe de tâches qui contient la tâche dont vous souhaitez afficher les détails. La valeur doit être définie surgroup0
.TASK_INDEX
: index 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 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 index0
,1
,2
et3
.
Étapes suivantes
Pour comprendre les événements d'état de Batch qui décrivent des erreurs, consultez la page Dépannage.
Si vous souhaitez un historique plus détaillé de votre tâche, tels que des événements d'état pour le début et la fin des exécutables, configurez des événements d'état personnalisés.
Découvrez comment analyser une tâche à l'aide de journaux.