Manual:How to debug/de

Diese Seite gibt eine grundlegende Einführung in das Debugging von MediaWiki-Software.

Eines der ersten Dinge, die du bemerken wirst, ist, dass "Echo" generell nicht funktioniert; das ist Teil des allgemeinen Designs.

Es gibt verschiedene Konfigurationsoptionen, die das Debugging erleichtern. Die folgenden sind alle standardmäßig. Aktiviere sie, indem du sie in deinen auf   festlegst:


 * Aktiviere, dass auf der Seite "Schwerwiegender Fehler" mehr Details (z. B. ein Stack-Trace) angezeigt werden.
 * Zeigt eine Symbolleiste auf der Seite mit Profilerstellung, Protokollmeldungen und mehr.
 * Fügt den "Logmeldungen"-Teil der wgDebugToolbar als rohe Liste zur Seite hinzu.
 * MediaWiki wird Benachrichtigungen für einige mögliche Fehlerbedingungen und für veraltete Funktionen ausgeben.



PHP-Fehler
Um PHP-Fehler zu sehen, füge dies in die zweite Zeile von oben (direkt unter der ) von ein:

Oder setze es in :

Oder setze es in .htaccess:

Dies führt dazu, dass PHP-Fehler auf der Seite angezeigt werden. Dies könnte es Angreifern erleichtern, einen Weg in deinen Server zu finden. Deaktiviere es daher wieder, wenn du das Problem gefunden hast.

Beachte, dass fatale PHP-Fehler auftreten können, bevor die obigen Zeilen überhaupt ausgeführt werden, oder dass sie nicht angezeigt werden können. Fatale PHP-Fehler werden normalerweise im Apache-Fehlerprotokoll protokolliert - überprüfe die Einstellung  in der   (oder verwende  ).



display_startup_errors einschalten
Einige Anbieter schalten  ab, wodurch die Fehler verborgen bleiben, auch wenn du die   Stufe erhöhst. Wenn du sie im Programm einschaltest, ist es zu spät! Stattdessen musst du eine Wrapper-Datei um deine Datei herum erstellen. Im Fall von MediaWiki kannst du diese einfach über mediawiki/index.php einfügen:

In mother embrion mers:



SQL-Fehler
Um alle SQL-Abfragen zu protokollieren und nicht nur diejenige, die die Ausnahme ausgelöst hat, legst du in   fest:

Vor MediaWiki 1.32 musstest du und  festlegen, um Details von Datenbankausnahmen in der HTML-Ausgabe zu sehen:



Debugger
Für die gebräuchlichste Einrichtung (mit MediaWiki-Vagrant und PhpStorm) siehe.

Zend
Wenn du den Zend PHP-Interpreter verwendest, kannst du deinen Code mit XDebug debuggen. MediaWiki-Vagrant hat dafür in den Einstellungen festgelegt. Wenn du nicht MediaWiki-Vagrant verwendest, dein Setup jedoch ähnlich ist, kannst du diese Werte wiederverwenden. In manchen Fällen (z. B. wegen einer Firewall) musst du die IDE auf demselben Rechner verwenden wie den Webserver. In diesem Fall kannst du einfach festlegen:

See the XDebug documentation for more information.

To debug a command-line script (e.g. PHPUnit, or a maintenance script) on MediaWiki-Vagrant, use:

Adjust the script, parameters, and remote host (it should be the IP of the computer where your IP is, 10.0.2.2 should work for MediaWiki-Vagrant) as needed.

Protokollierung
Für viel mehr Details musst du Fehler profilieren und protokollieren.



Wie man eine Debug-Protokolldatei einrichtet
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 :. Hier ist eine Beispieleinstellung:

Diese Datei wird viele Debuginformationen vom MediaWiki-Kern und Erweiterungen enthalten. Some subsystems write to custom logs, see #Creating a custom log file to capture their output.

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

Creating a custom log file
Prior to MediaWiki 1.32, to create a custom log file that only holds your specific debug statements, use the  function. 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. Siehe für weitere Informationen.

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. Siehe für weitere Informationen.

JavaScript error logging
See the documentation of the ResourceLoader module.

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

Anwendungsbeispiel:

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

Interactive shell
You can use as a PHP REPL with full access to MediaWiki internals.

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:

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.
 * ResourceLoader offers a means to ensure JavaScript is easily viewable by client-side tools.
 * Open your browser's console.
 * 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.
 * You can add  to your URL as in https://www.mediawiki.org/wiki/MediaWiki?debug=true to get more detailed information for debugging via your browser's console



Siehe auch

 * ResourceLoader: ResourceLoader/Developing with ResourceLoader#Debugging
 * All configuration variables related to debugging/logging: Manual:Configuration settings#Debug/logging
 * Useful debugging tip:  (dies with the given message and prints the callstack)
 * wikitech:Debugging in production - debugging on Wikimedia's production cluster
 * wikitech:Debugging in production - debugging on Wikimedia's production cluster
 * wikitech:Debugging in production - debugging on Wikimedia's production cluster