|
NAMEFile::Log - A simple Object Orientated LoggerSYNOPSISuse File::Log; # Pretty format, all the parameters my $log = File::Log->new({ debug => 4, # Set the debug level logFileName => 'myLogFile.log', # define the log filename logFileMode => '>', # '>>' Append or '>' overwrite dateTimeStamp => 1, # Timestamp log data entries stderrRedirect => 1, # Redirect STDERR to the log file defaultFile => 1, # Use the log file as the default filehandle logFileDateTime => 1, # Timestamp the log filename appName => 'myApplicationName', # The name of the application PIDstamp => 1, # Stamp the log data with the Process ID storeExpText => 1, # Store internally all exp text msgprepend => '', # Text to prepend to each message say => 1, # msg() and exp() methode act like the perl6 say # command (default off) requested by Aaleem Jiwa # however it might be better to just use the say() # method }); # Minimal instance, logfile name based on application name my $log = File::Log->new(); # Typical usage, set the debug level and log filename (say from a config file) my $log = File::Log->new(debug => $debugLevel, logFileName => $logFileName,); # Print message to the log file if the debug is >= 2 $log->msg(2, "Add this to the log file if debug >= 2\n"); # Print message to the log file if the debug is >= 2 (but in a perl6 way) $log->say(2, "Add this to the log file if debug >= 2"); # Print an exception (error) message to the log file $log->exp("Something went wrong\n"); # Close the log file (optional at exit) $log->close(); # Change the debug level, capturing the old value $oldDebugValue = $log->debugValue($newDebugValue); $currentDebugValue = $log->debugValue(); # Get all the exceptions text (so you can do something with all the errors, eg email them) $allExceptions = $log->getExpText(); $numberErrors = $log->expCnt(); # How many times has $log->exp been called DESCRIPTIONFile::Log is a class providing methods to log data to a file. There are a number of parameters that can be passed to allow configuration of the logger.REQUIRED MODULESCarp (confess is used), FindBin and Symbol;METHODSThere are no class methods, the object methods are described below. Private class method start with the underscore character '_' and should be treated as Private.newCalled to create a File::Log object. The following optional named parameters can be passed to the constructor via an anonymous hash:
_init & Private methodsPrivate method to initialise the object on construction. Called by "new()". All Private methods start with _ and should be treated as PRIVATE. No other private methods are documented (since they are private).msgThe "msg" method is used to log a message to the log file. The first POSITIONAL argument to "msg" is the "debug level" at which the message should be added to the log file if the instance "debug value" is greater than or equal to the "debug level".The second and optional subsiquent arguments are treated as text to print to the log file. eg. $log->msg(2, "Printed to log file if 'debug' is greater than or equal to 2 \n"); Note that newline characters are not automatically appended by this method. saySame as msg except a newline '\n' is appended to the end of the lineexp"exp" is used to report exceptions. There is no "debug level" parameter, just one or more text strings which are printed to the log file. The text printed has "**" prepended to each line (this occurs before prepended timestamp or PID values).Note that newline characters are not automatically appended by this method. closeCloses the file handle associated with the log file.DESTROY"DESTROY" is defined and closes the file handle associated with the log file.PIDstampThe "PIDstamp" method can be used to set or get the value of the PIDstamp instance variable. If called without parameters, the current value of the PIDstamp instance variable is returned. If called with a parameter, the parameter is used to set the PIDstamp instance variable and the previous value is returned.Refer to the "new" method for further information. dateTimeStampThe "dateTimeStamp" method can be used to set or get the value of the dateTimeStamp instance variable. If called without parameters, the current value of the dateTimeStamp instance variable is returned. If called with a parameter, the parameter is used to set the dateTimeStamp instance variable and the previous value is returned.Refer to the "new" method for further information. debugValueThe "debugValue" method can be used to set or get the value of the debugValue instance variable. If called without parameters, the current value of the debugValue instance variable is returned. If called with a parameter, the parameter is used to set the debugValue instance variable and the previous value is returned.Refer to the "new" method for further information. expTextThe "expText" method can be used to set or get the value of the storeexptext instance variable. If called without parameters, the current value of the storeexptext instance variable is returned. If called with a parameter, the parameter is used to set the storeexptext instance variable and the previous value is returned.Refer to the "new" method for further information. getExpTextThe "expText" method is used to retreive the stored value of the instance "Exception Text".clearExpTextThe "clearExpText" method is used to clear the stored value of the instance "Exception Text".expCntThe "expCnt" method is used to retreive the number of times that the exp method has been called for this object.getLogFileNameThe "getLogFileName" method is used to retreive the actual log file name used for this object.PROPERTIESsee the "new" method.KNOWN ISSUESNone, however please contact the author at gng@cpan.org should you find any problems and I will endevour to resolve then as soon as possible.If you have any enhancement suggestions please send me an email and I will try to accommodate your suggestion. Setting 'say' to true in the new() method and then using the say() method will give you two newlines. ENHANCEMENT REQUEST/BUGSThanks to the following for enhancement suggestions or bug reports:Aaleem Jiwa - say() method Paul K - msgprepend and dateformat AUTHORGreg George, IT Technology Solutions P/L, Australia Mobile: +61-404-892-159, Email: gng@cpan.org LICENSECopyright (c) 1999- Greg George. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.CVS ID$Id: Log.pm,v 1.5 2008/03/01 02:56:01 Greg Exp $CHANGE HISTORY$Log: Log.pm,v $ Revision 1.5 2008/03/01 02:56:01 Greg - Updated Makefile.PL to include prereq for Encode as I was getting cpan tester errors. NO CODE CHANGES Revision 1.4 2008/02/26 08:54:31 Greg - Updated POD Revision 1.3 2007/07/17 11:23:49 Greg - Added say() method - Added say, msgprepend and dateFormat arguments to new() - Added pre close of STDERR Revision 1.2 2004/10/08 23:10:14 Greg - Changed new() to allow named argument as well as the anonymous hash reference. Revision 1.1.1.1 2004/07/29 11:15:06 Greg - Initial release to CPAN
Visit the GSP FreeBSD Man Page Interface. |