update logging docs to not require router specific documentation
Tyler Riddle [Mon, 4 Feb 2013 23:04:41 +0000 (15:04 -0800)]
lib/Object/Remote.pm
lib/Object/Remote/Logging.pm

index 3020f6e..d4c269b 100644 (file)
@@ -157,7 +157,7 @@ this feature which is disabled by default. See L<Object::Remote::Logging>.
 
 Space seperated list of class names to display logs for if logging output is enabled. Default
 value is "Object::Remote::Logging" which selects all logs generated by Object::Remote.
-See L<Object::Remote::Logging::Router>.
+See L<Object::Remote::Logging>.
 
 =back
 
index eca717f..d87629a 100644 (file)
@@ -130,8 +130,6 @@ sub init_remote_logging {
 
 1;
 
-__END__
-
 =head1 NAME
 
 Object::Remote::Logging - Logging subsystem for Object::Remote
@@ -140,33 +138,35 @@ Object::Remote::Logging - Logging subsystem for Object::Remote
 
   use Object::Remote::Logging qw( :log :dlog arg_levels router );
 
-  @levels = qw( trace debug verbose info warn error fatal );
-  @levels = arg_levels(); #same result
+  $levels = [qw( trace debug verbose info warn error fatal )];
+  $levels = arg_levels(); #same result
 
   $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_SELECTIONS} = 'Object::Remote::Logging Some::Other::Subclass';
+  #Output logs from two specific logging pacakges
+  $ENV{OBJECT_REMOTE_LOG_SELECTIONS} = 'Object::Remote::Logging Some::Other::Package';
+  #Output all log messages except those generated by Object::Remote
   $ENV{OBJECT_REMOTE_LOG_SELECTIONS} = '* -Object::Remote::Logging';
-  $ENV{OBJECT_REMOTE_LOG_FORWARDING} = 0; #default 1
+  $ENV{OBJECT_REMOTE_LOG_FORWARDING} = 1; #default 0
 
   log_info { 'Trace log event' };
   Dlog_verbose { "Debug event with Data::Dumper::Concise: $_" } { foo => 'bar' };
 
 =head1 DESCRIPTION
 
-This is the logging framework for Object::Remote implemented as a subclass of
+This is the logging framework for Object::Remote implemented as an extension of
 L<Log::Contextual> with a slightly incompatible API. This system allows
 developers using Object::Remote and end users of that software to control
 Object::Remote logging so operation can be tracked if needed. This is also
 the API used to generate log messages inside the Object::Remote source code.
 
 The rest of the logging system comes from L<Object::Remote::Logging::Logger>
-which implements log rendering and output and L<Object::Remote::Logging::Router>
+which implements log rendering and output and Object::Remote::Logging::Router
 which delivers log events to the loggers.
 
 =head1 USAGE
 
-Object::Remote logging is not enabled by default. If you need to immediately start
+Object::Remote logging output 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
@@ -181,31 +181,31 @@ available metadata is documented in L<Object::Remote::Logging::Logger>. Setting
 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
+This system is designed so any module can create their own logging packages using it.
+With out any additional configuration the consumers of this logging system 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. If the asterisk character (*) is used in the place of a class
-name then all class names will be selected by default instead of ignored. An individual
-class name can be turned off by prefixing the name with a hypen character (-). This is
+By setting the OBJECT_REMOTE_LOG_SELECTIONS environment variable to a list of logging
+package names seperated by spaces then logs generated using those packages
+will be sent to STDERR. If the asterisk character (*) is used in the place of a package
+name then all package names will be selected by default instead of ignored. An individual
+package name can be turned off by prefixing the name with a hypen character (-). 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<Object::Remote::Logging::Logger> to be built
-and connected to the L<Object::Remote::Logging::Router> 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.
+and connected to the Object::Remote::Logging::Router instance. It is also possible
+to manually build a logger instance and connect it to the router. See the 
+Object::Remote::Logging documentation for more information.
 
 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.
+Packages using or extending 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
+except a forwarded message includes extra metadata about the remote connection. Log
 forwarding is disabled by default because it comes with a performance hit; to enable
 it set the OBJECT_REMOTE_LOG_FORWARDING environment variable to 1.