Using JLog - Revision history

MartijnM: Marked this version for translation

2020-03-31T15:16:47Z

Marked this version for translation

← Older revision		Revision as of 15:16, 31 March 2020
Line 287:		Line 287:

	<translate>		<translate>
	== PSR-3 Logger ==</translate>		== PSR-3 Logger == <!--T:66--></translate>
	<translate>		<translate>
			<!--T:67-->
	Since version 3.8 Joomla incorporates a logger which adheres to the [https://www.php-fig.org/psr/psr-3/ PSR-3 Logger Interface]. This enables libraries which follow this standard recommendation to integrate with the Joomla logging system. To use this, first do:</translate>		Since version 3.8 Joomla incorporates a logger which adheres to the [https://www.php-fig.org/psr/psr-3/ PSR-3 Logger Interface]. This enables libraries which follow this standard recommendation to integrate with the Joomla logging system. To use this, first do:</translate>

Line 296:		Line 297:
	</source>		</source>
	<translate>		<translate>
			<!--T:68-->
	This returns an object on which you have available the methods of the PSR-3 <tt>LoggerInterface</tt>, for example:</translate>		This returns an object on which you have available the methods of the PSR-3 <tt>LoggerInterface</tt>, for example:</translate>

Line 302:		Line 304:
	</source>		</source>
	<translate>		<translate>
			<!--T:69-->
	The default Joomla loggers process only the "category" and "date" elements of the <tt>context</tt> associative array (parameter 2), mapping the values of these elements to the corresponding column in your log file. </translate>		The default Joomla loggers process only the "category" and "date" elements of the <tt>context</tt> associative array (parameter 2), mapping the values of these elements to the corresponding column in your log file. </translate>

MartijnM at 15:16, 31 March 2020

2020-03-31T15:16:11Z

← Older revision		Revision as of 15:16, 31 March 2020
Line 286:		Line 286:
	</translate>		</translate>

	== PSR-3 Logger ==		<translate>
			== PSR-3 Logger ==</translate>
	Since version 3.8 Joomla incorporates a logger which adheres to the [https://www.php-fig.org/psr/psr-3/ PSR-3 Logger Interface]. This enables libraries which follow this standard recommendation to integrate with the Joomla logging system. To use this, first do:		<translate>
			Since version 3.8 Joomla incorporates a logger which adheres to the [https://www.php-fig.org/psr/psr-3/ PSR-3 Logger Interface]. This enables libraries which follow this standard recommendation to integrate with the Joomla logging system. To use this, first do:</translate>

	<source lang="php">		<source lang="php">
Line 294:		Line 295:
	$psr3Logger = Log::createDelegatedLogger();		$psr3Logger = Log::createDelegatedLogger();
	</source>		</source>
			<translate>
	This returns an object on which you have available the methods of the PSR-3 <tt>LoggerInterface</tt>, for example:		This returns an object on which you have available the methods of the PSR-3 <tt>LoggerInterface</tt>, for example:</translate>

	<source lang="php">		<source lang="php">
	$psr3Logger->critical("critical error text", array("category" => "my-critical-category"));		$psr3Logger->critical("critical error text", array("category" => "my-critical-category"));
	</source>		</source>
			<translate>
	The default Joomla loggers process only the "category" and "date" elements of the <tt>context</tt> associative array (parameter 2), mapping the values of these elements to the corresponding column in your log file.		The default Joomla loggers process only the "category" and "date" elements of the <tt>context</tt> associative array (parameter 2), mapping the values of these elements to the corresponding column in your log file. </translate>

	<translate>		<translate>

Robbiej: fix typo

2019-08-17T19:50:28Z

fix typo

← Older revision		Revision as of 19:50, 17 August 2019
Line 78:		Line 78:
	</translate>		</translate>

	<translate><!--T:56--> Below is the code for a simple Joomla module which you can install and run to demonstrate ~~using~~ of the logging functionality. If you are unsure about development and installing a Joomla module then following the tutorial at [[S:MyLanguage/J3.x:Creating a simple module/Introduction\| Creating a simple module ]] will help.</translate>		<translate><!--T:56--> Below is the code for a simple Joomla module which you can install and run to demonstrate use of the logging functionality. If you are unsure about development and installing a Joomla module then following the tutorial at [[S:MyLanguage/J3.x:Creating a simple module/Introduction\| Creating a simple module ]] will help.</translate>

	<translate><!--T:57--> In a folder mod_sample_log create the following 2 files:</translate>		<translate><!--T:57--> In a folder mod_sample_log create the following 2 files:</translate>

Robbiej: Added PSR-3 logger

2019-08-16T17:02:17Z

Added PSR-3 logger

@@ Line 285: / Line 285: @@
 will result in the message being shown in the Joomla message area, even though you haven't explicitly set up a logger to log there.
 </translate>
 <translate>

Wilsonge at 22:27, 13 August 2019

2019-08-13T22:27:16Z

← Older revision		Revision as of 22:27, 13 August 2019
Line 310:		Line 310:
	<translate>		<translate>
	<!--T:51-->		<!--T:51-->
	Joomla logging should be used in tandem with PHP exceptions, not as a replacement. See [[J2.5:Exceptions_and_Logging_in_Joomla_Platform_11.1_and_Joomla_2.5]] for ~~more information~~ on this.		Joomla logging should be used in tandem with PHP exceptions, not as a replacement. See [[J2.5:Exceptions_and_Logging_in_Joomla_Platform_11.1_and_Joomla_2.5]] for backstory on this class and how it arose from the old Joomla PHP4 compatible error classes.
	</translate>		</translate>

Sandra97: Marked this version for translation

2019-08-11T15:36:15Z

Marked this version for translation

← Older revision		Revision as of 15:36, 11 August 2019
Line 10:		Line 10:
	The logging can be controlled dynamically through the Joomla Global Configuration and by configuring the System – Debug plugin (which is shipped with Joomla). Overall these facilities allow you to:</translate>		The logging can be controlled dynamically through the Joomla Global Configuration and by configuring the System – Debug plugin (which is shipped with Joomla). Overall these facilities allow you to:</translate>
	<translate>		<translate>
			<!--T:53-->
	* switch DEBUG logging on or off – so that ordinarily you don't consume resources needlessly, but you have the logging information to assist troubleshooting when there are issues, for example on a live site which has your extension installed.		* switch DEBUG logging on or off – so that ordinarily you don't consume resources needlessly, but you have the logging information to assist troubleshooting when there are issues, for example on a live site which has your extension installed.
	* route log messages to a specific log file for your own extension.		* route log messages to a specific log file for your own extension.
Line 50:		Line 51:

	<translate>		<translate>
			<!--T:54-->
	Using the new class naming convention use instead:</translate>		Using the new class naming convention use instead:</translate>
	<source lang="php">		<source lang="php">
Line 73:		Line 75:

	<translate>		<translate>
	== Basic Logging Sample Code ==		== Basic Logging Sample Code == <!--T:55-->
	</translate>		</translate>

	<translate>Below is the code for a simple Joomla module which you can install and run to demonstrate using of the logging functionality. If you are unsure about development and installing a Joomla module then following the tutorial at [[S:MyLanguage/J3.x:Creating a simple module/Introduction\| Creating a simple module ]] will help.</translate>		<translate><!--T:56--> Below is the code for a simple Joomla module which you can install and run to demonstrate using of the logging functionality. If you are unsure about development and installing a Joomla module then following the tutorial at [[S:MyLanguage/J3.x:Creating a simple module/Introduction\| Creating a simple module ]] will help.</translate>

	<translate>In a folder mod_sample_log create the following 2 files:</translate>		<translate><!--T:57--> In a folder mod_sample_log create the following 2 files:</translate>

	<tt>mod_sample_log.xml</tt>		<tt>mod_sample_log.xml</tt>
Line 107:		Line 109:
	</source>		</source>

	<translate>Zip up the mod_sample_log directory to create <tt>mod_sample_log.zip</tt>.</translate>		<translate><!--T:58--> Zip up the mod_sample_log directory to create <tt>mod_sample_log.zip</tt>.</translate>

	<translate>Within your Joomla administrator go to Install Extensions and via the Upload Package File tab select this zip file to install this sample log module.</translate>		<translate><!--T:59--> Within your Joomla administrator go to Install Extensions and via the Upload Package File tab select this zip file to install this sample log module.</translate>

	<translate>Make this module visible by editing it (click on it within the Modules page) then:		<translate><!--T:60-->
			Make this module visible by editing it (click on it within the Modules page) then:
	# making its status Published		# making its status Published
	# selecting a position on the page for it to be shown		# selecting a position on the page for it to be shown
	# on the menu assignment tab specify the pages it should appear on</translate>		# on the menu assignment tab specify the pages it should appear on</translate>

	<translate>Check the configuration of the settings shown at the top of this web page. In particular, ensure that the System – Debug plugin is enabled and that Log Almost Everything is set to Yes. Also note where the folder where your log files are stored.</translate>		<translate><!--T:61--> Check the configuration of the settings shown at the top of this web page. In particular, ensure that the System – Debug plugin is enabled and that Log Almost Everything is set to Yes. Also note where the folder where your log files are stored.</translate>

	<translate>Display your Joomla site and you should then see the sample log module appearing. In your log file folder you should find your error messages in the everything.php file.</translate>		<translate><!--T:62--> Display your Joomla site and you should then see the sample log module appearing. In your log file folder you should find your error messages in the everything.php file.</translate>

	<translate>Also switch on the debug console and confirm that you can see the error messages in its Log Messages section.</translate>		<translate><!--T:63--> Also switch on the debug console and confirm that you can see the error messages in its Log Messages section.</translate>

	<translate>		<translate>
	== Logging to a Specific Log File==		== Logging to a Specific Log File== <!--T:64-->
	</translate>		</translate>

Line 135:		Line 138:
	</translate>		</translate>

	<translate>For example, if you have developed a ''com_helloworld'' extension you could use the following:</translate>		<translate><!--T:65--> For example, if you have developed a ''com_helloworld'' extension you could use the following:</translate>

	<source lang="php">		<source lang="php">

Sandra97: Correction of the bad placement of translate tags

2019-08-11T15:35:51Z

Correction of the bad placement of translate tags

← Older revision		Revision as of 15:35, 11 August 2019
Line 5:		Line 5:
	== Overview == <!--T:27-->		== Overview == <!--T:27-->
	</translate>		</translate>
	<translate><!--T:28--> Joomla logging gives you the ability to log messages to files and to the screen (within the Joomla! Debug Console at the bottom of the web page) and the main Joomla class which underpins this is JLog.~~</translate>~~ In the new naming convention this is the Log class within the namespace Joomla\CMS\Log\Log.		<translate><!--T:28--> Joomla logging gives you the ability to log messages to files and to the screen (within the Joomla! Debug Console at the bottom of the web page) and the main Joomla class which underpins this is JLog. In the new naming convention this is the Log class within the namespace Joomla\CMS\Log\Log.</translate>

	<translate><!--T:29-->		<translate><!--T:29-->
	The logging can be controlled dynamically through the Joomla Global Configuration and by configuring the System – Debug plugin (which is shipped with Joomla). Overall these facilities allow you to:		The logging can be controlled dynamically through the Joomla Global Configuration and by configuring the System – Debug plugin (which is shipped with Joomla). Overall these facilities allow you to:</translate>
			<translate>
	* switch DEBUG logging on or off – so that ordinarily you don't consume resources needlessly, but you have the logging information to assist troubleshooting when there are issues, for example on a live site which has your extension installed.		* switch DEBUG logging on or off – so that ordinarily you don't consume resources needlessly, but you have the logging information to assist troubleshooting when there are issues, for example on a live site which has your extension installed.
	* route log messages to a specific log file for your own extension.		* route log messages to a specific log file for your own extension.
Line 16:		Line 17:

	<translate><!--T:30-->		<translate><!--T:30-->
	The main configuration options relating to logging are shown below.		The main configuration options relating to logging are shown below.</translate>
			<translate>
	<!--T:31-->		<!--T:31-->
	Switching on debug and display of the Joomla Debug Console is controlled through the global configuration options.		Switching on debug and display of the Joomla Debug Console is controlled through the global configuration options.
Line 49:		Line 50:

	<translate>		<translate>
			Using the new class naming convention use instead:</translate>
	Using the new class naming convention use instead:
	<source lang="php">		<source lang="php">
	use Joomla\CMS\Log\Log;		use Joomla\CMS\Log\Log;
Line 56:		Line 56:
	</source>		</source>

	<!--T:38-->		<translate><!--T:38-->
	The parameters are		The parameters are
	# A message string. You can use translation with these. (For example, JText::_('MY_EXTENSION_ERR_MSG') You can also display the values of variables, provided you convert them into a string format. (For example, using __toString() if the type of the variable supports that.)		# A message string. You can use translation with these. (For example, JText::_('MY_EXTENSION_ERR_MSG') You can also display the values of variables, provided you convert them into a string format. (For example, using __toString() if the type of the variable supports that.)
Line 73:		Line 73:

	<translate>		<translate>

	== Basic Logging Sample Code ==		== Basic Logging Sample Code ==
			</translate>

	Below is the code for a simple Joomla module which you can install and run to demonstrate using of the logging functionality. If you are unsure about development and installing a Joomla module then following the tutorial at [[J3.x:Creating a simple module/Introduction\| Creating a simple module ]] will help.		<translate>Below is the code for a simple Joomla module which you can install and run to demonstrate using of the logging functionality. If you are unsure about development and installing a Joomla module then following the tutorial at [[S:MyLanguage/J3.x:Creating a simple module/Introduction\| Creating a simple module ]] will help.</translate>

	In a folder mod_sample_log create the following 2 files:		<translate>In a folder mod_sample_log create the following 2 files:</translate>

	<tt>mod_sample_log.xml</tt>		<tt>mod_sample_log.xml</tt>
Line 107:		Line 107:
	</source>		</source>

	Zip up the mod_sample_log directory to create <tt>mod_sample_log.zip</tt>.		<translate>Zip up the mod_sample_log directory to create <tt>mod_sample_log.zip</tt>.</translate>

	Within your Joomla administrator go to Install Extensions and via the Upload Package File tab select this zip file to install this sample log module.		<translate>Within your Joomla administrator go to Install Extensions and via the Upload Package File tab select this zip file to install this sample log module.</translate>

	Make this module visible by editing it (click on it within the Modules page) then:		<translate>Make this module visible by editing it (click on it within the Modules page) then:
	# making its status Published		# making its status Published
	# selecting a position on the page for it to be shown		# selecting a position on the page for it to be shown
	# on the menu assignment tab specify the pages it should appear on		# on the menu assignment tab specify the pages it should appear on</translate>

	Check the configuration of the settings shown at the top of this web page. In particular, ensure that the System – Debug plugin is enabled and that Log Almost Everything is set to Yes. Also note where the folder where your log files are stored.		<translate>Check the configuration of the settings shown at the top of this web page. In particular, ensure that the System – Debug plugin is enabled and that Log Almost Everything is set to Yes. Also note where the folder where your log files are stored.</translate>

	Display your Joomla site and you should then see the sample log module appearing. In your log file folder you should find your error messages in the everything.php file.		<translate>Display your Joomla site and you should then see the sample log module appearing. In your log file folder you should find your error messages in the everything.php file.</translate>

	Also switch on the debug console and confirm that you can see the error messages in its Log Messages section.		<translate>Also switch on the debug console and confirm that you can see the error messages in its Log Messages section.</translate>

			<translate>
			== Logging to a Specific Log File==
			</translate>

	~~== Logging to a Specific Log File== <!--T:40-->~~
	~~</translate>~~
	<translate>		<translate>
	<!--T:41-->		<!--T:41-->
Line 131:		Line 133:
	# an array of the categories to be logged in that file. (If parameter 4 is set to <tt>true</tt>, this array defines the categories which are NOT to be logged in the file.)		# an array of the categories to be logged in that file. (If parameter 4 is set to <tt>true</tt>, this array defines the categories which are NOT to be logged in the file.)
	# (often omitted) a boolean specifying whether parameter 3 is an include list. (The default, P4 = <tt>false</tt>) or an exclude list (P4 = <tt>true</tt>.)		# (often omitted) a boolean specifying whether parameter 3 is an include list. (The default, P4 = <tt>false</tt>) or an exclude list (P4 = <tt>true</tt>.)
			</translate>

	<~~!--T:42--~~>		<translate>For example, if you have developed a ''com_helloworld'' extension you could use the following:</translate>
	For example, if you have developed a ''com_helloworld'' extension you could use the following:
	</translate>

	<source lang="php">		<source lang="php">
Line 272:		Line 273:
	JLog::add('an error to display', JLog::ERROR, 'msg-error-cat');		JLog::add('an error to display', JLog::ERROR, 'msg-error-cat');
	</source>		</source>
	you will get the message copied to the message bar.		you will get the message copied to the message bar.</translate>
			<translate>
	<!--T:49-->		<!--T:49-->
	'''Note that Joomla core code sets up logging to the messagequeue for category 'jerror', so that if you use this category in your log messages, you will get the message displayed on the message bar.''' For example:		'''Note that Joomla core code sets up logging to the messagequeue for category 'jerror', so that if you use this category in your log messages, you will get the message displayed on the message bar.''' For example:

Robbiej: Add module sample code, plus use within new class naming convention

2019-08-11T12:15:55Z

Add module sample code, plus use within new class naming convention

@@ Line 5: / Line 5: @@
 == Overview == <!--T:27-->
 </translate>
-<translate><!--T:28--> Joomla logging gives you the ability to log messages to files and to the screen (within the Joomla! Debug Console at the bottom of the web page) and the main Joomla class which underpins this is JLog.</translate>
+<translate><!--T:28--> Joomla logging gives you the ability to log messages to files and to the screen (within the Joomla! Debug Console at the bottom of the web page) and the main Joomla class which underpins this is JLog.</translate> In the new naming convention this is the Log class within the namespace Joomla\CMS\Log\Log.
 <translate><!--T:29-->
@@ Line 49: / Line 49: @@
 <translate>
 <!--T:38-->
 The parameters are
@@ Line 66: / Line 73: @@
 <translate>
 == Logging to a Specific Log File== <!--T:40-->
 </translate>

Cmb: Corrected the link to the Exceptions and Logging page.

2019-07-27T15:14:14Z

Corrected the link to the Exceptions and Logging page.

← Older revision		Revision as of 15:14, 27 July 2019
Line 227:		Line 227:

	<translate>		<translate>

	== Exceptions == <!--T:25-->		== Exceptions == <!--T:25-->
	</translate>		</translate>
Line 246:		Line 245:
	</source>		</source>
	<translate>		<translate>

	== Further Reading == <!--T:50-->		== Further Reading == <!--T:50-->
	</translate>		</translate>

	<translate>		<translate>
	<!--T:51-->		<!--T:51-->
	Joomla logging should be used in tandem with PHP exceptions, not as a replacement. See [[S:~~MyLanguage/Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1\|Exceptions and Logging in Joomla 1~~.~~7 and Joomla Platform 11~~.1]] for more information on this.		Joomla logging should be used in tandem with PHP exceptions, not as a replacement. See [[J2.5:Exceptions_and_Logging_in_Joomla_Platform_11.1_and_Joomla_2.5]] for more information on this.
	</translate>		</translate>

Wilsonge: Remove new lines

2019-07-27T12:23:45Z

Remove new lines

← Older revision		Revision as of 12:23, 27 July 2019
Line 245:		Line 245:
	);		);
	</source>		</source>

	<translate>		<translate>