libapache2-mod-perl2-doc 2.0.8+httpd24-r1449661-6ubuntu2 / usr / share / doc / libapache2-mod-perl2-doc / docs / 2.0 / api / Apache2 / Status.html

This file is indexed.

/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/Apache2/Status.html is in libapache2-mod-perl2-doc 2.0.8+httpd24-r1449661-6ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body style="background-color: white">



<ul id="index">
  <li><a href="#NAME">NAME</a></li>
  <li><a href="#Synopsis">Synopsis</a></li>
  <li><a href="#Description">Description</a></li>
  <li><a href="#Options">Options</a>
    <ul>
      <li><a href="#StatusOptionsAll">StatusOptionsAll</a></li>
      <li><a href="#StatusDumper">StatusDumper</a></li>
      <li><a href="#StatusPeek">StatusPeek</a></li>
      <li><a href="#StatusLexInfo">StatusLexInfo</a></li>
      <li><a href="#StatusDeparse">StatusDeparse</a></li>
      <li><a href="#StatusTerse">StatusTerse</a></li>
      <li><a href="#StatusTerseSize">StatusTerseSize</a></li>
      <li><a href="#StatusTerseSizeMainSummary">StatusTerseSizeMainSummary</a></li>
      <li><a href="#StatusGraph">StatusGraph</a></li>
      <li><a href="#Dot">Dot</a></li>
      <li><a href="#GraphDir">GraphDir</a></li>
    </ul>
  </li>
  <li><a href="#Prerequisites">Prerequisites</a></li>
  <li><a href="#Copyright">Copyright</a></li>
  <li><a href="#See-Also">See Also</a></li>
  <li><a href="#Authors">Authors</a></li>
</ul>

<h1 id="NAME">NAME</h1>

<p>Apache2::Status - Embedded interpreter status information</p>

<h1 id="Synopsis">Synopsis</h1>

<pre><code>  &lt;Location /perl-status&gt;

      # disallow public access
      Order Deny, Allow
      Deny from all
      Allow from 127.0.0.1

      SetHandler modperl
      PerlOptions +GlobalRequest
      PerlResponseHandler Apache2::Status
  &lt;/Location&gt;

  or

  &lt;Location /perl-status&gt;

      # disallow public access
      Order Deny, Allow
      Deny from all
      Allow from 127.0.0.1

      SetHandler perl-script
      PerlResponseHandler Apache2::Status
  &lt;/Location&gt;</code></pre>

<h1 id="Description">Description</h1>

<p>The <code>Apache2::Status</code> module provides some information about the status of the Perl interpreter embedded in the server.</p>

<p>Configure like so:</p>

<pre><code>  &lt;Location /perl-status&gt;

      # disallow public access
      Order Deny, Allow
      Deny from all
      Allow from 127.0.0.1

      SetHandler modperl
      PerlOptions +GlobalRequest
      PerlResponseHandler Apache2::Status
  &lt;/Location&gt;</code></pre>

<p>Notice that under the <code><a>&quot;modperl&quot;</a></code> core handler the <i>Environment</i> menu option will show only the environment under that handler. To see the environment seen by handlers running under the <code><a>&quot;perl-script&quot;</a></code> core handler, configure <code>Apache2::Status</code> as:</p>

<pre><code>  &lt;Location /perl-status&gt;

      # disallow public access
      Order Deny, Allow
      Deny from all
      Allow from 127.0.0.1

      SetHandler perl-script
      PerlResponseHandler Apache2::Status
  &lt;/Location&gt;</code></pre>

<p>Other modules can &quot;plugin&quot; a menu item like so:</p>

<pre><code>  require Apache2::Module;
  Apache2::Status-&gt;menu_item(
      &#39;DBI&#39; =&gt; &quot;DBI connections&quot;, #item for Apache::DBI module
      sub {
          my ($r, $q) = @_; #request and CGI objects
          my (@strings);
          push @strings,  &quot;blobs of html&quot;;
          return \@strings;     #return an array ref
      }
  ) if Apache2::Module::loaded(&#39;Apache2::Status&#39;);</code></pre>

<p><b>WARNING</b>: <code>Apache2::Status</code> must be loaded before these modules via the <code>PerlModule</code> or <code>PerlRequire</code> directives (or from <i>startup.pl</i>).</p>

<p>A very common setup might be: Perl Module B::TerseSize</p>

<pre><code>  &lt;Location /perl-status&gt;
      SetHandler perl-script
      PerlResponseHandler Apache2::Status
      PerlSetVar StatusOptionsAll On
      PerlSetVar StatusDeparseOptions &quot;-p -sC&quot;
  &lt;/Location&gt;</code></pre>

<p>due to the implementation of Apache2::Status::noh_fileline in B::TerseSize, you must load B::TerseSize first.</p>

<h1 id="Options">Options</h1>

<h2 id="StatusOptionsAll"><code>StatusOptionsAll</code></h2>

<p>This single directive will enable all of the options described below.</p>

<pre><code>  PerlSetVar StatusOptionsAll On</code></pre>

<h2 id="StatusDumper"><code>StatusDumper</code></h2>

<p>When browsing symbol tables, the values of arrays, hashes and scalars can be viewed via <code>Data::Dumper</code> if this configuration variable is set to <code>On</code>:</p>

<pre><code>  PerlSetVar StatusDumper On</code></pre>

<h2 id="StatusPeek"><code>StatusPeek</code></h2>

<p>With this option <code>On</code> and the <code>Apache::Peek</code> module installed, functions and variables can be viewed ala <code>Devel::Peek</code> style:</p>

<pre><code>  PerlSetVar StatusPeek On</code></pre>

<h2 id="StatusLexInfo"><code>StatusLexInfo</code></h2>

<p>With this option <code>On</code> and the <code>B::LexInfo</code> module installed, subroutine lexical variable information can be viewed.</p>

<pre><code>  PerlSetVar StatusLexInfo On</code></pre>

<h2 id="StatusDeparse"><code>StatusDeparse</code></h2>

<p>With this option <code>On</code> subroutines can be &quot;deparsed&quot;.</p>

<pre><code>  PerlSetVar StatusDeparse On</code></pre>

<p>Options can be passed to <code>B::Deparse::new</code> like so:</p>

<pre><code>  PerlSetVar StatusDeparseOptions &quot;-p -sC&quot;</code></pre>

<p>See the <code>B::Deparse</code> manpage for details.</p>

<h2 id="StatusTerse"><code>StatusTerse</code></h2>

<p>With this option <code>On</code>, text-based op tree graphs of subroutines can be displayed, thanks to <code>B::Terse</code>.</p>

<pre><code>  PerlSetVar StatusTerse On</code></pre>

<h2 id="StatusTerseSize"><code>StatusTerseSize</code></h2>

<p>With this option <code>On</code> and the <code>B::TerseSize</code> module installed, text-based op tree graphs of subroutines and their size can be displayed. See the <code>B::TerseSize</code> docs for more info.</p>

<pre><code>  PerlSetVar StatusTerseSize On</code></pre>

<h2 id="StatusTerseSizeMainSummary"><code>StatusTerseSizeMainSummary</code></h2>

<p>With this option <code>On</code> and the <code>B::TerseSize</code> module installed, a <i>&quot;Memory Usage&quot;</i> will be added to the <code>Apache2::Status</code> 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 <code>-X</code> mode, as the results will be cached.</p>

<pre><code>  PerlSetVar StatusTerseSizeMainSummary On</code></pre>

<h2 id="StatusGraph"><code>StatusGraph</code></h2>

<p>When <code>StatusDumper</code> is enabled, another link <i>&quot;OP Tree Graph&quot;</i> will be present with the dump if this configuration variable is set to <code>On</code>:</p>

<pre><code>  PerlSetVar StatusGraph</code></pre>

<p>This requires the B module (part of the Perl compiler kit) and <code>B::Graph</code> (version 0.03 or higher) module to be installed along with the <code>dot</code> program.</p>

<p>Dot is part of the graph visualization toolkit from AT&amp;T: http://www.graphviz.org/.</p>

<p><b>WARNING</b>: Some graphs may produce very large images, some graphs may produce no image if <code>B::Graph</code>&#39;s output is incorrect.</p>

<h2 id="Dot"><code>Dot</code></h2>

<p>Location of the dot program for <code>StatusGraph</code>, if other than <i>/usr/bin</i> or <i>/usr/local/bin</i></p>

<h2 id="GraphDir"><code>GraphDir</code></h2>

<p>Directory where <code>StatusGraph</code> should write it&#39;s temporary image files. Default is <code>$ServerRoot/logs/b_graphs</code>.</p>

<h1 id="Prerequisites">Prerequisites</h1>

<p>The <code>Devel::Symdump</code> module, version <code>2.00</code> or higher.</p>

<p>Other optional functionality requirements: <code>B::Deparse</code> - 0.59, <code>B::Fathom</code> - 0.05, <code><code>B::Graph</code></code> - 0.03.</p>

<h1 id="Copyright">Copyright</h1>

<p>mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.</p>

<h1 id="See-Also">See Also</h1>

<p>perl(1), Apache(3), Devel::Symdump(3), Data::Dumper(3), B(3), <code>B::Graph</code>(3), <a>mod_perl 2.0 documentation</a>.</p>

<h1 id="Authors">Authors</h1>

<p>Doug MacEachern with contributions from Stas Bekman</p>


</body>

</html>

APT Browse - Built by Thomas Orozco.