Comment déboguer

From mediawiki.org
This page is a translated version of the page Manual:How to debug and the translation is 100% complete.
Languages:

Cette page donne une introduction de base au débogage du logiciel MediaWiki.

Une des premières choses que vous remarquerez est que echo ne fonctionne généralement pas ; Cela fait partie de la conception générale.

Il existe plusieurs options de configuration pour faciliter le débogage. Celles qui suivent sont toutes false par défaut. Activez-les en les mettant à true dans votre LocalSettings.php  :

  • $wgShowExceptionDetails Activer plus de détails (comme une trace de la pile) à afficher sur la page Erreur fatale.
  • $wgDebugToolbar Affiche une barre d'outils sur la page avec le profilage, les messages de journal et plus encore.
  • $wgShowDebug Ajoute la partie log messages de wgDebugToolbar comme une liste brute à la page.
  • $wgDevelopmentWarnings MediaWiki lancera des avis pour certaines conditions possibles d'erreur et pour les fonctions obsolètes.

Exemple de ligne à ajouter dans votre LocalSettings.php  : 

$wgShowExceptionDetails = true;

Erreurs PHP

Pour voir les erreurs PHP, ajoutez ceci à la seconde ligne du haut (juste sous le <?php) de LocalSettings.php  : 

error_reporting( -1 );
ini_set( 'display_errors', 1 );

Ou mettez-la dans php.ini  : 

error_reporting = E_ALL
display_errors = On

Ou déclarez dans .htaccess : 

php_value error_reporting -1
php_flag display_errors On

Cela entraînera l'affichage des erreurs PHP sur la page. Cela pourrait aider les attaquants pour trouver un chemin dans votre serveur, alors désactivez-la à nouveau lorsque vous avez trouvé le problème.

Notez que des erreurs PHP fatales peuvent se produire avant que les lignes ci-dessus ne se soient exécutées, ou peuvent empêcher leur affichage. Les erreurs fatales de PHP sont généralement enregistrées dans le journal des erreurs d'Apache - vérifiez le paramètre error_log dans php.ini (ou utilisez phpinfo())

Activation de l'affichage des erreurs au démarrage (display_startup_errors)

Certains fournisseurs désactivent display_startup_errors, ce qui masque les erreurs même si vous relancez le niveau error_reporting. Activer le programme est trop tard ! Au lieu de cela, vous devrez créer un fichier wrapper autour de votre fichier. Dans le cas de MediaWiki vous pouvez simplement ajouter ceci au-dessus de mediawiki/index.php : 

--- index.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );

Dans d'autres environnements : 

--- myTestFile.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );
    require 'your_file.php';

Erreurs SQL

Pour tracer toutes les requêtes SQL plutôt que uniquement celle qui a levé l'exception, fixez la valeur de $l dans LocalSettings.php : 

$wgDebugDumpSql = true;
Versions de MediaWiki :
1.16 – 1.31

Avant MediaWiki 1.32, vous deviez initialiser $wgShowSQLErrors et $wgShowDBErrorBacktrace pour voir les exceptions détaillées de la base de données dans la sortie HTML : 

$wgShowSQLErrors = true;
$wgShowDBErrorBacktrace = true;

Débogage en profondeur

Débogueur

Vous pouvez déboguer votre code étape par étape avec XDebug . Pour certaines configurations courantes, voir :

MediaWiki-Vagrant possède des paramètres intégrés pour cela. Si vous n'utilisez pas MediaWiki-Vagrant, mais que votre configuration est similaire, vous pouvez réutiliser ces valeurs. Dans certains cas (comme par exemple la présence d'un pare-feu), vous devrez peut-être utiliser l'IDE sur la même machine que le serveur web. Dans ce cas, définissez simplement : 

xdebug.remote_enable = 1
xdebug.remote_host = 'localhost'

Voir la documentation XDebug pour plus d'informations.

Pour déboguer un script de ligne de commande (par exemple PHPUnit ou un script de maintenance) sur MediaWiki-Vagrant, utilisez : 

xdebug_on; php /vagrant/mediawiki/path/to/script.php --wiki=wiki ; xdebug_off

Ajuster le script, les paramètres et l'hôte distant (ça devrait être l'adresse IP de l'ordinateur où se trouve votre IP, 10.0.2.2 devrait fonctionner pour MediaWiki-Vagrant) si nécessaire.

Journalisation

Pour plus de détails, vous devez faire un profil et consigner les erreurs.

Les instructions ci-dessous ne sont valables que pour la configuration par défaut. Si vous modifiez $wgMWLoggerDefaultSpi par exemple pour activer le rôle psr3 sur une case vagrant , ces paramètres seront probablement ignorés. Voir dans ce case la documentation de votre traceur, comme Manual:MonologSpi .

Configuration d'un fichier journal de débogage

Pour enregistrer les erreurs et les informations de débogage dans un journal, ajoutez $wgDebugLogFile au fichier LocalSettings.php. Modifiez la valeur vers un fichier texte où vous souhaitez enregistrer la sortie des traces de débogage.

Le logiciel MediaWiki doit avoir les droits de votre système d'exploitation pour créer et écrire dans ce fichier, par exemple dans une installation par défaut Ubuntu, il s'exécute en tant qu'utilisateur et groupe www-data:www-data . Voici un exemple de réglage : 

/**
 * The debug log file must never be publicly accessible because it contains private data.
 * But ensure that the directory is writeable by the PHP script running within your Web server.
 * The filename is with the database name of the wiki.
 */
$wgDebugLogFile = "/var/log/mediawiki/debug-{$wgDBname}.log";

Ce fichier contiendra beaucoup d'informations de débogage à partir du noyau MediaWiki et des extensions. Certains sous-systèmes écrivent dans des journaux personnalisés, voir #Création d'un fichier journal personnalisé pour capturer leur sortie.


Avertissement Avertissement : Le fichier journal de débogage peut contenir des informations privées telles que les informations de connexion, les cookies de session, et les valeurs des formulaires soumis. Si ces informations sont accessibles en public, les attaquants peuvent l'utiliser pour pirater et compromettre votre compte d'ordinateur et d'utilisateur. Si vous avez besoin de partager un journal de débogage à des fins de diagnostic, alors accédez au wiki sans y être connecté, et retirez du journal de débogage les lignes COOKIE, et n'exécutez aucune tentative de connexion.

Création d'un fichier journal personnalisé

Version de MediaWiki :
≤ 1.31

Avant Mediawiki 1.32, pour créer un fichier journal personnalisé qui ne contienne que vos instructions de débogage spécifiques, utilisez la fonction wfErrorLog(). Cette fonction a deux paramètres: la chaîne de caractères à tracer et le chemin vers le fichier du journal : 

wfErrorLog( "An error occurred.\n", '/var/log/mediawiki/my-custom-debug.log' );

Création de groupes de journaux personnalisés

Si vous effectuez le débogage de plusieurs composants différents, il peut être utile de diriger certains groupes de journaux à écrire dans un fichier distinct. Voir $wgDebugLogGroups pour plus d'informations.

Pour configurer des groupes de journaux personnalisés, utilisez les éléments suivants pour LocalSettings.php : 

/**
 * The debug log file should not be publicly accessible if it is used, as it
 * may contain private data. However, it must be in a directory to which PHP run
 * within your web server can write.
 *
 * Contrary to wgDebugLogFile, it is not necessary to include a wiki-id in these log file names
 * if you have multiple wikis. These log entries are prefixed with sufficient information to
 * identify the relevant wiki (web server hostname and wiki-id).
 */

// Groups from MediaWiki core
$wgDBerrorLog = '/var/log/mediawiki/dberror.log';
$wgDebugLogGroups = array(
	'exception' => '/var/log/mediawiki/exception.log',
	'resourceloader' => '/var/log/mediawiki/resourceloader.log',
	'ratelimit' => '/var/log/mediawiki/ratelimit.log',

	// Extra log groups from your extension
	#'myextension' => '/var/log/mediawiki/myextension.log',
	#'somegroup' => '/var/log/mediawiki/somegroup.log',
);

Pour vous connecter à l'un de ces groupes, appelez wfDebugLog comme ceci : 

if ( $module->hasFailed ) {
    wfDebugLog( 'myextension', "Something is not right, module {$module->name} failed." );
}
Si vous avez bien suivi les instructions ci-dessus mais que rien n'est écrit dans votre/vos fichier(s) de journalisation, et si votre système utilise SELinux, jetez un coup d’œil à la section logging sur la page SELinux pour contourner ce problème de contexte SELinux.
L'écriture de fichiers journaux dans le répertoire /tmp peut ne pas générer de fichier journal du tout, même si le répertoire /tmp est supposé être accessible en écriture à tous. Cela peut se produire si votre système utilise l'une des fonctionnalités systemd qui créent un répertoire virtuel /tmp pour ce processus. Si c'est le cas, configurez votre fichier journal à écrire dans un répertoire différent, comme /var/log/mediawiki

Enregistrement structuré

Version de MediaWiki :
≥ 1.25

La journalisation structurée vous permet d'inclure des champs dans vos enregistrements de journaux. Voir Structured logging pour plus d'informations.

Vous aurez besoin de configurer un meilleur enregistreur (par exemple Monolog), pour collecter les champs supplémentaires.

Jounaliser les erreurs JavaScript

Version de MediaWiki :
≥ 1.36

Voir la documentation du module ResourceLoader de mediawiki.errorLogger .

Statistiques

La journalisation avancée côté client peut être effectuée avec Extension:EventLogging , ce qui nécessite une configuration complexe et une inspection minutieuse des problèmes de confidentialité.

Le comptage simple de certains types d'événements est possible (depuis MediaWiki 1.25) en utilisant StatsD. StatsD propose des compteurs cumulatifs, des jauges, des compteurs instantanés et des métriques de temps.

Exemple d'utilisation : 

$stats = $context->getStats();
$stats->increment( 'resourceloader.cache.hits' );
$stats->timing( 'resourceloader.cache.rtt', $rtt );

Les métriques peuvent être envoyées à un serveur StatsD, qui peut être spécifié via la variable de configuration wgStatsdServer. Si cette variable n'est pas définie, les métriques sont perdues. Vous pouvez travailler avec StatsD localement (sans avoir besoin d'un serveur Graphite) en démarrant un serveur StatsD et en le configurant avec le backend backends/console, qui générera les métriques sur la console.

À partir de MediaWiki 1.25, wfIncrStats() est un raccourci pour la méthode increment() sur l'instance principale de RequestContext::getStats().

Envoyer des données de débogage à un commentaire HTML dans la sortie

Cela peut parfois être utile lorsqu'on aide un utilisateur final non technique. Il est plus sûr que d'exposer le fichier journal de débogage sur le web, car la sortie ne contient que des données privées pour l'utilisateur actuel. Mais il n'est pas idéal pour le développement car les données sont perdues en case d'erreur fatale ou de redirection. L'utilisation sur les sites de production n'est pas recommandée. Les commentaires de débogage révèlent des informations dans des vues de page qui pourraient potentiellement présenter des risques de sécurité. 

$wgDebugComments = true;

Travailler en direct avec des objets MediaWiki

eval.php est un script interactif pour évaluer et interagir avec les objets et fonctions MediaWiki dans un environnement entièrement initialisé. 

 $ php maintenance/eval.php
 > print wfMessage("Recentchanges")->plain();
 Recent changes

La machine virtuelle portable MediaWiki-Vagrant intègre le shell PHP interactif phpsh (en utilisant Zend).

Mises à jour appelables

Le code incorporé dans la fonction DeferredUpdates::addCallableUpdate(), comme $rc->save() dans RecentChange.php, n'est pas exécuté pendant la requête web, donc aucun message d'erreur ne sera affiché s'il échoue. Pour le débogage, il peut être utile de supprimer temporairement le code de la fonction afin qu'il soit exécuté en direct.

Shell interactif

Vous pouvez utiliser shell.php comme un REPL PHP avec un accès complet aux variables internes de MédiaWiki.

Débogage côté client (JavaScript)

Wikipedia propose un riche ensemble d'outils pour déboguer le JavaScript côté client. En plus des outils MediaWiki, d'autres techniques sont disponibles pour aider à diagnostiquer les interactions client.

Outils :

  • ResourceLoader propose un moyen de s'assurer que JavaScript est facilement affichable par les outils côté client.
  • Ouvrir la console de votre navigateur. De nombreux scripts Mediawiki côté client enregistrent les messages d'erreur sur la console à l'aide de ResourceLoader, qui fournit un moyen orienté vers la sécurité pour se connecter à la console client. Au-delà de la fonction de journalisation JavaScript native, il fournit une vérification pour s'assurer qu'une console est disponible et que la journalisation ne produit pas sa propre erreur. ResourceLoader/Features#Debug_mode décrit également cette fonctionnalité.
  • Les outils de navigation peuvent fournir une fonctionnalité native pour déboguer le script côté client.
  • Les traceurs de réseau, comme Wireshark peuvent fournir un aperçu dans le script qui est fourni par une page.
  • Vous pouvez ajouter ?debug=true à votre URL comme dans https://www.mediawiki.org/wiki/MediaWiki?debug=true pour obtenir des informations plus détaillées pour le débogage via la console de votre navigateur

Voir aussi

Retrieved from "https://www.mediawiki.org/w/index.php?title=Manual:How_to_debug/fr&oldid=6457105"