Handbuch:Wie man debuggt

From mediawiki.org
This page is a translated version of the page Manual:How to debug and the translation is 63% complete.
Languages:

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 existieren mehrere Konfigurationsoptionen, die die Fehlersuche erleichtern. Die folgenden sind standardmäßig alle false. Aktiviere diese, indem du sie in deiner LocalSettings.php auf true festlegst:

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

Beispielzeile, die du in deine LocalSettings.php einfügen kannst: 

$wgShowExceptionDetails = true;

PHP-Fehler

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

error_reporting( -1 );
ini_set( 'display_errors', 1 );

Oder setze es in php.ini : 

error_reporting = E_ALL
display_errors = On

Oder setze es in .htaccess: 

php_value error_reporting -1
php_flag display_errors On

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 verhindern, dass sie angezeigt werden. Fatale PHP-Fehler werden normalerweise im Apache-Fehlerprotokoll protokolliert - Überprüfe die Einstellung error_log in der php.ini (oder verwende phpinfo()).

display_startup_errors einschalten

Einige Anbieter schalten display_startup_errors ab, wodurch die Fehler verborgen bleiben, auch wenn du den error_reporting-Level 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 das einfach zu mediawiki/index.php hinzufügen: 

--- index.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );

In mother embrion mers: 

--- myTestFile.php
    error_reporting( -1 );
    ini_set( 'display_startup_errors', 1 );
    ini_set( 'display_errors', 1 );
    require 'your_file.php';

SQL-Fehler

Um alle SQL-Abfragen zu protokollieren und nicht nur diejenige, die die Ausnahme ausgelöst hat, lege $wgDebugDumpSql in LocalSettings.php fest: 

$wgDebugDumpSql = true;
MediaWiki Versions:
1.16 – 1.31

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

$wgShowSQLErrors = true;
$wgShowDBErrorBacktrace = true;

Eingehendes Debugging

Debugger

Du kannst deinen Code Schritt für Schritt mit XDebug debuggen. Einige gängige Konfigurationen findest du unter

MediaWiki-Vagrant verfügt über eingebaute Einstellungen für diesen Zweck. Wenn du nicht MediaWiki-Vagrant verwendest, dein Setup jedoch ähnlich ist, kannst du diese Werte wiederverwenden. In manchen Fällen (z. B. aufgrund einer Firewall) musst du die IDE auf demselben Rechner verwenden wie den Webserver. In diesem Fall kannst du einfach festlegen: 

xdebug.remote_enable = 1
xdebug.remote_host = 'localhost'

Weitere Informationen findest du in der XDebug-Dokumentation.

Um ein Kommandozeilenskript (z.B. PHPUnit oder ein Wartungsskript) auf MediaWiki-Vagrant zu debuggen, verwendest du: 

xdebug_on; php /vagrant/mediawiki/path/to/script.php --wiki=wiki ; xdebug_off

Passe das Skript, die Parameter und den Remote-Host (es sollte die IP des Computers sein, auf dem sich deine IP befindet, 10.0.2.2 sollte für MediaWiki-Vagrant funktionieren) nach Bedarf an.

Protokollierung

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

Die Anweisungen unten sind nur für die Standardkonfiguration gültig. Wenn du $wgMWLoggerDefaultSpi änderst, um zum Beispiel die Rolle psr3 auf einer vagrant -Box zu aktivieren, werden diese Einstellungen wahrscheinlich ignoriert. Siehe in diesen Fall die Dokumentation deines Loggers nach, zum Beispiel Manual:MonologSpi .

Wie man eine Debug-Protokolldatei einrichtet

Um Fehler und Debugging-Informationen in einem Protokoll zu speichern, füge $wgDebugLogFile zur Datei LocalSettings.php hinzu. Ändere den Wert in eine Textdatei, in der du die Debug-Trace-Ausgabe speichern möchtest.

Die MediaWiki-Software muss über die Berechtigungen deines Betriebssystems verfügen, um diese Datei zu erstellen und zu schreiben. In einer Standard-Ubuntu-Installation wird sie zum Beispiel als Benutzer & Gruppe www-data:www-data ausgeführt. Hier ist eine Beispieleinstellung: 

/**
 * The debug log file must never be publicly accessible because it contains private data.
 * But ensure that the directory is writeable by the PHP script running within your Web server.
 * The filename is with the database name of the wiki.
 */
$wgDebugLogFile = "/var/log/mediawiki/debug-{$wgDBname}.log";

Diese Datei wird viele Debuginformationen vom MediaWiki-Kern und Erweiterungen enthalten. Einige Subsysteme schreiben in benutzerdefinierte Logs, siehe #Erstellen einer benutzerdefinierten Logdatei, um ihre Ausgaben zu erfassen.


Warnung Warnung: Die Debug-Protokolldatei kann private Informationen wie Anmeldedaten, Sitzungscookies und Werte von eingereichten Formularen enthalten. Wenn diese Informationen öffentlich zugänglich sind, können Angreifer sie verwenden, um deinen Computer und dein Benutzerkonto zu hacken und zu kompromittieren. Wenn du ein Debug-Protokoll zu Diagnosezwecken weitergeben musst, greife auf das Wiki zu, ohne eingeloggt zu sein, und entferne aus dem Debug-Protokoll alle COOKIE-Zeilen und erfasse keine Anmeldeversuche.

Erstellen einer benutzerdefinierten Protokolldatei

MediaWiki Version:
≤ 1.31

Vor MediaWiki 1.32 konntest du die wfErrorLog()-Funktion verwenden, um eine benutzerdefinierte Protokolldatei zu erstellen, die nur deine spezifischen Debug-Anweisungen enthält. Diese Funktion benötigt zwei Argumente: die zu protokollierende Zeichenkette und den Pfad zur Protokolldatei: 

wfErrorLog( "An error occurred.\n", '/var/log/mediawiki/my-custom-debug.log' );

Erstellen von benutzerdefinierten Protokollgruppen

Wenn du mehrere verschiedene Komponenten debuggst, kann es sinnvoll sein, bestimmte Log-Gruppen anzuweisen, in eine separate Datei zu schreiben. Siehe $wgDebugLogGroups für weitere Informationen.

Um benutzerdefinierte Log-Gruppen festzulegen, verwende die folgende Zeile in der LocalSettings.php: 

/**
 * The debug log file should not be publicly accessible if it is used, as it
 * may contain private data. However, it must be in a directory to which PHP run
 * within your web server can write.
 *
 * Contrary to wgDebugLogFile, it is not necessary to include a wiki-id in these log file names
 * if you have multiple wikis. These log entries are prefixed with sufficient information to
 * identify the relevant wiki (web server hostname and wiki-id).
 */

// Groups from MediaWiki core
$wgDBerrorLog = '/var/log/mediawiki/dberror.log';
$wgDebugLogGroups = array(
	'exception' => '/var/log/mediawiki/exception.log',
	'resourceloader' => '/var/log/mediawiki/resourceloader.log',
	'ratelimit' => '/var/log/mediawiki/ratelimit.log',

	// Extra log groups from your extension
	#'myextension' => '/var/log/mediawiki/myextension.log',
	#'somegroup' => '/var/log/mediawiki/somegroup.log',
);

Um eine dieser Gruppen zu loggen, rufe wfDebugLog wie folgt auf: 

if ( $module->hasFailed ) {
    wfDebugLog( 'myextension', "Something is not right, module {$module->name} failed." );
}
Wenn du die obigen Anweisungen sorgfältig befolgt hast, jedoch nichts in deine Protokolldatei(en) geschrieben wird, und wenn dein System SELinux verwendet, wirf einen Blick auf den Logging-Abschnitt auf der SELinux-Seite, um dieses SELinux-Kontextproblem zu umgehen.
Das Schreiben von Logdateien in das Verzeichnis /tmp kann dazu führen, dass überhaupt keine Logdatei erzeugt wird, auch wenn das Verzeichnis /tmp für jeden beschreibbar sein soll. This could happen if your system is using one of the systemd features that create a virtual /tmp directory for that process. If that's the case, configure your log file to be written into a different directory, like /var/log/mediawiki

Structured logging

MediaWiki Version:
≥ 1.25

Structured logging allows you to include fields in your log records. Siehe Structured logging für weitere Informationen.

You will need to configure a better logger to collect the extra fields, for example Monolog.

JavaScript error logging

MediaWiki Version:
≥ 1.36

See the documentation of the mediawiki.errorLogger ResourceLoader module.

Statistiken

Advanced client-side logging can be performed with Erweiterung:EventLogging , 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: 

$stats = $context->getStats();
$stats->increment( 'resourceloader.cache.hits' );
$stats->timing( 'resourceloader.cache.rtt', $rtt );

The metrics can be sent to a StatsD server, which may be specified via the wgStatsdServer 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, wfIncrStats() is a shortcut for the increment() method on the main RequestContext::getStats() 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. 

$wgDebugComments = true;

Working live with MediaWiki objects

eval.php 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 MediaWiki-Vagrant portable virtual machine integrates the interactive PHP shell phpsh (when using Zend).

Callable updates

Code embedded in the DeferredUpdates::addCallableUpdate() function, such as $rc->save() in RecentChange.php, 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 shell.php 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:

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

Siehe auch

  • Useful debugging tip: throw new MWException( 'foo' ); (dies with the given message and prints the callstack)
Retrieved from "https://www.mediawiki.org/w/index.php?title=Manual:How_to_debug/de&oldid=6348263"