NAME
Smart::Comments::Log4perl - An extension of Smart::Comments to utilize Log::Log4perl for all output
VERSION
Version 1.00
SYNOPSIS
Smart:Comments is a great module which allows debug to be completely ignored during normal execution, but have debug entries fire when necessary. Log4perl turns logging up a notch, allowing easy logging to STDOUT/STDERR or file handles easily. This seeks to combine the two in a useful manner.
Here's a brief code snippet.
use Smart::Comments::Log4perl;
my $foo = {};
### Log a varianble: $foo;
...CONFIGURATION
Configuration of Log4Perl is very simple by default, with no additional decorations above Smart::Comments, with a to-screen logger that logs at debug and above. Wholesale configuration may be done via a Log4perl configuration file, which can be loaded into the system by either setting the SCL4P_CONFIG environment variable to the location of the file or by placing the following line: ### l4p_config: 'config/location' Variables may also be used in this configuration: ### l4p_config: "/log_root/$log_file"
Please note: Once a single line of logging has occurred, the ### l4p_config lines will be ignored, as there is no way to re-intialize the Log4perl system at the moment.
LOGGING
All normal ### smart comments will, by default, be logged as INFO level logs. The level for regular smart comments may be changed by calling the meta-command: ### l4p_level: 'INFO' (Other valid options are FATAL, WARN, DEBUG, and TRACE) A single line of logging may be run at a different level by a matching meta-command per level: ### l4p_trace: 'This is a TRACE level log' Note that anything after the : must evaluate to a valid Perl string in order to log successfully. Analog meta-commands exist for all 5 available log levels
EXPORT
SUBROUTINES/METHODS
AUTHOR
Tracy Beck, <tgbeck at acm.org>
BUGS
Please report any bugs or feature requests to bug-smart-comments-log4perl at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Smart-Comments-Log4perl. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Smart::Comments::Log4perlYou can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Smart-Comments-Log4perl
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
Search CPAN
ACKNOWLEDGEMENTS
LICENSE AND COPYRIGHT
Copyright 2015 Tracy Beck.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.