netsds::logger(3pm) [debian man page]

NetSDS::Logger(3pm)					User Contributed Perl Documentation				       NetSDS::Logger(3pm)

NAME

       NetSDS::Logger - syslog wrapper for applications and classes

SYNOPSIS

	       use NetSDS::Logger;

	       my $logger = NetSDS::Logger->new(
		       name => 'NetSDS-SuperDaemon',
	       );
	       $logger->log("info", "Syslog message here");

DESCRIPTION

       This module contains implementation of logging functionality for NetSDS components.

       By default, messages are logged with "local0" facility and "pid,ndelay,nowait" options.

       NOTE: "NetSDS::Logger" module is for internal use mostly from application frameworks like "NetSDS::App", "NetSDS::App::FCGI", etc.

CLASS API

       new(%parameters) - constructor
	   Constructor new() creates new logger object and opens socket with default NetSDS logging parameters.

	   Arguments allowed (as hash):

	   name - application name for identification

		   Use only ASCII characters in "name" to avoid possible errors.
		   Default value is "NetSDS".

	   facility - logging facility

		   Available facility values:

			   * local0..local7
			   * user
			   * daemon

		   If not set 'local0' is used as default value

       log($level, $message) - write record to log
	   Wrapper to "syslog()" method of Unix::Syslog module.

	   Level is passed as string and may be one of the following:

		   alert   - LOG_ALERT
		   crit    - LOG_CRIT
		   debug   - LOG_DEBUG
		   emerg   - LOG_EMERG
		   error   - LOG_ERR
		   info    - LOG_INFO
		   notice  - LOG_NOTICE
		   warning - LOG_WARNING

       DESTROY - class destructor
	   Destructor (DESTROY method) calls "closelog()" function. That's all.

EXAMPLES

       See NetSDS::App for example.

SEE ALSO

       Sys::Syslog

TODO

       1. Implement logging via UDP socket.

AUTHOR

       Michael Bochkaryov <misha@rattler.kiev.ua>

LICENSE

       Copyright (C) 2008-2009 Net Style Ltd.

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

perl v5.10.1							    2010-04-28						       NetSDS::Logger(3pm)

NetSDS::Feature(3pm)					User Contributed Perl Documentation				      NetSDS::Feature(3pm)

NAME

       NetSDS::Feature - abstract application feature

SYNOPSIS

	       package NetSDS::Feature::DBI;

	       use DBI;
	       use base 'NetSDS::Feature';

	       sub init {
		       my ($self) = @_;

		       my $dsn = $self->conf->{dsn};
		       my $user = $self->conf->{user};
		       my $passwd = $self->conf->{passwd};

		       $self->{dbconn} = DBI->connect($dsn, $user, $passwd);

	       }

	       # Sample method - DBI::do proxy
	       sub do {

		       my $self = shift @_;
		       return $self->{dbconn}->do(@_);
	       }

	       1;

DESCRIPTION

       Application "features" are Perl5 packages with unified API for easy integration of some functionality into NetSDS applications
       infrastructure.

       "NetSDS::Feature" module contains superclass for application features providing the following common feature functionality:

	       * class construction
	       * initialization stub
	       * logging

CLASS METHODS

       create($app, $conf) - feature constructor
       init() - feature initialization
	   This method should be rewritten with feature functionality implementation.  It's possibly to use application and configuration handlers
	   at this time.

	   Example:

		   sub init {
			   my ($self) = @_;

			   $self->{answer} = $self->conf->{answer} || '42';

			   my $pid = $self->app->pid();

			   if ($self->app->daemon()) {
				   $self->log("info", "Seems we are in a daemon mode");
			   }
		   }

OBJECT METHODS

       app() - application object
	   This method allows to use application methods and properties.

		   print "Feature included from app: " . $self->app->name;

       conf() - feature configuration
	   This method provides access to feature configuration.

       log($level, $message) - implements logging
	   Example:

		   # Write log message
		   $self->log("info", "Application does something interesting.");

	   See NetSDS::Logger documentation for details.

EXAMPLES

       See "samples/app_features.pl" script.

SEE ALSO

       o   NetSDS::App

AUTHOR

       Michael Bochkaryov <misha@rattler.kiev.ua>

LICENSE

       Copyright (C) 2008-2009 Net Style Ltd.

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

perl v5.10.1							    2010-04-28						      NetSDS::Feature(3pm)