Таймеры в устойчивых функциях (Функции Azure)

Статья
03/25/2023

Устойчивые функции предоставляют устойчивые таймеры, которые используются в функциях оркестраторов для реализации задержек или настройки времени ожидания в асинхронных действиях. Вместо API спящего режима или задержки, которые могут быть встроены в язык, в функциях оркестратора следует использовать устойчивые таймеры.

Устойчивые таймеры — это задачи, которые создаются с помощью соответствующего API создания таймера для указанного языка, как показано ниже, и в качестве аргумента принимают либо срок выполнения, либо длительность.

// Put the orchestrator to sleep for 72 hours
DateTime dueTime = context.CurrentUtcDateTime.AddHours(72);
await context.CreateTimer(dueTime, CancellationToken.None);

// Put the orchestrator to sleep for 72 hours
// Note that DateTime comes from the "luxon" module
const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ hours: 72 });
yield context.df.createTimer(deadline.toJSDate());

# Put the orchestrator to sleep for 72 hours
due_time = context.current_utc_datetime + timedelta(hours=72)
durable_timeout_task = context.create_timer(due_time)

# Put the orchestrator to sleep for 72 hours
$duration = New-TimeSpan -Hours 72
Start-DurableTimer -Duration $duration

// Put the orchestrator to sleep for 72 hours
ctx.createTimer(Duration.ofHours(72)).await();

Когда вы "ожидаете" задачу таймера, функция оркестратора будет находиться в спящем режиме до указанного времени окончания срока действия.

Примечание.

Во время ожидания истечения срока действия задачи таймера оркестрации будут продолжать обрабатывать другие входящие события.

Ограничения таймера

При создании таймера, срок действия которого истекает в 16:30 (UTC), базовая платформа устойчивых задач помещает в очередь сообщение, которое становится видимым только в 16:30. Если в это время приложение-функция масштабируется до нуля экземпляров, новое отображаемое сообщение таймера обеспечит повторную активацию приложения-функции на соответствующей виртуальной машине.

Примечание.

Для приложений JavaScript, Python и PowerShell устойчивые таймеры ограничены шестью днями. Чтобы обойти это ограничение, можно использовать API таймера в цикле while для имитации длительной задержки. Актуальные приложения .NET и Java поддерживают произвольные длительные таймеры.
В зависимости от используемой версии пакета SDK и поставщика хранилища длительные таймеры в течение 6 дней или более могут быть реализованы внутри системы с помощью ряда более коротких таймеров (например, 3 дня), пока не будет достигнуто требуемое время окончания срока действия. Это можно наблюдать в базовом хранилище данных, но не влияет на поведение оркестрации.
Не используйте встроенные API даты и времени для получения текущего времени. При вычислении будущей даты истечения срока действия таймера всегда используйте API текущего времени функции оркестратора. Дополнительные сведения см. в статье об ограничениях кода функции оркестратора.

Использование для задержки

В следующем примере показано, как использовать устойчивые таймеры для задержки выполнения. В примере отправляется уведомление о выставлении счета каждый день в течение 10 дней.

[FunctionName("BillingIssuer")]
public static async Task Run(
    [OrchestrationTrigger] IDurableOrchestrationContext context)
{
    for (int i = 0; i < 10; i++)
    {
        DateTime deadline = context.CurrentUtcDateTime.Add(TimeSpan.FromDays(1));
        await context.CreateTimer(deadline, CancellationToken.None);
        await context.CallActivityAsync("SendBillingEvent");
    }
}

Примечание.

Предыдущий пример C# нацелен на Устойчивые функции 2.x. Для расширения Устойчивые функции 1.x необходимо использовать DurableOrchestrationContext вместо IDurableOrchestrationContext. Дополнительные сведения о различиях между версиями см. в статье Версии устойчивых функций.

const df = require("durable-functions");
const { DateTime } = require("luxon");

module.exports = df.orchestrator(function*(context) {
    for (let i = 0; i < 10; i++) {
        const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ days: 1 });
        yield context.df.createTimer(deadline.toJSDate());
        yield context.df.callActivity("SendBillingEvent");
    }
});

import azure.functions as func
import azure.durable_functions as df
from datetime import datetime, timedelta

def orchestrator_function(context: df.DurableOrchestrationContext):
    for i in range(0, 9):
        deadline = context.current_utc_datetime + timedelta(days=1)
        yield context.create_timer(deadline)
        yield context.call_activity("SendBillingEvent")

main = df.Orchestrator.create(orchestrator_function)

param($Context)

for ($num = 0 ; $num -le 9 ; $num++){    
    $expiryTime =  New-TimeSpan -Days 1
    $timerTask = Start-DurableTimer -Duration $expiryTime
    Invoke-DurableActivity -FunctionName 'SendBillingEvent'
}

@FunctionName("BillingIssuer")
public String billingIssuer(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    for (int i = 0; i < 10; i++) {
        ctx.createTimer(Duration.ofDays(1)).await();
        ctx.callActivity("SendBillingEvent").await();
    }
    return "done";
}

Предупреждение

Избегайте бесконечных циклов в функциях оркестраторов. Сведения о том, как безопасно и эффективно реализовать сценарии с бесконечным циклом, см. в описании внешних оркестраций.

Использование для установки времени ожидания

В этом примере показано, как использовать устойчивые таймеры для реализации времени ожидания.

[FunctionName("TryGetQuote")]
public static async Task<bool> Run(
    [OrchestrationTrigger] IDurableOrchestrationContext context)
{
    TimeSpan timeout = TimeSpan.FromSeconds(30);
    DateTime deadline = context.CurrentUtcDateTime.Add(timeout);

    using (var cts = new CancellationTokenSource())
    {
        Task activityTask = context.CallActivityAsync("GetQuote");
        Task timeoutTask = context.CreateTimer(deadline, cts.Token);

        Task winner = await Task.WhenAny(activityTask, timeoutTask);
        if (winner == activityTask)
        {
            // success case
            cts.Cancel();
            return true;
        }
        else
        {
            // timeout case
            return false;
        }
    }
}

Примечание.

const df = require("durable-functions");
const { DateTime } = require("luxon");

module.exports = df.orchestrator(function*(context) {
    const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ seconds: 30 });

    const activityTask = context.df.callActivity("GetQuote");
    const timeoutTask = context.df.createTimer(deadline.toJSDate());

    const winner = yield context.df.Task.any([activityTask, timeoutTask]);
    if (winner === activityTask) {
        // success case
        timeoutTask.cancel();
        return true;
    }
    else
    {
        // timeout case
        return false;
    }
});

import azure.functions as func
import azure.durable_functions as df
from datetime import datetime, timedelta

def orchestrator_function(context: df.DurableOrchestrationContext):
    deadline = context.current_utc_datetime + timedelta(seconds=30)
    activity_task = context.call_activity("GetQuote")
    timeout_task = context.create_timer(deadline)

    winner = yield context.task_any([activity_task, timeout_task])
    if winner == activity_task:
        timeout_task.cancel()
        return True
    elif winner == timeout_task:
        return False

main = df.Orchestrator.create(orchestrator_function)

param($Context)

$expiryTime =  New-TimeSpan -Seconds 30

$activityTask = Invoke-DurableActivity -FunctionName 'GetQuote'-NoWait
$timerTask = Start-DurableTimer -Duration $expiryTime -NoWait

$winner = Wait-DurableTask -Task @($activityTask, $timerTask) -Any

if ($winner -eq $activityTask) {
    Stop-DurableTimerTask -Task $timerTask
    return $True
}
else {
    return $False
}

@FunctionName("TryGetQuote")
public boolean tryGetQuote(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    Task<Double> activityTask = ctx.callActivity("GetQuote", Double.class);
    Task<Void> timerTask = ctx.createTimer(Duration.ofSeconds(30));

    Task<?> winner = ctx.anyOf(activityTask, timerTask);
    if (winner == activityTask) {
        // success case
        return true;
    } else {
        // timeout case
        return false;
    }
}

Предупреждение

В .NET JavaScript, Python и PowerShell необходимо отменить созданные устойчивые таймеры, если программа не будет ожидать их завершения. В приведенных выше примерах показано, как отменить ожидающие таймеры. Платформа устойчивых задач не изменит статус оркестрации на "завершено", до тех пор, пока не будут завершены или отменены все незавершенные задачи, включая устойчивые задачи таймеров.

Этот механизм отмены на основе шаблона когда-любой не прерывает выполняющиеся действия по выполнению функций или подоркестрации. Вместо этого он просто позволяет функции оркестратора игнорировать результат и двигаться дальше. Если ваше приложение-функция использует план потребления, вам все равно будет выставлен счет за любое время и память, потребленные функцией брошенного действия. По умолчанию для функций, выполняемых в плане потребления, устанавливается время ожидания в пять минут. При превышении этого ограничения узел Функций Azure перезапускается для остановки выполнения всех процессов и предотвращения неконтролируемого выставления счетов. Время ожидания функции можно настроить.

Более подробный пример реализации тайм-аутов в функциях оркестратора см. в статье Взаимодействие с человеком и тайм-ауты — проверка по телефону.

Следующие шаги

Сведения о том, как вызывать и обрабатывать внешние события

Таймеры в устойчивых функциях (Функции Azure)

Ограничения таймера

Использование для задержки

Использование для установки времени ожидания

Следующие шаги

Дополнительные ресурсы