自动重试任务

本页介绍了如何在所有或部分任务失败后自动重试任务。

Batch 作业至少有一个任务失败时,它可能就会失败 会由于各种原因而发生默认情况下,作业中的每个任务仅运行一次;如果 如果任务失败,则不会重试。不过,也有一些问题会导致任务 只需重试任务即可轻松解决失败问题。在这些情况下,将作业配置为自动重试任务可以显著减少问题排查的阻碍,并缩短作业的总运行时间。

自动重试非常适合 松散耦合(独立)任务 并帮助解决各种问题例如,自动重试任务 可以解决以下具有时效性的问题:

创建作业时,您可以为每个任务配置自动任务重试。具体而言,对于每个任务,您可以使用以下配置选项之一:

  • 默认情况下,每个任务在失败时都不会重试。
  • 出现所有失败情况时重试任务:您可以 自动重试失败任务的最大次数。您可以指定 0(默认值)到 10 次重试。
  • 在出现部分失败情况时重试任务: 你可以配置不同的任务 操作(自动重试或不重试失败) 特定故障。对于所有未指定的失败情况,系统都会执行相反的操作。 具体的失败情况都可以通过退出代码来标识, 由应用或 Batch 定义。

准备工作

  1. 如果您以前没有使用过 Batch,请参阅 Batch 使用入门 并通过填写 针对项目和用户的前提条件
  2. 如需获取创建作业所需的权限, 请让管理员授予您 以下 IAM 角色:

    如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限

    您也可以通过自定义角色或其他预定义角色来获取所需的权限。

针对所有失败的任务重试

您可以定义 自动重试次数上限(maxRetryCount 字段) 使用 gcloud CLI 或 Batch API 监控作业中失败的任务。

gcloud

  1. 创建一个 JSON 文件,用于指定作业的配置详情和 maxRetryCount 字段。

    例如,要创建一个基本脚本作业, 重试失败的任务,请创建一个包含以下内容的 JSON 文件:

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

    MAX_RETRY_COUNT 替换为最大数量 重试次数。为了让作业能够重试失败的任务,此值必须设置为介于 110 之间的整数。如果未指定 maxRetryCount 字段,则默认值为 0,表示不重试任何任务。

  2. 如需创建和运行作业,请使用 gcloud batch jobs submit 命令

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

    替换以下内容:

    • JOB_NAME:作业的名称。

    • LOCATION位置 作业的组成部分。

    • JSON_CONFIGURATION_FILE:包含作业配置详细信息的 JSON 文件的路径。

API

向指定 maxRetryCount 字段的 jobs.create 方法发出 POST 请求。

例如,要创建一个基本脚本作业, 请发出以下请求:

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"
  }
}

替换以下内容:

  • PROJECT_ID项目 ID 项目名称

  • LOCATION位置 作业的组成部分。

  • JOB_NAME:作业的名称。

  • MAX_RETRY_COUNT:每个任务的最大重试次数。为了让作业能够重试失败的任务, 此值必须设置为 110 之间的整数。 如果未指定 maxRetryCount 字段,则默认值为 0。 这意味着不重试任何任务。

在部分失败时重试任务

您可以使用生命周期政策 (lifecyclePolicies[] 字段) 定义作业如何处理不同的任务失败情况。

生命周期政策包括 操作(action 字段)操作条件(actionCondition 字段), 和退出代码(exitCodes[] 字段)。 每当操作条件(特定退出代码)发生时,系统都会执行指定的操作。您可以指定以下任一操作:

  • RETRY_TASK:针对 exitCodes[] 字段中指定的退出代码重试失败的任务。系统不会重试失败且返回任何未指定退出代码的任务。
  • FAIL_TASK:如果任务使用在 exitCodes[] 字段。失败且包含任何未指定的退出代码的任务 重试。

值得注意的是,所有失败且退出代码未指定的任务都会执行相反的操作:某些退出代码会被重试,而某些退出代码会失败。因此,要使生命周期政策按预期运行 您还需要定义 自动重试次数上限(maxRetryCount 字段) 允许作业至少自动重试一次失败的任务。

每个退出代码代表一个特定失败,该失败由 或 Batch。 从 50001 到 59999 的退出代码由 批处理。如需详细了解预留的退出代码,请参阅问题排查

您可以为作业指定在特定失败后重试任务或使任务失败 gcloud CLI 或 Batch API

gcloud

  1. 创建一个 JSON 文件,用于指定作业的配置详细信息、maxRetryCount 字段和 lifecyclePolicies[] 子字段。

    如需创建一个基本脚本作业,仅针对某些退出代码重试失败的任务,请创建一个包含以下内容的 JSON 文件:

    {
      "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"
      }
    }
    

    替换以下内容:

    • MAX_RETRY_COUNT:每个任务的最大重试次数。为了让作业能够重试失败的任务, 此值必须设置为 110 之间的整数。 如果未指定 maxRetryCount 字段,则默认值为 0,表示不重试任何任务。

    • ACTION:您希望针对失败且返回指定退出代码的任务执行的操作(RETRY_TASKFAIL_TASK)。因未指定的退出而失败的任务 会执行另一个操作。

    • EXIT_CODES:以英文逗号分隔的 要触发指定的一个或多个退出代码, 操作,例如 50001, 50002

      每个退出代码都可以由您的应用或批处理作业定义。从 5000159999 的退出代码 为 Batch 预留。 有关保留的退出代码的详细信息,请参阅 问题排查

    例如,以下作业仅会重试因 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. 如需创建和运行作业,请使用 gcloud batch jobs submit 命令

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

    替换以下内容:

    • JOB_NAME:作业的名称。

    • LOCATION:作业的位置

    • JSON_CONFIGURATION_FILE:JSON 路径 该文件包含作业的配置详情。

API

请发送 POST 请求至 jobs.create 方法 ,用于指定 maxRetryCount 字段和 lifecyclePolicies[] 子字段。

如需创建一个基本脚本作业,仅针对某些退出代码重试失败的任务,请发出以下请求:

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"
  }
}

替换以下内容:

  • PROJECT_ID:您的项目的项目 ID

  • LOCATION:作业的位置

  • JOB_NAME:作业的名称。

  • MAX_RETRY_COUNT:最大数量 重试次数。为了让作业能够重试失败的任务, 此值必须设置为 110 之间的整数。 如果未指定 maxRetryCount 字段,则默认值为 0。 这意味着不重试任何任务。

  • ACTION:您希望针对失败且返回指定退出代码的任务执行的操作(RETRY_TASKFAIL_TASK)。因未指定的退出而失败的任务 会执行另一个操作。

  • EXIT_CODES:以英文逗号分隔的 要触发指定的一个或多个退出代码, 操作,例如 50001, 50002

    每个退出代码都可以由您的应用或 批处理。从 5000159999 的退出代码 为 Batch 预留。 如需详细了解预留的退出代码,请参阅问题排查

例如,以下作业仅会重试因 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"
        }
      }
    ]
  }
}

根据重试次数修改任务行为

(可选)为任务启用自动重试(如本页面上前几部分所述)后,您可以更新可运行作业以使用 BATCH_TASK_RETRY_ATTEMPT 预定义环境变量。BATCH_TASK_RETRY_ATTEMPT 变量描述此任务已经尝试的次数。使用 BATCH_TASK_RETRY_ATTEMPT 变量(如果需要) 使任务行为因重试次数而异。 例如,在重试任务时,您可能需要确认之前的尝试中哪些命令已成功执行。如需了解详情,请参阅 预定义的环境变量

后续步骤