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

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

Chaque job et chacune de ses tâches sont associés à des événements d'état qui sont automatiquement créés par Batch lors de l'exécution du job. 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 jobs et des tâches, consultez 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 Batch (roles/batch.jobsViewer) ou Éditeur de jobs Batch (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 avec 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 du job (champ statusEvents[] pour le job) 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 la gcloud CLI et de l'API Batch. Pour utiliser un langage de bibliothèque cliente, suivez les étapes pour afficher les détails d'un job 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'un job dans le projet actuel à l'aide de la consoleGoogle Cloud , procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page Liste des jobs.

    Accéder à la liste des tâches

  2. Dans la colonne Nom du job, cliquez sur le nom d'un job.

    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'un job à l'aide de gcloud CLI, utilisez 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'un job existant.

  • LOCATION : emplacement du job.

API

Pour afficher les événements d'état d'un job à 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 :

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, 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 : index de la tâche dont vous souhaitez afficher les détails. Dans un groupe de tâches, l'index 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 index 0, 1, 2 et 3.

  • JOB_NAME : nom d'un job existant.

  • LOCATION : emplacement du job.

  • 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 actuel.

  • LOCATION : emplacement du job.

  • JOB_NAME : nom d'un job existant.

  • 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â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 index 0, 1, 2 et 3.

Étapes suivantes