=head1 NAME Apache2::Status - Embedded interpreter status information =head1 Synopsis # disallow public access Order Deny, Allow Deny from all Allow from 127.0.0.1 SetHandler modperl PerlOptions +GlobalRequest PerlResponseHandler Apache2::Status or # disallow public access Order Deny, Allow Deny from all Allow from 127.0.0.1 SetHandler perl-script PerlResponseHandler Apache2::Status =head1 Description The C module provides some information about the status of the Perl interpreter embedded in the server. Configure like so: # disallow public access Order Deny, Allow Deny from all Allow from 127.0.0.1 SetHandler modperl PerlOptions +GlobalRequest PerlResponseHandler Apache2::Status Notice that under the C> core handler the I menu option will show only the environment under that handler. To see the environment seen by handlers running under the C> core handler, configure C as: # disallow public access Order Deny, Allow Deny from all Allow from 127.0.0.1 SetHandler perl-script PerlResponseHandler Apache2::Status Other modules can "plugin" a menu item like so: require Apache2::Module; Apache2::Status->menu_item( 'DBI' => "DBI connections", #item for Apache::DBI module sub { my ($r, $q) = @_; #request and CGI objects my (@strings); push @strings, "blobs of html"; return \@strings; #return an array ref } ) if Apache2::Module::loaded('Apache2::Status'); B: C must be loaded before these modules via the C or C directives (or from F). A very common setup might be: Perl Module B::TerseSize SetHandler perl-script PerlResponseHandler Apache2::Status PerlSetVar StatusOptionsAll On PerlSetVar StatusDeparseOptions "-p -sC" due to the implementation of Apache2::Status::noh_fileline in B::TerseSize, you must load B::TerseSize first. =head1 Options =head2 C This single directive will enable all of the options described below. PerlSetVar StatusOptionsAll On =head2 C When browsing symbol tables, the values of arrays, hashes and scalars can be viewed via C if this configuration variable is set to C: PerlSetVar StatusDumper On =head2 C With this option C and the C module installed, functions and variables can be viewed ala C style: PerlSetVar StatusPeek On =head2 C With this option C and the C module installed, subroutine lexical variable information can be viewed. PerlSetVar StatusLexInfo On =head2 C With this option C subroutines can be "deparsed". PerlSetVar StatusDeparse On Options can be passed to C like so: PerlSetVar StatusDeparseOptions "-p -sC" See the C manpage for details. =head2 C With this option C, text-based op tree graphs of subroutines can be displayed, thanks to C. PerlSetVar StatusTerse On =head2 C With this option C and the C module installed, text-based op tree graphs of subroutines and their size can be displayed. See the C docs for more info. PerlSetVar StatusTerseSize On =head2 C With this option C and the C module installed, a I<"Memory Usage"> will be added to the C main menu. This option is disabled by default, as it can be rather cpu intensive to summarize memory usage for the entire server. It is strongly suggested that this option only be used with a development server running in C<-X> mode, as the results will be cached. PerlSetVar StatusTerseSizeMainSummary On =head2 C When C is enabled, another link I<"OP Tree Graph"> will be present with the dump if this configuration variable is set to C: PerlSetVar StatusGraph This requires the B module (part of the Perl compiler kit) and C (version 0.03 or higher) module to be installed along with the C program. Dot is part of the graph visualization toolkit from AT&T: http://www.graphviz.org/. B: Some graphs may produce very large images, some graphs may produce no image if C's output is incorrect. =head2 C Location of the dot program for C, if other than I or I =head2 C Directory where C should write it's temporary image files. Default is C<$ServerRoot/logs/b_graphs>. =head1 Prerequisites The C module, version C<2.00> or higher. Other optional functionality requirements: C - 0.59, C - 0.05, C> - 0.03. =head1 Copyright mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0. =head1 See Also perl(1), Apache(3), Devel::Symdump(3), Data::Dumper(3), B(3), C(3), L. =head1 Authors Doug MacEachern with contributions from Stas Bekman =cut