doc/log.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % common SYSTEM "common/common.ent">
   5      %common;
   6 ]>
   7 <!-- $Id: log.xml,v 1.9 2007-05-09 21:23:08 adam Exp $ -->
   8 <refentry id="ref-log">
   9  <refmeta>
  10   <refentrytitle>log</refentrytitle>
  11   <manvolnum>3mp</manvolnum>
  12    <refmiscinfo>Metaproxy Module</refmiscinfo>
  13 </refmeta>
  14
  15  <refnamediv>
  16   <refname>log</refname>
  17   <refpurpose>Metaproxy Package Logging Module</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    This filter logs packages sent - and received .
  23   </para>
  24
  25   <para>
  26    Configurable values:
  27    <variablelist>
  28     <varlistentry><term>message</term>
  29      <listitem>
  30       <para>
  31        Specifies a custom message for the log message.
  32       </para>
  33      </listitem>
  34     </varlistentry>
  35     <varlistentry><term>filename</term>
  36      <listitem>
  37       <para>
  38        Specifies a name of file that log messages is written to.
  39       </para>
  40      </listitem>
  41     </varlistentry>
  42     <varlistentry><term>category</term>
  43      <listitem>
  44       <para>
  45        Specifies the category of messages to be logged. The category is an
  46        XML attribute and value of attribute is a boolean;
  47        <literal>true</literal> for enabled; <literal>false</literal>
  48        for disabled.
  49        The following category attributes are supported:
  50
  51    <variablelist>
  52     <varlistentry><term>access</term>
  53      <listitem>
  54       <para>
  55        One line log messages inspired by Apache access log entries.
  56        This is a brief message stating the request and response.
  57        This is enabled by default. All other categories are disabled by
  58        default.
  59       </para>
  60      </listitem>
  61     </varlistentry>
  62     <varlistentry><term>request-apdu</term>
  63      <listitem>
  64       <para>
  65        Z39.50 Request APDU.
  66       </para>
  67      </listitem>
  68     </varlistentry>
  69     <varlistentry><term>response-apdu</term>
  70      <listitem>
  71       <para>
  72        Z39.50 Response APDU.
  73       </para>
  74      </listitem>
  75     </varlistentry>
  76     <varlistentry><term>apdu</term>
  77      <listitem>
  78       <para>
  79        Z39.50 APDU (request and response)
  80       </para>
  81      </listitem>
  82     </varlistentry>
  83     <varlistentry><term>request-session</term>
  84      <listitem>
  85       <para>
  86        Request session.
  87       </para>
  88      </listitem>
  89     </varlistentry>
  90     <varlistentry><term>response-session</term>
  91      <listitem>
  92       <para>
  93        Response session.
  94       </para>
  95      </listitem>
  96     </varlistentry>
  97     <varlistentry><term>session</term>
  98      <listitem>
  99       <para>
 100        Session (request and response)
 101       </para>
 102      </listitem>
 103     </varlistentry>
 104     <varlistentry><term>init-options</term>
 105      <listitem>
 106       <para>
 107        Z39.50 Init Request options
 108       </para>
 109      </listitem>
 110     </varlistentry>
 111    </variablelist>
 112
 113
 114       </para>
 115      </listitem>
 116     </varlistentry>
 117    </variablelist>
 118   </para>
 119  </refsect1>
 120
 121  <refsect1><title>EXAMPLES</title>
 122   <para>
 123    A typical configuration looks like this:
 124    <screen><![CDATA[
 125     <filter type="log">
 126      <message>B</message>
 127      <category access="true"/>
 128      <filename>logs/metaproxy.log</filename>
 129     </filter>
 130 ]]>
 131    </screen>
 132   </para>
 133  </refsect1>
 134
 135  <refsect1><title>SEE ALSO</title>
 136   <para>
 137    <citerefentry>
 138     <refentrytitle>metaproxy</refentrytitle>
 139     <manvolnum>1</manvolnum>
 140    </citerefentry>
 141   </para>
 142  </refsect1>
 143
 144  &copyright;
 145 </refentry>
 146
 147 <!-- Keep this comment at the end of the file
 148 Local variables:
 149 mode: sgml
 150 sgml-omittag:t
 151 sgml-shorttag:t
 152 sgml-minimize-attributes:nil
 153 sgml-always-quote-attributes:t
 154 sgml-indent-step:1
 155 sgml-indent-data:t
 156 sgml-parent-document:nil
 157 sgml-local-catalogs: nil
 158 sgml-namecase-general:t
 159 End:
 160 -->