summaryrefslogtreecommitdiffstats
path: root/lib/Jaos/WebApp/Plugin/RequestTimer.pm
blob: 913682c4f3412e5fecf881b09a94b3810ffe2058 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
package Jaos::WebApp::Plugin::RequestTimer;
use strict;
use warnings;
use Time::HiRes ();


sub register 
{
  my ($self, $app) = @_;

  $app->add_run_hook(
    pre_dispatch => sub {
      my ($ctx) = @_;
      $ctx->stash->{__request_started} = [Time::HiRes::gettimeofday()];
    }
  );

  $app->add_run_hook(
    post_dispatch => sub {
      my ($ctx) = @_;
      if (my $started = $ctx->stash->{__request_started}) {
        my $now       = [Time::HiRes::gettimeofday()];
        my $interval  = sprintf "%f", Time::HiRes::tv_interval($started,$now);
        my $rate      = $interval == 0 ? '??' : sprintf '%.3f', 1 / $interval;
        $ctx->log->debug("Request took $interval seconds ($rate/s)");
      }
    }
  );

}

=head1 NAME

Jaos::WebApp::Plugin::RequestTimer - Show request time in debug log

=head1 SYNOPSIS

 package MyApp;

  sub startup
  {
    my $app = shift;
    $app->load_plugin('Jaos::WebApp::Plugin::RequestTimer');
  }

 1;

=head1 DESCRIPTION

Jaos::WebApp::Plugin::RequestTimer is a simple plugin using Time::HiRes to
show the time interval taken during controller execution.

This leaves out request setup time and plugin hook executime time which are
relatively constant.

=head1 METHODS

=head2 register

register adds callbacks to the pre_dispatch and post_dispatch hooks.
Each callback is passed the application object.

=head1 AUTHOR

Jason Woodward <woodwardj@jaos.org>

=head1 LICENSE

Copyright (C) 2010 Jason Woodward
All rights reserved

This library is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this library.  If not, see <http://www.gnu.org/licenses/>.

=cut

1;