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::SYSLOG (3)

.ds Aq ’

NAME

Log::Report::Dispatcher::Syslog - send messages to syslog

CONTENTS

INHERITANCE



 Log::Report::Dispatcher::Syslog
   is a Log::Report::Dispatcher



SYNOPSIS



 # add syslog dispatcher
 dispatcher SYSLOG => syslog, accept => NOTICE-
   , format_reason => IGNORE
   , to_prio => [ ALERT- => err ];

 # disable default dispatcher, when daemon
 dispatcher close => default;



DESCRIPTION

This dispatchers produces output to syslog, based on the Sys::Syslog module (which will NOT be automatically installed for you, because some systems have a problem with this dependency).

The REASON for a message often uses names which are quite similar to the log-levels used by syslog. However: they have a different purpose. The REASON is used by the programmer to indicate the cause of the message: whether it was able to handle a certain situation. The syslog levels are there for the user’s of the program (with syslog usually the system administrators). It is not unusual to see a normal error or mistake as a very serious situation in a production environment. So, you may wish to translate any message above reason MISTAKE into a LOG_CRIT.

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



  TRACE   => LOG_DEBUG    ERROR   => LOG_ERR
  ASSERT  => LOG_DEBUG    FAULT   => LOG_ERR
  INFO    => LOG_INFO     ALERT   => LOG_ALERT
  NOTICE  => LOG_NOTICE   FAILURE => LOG_EMERG
  WARNING => LOG_WARNING  PANIC   => LOG_CRIT
  MISTAKE => LOG_WARNING



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::Syslog-><B>newB>($type, $name, %options) With syslog, people tend not to include the REASON of the message in the logs, because that is already used to determine the destination of the message.



 -Option        --Defined in             --Default
  accept          Log::Report::Dispatcher  depend on mode
  charset                                  utf8
  facility                                 user
  flags                                    pid,nowait
  format                                   <unchanged>
  format_reason   Log::Report::Dispatcher  IGNORE
  identity                                 <basename $0>
  include_domain                           <false>
  locale          Log::Report::Dispatcher  <system locale>
  logsocket                                undef
  mode            Log::Report::Dispatcher  NORMAL
  to_prio                                  []



accept => REASONS
charset => CHARSET Translate the text-strings into the specified charset, otherwise the sysadmin may get unreadable text.
facility => STRING The possible values for this depend (a little) on the system. POSIX only defines user, and local0 upto local7.
flags => STRING Any combination of flags as defined by Sys::Syslog, for instance pid, ndelay, and nowait.
format => CODE [1.10] With a CODE reference you get your hands on the text before it gets sent to syslog. The three parameters are: the (translated) text, the related text domain object, and the message object. You may want to use context information from the latter.
format_reason => ’UPPERCASE’|’LOWERCASE’|’UCFIRST’|’IGNORE’|CODE
identity => STRING
include_domain => BOOLEAN [1.00] Include the text-domain of the message in each logged message.
locale => LOCALE
logsocket => ’unix’|’inet’|’stream’|HASH If specified, the log socket type will be initialized to this before openlog() is called. If not specified, the system default is used.
mode => ’NORMAL’|’VERBOSE’|’ASSERT’|’DEBUG’|0..3
to_prio => ARRAY-of-PAIRS See reasonToPrio().

    Accessors

Extends Accessors in Log::Report::Dispatcher.
$obj-><B>formatB>( [CODE] ) Returns the CODE ref which formats the syslog line.
$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::Syslog-><B>addSkipStackB>(@CODE) Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>collectLocationB>()
Log::Report::Dispatcher::Syslog-><B>collectLocationB>() Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>collectStackB>( [$maxdepth] )
Log::Report::Dispatcher::Syslog-><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>reasonToPrioB>($reason) Returns a level which is understood by syslog(3), based on a translation table. This can be changed with new(to_prio).
$obj-><B>skipStackB>() Inherited, see Logging in Log::Report::Dispatcher
$obj-><B>stackTraceLineB>(%options)
Log::Report::Dispatcher::Syslog-><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::SYSLOG (3) 2016-02-03

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