Manual:Job queue/de

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

Die Job queue („Warteschlange“) wurde in MediaWiki 1.6 eingeführt, um längerfristige Prozesse asynchron (zeitversetzt und besser verteilt) auszuführen. Sie wurde mit dem Ziel entwickelt, viele kleine Prozesse zu handhaben (Stapelverarbeitung).

Set up

Es empfiehlt sich, die Ausführung von Jobs komplett im Hintergrund über die Kommandozeile zu planen. Standardmäßig werden Jobs am Ende einer Webanforderung ausgeführt. Deaktivieren Sie dieses Standardverhalten, indem Sie $wgJobRunRate auf 0 setzen.

Die Funktion runJobs.php sollte unter dem gleichen Benutzer ausgeführt werden, unter dem auch der Webserver läuft, um die korrekte Einhaltung der erforderlichen Rechte für das Dateisystem zu garantieren, falls Jobs auf hochgeladene Dateien zugreifen.

Cron

Sie können cron verwenden, um die Jobs jede Stunde auszuführen. Fügen Sie Ihrer crontab-Datei Folgendes hinzu:

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

Die Verwendung von Cron macht den Einstieg einfach, kann aber dazu führen, dass E-Mail-Benachrichtigungen und kaskadierende Templates nur langsam reagieren (bis zu einer Stunde Wartezeit). Erwägen Sie deshalb einen der folgenden Ansätze, um einen kontinuierlichen Job-Runner einzurichten.

Dauereinsatz

Wenn Sie Shell-Zugriff und die Möglichkeit haben, Init-Skripte anzulegen, können Sie einen einfachen Dienst einrichten, der Jobs ausführt, sobald sie verfügbar sind, und sie außerdem ein wenig bremst, um zu verhindern, dass der Job-Runner die CPU-Ressourcen des Servers für sich in Anspruch nimmt:

Erstellen Sie ein Bash-Skript, zum Beispiel in /usr/local/bin/mwjobrunner:

#!/bin/bash
# Tragen Sie den MediaWiki-Installationspfad in die folgende Zeile ein
MW_INSTALL_PATH=/home/www/www.mywikisite.example/mediawiki
RUNJOBS=$MW_INSTALL_PATH/maintenance/runJobs.php
echo Job Service startet...
# Nach dem Hochfahren des Servers eine Minute warten, um anderen Prozessen Zeit zum Starten zu geben
sleep 60
echo Gestartet.
while true; do
	# Job-Typen, die schnellstmöglich ausgeführt werden müssen, egal wie viele in der Liste stehen
	# Diese Jobs sollten im Betrieb sehr "wenig" Leistung erfordern.
	php $RUNJOBS --type="enotifNotify"
	# Für alles andere begrenzen Sie die Anzahl der Jobs für jeden Batch.
	# Mit dem Parameter --wait wird die Ausführung hier angehalten, bis neue Aufträge hinzugefügt werden,
	# um zu vermeiden, dass die Programmschleife unnötig läuft.
	php $RUNJOBS --wait --maxjobs=20
	# Einige Sekunden warten, damit die CPU noch andere Aufgaben erledigen kann, z.B. die Bearbeitung von Web-Anfragen usw.
	echo 10 Sekunden warten...
	sleep 10
done

Je nachdem, wie leistungsfähig der Server ist und welche Auslastung vorliegt, können Sie die Anzahl der in jedem Zyklus auszuführenden Jobs und die Anzahl der Sekunden, die in jedem Zyklus gewartet werden, anpassen.

Das Script ausführbar machen (chmod 755).

Legen Sie bei Verwendung von systemd eine neue Service-Unit an, indem Sie die Datei /etc/systemd/system/mw-jobqueue.service erstellen. Den Parameter User so setzen, dass er dem Benutzer zugeordnet ist, der PHP auf Ihrem Webserver ausführt:

[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

Den Service mit diesen Befehlen aktivieren und starten:

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

Job-Erledigung bei Seitenaufrufen

Standardmäßig wird bei jedem Seitenaufruf ein Job aus der Job-Schlange genommen und ausgeführt. Die Anzahl der bearbeiteten Jobs kann mittels $wgJobRunRate konfiguriert werden. Das Setzen dieser Variable auf 1 führt zu einer Jobabarbeitung pro Seitenaufruf. 0 deaktiviert die Ausführung von Jobs bei Seitenaufrufen, dann sollte runJobs.php per Hand oder automatisiert periodisch ausgeführt werden.

MediaWiki Version:
1.23

Wenn aktiviert, wird zur Jobausführung ein Socket geöffnet und eine interne HTTP-Anfrage an special page: SpecialRunJobs.php geschickt. Siehe auch den Abschnitt asynchron.

Problem mit der Leistung

Wenn die Belastung durch die Ausführung von Jobs bei jeder Webanfrage zu groß ist, Sie aber keine Jobs über die Befehlszeile ausführen dürfen, können Sie $wgJobRunRate auf eine Zahl zwischen 1 und 0 reduzieren. Werte zwischen 1 und 0 sorgen dafür, dass „durchschnittlich“ alle 1 / $wgJobRunRate Seitenaufrufe ein Job erledigt wird.

$wgJobRunRate = 0.01;

Manuelle Bedienung

Es gibt auch eine Möglichkeit, die Job-Warteschlange manuell zu leeren, zum Beispiel nach dem Ändern eines Templates, das auf vielen Seiten vorhanden ist. Führen Sie einfach das Wartungsskript maintenance/runJobs.php aus. Zum Beispiel:

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

Geschichte

Asynchronous

The configuration variable $wgRunJobsAsync has been added to force the execution of jobs synchronously, in scenarios where making an internal HTTP request for job execution is not wanted.

When running jobs asynchronously, it will open an internal HTTP connection for handling the execution of jobs, and will return the contents of the page immediately to the client without waiting for the job to complete. Otherwise, the job will be executed in the same process and the client will have to wait until the job is completed. When the job does not run asynchronously, if a fatal error occurs during job execution, it will propagate to the client, aborting the load of the page.

Note that even if $wgRunJobsAsync is set to true, if PHP can't open a socket to make the internal HTTP request, it will fallback to the synchronous job execution. However, there are a variety of situations where this internal request may fail, and jobs won't be run, without falling back to the synchronous job execution. Starting with MediaWiki 1.28.1 and 1.27.2, $wgRunJobsAsync now defaults to false.

Deferred updates

The deferred updates mechanism was introduced in MediaWiki 1.23 and received major changes during MediaWiki 1.27 and 1.28. It allows the execution of some features at the end of the request, when all the content has been sent to the browser, instead of queuing it in the job, which would otherwise be executed potentially some hours later. The goal of this alternate mechanism is mainly to speed up the main MediaWiki requests, and at the same time execute some features as soon as possible at the end of the request.

Some deferrable updates can be both deferrable updates and jobs, if specified as such.

Changes in 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).
  • Performance: even if the job queue is empty, the new PHP process is started anyway (task 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 (task 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 (task T62698, fixed in 1.23)

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 (task 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.

Änderungen in 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.

Changes in 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.

task T107290

Changes in 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.

task T68485

Changes in 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 (task T100085) and was solved in 1.27.4 and 1.28.3.

Job examples

Aktualisierung der Linktabellen nach Vorlagenänderungen

Wird im Wiki eine Vorlage bearbeitet, fügt MediaWiki für jede Seite, die diese Vorlage verwendet, einen Job der Job queue hinzu. Jeder Job ist dabei der Befehl, die entsprechende Seite aufzurufen, die Vorlage neu zu expandieren und die Linktabelle entsprechend zu aktualisieren. Previously, the host articles would remain outdated until either their parser cache expires or until a user edits the article.

Außerkraftsetzen des HTML-Caches

Weitere Vorgänge können darüberhinaus für eine große Seitenanzahl zum Ungültigwerden des jeweiligen HTML-Caches führen:

  • Änderung eines Bildes (alle Vorschaubilder, die „Thumbnails“, müssen neu gerendert und ihre Größen neu berechnet werden)
  • Löschung einer Seite (alle Links auf anderen Seiten müssen von blau nach rot geändert werden)
  • Neuanlage oder Wiederherstellung einer Seite (wie vorstehend, aber von rot nach blau)
  • Änderung einer Vorlage (alle Seiten, die die Vorlage einbinden, müssen aktualisiert werden)

Abgesehen von Vorlagenänderungen betreffen diese Aktionen zwar nicht die Linktabellen, sie machen jedoch den HTML-Cache aller Seiten, auf denen die fragliche Seite verlinkt oder in denen ein Bild eingebunden ist, ungültig. Die Außerkraftsetzung des Caches einer Seite ist ein kurzer Vorgang; dazu wird nur die Aktualisierung eines einzigen Datenbankfelds und das Senden eines Multicast-Datenpakets zur Cacheleerung benötigt. Es dauert allerdings länger, wenn mehr als 1000 Aktualisierungen vorzunehmen sind. Standardmäßig werden Jobs hinzugefügt, wenn mehr als 500 Seiten betroffen sind; ein Job pro 500 Vorgänge.

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 $wgUpdateRowsPerJob to a small number (20, for example) and also set $wgJobBackoffThrottling for htmlCacheUpdate 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 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.

Typische Werte

In Zeiten geringer Serverlast kann die Job queue leer sein und den Wert Null haben. In der Praxis ist die Job queue – zumindest in den großen Wikimediaprojekten wie zum Beispiel der deutschsprachigen Wikipedia – fast nie leer. Außerhalb der Tagesspitzenzeiten kann sie einige hundert bis tausende anstehende Jobs umfassen, in Spitzenzeiten auch mehrere Millionen. Der Zahlenwert kann sehr kurzfristig um 10 Prozent oder mehr schwanken. [1]

Special:Statistics

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:Seiteninfo :



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.

Für Entwickler

Code-Verwaltung

Siehe auch