-
-
23 Jan 2013 08:18:41 UTC
- Distribution: Log-Message-Simple
- Module version: 0.10
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Repository
- Issues (0)
- Testers (5904 / 0 / 0)
- Kwalitee
Bus factor: 1- 79.53% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (5.58KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- Carp
- Log::Message
- Test::More
- if
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Log::Message::Simple - Simplified interface to Log::Message
SYNOPSIS
use Log::Message::Simple qw[msg error debug carp croak cluck confess]; use Log::Message::Simple qw[:STD :CARP]; ### standard reporting functionality msg( "Connecting to database", $verbose ); error( "Database connection failed: $@", $verbose ); debug( "Connection arguments were: $args", $debug ); ### standard carp functionality carp( "Wrong arguments passed: @_" ); croak( "Fatal: wrong arguments passed: @_" ); cluck( "Wrong arguments passed -- including stacktrace: @_" ); confess("Fatal: wrong arguments passed -- including stacktrace: @_" ); ### retrieve individual message my @stack = Log::Message::Simple->stack; my @stack = Log::Message::Simple->flush; ### retrieve the entire stack in printable form my $msgs = Log::Message::Simple->stack_as_string; my $trace = Log::Message::Simple->stack_as_string(1); ### redirect output local $Log::Message::Simple::MSG_FH = \*STDERR; local $Log::Message::Simple::ERROR_FH = \*STDERR; local $Log::Message::Simple::DEBUG_FH = \*STDERR; ### force a stacktrace on error local $Log::Message::Simple::STACKTRACE_ON_ERROR = 1
DESCRIPTION
This module provides standardized logging facilities using the
Log::Message
module.FUNCTIONS
msg("message string" [,VERBOSE])
Records a message on the stack, and prints it to
STDOUT
(or actually$MSG_FH
, see theGLOBAL VARIABLES
section below), if theVERBOSE
option is true. TheVERBOSE
option defaults to false.Exported by default, or using the
:STD
tag.debug("message string" [,VERBOSE])
Records a debug message on the stack, and prints it to
STDOUT
(or actually$DEBUG_FH
, see theGLOBAL VARIABLES
section below), if theVERBOSE
option is true. TheVERBOSE
option defaults to false.Exported by default, or using the
:STD
tag.error("error string" [,VERBOSE])
Records an error on the stack, and prints it to
STDERR
(or actually$ERROR_FH
, see theGLOBAL VARIABLES
sections below), if theVERBOSE
option is true. TheVERBOSE
options defaults to true.Exported by default, or using the
:STD
tag.carp();
Provides functionality equal to
Carp::carp()
while still logging to the stack.Exported by using the
:CARP
tag.croak();
Provides functionality equal to
Carp::croak()
while still logging to the stack.Exported by using the
:CARP
tag.confess();
Provides functionality equal to
Carp::confess()
while still logging to the stack.Exported by using the
:CARP
tag.cluck();
Provides functionality equal to
Carp::cluck()
while still logging to the stack.Exported by using the
:CARP
tag.CLASS METHODS
Log::Message::Simple->stack()
Retrieves all the items on the stack. Since
Log::Message::Simple
is implemented usingLog::Message
, consult its manpage for the functionretrieve
to see what is returned and how to use the items.Log::Message::Simple->stack_as_string([TRACE])
Returns the whole stack as a printable string. If the
TRACE
option is true all items are returned withCarp::longmess
output, rather than just the message.TRACE
defaults to false.Log::Message::Simple->flush()
Removes all the items from the stack and returns them. Since
Log::Message::Simple
is implemented usingLog::Message
, consult its manpage for the functionretrieve
to see what is returned and how to use the items.GLOBAL VARIABLES
- $ERROR_FH
-
This is the filehandle all the messages sent to
error()
are being printed. This defaults to*STDERR
. - $MSG_FH
-
This is the filehandle all the messages sent to
msg()
are being printed. This default to*STDOUT
. - $DEBUG_FH
-
This is the filehandle all the messages sent to
debug()
are being printed. This default to*STDOUT
. - $STACKTRACE_ON_ERROR
-
If this option is set to
true
, every call toerror()
will generate a stacktrace usingCarp::shortmess()
. Defaults tofalse
Module Install Instructions
To install Log::Message::Simple, copy and paste the appropriate command in to your terminal.
cpanm Log::Message::Simple
perl -MCPAN -e shell install Log::Message::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.