comparison xml/ru/docs/http/ngx_http_log_module.xml @ 795:41363f013cc9

Documented the recently added "gzip" and "flush" parameters of the "access_log" directive.
author Valentin Bartenev <vbart@nginx.com>
date Tue, 25 Dec 2012 15:23:24 +0000
parents 32b8498cfb40
children ddd22f571529
comparison
equal deleted inserted replaced
794:e77512b1ce11 795:41363f013cc9
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Модуль ngx_http_log_module" 10 <module name="Модуль ngx_http_log_module"
11 link="/ru/docs/http/ngx_http_log_module.html" 11 link="/ru/docs/http/ngx_http_log_module.html"
12 lang="ru" 12 lang="ru"
13 rev="6"> 13 rev="7">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 Модуль <literal>ngx_http_log_module</literal> записывает логи запросов 18 Модуль <literal>ngx_http_log_module</literal> записывает логи запросов
32 32
33 <section id="example" name="Пример конфигурации"> 33 <section id="example" name="Пример конфигурации">
34 34
35 <para> 35 <para>
36 <example> 36 <example>
37 log_format gzip '$remote_addr - $remote_user [$time_local] ' 37 log_format compression '$remote_addr - $remote_user [$time_local] '
38 '"$request" $status $bytes_sent ' 38 '"$request" $status $bytes_sent '
39 '"$http_referer" "$http_user_agent" "$gzip_ratio"'; 39 '"$http_referer" "$http_user_agent" "$gzip_ratio"';
40 40
41 access_log /spool/logs/nginx-access.log gzip buffer=32k; 41 access_log /spool/logs/nginx-access.log compression buffer=32k;
42 </example> 42 </example>
43 </para> 43 </para>
44 44
45 </section> 45 </section>
46 46
49 49
50 <directive name="access_log"> 50 <directive name="access_log">
51 <syntax> 51 <syntax>
52 <value>путь</value> 52 <value>путь</value>
53 [<value>формат</value> 53 [<value>формат</value>
54 [<literal>buffer</literal>=<value>размер</value>]]</syntax> 54 [<literal>buffer</literal>=<value>размер</value>
55 [<literal>flush</literal>=<value>время</value>]]]</syntax>
56 <syntax>
57 <value>путь</value>
58 <value>формат</value>
59 <literal>gzip[=<value>степень</value>]</literal>
60 [<literal>buffer</literal>=<value>размер</value>]
61 [<literal>flush</literal>=<value>время</value>]</syntax>
55 <syntax><literal>off</literal></syntax> 62 <syntax><literal>off</literal></syntax>
56 <default>logs/access.log combined</default> 63 <default>logs/access.log combined</default>
57 <context>http</context> 64 <context>http</context>
58 <context>server</context> 65 <context>server</context>
59 <context>location</context> 66 <context>location</context>
60 <context>if в location</context> 67 <context>if в location</context>
61 <context>limit_except</context> 68 <context>limit_except</context>
62 69
63 <para> 70 <para>
64 Задаёт путь, формат и размер буфера для буферизованной записи в лог. 71 Задаёт путь, формат и настройки буферизованной записи в лог.
65 На одном уровне может использоваться несколько логов. 72 На одном уровне может использоваться несколько логов.
66 Специальное значение <literal>off</literal> отменяет все директивы 73 Специальное значение <literal>off</literal> отменяет все директивы
67 <literal>access_log</literal> для текущего уровня. 74 <literal>access_log</literal> для текущего уровня.
68 Если формат не указан, то используется предопределённый формат 75 Если формат не указан, то используется предопределённый формат
69 “<literal>combined</literal>”. 76 “<literal>combined</literal>”.
70 </para> 77 </para>
71 78
72 <para> 79 <para>
80 Если задан размер буфера с помощью параметра <literal>buffer</literal> или
81 указан параметр <literal>gzip</literal> (1.3.10), то запись будет
82 буферизованной.
83 <note>
73 Размер буфера должен быть не больше размера атомарной записи в дисковый файл. 84 Размер буфера должен быть не больше размера атомарной записи в дисковый файл.
74 Для FreeBSD этот размер неограничен. 85 Для FreeBSD этот размер неограничен.
86 </note>
87 </para>
88
89 <para>
90 При включённой буферизации данные записываются в файл:
91 <list type="bullet">
92
93 <listitem>
94 если очередная строка лога не помещается в буфер;
95 </listitem>
96
97 <listitem>
98 если данные в буфере находятся дольше интервала времени, заданного
99 параметром <literal>flush</literal> (1.3.10);
100 </listitem>
101
102 <listitem>
103 при <link doc="../control.xml">переоткрытии</link> лог-файла или
104 завершении рабочего процесса.
105 </listitem>
106
107 </list>
108 </para>
109
110 <para>
111 Если задан параметр <literal>gzip</literal>, то буфер будет сжиматься перед
112 записью в файл.
113 Степень сжатия может быть задана в диапазоне от 1 (быстрее, но хуже сжатие)
114 до 9 (медленнее, но лучше сжатие).
115 По умолчанию используется буфер размером 64К байт и степень сжатия 1.
116 Данные сжимаются атомарными блоками, и в любой момент времени лог-файл может
117 быть распакован или прочитан с помощью утилиты “<literal>zcat</literal>”.
118 </para>
119
120 <para>
121 Пример:
122 <example>
123 access_log /path/to/log.gz combined gzip flush=5m;
124 </example>
125 </para>
126
127 <para>
128 <note>
129 Для поддержки gzip-сжатия логов nginx должен быть собран с библиотекой zlib.
130 </note>
75 </para> 131 </para>
76 132
77 <para> 133 <para>
78 В пути файла можно использовать переменные (0.7.6+), 134 В пути файла можно использовать переменные (0.7.6+),
79 но такие логи имеют некоторые ограничения: 135 но такие логи имеют некоторые ограничения: