In MediaWiki 1.6, a job queue was introduced to perform long-running tasks asynchronously. The job queue is designed to hold many short tasks using batch processing.
- 1 Set up
- 2 Job execution on page requests
- 3 History
- 4 Job examples
- 5 Typical values
- 6 Special:Statistics
- 7 For developers
- 8 See also
Whenever possible, you must set $wgJobRunRate to 0, and then use some sort of scheduler to run jobs completely in the background. For instance, if you were to use cron to run the jobs every day at midnight you would enter in your crontab file:
0 0 * * * /usr/bin/php /var/www/wiki/maintenance/runJobs.php > /var/log/runJobs.log 2>&1
Job execution on page requests
By default, each time a page request runs, one job is taken from the job queue and executed. This behavior is controlled by the $wgJobRunRate configuration variable. Setting this variable to
1, will run a job on each request. Setting this variable to a number between
0 will execute a job on average every
1 / $wgJobRunRate requests. Setting this variable to 0 will disable the execution of jobs during page requests completely, but you should run runJobs.php manually or periodically.
If the performance burden of this is too great, you can reduce $wgJobRunRate by putting something like this in your LocalSettings.php:
$wgJobRunRate = 0.01;
There is also a way to empty the job queue manually, for example after changing a template that's present on many pages. Simply run the maintenance/runJobs.php maintenance script. For example:
/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. There are some configurations that can cause the asynchronous job execution to fail:
- task T107290 Run jobs async does not honor $wgServerName.
- task T68485 runJobs not following redirect.
Changes introduced 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).
open_basedirrestrictions are in effect, and $wgPhpCli is disallowed (task T62208, 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)
- 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 (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.
Changes introduced 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.
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.
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. So null edits are no longer necessary, although it may take a while for big operations to complete. This can help to ease strain on a virtual person.
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 500 operations (see $wgUpdateRowsPerJob)
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.
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.