Manual:Job queue

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.

Set up
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:

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  configuration variable.

Setting this variable to, will run a job on each request.

Setting this variable to a number between  and   will execute a job on average every   requests.

Setting this variable to 0 will disable the execution of jobs during page requests completely, but you should run  manually or periodically.

When enabled, jobs will be executed by opening a socket and making an internal HTTP request to an unlisted man>Special:MyLanguage/Manual:Special pages|special page: SpecialRunJobs.php.

See the asynchronous section.

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 this may appear in error logs, or on the page:

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

Some special pages may fail to be updated in some cases, like categories not updating in 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. The best solution is to set   to 0 and add runJobs.php</> to a cron job to be executed periodically.

Performance issue
If the performance burden of this is too great, you can reduce <tvar|JobRunRate></> by putting something like this in your LocalSettings.php:

Manual usage
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 <tvar|RunJobs><tt></tt></> maintenance script.

For example:

Asynchronous
The configuration variable <tvar|RunJobsAsync></> 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.

There are some configurations that can cause the asynchronous job execution to fail:

Run jobs async does not honor $wgServerName. runJobs not following redirect.

The <tvar|DeferredUpdates> </> mechanism was introduced in MediaWiki 1.23 and received major changes during MediaWiki 1.27 and 1.28. It allows an execution of some features at the end of the request instead of executing the said feature in some job, which would be executed possibly some hours later. The goal of this alternate mechanism is mainly to speed up the main MediaWiki requests but at the same time execute some features quickly after the end of the request.

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

Changes introduced in MediaWiki 1.22
In <tvar|mw></>, the job queue execution on each page request was changed (<tvar|gerrit></>) 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 <tvar|runJobs></> in the background.

It will only work if <tvar|PhpCli></> 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 <tvar|PhpCli></> is set to an incompatible version of PHP (e.g.: an outdated version) jobs may fail to run (fixed in 1.23).


 * PHP  restrictions are in effect, and <tvar|PhpCli></> is disallowed (<tvar|task></>, fixed in 1.23).


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


 * Normal shell limits like <tvar|MaxShellMemory></>, <tvar|MaxShellTime></> and <tvar|MaxShellFileSize></> 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 <tvar|PhpCli></> to, for example, which may cause other problems (<tvar|task></>).

It can be disabled completely by setting <tvar|code> </>, 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.

It was first designed as an man>Special:MyLanguage/Manual:API</>|API entry point (<tvar|gerrit1></>) but later changed to be the unlisted special page Special:RunJobs (<tvar|gerrit2></>).

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.

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.

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 <tvar|1></>)

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 (<tvar|rev>75272</>) it's been removed, and can be seen now with <tvar|api></>:

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.