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 @{ shift->{tree}->getNodeValue->{t} };
92 return tv_interval(shift->{tree}->getNodeValue->{t});
98 my $column_width = Catalyst::Utils::term_width() - 9 - 13;
99 my $t = Text::SimpleTable->new( [ $column_width, 'Action' ], [ 9, 'Time' ] );
104 my $stat = $action->getNodeValue;
105 my @r = ( $action->getDepth,
106 ($stat->{action} || "") .
107 ($stat->{action} && $stat->{comment} ? " " : "") . ($stat->{comment} ? '- ' . $stat->{comment} : ""),
109 $stat->{action} ? 1 : 0,
111 # Trim down any times >= 10 to avoid ugly Text::Simple line wrapping
112 my $elapsed = substr(sprintf("%f", $stat->{elapsed}), 0, 8) . "s";
113 $t->row( ( q{ } x $r[0] ) . $r[1],
114 defined $r[2] ? $elapsed : '??');
118 return wantarray ? @results : $t->draw;
122 my ($self, $uid) = @_;
124 my $visitor = Tree::Simple::Visitor::FindByUID->new;
125 $visitor->searchForUID($uid);
126 $self->accept($visitor);
127 return $visitor->getResult;
134 my $stat = $node->getNodeValue;
136 # do we need to fake $stat->{ t } ?
137 if( $stat->{ elapsed } ) {
138 # remove the "s" from elapsed time
139 $stat->{ elapsed } =~ s{s$}{};
142 $self->tree->addChild( @_ );
149 # do we need to fake $stat->{ t } ?
150 if( $stat->{ elapsed } ) {
151 # remove the "s" from elapsed time
152 $stat->{ elapsed } =~ s{s$}{};
155 $self->tree->setNodeValue( @_ );
160 $self->tree->getNodeValue( @_ )->{ t };
163 __PACKAGE__->meta->make_immutable();
169 =for stopwords addChild getNodeValue mysub rollup setNodeValue
173 Catalyst::Stats - Catalyst Timing Statistics Class
179 $stats->profile($comment);
180 $stats->profile(begin => $block_name, comment =>$comment);
181 $stats->profile(end => $block_name);
182 $elapsed = $stats->elapsed;
183 $report = $stats->report;
189 This module provides the default, simple timing stats collection functionality for Catalyst.
190 If you want something different set C<< MyApp->stats_class >> in your application module,
193 __PACKAGE__->stats_class( "My::Stats" );
195 If you write your own, your stats object is expected to provide the interface described here.
197 Catalyst uses this class to report timings of component actions. You can add
198 profiling points into your own code to get deeper insight. Typical usage might
203 $c->stats->profile(begin => "mysub");
206 $c->stats->profile("starting critical bit");
209 $c->stats->profile("completed first part of critical bit");
212 $c->stats->profile("completed second part of critical bit");
215 $c->stats->profile(end => "mysub");
218 Supposing mysub was called from the action "process" inside a Catalyst
219 Controller called "service", then the reported timings for the above example
220 might look something like this:
222 .----------------------------------------------------------------+-----------.
224 +----------------------------------------------------------------+-----------+
225 | /service/process | 1.327702s |
226 | mysub | 0.555555s |
227 | - starting critical bit | 0.111111s |
228 | - completed first part of critical bit | 0.333333s |
229 | - completed second part of critical bit | 0.111000s |
231 '----------------------------------------------------------------+-----------'
233 which means mysub took 0.555555s overall, it took 0.111111s to reach the
234 critical bit, the first part of the critical bit took 0.333333s, and the second
244 $stats = Catalyst::Stats->new;
251 Enable or disable stats collection. By default, stats are enabled after object creation.
255 $stats->profile($comment);
256 $stats->profile(begin => $block_name, comment =>$comment);
257 $stats->profile(end => $block_name);
259 Marks a profiling point. These can appear in pairs, to time the block of code
260 between the begin/end pairs, or by themselves, in which case the time of
261 execution to the previous profiling point will be reported.
263 The argument may be either a single comment string or a list of name-value
264 pairs. Thus the following are equivalent:
266 $stats->profile($comment);
267 $stats->profile(comment => $comment);
269 The following key names/values may be used:
273 =item * begin => ACTION
275 Marks the beginning of a block. The value is used in the description in the
278 =item * end => ACTION
280 Marks the end of the block. The name given must match a previous 'begin'.
281 Correct nesting is recommended, although this module is tolerant of blocks that
282 are not correctly nested, and the reported timings should accurately reflect the
283 time taken to execute the block whether properly nested or not.
285 =item * comment => COMMENT
287 Comment string; use this to describe the profiling point. It is combined with
288 the block action (if any) in the timing report description field.
292 Assign a predefined unique ID. This is useful if, for whatever reason, you wish
293 to relate a profiling point to a different parent than in the natural execution
296 =item * parent => UID
298 Explicitly relate the profiling point back to the parent with the specified UID.
299 The profiling point will be ignored if the UID has not been previously defined.
303 Returns the UID of the current point in the profile tree. The UID is
304 automatically assigned if not explicitly given.
308 ($seconds, $microseconds) = $stats->created;
310 Returns the time the object was created, in C<gettimeofday> format, with
311 Unix epoch seconds followed by microseconds.
315 $elapsed = $stats->elapsed
317 Get the total elapsed time (in seconds) since the object was created.
321 print $stats->report ."\n";
322 $report = $stats->report;
323 @report = $stats->report;
325 In scalar context, generates a textual report. In array context, returns the
326 array of results where each row comprises:
328 [ depth, description, time, rollup ]
330 The depth is the calling stack level of the profiling point.
332 The description is a combination of the block name and comment.
334 The time reported for each block is the total execution time for the block, and
335 the time associated with each intermediate profiling point is the elapsed time
336 from the previous profiling point.
338 The 'rollup' flag indicates whether the reported time is the rolled up time for
339 the block, or the elapsed time from the previous profiling point.
341 =head1 COMPATIBILITY METHODS
343 Some components might expect the stats object to be a regular Tree::Simple object.
344 We've added some compatibility methods to handle this scenario:
362 Catalyst Contributors, see Catalyst.pm
366 This library is free software. You can redistribute it and/or modify
367 it under the same terms as Perl itself.
371 __PACKAGE__->meta->make_immutable;