Logging API - Revision history

GregorK: Documentation about new logger

GregorK — Sat, 27 Sep 2008 16:06:35 GMT

Documentation about new logger

←Older revision		Revision as of 16:06, 27 September 2008

	[[Category:Development]]		[[Category:Development]]
-	~~The~~ Phex ~~logging concept can be configured to support different type of logging libraries.~~	+
-	~~It's using~~ the [http://~~jakarta~~.~~apache~~.~~org~~/~~commons/logging Apache Commons Logging~~] ~~API as a bridge between different common~~ logging ~~libraries~~.	+	Phex uses the [http://logback.qos.ch/ LOGBack] library for logging. (Since Phex 3.2.8 build 107)

	== Logging Configuration ==		== Logging Configuration ==

-	~~=== General Configuration ===~~	+	To change the default configuration and adjust Phex logging to your needs, you need to create a file called '''logback-test.xml''' which must be placed in the Phex classpath. This can for example be the directory ext/ inside your Phex home directory or the Phex source directory.
-	To ~~configure~~ the Phex logging, you need to create a file called '''~~logging~~.~~properties~~''' inside your Phex configuration directory.	+
		+	The configuration file can contain LOGBack configuration according to the [http://logback.qos.ch/manual/index.html LOGBack documentation].
		+
		+	Phex provides a default configuration set of appenders which can be integrated into a custom configuration for easier setup. It will provide three logging appenders:
		+	* '''ConsoleAppender''': Outputs all message on the command line console, if Phex is started from console.
		+	* '''DefaultFileAppender''': Writes all log messages into the file 'phex.log' in the Phex configuration directory.
		+	* '''ErrorFileAppender''': Writes all error messages into the file 'phex.error.log' in the Phex configuration directory.
		+
		+	To use the provided default configuration add this directive:
		+	<nowiki>
		+	<configuration>
		+	...
		+	<!-- include Phex default appenders -->
		+	<include resource="logback.inc.xml"/>
		+	...
		+	</configuration>
		+	</nowiki>
		+
		+	All that is left to do is to configure the root logger and the custom logger configuration. Since the Phex logs a very high volume it is highly recommended to only log on the ERROR or maybe WARN level on the root logger.
		+
		+	This is a recommended example configuration for the root logger:
		+	<nowiki>
		+	<configuration>
		+	...
		+	<!-- root logger configuration -->
		+	<root>
		+	<!-- only log ERROR level -->
		+	<level value="ERROR" />
		+
		+	<!-- write all output to phex.log -->
		+	<appender-ref ref="DefaultFileAppender" />
		+
		+	<!-- write all ERROR output to phex.log -->
		+	<appender-ref ref="ErrorFileAppender" />
		+
		+	<!-- write all output to shell console -->
		+	<appender-ref ref="ConsoleAppender" />
		+	</root>
		+	...
		+	</configuration>
		+	</nowiki>
		+
		+	Now add your custom logger at package or class level. Here is a possible example configuration:
		+	<nowiki>
		+	<configuration>
		+	...
		+	<!-- configure logger for the class HttpFileDownload -->
		+	<logger name="phex.download.handler.HttpFileDownload" additivity="false">
		+	<level value="DEBUG" />
		+	</logger>

-	To configure the ~~log instance you need to add a property called '''org~~.~~apache~~.~~commons~~.~~logging~~.~~Log'''~~.	+	<!-- configure logger for the whole package phex.gwebcache -->
-	~~The property can have the following values:~~	+	<logger name="phex.gwebcache" additivity="false">
		+	<level value="DEBUG" />
		+	</logger>
		+	...
		+	</configuration>
		+	</nowiki>

-	* '''org.apache.commons.logging.impl.Log4JLogger'''<br>For use of Log4j as a logging library.
-	* '''phex.utils.PhexLogger'''<br>This is the default logger for Phex.
-	* '''org.apache.commons.logging.impl.Jdk14Logger'''<br>For use of the JDK logging library.
-	* '''org.apache.commons.logging.impl.SimpleLog'''<br>To use a simple log instance of Commons Logging.

		+	A complete custom log configuration file could look like this:
		+	<nowiki>
		+	<?xml version="1.0" encoding="UTF-8"?>
		+	<configuration>

-	=~~== Log4J Configuration ===~~	+	<!-- include Phex default appenders -->
		+	<include resource="logback.inc.xml"/>

-	~~When using org.apache.commons.logging.impl.Log4JLogger you can use the following additional properties:~~	+	<!-- root logger configuration -->
		+	<root>
		+	<!-- only log ERROR level -->
		+	<level value="ERROR" />

-	* '''log4j.~~configuration'''~~<br>~~File path possible with URL (file:/c%3A/MyFiles/phex/log4j.properties)~~	+	<!-- write all output to phex.log -->
		+	<appender-ref ref="DefaultFileAppender" />

		+	<!-- write all ERROR output to phex.log -->
		+	<appender-ref ref="ErrorFileAppender" />

-	=== ~~Phex Logging Configuration ==~~=	+	<!-- write all output to shell console -->
		+	<appender-ref ref="ConsoleAppender" />
		+	</root>
		+
		+	<!-- configure logger for the class HttpFileDownload -->
		+	<logger name="phex.download.handler.HttpFileDownload" additivity="false">
		+	<!-- log DEBUG, INFO, WARN and ERROR -->
		+	<level value="DEBUG" />

-	~~When using phex.utils.PhexLogger you can~~ use ~~the following additional properties:~~	+	<!-- use root logger appenders -->

-	* '''phex.utils.logger~~.logFile''' = phex.log~~	+	</logger>
-	* '''phex.utils.logger.errorLogFile''' = phex.error.log	+
-	* '''phex.utils.logger.level''' = 3	+
-	* '''phex.utils.logger.console''' = false	+
-	* '''phex.utils.logger.maxFileSize''' = 524288	+

		+	<!-- configure logger for the whole package phex.gwebcache -->
		+	<logger name="phex.gwebcache" additivity="false">
		+	<!-- log DEBUG, INFO, WARN and ERROR -->
		+	<level value="DEBUG" />

-	~~=== Commons Logging Configuration ===~~	+	<!-- use root logger appenders -->

-	~~When using org.apache.commons.logging.impl.SimpleLog you can use the following additional properties:~~	+	</logger>

-	* '''org.apache.commons.logging.simplelog.defaultlog'''<br>Default logging detail level for all instances of SimpleLog. Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, defaults to "info".	+	</configuration>
-	* '''org.apache.commons.logging.simplelog.log.xxxxx'''<br>Logging detail level for a SimpleLog instance named "xxxxx". Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, the default logging detail level is used.	+	</nowiki>
-	* '''org.apache.commons.logging.simplelog.showlogname'''<br>Set to <code>true</~~code~~> ~~if you want the Log instance name to be included in output messages. Defaults to false.~~	+
-	* '''org.apache.commons.logging.simplelog.showShortLogname'''<br>Set to <code>true</code> if you want the last component of the name to be included in output messages. Defaults to <code>true</code>.	+
-	* '''org.apache.commons.logging.simplelog.showdatetime'''<br>Set to <code>true</code> if you want the current date and time to be included in output messages. Default is <code>false</code>.	+
-	* '''org.apache.commons.logging.simplelog.dateTimeFormat'''<br>The date and time format to be used in the output messages. The pattern describing the date and time format is the same that is used in <code>java.text.SimpleDateFormat</code>. If the format is not specified or is invalid, the default format is used. The default format is <code>yyyy/MM/dd HH:mm:ss:SSS zzz</~~code~~>.	+

84.161.191.95: /* The old outdated logging concept */

84.161.191.95 — Sun, 23 Sep 2007 15:08:59 GMT

The old outdated logging concept

←Older revision		Revision as of 15:08, 23 September 2007

	* '''org.apache.commons.logging.simplelog.showdatetime'''<br>Set to <code>true</code> if you want the current date and time to be included in output messages. Default is <code>false</code>.		* '''org.apache.commons.logging.simplelog.showdatetime'''<br>Set to <code>true</code> if you want the current date and time to be included in output messages. Default is <code>false</code>.
	* '''org.apache.commons.logging.simplelog.dateTimeFormat'''<br>The date and time format to be used in the output messages. The pattern describing the date and time format is the same that is used in <code>java.text.SimpleDateFormat</code>. If the format is not specified or is invalid, the default format is used. The default format is <code>yyyy/MM/dd HH:mm:ss:SSS zzz</code>.		* '''org.apache.commons.logging.simplelog.dateTimeFormat'''<br>The date and time format to be used in the output messages. The pattern describing the date and time format is the same that is used in <code>java.text.SimpleDateFormat</code>. If the format is not specified or is invalid, the default format is used. The default format is <code>yyyy/MM/dd HH:mm:ss:SSS zzz</code>.
-
-
-	~~== The old outdated logging concept ==~~
-
-	~~The old class responsible for logging was 'Logger'. It's still used here or there in the sources. But it will soon be replaced with the above mentioned logging concept.~~
-
-
-	~~For the logging the following keys in your phex.cfg are responsible:~~
-
-	~~<ul>~~
-	~~<li><b>mLogFile</b><br>~~
-	~~The complete file name you like to log to.<br>~~
-	~~e.g.: c:\phex\logOutput.txt<br>~~
-	~~If not set then the path~~
-	~~{user.home}/phex/phex.log or {user.home}/.phex/phex.log is used~~
-	~~<li><b>maxLogFileLength</b><br>~~
-	~~The maximal log file length in bytes. If the file is larger then this size the file is renamed to<br>~~
-	~~{original file name}.1<br>~~
-	~~The old backup of the file is overwritten.~~
-	~~<li><b>logToConsole</b><br>~~
-	~~Activates or deactivate logging to console additionally to file logging.~~
-	~~Possible values are true or false.<br>~~
-	~~On Windows logging to console only works when Phex is not started with javaw.~~
-	~~<li><b>loggerVerboseLevel</b><br>~~
-	~~There are 7 different logger verbose levels. From 0 (finest) to 6 (severe).<br>~~
-	~~The possible levels are FINEST (0), FINER (1), FINE (2), CONFIG (3), INFO (4), WARNING (5), SEVERE (6)~~
-	~~<li><b>logType</b><br>~~
-	~~The log type indicates what kind of messages you like to log. The possible types are:<br>~~
-	~~DOWNLOAD (2), UPLOAD (4), SEARCH (8), NETWORK (16), GUI (32), GLOBAL<br>~~
-	~~GLOBAL messages are always logged if inside the verbose level. To log the different types just add the numbers.<br>~~
-	~~e.g.: to log download and network set the log type to 18 (2 + 16) or to log upload, search and gui set the log type to 44 (4 + 8 + 32)~~
-	~~</ul>~~

GregorK at 14:41, 18 March 2006

GregorK — Sat, 18 Mar 2006 14:41:01 GMT

←Older revision		Revision as of 14:41, 18 March 2006

		+	[[Category:Development]]
	The Phex logging concept can be configured to support different type of logging libraries.		The Phex logging concept can be configured to support different type of logging libraries.
	It's using the [http://jakarta.apache.org/commons/logging Apache Commons Logging] API as a bridge between different common logging libraries.		It's using the [http://jakarta.apache.org/commons/logging Apache Commons Logging] API as a bridge between different common logging libraries.

82.141.48.35: /* The old outdated logging concept */ Fixed typo

82.141.48.35 — Sun, 12 Mar 2006 21:06:30 GMT

The old outdated logging concept: Fixed typo

←Older revision		Revision as of 21:06, 12 March 2006

	== The old outdated logging concept ==		== The old outdated logging concept ==

-	The old class responsible for logging was 'Logger'. It's still used here or there in the sources. But it will soon be replaced with the ~~aboved~~ mentioned logging concept.	+	The old class responsible for logging was 'Logger'. It's still used here or there in the sources. But it will soon be replaced with the above mentioned logging concept.

GregorK at 16:48, 18 January 2006

GregorK — Wed, 18 Jan 2006 16:48:08 GMT

←Older revision		Revision as of 16:48, 18 January 2006

	It's using the [http://jakarta.apache.org/commons/logging Apache Commons Logging] API as a bridge between different common logging libraries.		It's using the [http://jakarta.apache.org/commons/logging Apache Commons Logging] API as a bridge between different common logging libraries.

		+	== Logging Configuration ==
		+
		+	=== General Configuration ===
	To configure the Phex logging, you need to create a file called '''logging.properties''' inside your Phex configuration directory.		To configure the Phex logging, you need to create a file called '''logging.properties''' inside your Phex configuration directory.


	The property can have the following values:		The property can have the following values:

-	~~{\| border="1"~~	+	* '''org.apache.commons.logging.impl.Log4JLogger'''<br>For use of Log4j as a logging library.
-	~~\| valign="top" \|~~ org.apache.commons.logging.impl.Log4JLogger	+	* '''phex.utils.PhexLogger'''<br>This is the default logger for Phex.
-	\| For use of Log4j as a logging library.	+	* '''org.apache.commons.logging.impl.Jdk14Logger'''<br>For use of the JDK logging library.
-	\|-	+	* '''org.apache.commons.logging.impl.SimpleLog'''<br>To use a simple log instance of Commons Logging.
-	~~\| valign="top" \|~~ phex.utils.PhexLogger	+
-	\| This is the default logger for Phex.	+
-	\|-	+
-	~~\| valign="top" \|~~ org.apache.commons.logging.impl.Jdk14Logger	+
-	\| For use of the JDK logging library.	+
-	\|-	+
-	~~\| valign="top" \|~~ org.apache.commons.logging.impl.SimpleLog	+
-	\| To use a simple log instance of Commons Logging.	+
-	\|}	+


		+	=== Log4J Configuration ===

	When using org.apache.commons.logging.impl.Log4JLogger you can use the following additional properties:		When using org.apache.commons.logging.impl.Log4JLogger you can use the following additional properties:

	* '''log4j.configuration'''<br>File path possible with URL (file:/c%3A/MyFiles/phex/log4j.properties)		* '''log4j.configuration'''<br>File path possible with URL (file:/c%3A/MyFiles/phex/log4j.properties)
		+
		+
		+	=== Phex Logging Configuration ===

	When using phex.utils.PhexLogger you can use the following additional properties:		When using phex.utils.PhexLogger you can use the following additional properties:

	* '''phex.utils.logger.console''' = false		* '''phex.utils.logger.console''' = false
	* '''phex.utils.logger.maxFileSize''' = 524288		* '''phex.utils.logger.maxFileSize''' = 524288
		+
		+
		+	=== Commons Logging Configuration ===

	When using org.apache.commons.logging.impl.SimpleLog you can use the following additional properties:		When using org.apache.commons.logging.impl.SimpleLog you can use the following additional properties:

	* '''org.apache.commons.logging.simplelog.dateTimeFormat'''<br>The date and time format to be used in the output messages. The pattern describing the date and time format is the same that is used in <code>java.text.SimpleDateFormat</code>. If the format is not specified or is invalid, the default format is used. The default format is <code>yyyy/MM/dd HH:mm:ss:SSS zzz</code>.		* '''org.apache.commons.logging.simplelog.dateTimeFormat'''<br>The date and time format to be used in the output messages. The pattern describing the date and time format is the same that is used in <code>java.text.SimpleDateFormat</code>. If the format is not specified or is invalid, the default format is used. The default format is <code>yyyy/MM/dd HH:mm:ss:SSS zzz</code>.

-	== The outdated logging concept ==	+
		+	== The old outdated logging concept ==

	The old class responsible for logging was 'Logger'. It's still used here or there in the sources. But it will soon be replaced with the aboved mentioned logging concept.		The old class responsible for logging was 'Logger'. It's still used here or there in the sources. But it will soon be replaced with the aboved mentioned logging concept.

GregorK at 13:12, 18 January 2006

GregorK — Wed, 18 Jan 2006 13:12:37 GMT

←Older revision		Revision as of 13:12, 18 January 2006

	The Phex logging concept can be configured to support different type of logging libraries.		The Phex logging concept can be configured to support different type of logging libraries.
	It's using the [http://jakarta.apache.org/commons/logging Apache Commons Logging] API as a bridge between different common logging libraries.		It's using the [http://jakarta.apache.org/commons/logging Apache Commons Logging] API as a bridge between different common logging libraries.
		+
		+	To configure the Phex logging, you need to create a file called '''logging.properties''' inside your Phex configuration directory.
		+
		+	To configure the log instance you need to add a property called '''org.apache.commons.logging.Log'''.
		+	The property can have the following values:
		+
		+	{\| border="1"
		+	\| valign="top" \| org.apache.commons.logging.impl.Log4JLogger
		+	\| For use of Log4j as a logging library.
		+	\|-
		+	\| valign="top" \| phex.utils.PhexLogger
		+	\| This is the default logger for Phex.
		+	\|-
		+	\| valign="top" \| org.apache.commons.logging.impl.Jdk14Logger
		+	\| For use of the JDK logging library.
		+	\|-
		+	\| valign="top" \| org.apache.commons.logging.impl.SimpleLog
		+	\| To use a simple log instance of Commons Logging.
		+	\|}
		+
		+
		+
		+	When using org.apache.commons.logging.impl.Log4JLogger you can use the following additional properties:
		+
		+	* '''log4j.configuration'''<br>File path possible with URL (file:/c%3A/MyFiles/phex/log4j.properties)
		+
		+	When using phex.utils.PhexLogger you can use the following additional properties:
		+
		+	* '''phex.utils.logger.logFile''' = phex.log
		+	* '''phex.utils.logger.errorLogFile''' = phex.error.log
		+	* '''phex.utils.logger.level''' = 3
		+	* '''phex.utils.logger.console''' = false
		+	* '''phex.utils.logger.maxFileSize''' = 524288
		+
		+	When using org.apache.commons.logging.impl.SimpleLog you can use the following additional properties:
		+
		+	* '''org.apache.commons.logging.simplelog.defaultlog'''<br>Default logging detail level for all instances of SimpleLog. Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, defaults to "info".
		+	* '''org.apache.commons.logging.simplelog.log.xxxxx'''<br>Logging detail level for a SimpleLog instance named "xxxxx". Must be one of ("trace", "debug", "info", "warn", "error", or "fatal"). If not specified, the default logging detail level is used.
		+	* '''org.apache.commons.logging.simplelog.showlogname'''<br>Set to <code>true</code> if you want the Log instance name to be included in output messages. Defaults to false.
		+	* '''org.apache.commons.logging.simplelog.showShortLogname'''<br>Set to <code>true</code> if you want the last component of the name to be included in output messages. Defaults to <code>true</code>.
		+	* '''org.apache.commons.logging.simplelog.showdatetime'''<br>Set to <code>true</code> if you want the current date and time to be included in output messages. Default is <code>false</code>.
		+	* '''org.apache.commons.logging.simplelog.dateTimeFormat'''<br>The date and time format to be used in the output messages. The pattern describing the date and time format is the same that is used in <code>java.text.SimpleDateFormat</code>. If the format is not specified or is invalid, the default format is used. The default format is <code>yyyy/MM/dd HH:mm:ss:SSS zzz</code>.

	== The outdated logging concept ==		== The outdated logging concept ==

GregorK: Logging with Log4J moved to Logging API

GregorK — Wed, 18 Jan 2006 12:42:39 GMT

Logging with Log4J moved to Logging API

←Older revision

Revision as of 12:42, 18 January 2006

GregorK: /* The outdated logging concept */

GregorK — Wed, 18 Jan 2006 12:42:26 GMT

The outdated logging concept

←Older revision		Revision as of 12:42, 18 January 2006

		+	The Phex logging concept can be configured to support different type of logging libraries.
		+	It's using the [http://jakarta.apache.org/commons/logging Apache Commons Logging] API as a bridge between different common logging libraries.
		+
	== The outdated logging concept ==		== The outdated logging concept ==
		+
		+	The old class responsible for logging was 'Logger'. It's still used here or there in the sources. But it will soon be replaced with the aboved mentioned logging concept.
		+

	For the logging the following keys in your phex.cfg are responsible:		For the logging the following keys in your phex.cfg are responsible:

GregorK at 12:34, 18 January 2006

GregorK — Wed, 18 Jan 2006 12:34:11 GMT

New page

== The outdated logging concept ==

For the logging the following keys in your phex.cfg are responsible:

<ul>
<li>mLogFile 
The complete file name you like to log to. 
e.g.: c:\phex\logOutput.txt 
If not set then the path
{user.home}/phex/phex.log or {user.home}/.phex/phex.log is used
<li>maxLogFileLength 
The maximal log file length in bytes. If the file is larger then this size the file is renamed to 
{original file name}.1 
The old backup of the file is overwritten.
<li>logToConsole 
Activates or deactivate logging to console additionally to file logging.
Possible values are true or false. 
On Windows logging to console only works when Phex is not started with javaw.
<li>loggerVerboseLevel 
There are 7 different logger verbose levels. From 0 (finest) to 6 (severe). 
The possible levels are FINEST (0), FINER (1), FINE (2), CONFIG (3), INFO (4), WARNING (5), SEVERE (6)
<li>logType 
The log type indicates what kind of messages you like to log. The possible types are: 
DOWNLOAD (2), UPLOAD (4), SEARCH (8), NETWORK (16), GUI (32), GLOBAL 
GLOBAL messages are always logged if inside the verbose level. To log the different types just add the numbers. 
e.g.: to log download and network set the log type to 18 (2 + 16) or to log upload, search and gui set the log type to 44 (4 + 8 + 32)
</ul>