Manual:ジョブ キュー

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Job queue and the translation is 57% complete.

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Tiếng Việt • ‎français • ‎italiano • ‎polski • ‎русский • ‎中文 • ‎日本語

MediaWiki 1.6 でジョブキューが導入され、長い処理を非同期的に実行できるようになりました。 このジョブキューは、バッチ処理を使用して短時間のタスクを多数保持するよう設計されています。

セットアップ

既定ではジョブは web リクエストの完了を待って実行されます。もし可能であればこの既定を無効にして($wgJobRunRate0に設定)、コマンドラインからジョブの実行を完全にバックグラウンドで行うようスケジュールしてください。 例えば、cron を使用して毎晩深夜にジョブが実行されるようにするには、crontab ファイルに以下を記載します:

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

Warning: Running jobs once a day like that could be very problematic for consistency and responsiveness -- you should instead run jobs as soon as possible after they are queued, using a wrapper script that waits for jobs to be queued and runs the appropriate job runners.

@FIXME: detail the actual wrappers Wikimedia uses in production to run jobs.

Note: you should run runJobs.php as the same user as the web server runs as, to ensure that permissions to the filesystem are correctly accounted for if jobs touch uploaded files.

Simple service to run jobs

If you have shell access and the possibility to create init scripts, you can create a simple service to run jobs as they become available, and also throttle them to prevent the job runner to monopolize the CPU resources of the server:

Create a bash script, for example at /usr/local/bin/mwjobrunner:

#!/bin/bash
# Put the MediaWiki installation path on the line below
IP=/home/www/www.mywikisite.com/mediawiki
RJ=$IP/maintenance/runJobs.php
echo Starting job service...
# Wait a minute after the server starts up to give other processes time to get started
sleep 60
echo Started.
while true; do
	# Job types that need to be run ASAP mo matter how many of them are in the queue
	# Those jobs should be very "cheap" to run
	php $RJ --type="enotifNotify"
	php $RJ --type="htmlCacheUpdate" --maxjobs=50
	# Everything else, limit the number of jobs on each batch
	# The --wait parameter will pause the execution here until new jobs are added,
	# to avoid running the loop without anything to do
	php $RJ --wait --maxjobs=10
	# Wait some seconds to let the CPU do other things, like handling web requests, etc
	echo Waiting for 10 seconds...
	sleep 10
done

Depending on how fast the server is and the load it handles, you can adapt the number of jobs to run on each cycle and the number of seconds to wait on each cycle.

Make the script executable (chmod 755).

If using systemd, create a new service unit by creating the file /etc/systemd/system/mw-jobqueue.service. Change the User parameter to the user that runs PHP on your web server:

[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

Enable it and start it with those commands:

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


ページ リクエストの際のジョブ実行

既定では web リクエストが完了するたび、ジョブキューから1件のジョブを取り込んで実行します。 この動作の制御は、$wgJobRunRate 構成変数で決まります。 変数を1に設定すると、リクエストごとにジョブを実行します。 同じく0に設定すると、 web リクエスト中はジョブの実行は完全に無効になり、その場であるいは定期的に手動で実行するには、runJobs.php を実行するか、コマンドラインから設定できます。

MediaWiki バージョン: 1.23

ジョブの実行が有効であればソケットを開き、Special:RunJobsというリストされていない特別ページに対して、内部HTTP要求を行います。 asynchronous の節も参照してください。

パフォーマンスの問題点

webリクエストのたびに毎回ジョブを走らせる負担が大きすぎるのに、コマンドラインからジョブを実行できない場合は、$wgJobRunRate の変数を 1 以下 0 以上に減らしてください。 これによりジョブは平均するとリクエスト1 / $wgJobRunRate 件ごとに実行されます。

$wgJobRunRate = 0.01;

手動で実行

別の方法として、たとえば多くのページで使われるテンプレートに変更を加えたときなどには、ジョブキューを手動で空にすることもできます。 maintenance/runJobs.php メンテナンス スクリプトを実行するだけです。 例:

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

履歴

非同期

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.

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 and $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.

ジョブの例

テンプレートの編集に合わせてリンクテーブルを更新

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 キャッシュの無効化

大量のページに相当する既存のHTMLキャッシュを一気に無効にしてしまう操作は、〔テンプレートの改訂だけでなく〕より幅広い種類にわたります:

  • 画像の改訂(すべてのサムネイルを作り直し、大きさも再計算する必要があります)
  • ページの削除(すべてのリンク元でのリンクの色を、青から赤にする必要があります)
  • ページの作成、または復帰〔被削除物の回復。undelete。復活とも〕(上記同様ですが、反対に赤から青にします)
  • テンプレートの改訂(テンプレートの参照読み込みされたページ〔のキャッシュ〕をすべて更新する必要があります)

テンプレートの改訂を除くこれらの操作の結果、リンクの表〔の内容〕が無効になることはありませんが、一方で、当該ページのリンク元の、あるいは当該画像の使用先の、すべてのページのHTMLキャッシュが無効になります。 1ページ分のキャッシュを無効にする処理はごく短く、必要なのはデータベースのフィールドを1件更新し、マルチキャストのパケットを1つ発してキャッシュを消すことだけです。 しかし約1000件以上もある場合には、かなり時間がかかります。既定では、300件の操作ごとに1件のジョブが追加されます ($wgUpdateRowsPerJob を参照)。

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.

典型的な値

低負荷の期間に、ジョブキューがゼロになる可能性はあります。 Wikimedia でのジョブキューがゼロになることは、実際にはほぼありません。 混雑していない時間帯では数百から千であるかもしれません。 混雑している日には数百万に達することもあるものの、10%以上の幅で頻繁に上下します。 [1]

特別ページ:統計

MediaWiki 1.16以前はジョブキューの長さを統計で表示していました。 ところが1.17 (rev:75272) 以降は取り除かれ、現在は API:Siteinfo で確認できます。

MySQLを使用すると、API結果に返されるジョブ件数は多少不正確になる可能性があります。MySQLは、データベース内のジョブの数を見積もります。 これは、最近追加したり削除したジョブの件数に基づいて変動する可能性があります。 For other databases that do not support fast result-size estimation, the actual number of jobs is given.

開発者向け

関連項目