创建公式以自动缩放 Batch 池中的计算节点

Azure Batch 可以根据定义的参数自动缩放池,节省时间和资金。 Batch 通过自动缩放动态控制计算节点的数目,在任务需求提高时向池中添加节点,在任务需求降低时删除节点。

若要为某个计算节点池启用自动缩放,请将该池与你所定义的自动缩放公式相关联。 Batch 服务会使用自动缩放公式确定执行工作负载所需的节点数。 这些节点可以是专用节点。 Batch 会定期检查服务指标数据,并使用它根据公式和您定义的时间间隔来调整池中的节点数。

可以在创建池时启用自动缩放,也可以将其应用于现有池。 Batch 使你能够在将公式分配给池之前先对其求值,以及监视自动缩放运行的状态。 为池配置自动缩放后,可在以后对该公式做出更改。

重要

创建 Batch 帐户时,可以指定池分配模式,用于确定是要在 Batch 服务订阅中(默认设置)还是在用户订阅中分配池。 如果使用默认的 Batch 服务配置创建了 Batch 帐户,则该帐户受限于可用于处理的最大核心数。 Batch 服务最多只能将计算节点数扩展到该核心数限制。 由于此原因,Batch 服务可能达不到自动缩放公式指定的目标计算节点数。 要了解如何查看和增加帐户配额,请参阅 Azure Batch 服务的配额和限制

如果使用用户订阅模式创建了帐户,则该帐户会共享订阅的核心配额。 有关详细信息,请参阅 Azure 订阅和服务限制、配额和约束条件中的虚拟机限制

自动缩放公式

自动缩放公式是你定义的一个字符串值,其中包含一个或多个语句。 自动缩放公式会分配给池的 autoScaleFormula 元素 (Batch REST) 或 CloudPool.AutoScaleFormula 属性 (Batch .NET)。 Batch 服务使用公式来确定池中可供下一个处理间隔使用的目标计算节点数。 公式字符串不能超过 8 KB,最多可以包含 100 个以分号分隔的语句,可以包括换行符和注释。

可以将自动缩放公式视为 Batch 自动缩放“语言”。公式语句是自由格式的表达式,可以包含 服务定义的变量(由 Batch 服务定义)和 用户定义的变量。 公式可以通过内置类型、运算符和函数对这些值执行各种操作。 例如,语句可以采用以下格式:

$myNewVariable = function($ServiceDefinedVariable, $myCustomVariable);

公式通常包含多个语句,这些语句对先前语句中获取的值执行操作。 例如,先获取 variable1 的值,然后将其传递给函数以填充 variable2

$variable1 = function1($ServiceDefinedVariable);
$variable2 = function2($OtherServiceDefinedVariable, $variable1);

在自动缩放公式中包含这些语句可实现计算节点的目标数。 专用节点有其自己的目标设置。 自动缩放公式可以包含专用节点的目标值。

节点的目标数可以大于、小于或等于池中该节点类型的当前数量。 Batch 按特定的 自动缩放间隔 对池的自动缩放公式求值。 Batch 将池中每种节点类型的目标数调整成在求值时自动缩放公式所指定的数目。

示例自动缩放公式

以下示例展示了可进行调整以适用于大多数场景的两个自动缩放公式。 示例公式中的变量 startingNumberOfVMsmaxNumberofVMs 可以根据需要进行调整。

待定任务

对于此自动缩放公式,最初使用单个 VM 创建池。 $PendingTasks 指标定义正在运行或已排队的任务数。 该公式查找过去 180 秒内的平均挂起任务数,并相应地设置 $TargetDedicatedNodes 变量。 该公式确保专用节点的目标数永远不会超过 25 个 VM。 提交新任务时,池会自动增大。 任务完成时,VM 会变为可用状态,自动缩放公式会收缩池。

此公式缩放专用节点。

startingNumberOfVMs = 1;
maxNumberofVMs = 25;
pendingTaskSamplePercent = $PendingTasks.GetSamplePercent(180 * TimeInterval_Second);
pendingTaskSamples = pendingTaskSamplePercent < 70 ? startingNumberOfVMs : avg($PendingTasks.GetSample(180 * TimeInterval_Second));
$TargetDedicatedNodes=min(maxNumberofVMs, pendingTaskSamples);
$NodeDeallocationOption = taskcompletion;

变量

可在自动缩放公式中同时使用“服务定义”和“用户定义”的变量。

服务定义的变量内置在 Batch 服务中。 有些服务定义的变量是可读写的,有些是只读的。

用户定义的变量是定义的变量。 在上一个示例中,$TargetDedicatedNodes$PendingTasks 是服务定义的变量,startingNumberOfVMsmaxNumberofVMs 是用户定义的变量。

注意

服务定义的变量始终前面带有美元符号 ($)。 对于用户定义的变量,美元符号是可选的。

下表显示了 Batch 服务定义的读写和只读变量。

可读写的服务定义变量

可以获取和设置这些服务定义的变量的值,以管理池中计算节点的数目。

变量 说明
$TargetDedicatedNodes 池的专用计算节点的目标数。 指定为目标,因为池可能不会始终达到所需节点数。 例如,如果在池达到初始目标数之前自动缩放评估修改了专用节点的目标数,池可能不会达到目标数。

如果目标数超过 Batch 帐户节点或核心配额,使用 Batch 服务模式创建的帐户中的池可能不会达到目标数。 如果目标数超过订阅的共享核心配额,使用用户订阅模式创建的帐户中的池可能不会达到目标数。
$NodeDeallocationOption 从池中删除计算节点时发生的操作。 可能的值包括:
- requeue:默认值。 立即终止任务并将其放回作业队列,以便重新计划这些任务。 此操作可确保尽快达到目标节点数。 但是,它的效率可能较低,因为任何正在运行的任务都会中断,然后必须重启。
- terminate:立即结束任务并将其从作业队列中删除。
- taskcompletion:等待当前运行的任务完成,并从池中删除节点。 使用此选项可以避免任务被中断和重新排队,因此不会浪费任务已完成的任何工作。
- retaineddata:等待清理节点上的本地任务保留的所有数据,并从池中删除节点。

注意

还可以使用别名 $TargetDedicated 指定 $TargetDedicatedNodes 变量。 如果全名变量及其别名由公式设置,则分配给全名变量的值会优先处理。

只读服务定义的变量

可以获取这些服务定义的变量的值,以根据 Batch 服务中的指标进行调整。

重要

作业释放任务当前未包含在提供任务计数的变量(例如 $ActiveTasks$PendingTasks)中。 根据你的自动缩放公式,这可能会导致节点被删除,并且没有节点可用于运行作业释放任务。

提示

这些只读的服务定义变量是对象,它们提供了各种方法来访问与其关联的数据。 有关详细信息,请参阅本文稍后的获取样本数据

变量 说明
$CPUPercent CPU 使用率的平均百分比。
$ActiveTasks 已准备好执行但尚未执行的任务数。 这包括处于活动状态且其依赖关系都得到满足的所有任务。 处于活动状态但不满足其依赖关系的所有任务将从 $ActiveTasks 计数中排除。 对于多实例任务,$ActiveTasks 包括该任务的实例集数。
$RunningTasks 处于运行状态的任务数。
$PendingTasks $ActiveTasks$RunningTasks 的和。
$SucceededTasks 成功完成的任务数。
$FailedTasks 失败的任务数。
$TaskSlotsPerNode 可用于在池中单个计算节点上运行并发任务的任务槽数。
$CurrentDedicatedNodes 当前的专用计算节点数。

注意

根据在某个时间点运行的任务数进行缩放时使用 $RunningTasks,根据排队等待运行的任务数进行缩放时使用 $ActiveTasks

类型

自动缩放公式支持以下类型:

  • Double
  • doubleVec
  • doubleVecList
  • string
  • timestamp--一个包含以下成员的复合结构:
    • year
    • month (1-12)
    • day (1-31)
    • weekday(采用数字格式,例如 1 表示星期一)
    • hour(采用 24 时制数字格式,例如 13 表示下午 1 点)
    • minute (00-59)
    • second (00-59)
  • timeinterval
    • TimeInterval_Zero
    • TimeInterval_100ns
    • TimeInterval_Microsecond
    • TimeInterval_Millisecond
    • TimeInterval_Second
    • TimeInterval_Minute
    • TimeInterval_Hour
    • TimeInterval_Day
    • TimeInterval_Week
    • TimeInterval_Year

操作

上一部分中列出的类型允许以下操作。

操作 支持的运算符 结果类型
double operator double +、-、*、/ double
double operator timeinterval * timeinterval
doubleVec operator double +、-、*、/ doubleVec
doubleVec operator doubleVec +、-、*、/ doubleVec
timeinterval operator double *、/ timeinterval
timeinterval operator timeinterval +, - timeinterval
timeinterval operator timestamp + timestamp
timestamp operator timeinterval + timestamp
timestamp operator timestamp - timeinterval
operator double -、! Double
operator timeinterval - timeinterval
double operator double <、<=、==、>=、>、!= double
string operator string <、<=、==、>=、>、!= double
timestamp operator timestamp <、<=、==、>=、>、!= double
timeinterval operator timeinterval <、<=、==、>=、>、!= double
double operator double &&、|| double

使用三元运算符 (double ? statement1 : statement2) 测试双精度,结果非零为 true,零为 false

函数

在定义自动缩放公式时,可以使用这些预定义的函数

函数 返回类型 说明
avg(doubleVecList) Double 返回 doubleVecList 中所有值的平均值。
ceil(double) double 返回不小于 double 的最小整数值。
ceil(doubleVecList) doubleVec 返回 doubleVecList 的分量方式 ceil
floor(double) double 返回不大于 double 的最大整数值。
floor(doubleVecList) doubleVec 返回 doubleVecList 的分量方式 floor
len(doubleVecList) Double 返回从 doubleVecList 创建的向量的长度。
lg(double) Double 返回 double 的对数底数 2。
lg(doubleVecList) doubleVec 返回 doubleVecList 的分量方式 lg
ln(double) Double 返回 double 的自然对数。
ln(doubleVecList) doubleVec 返回 doubleVecList 的分量方式 ln
log(double) Double 返回 double 的对数底数 10。
log(doubleVecList) doubleVec 返回 doubleVecList 的分量方式 log
max(doubleVecList) Double 返回 doubleVecList 中的最大值。
min(doubleVecList) Double 返回 doubleVecList 中的最小值。
norm(doubleVecList) Double 返回从 doubleVecList 创建的向量的二范数。
percentile(doubleVec v, double p) Double 返回向量 v 的百分位元素。
rand() double 返回介于 0.0 和 1.0 之间的随机值。
range(doubleVecList) Double 返回 doubleVecList 中最小值和最大值之间的差。
round(double) double 返回距离 double(浮点格式)最近的整数值,向远离零的方向四舍五入。
round(doubleVecList) doubleVec 返回 doubleVecList 的分量方式 round
std(doubleVecList) double 返回 doubleVecList 中值的样本标准偏差。
stop() 停止对自动缩放表达式求值。
sum(doubleVecList) double 返回 doubleVecList 的所有组成部分之和。
time(string dateTime="") timestamp 如果未传递参数,则返回当前时间的时间戳;如果传递了参数,则返回 dateTime 字符串的时间戳。 支持的 dateTime 格式为 W3C-DTF 和 RFC 1123。
val(doubleVec v, double i) Double 返回在起始索引为零的向量 v 中,位置 i 处的元素的值。

上表中描述的某些函数可以接受列表作为参数。 逗号分隔列表为 doubledoubleVec 的任意组合。 例如:

doubleVecList := ( (double | doubleVec)+(, (double | doubleVec) )* )?

doubleVecList 值在计算之前会转换为单个 doubleVec。 例如,如果 v = [1,2,3],则调用 avg(v) 相当于调用 avg(1,2,3)。 调用 avg(v, 7) 相当于调用 avg(1,2,3,7)

指标

定义公式时,可以使用资源和任务指标。 可根据获取和求值的度量值数据对池中专用节点的目标数目进行调整。 有关每个指标的详细信息,请参阅 变量 部分。

指标 说明
资源 资源指标基于计算节点的 CPU、带宽和内存使用量以及节点数。

这些服务定义的变量可用于根据节点计数进行调整:
- $TargetDedicatedNodes
- $TargetLowPriorityNodes
- $CurrentDedicatedNodes
- $SampleNodeCount

这些服务定义的变量可用于根据节点资源使用量进行调整:
- $CPUPercent
- $WallClockSeconds
- $MemoryBytes
- $DiskBytes
- $DiskReadBytes
- $DiskWriteBytes
- $DiskReadOps
- $DiskWriteOps
- $NetworkInBytes
- $NetworkOutBytes
任务 任务指标基于任务的状态(例如活动、挂起和已完成)。 以下服务定义的变量可用于根据任务度量值调整池大小:
- $ActiveTasks
- $RunningTasks
- $PendingTasks
- $SucceededTasks
- $FailedTasks

获取示例数据

自动缩放公式的核心操作是获取任务和资源指标数据(样本),并根据该数据调整池大小。 因此,请务必明确知道自动缩放公式如何与样本进行交互。

方法

自动缩放公式使用 Batch 服务提供的指标数据样本。 公式根据获取的值来扩大或缩小池计算节点。 服务定义的变量是一些对象,它们提供方法以访问与该对象关联的数据。 例如,以下表达式显示了一个用于获取过去五分钟 CPU 使用率的请求:

$CPUPercent.GetSample(TimeInterval_Minute * 5)

可以使用以下方法获取有关服务定义的变量的样本数据。

方法 说明
GetSample() GetSample() 方法返回数据样本的向量。

一个样本最好包含 30 秒钟的度量值数据。 换而言之,将每隔 30 秒获取一次样本。 但如下所示,样本在收集后需经历一定的延迟才能供公式使用。 因此,并非一段指定时间内的所有样本都可用于公式求值。

- doubleVec GetSample(double count):指定从收集的最近样本中获得的样本数。 GetSample(1) 返回最后一个可用样本。 但对于 $CPUPercent 这样的变量,不应使用 GetSample(1),因为无法获知样本是何时收集的。 它可能是最近收集的数据,也可能是旧得多的数据(由于存在系统问题)。 在此类情况下,最好使用如下所示的时间间隔。

- doubleVec GetSample((timestamp or timeinterval) startTime [, double samplePercent]):指定收集样本数据的时间范围。 (可选)它还指定必须在请求的时间范围内提供的样本的百分比。 例如,如果 CPUPercent 历史记录中存在过去 10 分钟的所有样本,$CPUPercent.GetSample(TimeInterval_Minute * 10) 会返回 20 个样本。 如果最后一分钟的历史记录不可用,则只返回 18 个样本。 在这种情况下,$CPUPercent.GetSample(TimeInterval_Minute * 10, 95) 会失败,因为仅 90% 的样本可用,但 $CPUPercent.GetSample(TimeInterval_Minute * 10, 80) 会成功。

- doubleVec GetSample((timestamp or timeinterval) startTime, (timestamp or timeinterval) endTime [, double samplePercent]):指定收集数据的时间范围(包括开始时间和结束时间)。 如前所述,在收集样本后,需等待一段时间,然后该样本才能供公式使用。 使用 GetSample 方法时,请考虑到这种延迟。 请参阅下面的 GetSamplePercent
GetSamplePeriod() 返回在历史样本数据集中采样的期间。
Count() 返回指标历史记录中的样本总数。
HistoryBeginTime() 返回度量值最旧可用数据样本的时间戳。
GetSamplePercent() 返回给定时间间隔的可用样本百分比。 例如,doubleVec GetSamplePercent( (timestamp or timeinterval) startTime [, (timestamp or timeinterval) endTime] )。 由于 GetSample 方法失败,因此如果返回的样本百分比低于指定的 samplePercent,则可先使用 GetSamplePercent 方法进行检查。 然后,如果存在的样本数量不足,用户可以执行其他操作,无需停止自动缩放评估。

示例

Batch 服务定期获取任务和资源指标的样本,使其可供自动缩放公式使用。 这些样本每 30 秒由 Batch 服务记录一次。 但是,记录样本的时间与样本可供自动缩放公式使用(与读取)的时间之间通常存在延迟。 此外,由于各种因素(例如网络或其他基础结构问题),可能无法记录特定间隔的样本。

样本百分比

samplePercent 传递到 GetSample() 方法,或调用 GetSamplePercent() 方法时,百分比是指 Batch 服务记录的样本可能的总数与自动缩放公式可用的样本数之间的比值。

让我们以 10 分钟的时间跨度为例。 由于每隔 30 秒记录一次样本,因此在 10 分钟的时间跨度内,Batch 服务记录的样本总数会达到 20 个(每分钟 2 个)。 但是,由于报告机制的固有延迟,并且 Azure 中存在其他问题,可能只有 15 个样本可供自动缩放公式读取。 因此,举例来说,在这 10 分钟内,记录的样本总数只有 75% 可供公式使用。

GetSample() 和样本范围

自动缩放公式添加或删除节点以对池进行扩大和收缩操作。 由于节点耗费资金,请确保公式使用的智能分析方法以足够的数据为基础。 建议在公式中使用趋势类型的分析。 此类型会根据所收集样本的范围来扩大和缩小池。

为此,请使用 GetSample(interval look-back start, interval look-back end) 返回样本的矢量:

$runningTasksSample = $RunningTasks.GetSample(1 * TimeInterval_Minute, 6 * TimeInterval_Minute);

Batch 评估上述代码行后,会以值的矢量形式返回样本范围。 例如:

$runningTasksSample=[1,1,1,1,1,1,1,1,1,1];

收集样本矢量后,可以使用 min()max()avg() 等函数从收集的范围中派生有意义的值。

为了更加谨慎,如果特定时间段小于特定的样本百分比,可强制公式求值失败。 强制公式求值失败会指示 Batch 在无法提供指定百分比的样本数时停止进一步的公式求值。 在这种情况下,不更改池大小。 要指定求值成功所需的样本百分比,请将其指定为 GetSample()的第三个参数。 下面指定要求 75% 的样本:

$runningTasksSample = $RunningTasks.GetSample(60 * TimeInterval_Second, 120 * TimeInterval_Second, 75);

由于样本可用性可能存在延迟,因此应始终指定回查开始时间早于一分钟的时间范围。 样本需要约一分钟才能传播到整个系统,因此可能无法使用 (0 * TimeInterval_Second, 60 * TimeInterval_Second) 范围内的样本。 同样地,可以使用 GetSample() 百分比参数来强制实施特定样本百分比要求。

重要

强烈建议不要仅依赖自动缩放公式中的 GetSample(1)。 这是因为,GetSample(1) 基本上只是向 Batch 服务表明:“不论多久以前检索最后一个样本,请将它提供给我。”由于它只是单个样本,而且可能是较旧的样本,因此可能无法代表最近任务或资源状态的全貌。 如果使用 GetSample(1),请确保它是更大语句的一部分,而不是公式所依赖的唯一数据点。

编写自动缩放公式

构造自动缩放公式时,可以使用上述组件来生成语句,并将这些语句组合成完整的公式即可。 在本部分中,你会创建自动缩放公式示例,它可以执行实际缩放决策并进行调整。

首先,定义新自动缩放公式的要求。 该公式应可以:

  • 如果 CPU 使用率高,则增加池中专用计算节点的目标数。
  • 如果 CPU 使用率低,则减少池中专用计算节点的目标数。
  • 始终将最大专用节点数限制为 400。
  • 减少节点数量时,不要删除正在运行任务的节点;如有必要,请等到任务完成后再删除节点。

在 CPU 使用率高时,公式中的第一个语句会增加节点数。 你定义语句,规定只有当过去 10 分钟内的最小平均 CPU 使用率高于 70% 时,该语句才会向用户定义的变量($totalDedicatedNodes)填充值,值的大小为专用节点当前目标数的 110%。 否则,它会使用专用节点的当前数值。

$totalDedicatedNodes =
    (min($CPUPercent.GetSample(TimeInterval_Minute * 10)) > 0.7) ?
    ($CurrentDedicatedNodes * 1.1) : $CurrentDedicatedNodes;

如果过去 60 分钟内平均 CPU 使用率低于 20%,公式中的下一个语句会将同一 $totalDedicatedNodes 变量设置为专用节点当前目标数的 90%,这是为了在 CPU 使用率低时减少专用节点数。 否则,它会使用在上述语句中填充的 $totalDedicatedNodes 的当前值。

$totalDedicatedNodes =
    (avg($CPUPercent.GetSample(TimeInterval_Minute * 60)) < 0.2) ?
    ($CurrentDedicatedNodes * 0.9) : $totalDedicatedNodes;

现在,将专用计算节点的目标数限制为最大值 400:

$TargetDedicatedNodes = min(400, $totalDedicatedNodes);

最后,确保在节点任务完成之前不会删除节点。

$NodeDeallocationOption = taskcompletion;

下面是完整公式:

$totalDedicatedNodes =
    (min($CPUPercent.GetSample(TimeInterval_Minute * 10)) > 0.7) ?
    ($CurrentDedicatedNodes * 1.1) : $CurrentDedicatedNodes;
$totalDedicatedNodes =
    (avg($CPUPercent.GetSample(TimeInterval_Minute * 60)) < 0.2) ?
    ($CurrentDedicatedNodes * 0.9) : $totalDedicatedNodes;
$TargetDedicatedNodes = min(400, $totalDedicatedNodes);
$NodeDeallocationOption = taskcompletion;

注意

可以根据需要在公式字符串中包含注释和分行符。 还要注意,缺少分号可能会导致求值错误。

自动缩放间隔

默认情况下,Batch 服务根据其自动缩放公式每隔 15 分钟调整池大小。 可使用以下池属性配置此间隔:

最小间隔为 5 分钟,最大间隔为 168 小时。 如果指定的间隔超出此范围,Batch 服务会返回“错误的请求(400)”错误。

注意

自动缩放目前不能以低于一分钟的时间响应更改,而只能在运行工作负荷时逐步调整池大小。

使用 Batch SDK 创建支持自动缩放的池

可以使用任意 Batch SDKBatch REST API Batch PowerShell cmdletBatch CLI 配置池自动缩放。 在此部分,可以查看 .NET 和 Python 的示例。

.NET

若要在 .NET 中创建启用自动缩放的池,请遵循以下步骤:

  1. 使用 BatchClient.PoolOperations.CreatePool 创建池。
  2. CloudPool.AutoScaleEnabled 属性设置为 true
  3. 使用自动缩放公式设置 CloudPool.AutoScaleFormula 属性。
  4. (可选)设置 CloudPool.AutoScaleEvaluationInterval 属性(默认值为 15 分钟)。
  5. 使用 CloudPool.CommitCommitAsync 提交池。

以下示例使用 .NET 创建启用自动缩放的池。 该池的自动缩放公式在星期一将专用节点的目标数设置为 5,在每周的其他日期将该目标数设置为 1。 自动缩放间隔设置为 30 分钟。 在本文的此部分与其他 C# 代码片段中,myBatchClientBatchClient 类的适当初始化的实例。

CloudPool pool = myBatchClient.PoolOperations.CreatePool(
                    poolId: "mypool",
                    virtualMachineSize: "standard_d1_v2",
                    VirtualMachineConfiguration: new VirtualMachineConfiguration(
                        imageReference: new ImageReference(
                                            publisher: "MicrosoftWindowsServer",
                                            offer: "WindowsServer",
                                            sku: "2019-datacenter-core",
                                            version: "latest"),
                        nodeAgentSkuId: "batch.node.windows amd64");
pool.AutoScaleEnabled = true;
pool.AutoScaleFormula = "$TargetDedicatedNodes = (time().weekday == 1 ? 5:1);";
pool.AutoScaleEvaluationInterval = TimeSpan.FromMinutes(30);
await pool.CommitAsync();

重要

创建启用自动缩放的池时,请不要在对 CreatePool 的调用中指定 targetDedicatedNodes 参数。 应该指定池中的 AutoScaleEnabledAutoScaleFormula 属性。 这些属性的值确定每种类型的节点的目标数。

若要手动重设启用自动缩放功能的池的大小(例如,使用 BatchClient.PoolOperations.ResizePoolAsync 来重设大小),必须先禁用该池的自动缩放,然后重设其大小。

提示

有关使用 .NET SDK 的更多示例,请参阅 GitHub 上的 Batch .NET 快速入门存储库

Python

要通过 Python SDK 创建已启用自动缩放的池:

  1. 创建池并指定其配置。
  2. 将池添加到服务客户端。
  3. 使用编写的公式在池中启用自动缩放。

以下示例演示了这些步骤。

# Create a pool; specify configuration
new_pool = batch.models.PoolAddParameter(
    id="autoscale-enabled-pool",
    virtual_machine_configuration=batchmodels.VirtualMachineConfiguration(
        image_reference=batchmodels.ImageReference(
          publisher="Canonical",
          offer="UbuntuServer",
          sku="20.04-LTS",
          version="latest"
            ),
        node_agent_sku_id="batch.node.ubuntu 20.04"),
    vm_size="STANDARD_D1_v2",
    target_dedicated_nodes=0,
    target_low_priority_nodes=0
)
batch_service_client.pool.add(new_pool) # Add the pool to the service client

formula = """$curTime = time();
             $workHours = $curTime.hour >= 8 && $curTime.hour < 18;
             $isWeekday = $curTime.weekday >= 1 && $curTime.weekday <= 5;
             $isWorkingWeekdayHour = $workHours && $isWeekday;
             $TargetDedicated = $isWorkingWeekdayHour ? 20:10;""";

# Enable autoscale; specify the formula
response = batch_service_client.pool.enable_auto_scale(pool_id, auto_scale_formula=formula,
                                            auto_scale_evaluation_interval=datetime.timedelta(minutes=10),
                                            pool_enable_auto_scale_options=None,
                                            custom_headers=None, raw=False)

提示

有关使用 Python SDK 的更多示例,请参阅 GitHub 上的 Batch Python 快速入门存储库

启用现有池的自动缩放功能

每个 Batch SDK 都提供了启用自动缩放的方式。 例如:

在现有池上启用自动缩放时,请注意:

  • 如果目前禁用了池的自动缩放功能,则在发出该请求时必须指定有效的自动缩放公式。 你还可以指定自动缩放间隔。 如果未指定时间间隔,则使用默认值 15 分钟。
  • 如果池中目前已启用自动缩放,则可指定新公式和/或新间隔。 必须至少指定其中的一个属性。
    • 如果指定新的自动缩放间隔,则会停止现有的计划并启动新的计划。 新计划的开始时间是发出启用自动缩放的请求的时间。
    • 如果省略自动缩放公式或时间间隔,则 Batch 服务将继续使用该设置的当前值。

注意

如果使用 .NET 创建池时指定了 CreatePool 方法的 targetDedicatedNodes 参数的值,或者使用其他语言指定了相应参数的值,则评估自动缩放公式时会忽略这些值。

此 C# 示例使用 Batch.NET 库启用现有池的自动缩放。

// Define the autoscaling formula. This formula sets the target number of nodes
// to 5 on Mondays, and 1 on every other day of the week
string myAutoScaleFormula = "$TargetDedicatedNodes = (time().weekday == 1 ? 5:1);";

// Set the autoscale formula on the existing pool
await myBatchClient.PoolOperations.EnableAutoScaleAsync(
    "myexistingpool",
    autoscaleFormula: myAutoScaleFormula);

更新自动缩放公式

若要更新现有的已启用自动缩放的池的公式,请使用新公式再次调用启用自动缩放的操作。 例如,如果在执行以下 .NET 代码时已在 myexistingpool 上启用自动缩放,则自动缩放公式会替换为 myNewFormula 的内容。

await myBatchClient.PoolOperations.EnableAutoScaleAsync(
    "myexistingpool",
    autoscaleFormula: myNewFormula);

更新自动缩放时间间隔

若要更新现有的已启用自动缩放的池的自动缩放评估间隔,请使用新间隔再次调用启用自动缩放的操作。 例如,将 .NET 中已启用自动缩放的池的自动缩放评估间隔设置为 60 分钟:

await myBatchClient.PoolOperations.EnableAutoScaleAsync(
    "myexistingpool",
    autoscaleEvaluationInterval: TimeSpan.FromMinutes(60));

评估自动缩放公式

在将公式应用于池之前可以对公式进行计算。 这样就可以在将公式的结果用于生产环境中之前对其进行测试。

在评估自动缩放公式之前,必须先通过有效的公式(例如单行公式 $TargetDedicatedNodes = 0)为池启用自动缩放。 然后,使用以下任何一个方法来计算想要测试的公式:

以下 Batch.NET 示例对自动缩放公式进行求值。 如果池尚未使用自动缩放,请先启用该功能。

// First obtain a reference to an existing pool
CloudPool pool = await batchClient.PoolOperations.GetPoolAsync("myExistingPool");

// If autoscaling isn't already enabled on the pool, enable it.
// You can't evaluate an autoscale formula on a non-autoscale-enabled pool.
if (pool.AutoScaleEnabled == false)
{
    // You need a valid autoscale formula to enable autoscaling on the
    // pool. This formula is valid, but won't resize the pool:
    await pool.EnableAutoScaleAsync(
        autoscaleFormula: "$TargetDedicatedNodes = $CurrentDedicatedNodes;",
        autoscaleEvaluationInterval: TimeSpan.FromMinutes(5));

    // Batch limits EnableAutoScaleAsync calls to once every 30 seconds.
    // Because you want to apply our new autoscale formula below if it
    // evaluates successfully, and you *just* enabled autoscaling on
    // this pool, pause here to ensure you pass that threshold.
    Thread.Sleep(TimeSpan.FromSeconds(31));

    // Refresh the properties of the pool so that we've got the
    // latest value for AutoScaleEnabled
    await pool.RefreshAsync();
}

// You must ensure that autoscaling is enabled on the pool prior to
// evaluating a formula
if (pool.AutoScaleEnabled == true)
{
    // The formula to evaluate - adjusts target number of nodes based on
    // day of week and time of day
    string myFormula = @"
        $curTime = time();
        $workHours = $curTime.hour >= 8 && $curTime.hour < 18;
        $isWeekday = $curTime.weekday >= 1 && $curTime.weekday <= 5;
        $isWorkingWeekdayHour = $workHours && $isWeekday;
        $TargetDedicatedNodes = $isWorkingWeekdayHour ? 20:10;
    ";

    // Perform the autoscale formula evaluation. Note that this code does not
    // actually apply the formula to the pool.
    AutoScaleRun eval =
        await batchClient.PoolOperations.EvaluateAutoScaleAsync(pool.Id, myFormula);

    if (eval.Error == null)
    {
        // Evaluation success - print the results of the AutoScaleRun.
        // This will display the values of each variable as evaluated by the
        // autoscale formula.
        Console.WriteLine("AutoScaleRun.Results: " +
            eval.Results.Replace("$", "\n    $"));

        // Apply the formula to the pool since it evaluated successfully
        await batchClient.PoolOperations.EnableAutoScaleAsync(pool.Id, myFormula);
    }
    else
    {
        // Evaluation failed, output the message associated with the error
        Console.WriteLine("AutoScaleRun.Error.Message: " +
            eval.Error.Message);
    }
}

如果此代码片段中所示的公式评估成功,会生成如下所示的结果:

AutoScaleRun.Results:
    $TargetDedicatedNodes=10;
    $NodeDeallocationOption=requeue;
    $curTime=2016-10-13T19:18:47.805Z;
    $isWeekday=1;
    $isWorkingWeekdayHour=0;
    $workHours=0

获取有关自动缩放运行的信息

建议定期检查 Batch 服务对自动缩放公式的评估。 为此,请获取(或刷新)对池的引用,然后检查其上一次自动缩放运行的属性。

在 Batch .NET 中,CloudPool.AutoScaleRun 属性具有多个属性,其提供了有关在池上执行的最新自动缩放运行的信息:

在 REST API 中,有关池的信息包括 autoScaleRun 属性中最新自动缩放运行的信息。

以下 C# 示例使用 Batch .NET 库来输出在池 myPool 中的最新自动缩放运行的信息。

await Cloud pool = myBatchClient.PoolOperations.GetPoolAsync("myPool");
Console.WriteLine("Last execution: " + pool.AutoScaleRun.Timestamp);
Console.WriteLine("Result:" + pool.AutoScaleRun.Results.Replace("$", "\n  $"));
Console.WriteLine("Error: " + pool.AutoScaleRun.Error);

前述示例的示例输出:

Last execution: 10/14/2016 18:36:43
Result:
  $TargetDedicatedNodes=10;
  $NodeDeallocationOption=requeue;
  $curTime=2016-10-14T18:36:43.282Z;
  $isWeekday=1;
  $isWorkingWeekdayHour=0;
  $workHours=0
Error:

使用池自动缩放事件获取自动缩放运行历史记录

你还可以通过查询 PoolAutoScaleEvent 来查看自动缩放历史记录。 Batch 服务发出此事件,用于记录每次自动缩放公式计算和执行的情况,这有助于排查潜在问题。

PoolAutoScaleEvent 的示例事件:

{
    "id": "poolId",
    "timestamp": "2020-09-21T23:41:36.750Z",
    "formula": "...",
    "results": "$TargetDedicatedNodes=10;$NodeDeallocationOption=requeue;$curTime=2016-10-14T18:36:43.282Z;$isWeekday=1;$isWorkingWeekdayHour=0;$workHours=0",
    "error": {
        "code": "",
        "message": "",
        "values": []
    }
}

自动缩放公式示例

让我们查看一些公式,它们演示了调整池中计算资源数量的不同方法。

示例 1:基于时间的调整

假设要根据星期日期和当天的时间来调整池的大小。 此示例演示如何相应地增加或减少池中的节点数。

该公式首先获取当前时间。 如果日期是工作日(周一到周五)且时间是工作时间(早 8 点到晚 6 点),则会将目标池大小设置为 20 个节点。 否则,设为 10 个节点。

$curTime = time();
$workHours = $curTime.hour >= 8 && $curTime.hour < 18;
$isWeekday = $curTime.weekday >= 1 && $curTime.weekday <= 5;
$isWorkingWeekdayHour = $workHours && $isWeekday;
$TargetDedicatedNodes = $isWorkingWeekdayHour ? 20:10;
$NodeDeallocationOption = taskcompletion;

通过将 time()TimeZoneInterval_Hour 和 UTC 时差的乘积相加,可以调整 $curTime,使之反映本地时区。 例如,使用 $curTime = time() + (-6 * TimeInterval_Hour); 作为山地夏令时 (MDT)。 请记住,在夏令时开始和结束时(如果适用),需要调整偏移量。

示例 2:基于任务的调整

在此 C# 示例中,池大小根据队列中的任务数进行调整。 公式字符串中包含注释和分行符。

// Get pending tasks for the past 15 minutes.
$samples = $PendingTasks.GetSamplePercent(TimeInterval_Minute * 15);
// If you have fewer than 70 percent data points, use the last sample point,
// otherwise use the maximum of last sample point and the history average.
$tasks = $samples < 70 ? max(0,$PendingTasks.GetSample(1)) : max( $PendingTasks.GetSample(1), avg($PendingTasks.GetSample(TimeInterval_Minute * 15)));
// If number of pending tasks is not 0, set targetVM to pending tasks, otherwise
// half of current dedicated.
$targetVMs = $tasks > 0? $tasks:max(0, $TargetDedicatedNodes/2);
// The pool size is capped at 20, if target VM value is more than that, set it
// to 20. This value should be adjusted according to your use case.
$TargetDedicatedNodes = max(0, min($targetVMs, 20));
// Set node deallocation mode - let running tasks finish before removing a node
$NodeDeallocationOption = taskcompletion;

示例 3:考虑并行任务

此 C# 示例根据任务数调整池大小。 此公式还考虑了为池设置的 TaskSlotsPerNode 值。 在对池启用了并行任务执行的情况下,此方法特别有效。

// Determine whether 70 percent of the samples have been recorded in the past
// 15 minutes; if not, use last sample
$samples = $ActiveTasks.GetSamplePercent(TimeInterval_Minute * 15);
$tasks = $samples < 70 ? max(0,$ActiveTasks.GetSample(1)) : max( $ActiveTasks.GetSample(1),avg($ActiveTasks.GetSample(TimeInterval_Minute * 15)));
// Set the number of nodes to add to one-fourth the number of active tasks
// (the TaskSlotsPerNode property on this pool is set to 4, adjust
// this number for your use case)
$cores = $TargetDedicatedNodes * 4;
$extraVMs = (($tasks - $cores) + 3) / 4;
$targetVMs = ($TargetDedicatedNodes + $extraVMs);
// Attempt to grow the number of compute nodes to match the number of active
// tasks, with a maximum of 3
$TargetDedicatedNodes = max(0,min($targetVMs,3));
// Keep the nodes active until the tasks finish
$NodeDeallocationOption = taskcompletion;

示例 4:设置初始池大小

此示例演示了一个 C# 示例,其中的自动缩放公式可在初始时间段内将池大小设置为指定的节点数。 然后,该公式会根据正在运行的和处于活动状态的任务的数目调整池大小。

具体说来,此公式执行以下操作:

  • 将初始池大小设置为 4 个节点。
  • 在池生命周期的最初 10 分钟内不调整池大小。
  • 10 分钟后,获取过去 60 分钟内正在运行和处于活动状态的任务数目的最大值。
    • 如果这两个值都是 0(表示过去 60 分钟没有正在运行或处于活动状态的任务),池大小将设置为 0。
    • 如果其中一个值大于零,则不进行任何更改。
string now = DateTime.UtcNow.ToString("r");
string formula = string.Format(@"
    $TargetDedicatedNodes = {1};
    lifespan         = time() - time(""{0}"");
    span             = TimeInterval_Minute * 60;
    startup          = TimeInterval_Minute * 10;
    ratio            = 50;

    $TargetDedicatedNodes = (lifespan > startup ? (max($RunningTasks.GetSample(span, ratio), $ActiveTasks.GetSample(span, ratio)) == 0 ? 0 : $TargetDedicatedNodes) : {1});
    ", now, 4);

后续步骤