Manual:How to debug/fr

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  par défaut. Activez-les en les mettant à  dans votre  :


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

Exemple de ligne à ajouter dans votre :



Erreurs PHP
Pour voir les erreurs PHP, ajoutez ceci à la seconde ligne du haut (juste sous le ) de :

Ou mettez-la dans :

Ou déclarez dans .htaccess :

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  dans   (ou utilisez  )



Activation de l'affichage des erreurs au démarrage (display_startup_errors)
Certains fournisseurs désactivent, ce qui masque les erreurs même si vous relancez le niveau. 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 :

Dans d'autres environnements :



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

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



Débogueur
You can debug your code step-by-step with XDebug. For some common setups, see:


 * MediaWiki-Docker
 * mwcli
 * Vagrant with PHPStorm
 * Vagrant with other IDEs
 * MacOS

MediaWiki-Vagrant has built in settings for this. If you're not using MediaWiki-Vagrant, but your setup is similar, you can reuse those values. In some cases (e.g. due to a firewall), you may have to use the IDE on the same machine as the web server. In this case, you can simply set:

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 :

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

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



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

Le logiciel MediaWiki doit avoir les permissions 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  :. Voici un exemple de réglage :

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.



Création d'un fichier journal personnalisé
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. Cette fonction a deux paramètres: la chaîne de caractères à tracer et le chemin vers le fichier du journal :



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 pour plus d'informations.

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

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



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



Jounaliser les erreurs JavaScript
See the documentation of the ResourceLoader module.

Statistiques
La journalisation avancée côté client peut être effectuée avec, 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 :

Les métriques peuvent être envoyées à un serveur StatsD, qui peut être spécifié via la variable de configuration. 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,  est un raccourci pour la méthode   sur l'instance principale de.



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é.





Travailler en direct avec des objets MediaWiki
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 intègre le shell PHP interactif   (en utilisant Zend).



Mises à jour appelables
Le code incorporé dans la fonction, comme   dans  , 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 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  à 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

 * ResourceLoader : ResourceLoader/Developing with ResourceLoader#Debugging
 * Toutes les variables de configuration liées au débogage/journalisation : Manuel:Paramètres de configuration#Debug/logging
 * Astuce de débogage utile :  (meurt avec le message donné et imprime la pile des appels)
 * wikitech:Debugging in production - Débogage sur le groupe de production de Wikimedia
 * Astuce de débogage utile :  (meurt avec le message donné et imprime la pile des appels)
 * wikitech:Debugging in production - Débogage sur le groupe de production de Wikimedia
 * wikitech:Debugging in production - Débogage sur le groupe de production de Wikimedia
 * wikitech:Debugging in production - Débogage sur le groupe de production de Wikimedia