NAME¶

App::CELL::Log - the Logging part of CELL

SYNOPSIS¶

    use App::CELL::Log qw( $log );
    # set up logging for application FooBar -- need only be done once
    $log->init( ident => 'FooBar' );  
    # do not suppess 'trace' and 'debug' messages
    $log->init( debug_mode => 1 );     
    # do not append filename and line number of caller
    $log->init( show_caller => 0 );
    # log messages at different log levels
    my $level = 'warn'  # can be any of the levels provided by Log::Any
    $log->$level ( "Foobar log message" );
    # the following App::CELL-specific levels are supported as well
    $log->ok       ( "Info-level message prefixed with 'OK: '");
    $log->not_ok   ( "Info-level message prefixed with 'NOT_OK: '");
    # by default, the caller's filename and line number are appended
    # to suppress this for an individual log message:
    $log->debug    ( "Debug-level message", suppress_caller => 1 );
    # Log a status object (happens automatically when object is
    # constructed)
    $log->status_obj( $status_obj );
    # Log a message object
    $log->message_obj( $message_obj );

EXPORTS¶

This module provides the following exports:

$log - App::CELL::Log singleton

PACKAGE VARIABLES¶

$ident - the name of our application

$show_caller - boolean value, determines if caller information is displayed in log messages

$debug_mode - boolean value, determines if we display debug messages

$log - App::CELL::Log singleton object

$log_any_obj - Log::Any singleton object

@permitted_levels - list of permissible log levels

DESCRIPTION¶

App::CELL's logs using Log::Any. This "App::CELL::Log" module exists to: (1) provide documentation, (2) store the logging category ($ident), (3) store the Log::Any log object, (4) provide convenience functions for logging 'OK' and 'NOT_OK' statuses.

METHODS¶

    $log->debug_mode(0); # turn debug mode off
    $log->debug_mode(1); # turn debug mode on
    print "Debug mode is on\n" if $log->debug_mode;