mod_status.c revision ce03576b2434cec77f2921db9d5b6a0510581c23
842ae4bd224140319ae7feec1872b93dfd491143fielding/* ====================================================================
842ae4bd224140319ae7feec1872b93dfd491143fielding * The Apache Software License, Version 1.1
842ae4bd224140319ae7feec1872b93dfd491143fielding * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
842ae4bd224140319ae7feec1872b93dfd491143fielding * reserved.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * Redistribution and use in source and binary forms, with or without
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * modification, are permitted provided that the following conditions
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * are met:
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * 1. Redistributions of source code must retain the above copyright
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * notice, this list of conditions and the following disclaimer.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * 2. Redistributions in binary form must reproduce the above copyright
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * notice, this list of conditions and the following disclaimer in
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * the documentation and/or other materials provided with the
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * distribution.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * 3. The end-user documentation included with the redistribution,
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * if any, must include the following acknowledgment:
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * "This product includes software developed by the
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * Apache Software Foundation (http://www.apache.org/)."
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * Alternately, this acknowledgment may appear in the software itself,
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * if and wherever such third-party acknowledgments normally appear.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 4. The names "Apache" and "Apache Software Foundation" must
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * not be used to endorse or promote products derived from this
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * software without prior written permission. For written
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * permission, please contact apache@apache.org.
e18e68b42830409bf48de0df9eed3fe363664aa7aaron * 5. Products derived from this software may not be called "Apache",
70535d6421eb979ac79d8f49d31cd94d75dd8b2fjorton * nor may "Apache" appear in their name, without prior written
8464a9c46b967001e38fe3c8afff51a649e9de51dougm * permission of the Apache Software Foundation.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * SUCH DAMAGE.
05413593151a238718198cc04ca849b2426be106rse * ====================================================================
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * This software consists of voluntary contributions made by many
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * individuals on behalf of the Apache Software Foundation. For more
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * information on the Apache Software Foundation, please see
434ad3e8e769a6a7a78c15f3ae2f7ae3adbfbb49wrowe * Portions of this software are based upon public domain software
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * originally written at the National Center for Supercomputing Applications,
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * University of Illinois, Urbana-Champaign.
05413593151a238718198cc04ca849b2426be106rse/* Status Module. Display lots of internal data about how Apache is
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * performing and the state of all children processes.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * To enable this, add the following lines into any config file:
87a1c79b7b37702a254920ca5214fb282a4fb085dougm * <Location /server-status>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * SetHandler server-status
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * </Location>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * You may want to protect this location by password or domain so no one
e8f95a682820a599fe41b22977010636be5c2717jim * else can look at it. Then you can access the statistics with a URL like:
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * /server-status - Returns page using tables
e8f95a682820a599fe41b22977010636be5c2717jim * /server-status?notable - Returns page for browsers without table support
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * /server-status?refresh - Returns page with 1 second refresh
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * /server-status?refresh=6 - Returns page with refresh every 6 seconds
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * /server-status?auto - Returns page with data for automatic parsing
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * Mark Cox, mark@ukweb.com, November 1995
87a1c79b7b37702a254920ca5214fb282a4fb085dougm * 12.11.95 Initial version for www.telescope.org
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * 13.3.96 Updated to remove rprintf's [Mark]
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * 18.3.96 Added CPU usage, process information, and tidied [Ben Laurie]
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 18.3.96 Make extra Scoreboard variables #definable
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 25.3.96 Make short report have full precision [Ben Laurie suggested]
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * 25.3.96 Show uptime better [Mark/Ben Laurie]
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 29.3.96 Better HTML and explanation [Mark/Rob Hartill suggested]
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse * 09.4.96 Added message for non-STATUS compiled version
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 18.4.96 Added per child and per slot counters [Jim Jagielski]
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 01.5.96 Table format, cleanup, even more spiffy data [Chuck Murcko/Jim J.]
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 18.5.96 Adapted to use new rprintf() routine, incidentally fixing a missing
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * piece in short reports [Ben Laurie]
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * 21.5.96 Additional Status codes (DNS and LOGGING only enabled if
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * extended STATUS is enabled) [George Burgyan/Jim J.]
87a1c79b7b37702a254920ca5214fb282a4fb085dougm * 10.8.98 Allow for extended status info at runtime (no more STATUS)
e8f95a682820a599fe41b22977010636be5c2717jim#endif /* NEXT */
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse *command-related code. This is here to prevent use of ExtendedStatus
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse * without status_module included.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrsestatic const char *set_extended_status(cmd_parms *cmd, void *dummy, int arg)
e8f95a682820a599fe41b22977010636be5c2717jim const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
ea6ff3396df1d6d43ee0ecfa3e26ada981d8e9a3sctemme AP_INIT_FLAG("ExtendedStatus", set_extended_status, NULL, RSRC_CONF,
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse "\"On\" to enable extended status information, \"Off\" to disable"),
14099c5540ce39114b5501a71ff96e40f48efc4bmartin/* Format the number of bytes nicely */
14099c5540ce39114b5501a71ff96e40f48efc4bmartinstatic void format_byte_out(request_rec *r, unsigned long bytes)
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrsestatic void format_kbyte_out(request_rec *r, unsigned long kbytes)
ea6ff3396df1d6d43ee0ecfa3e26ada981d8e9a3sctemmestatic void show_time(request_rec *r, apr_interval_time_t tsecs)
a0e0d20b666cfc453ac76506079eb50e03997eefdougm ap_rprintf(r, " %d day%s", days, days == 1 ? "" : "s");
a0e0d20b666cfc453ac76506079eb50e03997eefdougm ap_rprintf(r, " %d hour%s", hrs, hrs == 1 ? "" : "s");
a0e0d20b666cfc453ac76506079eb50e03997eefdougm ap_rprintf(r, " %d minute%s", mins, mins == 1 ? "" : "s");
a0e0d20b666cfc453ac76506079eb50e03997eefdougm ap_rprintf(r, " %d second%s", secs, secs == 1 ? "" : "s");
a0e0d20b666cfc453ac76506079eb50e03997eefdougm/* Main handler for x-httpd-status requests */
a0e0d20b666cfc453ac76506079eb50e03997eefdougm/* ID values for command table */
a0e0d20b666cfc453ac76506079eb50e03997eefdougm const char *hdr_out_str;
a0e0d20b666cfc453ac76506079eb50e03997eefdougmstatic const struct stat_opt status_options[] = /* see #defines above */
a0e0d20b666cfc453ac76506079eb50e03997eefdougm const char *loc;
a0e0d20b666cfc453ac76506079eb50e03997eefdougm int j, i, res;
a0e0d20b666cfc453ac76506079eb50e03997eefdougm unsigned long count = 0;
a0e0d20b666cfc453ac76506079eb50e03997eefdougm unsigned short conn_lres;
a0e0d20b666cfc453ac76506079eb50e03997eefdougm unsigned long bcount = 0;
a0e0d20b666cfc453ac76506079eb50e03997eefdougm unsigned long kbcount = 0;
a0e0d20b666cfc453ac76506079eb50e03997eefdougm char stat_buffer[HARD_SERVER_LIMIT * HARD_THREAD_LIMIT];
a0e0d20b666cfc453ac76506079eb50e03997eefdougm int pid_buffer[HARD_SERVER_LIMIT * HARD_THREAD_LIMIT];
22357f10585a847ebf7b084cbe1db07ba071aeb6dougm if (strcmp(r->handler, STATUS_MAGIC_TYPE) && strcmp(r->handler, "server-status")) {
22357f10585a847ebf7b084cbe1db07ba071aeb6dougm ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
dd7c683f683624b082d430935b594df7406782c2dougm "Server status unavailable in inetd mode");
dd7c683f683624b082d430935b594df7406782c2dougm * Simple table-driven form data set parser that lets you alter the header
176c2742db03fcb7b7d13e6408dd967d87e542e9ben if ((loc = ap_strstr_c(r->args, status_options[i].form_data_str)) != NULL) {
176c2742db03fcb7b7d13e6408dd967d87e542e9ben if (*(loc + strlen(status_options[i].form_data_str)) == '='
176c2742db03fcb7b7d13e6408dd967d87e542e9ben/* ap_sync_scoreboard_image(); */
e0c3fda9f782aee1140d83fbce32672ac299f2a4ben for (i = 0; i < HARD_SERVER_LIMIT; ++i) {
e0c3fda9f782aee1140d83fbce32672ac299f2a4ben for (j = 0; j < HARD_THREAD_LIMIT; ++j) {
dd7c683f683624b082d430935b594df7406782c2dougm if (lres != 0 || (res != SERVER_READY && res != SERVER_DEAD)) {
e18e68b42830409bf48de0df9eed3fe363664aa7aaron#endif /* HAVE_TIMES */
d54a31567fc49f1841d27a14796ae726016c54aadougm /* up_time in seconds */
3c65aa88903de7330a07e133dfda779842fadad4wrowe up_time = (apr_uint32_t) ((nowtime - ap_restart_time)/1000000);
3c65aa88903de7330a07e133dfda779842fadad4wrowe "<HTML><HEAD>\n<TITLE>Apache Status</TITLE>\n</HEAD><BODY>\n",
3c65aa88903de7330a07e133dfda779842fadad4wrowe ap_rvputs(r, ap_get_server_name(r), "</H1>\n\n", NULL);
b40799adcfd0f0a2a465c2934585986f7bbc9bbcwrowe ap_ht_time(r->pool, nowtime, DEFAULT_TIME_FORMAT, 0), "<br>\n", NULL);
b40799adcfd0f0a2a465c2934585986f7bbc9bbcwrowe ap_ht_time(r->pool, ap_restart_time, DEFAULT_TIME_FORMAT, 0),
b40799adcfd0f0a2a465c2934585986f7bbc9bbcwrowe ap_rprintf(r, "Parent Server Generation: %d <br>\n", (int) ap_my_generation);
8e09f1830f114c016598a3b76fd6d31e1589c012sctemme ap_rprintf(r, "Total Accesses: %lu\nTotal kBytes: %lu\n",
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme /* Allow for OS/2 not having CPU stats */
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme else { /* !short_report */
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rprintf(r, "Total accesses: %lu - Total Traffic: ", count);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme /* Allow for OS/2 not having CPU stats */
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme format_byte_out(r, KBYTE * (float) kbcount / (float) up_time);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme format_byte_out(r, KBYTE * (float) kbcount / (float) count);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme } /* short_report */
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme } /* ap_extended_status */
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rprintf(r, "\n%d requests currently being processed, %d idle servers\n"
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rprintf(r, "BusyServers: %d\nIdleServers: %d\n", busy, ready);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme /* send the scoreboard 'table' out */
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme for (i = 0; i < HARD_SERVER_LIMIT; ++i) {
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme for (j = 0; j < HARD_THREAD_LIMIT; ++j) {
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme if ((indx % STATUS_MAXLINE == (STATUS_MAXLINE - 1)) && !short_report)
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>_</code></B>\" Waiting for Connection, \n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>S</code></B>\" Starting up, \n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>R</code></B>\" Reading Request,<BR>\n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>W</code></B>\" Sending Reply, \n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>K</code></B>\" Keepalive (read), \n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>D</code></B>\" DNS Lookup,<BR>\n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>L</code></B>\" Logging, \n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>G</code></B>\" Gracefully finishing, \n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>I</code></B>\" Idle cleanup of worker, \n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("\"<B><code>.</code></B>\" Open slot with no current process<P>\n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme for (i = 0; i < HARD_SERVER_LIMIT; ++i) {
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme for (j = 0; j < HARD_THREAD_LIMIT; ++j) {
98f81eac9530d487f05013cda9df99755bb59689trawick if (++k >= 3) {
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme /* Allow for OS/2 not having CPU stats */
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("<p>\n\n<table border=0><tr><th>Srv<th>PID<th>Acc<th>M\n<th>SS<th>Req<th>Conn<th>Child<th>Slot<th>Client<th>VHost<th>Request</tr>\n\n", r);
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme ap_rputs("<p>\n\n<table border=0><tr><th>Srv<th>PID<th>Acc<th>M<th>CPU\n<th>SS<th>Req<th>Conn<th>Child<th>Slot<th>Client<th>VHost<th>Request</tr>\n\n", r);
3c65aa88903de7330a07e133dfda779842fadad4wrowe for (i = 0; i < HARD_SERVER_LIMIT; ++i) {
d94fd18ee21dc9b8c1f422144a881e941687d41fdougm for (j = 0; j < HARD_THREAD_LIMIT; ++j) {
d94fd18ee21dc9b8c1f422144a881e941687d41fdougm#endif /* HAVE_TIMES */
e62985c7a1b46a5036a247f35bddac1308985758dougm req_time = score_record.stop_time - score_record.start_time;
1eddce0da057f6fa5c5e9dde32e9dc6596616b12sctemme#endif /* HAVE_TIMES */
3c65aa88903de7330a07e133dfda779842fadad4wrowe ((score_record.stop_time - score_record.start_time) * 1000) +
3c65aa88903de7330a07e133dfda779842fadad4wrowe ((score_record.stop_time - score_record.start_time) / 1000);
req_time = 0L;
if (!short_report) {
if (no_table_report) {
ap_rprintf(r,
ap_rprintf(r,
case SERVER_READY:
case SERVER_STARTING:
case SERVER_BUSY_READ:
case SERVER_BUSY_WRITE:
case SERVER_BUSY_KEEPALIVE:
case SERVER_BUSY_LOG:
case SERVER_BUSY_DNS:
case SERVER_DEAD:
case SERVER_GRACEFUL:
#ifndef HAVE_TIMES
#ifdef OPTIMIZE_TIMEOUTS
(long) req_time);
ap_rprintf(r,
ap_rprintf(r,
case SERVER_READY:
case SERVER_STARTING:
case SERVER_BUSY_READ:
case SERVER_BUSY_WRITE:
case SERVER_BUSY_KEEPALIVE:
case SERVER_BUSY_LOG:
case SERVER_BUSY_DNS:
case SERVER_DEAD:
case SERVER_GRACEFUL:
#ifndef HAVE_TIMES
#ifdef OPTIMIZE_TIMEOUTS
(long) req_time);
ap_rprintf(r,
ap_rprintf(r,
#ifndef HAVE_TIMES
if (!short_report) {
if (!short_report) {