Руководство:Очередь задач

This page is a translated version of the page Manual:Job queue and the translation is 56% complete.

Outdated translations are marked like this.

В 2009 году (MediaWiki 1.6) была добавлена очередь задач для асинхронного выполнения долго выполняющихся задач. Очередь задач предназначена для хранения множества коротких задач с использованием пакетной обработки.

Настройка

Вместо этого рекомендуется полностью запланировать выполнение заданий в фоновом режиме через командную строку. По умолчанию задания запускаются в конце веб-запроса. Отключите это поведение по умолчанию, установив значение $wgJobRunRate как 0.

Вы должны запустить runJobs.php от имени того же пользователя, от имени которого работает веб-сервер, чтобы гарантировать, что разрешения для файловой системы правильно учитываются, если задания касаются загруженных файлов.

Cron

Вы можете использовать cron для запуска задач ежечасно. Добавьте следующее в файл crontab:

0 * * * * /usr/bin/php /var/www/wiki/maintenance/runJobs.php --maxtime=3600 > /var/log/runJobs.log 2>&1

Использование Cron упрощает начало работы, но может сделать уведомления по электронной почте и каскадный шаблон медленным (ждать до часа). Вместо этого рассмотрите возможность использования одного из следующих подходов, чтобы настроить средство выполнения непрерывных заданий.

Непрерывное обслуживание

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

Создайте сценарий bash, например, в /usr/local/bin/mwjobrunner:

Создание сценария

#!/bin/bash
# Поместите путь установки MediaWiki в строку ниже
MW_INSTALL_PATH="/home/www/www.mywikisite.example/mediawiki"
RUN_JOBS="$MW_INSTALL_PATH/maintenance/runJobs.php --maxtime=3600"
echo Запуск службы  задач...
# Подождать минуту после запуска сервера, чтобы дать время другим процессам начать работу.
sleep 60
echo Начато.
while true; do
	# Типы заданий, которые требуют запуска ASAP независимо от того, сколько из них в очереди
	# Эти работы должны быть очень «дешёвыми» в выполнении.
	php $RUN_JOBS --type="enotifNotify"
	# Ко всему прочему, ограничьте количество заданий на каждый пакет
	# Параметр --wait приостанавливает выполнение в этот момент до тех пор, пока не будут добавлены новые задания,
	# чтобы избежать запуска цикла без каких-либо действий
	php $RUN_JOBS --wait --maxjobs=20
	# Подождать несколько секунд, чтобы процессор мог выполнить другие задачи, например обработать веб-запросы и т.д.
	echo Подождите 10 секунд...
	sleep 10
done

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

Сделайте сценарий исполняемым (chmod 755).

Создание сервиса

При использовании systemd создайте новую служебную единицу, создав файл /etc/systemd/system/mw-jobqueue.service. Измените параметр User на пользователя, который запускает PHP на вашем веб-сервере:

[Unit]
Description=MediaWiki Job runner

[Service]
ExecStart=/usr/local/bin/mwjobrunner
Nice=10
ProtectSystem=full
User=php-fpm
OOMScoreAdjust=200
StandardOutput=journal

[Install]
WantedBy=multi-user.target

Включите его и запустите с помощью этих команд:

sudo systemctl enable mw-jobqueue
sudo systemctl start mw-jobqueue
sudo systemctl status mw-jobqueue

Выполнение задания по запросам страницы

По умолчанию, в конце каждого веб-запроса одно задание берётся из очереди заданий и выполняется. Это поведение контролируется при помощи конфигурируемой переменной $wgJobRunRate . Чтобы запускать задачу при каждом запросе, установите в этой переменной значение 1, Значение 0 в этой переменной полностью отключит выполнение задач при запросах. Вместо этого вы можете запускать runJobs.php вручную или периодически из командной строки.

Версия MediaWiki:

≥ 1.23

Когда включено, задача будет выполнена при помощи открытия сокета и выполнения внутреннего HTTP-запроса на скрытую служебную страницу: Special:RunJobs. Смотрите также асинхронный раздел.

Вопросы производительности

Если нагрузка на производительность при выполнении заданий по каждому веб-запросу слишком велика, но вы не можете запускать задания из командной строки, вы можете уменьшить $wgJobRunRate до числа между 1 до 0. Это означает, что задание будет выполняться "в среднем" каждые 1 / $wgJobRunRate запросов.

$wgJobRunRate = 0.01;

Ручное использование

Также, есть способ сделать пустую очередь задач вручную, например, после изменений в шаблоне, который присутствует на многих страницах. Просто запустите сценарий обслуживания maintenance/runJobs.php . Например:

/path-to-my-wiki/maintenance$ php ./runJobs.php

Abandoned jobs

A job can fail for some reasons. To understand why, you have to inspect the related log file.

In any case, if a job fails 3 times (so if the system has done that number of attempts), the job is then considered "abandoned" and it's not executed again.

Relevant source code:

https://doc.wikimedia.org/mediawiki-core/master/php/JobQueue_8php_source.html#l00085

An abandoned job is:

not executed anymore from runJobs.php
not counted from Manual:showJobs.php
not automatically removed from the database
but are included in the count of Special:Statistics

История

Асинхронность

Переменная конфигурации $wgRunJobsAsync была добавлена для принудительного синхонного выполнения заданий в сценариях, в которых выполнение внутреннего HTTP-запроса для выполнения задания не требуется.

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

Обратите внимание, что даже если для $wgRunJobsAsync установлено значение true, если PHP не может открыть сокет для выполнения внутреннего HTTP-запроса, он вернется к синхронному выполнению задания. Однако существует множество ситуаций, когда этот внутренний запрос может завершиться неудачно, и задания не будут выполняться без возврата к синхронному выполнению задания. Начиная с MediaWiki 1.28.1 и 1.27.2, $wgRunJobsAsync теперь по умолчанию имеет значение false.

Отложенные обновления

Механизм "отложенных обновлений" позволяет запланировать выполнение кода на конец запроса, после того как все содержимое будет отправлено в браузер. This is similar to queuing a job, except that it runs immediately instead of upto several minutes/hours in the future.

Механизм «отложенных обновлений» был представлен в MediaWiki 1.23 и претерпел значительные изменения в MediaWiki 1.27 и 1.28. Цель этого механизма - веб-ответы за счёт выполнения меньшего объёма работы, а также определить приоритетность некоторой работы, которая ранее была бы заданием для выполнения как можно скорее после окончания ответа.

A deferrable update can implement EnqueueableDataUpdate in order to be queueable as a Job as well. This is used by RefreshSecondaryDataUpdate in core, for example, which means if the update fails for any reason, MediaWiki will fallback to queuing as a job and try again later as to fulfil the contract in question.

Изменения в MediaWiki 1.22

In MediaWiki 1.22 , the job queue execution on each page request was changed (Gerrit change 59797) so, instead of executing the job inside the same PHP process that's rendering the page, a new PHP CLI command is spawned to execute runJobs.php in the background. It will only work if $wgPhpCli is set to an actual path or safe mode is off, otherwise, the old method will be used.

This new execution method could cause some problems:

If $wgPhpCli is set to an incompatible version of PHP (e.g.: an outdated version) jobs may fail to run (fixed in 1.23).

PHP open_basedir restrictions are in effect, and $wgPhpCli is disallowed (задача T62208, fixed in 1.23).

Performance: even if the job queue is empty, the new PHP process is started anyway (задача T62210, fixed in 1.23).

Sometimes the spawning PHP process cause the server or only the CLI process to hang due to stdout and stderr descriptors not properly redirected (задача T60719, fixed in 1.22)

It does not work for shared code (wiki farms), because it doesn't pass additional required parameters to runJobs.php to identify the wiki that's running the job (задача T62698, fixed in 1.23)

Normal shell limits like $wgMaxShellMemory , $wgMaxShellTime , $wgMaxShellFileSize are enforced on the runJobs.php process that's being executed in the background.

There's no way to revert to the old on-request job queue handling, besides setting $wgPhpCli to false, for example, which may cause other problems (задача T63387). It can be disabled completely by setting $wgJobRunRate = 0;, but jobs will no longer run on page requests, and you must explicitly run runJobs.php to periodically run pending jobs.

Изменения в MediaWiki 1.23

In MediaWiki 1.23, the 1.22 execution method is abandoned, and jobs are triggered by MediaWiki making an HTTP connection to itself.

It was first designed as an API entry point (Gerrit change 113038) but later changed to be the unlisted special page Special:RunJobs (Gerrit change 118336).

While it solves various bugs introduced in 1.22, it still requires loading a lot of PHP classes in memory on a new process to execute a job, and also makes a new HTTP request that the server must handle.

Изменения в MediaWiki 1.27

In MediaWiki 1.25 and MediaWiki 1.26, use of $wgRunJobsAsync would sometimes cause jobs not to get run if the wiki has custom $wgServerName configuration. This was fixed in MediaWiki 1.27.

задача T107290

Изменения в MediaWiki 1.28

Between MediaWiki 1.23 and MediaWiki 1.27, use of $wgRunJobsAsync would cause jobs not to get run on if MediaWiki requests are for a server name or protocol that does not match the currently configured server name one (e.g. when supporting both HTTP and HTTPS, or when MediaWiki is behind a reverse proxy that redirects to HTTPS). This was fixed in MediaWiki 1.28.

задача T68485

Изменения в MediaWiki 1.29

In MediaWiki 1.27.0 to 1.27.3 and 1.28.0 to 1.28.2, when $wgJobRunRate is set to a value greater than 0, an error like the one below may appear in error logs, or on the page:

PHP Notice: JobQueueGroup::__destruct: 1 buffered job(s) never inserted

As a result of this error, certain updates may fail in some cases, like category members not being updated on category pages, or recent changes displaying edits of deleted pages - even if you manually run runJobs.php to clear the job queue. It has been reported as a bug (задача T100085) and was solved in 1.27.4 and 1.28.3.

Примеры задач

Updating links tables when a template changes

When a template changes, MediaWiki adds a job to the job queue for each article transcluding that template. Each job is a command to read an article, expand any templates, and update the link table accordingly. Previously, the host articles would remain outdated until either their parser cache expires or until a user edits the article.

HTML cache invalidation

A wider class of operations can result in invalidation of the HTML cache for a large number of pages:

Changing an image (all the thumbnails have to be re-rendered, and their sizes recalculated)

Deleting a page (all the links to it from other pages need to change from blue to red)

Creating or undeleting a page (like above, but from red to blue)

Changing a template (all the pages that transclude the template need updating)

Except for template changes, these operations do not invalidate the links tables, but they do invalidate the HTML cache of all pages linking to that page, or using that image. Invalidating the cache of a page is a short operation; it only requires updating a single database field and sending a multicast packet to clear the caches. But if there are more than about 1000 to do, it takes a long time. By default, one job is added per 300 operations (see $wgUpdateRowsPerJob )

Note, however, that even if purging the cache of a page is a short operation, reparsing a complex page that is not in the cache may be expensive, especially if a highly used template is edited and causes lots of pages to be purged in a short period of time and your wiki has lots of concurrent visitors loading a wide spread of pages. This can be mitigated by reducing the number of pages purged in a short period of time, by reducing $wgUpdateRowsPerJob to a small number (20, for example) and also set $wgJobBackoffThrottling for htmlCacheUpdate to a low number (5, for example).

Перекодировка аудио и видео

When using TimedMediaHandler to process local uploads of audio and video files, the job queue is used to run the potentially very slow creation of derivative transcodes at various resolutions/formats.

These are not suitable for running on web requests -- you will need a background runner.

It's recommended to set up separate runners for the webVideoTranscode and webVideoTranscodePrioritized job types if possible. These two queues process different subsets of files -- the first for high resolution HD videos, and the second for lower-resolution videos and audio files which process more quickly.

Типичные значения

Во время низкой занятости очередь задач может быть нулевой. В Викимедиа, очередь задач в реальности всегда не равна нулю. Вне часов пик она может быть от нескольких сотен до тысячи. Во время занятых дней, она может быть несколько миллионов, но она может быстро колебаться до 10% или сильнее. ^[1]

Специальная:Статистика

Up to MediaWiki 1.16, the job queue value was shown on Special:Statistics. However, since 1.17 (rev:75272) it's been removed, and can be seen now with API:Siteinfo :

api.php?action=query&meta=siteinfo&siprop=statistics [попробуйте в ApiSandbox]

The number of jobs returned in the API result may be slightly inaccurate when using MySQL, which estimates the number of jobs in the database. This number can fluctuate based on the number of jobs that have recently been added or deleted. For other databases that do not support fast result-size estimation, the actual number of jobs is given.