Skip to content

Commit

Permalink
POD nits for Recorder plugin
Browse files Browse the repository at this point in the history
git-svn-id: svn+ssh://svn.bestpractical.com/svn/jifty.org/jifty/trunk@6440 e84bef0a-9b06-0410-84ba-c4c9edb13aeb
  • Loading branch information
alexmv committed Feb 25, 2009
1 parent 82261fc commit 090e38c
Showing 1 changed file with 36 additions and 33 deletions.
69 changes: 36 additions & 33 deletions lib/Jifty/Plugin/Recorder.pm
Expand Up @@ -10,6 +10,42 @@ use Storable 'nfreeze';

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
Expand Down Expand Up @@ -151,39 +187,6 @@ sub get_loghandle {
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
Expand Down

0 comments on commit 090e38c

Please sign in to comment.