log::message::handlers5.18(3pm) [mojave man page]
Log::Message::Handlers(3pm) Perl Programmers Reference Guide Log::Message::Handlers(3pm) NAME
Log::Message::Handlers - Message handlers for Log::Message SYNOPSIS
# Implicitly used by Log::Message to serve as handlers for # Log::Message::Item objects # Create your own file with a package called # Log::Message::Handlers to add to the existing ones, or to even # overwrite them $item->carp; $item->trace; DESCRIPTION
Log::Message::Handlers provides handlers for Log::Message::Item objects. The handler corresponding to the level (see Log::Message::Item manpage for an explanation about levels) will be called automatically upon storing the error. Handlers may also explicitly be called on an Log::Message::Item object if one so desires (see the Log::Message manpage on how to retrieve the Item objects). Default Handlers log Will simply log the error on the stack, and do nothing special carp Will carp (see the Carp manpage) with the error, and add the timestamp of when it occurred. croak Will croak (see the Carp manpage) with the error, and add the timestamp of when it occurred. cluck Will cluck (see the Carp manpage) with the error, and add the timestamp of when it occurred. confess Will confess (see the Carp manpage) with the error, and add the timestamp of when it occurred die Will simply die with the error message of the item warn Will simply warn with the error message of the item trace Will provide a traceback of this error item back to the first one that occurred, clucking with every item as it comes across it. Custom Handlers If you wish to provide your own handlers, you can simply do the following: o Create a file that holds a package by the name of "Log::Message::Handlers" o Create subroutines with the same name as the levels you wish to handle in the Log::Message module (see the Log::Message manpage for explanation on levels) o Require that file in your program, or add it in your configuration (see the Log::Message::Config manpage for explanation on how to use a config file) And that is it, the handler will now be available to handle messages for you. The arguments a handler may receive are those specified by the "extra" key, when storing the message. See the Log::Message manpage for details on the arguments. SEE ALSO
Log::Message, Log::Message::Item, Log::Message::Config AUTHOR
This module by Jos Boumans <kane@cpan.org>. Acknowledgements Thanks to Ann Barcomb for her suggestions. COPYRIGHT
This module is copyright (c) 2002 Jos Boumans <kane@cpan.org>. All rights reserved. This library is free software; you may redistribute and/or modify it under the same terms as Perl itself. perl v5.18.2 2014-01-06 Log::Message::Handlers(3pm)
Check Out this Related Man Page
Log::Message::Item(3pm) Perl Programmers Reference Guide Log::Message::Item(3pm) NAME
Log::Message::Item - Message objects for Log::Message SYNOPSIS
# Implicitly used by Log::Message to create Log::Message::Item objects print "this is the message's id: ", $item->id; print "this is the message stored: ", $item->message; print "this is when it happened: ", $item->when; print "the message was tagged: ", $item->tag; print "this was the severity level: ", $item->level; $item->remove; # delete the item from the stack it was on # Besides these methods, you can also call the handlers on # the object specifically. # See the Log::Message::Handlers manpage for documentation on what # handlers are available by default and how to add your own DESCRIPTION
Log::Message::Item is a class that generates generic Log items. These items are stored on a Log::Message stack, so see the Log::Message manpage about details how to retrieve them. You should probably not create new items by yourself, but use the storing mechanism provided by Log::Message. However, the accessors and handlers are of interest if you want to do fine tuning of how your messages are handled. The accessors and methods are described below, the handlers are documented in the Log::Message::Handlers manpage. Methods and Accessors remove Calling remove will remove the object from the stack it was on, so it will not show up any more in subsequent fetches of messages. You can still call accessors and handlers on it however, to handle it as you will. id Returns the internal ID of the item. This may be useful for comparing since the ID is incremented each time a new item is created. Therefore, an item with ID 4 must have been logged before an item with ID 9. when Returns the timestamp of when the message was logged message The actual message that was stored level The severity type of this message, as well as the name of the handler that was called upon storing it. tag Returns the identification tag that was put on the message. shortmess Returns the equivalent of a "Carp::shortmess" for this item. See the "Carp" manpage for details. longmess Returns the equivalent of a "Carp::longmess" for this item, which is essentially a stack trace. See the "Carp" manpage for details. parent Returns a reference to the Log::Message object that stored this item. This is useful if you want to have access to the full stack in a handler. SEE ALSO
Log::Message, Log::Message::Handlers, Log::Message::Config AUTHOR
This module by Jos Boumans <kane@cpan.org>. Acknowledgements Thanks to Ann Barcomb for her suggestions. COPYRIGHT
This module is copyright (c) 2002 Jos Boumans <kane@cpan.org>. All rights reserved. This library is free software; you may redistribute and/or modify it under the same terms as Perl itself. perl v5.18.2 2014-01-06 Log::Message::Item(3pm)