This module provides for forensic logging of client requests.
Create the log file using the
Logging is done before and after processing a request, so the forensic log contains two log lines for each request. The forensic logger is very strict, which means:
The check_forensic
script, which can be found in the
distribution's support directory, processes the resulting log file
to identify the requests that didn't complete.
Each request is logged two times. The first time is before it's processed further (that is, after receiving the headers). The second log entry is written after the request processing at the same time where normal logging occurs.
In order to identify each request, a unique request ID is assigned.
This forensic ID can be cross logged in the normal transfer log using the
%{forensic-id}n
format string. If you're using
The first line logs the forensic ID, the request line and all received
headers, separated by pipe characters (|
). A sample line
looks like the following (all on one line):
The plus character at the beginning indicates that this is the first log line of this request. The second line just contains a minus character and the ID again:
The check_forensic
script takes as its argument the name
of the logfile. It looks for those +
/-
ID pairs
and complains if a request was not completed.
See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server.
The log files may contain sensitive data such as the contents of
Authorization:
headers (which can contain passwords), so
they should not be readable by anyone except the user that starts the
server.
The forensic-id
, which can be added to the transfer log
using the %{forensic-id}n
format string.
The argument, which specifies the location to which the logs will be written, can take one of the following two types of values:
|
", followed by the path
to a program to receive the log information on its standard
input. The program name can be specified relative to the If a program is used, then it will be run as the user who
started
When entering a file path on non-Unix platforms, care should be taken to make sure that only forward slashes are used even though the platform may allow the use of back slashes. In general it is a good idea to always use forward slashes throughout the configuration files.