granicus.if.org Git - apache/blob - docs/manual/mod/mod_dumpio.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_dumpio.xml.meta">
  24
  25 <name>mod_dumpio</name>
  26 <description>Dumps all I/O to error log as desired.</description>
  27 <status>Extension</status>
  28 <sourcefile>mod_dumpio.c</sourcefile>
  29 <identifier>dumpio_module</identifier>
  30
  31 <summary>
  32     <p><code>mod_dumpio</code> allows for the logging of
  33     all input received by Apache and/or all output sent by
  34     Apache to be logged (dumped) to the error.log file.
  35     </p>
  36
  37     <p>The data logging is done right after SSL decoding (for
  38     input) and right before SSL encoding (for output). As can
  39     be expected, this can produce extreme volumes of data,
  40     and should only be used when debugging problems.</p>
  41 </summary>
  42
  43 <section id="enable">
  44     <title>Enabling dumpio Support</title>
  45
  46     <p>To enable the module, it should be compiled and loaded
  47     in to your running Apache configuration. Logging can then
  48     be enabled or disabled separately for input and output via
  49     the below directives.  Additionally, <module>mod_dumpio</module>
  50     needs to be configured to <directive
  51     module="core">LogLevel</directive> <code>trace7</code>:
  52     </p>
  53     <highlight language="config">
  54       LogLevel dumpio:trace7
  55     </highlight>
  56 </section>
  57
  58 <directivesynopsis>
  59
  60 <name>DumpIOInput</name>
  61 <description>Dump all input data to the error log</description>
  62 <syntax>DumpIOInput On|Off</syntax>
  63 <default>DumpIOInput Off</default>
  64 <contextlist><context>server config</context></contextlist>
  65
  66 <usage>
  67     <p>Enable dumping of all input.</p>
  68
  69     <example><title>Example</title>
  70     <highlight language="config">
  71       DumpIOInput On
  72       </highlight>
  73     </example>
  74 </usage>
  75
  76 </directivesynopsis>
  77
  78 <directivesynopsis>
  79
  80 <name>DumpIOOutput</name>
  81 <description>Dump all output data to the error log</description>
  82 <syntax>DumpIOOutput On|Off</syntax>
  83 <default>DumpIOOutput Off</default>
  84 <contextlist><context>server config</context></contextlist>
  85
  86 <usage>
  87     <p>Enable dumping of all output.</p>
  88
  89     <example><title>Example</title>
  90     <highlight language="config">
  91       DumpIOOutput On
  92       </highlight>
  93     </example>
  94 </usage>
  95
  96 </directivesynopsis>
  97
  98 </modulesynopsis>