Manual:How to debug/cs

Tato stránka poskytuje základní úvod k softwaru odstraňování chyb MediaWiki.

Jednou z prvních věcí, které si všimnete, je, že „echo“ obecně nefunguje; což je součást obecného designu.

Chyby PHP
Chcete-li zobrazit chyby PHP, přidejte toto do druhého řádku se shora (přímo pod ) :

Nebo jej zadejte do :

Nebo jej zadejte do .htaccess:

Chyby PHP budou zobrazovat na stránce. Tato úprava může útočníkům usnadnit nalezení cesty na váš server. Proto pokud problém najdete, znovu vypněte "echo".

Nezapomeňte, že k fatálním chybám PHP může dojít dříve, než budou výše uvedené řádky provedeny, neboť mohou zabránit jejich zobrazení. Závažné chyby PHP se obvykle zaznamenávají do protokolu chyb Apache - zkontrolujte nastavení  v   (nebo použijte  ).

K ladění existuje několik možností konfigurace. Ve výchozím nastavení jsou všechny. Povolte je nastavením jejich  v :
 * Na stránce „Závažná chyba“ (Fatal error) můžete zobrazit více podrobností (například trasování zásobníku).
 * Zobrazuje na stránce panel nástrojů s profilováním, protokolovacími zprávami a dalšími.
 * Přidá část "protokolové zprávy" (log messages) wgDebugToolbar jako nezpracovaný seznam na stránku.
 * MediaWiki vyvolá upozornění na možné chyby a na zastaralé funkce.

Zapnutí display_startup_errors
Někteří poskytovatelé vypnou, což chyby skryje, i když zvýšíte úroveň. Zapnutí při běhu programu je příliš pozdě! Místo toho budete muset vytvořit soubor obálek kolem vašeho souboru. V případě MediaWiki stačí přidat toto nazačátek mediawiki/index.php:

V jiných prostředích:

SQL chyby
Chcete-li protokolovat všechny dotazy SQL, nikoli pouze ten, který vyvolal výjimku, nastavte v  :

Před verzí MediaWiki 1.32 musíte nastavit a, abyste viděli podrobnosti o výjimkách databáze ve výstupu HTML:

Debugger
Nejběžnější nastavení (pomocí MediaWiki-Vagrant a PhpStorm) viz.

Zend
Pokud používáte interpret Zend PHP, můžete svůj kód ladit pomocí XDebug. MediaWiki-Vagrant má za tímto účelem vestavěné built in settings (nastavení ladicího souboru). Pokud nepoužíváte MediaWiki-Vagrant, ale vaše nastavení je podobné, můžete tyto hodnoty znovu použít. V některých případech (např. Kvůli bráně firewall) může být nutné použít IDE na stejném počítači jako webový server. V tomto případě můžete jednoduše nastavit:

Pokud použijete tuto konfiguraci, můžete narazit na problém, pokud HHVM také naslouchá na počítači. XDebug i HHVM standardně používají port 9000. Můžete to však změnit pro XDebug (a mnoho klientů). Na straně XDebug použijte:

Nezapomeňte, pokud jej změníte pro XDebug, musíte jej také změnit pro své IDE.

Další informace naleznete v dokumentaci XDebug documentation.

K ladění skriptu příkazového řádku (např. PHPUnit nebo skriptu údržby) na MediaWiki-Vagrant použijte:

Upravte skript, parametry a vzdáleného hostitele (měla by to být IP počítače, kde je vaše IP, 10.0.2.2 by měla fungovat pro MediaWiki-Vagrant) podle potřeby.

HHVM
Pokud používáte běhový modul HHVM PHP, můžete svůj kód ladit pomocí vestavěného ladicího a ladicího serveru CLI. (XDebug také obvykle funguje, ale je méně spolehlivý než na Zendu.) Tento debugger je nejasně podobný GDB.

Aby se ladicí program cli mohl připojit k webovým požadavkům, musí být povolen parametr hhvm.debug.enable_debugger. Ve výchozím nastavení je to ve vývojovém prostředí mediawiki-vagrant povoleno.

S tímto povoleným procesem je:

$ hhvm -m debug --debug-host localhost --debug-port 8089 localhost> machine list machine list 1    vagrant's default sandbox at /vagrant/www/ 2    __builtin's default sandbox at / localhost> machine attach 2 machine attach 2 Attaching to __builtin's default sandbox at / and pre-loading, please wait... localhost> break MediaWiki::run break MediaWiki::run Breakpoint 1 set upon entering MediaWiki::run localhost> continue continue

Je vyžadováno připojit stroj 2. Nemusí to být vždy stroj 2, ale vždy to bude ten, který je označen jako „__builtin's default sandbox at /“. To platí pouze pro konfigurace, které předávají  přes fastcgi do hhvm (například  a wmf production), alternativní konfigurace se mohou lišit.

At this point the next web request that enters MediaWiki::run (all of them) will break and put you on a command prompt:

Breakpoint 1 reached at MediaWiki::run on line 450 of /vagrant/mediawiki/includes/MediaWiki.php 449           try { 450*                  $this->checkMaxLag; 451                   try { localhost>

The HHVM CLI debugger has an excellent help system, for example try help break for details on the syntax of choosing break points.

Logging
For much greater detail, you need to profile and log errors.

Setting up a debug log file
To save errors and debugging information to a log, add  to the   file. Change the value to a text file where you want to save the debug trace output.

The MediaWiki software must have permissions from your operating system to create and write to this file, for example in a default Ubuntu install it runs as user & group :. Here's a sample setting:

This file will contain much debug information from MediaWiki core and extensions. Some subsystems write to custom logs, see to capture their output.

Database transaction lifecycle debugging can be enabled for some databases with.

Creating a custom log file
To create a custom log file that only holds your specific debug statements, use the  function (use of wfErrorLog was deprecated in MediaWiki 1.25). This function takes two arguments, the text string to log and the path to the log file:

Creating custom log groups
If you're debugging several different components, it may be useful to direct certain log groups to write to a separate file. See for more information.

To set up custom log groups, use the following to LocalSettings.php:

To log to one of these groups, call  like this:

Structured logging
Structured logging allows you to include fields in your log records. See for more information.

Statistics
Advanced client-side logging can be performed with, which requires a complex setup and careful inspection of privacy issues.

Simple counting of certain kind of events is possible (since MediaWiki 1.25) using StatsD. StatsD offers meters, gauges, counters, and timing metrics.

Usage example:

The metrics can be sent to a StatsD server, which may be specified via the  configuration variable. (If not set, the metrics are discarded.) You can work with StatsD locally (without needing a Graphite server) by starting a StatsD server and configuring it with the "backends/console" backend, which will output metrics to the console.

As of MediaWiki 1.25,  is a shortcut for the   method on the main   instance.

Send debug data to an HTML comment in the output
This may occasionally be useful when supporting a non-technical end-user. It's more secure than exposing the debug log file to the web, since the output only contains private data for the current user. But it's not ideal for development use since data is lost on fatal errors and redirects. Use on production sites is not recommended. Debug comments reveal information in page views which could potentially expose security risks.



Working live with MediaWiki objects
is an interactive script to evaluate and interact with MediaWiki objects and functions in a fully initialized environment.

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

The portable virtual machine integrates the interactive PHP shell   (when using the default HHVM) or   (when using Zend).

Callable updates
Code embedded in the  function, such as   in , is not executed during the web request, so no error message will be displayed if it fails. For debugging, it may be helpful to temporarily remove the code from within the function so that it is executed live.

Client side debugging (JavaScript)
Wikipedia offers a rich set of tools for debugging client side JavaScript. In addition to the MediaWiki tools, other techniques are available to assist with diagnosing client interactions.

Tools:


 * ResourceLoader offers a means to ensure JavaScript is easily viewable by client-side tools.
 * Open your browser's console. Many client side mediawiki scripts log error messages to the console using ResourceLoader, which provides a safety oriented way to log to the client console. Beyond the native JavaScript logging function, it provides a check to ensure that a console is available and that logging does not produce its own error. ResourceLoader/Architecture#Debug_mode also describes this feature.
 * Browser tools may provide native functionality to debug client side script.
 * Network tracers, like Wireshark can provide insight into the script that is being provided by a page.