Ver o histórico de uma tarefa por meio de eventos de status

Neste documento, explicamos como visualizar eventos de status de jobs e tarefas do Batch. Os eventos de status fornecem um histórico que pode ser usado para analisar jobs e geralmente contêm mensagens de erro úteis para solução de problemas.

Cada job e cada tarefa tem eventos de status que são criados automaticamente pelo Batch durante a execução do job. Cada um desses eventos de status descreve uma mudança de estado e detalhes sobre por que esse estado foi alcançado. Para saber mais sobre os estados do job e da tarefa, consulte Ciclo de vida do job. Também é possível configurar um job para ter eventos de status personalizados, que descrevem o progresso dos elementos executáveis. Para saber mais sobre eventos de status personalizados, consulte Configurar eventos de status personalizados.

Antes de começar

• Se você nunca usou o Batch, consulte Primeiros passos com ele e ative-o concluindo os pré-requisitos para projetos e usuários.

• Para receber as permissões necessárias para visualizar jobs e tarefas, peça ao administrador para conceder a você o papel do IAM Leitor de jobs em lote (roles/batch.jobsViewer) ou Editor de jobs em lote (roles/batch.jobsEditor) no projeto. Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

  Também é possível receber as permissões necessárias com papéis personalizados ou outros papéis predefinidos.

Ver eventos de status

Eventos de status diferentes podem aparecer no nível do job (campo statusEvents[] do job) e no nível da tarefa (campo statusEvents[] para cada tarefa).

As instruções a seguir explicam como visualizar eventos de status usando o Console do Google Cloud, a CLI gcloud e a API Batch. Para usar uma linguagem da biblioteca de cliente, siga as etapas para ver os detalhes de um job ou ver os detalhes de uma tarefa e, em seguida, consultar o campo statusEvents[] correspondente.

Visualizar os eventos de status de um job

Console

Observação: o console do Google Cloud lista apenas eventos de status no nível do job.

Para visualizar os eventos de status de um job no projeto atual usando o console do Google Cloud, siga estas etapas:

1. No console do Google Cloud, acesse a página Lista de jobs.

   Acessar a lista de jobs

2. Na coluna Nome do job, clique no nome de um job.

   A página Detalhes do job será aberta.

   A guia Detalhes fica aberta por padrão.

3. Clique na guia Eventos.

gcloud

Para visualizar os eventos de status de um job usando a CLI gcloud, use o comando gcloud batch jobs describe e consulte o campo statusEvents[].

gcloud batch jobs describe JOB_NAME \
    --location=LOCATION

Substitua:

• JOB_NAME: o nome de um job atual.

• LOCATION: o local onde o job existe.

API

Para visualizar os eventos de status de um job usando a API Batch, faça uma solicitação GET para o método jobs.get e consulte o campo statusEvents[].

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME

Substitua:

• PROJECT_ID: o ID do projeto atual.

• LOCATION: o local onde o job existe.

• JOB_NAME: o nome de um job atual.

Visualizar os eventos de status de uma tarefa

gcloud

Para ver os eventos de status de uma tarefa usando a CLI gcloud, use o comando gcloud batch tasks describe e consulte o campo statusEvents[].

gcloud batch tasks describe TASK_INDEX \
  --location=LOCATION \
  --job=JOB_NAME \
  --task_group=TASK_GROUP_NAME

Substitua:

• TASK_INDEX: o índice da tarefa com os detalhes que você quer acessar. Em um grupo de tarefas, o índice de tarefas começa em 0 para a primeira tarefa e aumenta em 1 a cada tarefa extra. Por exemplo, um grupo de tarefas que contém quatro tarefas tem os índices 0, 1, 2 e 3.

• JOB_NAME: o nome de um job atual.

• LOCATION: o local onde o job está.

• TASK_GROUP_NAME: o nome do grupo de tarefas que contém a tarefa com os detalhes que você quer ver. O valor precisa ser definido como group0.

API

Para visualizar os eventos de status de uma tarefa usando a API Batch, faça uma solicitação GET para o método tasks.get e consulte o campo statusEvents[].

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX

Substitua:

• PROJECT_ID: o ID do projeto atual.

• LOCATION: o local onde o job existe.

• JOB_NAME: o nome de um job atual.

• TASK_GROUP_NAME: o nome do grupo de tarefas que contém a tarefa com os detalhes que você quer ver. O valor precisa ser definido como group0.

• TASK_INDEX: o índice da tarefa com os detalhes que você quer acessar. Em um grupo de tarefas, o índice de tarefas começa em 0 para a primeira tarefa e aumenta em 1 a cada tarefa extra. Por exemplo, um grupo de tarefas que contém quatro tarefas tem os índices 0, 1, 2 e 3.

A seguir

• Para entender os eventos de status do Batch que descrevem erros, consulte Solução de problemas.

• Se você quiser um histórico mais detalhado do job, como eventos de status de início e término dos executáveis, configure eventos de status personalizados.

• Saiba como analisar um job usando registros.