Debugging: Unterschied zwischen den Versionen

Version vom 19. April 2019, 12:31 Uhr

Als Administrator/in können Sie die Ausgabe von Debugging-Nachrichten auf der Seite Website-Administration (oder im Block Einstellungen) > Website-Administration) > Entwicklung > Debugging aktivieren.

Debugging-Nachrichten verwenden

Debugging-Nachrichten helfen bei der Analyse von Problemen oder Fehlern und sind für Entwickler/innen nützlich. Wenn Sie ein Problem mit Ihrer Moodle-Site haben und in einem der Support-Foren von moodle.org Hilfe suchen, kann es passieren, dass Entwickler/innen Sie bitten, das Debugging zu aktivieren, um mehr Informationen zur Analyse Ihres Problems zu erhalten. Standardmäßig werden in Moodle keinerlei Fehlerinformationen ausgegeben. Das Aktivieren des Debugging-Modus ist meistens ein erster Schritt zur Fehleranalyse- und behebung.

Debugging-Einstellungen

Für das Debugging können Sie folgende Einstellungen vornehmen:

Debug-Mitteilungen

Die Standardeinstellung ist KEINE: keine Fehlermeldungen oder Warnungen anzeigen. Weitere Optionen sind:

ALLE: alle notwendigen PHP-Debug-Mitteilungen anzeigen
MINIMAL: nur schwerwiegende Fehler anzeigen
NORMAL: Fehler, Warnungen und Bemerkungen anzeigen
DEVELOPER: besondere Moodle-Debug-Mitteilungen für Entwickler anzeigen

Es gibt selten Sitautionen, wo Sie den DEVELOPER-Modus benötigen, solange Sie nicht selbst als Entwickler/in arbeiten. Entwickler/innen sollten dagegen unbedingt die DEVELOPER-Option verwenden.

Wenn Sie eine Fehlermeldung in Moodle erhalten, kopieren und speichern Sie diese an einer geeigneten Stelle. Es wird dringend empfohlen, danach den Modus wieder auf KEINE zurückzustellen, da die Fehlermeldungen sonst Angriffsflächen für Hacker bieten.

Debug-Mitteilungen zum E-Mail-Versand

Wenn Sie diese Checkbox markieren, werden umfassende Debug-Mitteilungen beim E-Mail-Versand über den SMTP-Server erstellt.

More tools for debugging outgoing mail (SMTP)

You can also use the config.php file to turn on more "tools" which will assist you with debugging the outgoing emails (and SMTP server configuration):

Redirect all outgoing emails to a specific address:

// Divert all outgoing emails to this address to test and debug emailing features // $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!

Turn on the CRON debugging and run CLI cron.php script.

// Force developer level debug and add debug info to the output of cron // $CFG->showcrondebugging = true; And then use SSH (or putty.exe, on windows) to run: you@moodle-server(/var/www/html/moodle)# php admin/cli/cron.php

Turn on verbose SMTP debugging and output it into system's error_log (code hack):

As suggested on Moodle's discussion forums: Open lib/moodlelib.php L5379 and change it to: if (!empty($CFG->debugsmtp)) {

   $mailer->SMTPDebug = 1;  // 0 - no debug ... 4 - low level full debug
   $mailer->Debugoutput = "error_log";

} See more info about SMTPDebug parameters & Debugoutput parameters, Set-up mailcatcher (https://mailcatcher.me/).

Performance

wenn Sie diese Checkbox markieren, dann wird beim Standard-Design (und einigen anderen Designs) in der Fußzeile eine Information über die Geschwindigkeit angezeigt. Zu diesen Informationen gehören die Ladezeit für eine Moodle-Seite, der benötigte Speicherbedarf, die CPU-Last und eine Cache-Information.

Wenn Sie folgenden Code in Ihre Moodle-Konfigurationsdatei config.php einfügen, dann werden außerdem die Datenbankabfragen gezählt: define('MDL_PERF', true); define('MDL_PERFDB', true); define('MDL_PERFTOLOG', true); define('MDL_PERFTOFOOT', true);

Dieser Code gehört in die Konfigurationsdatei, weil Moodle Datnabnkabfragen durchführt, bevor die Konfigurationsinformation in die datenbank geladen wird.

Herkunft der Texte anzeigen

Diese Einstellung ist für Übersetzer/innen nützlich. Sometimes ?strings=1 should be added; other times &strings=1. See the Wikipedia article Query string for details.

Prüflinks anzeigen

Wenn Sie diese Checkbox markieren, werden Links zu externen Validierungsservern in der Fußzeile angezeigt. Möglicherweise müssen Sie einen neuen Nutzer mit dem Anmeldenamen w3cvalidator erstellen und den Gastzugang freischalten. Wenn Sie diese Funktionalität aktivieren, sind unauthorisierte Serverzugriffe erlaubt, deshalb wird vom Einsatz auf Produktivsystemen dringend abgeraten.

Seiteninformation anzeigen

Wenn Sie diese Checkbox markieren, werden Seiteninformationen in der Fußzeile angezeigt.

SQL-Abfragen debuggen

You can add (turn ON) any of the following dboptions in your config.php files, which log different types of SQL queries into mdl_log_queires table:

logall - log all queries - suitable only for developers, causes high server loads and NOT recommended for production.
logslow - log queries that take longer than specified number of seconds (float values are accepted).
logerrors - log all error queries.

Full sample: $CFG->dboptions = array (

 //'logall'   => true,
 'logslow'  => 5,
 'logerrors'  => true,

);

Was mache ich, wenn ich keinen Zugriff auf die Debugging-Seite habe?

Wenn Sie eine Fehlermeldung erhalten und gar nicht mehr auf die Debugging-Seite gelangen, um den Debug-Modus zu aktivieren, dann können Sie das Debugging auch manuell einschalten:

Direkt über die URL

Die Debugging-Seite erreichen Sie über die direkte URL http://.../admin/settings.php?section=debugging auf Ihrem Server. Manchmal funktioniert das, auch wenn Sie keinen Zugriff auf die Startseite und den Einstellungen-Block Ihrer Moodle-Site mehr haben.

In der Moodle-Konfigurationsdatei config.php

Ergänzen Sie folgende Zeilen in der Moodle-Konfigurationsdatei config.php:

// Force a debugging mode regardless the settings in the site administration // @error_reporting(1023); // NOT FOR PRODUCTION SERVERS! @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS! $CFG->debug = 38911; // DEBUG_DEVELOPER // NOT FOR PRODUCTION SERVERS! $CFG->debugdisplay = true; // NOT FOR PRODUCTION SERVERS!

// You can specify a comma separated list of user ids that that always see // debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay // for these users only. $CFG->debugusers = '2';

Denken Sie daran, diese Zeilen wieder zu löschen, sobald das Problem behoben ist!

In der Moodle-Datenbank

Mit Hilfe eines Werkzeugs wie phpMyAdmin führen Sie folgende SQL-Befehle aus:

UPDATE mdl_config SET value = 32767 WHERE name = 'debug'; UPDATE mdl_config SET value = 1 WHERE name = 'debugdisplay';

Um das Debugging nach der Problembehandlung wieder zu deaktivieren, verwenden Sie folgende SQL-Befehle:

UPDATE mdl_config SET value = 0 WHERE name = 'debug'; UPDATE mdl_config SET value = 0 WHERE name = 'debugdisplay';

(Wenn Ihre Datenbank ein anderes Präfix anstelle von mdl_ verwenden, müssen Sie die Befehle entsprechend anpassen.)

Siehe auch

Entwickler/innen können auch XDEBUG verwenden, um mit Hilfe einer XDEBUG Client Applikation tiefer in den Code einzudringen. XDEBUG wird als Module im Apache Webserver installiert wird.

Beispiele: NetBeans, phpStorm, ...

@@ Zeile 1: / Zeile 1: @@
-{{Überarbeiten}}{{Entwicklerwerkzeuge}}
+{{Entwicklerwerkzeuge}}
 Als Administrator/in können Sie die Ausgabe von Debugging-Nachrichten auf der Seite ''Website-Administration'' (oder im Block ''[[Einstellungen-Block|Einstellungen]]) > Website-Administration'')'' > Entwicklung > Debugging'' aktivieren.
+==Debugging-Nachrichten verwenden==
 Debugging-Nachrichten helfen bei der Analyse von Problemen oder Fehlern und sind für Entwickler/innen nützlich. Wenn Sie ein Problem mit Ihrer Moodle-Site haben und in einem der Support-Foren von moodle.org Hilfe suchen, kann es passieren, dass Entwickler/innen Sie bitten, das Debugging zu aktivieren, um mehr Informationen zur Analyse Ihres Problems zu erhalten. Standardmäßig werden in Moodle keinerlei Fehlerinformationen ausgegeben. Das Aktivieren des Debugging-Modus ist meistens ein erster Schritt zur Fehleranalyse- und behebung.
 ==Debugging-Einstellungen==
 Für das Debugging können Sie folgende Einstellungen vornehmen:
-===Debug-Meldungen===
+===Debug-Mitteilungen===
 Die Standardeinstellung ist ''KEINE: keine Fehlermeldungen oder Warnungen anzeigen''. Weitere Optionen sind:
@@ Zeile 21: / Zeile 21: @@
 Wenn Sie eine Fehlermeldung in Moodle erhalten, kopieren und speichern Sie diese an einer geeigneten Stelle. Es wird dringend empfohlen, danach den Modus wieder auf KEINE zurückzustellen, da die Fehlermeldungen sonst Angriffsflächen für Hacker bieten.
-===Debug-Mitteilungen anzeigen===
+===Debug-Mitteilungen zum E-Mail-Versand===
-Wenn Sie diese Checkbox markieren, werden die Debug-Mitteilungen direkt im Browser angezeigt, andernfalls werden sie in den Server Logs gespeichert.
+Wenn Sie diese Checkbox markieren, werden umfassende Debug-Mitteilungen beim E-Mail-Versand über den SMTP-Server erstellt.
-===XML strict Header===
+==== More tools for debugging outgoing mail (SMTP) ====
-Wenn Sie diese Checkbox markieren, werden auf jeder Seite XML HTTP Header und Prologs erstellt. Der Browser zeigt dann XHTML Fehlermeldungen an. Diese Funktion ist nur für Entwickler/innen gedacht.
+You can also use the config.php file to turn on more "tools" which will assist you with debugging the outgoing emails (and SMTP server configuration):
+* Redirect all outgoing emails to a specific address:
+<code php>
+// Divert all outgoing emails to this address to test and debug emailing features
+// $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
+</code>
-===Debug E-Mail versenden===
+* Turn on the CRON debugging and run CLI cron.php script.
-Wenn Sie diese Checkbox markieren, werden umfassende Debug-Mitteilungen beim E-Mail-Versand über den SMTP-Server erstellt.
+<code php>
+// Force developer level debug and add debug info to the output of cron
+// $CFG->showcrondebugging = true;
+</code>
+And then use SSH (or putty.exe, on windows) to run:
+<code php>
+you@moodle-server(/var/www/html/moodle)# php admin/cli/cron.php
+</code>
+* Turn on verbose SMTP debugging and output it into system's error_log (code hack):
+As [https://moodle.org/mod/forum/discuss.php?d=316222#p1289850 suggested] on Moodle's discussion forums:
+Open [https://github.com/moodle/moodle/blob/master/lib/moodlelib.php#L5379 lib/moodlelib.php L5379] and change it to:
+<code php>
+if (!empty($CFG->debugsmtp)) {
+    $mailer->SMTPDebug = 1;  // 0 - no debug ... 4 - low level full debug
+    $mailer->Debugoutput = "error_log";
+}
+</code>
+See more info about [https://github.com/moodle/moodle/blob/master/lib/phpmailer/class.phpmailer.php#L314 SMTPDebug] parameters & [https://github.com/moodle/moodle/blob/master/lib/phpmailer/class.phpmailer.php#L328 Debugoutput] parameters,
+Set-up mailcatcher (https://mailcatcher.me/).
-===Geschwindigkeitsinformationen===
+===Performance===
 wenn Sie diese Checkbox markieren, dann wird beim Standard-Design (und einigen anderen Designs) in der Fußzeile eine Information über die Geschwindigkeit angezeigt. Zu diesen Informationen gehören die Ladezeit für eine Moodle-Seite, der benötigte Speicherbedarf, die CPU-Last und eine Cache-Information.
@@ Zeile 43: / Zeile 67: @@
 Dieser Code gehört in die Konfigurationsdatei, weil Moodle Datnabnkabfragen durchführt, bevor die Konfigurationsinformation in die datenbank geladen wird.
-===Originaltexte anzeigen===
+===Herkunft der Texte anzeigen===
-Diese Einstellung ist für Übersetzer/innen nützlich.
+Diese Einstellung ist für Übersetzer/innen nützlich. Sometimes <code>?strings=1</code> should be added; other times <code>&strings=1</code>. See the Wikipedia article [http://en.wikipedia.org/wiki/Query_string Query string] for details.
 ===Prüflinks anzeigen===
@@ Zeile 51: / Zeile 75: @@
 ===Seiteninformation anzeigen===
 Wenn Sie diese Checkbox markieren, werden Seiteninformationen in der Fußzeile angezeigt.
+===SQL-Abfragen debuggen===
+You can add (turn ON) any of the following dboptions in your config.php files, which log different types of SQL queries into mdl_log_queires table:
+* '''logall''' - log all queries - suitable only for developers, causes high server loads and NOT recommended for production.
+* '''logslow''' - log queries that take longer than specified number of seconds (float values are accepted).
+* '''logerrors''' - log all error queries.
+Full sample:
+<code php>
+$CFG->dboptions = array (
+  //'logall'  => true,
+  'logslow'  => 5,
+  'logerrors'  => true,
+);
+</code>
 ==Was mache ich, wenn ich keinen Zugriff auf die Debugging-Seite habe?==

Documentation