-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY copyright SYSTEM "copyright.xml">
<!ENTITY % idcommon SYSTEM "common/common.ent">
<manvolnum>3mp</manvolnum>
<refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
</refmeta>
-
+
<refnamediv>
<refname>log</refname>
<refpurpose>Metaproxy Package Logging Module</refpurpose>
</refnamediv>
-
+
<refsect1><title>DESCRIPTION</title>
<para>
- This filter logs packages sent - and received .
+ This filter logs packages sent - and received .
</para>
<para>
</para>
</listitem>
</varlistentry>
+ <varlistentry><term>time-format</term>
+ <listitem>
+ <para>
+ Date+time format if log is written to a custom file (see filename configuration, below), using the format of
+ <ulink
+ url="http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html">
+ strftime(3)</ulink>.
+ </para>
+ <para>
+ Use option -m in invocation of Metaproxy command to set format if yaz_log is used (no filename given).
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry><term>filename</term>
<listitem>
<para>
- Specifies a name of log file.
+ Specifies a name of log file. If this is omitted, logging is performed
+ using the log system of YAZ (yaz_log).
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Specifies the category of messages to be logged. The category is an
- XML attribute and value of attribute is a boolean;
+ XML attribute and value of attribute is a boolean;
<literal>true</literal> for enabled; <literal>false</literal>
for disabled.
The following category attributes are supported:
</para>
</listitem>
</varlistentry>
+ <varlistentry><term>line</term>
+ <listitem>
+ <para>
+ Simple one-line log message indicating the most important
+ things from a request and response.
+ Available from version 1.3.38 and later.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
-
+
</para>
</listitem>
</varlistentry>
<varlistentry><term>protocol (position 6)</term>
<listitem><para>
Protocol type which is one of <literal>Z3950</literal> or
- <literal>HTTP_Request</literal> or
+ <literal>HTTP_Request</literal> or
<literal>HTTP_Response</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
-
+
<para>
For packages of with protocol marker <literal>Z3950</literal>
the the access log line is followed by the APDU type + information
depending on the type. The APDU type is on position 7.
-
+
<variablelist>
-
+
<varlistentry><term>initRequest</term>
<listitem><para>
- Z39.50 Initialize Request with the information
+ Z39.50 Initialize Request with the information
username, vhost,
implementation ID, implementation name, implementation version.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>initResponse</term>
<listitem><para>
Z39.50 Initialize Response with the information:
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>searchRequest</term>
<listitem><para>
Z39.50 Search Request with the information:
database(s), result set ID, record syntax, query.
</para>
<para>
- Multiple databases are separated by
+ Multiple databases are separated by
a plus-sign (<literal>+</literal>). The query itself is
multiple tokens. For this reason it is placed as the last
information on this log entry.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>searchResponse</term>
<listitem><para>
Z39.50 Search Response with the information:
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>presentRequest</term>
<listitem><para>
Z39.50 Present Request with the information:
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>presentResponse</term>
<listitem><para>
Z39.50 Present Response with the information:
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>scanRequest</term>
<listitem><para>
Z39.50 Scan Request with the information:
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>scanResponse</term>
<listitem><para>
Z39.50 Scan Response with the information:
</para>
</listitem>
</varlistentry>
-
+
</variablelist>
</para>
-
+
</refsect1>
<refsect1><title>SCHEMA</title>
<literallayout><xi:include
- xi:href="../xml/schema/filter_log.rnc" xi:parse="text"
+ xi:href="../xml/schema/filter_log.rnc" xi:parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</literallayout>
</refsect1>
-
+
<refsect1><title>EXAMPLES</title>
<para>
A typical configuration looks like this:
]]>
</screen>
</para>
- </refsect1>
-
+ </refsect1>
+
<refsect1><title>SEE ALSO</title>
<para>
<citerefentry>
</citerefentry>
</para>
</refsect1>
-
+
©right;
</refentry>