GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LOG::REPORT::DISPATCHER::LOGDISPATCH (3)

.ds Aq ’

NAME

Log::Report::Dispatcher::LogDispatch - send messages to Log::Dispatch back-end

CONTENTS

INHERITANCE



 Log::Report::Dispatcher::LogDispatch
   is a Log::Report::Dispatcher



SYNOPSIS



 use Log::Dispatch::File;
 dispatcher Log::Dispatch::File => logger, accept => NOTICE-
   , filename => logfile, to_level => [ ALERT- => err ];

 # disable default dispatcher
 dispatcher close => logger;



DESCRIPTION

This dispatchers produces output to and Log::Dispatch back-end. (which will NOT be automatically installed for you).

The REASON for a message often uses names which are quite similar to the log-levels used by Log::Dispatch. However: they have a different approach. The REASON of Log::Report limits the responsibility of the programmer to indicate the cause of the message: whether it was able to handle a certain situation. The Log::Dispatch levels are there for the user’s of the program. However: the programmer does not known anything about the application (in the general case). This is cause of much of the trickery in Perl programs.

The default translation table is list below. You can change the mapping using new(to_level). See example in SYNOPSIS.

Extends DESCRIPTION in Log::Report::Dispatcher.

METHODS

Extends METHODS in Log::Report::Dispatcher.

    Constructors

Extends Constructors in Log::Report::Dispatcher.
$obj-><B>closeB>() Inherited, see Constructors in Log::Report::Dispatcher
Log::Report::Dispatcher::LogDispatch-><B>newB>($type, $name, %options) The Log::Dispatch infrastructure has quite a large number of output TYPEs, each extending the Log::Dispatch::Output base-class. You do not create these objects yourself: Log::Report is doing it for you.

The Log::Dispatch back-ends are very careful with validating their parameters, so you will need to restrict the options to what is supported for the specific back-end. See their respective manual-pages. The errors produced by the back-ends quite horrible and untranslated, sorry.



 -Option       --Defined in             --Default
  accept         Log::Report::Dispatcher  depend on mode
  callbacks                               []
  charset        Log::Report::Dispatcher  <undef>
  format_reason  Log::Report::Dispatcher  LOWERCASE
  locale         Log::Report::Dispatcher  <system locale>
  max_level                               undef
  min_level                               debug
  mode           Log::Report::Dispatcher  NORMAL
  to_level                                []



accept => REASONS
callbacks => CODE|ARRAY-of-CODE See Log::Dispatch::Output.
charset => CHARSET
format_reason => ’UPPERCASE’|’LOWERCASE’|’UCFIRST’|’IGNORE’|CODE
locale => LOCALE
max_level => LEVEL Like min_level.
min_level => LEVEL Restrict the messages which are passed through based on the LEVEL, so after the reason got translated into a Log::Dispatch compatible LEVEL. The default will use Log::Report restrictions only.
mode => ’NORMAL’|’VERBOSE’|’ASSERT’|’DEBUG’|0..3
to_level => ARRAY-of-PAIRS See reasonToLevel().

    Accessors

Extends Accessors in Log::Report::Dispatcher.
$obj-><B>backendB>() Returns the Log::Dispatch::Output object which is used for logging.
$obj-><B>isDisabledB>() Inherited, see Accessors in Log::Report::Dispatcher
$obj-><B>modeB>() Inherited, see Accessors in Log::Report::Dispatcher
$obj-><B>nameB>() Inherited, see Accessors in Log::Report::Dispatcher
$obj-><B>needsB>( [$reason] ) Inherited, see Accessors in Log::Report::Dispatcher
$obj-><B>typeB>() Inherited, see Accessors in Log::Report::Dispatcher

    Logging

Extends Logging in Log::Report::Dispatcher.
$obj-><B>addSkipStackB>(@CODE)
Log::Report::Dispatcher::LogDispatch-><B>addSkipStackB>(@CODE) Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>collectLocationB>()
Log::Report::Dispatcher::LogDispatch-><B>collectLocationB>() Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>collectStackB>( [$maxdepth] )
Log::Report::Dispatcher::LogDispatch-><B>collectStackB>( [$maxdepth] ) Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>logB>(HASH-$of-%options, $reason, $message, $domain) Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>reasonToLevelB>($reason) Returns a level which is understood by Log::Dispatch, based on a translation table. This can be changed with new(to_level).
$obj-><B>skipStackB>() Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>stackTraceLineB>(%options)
Log::Report::Dispatcher::LogDispatch-><B>stackTraceLineB>(%options) Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>translateB>(HASH-$of-%options, $reason, $message) Inherited, see Logging in Log::Report::Dispatcher

DETAILS

Extends DETAILS in Log::Report::Dispatcher.

SEE ALSO

This module is part of Log-Report distribution version 1.13, built on February 03, 2016. Website: http://perl.overmeer.net/log-report/

LICENSE

Copyrights 2007-2016 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 LOG::REPORT::DISPATCHER::LOGDISPATCH (3) 2016-02-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.