X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=scpubgit%2FObject-Remote.git;a=blobdiff_plain;f=lib%2FObject%2FRemote%2FLogging.pm;h=7e030ff49a5c8108d278ee89431e0a2876ed6cc1;hp=48110480e220db8025696281164d7a3efcef95d3;hb=f21127fd8c611eee83f769422168bb7bf3b25f0a;hpb=d672a9bff87112bf8cfea0a5749e934d4c8c996e diff --git a/lib/Object/Remote/Logging.pm b/lib/Object/Remote/Logging.pm index 4811048..7e030ff 100644 --- a/lib/Object/Remote/Logging.pm +++ b/lib/Object/Remote/Logging.pm @@ -62,15 +62,16 @@ sub before_import { $spec->add_export("&Flog_$level", sub (&@) { my ($code, $exit_value) = @_; $exit_value = 1 unless defined $exit_value; - $router->handle_log_request({ + #don't let it going wrong stop us from calling exit() + eval { $router->handle_log_request({ controller => $class, package => scalar(caller), caller_level => 1, level => $level, - }, $code); - #TODO this should get fed into a logger so it can be formatted - #don't let it going wrong stop us from calling exit() + }, $code) }; + warn "could not deliver log event during Flog_$level: $@" if defined $@; eval { carp $code->() }; + warn "could not emit warning during Flog_$level: $@" if defined $@; exit($exit_value); }); } @@ -81,7 +82,6 @@ sub before_import { sub init_logging { my $level = $ENV{OBJECT_REMOTE_LOG_LEVEL}; my $format = $ENV{OBJECT_REMOTE_LOG_FORMAT}; - #TODO allow the selections value to be * so it selects everything my $selections = $ENV{OBJECT_REMOTE_LOG_SELECTIONS}; my %controller_should_log; @@ -97,7 +97,7 @@ sub init_logging { router()->connect(sub { my $controller = $_[1]->{controller}; - return unless $controller_should_log{'*'} || $controller_should_log{$controller}; + return unless $controller_should_log{'*'} || $controller_should_log{$controller}; #skip things from remote hosts because they log to STDERR #when OBJECT_REMOTE_LOG_LEVEL is in effect return if $_[1]->{remote}->{connection_id}; @@ -115,6 +115,7 @@ sub init_logging_forwarding { } 1; + __END__ =head1 NAME @@ -130,8 +131,8 @@ Object::Remote::Logging - Logging subsystem for Object::Remote $ENV{OBJECT_REMOTE_LOG_LEVEL} = 'trace'; #or other level name $ENV{OBJECT_REMOTE_LOG_FORMAT} = '%l %t: %p::%m %s'; #and more - $ENV{OBJECT_REMOTE_LOG_FORWARDING} = 0 || 1; #default 0 $ENV{OBJECT_REMOTE_LOG_SELECTIONS} = 'Object::Remote::Logging Some::Other::Subclass'; + $ENV{OBJECT_REMOTE_LOG_FORWARDING} = 0 || 1; #default 0 log_info { 'Trace log event' }; Dlog_verbose { "Debug event with Data::Dumper::Concise: $_" } { foo => 'bar' }; @@ -150,6 +151,48 @@ The rest of the logging system comes from L which implements log rendering and output and L which delivers log events to the loggers. +=head1 USAGE + +Object::Remote logging is not enabled by default. If you need to immediately start +debugging set the OBJECT_REMOTE_LOG_LEVEL environment variable to either 'trace' +or 'debug'. This will enable logging to STDERR on the local and all remote Perl +interpreters. By default STDERR for all remote interpreters is passed through +unmodified so this is sufficient to receive logs generated anywhere Object::Remote +is running. + +Every time the local interpreter creates a new Object::Remote::Connection the connection +is given an id that is unique to that connection on the local interpreter. The connection +id and other metadata is available in the log output via a log format string that can +be set via the OBJECT_REMOTE_LOG_FORMAT environment variable. The format string and +available metadata is documented in L. Setting this +environment variable on the local interpreter will cause it to be propagated to the +remote interpreter so all logs will be formated the same way. + +This class is designed so any module can create their own logging sub-class using it. +With out any additional configuration the consumers of this logging class will +automatically be enabled via OBJECT_REMOTE_LOG_LEVEL and formated with +OBJECT_REMOTE_LOG_FORMAT but those additional log messages are not sent to STDERR. +By setting the OBJECT_REMOTE_LOG_SELECTIONS environment variable to a list of +class names seperated by spaces then logs generated by packages that use those classes +will be sent to STDERR. This is also a configuration item that is forwarded to the +remote interpreters so all logging is consistent. + +Regardless of OBJECT_REMOTE_LOG_LEVEL the logging system is still active and loggers +can access the stream of log messages to format and output them. Internally +OBJECT_REMOTE_LOG_LEVEL causes an L to be built +and connected to the L instance. It is also possible +to manually build a logger instance and connect it to the router. See the documentation +for the logger and router classes. + +The logging system also supports a method of forwarding log messages from remote +interpreters to the local interpreter. Forwarded log messages are generated in the +remote interpreter and the logger for the message is invoked in the local interpreter. +Sub-classes of Object::Remote::Logging will have log messages forwarded automatically. +Loggers receive forwarded log messages exactly the same way as non-forwarded messages +except a forwarded message includes extra metadata about the remote interpreter. Log +forwarding is not currently enabled by default; to enable it set the +OBJECT_REMOTE_LOG_FORWARDING environment variable to 1. See L. + =head1 EXPORTABLE SUBROUTINES =over 4 @@ -174,7 +217,7 @@ that returns the log message contents and the optional further arguments are bot to the block as the argument list and returned from the log method as a list. log_trace { "A fine log message $_[0] " } 'if I do say so myself'; - $hashref = Dlog_trace { "Very handy: $_" } { foo => 'bar' }; + %hash = Dlog_trace { "Very handy: $_" } ( foo => 'bar' ); =item logS_ and DlogS_ @@ -244,36 +287,3 @@ Something went wrong and recovery is not possible. The system should stop operat as soon as possible. Tripple quiet operation (-q -q -q). =back - -=head1 ENVIRONMENT - -=over 4 - -=item OBJECT_REMOTE_LOG_LEVEL - -By default Object::Remote will generate log events but messages will not be -output to STDERR. If there is a defined value for this variable then logs will -be sent to STDERR if they are at this level or higher. - -=item OBJECT_REMOTE_LOG_FORMAT - -If logging output is enabled and this value is defined then the logger will -use this format string instead of the default '[%l %r] %s'; See -L for documentation on the format string. - -=item OBJECT_REMOTE_LOG_SELECTIONS - -By default Object::Remote log output will only be enabled for messages generated inside -Object::Remote packages. If logs should be generated for other log messages instead of just -Object::Remote messages set this variable to the names of any Object::Remote::Logging subclass or -Object::Remote::Logging itself seperated by a space. To output all logs generated set the value -to *. - -=item OBJECT_REMOTE_LOG_FORWARDING - -Object::Remote can forward log events from the remote Perl interpreter to the local Perl -interpreter in a transparent way. Currently this feature is disabled by default but -that will change Really Soon Now(TM); to enable it set the variable to '1'. - -=back -