Mercurial > hg > nginx-site
view xml/ru/docs/http/ngx_http_log_module.xml @ 355:5d731825a6c2
Regenerated.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Wed, 25 Jan 2012 13:34:17 +0000 |
parents | a4fa80755eab |
children | bb51d3e17dd0 |
line wrap: on
line source
<?xml version="1.0"?> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Модуль ngx_http_log_module" link="/ru/docs/http/ngx_http_log_module.html" lang="ru"> <section id="summary"> <para> Модуль <literal>ngx_http_log_module</literal> записывает логи запросов в указанном формате. </para> </section> <section id="example" name="Пример конфигурации"> <para> <example> log_format gzip '$remote_addr - $remote_user [$time_local] ' '"$request" $status $bytes_sent ' '"$http_referer" "$http_user_agent" "$gzip_ratio"'; access_log /spool/logs/nginx-access.log gzip buffer=32k; </example> </para> </section> <section id="directives" name="Директивы"> <directive name="access_log"> <syntax> <value>путь</value> [<value>формат</value> [<literal>buffer</literal>=<value>размер</value>]]</syntax> <syntax><literal>off</literal></syntax> <default>log/access.log combined</default> <context>http</context> <context>server</context> <context>location</context> <context>if в location</context> <context>limit_except</context> <para> Задаёт путь, формат и размер буфера для буферизованной записи в лог. На одном уровне может использоваться несколько логов. Специальное значение <literal>off</literal> отменяет все директивы <literal>access_log</literal> для текущего уровня. Если формат не указан, то используется предопределённый формат “<literal>combined</literal>”. </para> <para> Размер буфера должен быть не больше размера атомарной записи в дисковый файл. Для FreeBSD 3.0-6.0 этот размер неограничен. </para> <para> В пути файла можно использовать переменные (0.7.6+), но такие логи имеют некоторые ограничения: <list type="bullet"> <listitem> <link doc="../ngx_core_module.xml" id="user">пользователь</link>, с правами которого работают рабочие процессы, должен иметь права на создание файлов в каталоге с такими логами; </listitem> <listitem> не работает буферизация; </listitem> <listitem> файл открывается для каждой записи в лог и сразу же после записи закрывается. Следует однако иметь в виду, что поскольку дескрипторы часто используемых файлов могут храниться в <link id="open_log_file_cache">кэше</link>, то при вращении логов в течение времени, заданного параметром <literal>valid</literal> директивы <link id="open_log_file_cache"/>, запись может продолжаться в старый файл. </listitem> <listitem> при каждой записи в лог проверяется существование <link doc="ngx_http_core_module.xml" id="root">корневого каталога</link> для запроса — если этот каталог не существует, то лог не создаётся. Поэтому <link doc="ngx_http_core_module.xml" id="root"/> и <literal>access_log</literal> нужно описывать на одном уровне: <example> server { root /spool/vhost/data/$host; access_log /spool/vhost/logs/$host; ... </example> </listitem> </list> </para> </directive> <directive name="log_format"> <syntax> <value>название</value> <value>строка</value> ...</syntax> <default>combined "..."</default> <context>http</context> <para> Задаёт формат лога. </para> <para> Кроме общих переменных в формате можно использовать переменные, существующие только на момент записи в лог: <list type="tag"> <tag-name><var>$body_bytes_sent</var></tag-name> <tag-desc> число байт, переданных клиенту, за вычетом заголовка ответа; переменная совместима с параметром “<literal>%B</literal>” модуля Apache <literal>mod_log_config</literal> </tag-desc> <tag-name><var>$bytes_sent</var></tag-name> <tag-desc> число байт, переданных клиенту </tag-desc> <tag-name><var>$connection</var></tag-name> <tag-desc> порядковый номер соединения </tag-desc> <tag-name><var>$msec</var></tag-name> <tag-desc> время в секундах с точностью до миллисекунд на момент записи в лог </tag-desc> <tag-name><var>$pipe</var></tag-name> <tag-desc> “<literal>p</literal>” если запрос был pipelined, иначе “<literal>.</literal>” </tag-desc> <tag-name><var>$request_length</var></tag-name> <tag-desc> длина запроса (включая строку запроса, заголовок и тело запроса) </tag-desc> <tag-name><var>$request_time</var></tag-name> <tag-desc> время обработки запроса в секундах с точностью до миллисекунд; время, прошедшее с момента чтения первых байт от клиента до момента отправки последних байт клиенту и записи в лог </tag-desc> <tag-name><var>$status</var></tag-name> <tag-desc> статус ответа </tag-desc> <tag-name><var>$time_iso8601</var></tag-name> <tag-desc> локальное время в формате по стандарту ISO 8601 </tag-desc> <tag-name><var>$time_local</var></tag-name> <tag-desc> локальное время в Common Log Format </tag-desc> </list> </para> <para> Строки заголовка, переданные клиенту, начинаются с префикса “<literal>sent_http_</literal>”, например, <var>$sent_http_content_range</var>. </para> <para> В конфигурации всегда существует предопределённый формат “<literal>combined</literal>”: <example> log_format combined '$remote_addr - $remote_user [$time_local] ' '"$request" $status $body_bytes_sent ' '"$http_referer" "$http_user_agent"'; </example> </para> </directive> <directive name="open_log_file_cache"> <syntax> <literal>max</literal>=<value>N</value> [<literal>inactive</literal>=<value>время</value>] [<literal>min_uses</literal>=<value>N</value>] [<literal>valid</literal>=<value>время</value>]</syntax> <syntax><literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> <context>location</context> <para> Задаёт кэш, в котором хранятся дескрипторы файлов часто используемых логов, имена которых заданы с использованием переменных. Параметры директивы: <list type="tag"> <tag-name><literal>max</literal></tag-name> <tag-desc> задаёт максимальное число дескрипторов в кэше; при переполнении кэша самые невостребованные (LRU) дескрипторы закрываются </tag-desc> <tag-name><literal>inactive</literal></tag-name> <tag-desc> задаёт время, после которого закэшированный дескриптор закрывается, если к нему не было обращений в течение этого времени; по умолчанию 10 секунд </tag-desc> <tag-name><literal>min_uses</literal></tag-name> <tag-desc> задаёт минимальное число использований файла в течение времени, заданного параметром <literal>inactive</literal>, после которого дескриптор файла будет оставаться открытым в кэше; по умолчанию 1 </tag-desc> <tag-name><literal>valid</literal></tag-name> <tag-desc> задаёт, через какое время нужно проверять, что файл ещё существует под тем же именем; по умолчанию 60 секунд </tag-desc> <tag-name><literal>off</literal></tag-name> <tag-desc> запрещает кэш </tag-desc> </list> </para> <para> Пример использования: <example> open_log_file_cache max=1000 inactive=20s valid=1m min_uses=2; </example> </para> </directive> </section> </module>