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 use namespace::clean -except => 'meta';
12 has enable => (is => 'rw', required => 1, default => sub{ 1 });
16 default => sub{ Tree::Simple->new({t => [gettimeofday]}) },
17 handles => [qw/ accept traverse /],
23 default => sub { [ shift->tree ] }
29 return unless $self->enable;
33 $params{comment} = shift || "";
36 die "profile() requires a single comment parameter or a list of name-value pairs; found "
37 . (scalar @_) . " values: " . join(", ", @_);
41 $params{comment} ||= "";
46 my $t = [ gettimeofday ];
47 my $stack = $self->stack;
50 # parent is on stack; search for matching block and splice out
51 for (my $i = $#{$stack}; $i > 0; $i--) {
52 if ($stack->[$i]->getNodeValue->{action} eq $params{end}) {
53 my ($node) = splice(@{$stack}, $i, 1);
54 # Adjust elapsed on partner node
55 my $v = $node->getNodeValue;
56 $v->{elapsed} = tv_interval($v->{t}, $t);
60 # if partner not found, fall through to treat as non-closing call
62 if ($params{parent}) {
63 # parent is explicitly defined
64 $prev = $parent = $self->_get_uid($params{parent});
67 # Find previous node, which is either previous sibling or parent, for ref time.
68 $prev = $parent = $stack->[-1] or return undef;
69 my $n = $parent->getChildCount;
70 $prev = $parent->getChild($n - 1) if $n > 0;
73 my $node = Tree::Simple->new({
74 action => $params{begin} || "",
76 elapsed => tv_interval($prev->getNodeValue->{t}, $t),
77 comment => $params{comment},
79 $node->setUID($params{uid}) if $params{uid};
81 $parent->addChild($node);
82 push(@{$stack}, $node) if $params{begin};
88 return tv_interval(shift->{tree}->getNodeValue->{t});
94 my $column_width = Catalyst::Utils::term_width() - 9 - 13;
95 my $t = Text::SimpleTable->new( [ $column_width, 'Action' ], [ 9, 'Time' ] );
100 my $stat = $action->getNodeValue;
101 my @r = ( $action->getDepth,
102 ($stat->{action} || "") .
103 ($stat->{action} && $stat->{comment} ? " " : "") . ($stat->{comment} ? '- ' . $stat->{comment} : ""),
105 $stat->{action} ? 1 : 0,
107 # Trim down any times >= 10 to avoid ugly Text::Simple line wrapping
108 my $elapsed = substr(sprintf("%f", $stat->{elapsed}), 0, 8) . "s";
109 $t->row( ( q{ } x $r[0] ) . $r[1],
110 defined $r[2] ? $elapsed : '??');
114 return wantarray ? @results : $t->draw;
118 my ($self, $uid) = @_;
120 my $visitor = Tree::Simple::Visitor::FindByUID->new;
121 $visitor->searchForUID($uid);
122 $self->accept($visitor);
123 return $visitor->getResult;
130 my $stat = $node->getNodeValue;
132 # do we need to fake $stat->{ t } ?
133 if( $stat->{ elapsed } ) {
134 # remove the "s" from elapsed time
135 $stat->{ elapsed } =~ s{s$}{};
138 $self->tree->addChild( @_ );
145 # do we need to fake $stat->{ t } ?
146 if( $stat->{ elapsed } ) {
147 # remove the "s" from elapsed time
148 $stat->{ elapsed } =~ s{s$}{};
151 $self->tree->setNodeValue( @_ );
156 $self->tree->getNodeValue( @_ )->{ t };
159 __PACKAGE__->meta->make_immutable();
167 Catalyst::Stats - Catalyst Timing Statistics Class
173 $stats->profile($comment);
174 $stats->profile(begin => $block_name, comment =>$comment);
175 $stats->profile(end => $block_name);
176 $elapsed = $stats->elapsed;
177 $report = $stats->report;
183 This module provides the default, simple timing stats collection functionality for Catalyst.
184 If you want something different set C<< MyApp->stats_class >> in your application module,
187 __PACKAGE__->stats_class( "My::Stats" );
189 If you write your own, your stats object is expected to provide the interface described here.
191 Catalyst uses this class to report timings of component actions. You can add
192 profiling points into your own code to get deeper insight. Typical usage might
197 $c->stats->profile(begin => "mysub");
200 $c->stats->profile("starting critical bit");
203 $c->stats->profile("completed first part of critical bit");
206 $c->stats->profile("completed second part of critical bit");
209 $c->stats->profile(end => "mysub");
212 Supposing mysub was called from the action "process" inside a Catalyst
213 Controller called "service", then the reported timings for the above example
214 might look something like this:
216 .----------------------------------------------------------------+-----------.
218 +----------------------------------------------------------------+-----------+
219 | /service/process | 1.327702s |
220 | mysub | 0.555555s |
221 | - starting critical bit | 0.111111s |
222 | - completed first part of critical bit | 0.333333s |
223 | - completed second part of critical bit | 0.111000s |
225 '----------------------------------------------------------------+-----------'
227 which means mysub took 0.555555s overall, it took 0.111111s to reach the
228 critical bit, the first part of the critical bit took 0.333333s, and the second
238 $stats = Catalyst::Stats->new;
245 Enable or disable stats collection. By default, stats are enabled after object creation.
249 $stats->profile($comment);
250 $stats->profile(begin => $block_name, comment =>$comment);
251 $stats->profile(end => $block_name);
253 Marks a profiling point. These can appear in pairs, to time the block of code
254 between the begin/end pairs, or by themselves, in which case the time of
255 execution to the previous profiling point will be reported.
257 The argument may be either a single comment string or a list of name-value
258 pairs. Thus the following are equivalent:
260 $stats->profile($comment);
261 $stats->profile(comment => $comment);
263 The following key names/values may be used:
267 =item * begin => ACTION
269 Marks the beginning of a block. The value is used in the description in the
272 =item * end => ACTION
274 Marks the end of the block. The name given must match a previous 'begin'.
275 Correct nesting is recommended, although this module is tolerant of blocks that
276 are not correctly nested, and the reported timings should accurately reflect the
277 time taken to execute the block whether properly nested or not.
279 =item * comment => COMMENT
281 Comment string; use this to describe the profiling point. It is combined with
282 the block action (if any) in the timing report description field.
286 Assign a predefined unique ID. This is useful if, for whatever reason, you wish
287 to relate a profiling point to a different parent than in the natural execution
290 =item * parent => UID
292 Explicitly relate the profiling point back to the parent with the specified UID.
293 The profiling point will be ignored if the UID has not been previously defined.
297 Returns the UID of the current point in the profile tree. The UID is
298 automatically assigned if not explicitly given.
302 $elapsed = $stats->elapsed
304 Get the total elapsed time (in seconds) since the object was created.
308 print $stats->report ."\n";
309 $report = $stats->report;
310 @report = $stats->report;
312 In scalar context, generates a textual report. In array context, returns the
313 array of results where each row comprises:
315 [ depth, description, time, rollup ]
317 The depth is the calling stack level of the profiling point.
319 The description is a combination of the block name and comment.
321 The time reported for each block is the total execution time for the block, and
322 the time associated with each intermediate profiling point is the elapsed time
323 from the previous profiling point.
325 The 'rollup' flag indicates whether the reported time is the rolled up time for
326 the block, or the elapsed time from the previous profiling point.
328 =head1 COMPATIBILITY METHODS
330 Some components might expect the stats object to be a regular Tree::Simple object.
331 We've added some compatibility methods to handle this scenario:
349 Catalyst Contributors, see Catalyst.pm
353 This library is free software. You can redistribute it and/or modify
354 it under the same terms as Perl itself.
358 __PACKAGE__->meta->make_immutable;