Debugging - Revision history

Nadavkav: /* More tools for debugging outgoing mail */

2018-06-12T13:13:15Z

More tools for debugging outgoing mail

← Older revision		Revision as of 13:13, 12 June 2018
Line 27:		Line 27:
	Determines whether or not to enable verbose debug information during sending of email messages to SMTP server.		Determines whether or not to enable verbose debug information during sending of email messages to SMTP server.

	==== More tools for debugging outgoing mail ====		==== 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):		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:

Nadavkav: /* More tools for debugging outgoing mail */

2018-06-12T13:12:45Z

More tools for debugging outgoing mail

← Older revision		Revision as of 13:12, 12 June 2018
Line 54:		Line 54:
	}		}
	</code>		</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		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/).

	===Performance info===		===Performance info===

Tsala: rewording

2017-12-11T13:20:24Z

rewording

← Older revision		Revision as of 13:20, 11 December 2017
Line 2:		Line 2:
	==Using debugging messages==		==Using debugging messages==

	Debugging messages are intended to help diagnose problems and/or help Moodle developers. If you have a problem with your Moodle site and ask for help in a Moodle.org forum, a developer may ask you to turn ~~debug~~ messages on, in order to locate the cause of the problem~~. By default Moodle does not show any error messages at all~~. If you are having problems ~~(e.g.~~ blank ~~screens~~ or incomplete screens) turning on debugging is usually the first thing to try.		Debugging messages are intended to help diagnose problems and/or help Moodle developers. If you have a problem with your Moodle site and ask for help in a Moodle.org forum, a developer may ask you to turn enable debugging i.e. turn debugging messages on, in order to locate the cause of the problem. If you are having problems such as a blank screen or incomplete screens, then turning on debugging is usually the first thing to try.

	==~~Debugging settings~~==		==Enabling debugging==

	~~Debugging messages can be enabled by an administrator in~~ Debugging in the Site administration.		To enable debugging, go to Debugging in the Site administration.

	===Debug ~~messages and display debug~~ messages===		===Debug messages===

	The options are:		The options are:

Tsala: hiding performance info from ordinary users

2017-09-07T14:43:17Z

hiding performance info from ordinary users

← Older revision		Revision as of 14:43, 7 September 2017
Line 67:		Line 67:
	define('MDL_PERFTOFOOT', true);		define('MDL_PERFTOFOOT', true);
	</code>		</code>
	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!)

			To hide performance info from ordinary users, see the discussion [https://moodle.org/mod/forum/discuss.php?d=358032 Performance info only for admins?]

	===Show origin of language strings===		===Show origin of language strings===

Tsala: recommendation thanks to David Mudrak about keeping a record of error messages

2017-06-08T09:30:43Z

recommendation thanks to David Mudrak about keeping a record of error messages

← Older revision		Revision as of 09:30, 8 June 2017
Line 1:		Line 1:
	{{Developer tools}}		{{Developer tools}}
	~~Debugging~~ messages ~~can be enabled by an administrator in ''Administration > Site administration > Development > Debugging''.~~		==Using debugging messages==

	Debugging messages are intended to help diagnose problems and/or help Moodle developers. If you have a problem with your Moodle site and ask for help in a Moodle.org forum, a developer may ask you to turn debug messages on, in order to locate the cause of the problem. By default Moodle does not show any error messages at all. If you are having problems (e.g. blank screens or incomplete screens) turning on debugging is usually the first thing to try.		Debugging messages are intended to help diagnose problems and/or help Moodle developers. If you have a problem with your Moodle site and ask for help in a Moodle.org forum, a developer may ask you to turn debug messages on, in order to locate the cause of the problem. By default Moodle does not show any error messages at all. If you are having problems (e.g. blank screens or incomplete screens) turning on debugging is usually the first thing to try.

	==Debugging settings==		==Debugging settings==
	~~Here are the settings on the Debugging page:~~

	===Debug messages===		Debugging messages can be enabled by an administrator in Debugging in the Site administration.

			===Debug messages and display debug messages===

	The options are:		The options are:
Line 17:		Line 18:
	* DEVELOPER: extra Moodle debug messages for developers		* DEVELOPER: extra Moodle debug messages for developers

	There is rarely any advantage in going to Developer level, unless you are a developer, in which case it is strongly recommended. Once you have got the error message, and copied and pasted it somewhere. HIGHLY RECOMMENDED to turn Debug back to NONE. Debug messages can give clues to a hacker as to the setup of your site.		Notes:

	~~===Display debug messages===~~

	~~There~~ is ~~an option~~ to ~~choose whether~~ to ~~display error~~ messages ~~or simply record them~~ in the server logs.		# It is recommended that a record of error messages is kept, and for the admin to regularly monitor the error logs. This may be done by setting 'Debug messages' (debug) to Normal and leaving 'Display debug messages' (debugdisplay) off (unticked). Error messages are then recorded in the server logs.
			# If 'Debug messages' is set to Developer on a production (public) site, it is recommended to copy and paste the debugging message obtained and then turn off Developer debugging. This is because debugging messages can give clues to a hacker as to the set-up of your site.

	===Debug email sending===		===Debug email sending===

Tsala: /* Debug messages */ formatting

2017-06-08T09:05:06Z

Debug messages: formatting

← Older revision		Revision as of 09:05, 8 June 2017
Line 8:		Line 8:

	===Debug messages===		===Debug messages===
	~~The default is none, your choices are:~~

	~~;NONE~~ : ~~Do not show any errors or warnings (Default)~~		The options are:
	~~;ALL : Show all reasonable PHP debug messages~~
	~~;MINIMAL : Show only fatal errors~~
	~~;NORMAL : Show warnings, errors and notices~~
	~~;DEVELOPER : extra Moodle debug messages for developers~~

	~~There is rarely~~ any ~~advantage in going to Developer level~~, ~~unless you are a developer, in which case it is strongly recommended.~~		* NONE: Do not show any errors or warnings (Default)
			* MINIMAL: Show only fatal errors
			* NORMAL: Show warnings, errors and notices
			* ALL: Show all reasonable PHP debug messages
			* DEVELOPER: extra Moodle debug messages for developers

	Once you have got the error message, and copied and pasted it somewhere. HIGHLY RECOMMENDED to turn Debug back to NONE. Debug messages can give clues to a hacker as to the setup of your site.		There is rarely any advantage in going to Developer level, unless you are a developer, in which case it is strongly recommended. Once you have got the error message, and copied and pasted it somewhere. HIGHLY RECOMMENDED to turn Debug back to NONE. Debug messages can give clues to a hacker as to the setup of your site.

	===Display debug messages===		===Display debug messages===

Nadavkav: /* More tools for debugging outgoing mail */

2015-12-05T12:02:30Z

More tools for debugging outgoing mail

@@ Line 45: / Line 45: @@
 you@moodle-server(/var/www/html/moodle)# php admin/cli/cron.php
 </code>
 ===Performance info===

Nadavkav at 11:15, 5 December 2015

2015-12-05T11:15:39Z

← Older revision		Revision as of 11:15, 5 December 2015
Line 24:		Line 24:
	There is an option to choose whether to display error messages or simply record them in the server logs.		There is an option to choose whether to display error messages or simply record them in the server logs.

	You can also use the config.php file to turn on more "tools" which will assist you with debugging the emails (and SMTP ~~servers~~):		===Debug email sending===

			Determines whether or not to enable verbose debug information during sending of email messages to SMTP server.

			==== More tools for debugging outgoing mail ====
			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>		<code 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>		</code>
	Turn on the CRON debugging and run CLI cron.php script.
			* Turn on the CRON debugging and run CLI cron.php script.
	<code php>		<code 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
Line 38:		Line 45:
	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>		</code>

	~~===Debug email sending===~~

	~~Determines whether or not to enable verbose debug information during sending of email messages to SMTP server.~~

	===Performance info===		===Performance info===

Nadavkav: /* Display debug messages */

2015-12-04T17:44:49Z

Display debug messages

← Older revision		Revision as of 17:44, 4 December 2015
Line 23:		Line 23:

	There is an option to choose whether to display error messages or simply record them in the server logs.		There is an option to choose whether to display error messages or simply record them in the server logs.

			You can also use the config.php file to turn on more "tools" which will assist you with debugging the emails (and SMTP servers):
			<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>
			Turn on the CRON debugging and run CLI cron.php script.
			<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>

	===Debug email sending===		===Debug email sending===

Harrysmith: /* In config.php */

2015-04-07T16:09:51Z

In config.php

← Older revision		Revision as of 16:09, 7 April 2015
Line 70:		Line 70:
	// Force a debugging mode regardless the settings in the site administration		// Force a debugging mode regardless the settings in the site administration
	// @error_reporting(E_ALL \| E_STRICT); // NOT FOR PRODUCTION SERVERS!		// @error_reporting(E_ALL \| E_STRICT); // NOT FOR PRODUCTION SERVERS!
	// @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!		// @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!
	// $CFG->debug = (E_ALL \| E_STRICT); // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS!		// $CFG->debug = (E_ALL \| E_STRICT); // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS!
	// $CFG->debugdisplay = 1; // NOT FOR PRODUCTION SERVERS!		// $CFG->debugdisplay = 1; // NOT FOR PRODUCTION SERVERS!
	//		//
	// You can specify a comma separated list of user ids that that always see		// You can specify a comma separated list of user ids that that always see
Line 83:		Line 83:

	'''NOTE 1''': do not try to modify the config database table directly, it will not work because the values are cached in MUC.		'''NOTE 1''': do not try to modify the config database table directly, it will not work because the values are cached in MUC.
	'''NOTE 2''': if you find your config.php does not have the above settings (a cut down approx 30 lines config.php) look for a "config-dist.php" file that contains the full details. I would suggest transferring your details in the current config.php file you have into the full config file and renaming that one to "config.php".
			'''NOTE 2''': if you find your config.php does not have the above settings (you have a cut down approx 30 lines config.php) look for a "config-dist.php" file that contains the full details. I would suggest transferring your details in the current config.php file you have into the full config file and renaming that one to "config.php".

	==See also==		==See also==