Manual:$wgJobRunRate

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎français • ‎日本語 • ‎polski
Jobs: $wgJobRunRate
Number of jobs to perform per request.
Introduced in version: 1.6.0 (r13088)
Removed in version: still in use
Allowed values: number >= 0
Default value: 1
Other settings: Alphabetical | By function

Details[edit]

Number of jobs to perform per request. May be less than one in which case jobs are performed or not performed based on probability. If this is zero, jobs will not be done during ordinary apache requests. In this case, maintenance/runJobs.phpManual:runJobs.php should be run periodically.

Explanation[edit]

The job queue is designed to hold many short tasks. By default, each time a request runs, one job is taken from the job queue and executed. If the performance burden of this is too great, you can reduce $wgJobRunRate by putting something like this in your LocalSettings.phpManual:LocalSettings.php:

$wgJobRunRate = 0.01;

This will cause one item in the job queue to run on average every 100 page views. It is important to understand that this means that on every page view the probability of running a queued item is 1 in 100. This means that (in theory at least) you could still end up with one job being run every page impression, or (at the other end of the scale) no jobs being run at all. However, in practice, providing you have enough traffic to make a meaningful sample size, it should be about 1 per 100 requests.

In some versions of mediawiki, you can view the number of jobs at Special:Statistics. However, this number is a rough estimate, and thus misleading, so it was removed in 1.17.

In later versions, you can still view it using the api, using a request like:

The job queue is located in MediaWiki.phpManual:MediaWiki.php, function triggerJobs() (doJobs() before 1.23).

See also[edit]