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.

V tomto okamžiku se další webový požadavek, který zadá MediaWiki ::run (všechny), rozbije a umístí na příkazový řádek:

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

Ladicí program HHVM CLI má vynikající systém nápovědy, například vyzkoušejte help break, kde najdete podrobnosti o syntaxi výběru bodů přerušení.

Protokolování
Pro mnohem podrobnější informace je třeba se profilovat a zaznamenávat chyby.

Nastavení souboru protokolu ladění
Chcete-li uložit chyby a informace o ladění do protokolu, přidejte soubor  do souboru. Změňte hodnotu na textový soubor, do kterého chcete uložit výstup trasování ladění.

Software MediaWiki musí mít oprávnění od vašeho operačního systému k vytvoření a zápisu do tohoto souboru, například ve výchozí instalaci Ubuntu běží jako uživatel a skupina :. Zde je ukázkové nastavení:

Tento soubor bude obsahovat mnoho ladících informací z jádra a rozšíření MediaWiki. Některé subsystémy zapisují do vlastních protokolů, informace o zachycení jejich výstupu naleznete v části.

Ladění životnost databázových transakcí lze povolit pro některé databáze pomocí.

Vytvoření vlastního souboru protokolu
Chcete-li vytvořit vlastní soubor protokolu, který obsahuje pouze vaše specifické příkazy ladění, použijte funkci  (použití wfErrorLog bylo v MediaWiki 1.25 zastaralé). Tato funkce používá dva argumenty, textový řetězec k protokolování a cestu k souboru protokolu:

Vytváření vlastních skupin protokolů
Pokud ladíte několik různých součástí najednou, může být užitečné nasměrovat určité skupiny protokolů k zápisu do samostatného souboru. Pro další informace viz.

Chcete-li nastavit vlastní skupiny protokolů, použijte LocalSettings.php následující:

Chcete-li se přihlásit k jedné z těchto skupin, volejte  takto:

Strukturované protokolování
Strukturované protokolování umožňuje zahrnout do záznamu protokolu pole Pro další informace viz.

Statistiky
Pokročilé protokolování na straně klienta lze provádět za, což vyžaduje komplexní nastavení a pečlivou kontrolu problémů s ochranou osobních údajů.

Jednoduché počítání určitých druhů událostí je možné (od MediaWiki 1.25) pomocí StatsD. StatsD nabízí měřiče, měřidla, čítače a metriky časování.

Příklad použití:

Metriky lze poslat na server StatsD, který lze určit pomocí konfigurační proměnné. (Pokud není nastaveno, metriky se zahodí.) Se StatsD můžete pracovat lokálně (bez potřeby grafitového serveru) spuštěním serveru StatsD a jeho konfigurací s "backends/console" backendem, který vyvede metriky do konzoly.

Od MediaWiki 1.25 je  zkratkou metody   v hlavní instanci.

Odeslat debug data do komentáře HTML ve výstupu
To může být někdy užitečné při podpoře netechnického koncového uživatele. Je to bezpečnější než vystavení souboru protokolu ladění webu, protože výstup obsahuje pouze soukromá data pro aktuálního uživatele. Není to však ideální pro vývojové použití, protože se ztratí data o závažných chybách a přesměrováních. Použití ve výrobě se nedoporučuje. Ladící komentáře odhalují informace v zobrazeních stránek, která by mohla potenciálně vystavit bezpečnostním rizikům.



Práce živě s objekty MediaWiki
je interaktivní skript pro vyhodnocení a interakci s objekty a funkcemi MediaWiki v plně inicializovaném prostředí.

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

Virtuální počítač integruje interaktivní prostředí PHP   (při použití výchozí HHVM) nebo   (při použití Zendu).

Volitelné aktualizace
Kód vložený do funkce, jako je například   v  , není proveden. během webového požadavku, takže pokud se nezdaří, nebude zobrazena žádná chybová zpráva. Pro ladění může být užitečné dočasně odebrat kód z funkce, aby byl spuštěn živě.

Ladění na straně klienta (JavaScript)
Wikipedia nabízí bohatou sadu nástrojů pro ladění JavaScriptu na straně klienta. Kromě nástrojů MediaWiki jsou k dispozici další techniky, které pomáhají diagnostikovat interakce klienta.

Nástroje:


 * ResourceLoader nabízí prostředek k zajištění JavaScriptu, který lze snadno zobrazit pomocí nástrojů na straně klienta.
 * Otevřete konzolu prohlížeče. Mnoho skriptů Mediawiki na straně klienta zaznamenává chybové zprávy do konzole pomocí ResourceLoader, který poskytuje bezpečně orientovaný způsob pro přihlášení do klientské konzole. Kromě funkce protokolování nativního JavaScriptu poskytuje kontrolu, zda je k dispozici konzole a že protokolování nevyvolává svou vlastní chybu. Režim ladění architektury zavaděče zdrojů také popisuje tuto funkci.
 * Nástroje prohlížeče mohou poskytovat nativní funkce pro ladění skriptu na straně klienta.
 * Síťové indikátory, například Wireshark, mohou poskytnout nahlédnutí do skriptu, který poskytuje stránka.

Viz též

 * ResourceLoader: ResourceLoader/Developing with ResourceLoader#Debugging (Vývoj ladění zdrojů # Ladění)
 * Všechny konfigurační proměnné související s laděním / protokolováním: Návod: Nastavení konfigurace # Ladění / protokolování
 * Užitečný tip pro ladění:  (zanikne s danou zprávou a vytiskne zpětné volání)
 * wikitech:Debugging - ladění produkčního clusteru Wikimedia
 * Užitečný tip pro ladění:  (zanikne s danou zprávou a vytiskne zpětné volání)
 * wikitech:Debugging - ladění produkčního clusteru Wikimedia
 * wikitech:Debugging - ladění produkčního clusteru Wikimedia
 * wikitech:Debugging - ladění produkčního clusteru Wikimedia