mod_status.c revision d90b36a9e6f6ea9a583694f4db5e5edd54a750b3
842ae4bd224140319ae7feec1872b93dfd491143fielding/* Licensed to the Apache Software Foundation (ASF) under one or more
842ae4bd224140319ae7feec1872b93dfd491143fielding * contributor license agreements. See the NOTICE file distributed with
842ae4bd224140319ae7feec1872b93dfd491143fielding * this work for additional information regarding copyright ownership.
842ae4bd224140319ae7feec1872b93dfd491143fielding * The ASF licenses this file to You under the Apache License, Version 2.0
842ae4bd224140319ae7feec1872b93dfd491143fielding * (the "License"); you may not use this file except in compliance with
842ae4bd224140319ae7feec1872b93dfd491143fielding * the License. You may obtain a copy of the License at
04891cf70e0bfc38bfb027541dc821f04c754ff7nd * Unless required by applicable law or agreed to in writing, software
04891cf70e0bfc38bfb027541dc821f04c754ff7nd * distributed under the License is distributed on an "AS IS" BASIS,
04891cf70e0bfc38bfb027541dc821f04c754ff7nd * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
04891cf70e0bfc38bfb027541dc821f04c754ff7nd * See the License for the specific language governing permissions and
04891cf70e0bfc38bfb027541dc821f04c754ff7nd * limitations under the License.
3568de757bac0b47256647504c186d17ca272f85rbb/* Status Module. Display lots of internal data about how Apache is
3568de757bac0b47256647504c186d17ca272f85rbb * performing and the state of all children processes.
3568de757bac0b47256647504c186d17ca272f85rbb * To enable this, add the following lines into any config file:
3568de757bac0b47256647504c186d17ca272f85rbb * <Location /server-status>
3568de757bac0b47256647504c186d17ca272f85rbb * SetHandler server-status
3568de757bac0b47256647504c186d17ca272f85rbb * </Location>
3568de757bac0b47256647504c186d17ca272f85rbb * You may want to protect this location by password or domain so no one
3568de757bac0b47256647504c186d17ca272f85rbb * else can look at it. Then you can access the statistics with a URL like:
3568de757bac0b47256647504c186d17ca272f85rbb * /server-status - Returns page using tables
3568de757bac0b47256647504c186d17ca272f85rbb * /server-status?notable - Returns page for browsers without table support
3568de757bac0b47256647504c186d17ca272f85rbb * /server-status?refresh - Returns page with 1 second refresh
3568de757bac0b47256647504c186d17ca272f85rbb * /server-status?refresh=6 - Returns page with refresh every 6 seconds
3568de757bac0b47256647504c186d17ca272f85rbb * /server-status?auto - Returns page with data for automatic parsing
3568de757bac0b47256647504c186d17ca272f85rbb * Mark Cox, mark@ukweb.com, November 1995
3568de757bac0b47256647504c186d17ca272f85rbb * 12.11.95 Initial version for www.telescope.org
3568de757bac0b47256647504c186d17ca272f85rbb * 13.3.96 Updated to remove rprintf's [Mark]
3568de757bac0b47256647504c186d17ca272f85rbb * 18.3.96 Added CPU usage, process information, and tidied [Ben Laurie]
3568de757bac0b47256647504c186d17ca272f85rbb * 18.3.96 Make extra Scoreboard variables #definable
3568de757bac0b47256647504c186d17ca272f85rbb * 25.3.96 Make short report have full precision [Ben Laurie suggested]
3568de757bac0b47256647504c186d17ca272f85rbb * 25.3.96 Show uptime better [Mark/Ben Laurie]
3568de757bac0b47256647504c186d17ca272f85rbb * 29.3.96 Better HTML and explanation [Mark/Rob Hartill suggested]
3568de757bac0b47256647504c186d17ca272f85rbb * 09.4.96 Added message for non-STATUS compiled version
3568de757bac0b47256647504c186d17ca272f85rbb * 18.4.96 Added per child and per slot counters [Jim Jagielski]
3568de757bac0b47256647504c186d17ca272f85rbb * 01.5.96 Table format, cleanup, even more spiffy data [Chuck Murcko/Jim J.]
3568de757bac0b47256647504c186d17ca272f85rbb * 18.5.96 Adapted to use new rprintf() routine, incidentally fixing a missing
3568de757bac0b47256647504c186d17ca272f85rbb * piece in short reports [Ben Laurie]
3568de757bac0b47256647504c186d17ca272f85rbb * 21.5.96 Additional Status codes (DNS and LOGGING only enabled if
3568de757bac0b47256647504c186d17ca272f85rbb * extended STATUS is enabled) [George Burgyan/Jim J.]
3568de757bac0b47256647504c186d17ca272f85rbb * 10.8.98 Allow for extended status info at runtime (no more STATUS)
3568de757bac0b47256647504c186d17ca272f85rbb * [Jim J.]
0f081398cf0eef8cc7c66a535d450110a92dc8aefielding#define DEFAULT_TIME_FORMAT "%A, %d-%b-%Y %H:%M:%S %Z"
98fb535f829e2a95aabd82420931f476661fa8e3jorton/* Implement 'ap_run_status_hook'. */
f0e395a55abfcad3d2bd7c63470003b08a93d567ndAPR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ap, STATUS, int, status_hook,
7cd5419264796cfeaf8215383cf0f89130a81fectrawick/* ugh... need to know if we're running with a pthread implementation
7cd5419264796cfeaf8215383cf0f89130a81fectrawick * such as linuxthreads that treats individual threads as distinct
7cd5419264796cfeaf8215383cf0f89130a81fectrawick * processes; that affects how we add up CPU time in a process
3568de757bac0b47256647504c186d17ca272f85rbb/* Format the number of bytes nicely */
41634f717c623556a16b27b25d7d909a66fe20f8wrowestatic void format_byte_out(request_rec *r, apr_off_t bytes)
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, "%.1f kB", (float) bytes / KBYTE);
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, "%.1f MB", (float) bytes / MBYTE);
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, "%.1f GB", (float) bytes / GBYTE);
41634f717c623556a16b27b25d7d909a66fe20f8wrowestatic void format_kbyte_out(request_rec *r, apr_off_t kbytes)
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, "%.1f MB", (float) kbytes / KBYTE);
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, "%.1f GB", (float) kbytes / MBYTE);
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantzstatic void show_time(request_rec *r, apr_interval_time_t tsecs)
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, " %d day%s", days, days == 1 ? "" : "s");
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, " %d hour%s", hrs, hrs == 1 ? "" : "s");
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, " %d minute%s", mins, mins == 1 ? "" : "s");
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz ap_rprintf(r, " %d second%s", secs, secs == 1 ? "" : "s");
3568de757bac0b47256647504c186d17ca272f85rbb/* Main handler for x-httpd-status requests */
3568de757bac0b47256647504c186d17ca272f85rbb/* ID values for command table */
3568de757bac0b47256647504c186d17ca272f85rbb const char *form_data_str;
3568de757bac0b47256647504c186d17ca272f85rbb const char *hdr_out_str;
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantzstatic const struct stat_opt status_options[] = /* see #defines above */
397df70abe0bdd78a84fb6c38c02641bcfeadceasf const char *loc;
78ae889ffe0fdfab72f56c6993b0f302cb48da55rbb unsigned long count;
d90b36a9e6f6ea9a583694f4db5e5edd54a750b3minfrin if (strcmp(r->handler, STATUS_MAGIC_TYPE) && strcmp(r->handler,
d90b36a9e6f6ea9a583694f4db5e5edd54a750b3minfrin "server-status")) {
6653a33e820463abd4f81915b7a1eba0f602e200brianp pid_buffer = apr_palloc(r->pool, server_limit * sizeof(pid_t));
6653a33e820463abd4f81915b7a1eba0f602e200brianp stat_buffer = apr_palloc(r->pool, server_limit * thread_limit * sizeof(char));
3568de757bac0b47256647504c186d17ca272f85rbb "Server status unavailable in inetd mode");
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb ap_set_content_type(r, "text/html; charset=ISO-8859-1");
0f081398cf0eef8cc7c66a535d450110a92dc8aefielding * Simple table-driven form data set parser that lets you alter the header
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz apr_size_t len = strlen(status_options[i].form_data_str);
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard ap_set_content_type(r, "text/plain; charset=ISO-8859-1");
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard for (i = 0; i < server_limit; ++i) {
3568de757bac0b47256647504c186d17ca272f85rbb clock_t proc_tu = 0, proc_ts = 0, proc_tcu = 0, proc_tcs = 0;
7cd5419264796cfeaf8215383cf0f89130a81fectrawick for (j = 0; j < thread_limit; ++j) {
98cd3186185bb28ae6c95a3f159899fcf56a663ftrawick ws_record = ap_get_scoreboard_worker_from_indexes(i, j);
3cbd177a6c885562f9ad0cf11695f044489c881dgregames /* XXX what about the counters for quiescing/seg faulted
dd028aa8111afb6534fece555e8c2d408894671etrawick * processes? should they be counted or not? GLA
5a0f707b48da7703cbe6bc087f13a6735b1c742dgregames if (lres != 0 || (res != SERVER_READY && res != SERVER_DEAD)) {
7cd5419264796cfeaf8215383cf0f89130a81fectrawick#endif /* HAVE_TIMES */
7cd5419264796cfeaf8215383cf0f89130a81fectrawick /* up_time in seconds */
64c351fd973428b5bb4c28e983fa86875ea4e60fdougm "<html><head>\n<title>Apache Status</title>\n</head><body>\n",
74fd6d9aeadb9022086259c5c1ae00bc0dda9c9astoddard ap_rvputs(r, ap_get_server_name(r), "</h1>\n\n", NULL);
3568de757bac0b47256647504c186d17ca272f85rbb ap_get_server_built(), "\n</dt></dl><hr /><dl>\n", NULL);
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard ap_ht_time(r->pool, nowtime, DEFAULT_TIME_FORMAT, 0),
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard ap_rprintf(r, "<dt>Parent Server Generation: %d</dt>\n",
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard ap_rprintf(r, "Total Accesses: %lu\nTotal kBytes: %"
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard /* Allow for OS/2 not having CPU stats */
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard else { /* !short_report */
663237d6bcc59ac0997d71d48a1baa55fa29a3d8jim ap_rprintf(r, "<dt>Total accesses: %lu - Total Traffic: ", count);
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard /* Allow for OS/2 not having CPU stats */
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard format_byte_out(r, (unsigned long)(KBYTE * (float) kbcount
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard / (float) up_time));
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh if (count > 0) {
3568de757bac0b47256647504c186d17ca272f85rbb format_byte_out(r, (unsigned long)(KBYTE * (float) kbcount
3568de757bac0b47256647504c186d17ca272f85rbb / (float) count));
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz } /* short_report */
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard } /* ap_extended_status */
3568de757bac0b47256647504c186d17ca272f85rbb ap_rprintf(r, "<dt>%d requests currently being processed, "
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard ap_rprintf(r, "BusyWorkers: %d\nIdleWorkers: %d\n", busy, ready);
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard /* send the scoreboard 'table' out */
3568de757bac0b47256647504c186d17ca272f85rbb for (i = 0; i < server_limit; ++i) {
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz for (j = 0; j < thread_limit; ++j) {
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard if ((indx % STATUS_MAXLINE == (STATUS_MAXLINE - 1))
cd8f8c995d415473f3bfb0b329b2450f2a722c3atrawick ap_rputs("\"<b><code>_</code></b>\" Waiting for Connection, \n", r);
d69e1ed15b5db3d832c1f6c8c403ef397248857atrawick ap_rputs("\"<b><code>S</code></b>\" Starting up, \n", r);
d69e1ed15b5db3d832c1f6c8c403ef397248857atrawick ap_rputs("\"<b><code>R</code></b>\" Reading Request,<br />\n", r);
d69e1ed15b5db3d832c1f6c8c403ef397248857atrawick ap_rputs("\"<b><code>W</code></b>\" Sending Reply, \n", r);
d69e1ed15b5db3d832c1f6c8c403ef397248857atrawick ap_rputs("\"<b><code>K</code></b>\" Keepalive (read), \n", r);
d69e1ed15b5db3d832c1f6c8c403ef397248857atrawick ap_rputs("\"<b><code>D</code></b>\" DNS Lookup,<br />\n", r);
d69e1ed15b5db3d832c1f6c8c403ef397248857atrawick ap_rputs("\"<b><code>C</code></b>\" Closing connection, \n", r);
d69e1ed15b5db3d832c1f6c8c403ef397248857atrawick ap_rputs("\"<b><code>L</code></b>\" Logging, \n", r);
beb70d51e435dc36c56a72b6cd83556c04db9283wrowe ap_rputs("\"<b><code>G</code></b>\" Gracefully finishing,<br /> \n", r);
fe6baec9bbcd36f932b71a355120cd7b5a685d6cfielding ap_rputs("\"<b><code>I</code></b>\" Idle cleanup of worker, \n", r);
3568de757bac0b47256647504c186d17ca272f85rbb ap_rputs("\"<b><code>.</code></b>\" Open slot with no current process</p>\n", r);
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard for (i = 0; i < server_limit; ++i) {
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard for (j = 0; j < thread_limit; ++j) {
397df70abe0bdd78a84fb6c38c02641bcfeadceasf if (++k >= 3) {
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard "<th>Srv</th><th>PID</th><th>Acc</th>"
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard "<th>M</th>"
3568de757bac0b47256647504c186d17ca272f85rbb "<th>CPU\n</th>"
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz "<th>SS</th><th>Req</th>"
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard "<th>Conn</th><th>Child</th><th>Slot</th>"
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard "<th>Client</th><th>VHost</th>"
c0659e61002e9d6ff77b2dca72540e0af1b2ca64stoddard "<th>Request</th></tr>\n\n", r);
3568de757bac0b47256647504c186d17ca272f85rbb for (i = 0; i < server_limit; ++i) {
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick for (j = 0; j < thread_limit; ++j) {
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick ws_record = ap_get_scoreboard_worker_from_indexes(i, j);
3568de757bac0b47256647504c186d17ca272f85rbb if (ws_record->pid) { /* MPM sets per-worker pid and generation */
64c351fd973428b5bb4c28e983fa86875ea4e60fdougm "<b>Server %d-%d</b> (-): %d|%lu|%lu [",
36c8049de63c446926139936c3d195330a0539cetrawick "<b>Server %d-%d</b> (%"
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "u%g s%g cu%g cs%g"
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "\n %ld %ld (",
64c351fd973428b5bb4c28e983fa86875ea4e60fdougm " <i>%s {%s}</i> <b>[%s]</b><br />\n\n",
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick else { /* !no_table_report */
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "<tr><td><b>%d-%d</b></td><td>-</td><td>%d/%lu/%lu",
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "<tr><td><b>%d-%d</b></td><td>%"
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "</td><td>%d/%lu/%lu",
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "<td>%.2f</td>"
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "<td>%ld</td><td>%ld",
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick ap_rprintf(r, "</td><td>%-1.1f</td><td>%-2.2f</td><td>%-2.2f\n",
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick (float)conn_bytes / KBYTE, (float) my_bytes / MBYTE,
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick "<td nowrap>%s</td></tr>\n\n",
72b6f1cf3e616473e1c26464b3193b13c2c09e87brianp } /* no_table_report */
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick } /* for (j...) */
e8f95a682820a599fe41b22977010636be5c2717jim } /* for (i...) */
44d2e75323651320b480d8bc2f098448a08de4fcwrowe<tr><th>Srv</th><td>Child Server number - generation</td></tr>\n \
44d2e75323651320b480d8bc2f098448a08de4fcwrowe<tr><th>PID</th><td>OS process ID</td></tr>\n \
44d2e75323651320b480d8bc2f098448a08de4fcwrowe<tr><th>Acc</th><td>Number of accesses this connection / this child / this slot</td></tr>\n \
44d2e75323651320b480d8bc2f098448a08de4fcwrowe<tr><th>M</th><td>Mode of operation</td></tr>\n"
44d2e75323651320b480d8bc2f098448a08de4fcwrowe"<tr><th>CPU</th><td>CPU usage, number of seconds</td></tr>\n"
2e7f1d7da527c09e717251e186deffe55e6fbd0ftrawick"<tr><th>SS</th><td>Seconds since beginning of most recent request</td></tr>\n \
2e7f1d7da527c09e717251e186deffe55e6fbd0ftrawick<tr><th>Req</th><td>Milliseconds required to process most recent request</td></tr>\n \
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz<tr><th>Conn</th><td>Kilobytes transferred this connection</td></tr>\n \
8bfe865d8d61be4ba4a89e45427a3c4211ebabdctrawick<tr><th>Child</th><td>Megabytes transferred this child</td></tr>\n \
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantz<tr><th>Slot</th><td>Total megabytes transferred this slot</td></tr>\n \
1ec8bd0373f11c07688ec9afbbf778cf78a0bc52wrowe</table>\n", r);
1ec8bd0373f11c07688ec9afbbf778cf78a0bc52wrowe } /* if (ap_extended_status && !short_report) */
f886987cd0bd4220c14043c4d9be77ec22902e73trawick ap_rputs("<hr />To obtain a full report with current status "
f886987cd0bd4220c14043c4d9be77ec22902e73trawick "information you need to use the "
f886987cd0bd4220c14043c4d9be77ec22902e73trawick "<code>ExtendedStatus On</code> directive.\n", r);
1ec8bd0373f11c07688ec9afbbf778cf78a0bc52wrowe /* Run extension hooks to insert extra content. */
e8f95a682820a599fe41b22977010636be5c2717jimstatic int status_pre_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp)
98fb535f829e2a95aabd82420931f476661fa8e3jorton /* When mod_status is loaded, default our ExtendedStatus to 'on'
98fb535f829e2a95aabd82420931f476661fa8e3jorton * other modules which prefer verbose scoreboards may play a similar game.
e8f95a682820a599fe41b22977010636be5c2717jim * If left to their own requirements, mpm modules can make do with simple
98fb535f829e2a95aabd82420931f476661fa8e3jorton * scoreboard entries.
3568de757bac0b47256647504c186d17ca272f85rbbstatic int status_init(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp,
0f081398cf0eef8cc7c66a535d450110a92dc8aefielding status_flags[SERVER_DEAD] = '.'; /* We don't want to assume these are in */
0f081398cf0eef8cc7c66a535d450110a92dc8aefielding status_flags[SERVER_READY] = '_'; /* any particular order in scoreboard.h */
0cb6873985efbf0cc9644114925df6baa4b32d5awrowe ap_mpm_query(AP_MPMQ_HARD_LIMIT_THREADS, &thread_limit);
3568de757bac0b47256647504c186d17ca272f85rbb ap_mpm_query(AP_MPMQ_HARD_LIMIT_DAEMONS, &server_limit);
28c170ac8e99644de58cad454c6e0f9b4b359be6jerenkrantzstatic void status_child_init(apr_pool_t *p, server_rec *s)
3568de757bac0b47256647504c186d17ca272f85rbb ap_hook_handler(status_handler, NULL, NULL, APR_HOOK_MIDDLE);
ce03576b2434cec77f2921db9d5b6a0510581c23rederpj ap_hook_pre_config(status_pre_config, NULL, NULL, APR_HOOK_LAST);
397df70abe0bdd78a84fb6c38c02641bcfeadceasf ap_hook_post_config(status_init, NULL, NULL, APR_HOOK_MIDDLE);