log::agent::channel::handle(3pm) [debian man page]

Agent::Channel::Handle(3pm)				User Contributed Perl Documentation			       Agent::Channel::Handle(3pm)

NAME

       Log::Agent::Channel::Handle - I/O handle logging channel for Log::Agent

SYNOPSIS

	require Log::Agent::Channel::Handle;

	my $driver = Log::Agent::Channel::Handle->make(
	    -prefix	=> "prefix",
	    -stampfmt	=> "own",
	    -showpid	=> 1,
	    -handle	=> *FILE,
	);

DESCRIPTION

       The handle channel performs logging to an already opened I/O handle, along with the necessary prefixing and stamping of the messages.

       The creation routine make() takes the following arguments:

       "-handle" => handle
	   Specifies the I/O handle to use.  It can be given as a GLOB reference, such as "*FILE", or as an "IO::Handle" object.

	   NOTE: Auto-flushing is not enabled on the handle.  Even when the channel is closed, the handle is left as-is: we simply stop sending
	   log messages to it.

       "-no_newline" => flag
	   When set to true, never append any "
" (on Unix) or "
" (on Windows) to log messages.

	   Internally, Log::Agent relies on the channel to delimit logged lines appropriately, so this flag is not used.  However, it might be
	   useful for "Log::Agent::Logger" users.

	   Default is false, meaning newline markers are systematically appended.

       "-no_prefixing" => flag
	   When set to true, disable the prefixing logic entirely, i.e. the following options are ignored completely: "-prefix", "-showpid",
	   "-no_ucfirst", "-stampfmt".

	   Default is false.

       "-no_ucfirst" => flag
	   When set to true, don't upper-case the first letter of the log message entry when there's no prefix inserted before the logged line.
	   When there is a prefix, a ":" character follows, and therefore the leading letter of the message should not be upper-cased anyway.

	   Default is false, meaning uppercasing is performed.

       "-prefix" => prefix
	   The application prefix string to prepend to messages.

       "-showpid" => flag
	   If set to true, the PID of the process will be appended within square brackets after the prefix, to all messages.

	   Default is false.

       "-stampfmt" => (name | CODE)
	   Specifies the time stamp format to use. By default, my "own" format is used.  See Log::Agent::Stamping for a description of the
	   available format names.

	   You may also specify a CODE ref: that routine will be called every time we need to compute a time stamp. It should not expect any
	   parameter, and should return a string.

CAVEAT

       Beware of chdir().  If your program uses chdir(), you should always specify logfiles by using absolute paths, otherwise you run the risk of
       having your relative paths become invalid: there is no anchoring done at the time you specify them.  This is especially true when
       configured for rotation, since the logfiles are recreated as needed and you might end up with many logfiles scattered throughout all the
       directories you chdir()ed to.

AUTHOR

       Raphael Manfredi <Raphael_Manfredi@pobox.com>

SEE ALSO

       Log::Agent::Logger(3), Log::Agent::Channel(3).

perl v5.10.0							    2002-03-09					       Agent::Channel::Handle(3pm)

Agent::Tag(3pm) 					User Contributed Perl Documentation					   Agent::Tag(3pm)

NAME

       Log::Agent::Tag - formats caller information

SYNOPSIS

	Intended to be inherited from

DESCRIPTION

       This class is meant to be inherited by all the classes implementing a log message tag.

       A message tag is a little string that is either appended or prepended to all log messages.

       For instance, and oversimplifying a bit, a tag meant to be prepended will be inserted in front of the current log message, separated by
       separator, which defaults to a single space:

	  +------------+-----------+---------------------------------+
	  | tag string | separator |	  current log message	     |
	  +------------+-----------+---------------------------------+

       This operation is called tag insertion. The whole string then becomes the current log message, and can be the target of another tag
       insertion.

       The reality is a little bit more complex, to allow successive tags to be prepended or appended in the order they are specified, and not in
       reverse order as they would be if naively implemented.  See Log::Agent::Message for the exact semantics of append() and prepend()
       operations.

FEATURES

       This section documents the interface provided to heirs, in case you wish to implement your own tag class.

       _init(name, postfix, separator)
	   Initialization routine that should be called by all heirs during creation to initialize the common attributes.

       postfix
	   When true, the tag is meant to be appended to the log message.  Otherwise, it is prepended.

       name
	   The name of this tag.  It is meant to provide by-name access to tags, check whether a given tag is recorded, etc...	The names "caller"
	   and "priority" are architecturally defined to refer to "Log::Agent::Tag::Caller" and "Log::Agent::Tag::Priority" objects.

	   NOTE: Currently unused by any client code.

       separator
	   The sperating string inserted between the tag and the log message.  It defaults to " " if not specified, i.e. left to "undef" when
	   calling _init().

       string()
	   A deferred routine, to be implemented by heirs.

	   Returns the tag string only, without the separator, since its exact placement depends on the value of the "postfix" attribute.

       insert(message)
	   Insert this tag withing the "Log::Agent::Message" message, according to the tag specifications (placement, separator).  Calls string()
	   to produce the tag string.

	   This routine is frozen and should not be redefined by heirs.

STANDARD TAGGING CLASSES

       Tagging classes define via their "string()" routine what is the string to be used as a tag.  The insertion of the tag within the log
       message is done via a frozen routine from the "Log::Agent::Tag" ancestor.

       The following classes are provided by "Log::Agent":

       "Log::Agent::Tag::Callback"
	   The "string()" routine invokes a user-supplied callback, given as a "Callback" object.  You need the Callback module from CPAN if you
	   wish to use this class.

       "Log::Agent::Tag::Caller"
	   Used internally to compute the caller and format it according to user specifications.

       "Log::Agent::Tag::Priority"
	   Used internally to format message priorities and add them to the log messages.

       "Log::Agent::Tag::String"
	   Defines a constant tagging string that should be added in all the log messages, e.g. a web session ID.

AUTHOR

       Raphael Manfredi <Raphael_Manfredi@pobox.com>

SEE ALSO

       Log::Agent::Message(3).

perl v5.10.0							    2002-03-09							   Agent::Tag(3pm)