Manual:How to debug/nl

Op deze pagina wordt een introductie gegeven voor het debuggen van de MediaWiki software.

Een van de eerste dingen die opvalt is dat "echo" in het algemeen niet werkt; dit is deel van het algemene ontwerp.

Er zijn meerdere configuratie-opties voor het ondersteunen van het debuggen. De volgende staan standaard op, dus uit. Het inschakelen is vanzelfsprekend het op  te zetten in uw bestand :


 * Meer details tonen (zoals een 'stack trace') op de pagina met de "Fatal error".
 * Toont een werkbalk op de pagina met o.a. profilering en logberichten.
 * Voegt het deel "logberichten" van de wgDebugToolbar aan de pagina toe als een ruwe lijst.
 * MediaWiki zal meldingen geven voor mogelijke foutcondities en voor ontraden functies.

Voorbeeldregel die moet worden toegevoegd aan uw :



PHP fouten
Om PHP fouten te zien, voeg dit aan de 2e regel toe (net onder ) van :

Of plaats deze regels in :

Of in .htaccess:

Hierdoor worden PHP-fouten nu op de pagina getoond. Dit kan het voor kwaadwillenden gemakkelijker maken om uw server te kraken, laat dit dus alleen even zo staan tijdens uw test.

Het kan zijn dat een fatale PHP-fout optreedt in een regel die nog niet uitgevoerd is of voorkomt dat die worden getoond. Fatale PHP-fouten worden normaal gesproken gelogd in de error-log van Apache. Controleer de instelling  in   (of gebruik  ).



Zet display_startup_errors aan
Enkele providers zetten  uit, dat verbergt de fouten ook als u het level   gebruikt. Het aanzetten in het programma werkt niet! Maak daarvan in plaats een wrapper bestand om uw bestand. In het geval van MediaWiki kunt u dit toevoegen bovenaan in mediawiki/index.php:

In andere omgevingen:



SQL fouten
Om SQL-queries te loggen, in plaats van alleen de queries die foutlopen: set in  ":

Voor versie 1.32 van de MediaWiki moest men de en  zetten om de details van de database-fouten te zien in de HTML-uitvoer:



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 heeft hiervoor ingebouwde instellingen. Als u MediaWiki-Vagrant niet gebruikt, maar uw set-up vergelijkbaar is, kunt u die waarden hergebruiken. In sommige gevallen (bijvoorbeeld door een firewall) moet u de IDE op dezelfde machine gebruiken als de webserver. In dat geval kunt u eenvoudig instellen:

Meer informatie over XDebug.

Om een commando-regel script (PHPUnit of een onderhoudsscript) te debuggen op MediaWiki-Vagrant, gebruik:

Pas het script, parameters en de remote host aan (het moet de IP zijn van de computer wat uw IP heeft, 10.0.2.2 zou moeten werken voor MediaWiki-Vagrant).

Inloggen
Voor meer informatie moet u profileren en de log gebruiken.



Een logbestand instellen voor het debuggen
Om fouten en debug informatie in een log te plaatsen, voeg  toe aan het bestand. Wijzig de waarde naar een tekstbestand waarin u de debug trace de uitvoer wilt laten schrijven.

De MediaWiki software moet rechten krijgen van uw besturingssysteem om dit bestand aan te maken en om erin te schrijven. In een standaard Ubuntu installatie wordt het uitgevoerd als gebruiker en groep :. Een mogelijke instelling:

Dit bestand zal debug-informatie bevatten van de core MediaWiki en diens extensies. Enkele subsystemen schrijven naar eigen of andere logbestanden, lees dit artikel om die logging te bekijken.



Aangepast logbestand aanmaken
Voor MediaWiki 1.32 kon je een aangepast logbestand maken dat alleen uw specifieke debug statements bevatte. Dat ging met de functie. Deze functie heeft twee argumenten, de te loggen tekst en het pad naar het logbestand:



Aangepaste loggroepen aanmaken
Als u verschillende componenten probeert te debuggen, dan kunt u loggen naar meerdere logbestanden. Zie voor meer informatie.

Om meerdere loggroepen in te stellen, voeg het volgende toe aan LocalSettings.php:

Om dan naar een bepaalde groep te loggen, roep  op deze manier aan:



Gestructureerde logging
Gestructureerde logging staat u toe om velden in uw loggegevens toe te voegen. Zie voor meer informatie.



JavaScript loggen van fouten
See the documentation of the ResourceLoader module.

Statistieken
Geavanceerde klantzijde logging kan met worden gedaan, hiervoor is een complexe instelling en een zorgvuldige controle op het omgaan met privacy gevoelige informatie nodig.

Het eenvoudig tellen van bepaalde type gebeurtenissen is mogelijk (sinds versie 1.25) met gebruik van StatsD. StatsD zorgt voor tellers van allerlei soort ook voor met meten van de tijd.

Gebruiksvoorbeeld:

Deze gegevens kunnen worden verzonden naar een StatD server die met  kan worden ingesteld. (zonder het instellen geen verzending en externe verwerking.) U kunt lokaal met StatsD werken (zonder een Graphite server nodig te hebben) door een StatsD server te starten en het in te stellen met het "backends/console", de uitvoergegevens van de metingen komen dan op het console.

Vanaf MediaWiki 1.25 is  een verkorte aanduiding voor de methode   in de   instantie.



Debuggegevens in HTML commentaar zetten
Dit kan soms bruikbaar zijn bij het ondersteunen van een niet technische gebruiker. Het is veiliger dan het logbestand van het debuggen op het web te laten zien omdat de uitvoer alleen private gegevens van de huidige gebruiker bevat. Maar in de ontwikkelfase is het niet ideaal omdat er dan gegevens over fouten en verwijzingen ontbreken. Het gebruiken op productie-omgevingen wordt niet aanbevolen. Debug commentaar openbaart informatie die het veiligheidsrisico verhoogt.





MediaWiki objecten in productie gebruiken
is een interactief script voor het evalueren en bekijken van MediaWiki objecten en functies in een volledige geïnitialiseerd omgeving.

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

De portabele virtuele machine integreert met de interactieve PHP shell   (bij gebruik van Zend).



Oproepbare updates
De code die ingebed zit in de functie, zoals    in  , wordt niet uitgevoerd bij de web request, er wordt dus geen foutboodschap getoond als dat mislukt. Bij het debugging, is het mogelijk handig om tijdelijk deze code niet uit te laten voeren in de functie zodat het loggen wel dan wordt uitgevoerd.



Interactieve shell
U kunt gebruiken als een PHP REPL met volledige toegang tot de interne functies van MediaWiki (internals).



Cliëntzijde debuggen (JavaScript)
Wikipedia heeft veel hulpmiddelen voor het debuggen aan de klantzijde met JavaScript. Als aanvulling op de hulpmiddelen van MediaWiki tools zijn er andere technieken beschikbaar voor het helpen met de diagnose van de interactie met de klant.

Hulpmiddelen:


 * ResourceLoader zorgt dat JavaScript zeker eenvoudig te bekijken is door de hulpmiddelen.
 * Open het console van uw webbrowser Veel klantzijde Mediawiki scripts zetten de foutboodschappen op het console met gebruik van ResourceLoader, die zorgt dat dat veilig kan. Naast de interne JavaScript logfunctie, zorgt het ook voor een controle dat er een console beschikbaar is en dat de logging zelf niet foutloopt. Deze functie is beschreven in ResourceLoader/Architecture#Debug_mode.
 * De webbrowser heeft vermoedelijk ook interne hulpmiddelen voor het debuggen van code.
 * Netwerk tracers, zoals Wireshark geven inzicht in het script dat wordt gebruikt door een pagina.
 * U kunt  toevoegen aan uw URL (bijv.  https://www.mediawiki.org/wiki/MediaWiki?debug=true) om gedetailleerde informatie voor het debuggen te krijgen via het console van de webbrowser.



Zie ook

 * ResourceLoader: ResourceLoader/Developing with ResourceLoader#Debugging|Ontwikkelen met debuggen
 * Alle configuratie variabelen gerelateerd aan debugging/logging
 * TIP:  (stopt na het opgegeven bericht en toont de 'callstack')
 * wikitech:Debugging in production - debugging op een productie omgeving
 * TIP:  (stopt na het opgegeven bericht en toont de 'callstack')
 * wikitech:Debugging in production - debugging op een productie omgeving
 * wikitech:Debugging in production - debugging op een productie omgeving
 * wikitech:Debugging in production - debugging op een productie omgeving