手册:作业队列

From mediawiki.org
This page is a translated version of the page Manual:Job queue and the translation is 93% complete.

在MediaWiki 1.6中,引入了作业队列以异步执行长时间运行的任务。 作业队列被设计为使用批处理来保存许多短任务。

设置

建议您通过命令行完全在后台调度作业的运行。 默认情况下,作业在web请求结束时运行。通过将$wgJobRunRate 设置为0来禁用此默认行为。

您应该以与web服务器相同的用户运行runJobs.php,以确保在作业触及上载文件时正确考虑对文件系统的权限。

Cron

您可以使用Cron每小时运行一次作业。将以下内容添加到crontab文件中:

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

使用Cron可以很容易地开始,但会使电子邮件通知和级联模板感觉很慢(最多等待一个小时)。考虑使用以下方法之一来建立一个连续的作业运行器。

持续服务

如果您有shell访问权限,并且可以创建init脚本,那么您可以创建一个简单的服务,在作业可用时运行它们,并限制它们,以防止作业运行者独占服务器的CPU资源:

创建一个bash脚本,例如/usr/local/bin/mwjobrunner

#!/bin/bash
# 将MediaWiki安装路径放在下面的行中
MW_INSTALL_PATH=/home/www/www.mywikisite.example/mediawiki
RUNJOBS=$MW_INSTALL_PATH/maintenance/runJobs.php
echo 正在启动作业服务……
# 在服务器启动后等待一分钟,以便其他进程有时间启动
sleep 60
echo 开始运行。
while true; do
	# 无论队列中有多少作业类型都需要尽快运行
	# 这些工作应该非常“简易”
	php $RUNJOBS --type="enotifNotify"
	# 除此之外,限制每批作业的数量
	# --wait参数将在此处暂停执行,直到添加新作业,
	# 避免在没有任何事情可做的情况下运行循环
	php $RUNJOBS --wait --maxjobs=20
	# 等待几秒钟,让CPU做其他事情,例如处理网络请求等
	echo 等待10秒……
	sleep 10
done

根据服务器的速度和处理的负载,您可以调整每个周期运行的作业数和每个周期等待的秒数。

使脚本可执行(chmod 755)。

如果使用systemd,请通过创建文件/etc/systemd/system/mw-jobqueue.service来创建新的服务单元。 将User参数更改为在web服务器上运行PHP的用户:

[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

启用它并使用以下命令启动它:

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

页面请求的作业执行

默认情况下,在每个web请求结束时,从作业队列中取出一个作业并执行。 此行为由$wgJobRunRate 配置变量控制。 将此变量设置为1,将对每个请求运行一个作业。 将此变量设置为0将完全禁止在web请求期间执行作业,因此您可以从命令行手动或定期运行runJobs.php

MediaWiki版本:
1.23

启用后,将通过打开套接字并向未列出的特殊页面:Special:RunJobs发出内部HTTP请求来执行作业。 参见#Asynchronous章节。

性能问题

如果在每个web请求上运行作业的性能负担太大,但无法从命令行运行作业,则可以将$wgJobRunRate 降至10之间。 这意味着作业将平均1 / $wgJobRunRate请求执行一次。

$wgJobRunRate = 0.01;

手动使用

还有一种方法可以手动清空作业队列,例如,在更改许多页面上的模板后。 简单地运行maintenance/runJobs.php 维护脚本。 例如:

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

历史

异步

已添加配置变量$wgRunJobsAsync ,以在不需要对作业执行发出内部HTTP请求的情况下强制同步执行作业。

当异步运行作业时,它将打开一个用于处理作业执行的内部HTTP连接,并将立即将页面内容返回给客户端,而无需等待作业完成。 否则,作业将在同一进程中执行,客户端必须等待作业完成。 当作业未异步运行时,如果在作业执行过程中发生致命错误,它将传播到客户端,从而中止页面加载。

注意,即使$wgRunJobsAsync设置为true,如果PHP无法打开套接字来发出内部HTTP请求,它也会返回到同步作业执行。 但是,在各种情况下,此内部请求可能会失败,作业不会运行,而不会返回到同步作业执行。 从MediaWiki 1.28.1和1.27.2开始,$wgRunJobsAsync现在默认为false。

滞后更新

滞后更新机制允许在将所有内容发送到浏览器后,在请求结束时安排代码的执行。 This is similar to queuing a job, except that it runs immediately instead of upto several minutes/hours in the future.

DeferredUpdates在MediaWiki 1.23中引入,并在MediaWiki 1.27和1.28期间进行了重大更改。 该机制的目标是通过减少工作量来加快网络响应速度,并在响应结束后尽快优先处理一些以前属于作业的工作。

A deferrable update can implement EnqueueableDataUpdate in order to be queueable as a Job as well. This is used by RefreshSecondaryDataUpdate in core, for example, which means if the update fails for any reason, MediaWiki will fallback to queuing as a job and try again later as to fulfil the contract in question.

MediaWiki 1.22的改变

MediaWiki 1.22 中,每个页面请求上的作业队列执行都发生了更改(Gerrit change 59797),因此,不再在渲染页面的同一个PHP进程中执行作业,而是生成了一个新的PHPcli命令来在后台执行runJobs.php 。 只有当$wgPhpCli 设置为实际路径或安全模式关闭时,它才会工作,否则将使用旧方法。

这个新的执行方法可能导致一些问题:

  • 如果$wgPhpCli 设置为PHP的不兼容版本(例如:过时版本),则作业可能无法运行(1.23中已修复)。
  • PHP open_basedir限制生效,$wgPhpCli 被禁止(任务T62208,在1.23中修复)。
  • 性能:即使作业队列为空,也会启动新的PHP进程(任务T62210,在1.23中修复)。
  • 有时,由于stdout和stderr描述符未正确重定向,生成的PHP进程会导致服务器或仅CLI进程挂起(任务T60719,已在1.22中修复)。
  • 它不适用于共享代码(wiki农场),因为它不会向runJobs.php传递额外的必需参数来标识运行作业的wiki(任务T62698,在1.23中修复)。
  • 普通shell限制(如$wgMaxShellMemory $wgMaxShellTime 和$MaxShellfFileSize)在后台执行的runJobs.php进程上强制执行。

例如,除了将$wgPhpCli 设置为false之外,无法恢复到旧的请求作业队列处理,这可能会导致其他问题(任务T63387)。 它可以通过设置$wgJobRunRate = 0;完全禁用,但作业将不再在页面请求上运行,您必须显式运行runJobs.php定期运行挂起的作业。

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.


作业示例

当模版改变时更新链接表

当模板发生更改时,MediaWiki会将一个作业添加到包含该模板的每篇文章的作业队列中。 每个作业都是读取文章、展开任何模板并相应更新链接表的命令。 在此之前,主文章将保持过时,直到其解析器缓存过期或用户编辑文章。

HTML 缓存清空

更广泛的操作类别可能会导致大量页面的HTML缓存无效:

  • 更改图像(必须重新渲染所有缩略图,并重新计算其大小)
  • 删除页面(其他页面的所有链接都需要从蓝色变为红色)
  • 创建或取消删除页面(如上所述,但从红色到蓝色)
  • 更改模板(包含模板的所有页面都需要更新)

除了模板更改之外,这些操作不会使链接表失效,但会使链接到该页面或使用该图像的所有页面的HTML缓存失效。 使页面的缓存无效是一个短操作;它只需要更新单个数据库字段并发送多播数据包来清除缓存。 但如果要做的事情超过1000件,则需要很长时间。默认情况下,每300个操作添加一个作业(请参见$wgUpdateRowsPerJob )。

然而,请注意,即使清除页面的缓存是一项很短的操作,重新分析不在缓存中的复杂页面可能会很昂贵,特别是如果编辑了一个使用率很高的模板,并导致在短时间内清除大量页面,并且您的wiki有大量并发访问者加载大量页面。 这可以通过减少在短时间内清除的页面数量、将$wgUpdateRowsPerJob 减少到一个小数字(例如20)以及将htmlCacheUpdate$wgJobBackoffThrottling 设置为一个低数字(例如5)来缓解。


音视频转码

当使用扩展:TimedMediaHandler 处理音频和视频文件的本地上传时,作业队列用于以各种分辨率/格式运行可能非常缓慢的派生代码转换创建。

这些工作不适合在web请求上运行——您需要后台运行程序。

如果可能,建议为webVideoTranscodewebVideoTranscodePrioritized的工作类型设置单独的运行器。这两个队列处理不同的文件子集——第一个用于高分辨率高清视频,第二个用于处理速度更快的低分辨率视频和音频文件。

典型值

当负荷低时,作业队列可能为零。 在维基媒体,作业队列实际上几乎从来没有为零。 在低谷时,它可能为几百至一千。 在繁忙的日子,它可能为几百万,但可能很快地变化10%或更多。 [1]

Special:Statistics

直到MediaWiki 1.16以前,队列值曾显示于Special:Statistics。 然而从1.17(rev:75272)版本开始这已被移除,并且现在可以通过API:Siteinfo 查看:



当使用MySQL时,API结果中返回的作业数可能稍有不准确,MySQL估计数据库中的作业数。 此数字可能会根据最近添加或删除的作业数量而波动。 对于不支持快速结果大小估计的其他数据库,将给出实际作业数。

面向开发者

代码维护

参见