1 package Catalyst::Stats;
4 use Time::HiRes qw/gettimeofday tv_interval/;
5 use Text::SimpleTable ();
7 use Tree::Simple qw/use_weak_refs/;
8 use Tree::Simple::Visitor::FindByUID;
10 has enable => (is => 'rw', required => 1, default => sub{ 1 });
14 default => sub{ Tree::Simple->new({t => [gettimeofday]}) },
15 handles => [qw/ accept traverse /],
21 default => sub { [ shift->tree ] }
27 return unless $self->enable;
31 $params{comment} = shift || "";
34 die "profile() requires a single comment parameter or a list of name-value pairs; found "
35 . (scalar @_) . " values: " . join(", ", @_);
39 $params{comment} ||= "";
44 my $t = [ gettimeofday ];
45 my $stack = $self->stack;
48 # parent is on stack; search for matching block and splice out
49 for (my $i = $#{$stack}; $i > 0; $i--) {
50 if ($stack->[$i]->getNodeValue->{action} eq $params{end}) {
51 my ($node) = splice(@{$stack}, $i, 1);
52 # Adjust elapsed on partner node
53 my $v = $node->getNodeValue;
54 $v->{elapsed} = tv_interval($v->{t}, $t);
58 # if partner not found, fall through to treat as non-closing call
60 if ($params{parent}) {
61 # parent is explicitly defined
62 $prev = $parent = $self->_get_uid($params{parent});
65 # Find previous node, which is either previous sibling or parent, for ref time.
66 $prev = $parent = $stack->[-1] or return undef;
67 my $n = $parent->getChildCount;
68 $prev = $parent->getChild($n - 1) if $n > 0;
71 my $node = Tree::Simple->new({
72 action => $params{begin} || "",
74 elapsed => tv_interval($prev->getNodeValue->{t}, $t),
75 comment => $params{comment},
77 $node->setUID($params{uid}) if $params{uid};
79 $parent->addChild($node);
80 push(@{$stack}, $node) if $params{begin};
86 return tv_interval(shift->{tree}->getNodeValue->{t});
92 my $column_width = Catalyst::Utils::term_width() - 9 - 13;
93 my $t = Text::SimpleTable->new( [ $column_width, 'Action' ], [ 9, 'Time' ] );
98 my $stat = $action->getNodeValue;
99 my @r = ( $action->getDepth,
100 ($stat->{action} || "") .
101 ($stat->{action} && $stat->{comment} ? " " : "") . ($stat->{comment} ? '- ' . $stat->{comment} : ""),
103 $stat->{action} ? 1 : 0,
105 # Trim down any times >= 10 to avoid ugly Text::Simple line wrapping
106 my $elapsed = substr(sprintf("%f", $stat->{elapsed}), 0, 8) . "s";
107 $t->row( ( q{ } x $r[0] ) . $r[1],
108 defined $r[2] ? $elapsed : '??');
112 return wantarray ? @results : $t->draw;
116 my ($self, $uid) = @_;
118 my $visitor = Tree::Simple::Visitor::FindByUID->new;
119 $visitor->searchForUID($uid);
120 $self->accept($visitor);
121 return $visitor->getResult;
128 my $stat = $node->getNodeValue;
130 # do we need to fake $stat->{ t } ?
131 if( $stat->{ elapsed } ) {
132 # remove the "s" from elapsed time
133 $stat->{ elapsed } =~ s{s$}{};
136 $self->tree->addChild( @_ );
143 # do we need to fake $stat->{ t } ?
144 if( $stat->{ elapsed } ) {
145 # remove the "s" from elapsed time
146 $stat->{ elapsed } =~ s{s$}{};
149 $self->tree->setNodeValue( @_ );
154 $self->tree->getNodeValue( @_ )->{ t };
158 __PACKAGE__->meta->make_immutable();
166 Catalyst::Stats - Catalyst Timing Statistics Class
172 $stats->profile($comment);
173 $stats->profile(begin => $block_name, comment =>$comment);
174 $stats->profile(end => $block_name);
175 $elapsed = $stats->elapsed;
176 $report = $stats->report;
182 This module provides the default, simple timing stats collection functionality for Catalyst.
183 If you want something different set C<< MyApp->stats_class >> in your application module,
186 __PACKAGE__->stats_class( "My::Stats" );
188 If you write your own, your stats object is expected to provide the interface described here.
190 Catalyst uses this class to report timings of component actions. You can add
191 profiling points into your own code to get deeper insight. Typical usage might
196 $c->stats->profile(begin => "mysub");
199 $c->stats->profile("starting critical bit");
202 $c->stats->profile("completed first part of critical bit");
205 $c->stats->profile("completed second part of critical bit");
208 $c->stats->profile(end => "mysub");
211 Supposing mysub was called from the action "process" inside a Catalyst
212 Controller called "service", then the reported timings for the above example
213 might look something like this:
215 .----------------------------------------------------------------+-----------.
217 +----------------------------------------------------------------+-----------+
218 | /service/process | 1.327702s |
219 | mysub | 0.555555s |
220 | - starting critical bit | 0.111111s |
221 | - completed first part of critical bit | 0.333333s |
222 | - completed second part of critical bit | 0.111000s |
224 '----------------------------------------------------------------+-----------'
226 which means mysub took 0.555555s overall, it took 0.111111s to reach the
227 critical bit, the first part of the critical bit took 0.333333s, and the second
237 $stats = Catalyst::Stats->new;
244 Enable or disable stats collection. By default, stats are enabled after object creation.
248 $stats->profile($comment);
249 $stats->profile(begin => $block_name, comment =>$comment);
250 $stats->profile(end => $block_name);
252 Marks a profiling point. These can appear in pairs, to time the block of code
253 between the begin/end pairs, or by themselves, in which case the time of
254 execution to the previous profiling point will be reported.
256 The argument may be either a single comment string or a list of name-value
257 pairs. Thus the following are equivalent:
259 $stats->profile($comment);
260 $stats->profile(comment => $comment);
262 The following key names/values may be used:
266 =item * begin => ACTION
268 Marks the beginning of a block. The value is used in the description in the
271 =item * end => ACTION
273 Marks the end of the block. The name given must match a previous 'begin'.
274 Correct nesting is recommended, although this module is tolerant of blocks that
275 are not correctly nested, and the reported timings should accurately reflect the
276 time taken to execute the block whether properly nested or not.
278 =item * comment => COMMENT
280 Comment string; use this to describe the profiling point. It is combined with
281 the block action (if any) in the timing report description field.
285 Assign a predefined unique ID. This is useful if, for whatever reason, you wish
286 to relate a profiling point to a different parent than in the natural execution
289 =item * parent => UID
291 Explicitly relate the profiling point back to the parent with the specified UID.
292 The profiling point will be ignored if the UID has not been previously defined.
296 Returns the UID of the current point in the profile tree. The UID is
297 automatically assigned if not explicitly given.
301 $elapsed = $stats->elapsed
303 Get the total elapsed time (in seconds) since the object was created.
307 print $stats->report ."\n";
308 $report = $stats->report;
309 @report = $stats->report;
311 In scalar context, generates a textual report. In array context, returns the
312 array of results where each row comprises:
314 [ depth, description, time, rollup ]
316 The depth is the calling stack level of the profiling point.
318 The description is a combination of the block name and comment.
320 The time reported for each block is the total execution time for the block, and
321 the time associated with each intermediate profiling point is the elapsed time
322 from the previous profiling point.
324 The 'rollup' flag indicates whether the reported time is the rolled up time for
325 the block, or the elapsed time from the previous profiling point.
327 =head1 COMPATIBILITY METHODS
329 Some components might expect the stats object to be a regular Tree::Simple object.
330 We've added some compatibility methods to handle this scenario:
348 Catalyst Contributors, see Catalyst.pm
352 This program is free software, you can redistribute it and/or modify
353 it under the same terms as Perl itself.
357 __PACKAGE__->meta->make_immutable;