[Jifty-commit] r4598 - in jifty/trunk: lib/Jifty/Plugin lib/Jifty/Plugin/Recorder/Command

[jifty-commit at lists.jifty.org]

Author: sartak
Date: Fri Nov 30 19:28:53 2007
New Revision: 4598

Modified:
   jifty/trunk/   (props changed)
   jifty/trunk/lib/Jifty/Plugin/Recorder.pm
   jifty/trunk/lib/Jifty/Plugin/Recorder/Command/Playback.pm

Log:
 r48470 at onn:  sartak | 2007-11-30 19:28:45 -0500
 More Recorder doc


Modified: jifty/trunk/lib/Jifty/Plugin/Recorder.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/Recorder.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/Recorder.pm	Fri Nov 30 19:28:53 2007
@@ -13,7 +13,7 @@
 =head2 init
 
 init installs the trigger needed before each HTTP request. It also establishes
-the baseline for all times.
+the baseline for all times and creates the log path.
 
 =cut
 
@@ -42,6 +42,7 @@
 
 =head2 before_request
 
+Log as much of the request state as we can.
 
 =cut
 
@@ -59,6 +60,14 @@
     Jifty->log->error("Unable to append to request log: $@") if $@;
 }
 
+=head2 get_loghandle
+
+Creates the loghandle. The created file is named C<PATH/BOOTTIME-PID.log>.
+
+Returns C<undef> on error.
+
+=cut
+
 sub get_loghandle {
     my $self = shift;
 
@@ -79,10 +88,13 @@
 
 =head1 NAME
 
-Jifty::Plugin::Recorder
+Jifty::Plugin::Recorder - record HTTP requests for playback
 
 =head1 DESCRIPTION
 
+This plugin will log all HTTP requests as YAML. The logfiles can be used by
+C<jifty playback> (provided with this plugin) to replay the logged requests.
+This can be handy for perfomance tuning, debugging, and testing.
 
 =head1 USAGE
 
@@ -92,8 +104,20 @@
    Plugins:
      - Recorder: {}
 
+=head2 OPTIONS
+
+=over 4
+
+=item path
+
+The path for creating request logs. Default: log/requests. This directory will
+be created for you, if necessary.
+
+=back
+
 =head1 SEE ALSO
 
+L<Jifty::Plugin::Recorder::Command::Playback>, L<HTTP::Server::Simple::Recorder>
 
 =head1 COPYRIGHT AND LICENSE
 

Modified: jifty/trunk/lib/Jifty/Plugin/Recorder/Command/Playback.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/Recorder/Command/Playback.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/Recorder/Command/Playback.pm	Fri Nov 30 19:28:53 2007
@@ -14,13 +14,13 @@
 our $start = time; # for naming log files
 our $path = 'log/playback';
 
-=head1 Jifty::Script::Playback - Play back a request log
+=head1 Jifty::Script::Playback - Play back request logs
 
 =head1 DESCRIPTION
 
 L<Jifty::Plugin::Recorder> lets you record a request log. Using this command
-you can play back the request log. This can be handy for performance testing
-and debugging, and perhaps even testing.
+you can play back request logs. This can be handy for performance tuning,
+debugging, and testing.
 
 =head1 API
 
@@ -183,5 +183,17 @@
 
 sub filename { __FILE__ }
 
+=head1 SEE ALSO
+
+L<Jifty::Plugin::Recorder>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2007 Best Practical Solutions
+
+This is free software and may be modified and distributed under the same terms as Perl itself.
+
+=cut
+
 1;