/ 
lsn-data-hub-05.00289
River stage zero No dependents
/ Misc::LogUtil

NAME

Misc::LogUtil - Simple logging utility with run-time context

SYNOPSIS

use Misc::LogUtil;
my $log = Misc::LogUtil->new();

Or, to capture elapsed time:

use Misc::LogUtil;
use Misc::Stopwatch;
my $sw = Misc::Stopwatch->new;
my $log = Misc::LogUtil->new($sw);
$sw->reset->start(); # Elapsed time starts now

Call logging methods:

$log->error('The code is smoking');
$log->warn('The code is hot');
$log->notice('The code is warm');
$log->info('The code is lighting up');
$log->debug('The code is doing what?');

EXPORTS

Nothing exported by default

DEPENDENCIES

This module requires these other modules and libraries:

Misc::Stopwatch
Time::Piece
Time::Regex::Strftime

DESCRIPTION

Log-file entries are formatted as:

 .--------------------------------------------- 1) Date and time
 |     .--------------------------------------- 2) Logging level
 |     |      .-------------------------------- 3) Filename and line number
 |     |      |           .-------------------- 4) Process ID, i.e., $$
 |     |      |           |       .------------ 5) Elapsed time
 |     |      |           |       |       .---- 6) Log Message
 |     |      |           |       |       |
 |     |      |           |       |       |
 v     v      v           v       v       v
[...] [warn] <test.pl:5> [22933] [0.0229] ...

PUBLIC INTERFACE

new

Construct a new instance

where:

$stopwatch  isa Misc::Stopwatch

This example will not abort:

# Create a new instance
use Misc::LogUtil;
Misc::LogUtil->new();

debug

Write a debug message to the apache log

warn

Write a warning to the apache log

error

Write an error to the apache log

notice

Write a notice to the apache log

info

Write an informational message to the apache log

message

Write to the apache log

SEE ALSO

Misc::Stopwatch

AUTHORS

Ryan Gies <ryangies@cpan.org>

COPYRIGHT

Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.
* The origin of this software must not be misrepresented; you must not 
claim that you wrote the original software. If you use this software in a 
product, an acknowledgment in the product documentation would be 
appreciated but is not required.
* Altered source versions must be plainly marked as such, and must not be 
misrepresented as being the original software.
* The name of the author may not be used to endorse or promote products 
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
OF SUCH DAMAGE.
To the best of our knowledge, no patented algorithms have been used. However, we
do not have the resources to carry out a patent search, and therefore cannot 
give any guarantee of the above statement.