Manual

Reference

Modules

  • A • B • C • D • E
  • F • G • H • I • L
  • M • N • O • P • S
  • T • U • X

Tools

Log::Message::Simple

Perl 5 version 12.2 documentation
Go to top
Show page index • Show recent pages
Recently read

Log::Message::Simple

NAME

Log::Message::Simple - Simplified interface to Log::Message

SYNOPSIS

  1.     use Log::Message::Simple qw[msg error debug
  2.                                 carp croak cluck confess];
  4.     use Log::Message::Simple qw[:STD :CARP];
  6.     ### standard reporting functionality
  7.     msg(    "Connecting to database",           $verbose );
  8.     error(  "Database connection failed: $@",   $verbose );
  9.     debug(  "Connection arguments were: $args", $debug );
  11.     ### standard carp functionality
  12.     carp(   "Wrong arguments passed: @_" );
  13.     croak(  "Fatal: wrong arguments passed: @_" );
  14.     cluck(  "Wrong arguments passed -- including stacktrace: @_" );
  15.     confess("Fatal: wrong arguments passed -- including stacktrace: @_" );
  17.     ### retrieve individual message
  18.     my @stack = Log::Message::Simple->stack;
  19.     my @stack = Log::Message::Simple->flush;
  21.     ### retrieve the entire stack in printable form
  22.     my $msgs  = Log::Message::Simple->stack_as_string;
  23.     my $trace = Log::Message::Simple->stack_as_string(1);
  25.     ### redirect output
  26.     local $Log::Message::Simple::MSG_FH     = \*STDERR;
  27.     local $Log::Message::Simple::ERROR_FH   = \*STDERR;
  28.     local $Log::Message::Simple::DEBUG_FH   = \*STDERR;
  29.     
  30.     ### force a stacktrace on error
  31.     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 the GLOBAL VARIABLES section below), if the VERBOSE option is true. The VERBOSE 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 the GLOBAL VARIABLES section below), if the VERBOSE option is true. The VERBOSE 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 the GLOBAL VARIABLES sections below), if the VERBOSE option is true. The VERBOSE 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 using Log::Message , consult its manpage for the function retrieve 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 with Carp::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 using Log::Message , consult its manpage for the function retrieve 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 to error() will generate a stacktrace using Carp::shortmess() . Defaults to false

Page index