Apache::Status(3) User Contributed Perl Documentation Apache::Status(3)
NAME
Apache::Status - Embedded interpreter status information
SYNOPSIS
<Location /perl-status>
SetHandler perl-script
PerlHandler Apache::Status
</Location>
DESCRIPTION
The Apache::Status module provides some information about the status of
the Perl interpreter embedded in the server.
Configure like so:
<Location /perl-status>
SetHandler perl-script
PerlHandler Apache::Status
</Location>
Other modules can "plugin" a menu item like so:
Apache::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 Apache->module("Apache::Status"); #only if Apache::Status is loaded
WARNING: Apache::Status must be loaded before these modules via the
PerlModule or PerlRequire directives.
OPTIONS
StatusOptionsAll
This single directive will enable all of the options described
below.
PerlSetVar StatusOptionsAll On
StatusDumper
When browsing symbol tables, the values of arrays, hashes ans
calars can be viewed via Data::Dumper if this configuration
variable is set to On:
PerlSetVar StatusDumper On
StatusPeek
With this option On and the Apache::Peek module installed,
functions and variables can be viewed ala Devel::Peek style:
PerlSetVar StatusPeek On
StatusLexInfo
With this option On and the B::LexInfo module installed, subroutine
lexical variable information can be viewed.
PerlSetVar StatusLexInfo On
StatusDeparse
With this option On and B::Deparse version 0.59 or higher (included
in Perl 5.005_59+), subroutines can be "deparsed".
PerlSetVar StatusDeparse On
Options can be passed to B::Deparse::new like so:
PerlSetVar StatusDeparseOptions "-p -sC"
See the B::Deparse manpage for details.
StatusTerse
With this option On, text-based op tree graphs of subroutines can
be displayed, thanks to B::Terse.
PerlSetVar StatusTerse On
StatusTerseSize
With this option On and the B::TerseSize module installed, text-
based op tree graphs of subroutines and their size can be
displayed. See the B::TerseSize docs for more info.
PerlSetVar StatusTerseSize On
StatusTerseSizeMainSummary
With this option On and the B::TerseSize module installed, a
"Memory Usage" will be added to the Apache::Status 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 -X mode, as the results will be cached.
PerlSetVar StatusTerseSizeMainSummary On
StatusGraph
When StatusDumper is enabled, another link "OP Tree Graph" will be
present with the dump if this configuration variable is set to On:
PerlSetVar StatusGraph
This requires the B module (part of the Perl compiler kit) and
B::Graph (version 0.03 or higher) module to be installed along with
the dot program.
Dot is part of the graph visualization toolkit from AT&T:
"http://www.research.att.com/sw/tools/graphviz/").
WARNING: Some graphs may produce very large images, some graphs may
produce no image if B::Graph's output is incorrect.
Dot Location of the dot program for StatusGraph, if other than /usr/bin
or /usr/local/bin
GraphDir
Directory where StatusGraph should write it's temporary image
files. Default is $ServerRoot/logs/b_graphs
PREREQUISITES
The Devel::Symdump module, version 2.00 or higher.
SEE ALSO
perl(1), Apache(3), Devel::Symdump(3), Data::Dumper(3), B(3),
B::Graph(3)
AUTHOR
Doug MacEachern
perl v5.8.8 2003-10-08 Apache::Status(3)
Mac OS X 10.5 Server - Generated Sun Jun 15 13:59:46 CDT 2008