NAME

MasonX::Plugin::CompDebug - log components execution chain


VERSION

This document describes MasonX::Plugin::CompDebug version 0.2.0


SYNOPSIS

 # basic method:
 PerlAddVar MasonPlugins MasonX::Plugin::CompDebug
 # advanced method:
 my $ah = HTML::Mason::ApacheHandler->new(
              # ...
              plugins => [ 'MasonX::Plugin::CompDebug' ],
              # ...
          );
 # sample output:
 [Thu Jan 19 21:33:08 2006] [debug] Mason execution chain:
 [Thu Jan 19 21:33:08 2006] [debug] /index.html (0.0004)
 [Thu Jan 19 21:33:08 2006] [debug]     /autohandler (0.0959)
 [Thu Jan 19 21:33:08 2006] [debug]         /index.html:_init (0.0005)
 [Thu Jan 19 21:33:08 2006] [debug]         /index.html:sidebar (0.0545)
 [Thu Jan 19 21:33:08 2006] [debug]         /_gfx (0.0005)
 [Thu Jan 19 21:33:08 2006] [debug]         /index.html (0.0968)
 [Thu Jan 19 21:33:08 2006] [debug]         /_toc (0.0010)
 [Thu Jan 19 21:33:08 2006] [debug]         /_ul (0.0018)
 [Thu Jan 19 21:33:08 2006] [debug]         /_search (0.0006)
 [Thu Jan 19 21:33:08 2006] [debug]         /_bc (0.0016)
 [Thu Jan 19 21:33:08 2006] [debug]             /autohandler:bc (0.0004)
 [Thu Jan 19 21:33:08 2006] [debug]         /_ul (0.0027)
  
=head1 DESCRIPTION

This HTML::Mason plugin should be used by developers to get an overview of a mason handler execution chain.


INTERFACE

There is no public interface. Loading this plugin is enough to do its job, logging its findings to STDERR (usually httpd's error_log).


CONFIGURATION AND ENVIRONMENT

MasonX::Plugin::CompDebug::DEBUG_URI

This is the regular expression applied to $r->uri to determine if execution chain should be monitored or not. By default it's set to qr{.} — monitor every request.


DEPENDENCIES

HTML::Mason, Time::HiRes, version.


INCOMPATIBILITIES

None reported.


BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to <altblue@n0i.net>.


AUTHOR

Marius FERARU <altblue@n0i.net>


LICENCE AND COPYRIGHT

Copyright (c) 2006, Marius FERARU <altblue AT n0i DOT net>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See >perlartistic.


DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.