FS::Log - Freeside event log
use FS::Log;
sub do_something { my $log = FS::Log->new('do_something'); # set log context to 'do_something'
...
if ( $error ) {
$log->error('something is wrong: '.$error);
return $error;
}
# at this scope exit, do_something is removed from context
}
FS::Log provides an interface for logging errors and profiling information to the database. FS::Log inherits from Log::Dispatch.
new CONTEXT
Constructs and returns a log handle. CONTEXT must be a known context tag indicating what activity is going on, such as the name of the function or script that is executing.
Log context is a stack, and each element is removed from the stack when it goes out of scope. So don't keep log handles in persistent places (i.e. package variables or class-scoped lexicals).
context
Returns the current context stack.
log LEVEL, MESSAGE[, OPTIONS ]
Like Log::Dispatch::log, but OPTIONS may include:
- agentnum - object (an <FS::Record> object to reference in this log message) - tablename and tablenum (an alternate way of specifying 'object')
levelnums
Subroutine. Returns ordered list of level nums.
levelmap
Subroutine. Returns ordered map of level num => level name.
Hey! The above document had some coding errors, which are explained below:
You can't have =items (as at line 85) unless the first thing after the =over is an =item
=over without closing =back