Debugging - Revision history

Tim@horizoneducationnetwork.org: /* Debug SQL queries */ clean up, typos fixed: techncially → technically

2024-11-14T16:43:32Z

Debug SQL queries: clean up, typos fixed: techncially → technically

← Older revision		Revision as of 16:43, 14 November 2024
Line 87:		Line 87:
	'logerrors' => true,		'logerrors' => true,
	);		);
	</syntaxhighlight>However, if you are in control of your Database server, your database probably has an option to log slow database queries in the database logs, and that is probably a ~~techncially~~ better solution, if it is available to you.		</syntaxhighlight>However, if you are in control of your Database server, your database probably has an option to log slow database queries in the database logs, and that is probably a technically better solution, if it is available to you.
	==What to do if you cannot get to the admin screens==		==What to do if you cannot get to the admin screens==
	If the error is stopping you even getting to the admin screens to turn on debugging, then you can set the debugging setting manually.		If the error is stopping you even getting to the admin screens to turn on debugging, then you can set the debugging setting manually.

Marycooch: removd

2024-02-07T20:58:11Z

removd

← Older revision		Revision as of 20:58, 7 February 2024
Line 16:		Line 16:
	===Display debug messages===		===Display debug messages===
	If you select this checkbox, the debug messages are displayed directly in the browser, otherwise they are stored in the server logs.		If you select this checkbox, the debug messages are displayed directly in the browser, otherwise they are stored in the server logs.
	~~===Debug email sending===~~
	~~Determines whether or not to enable verbose debug information during sending of email messages to SMTP server.~~		==== Debug outgoing mail (SMTP) ====
	==== ~~More tools for debugging~~ outgoing mail (SMTP) ====		You can use the config.php file to turn on more "tools" which will assist you with debugging the outgoing emails (and SMTP server configuration):
	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:		* Redirect all outgoing emails to a specific address:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 45:		Line 44:
	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,		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/).		Set-up mailcatcher (https://mailcatcher.me/).

	===Performance info===		===Performance info===
	The Performance info option determines whether performance info will be included in the footer of the standard theme (and some other themes). Performance info includes the time for the page to load, the amount of memory used to generate the page, cpu usage, load, and the record cache hit/miss ration.		The Performance info option determines whether performance info will be included in the footer of the standard theme (and some other themes). Performance info includes the time for the page to load, the amount of memory used to generate the page, cpu usage, load, and the record cache hit/miss ration.

Tsala: /* Show template information */ requirement to purge caches, warning about breaking core functionality

2024-01-15T10:08:09Z

Show template information: requirement to purge caches, warning about breaking core functionality

← Older revision		Revision as of 10:08, 15 January 2024
Line 67:		Line 67:
	To show page information printed in the page footer.		To show page information printed in the page footer.
	===Show template information===		===Show template information===
	To ~~shown~~ templates used for rendering as comments in the page HTML.		To show templates used for rendering as comments in the page HTML. After changing the setting, you need to purge caches for the change to take effect.

	Example of how the templates are shown in the page HTML source:<syntaxhighlight lang="html">		Example of how the templates are shown in the page HTML source:<syntaxhighlight lang="html">
	<!-- template(PHP): core/pix_icon_fontawesome -->		<!-- template(PHP): core/pix_icon_fontawesome -->
	<i class="icon fa fa-window-close fa-fw " aria-hidden="true"></i>		<i class="icon fa fa-window-close fa-fw " aria-hidden="true"></i>
	<!-- /template(PHP): core/pix_icon_fontawesome -->		<!-- /template(PHP): core/pix_icon_fontawesome -->
	</syntaxhighlight>It is important to note the added comments can interfere with some scripts.		</syntaxhighlight>It is important to note the added comments can interfere with some scripts and can even break core functionality!

	===Debug SQL queries===		===Debug SQL queries===

Tsala: /* Show template information */

2023-09-15T13:31:03Z

Show template information

← Older revision		Revision as of 13:31, 15 September 2023
Line 67:		Line 67:
	To show page information printed in the page footer.		To show page information printed in the page footer.
	===Show template information===		===Show template information===
	~~{{New features}}~~To shown templates used for rendering as comments in the page HTML.		To shown templates used for rendering as comments in the page HTML.
	Example of how the templates are shown in the page HTML source:<syntaxhighlight lang="html">		Example of how the templates are shown in the page HTML source:<syntaxhighlight lang="html">
	<!-- template(PHP): core/pix_icon_fontawesome -->		<!-- template(PHP): core/pix_icon_fontawesome -->

Tusefomal: Add example of show template information.

2023-08-23T15:31:48Z

Add example of show template information.

← Older revision		Revision as of 15:31, 23 August 2023
Line 60:		Line 60:
	===Show origin of languages strings===		===Show origin of languages strings===
	Helps with [[:dev:Translation\|translation]] and also with [[Language customization]]. 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.		Helps with [[:dev:Translation\|translation]] and also with [[Language customization]]. 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.

	=== Show origin of SQL calls ===		=== Show origin of SQL calls ===
	If you turn this on, then for every bit of SQL send to the Database server, an SQL comment is added with all or part of the PHP stack trace. That means that if something happens which causes the query to be logged by the database (e.g. and error, or a slow query) you can find where in Moodle that query came from.		If you turn this on, then for every bit of SQL send to the Database server, an SQL comment is added with all or part of the PHP stack trace. That means that if something happens which causes the query to be logged by the database (e.g. and error, or a slow query) you can find where in Moodle that query came from.
Line 69:		Line 68:
	===Show template information===		===Show template information===
	{{New features}}To shown templates used for rendering as comments in the page HTML.		{{New features}}To shown templates used for rendering as comments in the page HTML.
			Example of how the templates are shown in the page HTML source:<syntaxhighlight lang="html">
			<!-- template(PHP): core/pix_icon_fontawesome -->
			<i class="icon fa fa-window-close fa-fw " aria-hidden="true"></i>
			<!-- /template(PHP): core/pix_icon_fontawesome -->
			</syntaxhighlight>It is important to note the added comments can interfere with some scripts.

	===Debug SQL queries===		===Debug SQL queries===
	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_queries table:		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_queries table:
Line 82:		Line 87:
	);		);
	</syntaxhighlight>However, if you are in control of your Database server, your database probably has an option to log slow database queries in the database logs, and that is probably a techncially better solution, if it is available to you.		</syntaxhighlight>However, if you are in control of your Database server, your database probably has an option to log slow database queries in the database logs, and that is probably a techncially better solution, if it is available to you.

	==What to do if you cannot get to the admin screens==		==What to do if you cannot get to the admin screens==
	If the error is stopping you even getting to the admin screens to turn on debugging, then you can set the debugging setting manually.		If the error is stopping you even getting to the admin screens to turn on debugging, then you can set the debugging setting manually.

Timhunt: Documenting 'Show origin of SQL calls'

2023-08-22T21:45:11Z

Documenting 'Show origin of SQL calls'

Show changes

Tsala: Show template information (MDL-77182)

2023-08-22T12:22:04Z

Show template information (MDL-77182)

← Older revision		Revision as of 12:22, 22 August 2023
Line 85:		Line 85:
	===Show page information===		===Show page information===
	To show page information printed in the page footer.		To show page information printed in the page footer.

			===Show template information===
			{{New features}}To shown templates used for rendering as comments in the page HTML.

	===Debug SQL queries===		===Debug SQL queries===

Leonstr: Changed `to`


2021-07-27T12:35:33Z
Changed <code> to <syntaxhighlight>

				
				
				
				
				
				← Older revision
				Revision as of 12:35, 27 July 2021
				
Line 34:
Line 34:
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): 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: * Redirect all outgoing emails to a specific address:
<code php> <syntaxhighlight lang="php">
// Divert all outgoing emails to this address to test and debug emailing features // Divert all outgoing emails to this address to test and debug emailing features
// $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS! // $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
</code> </syntaxhighlight>



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



* Turn on verbose SMTP debugging and output it into system's error_log (code hack): * 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: 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: Open [https://github.com/moodle/moodle/blob/master/lib/moodlelib.php#L5379 lib/moodlelib.php L5379] and change it to:
<code php> <syntaxhighlight lang="php">
if (!empty($CFG->debugsmtp)) { if (!empty($CFG->debugsmtp)) {
     $mailer->SMTPDebug = 1;  // 0 - no debug ... 4 - low level full debug      $mailer->SMTPDebug = 1;  // 0 - no debug ... 4 - low level full debug
     $mailer->Debugoutput = "error_log";      $mailer->Debugoutput = "error_log";
} }
</code> </syntaxhighlight>
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, 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/). Set-up mailcatcher (https://mailcatcher.me/).
Line 66:
Line 66:



If you add If you add
<code php> <syntaxhighlight lang="php">
define('MDL_PERF', true); define('MDL_PERF', true);
define('MDL_PERFDB', true); define('MDL_PERFDB', true);
define('MDL_PERFTOLOG', true); define('MDL_PERFTOLOG', true);
define('MDL_PERFTOFOOT', true); define('MDL_PERFTOFOOT', true);
</code> </syntaxhighlight>
to your config.php file, then it will also count database queries. (This has to be in config.php, because Moodle starts doing DB queries before it loads the config information in the database!) to your config.php file, then it will also count database queries. (This has to be in config.php, because Moodle starts doing DB queries before it loads the config information in the database!)



Line 93:
Line 93:



Full sample: Full sample:
<code php> <syntaxhighlight lang="php">
$CFG->dboptions = array ( $CFG->dboptions = array (
   //'logall'   => true,    //'logall'   => true,
Line 99:
Line 99:
   'logerrors'  => true,    'logerrors'  => true,
); );
</code> </syntaxhighlight>



==What to do if you cannot get to the admin screens== ==What to do if you cannot get to the admin screens==
Line 113:
Line 113:
In [[Configuration file|config.php]] you can uncomment lines (delete the // at the start of the line) under Section 7 to enable debugging for all or just specific users: In [[Configuration file|config.php]] you can uncomment lines (delete the // at the start of the line) under Section 7 to enable debugging for all or just specific users:



<code php> <syntaxhighlight lang="php">
//========================================================================= //=========================================================================
// 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!! // 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
Line 128:
Line 128:
// for these users only. // for these users only.
// $CFG->debugusers = '2'; // $CFG->debugusers = '2';
</code> </syntaxhighlight>



Remember to comment those lines again (reinsert the // at the start of the line) when you have finished diagnosing your problem. Remember to comment those lines again (reinsert the // at the start of the line) when you have finished diagnosing your problem.



Drcuriosity: Added a note about debugging() for developers, since it was hard to find details in search.
2021-06-03T05:15:45Z
Added a note about debugging() for developers, since it was hard to find details in search.

				
				
				
				
				
				← Older revision
				Revision as of 05:15, 3 June 2021
				
Line 138:
Line 138:
==See also== ==See also==



* If you are a developer looking for usage information on the <tt>debugging()</tt> statement, try lib/weblib.php for documentation on how it is used, and lib/setuplib.php for definitions of which PHP error levels the <tt>DEBUG_*</tt> flags map to.
* Developers can also use [http://xdebug.org/ XDEBUG] (Installed as a module on the Apache server) to further dig into the code, step by step using an [http://xdebug.org/docs/remote XDEBUG client application]. Probably, as part of their favorite IDE. For example: [http://php.netbeans.org/ NetBeans], [http://www.jetbrains.com/phpstorm/ phpStorm] or... * Developers can also use [http://xdebug.org/ XDEBUG] (Installed as a module on the Apache server) to further dig into the code, step by step using an [http://xdebug.org/docs/remote XDEBUG client application]. Probably, as part of their favorite IDE. For example: [http://php.netbeans.org/ NetBeans], [http://www.jetbrains.com/phpstorm/ phpStorm] or...




[[es:Depuración]] [[es:Depuración]]
[[fr:Débogage]] [[fr:Débogage]]
[[de:Debugging]] [[de:Debugging]]



Danielneis: fix typo
2021-04-16T20:23:59Z
fix typo

				
				
				
				
				
				← Older revision
				Revision as of 20:23, 16 April 2021
				
Line 87:
Line 87:



===Debug SQL queries=== ===Debug SQL queries===
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: 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_queries table:
* '''logall''' - log all queries - suitable only for developers, causes high server loads and NOT recommended for production. * '''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). * '''logslow''' - log queries that take longer than specified number of seconds (float values are accepted).

← Older revision		Revision as of 12:35, 27 July 2021
Line 34:		Line 34:
	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):		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:		* Redirect all outgoing emails to a specific address:
	<~~code~~ php>		<syntaxhighlight lang="php">
	// Divert all outgoing emails to this address to test and debug emailing features		// Divert all outgoing emails to this address to test and debug emailing features
	// $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!		// $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
	</~~code~~>		</syntaxhighlight>

	* Turn on the CRON debugging and run CLI cron.php script.		* Turn on the CRON debugging and run CLI cron.php script.
	<~~code~~ php>		<syntaxhighlight lang="php">
	// Force developer level debug and add debug info to the output of cron		// Force developer level debug and add debug info to the output of cron
	// $CFG->showcrondebugging = true;		// $CFG->showcrondebugging = true;
	</~~code~~>		</syntaxhighlight>
	And then use SSH (or putty.exe, on windows) to run:		And then use SSH (or putty.exe, on windows) to run:
	<~~code~~ php>		<syntaxhighlight lang="php">
	you@moodle-server(/var/www/html/moodle)# php admin/cli/cron.php		you@moodle-server(/var/www/html/moodle)# php admin/cli/cron.php
	</~~code~~>		</syntaxhighlight>

	* Turn on verbose SMTP debugging and output it into system's error_log (code hack):		* 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:		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:		Open [https://github.com/moodle/moodle/blob/master/lib/moodlelib.php#L5379 lib/moodlelib.php L5379] and change it to:
	<~~code~~ php>		<syntaxhighlight lang="php">
	if (!empty($CFG->debugsmtp)) {		if (!empty($CFG->debugsmtp)) {
	$mailer->SMTPDebug = 1; // 0 - no debug ... 4 - low level full debug		$mailer->SMTPDebug = 1; // 0 - no debug ... 4 - low level full debug
	$mailer->Debugoutput = "error_log";		$mailer->Debugoutput = "error_log";
	}		}
	</~~code~~>		</syntaxhighlight>
	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,		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/).		Set-up mailcatcher (https://mailcatcher.me/).
Line 66:		Line 66:

	If you add		If you add
	<~~code~~ php>		<syntaxhighlight lang="php">
	define('MDL_PERF', true);		define('MDL_PERF', true);
	define('MDL_PERFDB', true);		define('MDL_PERFDB', true);
	define('MDL_PERFTOLOG', true);		define('MDL_PERFTOLOG', true);
	define('MDL_PERFTOFOOT', true);		define('MDL_PERFTOFOOT', true);
	</~~code~~>		</syntaxhighlight>
	to your config.php file, then it will also count database queries. (This has to be in config.php, because Moodle starts doing DB queries before it loads the config information in the database!)		to your config.php file, then it will also count database queries. (This has to be in config.php, because Moodle starts doing DB queries before it loads the config information in the database!)

Line 93:		Line 93:

	Full sample:		Full sample:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$CFG->dboptions = array (		$CFG->dboptions = array (
	//'logall' => true,		//'logall' => true,
Line 99:		Line 99:
	'logerrors' => true,		'logerrors' => true,
	);		);
	</~~code~~>		</syntaxhighlight>

	==What to do if you cannot get to the admin screens==		==What to do if you cannot get to the admin screens==
Line 113:		Line 113:
	In [[Configuration file\|config.php]] you can uncomment lines (delete the // at the start of the line) under Section 7 to enable debugging for all or just specific users:		In [[Configuration file\|config.php]] you can uncomment lines (delete the // at the start of the line) under Section 7 to enable debugging for all or just specific users:

	<~~code~~ php>		<syntaxhighlight lang="php">
	//=========================================================================		//=========================================================================
	// 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!		// 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
Line 128:		Line 128:
	// for these users only.		// for these users only.
	// $CFG->debugusers = '2';		// $CFG->debugusers = '2';
	</~~code~~>		</syntaxhighlight>

	Remember to comment those lines again (reinsert the // at the start of the line) when you have finished diagnosing your problem.		Remember to comment those lines again (reinsert the // at the start of the line) when you have finished diagnosing your problem.

← Older revision		Revision as of 05:15, 3 June 2021
Line 138:		Line 138:
	==See also==		==See also==

			* If you are a developer looking for usage information on the <tt>debugging()</tt> statement, try lib/weblib.php for documentation on how it is used, and lib/setuplib.php for definitions of which PHP error levels the <tt>DEBUG_*</tt> flags map to.
	* Developers can also use [http://xdebug.org/ XDEBUG] (Installed as a module on the Apache server) to further dig into the code, step by step using an [http://xdebug.org/docs/remote XDEBUG client application]. Probably, as part of their favorite IDE. For example: [http://php.netbeans.org/ NetBeans], [http://www.jetbrains.com/phpstorm/ phpStorm] or...		* Developers can also use [http://xdebug.org/ XDEBUG] (Installed as a module on the Apache server) to further dig into the code, step by step using an [http://xdebug.org/docs/remote XDEBUG client application]. Probably, as part of their favorite IDE. For example: [http://php.netbeans.org/ NetBeans], [http://www.jetbrains.com/phpstorm/ phpStorm] or...


	[[es:Depuración]]		[[es:Depuración]]
	[[fr:Débogage]]		[[fr:Débogage]]
	[[de:Debugging]]		[[de:Debugging]]

← Older revision		Revision as of 20:23, 16 April 2021
Line 87:		Line 87:

	===Debug SQL queries===		===Debug SQL queries===
	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:		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_queries table:
	* '''logall''' - log all queries - suitable only for developers, causes high server loads and NOT recommended for production.		* '''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).		* '''logslow''' - log queries that take longer than specified number of seconds (float values are accepted).