Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Log::Report::DispatcheUseroContributed)Log::Report::Dispatcher::LogDispatch(3)

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

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->close()
	   Inherited, see "Constructors" in Log::Report::Dispatcher

       Log::Report::Dispatcher::LogDispatch->new($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->backend()
	   Returns the Log::Dispatch::Output object which is used for logging.

       $obj->isDisabled()
	   Inherited, see "Accessors" in Log::Report::Dispatcher

       $obj->mode()
	   Inherited, see "Accessors" in Log::Report::Dispatcher

       $obj->name()
	   Inherited, see "Accessors" in Log::Report::Dispatcher

       $obj->needs( [$reason] )
	   Inherited, see "Accessors" in Log::Report::Dispatcher

       $obj->type()
	   Inherited, see "Accessors" in Log::Report::Dispatcher

   Logging
       Extends "Logging" in Log::Report::Dispatcher.

       $obj->addSkipStack(@CODE)
       Log::Report::Dispatcher::LogDispatch->addSkipStack(@CODE)
	   Inherited, see "Logging" in Log::Report::Dispatcher

       $obj->collectLocation()
       Log::Report::Dispatcher::LogDispatch->collectLocation()
	   Inherited, see "Logging" in Log::Report::Dispatcher

       $obj->collectStack( [$maxdepth] )
       Log::Report::Dispatcher::LogDispatch->collectStack( [$maxdepth] )
	   Inherited, see "Logging" in Log::Report::Dispatcher

       $obj->log(HASH-$of-%options, $reason, $message, $domain)
	   Inherited, see "Logging" in Log::Report::Dispatcher

       $obj->reasonToLevel($reason)
	   Returns a level which is understood by Log::Dispatch, based on a
	   translation table.  This can	be changed with	new(to_level).

       $obj->skipStack()
	   Inherited, see "Logging" in Log::Report::Dispatcher

       $obj->stackTraceLine(%options)
       Log::Report::Dispatcher::LogDispatch->stackTraceLine(%options)
	   Inherited, see "Logging" in Log::Report::Dispatcher

       $obj->translate(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.33, built on
       July 17,	2021. Website: http://perl.overmeer.net/CPAN/

LICENSE
       Copyrights 2007-2021 by [Mark Overmeer <markov@cpan.org>]. 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://dev.perl.org/licenses/

perl v5.32.1			  2021-Log::Report::Dispatcher::LogDispatch(3)

NAME | INHERITANCE | SYNOPSIS | DESCRIPTION | METHODS | DETAILS | SEE ALSO | LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Log::Report::Dispatcher::LogDispatch&sektion=3&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help