Manual:How to debug/cs

Tato stránka obsahuje základní informace potřebné k řešení chyb MediaWiki.

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

K ladění existuje několik možností konfigurace. Ve výchozím nastavení jsou všechny nastaveny na. Povolte je v nastavením na  :


 * Povolení zobrazení dalších podrobností (jako je trasování zásobníku) na stránce "Závažná chyba" (fatal error).
 * Zobrazení na stránce panel nástrojů s profilováním, protokolovacími zprávami a dalšími.
 * Přidá na stránku část "zprávy protokolu" wgDebugToolbar jako nezpracovaný seznam.
 * Vyvolá upozornění na možné chyby MediaWiki a na zastaralé funkce.

Příklad řádku, který má být přidán do vašeho :



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

Nebo zadejte do :

Nebo zadejte do .htaccess:

Chyby PHP e 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  ).



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 na začá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
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 má k tomu vestavěná nastavení. 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 firewallu) možná budete muset použít IDE na stejném počítači jako webový server. V tomto případě můžete jednoduše nastavit:

Další informace naleznete v dokumentaci XDebug.

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 podle potřeby fungovat pro MediaWiki-Vagrant).

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 #Vytvoření vlastního souboru protokolu.



Vytvoření vlastního souboru protokolu
U starších verzí před MediaWiki 1.32 použijte funkci  k vytvoření vlastního souboru protokolu, který obsahuje pouze vaše konkrétní ladicí příkazy. 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. Další informace naleznete na stránce.

Chcete-li nastavit vlastní skupiny protokolů, použijte v 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. Další informace získáte na stránce.



Protokolování chyb JavaScriptu
See the documentation of the ResourceLoader module.

Statistiky
Pokročilé protokolování na straně klienta lze provádět při použití. 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 odeslat 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 Grafite 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.



Odeslání debug dat 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ývoji 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í 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ě.



Interaktivní shell
můžete použít jako PHP REPL s plným přístupem k interním informacím MediaWiki.



Ladění na straně klienta (JavaScript)
Wikipedie 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í ResourceLoaderu, 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 konzola 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.
 * Ke své adrese URL můžete přidat  jako v https://www.mediawiki.org/wiki/MediaWiki?debug=true, abyste získali podrobnější informace pro ladění prostřednictvím konzole prohlížeče



Související odkazy

 * ResourceLoader: Vývoj ladění zdrojů#Ladění
 * Všechny konfigurační proměnné související s laděním případně s 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 in production - ladění produkčního clusteru Wikimedií
 * Užitečný tip pro ladění:  (zanikne s danou zprávou a vytiskne zpětné volání)
 * wikitech:Debugging in production - ladění produkčního clusteru Wikimedií
 * wikitech:Debugging in production - ladění produkčního clusteru Wikimedií
 * wikitech:Debugging in production - ladění produkčního clusteru Wikimedií