Manual:Job queue/cs

V MediaWiki 1.6 byla zavedena fronta úloh (job queue), která provádí asynchronně dlouhodobé úkoly. Fronta úloh je navržena tak, aby pojala mnoho krátkých úloh pomocí dávkového zpracování.

Nastavení
Ve výchozím nastavení jsou úlohy spouštěny na konci webové žádosti. Pokud je to možné, doporučujeme vám toto výchozí chování zakázat nastavením na   a namísto toho naplánovat spuštění úloh zcela na pozadí pomocí příkazového řádku. Například můžete použít cron ke spuštění úloh každý den o půlnoci zadáním následujícího do souboru crontab:

Jednoduché spuštění úloh
Máte-li přístup k shellu a máte možnost vytvářet iniciační skripty, můžete vytvořit jednoduchou službu pro spouštění úloh, jakmile budou k dispozici a také je omezit, aby se zabránilo tomu, aby běh úlohy monopolizoval prostředky CPU serveru:

Vytvořte bash skript, například za :

V závislosti na rychlosti serveru a zatížení, které zpracovává, můžete upravit počet úloh, které se mají spustit v každém cyklu, a počet sekund, které se mají v každém cyklu čekat.

Vytvořte spustitelný skript.

Pokud používáte systemd, vytvořte novou servisní jednotku vytvořením souboru. Změňte parametr  na uživatele, který spouští PHP na vašem webovém serveru:

Povolte jej a spusťte jej pomocí těchto příkazů:

Provedení úlohy na žádostech o stránky
Ve výchozím nastavení je na konci každé webové žádosti odebrána z fronty úloh jedna úloha a provedena. Toto chování je řízeno konfigurační proměnnou. Pokud nastavíte tuto proměnnou na, spustí se úloha při každém požadavku. Nastavení této proměnné na  zakáže provádění úloh během webových požadavků úplně, takže můžete místo toho spustit  ručně nebo periodicky z příkazového řádku.

Pokud je to povolené, budou úlohy prováděny otevřením soketu a provedením interního požadavku HTTP na neuvedenou speciální stránku: Speciální: RunJobs. Viz také část asynchronous.

Problém s výkonem
Pokud je výkonnost při spouštění úloh na každém webovém požadavku příliš velká, ale z příkazového řádku nemůžete spustit úlohy, můžete jej snížit na číslo mezi   a. To znamená, že úloha provede průměrně každou  žádost.

Ruční nastavení
Existuje také způsob, jak frontu úloh vyprázdnit ručně, například po změně šablony, která se nachází na mnoha stránkách. Jednoduše spusťte servisní skript. Například:

Asynchronní spouštění
Byla přidána konfigurační proměnná, která vynucuje synchronní provádění úloh, ve scénářích, kde není požadováno provádění interního požadavku HTTP na provedení úlohy.

Při asynchronním spouštění úloh se otevře interní připojení HTTP pro zpracování provádění úloh a obsah stránky se okamžitě vrátí klientovi bez čekání na dokončení úlohy. Jinak bude úloha provedena ve stejném procesu a klient bude muset počkat, až bude úloha dokončena. Pokud se úloha nespustí asynchronně, dojde-li během provádění úlohy k závažné chybě, rozšíří se na klienta a přeruší načtení stránky.

Všimněte si, že i když je $wgRunJobsAsync nastaven na true, pokud PHP nemůže otevřít soket pro vytvoření interního požadavku HTTP, dojde k synchronnímu provádění úlohy. Existují však různé situace, kdy může dojít k selhání tohoto interního požadavku a úlohy nebudou spuštěny, aniž by došlo k návratu k synchronnímu provádění úlohy. Počínaje MediaWiki 1.28.1 a 1.27.2 je nyní $wgRunJobsAsync nastaveno na false.

Odložené aktualizace
Mechanismus „odložených aktualizací“ byl zaveden v MediaWiki 1.23 a během MediaWiki 1.27 a 1.28 došlo k zásadním změnám. Umožňuje provedení některých funkcí na konci požadavku, když byl veškerý obsah odeslán do prohlížeče, namísto toho, aby byl zařazen do úlohy, což by se jinak mohlo provést o několik hodin později. Cílem tohoto alternativního mechanismu je hlavně urychlit hlavní požadavky MediaWiki a zároveň provést některé funkce co nejdříve na konci žádosti.

Některé odložitelné aktualizace mohou být odložitelné aktualizace a úlohy, pokud jsou jako takové specifikovány.

Změny v MediaWiki 1.22
V bylo změněno provádění fronty úloh na každém požadavku na stránku, takže namísto provádění úlohy uvnitř stejného procesu PHP, který načítá stránku, je vytvořen nový příkaz cli PHP, aby se provedlo  na pozadí. Funguje to pouze v případě, že je nastavena na skutečnou cestu nebo je vypnutý bezpečný režim, jinak bude použita stará metoda.

Tato nová metoda spuštění může způsobit některé problémy:


 * Pokud je nastavena na nekompatibilní verzi PHP (např .: zastaralá verze), úlohy nemusí fungovat (opraveno v 1.23).
 * Pokud je nastavena na nekompatibilní verzi PHP (např.: zastaralá verze), úlohy nemusí fungovat (opraveno ve verzi 1.23).
 * Provedení: i když je fronta úloh prázdná, nový proces PHP je přesto spuštěn (, opraveno ve verzi 1.23).
 * Někdy způsobí proces třídění PHP zablokování serveru nebo pouze CLI procesu kvůli nesprávně přesměrovaným popisovačům stdout a stderr (, opraveno ve verzi 1.22)
 * Nefunguje pro sdílený kód (farmy wiki), protože nepředává další požadované parametry ke spuštění souboru runJobs.php k identifikaci wiki, která úlohu spouští (, opraveno ve verzi 1.23)
 * Normální limity prostředí jako, a  jsou vynucovány v procesu runJobs.php, který se provádí na pozadí.

Neexistuje způsob, jak se vrátit ke starému zpracování front úloh na vyžádání, kromě nastavení na , které může způsobit další problémy. Lze ji zcela zakázat nastavením, ale úlohy se již nebudou na žádostech o stránku spouštět. Chcete-li pravidelně spouštět čekající úlohy, musíte explicitně spustit runJobs.php.

Změny v MediaWiki 1.23
V MediaWiki 1.23 je metoda prováděná ve verzi 1.22 opuštěna a úlohy jsou spouštěny MediaWiki vytvářejícím HTTP připojení k sobě.

Nejprve byl navržen jako vstupní bod API, ale později se změnil na neveřejnou speciální stránku Special:RunJobs.

Přestože řeší různé chyby zavedené v 1.22, stále vyžaduje načtení mnoha tříd PHP do paměti pro nový proces k provedení úlohy a také vytvoří nový požadavek HTTP, který musí server zpracovat.

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

Changes in MediaWiki 1.28
Between MediaWiki 1.23 and MediaWiki 1.27, use of 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.

Changes in MediaWiki 1.29
In MediaWiki 1.27.0 to 1.27.3 and 1.28.0 to 1.28.2, when 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 to clear the job queue. It has been reported as a bug 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 )

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, specially 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 to a small number (20, for example) and also set  for   to a low number (5, for example).

Audio and video transcoding
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  and   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.

Typical values
During a period of low load, the job queue might be zero. At Wikimedia, the job queue is, in practice, almost never zero. In off-peak hours, it might be a few hundred to a thousand. During a busy day, it might be a few million, but it can quickly fluctuate by 10% or more.

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

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.