You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by ia...@apache.org on 2002/09/28 06:18:35 UTC
cvs commit: httpd-2.0/modules/loggers mod_logio.c config.m4
ianh 2002/09/27 21:18:35
Modified: . CHANGES
docs/conf httpd-std.conf.in httpd-win.conf
docs/manual/mod mod_log_config.html.en mod_log_config.xml
modules/loggers config.m4
Added: docs/manual/mod mod_logio.xml
modules/loggers mod_logio.c
Log:
New Module -- mod_logio.
This adds the ability to log the bytes sent and
received for each request
Submitted by: Bojan Smojver <bo...@rexursive.com>
Reviewed by: Justin & Ian
Revision Changes Path
1.940 +3 -0 httpd-2.0/CHANGES
Index: CHANGES
===================================================================
RCS file: /home/cvs/httpd-2.0/CHANGES,v
retrieving revision 1.939
retrieving revision 1.940
diff -u -r1.939 -r1.940
--- CHANGES 27 Sep 2002 23:53:04 -0000 1.939
+++ CHANGES 28 Sep 2002 04:18:34 -0000 1.940
@@ -1,5 +1,8 @@
Changes with Apache 2.0.43
+ *) New Module: mod_logio. adds the ability to log bytes sent and
+ received. [Bojan Smojver <bo...@rexursive.com>]
+
*) SuExec needs to use the same default directory as the rest of
server, namely /usr/local/apache2.
[SangBeom han <sb...@os.korea.ac.kr>]
1.23 +3 -0 httpd-2.0/docs/conf/httpd-std.conf.in
Index: httpd-std.conf.in
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/conf/httpd-std.conf.in,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- httpd-std.conf.in 16 Sep 2002 16:57:04 -0000 1.22
+++ httpd-std.conf.in 28 Sep 2002 04:18:35 -0000 1.23
@@ -479,6 +479,9 @@
LogFormat "%{Referer}i -> %U" referer
LogFormat "%{User-agent}i" agent
+# You need to enable mod_logio.c to use %I and %O
+#LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio
+
#
# The location and format of the access logfile (Common Logfile Format).
# If you do not define any access logfiles within a <VirtualHost>
1.70 +3 -0 httpd-2.0/docs/conf/httpd-win.conf
Index: httpd-win.conf
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/conf/httpd-win.conf,v
retrieving revision 1.69
retrieving revision 1.70
diff -u -r1.69 -r1.70
--- httpd-win.conf 16 Sep 2002 16:57:04 -0000 1.69
+++ httpd-win.conf 28 Sep 2002 04:18:35 -0000 1.70
@@ -406,6 +406,9 @@
LogFormat "%{Referer}i -> %U" referer
LogFormat "%{User-agent}i" agent
+# You need to enable mod_logio.c to use %I and %O
+#LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio
+
#
# The location and format of the access logfile (Common Logfile Format).
# If you do not define any access logfiles within a <VirtualHost>
1.15 +11 -1 httpd-2.0/docs/manual/mod/mod_log_config.html.en
Index: mod_log_config.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_log_config.html.en,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- mod_log_config.html.en 10 Sep 2002 01:55:53 -0000 1.14
+++ mod_log_config.html.en 28 Sep 2002 04:18:35 -0000 1.15
@@ -138,6 +138,16 @@
this conflicted with the historical ssl %...{var}c syntax.)</div>
</td></tr>
+<tr><td>%...I:</td>
+<td>Bytes received, including request and headers, cannot be zero. You need to
+enable <code class="module"><a
+href="../mod/mod_logio.html">mod_logio</a></code> to use this.</td></tr>
+
+<tr><td>%...O:</td>
+<td>Bytes sent, including headers, cannot be zero. You need to enable <code
+class="module"><a href="../mod/mod_logio.html">mod_logio</a></code> to use
+this.</td></tr>
+
</table>
<p>The "..." can be nothing at all (<em>e.g.</em>, <code>"%h %u
@@ -352,4 +362,4 @@
TransferLog logs/access_log
</code></p></div>
-</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>
\ No newline at end of file
+</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>
1.10 +8 -0 httpd-2.0/docs/manual/mod/mod_log_config.xml
Index: mod_log_config.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_log_config.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- mod_log_config.xml 27 Aug 2002 17:15:45 -0000 1.9
+++ mod_log_config.xml 28 Sep 2002 04:18:35 -0000 1.10
@@ -143,6 +143,14 @@
this conflicted with the historical ssl %...{var}c syntax.)</note>
</td></tr>
+<tr><td>%...I:</td>
+<td>Bytes received, including request and headers, cannot be zero. You need to
+enable <module>mod_logio</module> to use this.</td></tr>
+
+<tr><td>%...O:</td>
+<td>Bytes sent, including headers, cannot be zero. You need to enable
+<module>mod_logio</module> to use this.</td></tr>
+
</table>
<p>The "..." can be nothing at all (<em>e.g.</em>, <code>"%h %u
1.1 httpd-2.0/docs/manual/mod/mod_logio.xml
Index: mod_logio.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<modulesynopsis>
<name>mod_logio</name>
<description>Logging of input and output bytes per request</description>
<status>Base</status>
<sourcefile>mod_logio.c</sourcefile>
<identifier>logio_module</identifier>
<summary>
<p>This module provides the logging of input and output number of
bytes received/sent per request. The numbers reflect the actual bytes
as received on the network, which then takes into account the
headers and bodies of requests and responses. The counting is done
before SSL/TLS on input and after SSL/TLS on output, so the numbers
will correctly reflect any changes made by encryption.</p>
<p>This module requires <module>mod_log_config</module>.</p>
</summary>
<seealso><a href="../logs.html">Apache Log Files</a></seealso>
<section id="formats">
<title>Custom Log Formats</title>
<p>This modules adds two new logging directives. The characteristics of the
request itself are logged by placing "%" directives in the format string,
which are replaced in the log file by the values as follows:</p>
<table>
<tr><td>%...I:</td>
<td>Bytes received, including request and headers, cannot be zero.</td></tr>
<tr><td>%...O:</td>
<td>Bytes sent, including headers, cannot be zero.</td></tr>
</table>
<p>Usually, the functionality is used like this:</p>
<dl>
<dt>Combined I/O log format:</dt>
<dd><code>"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\"
\"%{User-agent}i\" %I %O"</code></dd>
</dl>
</section>
</modulesynopsis>
1.5 +2 -0 httpd-2.0/modules/loggers/config.m4
Index: config.m4
===================================================================
RCS file: /home/cvs/httpd-2.0/modules/loggers/config.m4,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- config.m4 16 Feb 2001 13:38:25 -0000 1.4
+++ config.m4 28 Sep 2002 04:18:35 -0000 1.5
@@ -6,4 +6,6 @@
APACHE_MODULE(log_config, logging configuration, , , yes)
+APACHE_MODULE(logio, input and output logging, , , no)
+
APACHE_MODPATH_FINISH
1.1 httpd-2.0/modules/loggers/mod_logio.c
Index: mod_logio.c
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* Portions of this software are based upon public domain software
* originally written at the National Center for Supercomputing Applications,
* University of Illinois, Urbana-Champaign.
*/
/*
* Written by Bojan Smojver <bo...@rexursive.com>:
*
* The argument to LogFormat and CustomLog is a string, which can include
* literal characters copied into the log files, and '%' directives as
* follows:
*
* %...I: bytes received, including request and headers, cannot be zero
* %...O: bytes sent, including headers, cannot be zero
*
*/
#include "apr_strings.h"
#include "apr_lib.h"
#include "apr_hash.h"
#include "apr_optional.h"
#define APR_WANT_STRFUNC
#include "apr_want.h"
#include "ap_config.h"
#include "mod_log_config.h"
#include "httpd.h"
#include "http_config.h"
#include "http_protocol.h"
module AP_MODULE_DECLARE_DATA logio_module;
static const char logio_filter_name[] = "LOG_INPUT_OUTPUT";
/*
* Logging of input and output config...
*/
typedef struct logio_config_t {
apr_off_t bytes_in;
apr_off_t bytes_out;
} logio_config_t;
/*
* Format items...
*/
static const char *log_bytes_in(request_rec *r, char *a)
{
logio_config_t *cf = ap_get_module_config(r->connection->conn_config,
&logio_module);
return apr_off_t_toa(r->pool, cf->bytes_in);
}
static const char *log_bytes_out(request_rec *r, char *a)
{
logio_config_t *cf = ap_get_module_config(r->connection->conn_config,
&logio_module);
return apr_off_t_toa(r->pool, cf->bytes_out);
}
/*
* Reset counters after logging...
*/
static int logio_transaction(request_rec *r)
{
logio_config_t *cf = ap_get_module_config(r->connection->conn_config,
&logio_module);
cf->bytes_in = cf->bytes_out = 0;
return OK;
}
/*
* Logging of input and output filters...
*/
static apr_status_t logio_out_filter(ap_filter_t *f,
apr_bucket_brigade *bb) {
apr_off_t length;
logio_config_t *cf = ap_get_module_config(f->c->conn_config, &logio_module);
if (!cf) { /* Create config */
cf = apr_pcalloc(f->c->pool, sizeof(*cf));
ap_set_module_config(f->c->conn_config, &logio_module, cf);
}
apr_brigade_length (bb, 0, &length);
if (length > 0)
cf->bytes_out += length;
return ap_pass_brigade(f->next, bb);
}
static apr_status_t logio_in_filter(ap_filter_t *f,
apr_bucket_brigade *bb,
ap_input_mode_t mode,
apr_read_type_e block,
apr_off_t readbytes) {
apr_off_t length;
apr_status_t status;
logio_config_t *cf = ap_get_module_config(f->c->conn_config, &logio_module);
status = ap_get_brigade(f->next, bb, mode, block, readbytes);
if (!cf) { /* Create config */
cf = apr_pcalloc(f->c->pool, sizeof(*cf));
ap_set_module_config(f->c->conn_config, &logio_module, cf);
}
apr_brigade_length (bb, 0, &length);
if (length > 0)
cf->bytes_in += length;
return status;
}
/*
* The hooks...
*/
static int logio_pre_conn(conn_rec *c) {
ap_add_input_filter(logio_filter_name, NULL, NULL, c);
ap_add_output_filter(logio_filter_name, NULL, NULL, c);
return OK;
}
static int logio_pre_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp)
{
static APR_OPTIONAL_FN_TYPE(ap_register_log_handler) *log_pfn_register;
log_pfn_register = APR_RETRIEVE_OPTIONAL_FN(ap_register_log_handler);
if (log_pfn_register) {
log_pfn_register(p, "I", log_bytes_in, 0);
log_pfn_register(p, "O", log_bytes_out, 0);
}
return OK;
}
static void register_hooks(apr_pool_t *p)
{
static const char *pre[] = { "mod_log_config.c", NULL };
ap_hook_pre_connection(logio_pre_conn, NULL, NULL, APR_HOOK_MIDDLE);
ap_hook_pre_config(logio_pre_config, NULL, NULL, APR_HOOK_REALLY_FIRST);
ap_hook_log_transaction(logio_transaction, pre, NULL, APR_HOOK_MIDDLE);
ap_register_input_filter(logio_filter_name, logio_in_filter, NULL,
AP_FTYPE_NETWORK - 1);
ap_register_output_filter(logio_filter_name, logio_out_filter, NULL,
AP_FTYPE_NETWORK - 1);
}
module AP_MODULE_DECLARE_DATA logio_module =
{
STANDARD20_MODULE_STUFF,
NULL, /* create per-dir config */
NULL, /* merge per-dir config */
NULL, /* server config */
NULL, /* merge server config */
NULL, /* command apr_table_t */
register_hooks /* register hooks */
};