Manual:File d’attente des travaux

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 44% complete.

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

Avec MediaWiki 1.6, une file d'attente des travaux (ou job queue en anglais) a été introduite pour réaliser les longues opérations en tâche de fond. La file d’attente est conçue pour effectuer plusieurs petites tâches en traitement par lots.

Installation

Lorsque c’est possible, vous devriez mettre $wgJobRunRate à 0, et ensuite utiliser un planificateur de tâches pour effectuer les tâches en toile de fond.

Par exemple, si vous utilisez cron pour effectuer des tâches tous les jours à minuit, vous entreriez dans votre fichier crontab :

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

Exécution de tâches lors des requêtes de pages

Par défaut, chaque fois qu’une page est requêtée, une tâche est prise dans le planificateur de tâches et exécutée.

Ce comportement est contrôlé par le paramètre de configuration $JogRunRate. En mettant ce paramètre à 1, une tâche sera traitée à chaque requête.

En mettant ce paramètre à 0, l’exécution des tâches sera arrêtée complètement lors des requêtes de pages, mais vous devrez exécuter manuellement ou périodiquement runJobs.phpManual:runJobs.php.

Version de MediaWiki : 1.23

Lorsqu’elles sont activées, les tâches sont exécutées en ouvrant un socket et en faisant une requête HTTP interne à une page spéciale non-listée SpecialRunJobs.php.

Voyez la section asynchronous.

Problématique de la performance

Si les performances sont trop amoindries, vous pouvez réduire $wgJobRunRateManual:$wgJobRunRate en mettant quelque chose comme ceci dans votre LocalSettings.php :

En mettant ce paramètre à un nombre compris entre 1 et 0, une tâche sera exécutée en moyenne toutes les 1 / $wgJobRunRate requêtes.

$wgJobRunRate = 0.01;

Utilisation manuelle

Il y a aussi un moyen de vider manuellement le planificateur de tâches, par exemple après avoir changé un modèle présent sur de nombreuses pages.

Exécutez simplement le script de maintenance maintenance/runJobs.phpManual:runJobs.php.

Par exemple :

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

Historique

Asynchrone

The configuration variable $wgRunJobsAsyncManual:$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.

Mises à jour différées

Le mécanisme de mises à jour différées (deferred updates en anglais) a été introduit dans MediaWiki 1.23 et a connu des changements majeurs dans MediaWiki 1.27 et 1.28. Il permet l’exécution de certaines fonctionnalités à la fin de la requête, lorsque tout le contenu a été envoyé au navigateur, plutôt que des ajouter dans un travail (job) qui pourrait potentiellement être exécuté plusieurs heures après. Le but de ce mécanisme alternatif est principalement d’accélérer les requêtes MediaWiki, et en même temps d’exécuter certaines fonctionnalités dès que possible à la fin de la requête.

Quelques mises à jour différées peuvent être à la fois des mises à jour différées et des travaux, si spécifié comme tel.

Changes introduced in MediaWiki 1.22

In MediaWiki 1.22MediaWiki 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.phpManual:runJobs.php in the background. It will only work if $wgPhpCliManual:$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:

There's no way to revert to the old on-request job queue handling, besides setting $wgPhpCliManual:$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.

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.

Changes introduced in MediaWiki 1.27

In MediaWiki 1.25 and MediaWiki 1.26, use of $wgRunJobsAsyncManual:$wgRunJobsAsync would sometimes cause jobs not to get run if the wiki has custom $wgServerNameManual:$wgServerName configuration. This was fixed in MediaWiki 1.27. task T107290

Changes introduced in MediaWiki 1.28

Between MediaWiki 1.23 and MediaWiki 1.27, use of $wgRunJobsAsyncManual:$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. task T68485

Changes introduced in MediaWiki 1.29

Dans MediaWiki 1.27.0 à 1.27.3 et 1.28.0 à 1.28.2, lorsque $wgJobRunRateManual:$wgJobRunRate est configuré à une valeur supérieure à 0, l’erreur suivante peut apparaître dans les journaux d’erreur ou sur la page :

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

Quelques pages spéciales peuvent ne plus être mises à jour dans certains cas, des catégories peuvent plus être mises à jour sur les pages de catégories, ou les modifications récentes peuvent afficher des liens vers des pages supprimées, même si vous exécutez runJobs.phpManual:runJobs.php pour vider la file d’attente.

Ce bug a été rapporté (task T100085) et corrigé dans 1.27.4 et 1.28.3.

Job examples

Mettre à jour la table des liens quand un modèle est modifié

MediaWiki 1.6 ajoute une tâche dans la file pour chaque article qui utilise un modèle modifié. Chaque tâche va lire l'article, substituer les modèles et modifier la table des liens en conséquence.

Les modifications consistant à sauver une page sans en modifier le contenu (null edit) ne sont plus nécessaires, mais cela peut prendre un certain temps pour les modèles très utilisés.

Invalidation du cache HTML

Une plus grande classe d'opérations consiste en l'invalidation du cache HTML pour un grand nombre de pages :

  • Modifier une image (toutes les miniatures seront mises à jour)
  • Suppression d'une page (tous les liens vers cette page passeront du bleu au rouge)
  • Création ou restauration d'une page (l'inverse du cas précédent)
  • Modifier un modèle (toutes les pages contenant ce modèle devront être mises à jour)

À l'exception des modifications de modèles, toutes ces opérations ne modifient pas la table des liens, mais elles invalident le cache HTML de toutes les pages liées. Invalider un cache est rapide, l'opération ne requiert la modification que d'un champ dans la base de données et l'envoi de requêtes de purge aux serveurs Squid si utilisés. Mais s'il y a plus de 1 000 pages à purger, cela peut prendre un certain temps. Par défaut, des tâches sont ajoutées uniquement s'il y a plus de 500 pages à invalider, une tâche par 500 pages.

Valeurs typiques

Pendant les périodes de faible affluence, la file peut être vide. Chez Wikimedia, la file n'est en pratique jamais vide. Pendant les heures creuses, elle peut avoir entre une centaine et quelques milliers de tâches. Mais pendant une journée chargée, elle peut atteindre plusieurs millions de tâches. [1]

Voir l'état de la file d'attente

Up to MediaWiki 1.16, the job queue value was shown on Special:Statistics. Depuis la version 1.17, cela n'est plus visible dans les statistiques, il faut passer par l'API.

  • w/api.php?action=query&meta=siteinfo&siprop=statistics

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.

For developers

See also