Log::Agent::Logger - a logging interface

 require Log::Agent::Logger;

 my $log = Log::Agent::Logger->make(
     -channel    => $chan,
     -max_prio   => 'info',
     -min_prio   => 'emerg',
 );

 $log->error("can't open file %s: $!", $file);
 $log->warning("can't open file: $!");

The CWLog::Agent::Logger class defines a generic interface for application logging. It must not be confused with the interface provided by Log::Agent, which is meant to be used by re-usable modules that do not wish to commit on a particular logging method, so that they remain true building blocks.

By contrast, CWLog::Agent::Logger explicitely requests an object to be used, and that object must commit upon the logging channel to be used, at creation time.

Optionally, minimum and maximum priority levels may be defined (and changed dynamically) to limit the messages to effectively log, depending on the advertised priority. The standard syslog(3) priorities are used.

The following channels are available:

Those channels are documented in Log::Agent::Channel.

Future CWLog::Agent::Logger extension will extend the set of available channels.

The creation routine is called CWmake and takes the following switches: Request that caller information (relative to the ->log() call) be part of the log message. The given parameters are handed off to the creation routine of CWLog::Agent::Tag::Caller and are documented there. I usually say something like:

 -caller => [ -display => '($sub/$line)', -postfix => 1 ]

        -priority => [ -display => '[$priority]' ]

Each routine is documented to take a single string, but you may also supply a code reference as the first argument, followed by extra arguments. That routine will be called, along with the extra arguments, to generate the message to be logged. If that sounds crazy, think about the CPU time we save by NOT calling the routine. If nothing is returned by the routine, nothing is logged.

If more than one argument is given, and the first argument is not a code reference, then it is taken as a printf() format, and the remaining arguments are used to fill the various % placeholders in the format. The special %m placeholder does not make use of any extra argument and is replaced by a stringification of the error message contained in $!, aka CWerrno.

There is a logging routine defined for each syslog(3) priority, along with aliases for some of them. Here is an exhaustive table, sorted by decreasing priority.

    Syslog     Alias
    --------   ---------
    emerg      emergency
    alert
    crit       critical
    err        error
    warning    warn
    notice
    info
    debug

We shall document only one routine for a given level: for instance, we document CWwarn but you could also use the standard CWwarning to achieve exactly the same funciton. Log at the emerg level, usually just before panicing. Something terribly bad has been detected, and the program might crash soon after logging this. Log at the alert level, to signal a problem requiring immediate attention. Usually, some functionality will be missing until the condition is fixed. Log at the crit level, to signal a severe error that prevents fulfilling some activity. Log at the err level, to signal a regular error. Log at the warning level, which is an indication that something unusual occurred. Log at the notice level, indicating something that is fully handled by the applicaiton, but which is not the norm. A significant condition, as they say. Log at the info level, for their amusement. Log at the debug level, to further confuse them.

This routine closes the channel. Further logging to the logger is permitted, but will be simply discarded without notice.

The following access routines are defined: The defined logging channel. Cannot be changed. Returns the maximum priority recorded, either as a numeric value or as a string. For the correspondance between the two, see Log::Agent::Priorities. Returns the minimum priority recorded, either as a numeric value or as a string. For the correspondance between the two, see Log::Agent::Priorities. Dynamically change the caller information formatting in the logs. The list given supersedes the initial settings done via the CW-caller argument, if any, and is passed to the creation routine of the CWLog::Agent::Tag::Caller class. Note that a plain list must be given, not a list ref. An empty list removes caller information from subsequent logs. Please see Log::Agent::Tag::Caller to get the allowed parameters for list. Used to modify the maximum/minimum priorities. You can use either the string value or the numerical equivalent, as documented in Log::Agent::Priorities. Dynamically change the priority information formatting in the logs. The list given supersedes the initial settings done via the CW-priority argument, if any, and is passed to the creation routine of the CWLog::Agent::Tag::Priority class. Note that a plain list must be given, not a list ref. An empty list removes priority information from subsequent logs. Please see Log::Agent::Tag::Priority to get the allowed parameters for list. Returns a CWLog::Agent::Tag_List object, which holds all user-defined tags that are to be added to each log message. The initial list of tags is normally supplied by the application at creation time, via the CW-tags argument. See Log::Agent::Tag_List for the operations that can be performed on that object.

Raphael Manfredi <Raphael_Manfredi@pobox.com>

Log::Agent::Channel(3).