Apache2::Status(3pm)

1docs::api::Apache2::StaUtsuesr(3C)ontributed Perl Documednotcast:i:oanpi::Apache2::Status(3)
2
3
4

NAME

6       Apache2::Status - Embedded interpreter status information
7

Synopsis

9         <Location /perl-status>
10             SetHandler modperl
11             PerlOptions +GlobalRequest
12             PerlResponseHandler Apache2::Status
13         </Location>
14
15         or
16
17         <Location /perl-status>
18             SetHandler perl-script
19             PerlResponseHandler Apache2::Status
20         </Location>
21

Description

23       The "Apache2::Status" module provides some information about the status
24       of the Perl interpreter embedded in the server.
25
26       Configure like so:
27
28         <Location /perl-status>
29             SetHandler modperl
30             PerlOptions +GlobalRequest
31             PerlResponseHandler Apache2::Status
32         </Location>
33
34       Notice that under the "modperl" core handler the Environment menu
35       option will show only the environment under that handler. To see the
36       environment seen by handlers running under the "perl-script" core
37       handler, configure "Apache2::Status" as:
38
39         <Location /perl-status>
40             SetHandler perl-script
41             PerlResponseHandler Apache2::Status
42         </Location>
43
44       Other modules can "plugin" a menu item like so:
45
46         require Apache2::Module;
47         Apache2::Status->menu_item(
48             'DBI' => "DBI connections", #item for Apache::DBI module
49             sub {
50                 my ($r, $q) = @_; #request and CGI objects
51                 my (@strings);
52                 push @strings,  "blobs of html";
53                 return \@strings;     #return an array ref
54             }
55         ) if Apache2::Module::loaded('Apache2::Status');
56
57       WARNING: "Apache2::Status" must be loaded before these modules via the
58       "PerlModule" or "PerlRequire" directives (or from startup.pl).
59
60       A very common setup might be:
61         Perl Module B::TerseSize
62
63         <Location /perl-status>
64             SetHandler perl-script
65             PerlResponseHandler Apache2::Status
66             PerlSetVar StatusOptionsAll On
67             PerlSetVar StatusDeparseOptions "-p -sC"
68         </Location>
69
70       due to the implementation of Apache2::Status::noh_fileline in
71       B::TerseSize, you must load B::TerseSize first.
72

Options

74   "StatusOptionsAll"
75       This single directive will enable all of the options described below.
76
77         PerlSetVar StatusOptionsAll On
78
79   "StatusDumper"
80       When browsing symbol tables, the values of arrays, hashes and scalars
81       can be viewed via "Data::Dumper" if this configuration variable is set
82       to "On":
83
84         PerlSetVar StatusDumper On
85
86   "StatusPeek"
87       With this option "On" and the "Apache::Peek" module installed,
88       functions and variables can be viewed ala "Devel::Peek" style:
89
90         PerlSetVar StatusPeek On
91
92   "StatusLexInfo"
93       With this option "On" and the "B::LexInfo" module installed, subroutine
94       lexical variable information can be viewed.
95
96         PerlSetVar StatusLexInfo On
97
98   "StatusDeparse"
99       With this option "On" subroutines can be "deparsed".
100
101         PerlSetVar StatusDeparse On
102
103       Options can be passed to "B::Deparse::new" like so:
104
105         PerlSetVar StatusDeparseOptions "-p -sC"
106
107       See the "B::Deparse" manpage for details.
108
109   "StatusTerse"
110       With this option "On", text-based op tree graphs of subroutines can be
111       displayed, thanks to "B::Terse".
112
113         PerlSetVar StatusTerse On
114
115   "StatusTerseSize"
116       With this option "On" and the "B::TerseSize" module installed, text-
117       based op tree graphs of subroutines and their size can be displayed.
118       See the "B::TerseSize" docs for more info.
119
120         PerlSetVar StatusTerseSize On
121
122   "StatusTerseSizeMainSummary"
123       With this option "On" and the "B::TerseSize" module installed, a
124       "Memory Usage" will be added to the "Apache2::Status" main menu.  This
125       option is disabled by default, as it can be rather cpu intensive to
126       summarize memory usage for the entire server.  It is strongly suggested
127       that this option only be used with a development server running in "-X"
128       mode, as the results will be cached.
129
130         PerlSetVar StatusTerseSizeMainSummary On
131
132   "StatusGraph"
133       When "StatusDumper" is enabled, another link "OP Tree Graph" will be
134       present with the dump if this configuration variable is set to "On":
135
136         PerlSetVar StatusGraph
137
138       This requires the B module (part of the Perl compiler kit) and
139       "B::Graph" (version 0.03 or higher) module to be installed along with
140       the "dot" program.
141
142       Dot is part of the graph visualization toolkit from AT&T:
143       http://www.graphviz.org/.
144
145       WARNING: Some graphs may produce very large images, some graphs may
146       produce no image if "B::Graph"'s output is incorrect.
147
148   "Dot"
149       Location of the dot program for "StatusGraph", if other than /usr/bin
150       or /usr/local/bin
151
152   "GraphDir"
153       Directory where "StatusGraph" should write it's temporary image files.
154       Default is "$ServerRoot/logs/b_graphs".
155

Prerequisites

157       The "Devel::Symdump" module, version 2.00 or higher.
158
159       Other optional functionality requirements: "B::Deparse" - 0.59,
160       "B::Fathom" - 0.05, ""B::Graph"" - 0.03.
161

Copyright

163       mod_perl 2.0 and its core modules are copyrighted under The Apache
164       Software License, Version 2.0.
165

Authors

171       Doug MacEachern with contributions from Stas Bekman
172
173
174
175perl v5.12.0                      2007-11-12     docs::api::Apache2::Status(3)