Перейти к содержимому
M
Все статьи
Технологии 8 мин чтения

Задачи по расписанию в Moodle: scheduled и adhoc tasks, cron и отладка зависаний

Как написать scheduled и adhoc task в плагине Moodle, настроить cron и найти причину, когда задачи не запускаются, зависают или падают по кругу.

Как написать scheduled и adhoc task в плагине Moodle, настроить cron и найти причину, когда задачи не запускаются, зависают или падают по кругу.

Любая работа плагина, которую нельзя делать в запросе пользователя, живёт в задачах: рассылка отчёта, синхронизация с внешней системой, пересчёт статусов. В Moodle для этого есть Task API, а двигателем служит cron. Ниже — как написать обе разновидности задач, на что опереться при зависаниях и какие ошибки встречались мне на практике чаще всего.

Две разновидности задач

Scheduled taskAdhoc task
Когда создаётсяПри установке плагина, из db/tasks.phpВ коде, когда понадобилась фоновая работа
Сколько экземпляровОдин на классСколько поставили в очередь
РасписаниеМинуты, часы, дни, месяцы, дни неделиВыполняется при ближайшем запуске cron
ДанныеНет, берёт всё из базыХранит custom data (JSON) и пользователя
После выполненияОстаётся и ждёт следующего срокаУдаляется из очереди
Для чегоРегулярная уборка, выгрузки, пересчётыТяжёлая реакция на событие, массовая операция

Классы задач лежат в classes/task/. Подробности — в документации Task API.

Плановая задача пошагово

Класс наследуется от \core\task\scheduled_task и реализует два метода:

namespace local_example\task;

defined('MOODLE_INTERNAL') || die();

class sync extends \core\task\scheduled_task {
    public function get_name() {
        return get_string('tasksync', 'local_example');
    }

    public function execute() {
        mtrace('local_example: sync started');
        // Работа задачи. Исключение пометит запуск как неудачный.
    }
}

Расписание указывается в db/tasks.php:

defined('MOODLE_INTERNAL') || die();

$tasks = [
    [
        'classname' => 'local_example\task\sync',
        'blocking'  => 0,
        'minute'    => '*/15',
        'hour'      => '*',
        'day'       => '*',
        'month'     => '*',
        'dayofweek' => '*',
    ],
];

Поля расписания устроены как в классическом crontab. После установки администратор может изменить время на странице плановых задач, и его правка важнее значения из файла. Меняя расписание в tasks.php, помните: у уже установленных сайтов значение, которое менял администратор, не перезаписывается.

Вывод mtrace() попадает в консоль cron и в лог задачи, его удобно использовать для отметок о ходе работы.

Adhoc-задача: тяжёлая работа вне запроса

Типичный сценарий: пользователь нажал «Сформировать отчёт», обработчик не строит отчёт сам, а ставит задачу и сразу отвечает. Класс наследуется от \core\task\adhoc_task:

namespace local_example\task;

defined('MOODLE_INTERNAL') || die();

class build_report extends \core\task\adhoc_task {
    public function execute() {
        $data = $this->get_custom_data();
        $userid = $data->userid;
        // Построить отчёт и уведомить пользователя.
    }
}

Постановка в очередь:

$task = new \local_example\task\build_report();
$task->set_custom_data(['userid' => $USER->id]);
$task->set_component('local_example');
\core\task\manager::queue_adhoc_task($task);

Второй параметр queue_adhoc_task() включает проверку на дубли: если такая же задача с теми же данными уже ждёт, новая не создаётся. Это спасает, когда пользователь нетерпеливо жмёт кнопку несколько раз. Если постановка происходит в транзакции базы данных, задача попадёт в очередь только после её фиксации, так что обработчик не увидит «призрачных» данных.

Данные в custom data передавайте минимальные: идентификаторы, а не готовые массивы. К моменту выполнения записи могут измениться, и надёжнее перечитать их из базы.

Как работает cron

На сервере cron запускает admin/cli/cron.php, как правило, каждую минуту, от пользователя веб-сервера. Скрипт берёт плановые задачи, срок которых подошёл, и задачи из adhoc-очереди, блокирует их, чтобы не взяли параллельные процессы, и выполняет. Параллельность задаётся настройками «Сервер → Задачи → Управление процессами»: можно ограничить число одновременных плановых и adhoc-задач, а также максимальное время работы. Поэтому тяжёлую работу разумно дробить: мелкие задачи ставятся и выполняются независимо, а одна огромная блокирует канал на полчаса.

* * * * * www-data /usr/bin/php /var/www/moodle/admin/cli/cron.php >/dev/null 2>&1

Путь и пользователя подставьте свои. Вывод cron лучше не выбрасывать совсем, а писать в файл: он пригодится, когда понадобится понять, что произошло ночью.

Cron не работает: порядок диагностики

СимптомВероятная причинаКак проверить и исправить
Предупреждение «cron не запускался»Запись в crontab отсутствует или неверный пользовательВыполнить команду вручную от пользователя веб-сервера, посмотреть вывод
Задача «Выполняется» много часовПроцесс завис или был убит, а блокировка осталасьПроверить процессы php; после устранения причины снять блокировку, дождавшись таймаута, либо перезапустить задачу
Задача падает с задержкой, растущей от запуска к запускуИсключение в execute() каждый разПрочитать текст в логе задач, исправить; задержка сбросится при успехе
Скрипт cron падает по памятиВыборка всех записей в массивЧитать порциями или итератором, дробить задачу
Задача не видна в спискеНе поднята версия после правки db/tasks.php или неверное имя классаПоднять версию, пройти обновление, сверить пространство имён
Adhoc-очередь растётЗадач ставится больше, чем cron успевает выполнятьУвеличить допустимое число процессов или сократить объём задач

Для ручной проверки у Moodle есть CLI-скрипты в admin/cli: scheduled_task.php умеет показать список (--list) и выполнить одну задачу (--execute), adhoc_task.php делает то же для очереди. Запускайте их от того же пользователя, что и cron, иначе файлы в moodledata получат неверные права и дальше начнутся странности уже у веб-сервера.

Журнал выполнения доступен в «Сервер → Задачи → Журналы задач»: там видно время начала и конца, результат и текст ошибки. Для зависших задач это первое, куда стоит смотреть.

Типичные ошибки в коде задач

  • Глобальное состояние. Задача выполняется в CLI, а не в запросе пользователя: нет сессии и $USER по умолчанию пуст. Нужного пользователя передайте в данных и загрузите явно.
  • Нет идемпотентности. Задача может выполниться повторно после сбоя. Если письмо уходит дважды или запись создаётся дубликатом, ищите ошибку в проверках, а не в cron.
  • Исключения без контекста. Бросайте исключение с понятным сообщением и данными, по которым найдёте проблемную запись, и не глотайте ошибки молча.
  • Долгие запросы к внешнему API без таймаута. Один зависший ответ блокирует поток cron. Ставьте таймауты и делайте повтор через новую задачу.

Администрирование очереди

Все плановые задачи сайта видны в «Сервер → Задачи → Плановые задачи»: имя, компонент, расписание, время последнего и следующего запуска, признак сбоя. Оттуда же задачу можно отключить или запустить вручную, если на сайте разрешён запуск из интерфейса. Очередь adhoc-задач показана в соседнем разделе: там видно класс, число попыток и время следующего запуска. Если очередь растёт, а одинаковых задач сотни, значит, постановщик ставит их без проверки дублей.

Если после ошибки задача перешла в состояние ожидания, Moodle откладывает следующую попытку на всё более долгий срок. Удобно, потому что падающая задача не забивает cron. Неудобно, когда причина устранена, а задача всё ещё «в отпуске»: её нужно запустить вручную или сбросить задержку в интерфейсе. Этот момент стоит помнить на следующий день после исправления бага: «починила, а письма не идут» нередко означает ожидание очередной попытки.

Несколько серверов и блокировки

Блокировки, по которым процессы не берут одну и ту же задачу, хранятся там, где настроена фабрика блокировок. На одиночном сервере хватает варианта по умолчанию. Если cron запускается на нескольких серверах, блокировки должны быть общими (через базу или общее хранилище), иначе задача выполнится дважды. Дополнительно проверьте, что у CLI-версии PHP собственные настройки: у командной строки отдельный php.ini, и лимит памяти или список расширений может отличаться от веб-версии. Классическая история: задача отрабатывает из интерфейса и падает из cron, потому что в CLI нет нужного расширения.

Для контроля свежести в разделе проверок состояния есть проверка cron, а на уровне сервера полезен внешний мониторинг: простой скрипт, который сообщает, если в журнале задач давно нет записей. Подробнее о том, как такой контроль устроен у меня, — в статье про мониторинг доступности.

Что где смотреть: команды и страницы

ЗадачаГде сделать
Список плановых задач и их состояние«Сервер → Задачи → Плановые задачи» или php admin/cli/scheduled_task.php --list
Запустить одну плановую задачуТот же скрипт с ключом --execute и именем класса
Посмотреть очередь adhoc«Сервер → Задачи → Задачи ad hoc»
Выполнить очередь вручнуюphp admin/cli/adhoc_task.php --execute
Разобрать результат запуска«Сервер → Задачи → Журналы задач»
Ограничить параллельность и время«Сервер → Задачи → Управление процессами»

Как я выбираю тип задачи

Для плагина автоотчисления по окончании обучения логика плановая по природе: раз в сутки собрать тех, у кого срок вышел, и обработать. Но сама обработка каждого слушателя нередко тяжёлая и затрагивает чужие таблицы. Надёжная схема выглядит так: плановая задача только находит кандидатов и ставит по одной adhoc-задаче на каждого, а adhoc-задача выполняет действие. Тогда сбой на одном человеке не останавливает остальных, а повторный запуск обрабатывает только упавших. Так же строится любая массовая операция в СДО: поиск отдельно, действие отдельно, у каждого действия своя запись об успехе или ошибке.

Что дальше

Хорошая схема для плагина: событие или действие пользователя ставит adhoc-задачу, плановая задача раз в сутки подбирает хвосты. Так реакция быстрая, а ночная проверка исправляет сбои. О связке с событиями я писала в статье про Events API и наблюдателей.

Если cron на вашей СДО регулярно «ломается» после переезда или обновления, это входит в техподдержку Moodle: настройка запуска, проверка прав на moodledata, мониторинг очереди задач.

Нужна помощь с Moodle?

Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.