Studio:Log.pm - Revision history

Timd: Text replace - 'Category: Libraries' to 'Category:Studio:Libraries'

2009-08-20T23:26:07Z

Text replace - 'Category: Libraries' to 'Category:Studio:Libraries'

← Older revision		Revision as of 23:26, 20 August 2009
Line 402:		Line 402:


	[[Category: Libraries]]		[[Category:Studio:Libraries]]

Timd: Log.pm moved to Studio:Log.pm

2009-08-18T22:05:39Z

Log.pm moved to Studio:Log.pm

← Older revision	Revision as of 22:05, 18 August 2009
(No difference)

Timd: /* info() */

2008-12-02T23:30:08Z

info()

← Older revision		Revision as of 23:30, 2 December 2008
Line 332:		Line 332:
	$log->info("this is an info message");		$log->info("this is an info message");
	my $number = 32767;		my $number = 32767;
	$log->~~debug~~("you can also use sprintf: %x %e ", $number, $number);		$log->info("you can also use sprintf: %x %e ", $number, $number);
	</source>		</source>

Line 342:		Line 342:
	arguments as FORMAT, LIST if desired. (Useful for number formatting, changing radix,		arguments as FORMAT, LIST if desired. (Useful for number formatting, changing radix,
	etc.) See [[http://perldoc.perl.org/functions/sprintf.html]]		etc.) See [[http://perldoc.perl.org/functions/sprintf.html]]


	== warning() ==		== warning() ==

Timd: /* Message Levels */

2008-12-02T23:26:48Z

Message Levels

← Older revision		Revision as of 23:26, 2 December 2008
Line 138:		Line 138:
	From lowest to highest, the module defines the following levels:		From lowest to highest, the module defines the following levels:


	* DEBUG		* DEBUG
			* INFO
	* WARNING		* WARNING
	* ERROR		* ERROR

Timd: /* Example */

2008-12-02T23:24:50Z

Example

← Older revision		Revision as of 23:24, 2 December 2008
Line 70:		Line 70:

	$log->debug('this is a debug test message');		$log->debug('this is a debug test message');
			$log->info('this is an info test message');
	$log->warning('this is a warning test message');		$log->warning('this is a warning test message');
	$log->error('this is an error test message');		$log->error('this is an error test message');
Line 77:		Line 78:

	$log->debug('this is another debug test message: %x and %e ', $number, $number);		$log->debug('this is another debug test message: %x and %e ', $number, $number);
			$log->info('this is another info test message');
	$log->warning('this is another warning test message');		$log->warning('this is another warning test message');
	$log->error('this is another error test message');		$log->error('this is another error test message');

Timd: /* Functions */

2008-12-02T23:23:02Z

Functions

← Older revision		Revision as of 23:23, 2 December 2008
Line 178:		Line 178:

	;<code>level</code> key		;<code>level</code> key
	:Determines minimum logging level for this output. Valid values are 'debug', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).		:Determines minimum logging level for this output. Valid values are 'debug', 'info', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).

	== addFile() ==		== addFile() ==
Line 194:		Line 194:

	;<code>level</code> key		;<code>level</code> key
	:Determines minimum logging level for this output. Valid values are 'debug', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).		:Determines minimum logging level for this output. Valid values are 'debug', 'info', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).

	;<code>filename</code> key		;<code>filename</code> key
Line 214:		Line 214:

	;<code>level</code> key		;<code>level</code> key
	:Determines minimum logging level for this output. Valid values are 'debug', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).		:Determines minimum logging level for this output. Valid values are 'debug', 'info', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).

	;<code>messageOwner</code> key		;<code>messageOwner</code> key
Line 259:		Line 259:

	;<code>level</code> key		;<code>level</code> key
	:Determines minimum logging level for this output. Valid values are 'debug', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).		:Determines minimum logging level for this output. Valid values are 'debug', info', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).

	;<code>testCase</code> key		;<code>testCase</code> key
Line 278:		Line 278:

	;<code>level</code> key		;<code>level</code> key
	:Determines minimum logging level for this output. Valid values are 'debug', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).		:Determines minimum logging level for this output. Valid values are 'debug', 'info', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).

	;<code>testSuite</code> key		;<code>testSuite</code> key
Line 300:		Line 300:

	;<code>level</code> key		;<code>level</code> key
	:Determines minimum logging level for this output. Valid values are 'debug', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).		:Determines minimum logging level for this output. Valid values are 'debug', 'info', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).

	;<code>logTo</code> key		;<code>logTo</code> key
Line 311:		Line 311:
	<source lang="perl">		<source lang="perl">
	# $tc is the test case to be logged to		# $tc is the test case to be logged to
	$log-~~Edebug~~("this is a debug message");		$log->debug("this is a debug message");
	my $number = 32767;		my $number = 32767;
	$log-~~Edebug~~("you can also use sprintf: %x %e ", $number, $number);		$log->debug("you can also use sprintf: %x %e ", $number, $number);
	</source>		</source>

Line 323:		Line 323:
	arguments as FORMAT, LIST if desired. (Useful for number formatting, changing radix,		arguments as FORMAT, LIST if desired. (Useful for number formatting, changing radix,
	etc.) See [[http://perldoc.perl.org/functions/sprintf.html]]		etc.) See [[http://perldoc.perl.org/functions/sprintf.html]]

			== info() ==
			Writes a message with the INFO level to all added outputs.

			<source lang="perl">
			$log->info("this is an info message");
			my $number = 32767;
			$log->debug("you can also use sprintf: %x %e ", $number, $number);
			</source>

			'''arg1: <code>$msg</code>'''

			String to be logged.

			Note that the argument(s) you supply here are passed to sprintf, so you can supply
			arguments as FORMAT, LIST if desired. (Useful for number formatting, changing radix,
			etc.) See [[http://perldoc.perl.org/functions/sprintf.html]]


	== warning() ==		== warning() ==

Timd: /* Functions */

2008-12-02T22:38:47Z

Functions

← Older revision		Revision as of 22:38, 2 December 2008
Line 170:		Line 170:

	<source lang="perl">		<source lang="perl">
	$log->addStudio({level => 'error'});		$log->addStudio(level => 'error');
	</source>		</source>

Line 186:		Line 186:

	<source lang="perl">		<source lang="perl">
	$log->addFile({level => 'error', filename => "C:\\myLog\\mylog.txt"});		$log->addFile(level => 'error', filename => "C:\\myLog\\mylog.txt");
	</source>		</source>

Line 206:		Line 206:
	# a broadcast message has been captured with the name 'logMSG'		# a broadcast message has been captured with the name 'logMSG'
	my $logMsg = $main::ascript->Messages->Item("logMSG")->Owner;		my $logMsg = $main::ascript->Messages->Item("logMSG")->Owner;
	$log->addBCMessage({level => 'error', messageOwner => $logMSG});		$log->addBCMessage(level => 'error', messageOwner => $logMSG);
	</source>		</source>

Line 251:		Line 251:
	<source lang="perl">		<source lang="perl">
	# $tc is the test case to be logged to		# $tc is the test case to be logged to
	$log->addTestCast({level => 'error', testCase => $tc});>		$log->addTestCast(level => 'error', testCase => $tc);>
	</source>		</source>

Line 270:		Line 270:
	<source lang="perl">		<source lang="perl">
	# $ts is the test suite to be logged to		# $ts is the test suite to be logged to
	$log->addAnnotation({level => 'error', testSuite => $ts});>		$log->addAnnotation(level => 'error', testSuite => $ts);>
	</source>		</source>

Line 284:		Line 284:

	If the annotation does not exist, then it is created on first write. Upon creation, the comment label is set to: "[LEVEL] Log Message" (where LEVEL is one of: DEBUG, WARNING, ERROR, FATAL) and the annotation level is set to correspond to the level indicated in the label (note that WARNING is mapped to the ''warn'' level.).		If the annotation does not exist, then it is created on first write. Upon creation, the comment label is set to: "[LEVEL] Log Message" (where LEVEL is one of: DEBUG, WARNING, ERROR, FATAL) and the annotation level is set to correspond to the level indicated in the label (note that WARNING is mapped to the ''warn'' level.).



			== addScreen() ==

			Adds the console window as an output of this logger. The output will be seen only if the script using the logger was invoked from the command line.

			<source lang="perl">
			$log->addScreen(level => 'error', logTo => 'STDERR');>
			</source>

			'''arg1: <code>$params</code> ''(Optional)'''''

			An anonymous hash; string values at keys are as follows:

			;<code>level</code> key
			:Determines minimum logging level for this output. Valid values are 'debug', 'warning', 'error', and 'fatal'. Defaults to 'debug' if omitted (all messages logged).

			;<code>logTo</code> key
			:Sets the output stream to be logged to. Valid values are 'STDOUT' and 'STDERR'. Defaults to 'STDOUT' if omitted.


	== debug() ==		== debug() ==

Timd: /* Description */

2008-12-02T22:33:14Z

Description

← Older revision		Revision as of 22:33, 2 December 2008
Line 122:		Line 122:
	*A test suite annotation		*A test suite annotation
	*A broadcast message		*A broadcast message
			*The console window (when script is running from the command line)

	== Message Levels ==		== Message Levels ==
Line 151:		Line 152:
	This module derives from from '''Log::Handler'''. If you need advanced functionality,		This module derives from from '''Log::Handler'''. If you need advanced functionality,
	please see [[http://search.cpan.org/~bloonix/Log-Handler-0.49/lib/Log/Handler.pm]]		please see [[http://search.cpan.org/~bloonix/Log-Handler-0.49/lib/Log/Handler.pm]]



	= Functions =		= Functions =

Timd: /* Example */

2008-12-02T16:49:31Z

Example

← Older revision		Revision as of 16:49, 2 December 2008
Line 57:		Line 57:


	my $log = new Log;		my $log = new S2S::Log;

	$log->addStudio(); # accept defaults		$log->addStudio(); # accept defaults
Line 63:		Line 63:
	$log->addFile(); # accept defaults		$log->addFile(); # accept defaults

	$log->addBCMessage(		$log->addBCMessage(messageOwner => $logMsg);
	{
	messageOwner => $logMsg
	}
	);

	$log->addTestCase(		$log->addTestCase(testCase => $tc);
	{
	testCase => $tc
	}
	);

	$log->addAnnotation(		$log->addAnnotation(testSuite => $main::testSuite);
	{
	testSuite => $main::testSuite
	}
	);

	$log->debug('this is a debug test message');		$log->debug('this is a debug test message');

Timd: /* Functions */

2008-12-01T20:18:02Z

Functions

← Older revision		Revision as of 20:18, 1 December 2008
Line 202:		Line 202:
	</source>		</source>

	~~===~~arg1: <code>$params</code> ''(optional)''~~===~~		'''arg1: <code>$params</code> ''(optional)'''''

	An anonymous hash; string values at keys are as follows:		An anonymous hash; string values at keys are as follows:

Line 221:		Line 222:
	</source>		</source>

	~~===~~arg1: <code>$params</code> ''(NOT optional; the messageOwner must be specified)''~~===~~		'''arg1: <code>$params</code> ''(NOT optional; the messageOwner must be specified)'''''

	An anonymous hash; string values at keys are as follows:		An anonymous hash; string values at keys are as follows:

Line 265:		Line 267:
	</source>		</source>

	~~===~~arg1: <code>$params</code> ''(NOT optional; testCase must be specified)''~~===~~		'''arg1: <code>$params</code> ''(NOT optional; testCase must be specified)'''''

	An anonymous hash; string values at keys are as follows:		An anonymous hash; string values at keys are as follows:

Line 283:		Line 286:
	</source>		</source>

	~~===~~arg1: <code>$params</code> ''(NOT optional; testSuite must be specified)''~~===~~		'''arg1: <code>$params</code> ''(NOT optional; testSuite must be specified)'''''

	An anonymous hash; string values at keys are as follows:		An anonymous hash; string values at keys are as follows:

Line 304:		Line 308:
	</source>		</source>

	~~===~~arg1: <code>$msg</code>~~===~~		'''arg1: <code>$msg</code>'''

	String to be logged.		String to be logged.

Line 322:		Line 327:
	</source>		</source>

	~~===~~arg1: <code>$msg</code>~~===~~		'''arg1: <code>$msg</code>'''

	String to be logged.		String to be logged.

Line 340:		Line 346:
	</source>		</source>

	~~===~~arg1: <code>$msg</code>~~===~~		'''arg1: <code>$msg</code>'''

	String to be logged.		String to be logged.

Line 358:		Line 365:
	</source>		</source>

	~~===~~arg1: <code>$msg</code>~~===~~		'''arg1: <code>$msg</code>'''

	String to be logged.		String to be logged.