Управление задачами

Содержание раздела
  1. Настройка выполнения задач
  2. Создание задачи
  3. Изменение параметров задачи
  4. Деактивация и активация задачи
  5. Отключение выполнения всех задач
  6. Удаление задачи
  7. Просмотр задач и журналов их запусков
  8. Очистка журналов запусков задач

Настройка выполнения задач

По умолчанию выполнение задач включено в конфигурации (SCHEDULER_ENABLED = true) для всего окружения и не требует дополнительной настройки.

Чтобы изменить настройки планировщика, скорректируйте их в секции scheduler конфигурации каждой ноды и перезапустите ноды по одной.

Создание задачи

Чтобы создать задачу:

  1. Выполните запрос через POST /scheduler/jobs.
  2. Если задача создавалась активной и вернулся успешный ответ:
    1. Запросите информацию о ней и проверьте значения полей nextRunDateTime и lastRunStatus.
    2. Если значение nextRunDateTime равно null или lastRunStatus равно failed*, удалите задачу и пересоздайте ее с корректными параметрами. Причины проблем с расписанием не указываются, но причины остальных проблем можно найти в полях lastRunCommandResult и log/commandResult.

* Значение lastRunStatus равное null означает, что задача еще не запускалась и корректность ее параметров необходимо отследить таким же образом, но позже — после ее первого запуска по расписанию.

Изменение параметров задачи

Изменение параметров задачи, кроме признака ее активности, недоступно.

Чтобы изменить имя, расписание, список запросов или исполнителя задачи:

  1. Удалите задачу.
  2. Создайте задачу заново с новыми параметрами.

Деактивация и активация задачи

При создании задачи можно указать, в каком состоянии она создается: активном или неактивном.

Деактивацией и активацией уже созданных задач управляет метод POST /scheduler/jobs/{job}:

  • чтобы деактивировать задачу и тем самым прекратить ее выполнение, выполните запрос с параметром active, равным false;
  • чтобы активировать задачу и тем самым возобновить ее выполнение, выполните запрос с параметром active, равным true.

Деактивация не прерывает выполнение задачи: она становится неактивной после завершения текущего выполнения.

Отключение выполнения всех задач

Чтобы остановить выполнение всех задач окружения, в конфигурации каждой ноды установите параметр SCHEDULER_ENABLED равным false или параметр SCHEDULER_CHECK_PERIOD_MS — равным 0 и перезапустите ноды по одной.

Удаление задачи

Чтобы удалить задачу вместе с ее журналом запусков, выполните запрос через DELETE /scheduler/jobs/{job}.

Задача удаляется безвозвратно. Чтобы отключить будущие запуски задачи без ее удаления, деактивируйте ее.

Просмотр задач и журналов их запусков

Чтобы получить информацию о задачах, выполните запрос через GET /scheduler/jobs:

  • с параметром withLog — чтобы также получить информацию из журналов запусков;
  • без параметра withLog — иначе.

Записи журнала запусков задачи возвращаются в массиве log, сведения о текущем запуске — в полях lastRun*.

Очистка журналов запусков задач

По умолчанию журналы запусков автоматически очищаются раз в 12 часов до последних 100 записей в каждом журнале.

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

  • SCHEDULER_LOG_TRUNCATE_PERIOD_MS — частота проверки журналов,
  • SCHEDULER_LOG_MAX_SIZE — количество оставляемых последних записей в журналах.

Чтобы вручную очистить журналы, выполните запрос через DELETE /scheduler/log.

Автоматическая очистка всегда сохраняет запись о последнем завершенном запуске каждой задачи. Полностью очистить журнал можно только вручную.