perlancar > Devel-EndStats > Devel::EndStats

Download:
Devel-EndStats-0.18.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.18   Source  

NAME ^

Devel::EndStats - Display run time and dependencies after running code

VERSION ^

This document describes version 0.18 of Devel::EndStats (from Perl distribution Devel-EndStats), released on 2014-11-13.

SYNOPSIS ^

 # from the command line
 % perl -MDevel::EndStats script.pl

 ##### sample output #####
 <normal script output, if any...>

 # BEGIN stats from Devel::EndStats
 # Program runtime duration: 0.055s
 # Total number of required files loaded: 132
 # Total number of required lines loaded: 48772
 # END stats

 ##### sample output (with verbose=1, some cut) #####
 <normal script output, if any...>

 # BEGIN stats from Devel::EndStats
 # Program runtime duration: 0.055s
 # Total number of required files loaded: 132
 # Total number of required lines loaded: 48772
 #   #  1   1747 lines  0.023489s( 43%)  Log/Any/App.pm (loaded by main)
 #   # 52   1106 lines  0.015112s( 28%)  Log/Log4perl/Logger.pm (loaded by Log::Log4perl)
 #   # 17    190 lines  0.011983s( 22%)  Log/Any/Adapter.pm (loaded by Log::Any::App)
 #   # 18    152 lines  0.011679s( 21%)  Log/Any/Manager.pm (loaded by Log::Any::Adapter)
 #   #  5    981 lines  0.007299s( 13%)  File/Path.pm (loaded by Log::Any::App)
 ...
 # END stats

DESCRIPTION ^

Devel::EndStats runs in the END block, displaying various statistics about your program, such as:

Some notes/caveats:

Devel::EndStats should be loaded before other modules, for example by running it on the command-line, as shown in the SYNOPSIS.

OPTIONS ^

Some options are accepted. They can be passed via the use statement:

 # from the command line
 % perl -MDevel::EndStats=verbose,1 script.pl

 # from script
 use Devel::EndStats verbose=>1;

or via the DEVELENDSTATS_OPTS environment variable:

 % DEVELENDSTATS_OPTS='verbose=1' perl -MDevel::EndStats script.pl

FAQ ^

What is the purpose of this module?

This module might be useful during development. I first wrote this module when trying to reduce startup overhead of a command line application, by looking at how many modules the app has loaded and try to avoid loading modules whenever it's unnecessary.

Can you add (so and so) information to the stats?

Sure, if it's useful. As they say, (comments|patches) are welcome.

SEE ALSO ^

There are many modules on CPAN that can be used to generate dependency information for your code. Neil Bowers has written a review that covers most of them.

KNOWN ISSUES ^

* Timing and memory usage is inclusive instead of exclusive.

TODO ^

* Stat: system/user time.

* Stat: number of open files (sockets).

* Stat: number of child processes.

* Stat: number of actual code lines (vs blanks, data, comment, POD)

* Stat: number of XS vs PP modules.

* Feature: remember last run's stats, compare with current run.

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/Devel-EndStats.

SOURCE ^

Source repository is at https://github.com/perlancar/perl-Devel-EndStats.

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Devel-EndStats

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: