本页面介绍了如何在全部或部分失败后自动重试任务。
当批量作业中的至少一个任务失败时,可能会由于各种原因而失败。默认情况下,作业中的每个任务仅运行一次;如果任务失败,则不会重试。但是,一些导致任务失败的问题可以轻松通过重试任务来解决。在这些情况下,将作业配置为自动重试任务可以极大地帮助减少问题排查的麻烦并缩短作业的总运行时间。
自动重试非常适合松散耦合(独立)任务,有助于解决各种问题。例如,自动任务重试可以解决如下具有时效性的问题:
- Spot 虚拟机的抢占
- 虚拟机维护事件和主机错误
- 暂时性网络连接错误
您可以在创建作业时为每个任务配置自动重试任务的功能。具体而言,对于每项任务,您都可以使用以下某个配置选项:
- 默认情况下,每个任务失败时都不会重试。
- 针对所有失败任务重试任务:您可以配置自动重试失败任务的最大次数。您可以指定 0(默认值)到 10 次重试。
- 针对某些失败情况重试任务:您可以针对特定失败情况配置不同的任务操作,包括自动重试或失败而不重试。对于所有未指定的失败情况,系统都会执行相反的操作。 具体的失败情况都可以通过应用或 Batch 定义的退出代码来标识。
准备工作
- 如果您之前未使用过 Batch,请查看 Batch 使用入门,并通过完成项目和用户的前提条件来启用 Batch。
-
如需获取创建作业所需的权限,请让管理员授予您以下 IAM 角色:
-
项目的 Batch Job Editor (
roles/batch.jobsEditor
) -
作业的服务帐号上的 Service Account User (
roles/iam.serviceAccountUser
),默认为默认 Compute Engine 服务帐号
如需详细了解如何授予角色,请参阅管理访问权限。
-
项目的 Batch Job Editor (
在所有失败后重试任务
您可以使用 gcloud CLI 或 Batch API 为作业的失败任务定义自动重试次数上限(maxRetryCount
字段)。
gcloud
创建一个 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
替换为每个任务的最大重试次数。为使作业能够重试失败的任务,此值必须设置为1
到10
之间的整数。如果未指定maxRetryCount
字段,则默认值为0
,表示不会重试任何任务。如需创建并运行作业,请使用
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"
}
}
请替换以下内容:
在部分失败时重试任务
您可以使用生命周期政策(lifecyclePolicies[]
字段)来定义作业处理不同任务失败的方式。
生命周期政策由操作(action
字段)、操作条件(actionCondition
字段)和退出代码(exitCodes[]
字段)组成。每当操作条件(特定的退出代码)发生时,系统都会执行指定的操作。您可以指定以下操作之一:
RETRY_TASK
:使用exitCodes[]
字段中指定的退出代码重试失败的任务。如果任务失败且有任何未指定的退出代码,则系统不会重试这些任务。FAIL_TASK
:不重试使用exitCodes[]
字段中指定的退出代码失败的任务。如果任务失败且有任何未指定的退出代码,系统会重试。
值得注意的是,任何因未指定的退出代码而失败的任务都会采取相反的操作:有些任务会重试,有些会失败。因此,为使生命周期政策按预期运行,您还需要定义自动重试次数上限(maxRetryCount
字段),以允许作业至少自动重试失败的任务一次。
每个退出代码代表一个由应用或 Batch 定义的特定失败。 从 50001 到 59999 的退出代码由 Batch 保留和定义。如需详细了解预留的退出代码,请参阅问题排查。
您可以使用 gcloud CLI 或 Batch API 为作业指定在任务发生特定失败后重试或失败任务。
gcloud
创建一个 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
:每个任务的重试次数上限。为使作业能够重试失败的任务,此值必须设置为1
到10
之间的整数。如果未指定maxRetryCount
字段,则默认值为0
,表示不会重试任何任务。ACTION
:您希望对以指定退出代码失败的任务执行的操作(RETRY_TASK
或FAIL_TASK
)。如果任务因未指定的退出代码而失败,则会执行其他操作。EXIT_CODES
:要触发指定操作的一个或多个退出代码的列表(以英文逗号分隔),例如50001, 50002
。每个退出代码都可以由应用或 Batch 定义。从
50001
到59999
的退出代码由 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" } } ] } }
如需创建并运行作业,请使用
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
字段和 lifecyclePolicies[]
子字段的 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,
"lifecyclePolicies": [
{
"action": "ACTION",
"actionCondition": {
"exitCodes": [EXIT_CODES]
}
}
]
}
}
],
"logsPolicy": {
"destination": "CLOUD_LOGGING"
}
}
请替换以下内容:
PROJECT_ID
:您的项目 ID。LOCATION
:作业的位置。JOB_NAME
:作业的名称。MAX_RETRY_COUNT
:每个任务的重试次数上限。为使作业能够重试失败的任务,此值必须设置为1
到10
之间的整数。如果未指定maxRetryCount
字段,则默认值为0
,表示不会重试任何任务。ACTION
:您希望对以指定退出代码失败的任务执行的操作(RETRY_TASK
或FAIL_TASK
)。如果任务因未指定的退出代码而失败,则会执行其他操作。EXIT_CODES
:要触发指定操作的一个或多个退出代码的列表(以英文逗号分隔),例如50001, 50002
。每个退出代码都可以由应用或 Batch 定义。从
50001
到59999
的退出代码由 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
变量描述此任务已经尝试的次数。如果您希望任务根据重试次数表现出不同的行为,请在 Runnable 中使用 BATCH_TASK_RETRY_ATTEMPT
变量。例如,在重试任务时,您可能需要确认在上一次尝试中已成功执行了哪些命令。如需了解详情,请参阅预定义的环境变量。