You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2003/01/01 22:13:42 UTC
cvs commit: httpd-2.0/docs/manual/mod mod_deflate.xml
nd 2003/01/01 13:13:42
Modified: docs/manual/mod mod_deflate.xml
Log:
document DeflateFilterNote changes
Revision Changes Path
1.14 +31 -2 httpd-2.0/docs/manual/mod/mod_deflate.xml
Index: mod_deflate.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_deflate.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- mod_deflate.xml 22 Dec 2002 15:36:16 -0000 1.13
+++ mod_deflate.xml 1 Jan 2003 21:13:42 -0000 1.14
@@ -16,7 +16,7 @@
your server to be compressed before being sent to the client over
the network.</p>
</summary>
-<seealso><a href="../filter.html">The filter documentation</a></seealso>
+<seealso><a href="../filter.html">Filters</a></seealso>
<section id="recommended"><title>Recommended Configuration</title>
<p>This is a sample configuration for the impatient. But please take
@@ -190,9 +190,10 @@
<directivesynopsis>
<name>DeflateFilterNote</name>
<description>Places the compression ratio in a note for logging</description>
-<syntax>DeflateFilterNote <var>notename</var></syntax>
+<syntax>DeflateFilterNote [<var>type</var>] <var>notename</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
+<compatibility><var>type</var> is available since Apache 2.1</compatibility>
<usage>
<p>The <directive>DeflateFilterNote</directive> directive
@@ -206,6 +207,34 @@
DeflateFilterNote ratio<br />
<br />
LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate<br />
+ CustomLog logs/deflate_log deflate
+ </example>
+
+ <p>If you want to extract more accurate values from your logs, you
+ can use the <var>type</var> argument to specify the type of data
+ left as note for logging. <var>type</var> can be one of:</p>
+
+ <dl>
+ <dt><code>Input</code></dt>
+ <dd>Store the byte count of the filter's input stream in the note.</dd>
+
+ <dt><code>Output</code></dt>
+ <dd>Store the byte count of the filter's output stream in the note.</dd>
+
+ <dt><code>Ratio</code></dt>
+ <dd>Store the compression ratio (<code>output/input * 100</code>)
+ in the note. This is the default, if the <var>type</var> argument
+ is omitted.</dd>
+ </dl>
+
+ <p>Thus you may log it this way:</p>
+
+ <example><title>Accurate Logging</title>
+ DeflateFilterNote Input instream<br />
+ DeflateFilterNote Output outstream<br />
+ DeflateFilterNote Ratio ratio<br />
+ <br />
+ LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate<br />
CustomLog logs/deflate_log deflate
</example>
</usage>