Ce document explique comment créer un job Batch qui envoie des notifications Pub/Sub. Vous pouvez utiliser Pub/Sub pour recevoir des notifications lorsqu'un état de job ou de tâche change, ou lorsqu'un job ou une tâche passe à un état spécifique. Pour en savoir plus, consultez Surveiller les jobs à l'aide des notifications.
Avant de commencer
- 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.
- Créez ou identifiez un sujet Pub/Sub pour les notifications Batch.
- Configurez un abonnement pour recevoir et utiliser les notifications.
Rôles requis
-
Pour obtenir les autorisations nécessaires pour créer et exécuter un job qui envoie des notifications, demandez à votre administrateur de vous accorder les rôles IAM suivants :
-
Éditeur de tâches par lot (
roles/batch.jobsEditor
) sur le projet. -
Utilisateur du compte de service (
roles/iam.serviceAccountUser
) sur le compte de service du job, qui par défaut est le compte de service Compute Engine par défaut. -
Éditeur Pub/Sub (
roles/pubsub.editor
) sur le sujet ou le projet Pub/Sub.
Pour en savoir plus sur l'attribution de rôles, consultez 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.
-
Éditeur de tâches par lot (
-
À moins que vous n'utilisiez la configuration par défaut pour le compte de service du job, assurez-vous qu'il dispose des autorisations nécessaires.
Pour vous assurer que le compte de service du job dispose des autorisations nécessaires pour publier des notifications Pub/Sub, demandez à votre administrateur d'accorder au compte de service du job le rôle IAM Éditeur Pub/Sub (
roles/pubsub.publisher
) sur votre sujet Pub/Sub. - Si vous souhaitez qu'un job publie des notifications dans un sujet Pub/Sub qui se trouve dans un projet différent de celui du job, l'agent de service Batch pour le projet du job doit être autorisé à publier dans ce sujet.
Pour vous assurer que l'agent de service Batch du projet du job dispose des autorisations nécessaires pour publier des notifications Pub/Sub sur un sujet Pub/Sub dans un autre projet, demandez à votre administrateur d'accorder à l'agent de service Batch du projet du job le rôle IAM Éditeur Pub/Sub (
roles/pubsub.publisher
) sur le sujet Pub/Sub.
Créer et exécuter un job qui envoie des notifications
Vous pouvez créer un job Batch qui envoie des notifications Pub/Sub en procédant comme suit :
gcloud
Utilisez Google Cloud CLI pour créer un job qui inclut le champ notifications
et un ou plusieurs objets jobNotification
dans le corps principal du fichier JSON :
{
...
"notifications": [
{
"pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
"message": {
ATTRIBUTES
}
}
]
...
}
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet contenant le sujet Pub/Sub.TOPIC_ID
: ID du sujet Pub/Sub que vous avez créé lorsque vous avez activé les notifications Pub/Sub.ATTRIBUTES
: spécifiez un ou plusieurs des attributs suivants, qui vous permettent chacun de recevoir des notifications sur l'état du job ou de toutes ses tâches.Pour recevoir des notifications concernant toutes les modifications de l'état des jobs, spécifiez les éléments suivants :
"type": "JOB_STATE_CHANGED"
Pour recevoir des notifications concernant un changement d'état de job spécifique, spécifiez les éléments suivants :
"type": "JOB_STATE_CHANGED", "newJobState": "JOB_STATE"
Remplacez
JOB_STATE
par l'un des états de job suivants :QUEUED
SCHEDULED
RUNNING
SUCCEEDED
FAILED
Pour en savoir plus sur les états des jobs, consultez Cycle de vie des jobs.
Pour recevoir des notifications concernant toutes les modifications d'état des tâches, spécifiez les éléments suivants :
"type": "TASK_STATE_CHANGED"
Pour recevoir des notifications concernant des changements d'état de tâches spécifiques, indiquez les éléments suivants :
"type": "TASK_STATE_CHANGED", "newTaskState": "TASK_STATE"
Remplacez
TASK_STATE
par l'un des états de tâche suivants :PENDING
ASSIGNED
RUNNING
SUCCEEDED
FAILED
Pour en savoir plus sur les états des tâches, consultez Cycle de vie des jobs.
Par exemple, supposons que vous souhaitiez recevoir des notifications sur toutes les modifications de l'état des jobs et chaque fois qu'une tâche échoue. Pour ce faire, vous pouvez utiliser un fichier de configuration JSON semblable à celui-ci :
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"script": {
"text": "echo Hello World! This is task $BATCH_TASK_INDEX."
}
}
]
},
"taskCount": 3,
}
],
"logsPolicy": {
"destination": "CLOUD_LOGGING"
},
"notifications": [
{
"pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
"message": {
"type": "JOB_STATE_CHANGED"
}
},
{
"pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
"message": {
"type": "TASK_STATE_CHANGED",
"newTaskState": "FAILED"
}
}
]
}
API
Utilisez l'API REST pour créer un job incluant le champ notifications
et un ou plusieurs objets jobNotification
dans le corps principal du fichier JSON :
{
...
"notifications": [
{
"pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
"message": {
ATTRIBUTES
}
}
]
...
}
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet contenant le sujet Pub/Sub.TOPIC_ID
: ID du sujet Pub/Sub que vous avez créé lorsque vous avez activé les notifications Pub/Sub.ATTRIBUTES
: spécifiez un ou plusieurs des attributs suivants, qui vous permettent chacun de recevoir des notifications sur l'état du job ou de toutes ses tâches.Pour recevoir des notifications concernant toutes les modifications de l'état des jobs, spécifiez les éléments suivants :
"type": "JOB_STATE_CHANGED"
Pour recevoir des notifications concernant un changement d'état de job spécifique, spécifiez les éléments suivants :
"type": "JOB_STATE_CHANGED", "newJobState": "JOB_STATE"
Remplacez
JOB_STATE
par l'un des états de job suivants :QUEUED
SCHEDULED
RUNNING
SUCCEEDED
FAILED
Pour en savoir plus sur les états des jobs, consultez Cycle de vie des jobs.
Pour recevoir des notifications concernant toutes les modifications d'état des tâches, spécifiez les éléments suivants :
"type": "TASK_STATE_CHANGED"
Pour recevoir des notifications concernant des changements d'état de tâches spécifiques, indiquez les éléments suivants :
"type": "TASK_STATE_CHANGED", "newTaskState": "TASK_STATE"
Remplacez
TASK_STATE
par l'un des états de tâche suivants :PENDING
ASSIGNED
RUNNING
SUCCEEDED
FAILED
Pour en savoir plus sur les états des tâches, consultez Cycle de vie des jobs.
Par exemple, supposons que vous souhaitiez recevoir des notifications sur toutes les modifications de l'état des jobs et chaque fois qu'une tâche échoue. Pour ce faire, vous pouvez utiliser un fichier de configuration JSON semblable à celui-ci :
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"script": {
"text": "echo Hello World! This is task $BATCH_TASK_INDEX."
}
}
]
},
"taskCount": 3,
}
],
"logsPolicy": {
"destination": "CLOUD_LOGGING"
},
"notifications": [
{
"pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
"message": {
"type": "JOB_STATE_CHANGED"
}
},
{
"pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
"message": {
"type": "TASK_STATE_CHANGED",
"newTaskState": "FAILED"
}
}
]
}
Go
Java
Node.js
Python
Une fois la tâche en cours d'exécution, vous pouvez utiliser ses notifications. Par exemple, si le sujet Pub/Sub de votre job dispose d'un abonnement qui diffuse des notifications vers BigQuery, vous pouvez analyser les notifications Pub/Sub dans BigQuery.
Étapes suivantes
- Découvrez comment surveiller l'état des jobs à l'aide des notifications Pub/Sub et de BigQuery.
- Si vous rencontrez des problèmes pour créer ou exécuter un job, consultez la section Dépannage.
- Afficher les jobs et les tâches
- Découvrez d'autres options de création de tâches.