Joomla! Documentation - User contributions [en]

Using JLog

2017-10-20T14:42:26Z

Ollehar:

<noinclude><languages /></noinclude>
<translate>
Using '''JLog''' can be very useful in components when analysing the performance of custom extensions - or analysing where extensions are giving issues. Note this 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.</translate>
__TOC__

<translate>
== Calling the class == 
</translate>

<translate>
To use JLog you need to call the JLog class. Done through the following code:</translate>

jimport('joomla.log.log');

<translate>
== Basic File Logging == 
</translate>

<translate>
Often you may wish to display an error log message and log to an error file. Joomla allows this natively through the <tt>JLog::add</tt> function. For example:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'jerror');

<translate>
Adding the category of jerror means that this message will also be displayed to users. To only write to file you can easily drop that parameter and simply use:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING);

<translate>
== Logging a specific extension == 
</translate>
<translate>
Sometimes it may be useful to log the errors to a specific file. In this case you can.</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.errors.php'
),
// Sets messages of all log levels to be sent to the file
JLog::ALL,
// The log category/categories which should be recorded in this file
// In this case, it's just the one category from our extension, still
// we need to put it inside an array
array('com_helloworld')
);

<translate>
Now remember to change the category when you add a log message. Such as in the example below.</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'com_helloworld');

<translate>
'''Note:''' You may wish to combine this with the [[S:MyLanguage/Display error messages and notices|Display error messages and notices]] section to display visable error notifications to users.</translate>

<translate>
== Logging specific priorities == 
</translate>

<translate>
You can also add an additional logger to capture only critical and emergency log notifications:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php'
),
// Sets critical and emergency log level messages to be sent to the file
JLog::CRITICAL + JLog::EMERGENCY,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
You can also exclude a specific category from being included. For example, to log all but DEBUG messages:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.all_but_debug.php'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
Notice how '''bitwise''' operations (bitwise AND, &; and bitwise NOT, ~) are used to calculate the accepted log levels.</translate>

<translate>
== Formatting the logfile == 
</translate>

<translate>
The first parameter to addLogger can have a few optional additional settings in addition to the <tt>text_file</tt> entry.</translate>

<translate>
There is for example the entry <tt>text_entry_format</tt>, specifying the format of each line in your logfile.</translate>

<translate>
The default format is:</translate>

'{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}'

<translate>
Here is an example of a different format which shows how to omit the category:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php',
// Sets the format of each line
'text_entry_format' => '{DATETIME} {PRIORITY} {MESSAGE}'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
In addition to the placeholders shown above in the default string, the following values are available:</translate>

{CLIENTIP}
{TIME}
{DATE}

<translate>
There is an additional optional boolean parameter <tt>text_file_no_php</tt>, which specifies whether the log file is prepended with the usual prefix of:</translate>

#
#<?php die('Forbidden.');?>

<translate>
'''Note:''' Usually you should not set this setting to false. Log files should not be readable from the outside, since they can provide valuable information about your system for attackers.
Only dabble with this if you know what you're doing!</translate>

<translate>
Furthermore, if you want to store the log file somewhere else than the logging path configured in the Joomla! settings, you can there is the <tt>text_file_path</tt> setting.</translate>

<translate>
== Exceptions == 
</translate>

<translate>
<code>JLog::add()</code> will throw an exception if it can't write to the log file. To avoid this, you'd have to either wrap the call in another function, or implement your own logger class and then include it with:</translate>

JLog::addLogger(
array(
// Use mycustomlogger
'logger' => 'mycustomlogger',
'text_file' => 'com_helloworld.errors.php'
),
JLog::ALL,
array('com_helloworld')
);

<noinclude>
<translate>

[[Category:Development]]
[[category:Joomla! 1.7]]
[[category:Joomla! 2.5]]
[[category:Joomla! 3.0]]
[[category:Joomla! 3.x]]
</translate>
</noinclude>

Using JLog

2017-10-20T12:08:35Z

Ollehar:

<noinclude><languages /></noinclude>
<translate>
Using '''JLog''' can be very useful in components when analysing the performance of custom extensions - or analysing where extensions are giving issues. Note this 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.</translate>
__TOC__

<translate>
== Calling the class == 
</translate>

<translate>
To use JLog you need to call the JLog class. Done through the following code:</translate>

jimport('joomla.log.log');

<translate>
== Basic File Logging == 
</translate>

<translate>
Often you may wish to display an error log message and log to an error file. Joomla allows this natively through the <tt>JLog::add</tt> function. For example:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'jerror');

<translate>
Adding the category of jerror means that this message will also be displayed to users. To only write to file you can easily drop that parameter and simply use:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING);

<translate>
== Logging a specific extension == 
</translate>
<translate>
Sometimes it may be useful to log the errors to a specific file. In this case you can.</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.errors.php'
),
// Sets messages of all log levels to be sent to the file
JLog::ALL,
// The log category/categories which should be recorded in this file
// In this case, it's just the one category from our extension, still
// we need to put it inside an array
array('com_helloworld')
);

<translate>
Now remember to change the category when you add a log message. Such as in the example below.</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'com_helloworld');

<translate>
'''Note:''' You may wish to combine this with the [[S:MyLanguage/Display error messages and notices|Display error messages and notices]] section to display visable error notifications to users.</translate>

<translate>
== Logging specific priorities == 
</translate>

<translate>
You can also add an additional logger to capture only critical and emergency log notifications:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php'
),
// Sets critical and emergency log level messages to be sent to the file
JLog::CRITICAL + JLog::EMERGENCY,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
You can also exclude a specific category from being included. For example, to log all but DEBUG messages:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.all_but_debug.php'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
Notice how '''bitwise''' operations (bitwise AND, &; and bitwise NOT, ~) are used to calculate the accepted log levels.</translate>

<translate>
== Formatting the logfile == 
</translate>

<translate>
The first parameter to addLogger can have a few optional additional settings in addition to the <tt>text_file</tt> entry.</translate>

<translate>
There is for example the entry <tt>text_entry_format</tt>, specifying the format of each line in your logfile.</translate>

<translate>
The default format is:</translate>

'{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}'

<translate>
Here is an example of a different format which shows how to omit the category:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php',
// Sets the format of each line
'text_entry_format' => '{DATETIME} {PRIORITY} {MESSAGE}'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
In addition to the placeholders shown above in the default string, the following values are available:</translate>

{CLIENTIP}
{TIME}
{DATE}

<translate>
There is an additional optional boolean parameter <tt>text_file_no_php</tt>, which specifies whether the log file is prepended with the usual prefix of:</translate>

#
#<?php die('Forbidden.');?>

<translate>
'''Note:''' Usually you should not set this setting to false. Log files should not be readable from the outside, since they can provide valuable information about your system for attackers.
Only dabble with this if you know what you're doing!</translate>

<translate>
Furthermore, if you want to store the log file somewhere else than the logging path configured in the Joomla! settings, you can there is the <tt>text_file_path</tt> setting.</translate>

<translate>
== Exceptions == 
</translate>

<translate>
<code>JLog::add()</code> will throw an exception if it can't write to the log file. To avoid this, you'd have to implement your own logger class and then include it with:</translate>

JLog::addLogger(
array(
// Use mycustomlogger
'logger' => 'mycustomlogger',
'text_file' => 'com_helloworld.errors.php'
),
JLog::ALL,
array('com_helloworld')
);

<noinclude>
<translate>

[[Category:Development]]
[[category:Joomla! 1.7]]
[[category:Joomla! 2.5]]
[[category:Joomla! 3.0]]
[[category:Joomla! 3.x]]
</translate>
</noinclude>

Using JLog

2017-10-20T12:08:03Z

Ollehar:

<noinclude><languages /></noinclude>
<translate>
Using '''JLog''' can be very useful in components when analysing the performance of custom extensions - or analysing where extensions are giving issues. Note this 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.</translate>
__TOC__

<translate>
== Calling the class == 
</translate>

<translate>
To use JLog you need to call the JLog class. Done through the following code:</translate>

jimport('joomla.log.log');

<translate>
== Basic File Logging == 
</translate>

<translate>
Often you may wish to display an error log message and log to an error file. Joomla allows this natively through the <tt>JLog::add</tt> function. For example:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'jerror');

<translate>
Adding the category of jerror means that this message will also be displayed to users. To only write to file you can easily drop that parameter and simply use:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING);

<translate>
== Logging a specific extension == 
</translate>
<translate>
Sometimes it may be useful to log the errors to a specific file. In this case you can.</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.errors.php'
),
// Sets messages of all log levels to be sent to the file
JLog::ALL,
// The log category/categories which should be recorded in this file
// In this case, it's just the one category from our extension, still
// we need to put it inside an array
array('com_helloworld')
);

<translate>
Now remember to change the category when you add a log message. Such as in the example below.</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'com_helloworld');

<translate>
'''Note:''' You may wish to combine this with the [[S:MyLanguage/Display error messages and notices|Display error messages and notices]] section to display visable error notifications to users.</translate>

<translate>
== Logging specific priorities == 
</translate>

<translate>
You can also add an additional logger to capture only critical and emergency log notifications:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php'
),
// Sets critical and emergency log level messages to be sent to the file
JLog::CRITICAL + JLog::EMERGENCY,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
You can also exclude a specific category from being included. For example, to log all but DEBUG messages:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.all_but_debug.php'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
Notice how '''bitwise''' operations (bitwise AND, &; and bitwise NOT, ~) are used to calculate the accepted log levels.</translate>

<translate>
== Formatting the logfile == 
</translate>

<translate>
The first parameter to addLogger can have a few optional additional settings in addition to the <tt>text_file</tt> entry.</translate>

<translate>
There is for example the entry <tt>text_entry_format</tt>, specifying the format of each line in your logfile.</translate>

<translate>
The default format is:</translate>

'{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}'

<translate>
Here is an example of a different format which shows how to omit the category:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php',
// Sets the format of each line
'text_entry_format' => '{DATETIME} {PRIORITY} {MESSAGE}'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
In addition to the placeholders shown above in the default string, the following values are available:</translate>

{CLIENTIP}
{TIME}
{DATE}

<translate>
There is an additional optional boolean parameter <tt>text_file_no_php</tt>, which specifies whether the log file is prepended with the usual prefix of:</translate>

#
#<?php die('Forbidden.');?>

<translate>
'''Note:''' Usually you should not set this setting to false. Log files should not be readable from the outside, since they can provide valuable information about your system for attackers.
Only dabble with this if you know what you're doing!</translate>

<translate>
Furthermore, if you want to store the log file somewhere else than the logging path configured in the Joomla! settings, you can there is the <tt>text_file_path</tt> setting.</translate>

<translate>
== Exceptions == 
</translate>

<translate>
JLog::add() will throw an exception if it can't write to the log file. To avoid this, you'd have to implement your own logger class and then include it with:</translate>

JLog::addLogger(
array(
// Use mycustomlogger
'logger' => 'mycustomlogger',
'text_file' => 'com_helloworld.errors.php'
),
JLog::ALL,
array('com_helloworld')
);

<noinclude>
<translate>

[[Category:Development]]
[[category:Joomla! 1.7]]
[[category:Joomla! 2.5]]
[[category:Joomla! 3.0]]
[[category:Joomla! 3.x]]
</translate>
</noinclude>

Using JLog

2017-10-20T12:07:36Z

Ollehar:

<noinclude><languages /></noinclude>
<translate>
Using '''JLog''' can be very useful in components when analysing the performance of custom extensions - or analysing where extensions are giving issues. Note this 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.</translate>
__TOC__

<translate>
== Calling the class == 
</translate>

<translate>
To use JLog you need to call the JLog class. Done through the following code:</translate>

jimport('joomla.log.log');

<translate>
== Basic File Logging == 
</translate>

<translate>
Often you may wish to display an error log message and log to an error file. Joomla allows this natively through the <tt>JLog::add</tt> function. For example:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'jerror');

<translate>
Adding the category of jerror means that this message will also be displayed to users. To only write to file you can easily drop that parameter and simply use:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING);

<translate>
== Logging a specific extension == 
</translate>
<translate>
Sometimes it may be useful to log the errors to a specific file. In this case you can.</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.errors.php'
),
// Sets messages of all log levels to be sent to the file
JLog::ALL,
// The log category/categories which should be recorded in this file
// In this case, it's just the one category from our extension, still
// we need to put it inside an array
array('com_helloworld')
);

<translate>
Now remember to change the category when you add a log message. Such as in the example below.</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'com_helloworld');

<translate>
'''Note:''' You may wish to combine this with the [[S:MyLanguage/Display error messages and notices|Display error messages and notices]] section to display visable error notifications to users.</translate>

<translate>
== Logging specific priorities == 
</translate>

<translate>
You can also add an additional logger to capture only critical and emergency log notifications:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php'
),
// Sets critical and emergency log level messages to be sent to the file
JLog::CRITICAL + JLog::EMERGENCY,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
You can also exclude a specific category from being included. For example, to log all but DEBUG messages:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.all_but_debug.php'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
Notice how '''bitwise''' operations (bitwise AND, &; and bitwise NOT, ~) are used to calculate the accepted log levels.</translate>

<translate>
== Formatting the logfile == 
</translate>

<translate>
The first parameter to addLogger can have a few optional additional settings in addition to the <tt>text_file</tt> entry.</translate>

<translate>
There is for example the entry <tt>text_entry_format</tt>, specifying the format of each line in your logfile.</translate>

<translate>
The default format is:</translate>

'{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}'

<translate>
Here is an example of a different format which shows how to omit the category:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php',
// Sets the format of each line
'text_entry_format' => '{DATETIME} {PRIORITY} {MESSAGE}'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
In addition to the placeholders shown above in the default string, the following values are available:</translate>

{CLIENTIP}
{TIME}
{DATE}

<translate>
There is an additional optional boolean parameter <tt>text_file_no_php</tt>, which specifies whether the log file is prepended with the usual prefix of:</translate>

#
#<?php die('Forbidden.');?>

<translate>
'''Note:''' Usually you should not set this setting to false. Log files should not be readable from the outside, since they can provide valuable information about your system for attackers.
Only dabble with this if you know what you're doing!</translate>

<translate>
Furthermore, if you want to store the log file somewhere else than the logging path configured in the Joomla! settings, you can there is the <tt>text_file_path</tt> setting.</translate>

<noinclude>
<translate>

[[Category:Development]]
[[category:Joomla! 1.7]]
[[category:Joomla! 2.5]]
[[category:Joomla! 3.0]]
[[category:Joomla! 3.x]]
</translate>
</noinclude>

<translate>
== Exceptions == 
</translate>

<translate>
JLog::add() will throw an exception if it can't write to the log file. To avoid this, you'd have to implement your own logger class and then include it with:</translate>

JLog::addLogger(
array(
// Use mycustomlogger
'logger' => 'mycustomlogger',
'text_file' => 'com_helloworld.errors.php'
),
JLog::ALL,
array('com_helloworld')
);

Using JLog

2017-10-20T12:06:31Z

Ollehar:

<noinclude><languages /></noinclude>
<translate>
Using '''JLog''' can be very useful in components when analysing the performance of custom extensions - or analysing where extensions are giving issues. Note this 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.</translate>
__TOC__

<translate>
== Calling the class == 
</translate>

<translate>
To use JLog you need to call the JLog class. Done through the following code:</translate>

jimport('joomla.log.log');

<translate>
== Basic File Logging == 
</translate>

<translate>
Often you may wish to display an error log message and log to an error file. Joomla allows this natively through the <tt>JLog::add</tt> function. For example:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'jerror');

<translate>
Adding the category of jerror means that this message will also be displayed to users. To only write to file you can easily drop that parameter and simply use:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING);

<translate>
== Logging a specific extension == 
</translate>
<translate>
Sometimes it may be useful to log the errors to a specific file. In this case you can.</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.errors.php'
),
// Sets messages of all log levels to be sent to the file
JLog::ALL,
// The log category/categories which should be recorded in this file
// In this case, it's just the one category from our extension, still
// we need to put it inside an array
array('com_helloworld')
);

<translate>
Now remember to change the category when you add a log message. Such as in the example below.</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'com_helloworld');

<translate>
'''Note:''' You may wish to combine this with the [[S:MyLanguage/Display error messages and notices|Display error messages and notices]] section to display visable error notifications to users.</translate>

<translate>
== Logging specific priorities == 
</translate>

<translate>
You can also add an additional logger to capture only critical and emergency log notifications:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php'
),
// Sets critical and emergency log level messages to be sent to the file
JLog::CRITICAL + JLog::EMERGENCY,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
You can also exclude a specific category from being included. For example, to log all but DEBUG messages:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.all_but_debug.php'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
Notice how '''bitwise''' operations (bitwise AND, &; and bitwise NOT, ~) are used to calculate the accepted log levels.</translate>

<translate>
== Formatting the logfile == 
</translate>

<translate>
The first parameter to addLogger can have a few optional additional settings in addition to the <tt>text_file</tt> entry.</translate>

<translate>
There is for example the entry <tt>text_entry_format</tt>, specifying the format of each line in your logfile.</translate>

<translate>
The default format is:</translate>

'{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}'

<translate>
Here is an example of a different format which shows how to omit the category:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php',
// Sets the format of each line
'text_entry_format' => '{DATETIME} {PRIORITY} {MESSAGE}'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
In addition to the placeholders shown above in the default string, the following values are available:</translate>

{CLIENTIP}
{TIME}
{DATE}

<translate>
There is an additional optional boolean parameter <tt>text_file_no_php</tt>, which specifies whether the log file is prepended with the usual prefix of:</translate>

#
#<?php die('Forbidden.');?>

<translate>
'''Note:''' Usually you should not set this setting to false. Log files should not be readable from the outside, since they can provide valuable information about your system for attackers.
Only dabble with this if you know what you're doing!</translate>

<translate>
Furthermore, if you want to store the log file somewhere else than the logging path configured in the Joomla! settings, you can there is the <tt>text_file_path</tt> setting.</translate>

<noinclude>
<translate>

[[Category:Development]]
[[category:Joomla! 1.7]]
[[category:Joomla! 2.5]]
[[category:Joomla! 3.0]]
[[category:Joomla! 3.x]]
</translate>
</noinclude>

<translate>
== Exceptions == 
</translate>

JLog::add() will throw an exception if it can't write to the log file. To avoid this, you'd have to implement your own logger class and then include it with

JLog::addLogger(
array(
// Use mycustomlogger
'logger' => 'mycustomlogger',
'text_file' => 'com_helloworld.errors.php'
),
JLog::ALL,
array('com_helloworld')
);

Using JLog

2017-10-20T10:58:13Z

Ollehar:

<noinclude><languages /></noinclude>
<translate>
Using '''JLog''' can be very useful in components when analysing the performance of custom extensions - or analysing where extensions are giving issues. Note this 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.</translate>
__TOC__

<translate>
== Calling the class == 
</translate>

<translate>
To use JLog you need to call the JLog class. Done through the following code:</translate>

jimport('joomla.log.log');

<translate>
== Basic File Logging == 
</translate>

<translate>
Often you may wish to display an error log message and log to an error file. Joomla allows this natively through the <tt>JLog::add</tt> function. For example:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'jerror');

<translate>
Adding the category of jerror means that this message will also be displayed to users. To only write to file you can easily drop that parameter and simply use:</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING);

<translate>
== Logging a specific extension == 
</translate>
<translate>
Sometimes it may be useful to log the errors to a specific file. In this case you can.</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.errors.php'
),
// Sets messages of all log levels to be sent to the file
JLog::ALL,
// The log category/categories which should be recorded in this file
// In this case, it's just the one category from our extension, still
// we need to put it inside an array
array('com_helloworld')
);

<translate>
Now remember to change the category when you add a log message. Such as in the example below.</translate>

JLog::add(JText::_('JTEXT_ERROR_MESSAGE'), JLog::WARNING, 'com_helloworld');

<translate>
'''Note:''' You may wish to combine this with the [[S:MyLanguage/Display error messages and notices|Display error messages and notices]] section to display visable error notifications to users.</translate>

<translate>
== Logging specific priorities == 
</translate>

<translate>
You can also add an additional logger to capture only critical and emergency log notifications:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php'
),
// Sets critical and emergency log level messages to be sent to the file
JLog::CRITICAL + JLog::EMERGENCY,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
You can also exclude a specific category from being included. For example, to log all but DEBUG messages:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.all_but_debug.php'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
Notice how '''bitwise''' operations (bitwise AND, &; and bitwise NOT, ~) are used to calculate the accepted log levels.</translate>

<translate>
== Formatting the logfile == 
</translate>

<translate>
The first parameter to addLogger can have a few optional additional settings in addition to the <tt>text_file</tt> entry.</translate>

<translate>
There is for example the entry <tt>text_entry_format</tt>, specifying the format of each line in your logfile.</translate>

<translate>
The default format is:</translate>

'{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}'

<translate>
Here is an example of a different format which shows how to omit the category:</translate>

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php',
// Sets the format of each line
'text_entry_format' => '{DATETIME} {PRIORITY} {MESSAGE}'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

<translate>
In addition to the placeholders shown above in the default string, the following values are available:</translate>

{CLIENTIP}
{TIME}
{DATE}

<translate>
There is an additional optional boolean parameter <tt>text_file_no_php</tt>, which specifies whether the log file is prepended with the usual prefix of:</translate>

#
#<?php die('Forbidden.');?>

<translate>
'''Note:''' Usually you should not set this setting to false. Log files should not be readable from the outside, since they can provide valuable information about your system for attackers.
Only dabble with this if you know what you're doing!</translate>

<translate>
Furthermore, if you want to store the log file somewhere else than the logging path configured in the Joomla! settings, you can there is the <tt>text_file_path</tt> setting.</translate>

<noinclude>
<translate>

[[Category:Development]]
[[category:Joomla! 1.7]]
[[category:Joomla! 2.5]]
[[category:Joomla! 3.0]]
[[category:Joomla! 3.x]]
</translate>
</noinclude>

== Exceptions == 

JLog::add() will throw an exception if it can't write to the log file. To avoid this, you'd have to implement your own logger class and then include it with

JLog::addLogger(
array(
// Use mycustomlogger
'logger' => 'mycustomlogger',
'text_file' => 'com_helloworld.errors.php'
),
JLog::ALL,
array('com_helloworld')
);

User:Ollehar

2017-10-20T10:49:24Z

Ollehar: Created page with "Hi, My name is Olle Haerstedt. I work for LimeSurvey GmbH in Hamburg."

Hi,

My name is Olle Haerstedt. I work for LimeSurvey GmbH in Hamburg.