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 B::Terse‐
71       Size, you must load B::TerseSize first.
72

Options

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

Prerequisites

168       The "Devel::Symdump" module, version 2.00 or higher.
169
170       Other optional functionality requirements: "B::Deparse" - 0.59,
171       "B::Fathom" - 0.05, ""B::Graph"" - 0.03.
172

174       mod_perl 2.0 and its core modules are copyrighted under The Apache
175       Software License, Version 2.0.
176

See Also

178       perl(1), Apache(3), Devel::Symdump(3), Data::Dumper(3), B(3),
179       "B::Graph"(3), mod_perl 2.0 documentation.
180

Authors

182       Doug MacEachern with contributions from Stas Bekman
183
184
185
186perl v5.8.8                       2006-11-19     docs::api::Apache2::Status(3)
Impressum