[Jifty-commit] r6440 - in jifty/trunk: lib/Jifty/Plugin

Jifty commits jifty-commit at lists.jifty.org
Wed Feb 25 01:04:34 EST 2009


Author: alexmv
Date: Wed Feb 25 01:04:33 2009
New Revision: 6440

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

Log:
 r42602 at kohr-ah:  chmrr | 2009-02-25 00:59:43 -0500
 POD nits for Recorder plugin


Modified: jifty/trunk/lib/Jifty/Plugin/Recorder.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/Recorder.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/Recorder.pm	Wed Feb 25 01:04:33 2009
@@ -10,6 +10,42 @@
 
 our $VERSION = 0.01;
 
+=head1 NAME
+
+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
+
+Add the following to your site_config.yml
+
+ framework:
+   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.
+
+=item memory_usage
+
+Report how much memory (in bytes) Jifty is taking up. This uses
+L<Proc::ProcessTable>. Default is off.
+
+=back
+
+=head1 METHODS
+
 =head2 init
 
 init installs the trigger needed before each HTTP request. It also establishes
@@ -151,39 +187,6 @@
     return $self->loghandle;
 }
 
-=head1 NAME
-
-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
-
-Add the following to your site_config.yml
-
- framework:
-   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.
-
-=item memory_usage
-
-Report how much memory (in bytes) Jifty is taking up. This uses
-L<Proc::ProcessTable>. Default is off.
-
-=back
 
 =head1 SEE ALSO
 


More information about the Jifty-commit mailing list