Automatizar novas tentativas de tarefas

Nesta página, descrevemos como repetir tarefas automaticamente após todas ou algumas falhas.

Um job em lote falha quando pelo menos uma das tarefas falha, o que pode acontecer por vários motivos. Por padrão, cada tarefa em um job é executada apenas uma vez. Se uma tarefa falhar, ela não será repetida. No entanto, alguns problemas que causam a falha de uma tarefa podem ser facilmente resolvidos repetindo a tarefa. Nesses casos, configurar o job para repetir as tarefas automaticamente pode ajudar a reduzir substancialmente o atrito da solução de problemas e o tempo geral de execução dos jobs.

Novas tentativas automáticas são adequadas para tarefas com acoplamento flexível (independente) e podem ajudar com vários problemas. Por exemplo, novas tentativas automáticas de tarefas podem resolver problemas sensíveis ao tempo, como estes:

Ao criar um job, você pode configurar novas tentativas automáticas para cada tarefa. Especificamente, para cada tarefa, é possível usar uma das seguintes opções de configuração:

  • Por padrão, cada tarefa não é repetida em caso de falha.
  • Repetir tarefas para todas as falhas: é possível configurar os tempos máximos para repetir automaticamente as tarefas com falha. É possível especificar entre 0 (padrão) e 10 tentativas.
  • Repetir tarefas para algumas falhas: é possível configurar diferentes ações da tarefa (repetição automática ou falha sem nova tentativa) para falhas específicas. A ação oposta é realizada para todas as falhas não especificadas. Cada falha específica pode ser identificada por um código de saída definido pelo aplicativo ou pelo Batch.

Antes de começar

Repetir tarefas para todas as falhas

Defina o número máximo de novas tentativas automáticas (campo maxRetryCount) para as tarefas com falha de um job usando a CLI gcloud ou a API Batch.

gcloud

  1. Crie um arquivo JSON que especifique os detalhes de configuração do job e o campo maxRetryCount.

    Por exemplo, para criar um job de script básico que especifique o número máximo de novas tentativas para tarefas com falha, crie um arquivo JSON com o seguinte conteúdo:

    {
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "echo Hello world from task ${BATCH_TASK_INDEX}"
            }
          }
        ],
        
        "maxRetryCount": MAX_RETRY_COUNT
        
      },
      "taskCount": 3
    }
  ],
  "logsPolicy": {
    "destination": "CLOUD_LOGGING"
  }
}

    Substitua MAX_RETRY_COUNT pelo número máximo de novas tentativas para cada tarefa. Para que um job possa repetir tarefas com falha, esse valor precisa ser definido como um número inteiro entre 1 e 10. Se o campo maxRetryCount não for especificado, o valor padrão será 0, o que significa que não é possível repetir nenhuma tarefa.

  2. Para criar e executar o job, use o comando gcloud batch jobs submit:

    gcloud batch jobs submit JOB_NAME \
  --location LOCATION \
  --config JSON_CONFIGURATION_FILE

    Substitua:

    • JOB_NAME: o nome do job.

    • LOCATION: o local do job.

    • JSON_CONFIGURATION_FILE: o caminho para um arquivo JSON com os detalhes de configuração do job.

API

Faça uma solicitação POST ao método jobs.create que especifique o campo maxRetryCount.

Por exemplo, para criar um job básico de script que especifique o máximo de novas tentativas para tarefas com falha, faça a seguinte solicitação:

POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs?job_id=JOB_NAME

{
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "echo Hello world from task ${BATCH_TASK_INDEX}"
            }
          }
        ],
        
        "maxRetryCount": MAX_RETRY_COUNT
        
      },
      "taskCount": 3
    }
  ],
  "logsPolicy": {
    "destination": "CLOUD_LOGGING"
  }
}

Substitua:

  • PROJECT_ID: o ID do seu projeto.

  • LOCATION: o local do job.

  • JOB_NAME: o nome do job.

  • MAX_RETRY_COUNT: o número máximo de novas tentativas para cada tarefa. Para que um job possa repetir tarefas com falha, esse valor precisa ser definido como um número inteiro entre 1 e 10. Se o campo maxRetryCount não for especificado, o valor padrão será 0, o que significa que não é possível repetir nenhuma tarefa.

Repetir tarefas para algumas falhas

É possível definir como você quer que um job processe diferentes falhas de tarefas usando políticas de ciclo de vida (campo lifecyclePolicies[]).

Uma política de ciclo de vida consiste em uma ação (campo action), uma condição de ação (campo actionCondition) e um código de saída (campo exitCodes[]). A ação especificada é realizada sempre que ocorre a condição de ação (um código de saída específico). É possível especificar uma das seguintes ações:

  • RETRY_TASK: repete tarefas que falham com os códigos de saída especificados no campo exitCodes[]. As tarefas que falham com códigos de saída não especificados não são repetidas.
  • FAIL_TASK: não tenta repetir tarefas que falham com os códigos de saída especificados no campo exitCodes[]. As tarefas que falham com códigos de saída não especificados são repetidas.

É importante ressaltar que todas as tarefas que falham com códigos de saída não especificados realizam a ação oposta. Alguns códigos de saída são repetidos e outros apresentam falha. Consequentemente, para que a política de ciclo de vida funcione como esperado, você também precisa definir o número máximo de novas tentativas automáticas (campo maxRetryCount) para permitir que o job tente repetir automaticamente as tarefas com falha pelo menos uma vez.

Cada código de saída representa uma falha específica definida pelo aplicativo ou pelo Batch. Os códigos de saída de 50001 a 59999 são reservados e definidos pelo Batch. Para mais informações sobre os códigos de saída reservados, consulte Solução de problemas.

É possível especificar que um job tente repetir ou falhar tarefas após falhas específicas usando a CLI gcloud ou a API Batch.

gcloud

  1. Crie um arquivo JSON que especifique os detalhes de configuração do job, o campo maxRetryCount e os subcampos lifecyclePolicies[].

    Para criar um job de script básico que repita as tarefas com falha apenas para alguns códigos de saída, crie um arquivo JSON com o seguinte conteúdo:

    {
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "echo Hello world from task ${BATCH_TASK_INDEX}"
            }
          }
        ],
        
        "maxRetryCount": MAX_RETRY_COUNT,
        "lifecyclePolicies": [
          {
            "action": "ACTION",
            "actionCondition": {
               "exitCodes": [EXIT_CODES]
            }
          }
        ]
      }
    }
  ],
  "logsPolicy": {
    "destination": "CLOUD_LOGGING"
  }
}

    Substitua:

    • MAX_RETRY_COUNT: o número máximo de novas tentativas para cada tarefa. Para que um job possa repetir tarefas com falha, esse valor precisa ser definido como um número inteiro entre 1 e 10. Se o campo maxRetryCount não for especificado, o valor padrão será 0, o que significa que não é possível repetir nenhuma tarefa.

    • ACTION: a ação, RETRY_TASK ou FAIL_TASK, que você quer para tarefas que falham com os códigos de saída especificados. As tarefas que falham com códigos de saída não especificados realizam a outra ação.

    • EXIT_CODES: uma lista separada por vírgulas de um ou mais códigos de saída que você quer que acionem a ação especificada, por exemplo, 50001, 50002.

      Cada código de saída pode ser definido pelo seu aplicativo ou Batch. Os códigos de saída de 50001 a 59999 são reservados pelo Batch. Para mais informações sobre os códigos de saída reservados, consulte Solução de problemas.

    Por exemplo, o job a seguir só tenta executar novamente tarefas que falham devido à preempção das VMs spot.

    {
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "sleep 30"
            }
          }
        ],
        "maxRetryCount": 3,
        "lifecyclePolicies": [
          {
             "action": "RETRY_TASK",
             "actionCondition": {
               "exitCodes": [50001]
            }
          }
        ]
      }
    }
  ],
  "allocationPolicy": {
    "instances": [
      {
        "policy": {
          "machineType": "e2-standard-4",
          "provisioningModel": "SPOT"
        }
      }
    ]
  }
}

  2. Para criar e executar o job, use o comando gcloud batch jobs submit:

    gcloud batch jobs submit JOB_NAME \
  --location LOCATION \
  --config JSON_CONFIGURATION_FILE

    Substitua:

    • JOB_NAME: o nome do job.

    • LOCATION: o local do job.

    • JSON_CONFIGURATION_FILE: o caminho para um arquivo JSON com os detalhes de configuração do job.

API

Faça uma solicitação POST para o método jobs.create que especifique o campo maxRetryCount e os subcampos lifecyclePolicies[].

Para criar um job básico de script que repita as tarefas com falha apenas para alguns códigos de saída, faça a seguinte solicitação:

POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs?job_id=JOB_NAME

{
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "echo Hello world from task ${BATCH_TASK_INDEX}"
            }
          }
        ],
        
        "maxRetryCount": MAX_RETRY_COUNT,
        "lifecyclePolicies": [
          {
            "action": "ACTION",
            "actionCondition": {
                "exitCodes": [EXIT_CODES]
            }
          }
        ]
      }
    }
  ],
  "logsPolicy": {
    "destination": "CLOUD_LOGGING"
  }
}

Substitua:

  • PROJECT_ID: o ID do seu projeto.

  • LOCATION: o local do job.

  • JOB_NAME: o nome do job.

  • MAX_RETRY_COUNT: o número máximo de novas tentativas para cada tarefa. Para que um job possa repetir tarefas com falha, esse valor precisa ser definido como um número inteiro entre 1 e 10. Se o campo maxRetryCount não for especificado, o valor padrão será 0, o que significa que não é possível repetir nenhuma tarefa.

  • ACTION: a ação, RETRY_TASK ou FAIL_TASK, que você quer para tarefas que falham com os códigos de saída especificados. As tarefas que falham com códigos de saída não especificados realizam a outra ação.

  • EXIT_CODES: uma lista separada por vírgulas de um ou mais códigos de saída que você quer que acionem a ação especificada, por exemplo, 50001, 50002.

    Cada código de saída pode ser definido pelo seu aplicativo ou Batch. Os códigos de saída de 50001 a 59999 são reservados pelo Batch. Para mais informações sobre os códigos de saída reservados, consulte Solução de problemas.

Por exemplo, o job a seguir só tenta executar novamente tarefas que falham devido à preempção das VMs spot.

POST https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?job_id=example-job

{
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "sleep 30"
            }
          }
        ],
        "maxRetryCount": 3,
        "lifecyclePolicies": [
          {
             "action": "RETRY_TASK",
             "actionCondition": {
               "exitCodes": [50001]
            }
          }
        ]
      }
    }
  ],
  "allocationPolicy": {
    "instances": [
      {
        "policy": {
          "machineType": "e2-standard-4",
          "provisioningModel": "SPOT"
        }
      }
    ]
  }
}

Modificar o comportamento da tarefa com base no número de novas tentativas

Outra opção é atualizar os elementos executáveis para usar a variável de ambiente predefinida BATCH_TASK_RETRY_ATTEMPT depois de ativar as tentativas automáticas para uma tarefa, conforme descrito nas seções anteriores desta página. A variável BATCH_TASK_RETRY_ATTEMPT descreve o número de vezes em que essa tarefa já foi tentada. Use a variável BATCH_TASK_RETRY_ATTEMPT nos executáveis se quiser que uma tarefa se comporte de maneira diferente com base no número de novas tentativas. Por exemplo, quando uma tarefa está sendo repetida, você pode confirmar quais comandos já foram executados na tentativa anterior. Para mais informações, consulte Variáveis de ambiente predefinidas.

A seguir