comparison xml/ru/docs/http/ngx_http_log_module.xml @ 271:4c6d2c614d2c

Cleaned up XML tag mess: - all of <parameter> and <code>, and some of <dirname>, <value>, and <command> were replaced by <literal>; - the rest of <dirname> were replaced by links; - <argument> were replaced by <value>; - <value> is now rendered in HTML in italic; - <literal> and <path> can now contain <value>. Cleaned up terminology mess: - directives take "parameters".
author Ruslan Ermilov <ru@nginx.com>
date Fri, 23 Dec 2011 17:29:59 +0000
parents 945d7299c26c
children 457c54242cfa
comparison
equal deleted inserted replaced
270:945d7299c26c 271:4c6d2c614d2c
7 lang="ru"> 7 lang="ru">
8 8
9 <section id="summary"> 9 <section id="summary">
10 10
11 <para> 11 <para>
12 Модуль <code>ngx_http_log_module</code> записывает логи запросов 12 Модуль <literal>ngx_http_log_module</literal> записывает логи запросов
13 в указанном формате. 13 в указанном формате.
14 </para> 14 </para>
15 15
16 </section> 16 </section>
17 17
33 33
34 <section id="directives" name="Директивы"> 34 <section id="directives" name="Директивы">
35 35
36 <directive name="access_log"> 36 <directive name="access_log">
37 <syntax> 37 <syntax>
38 <argument>путь</argument> 38 <value>путь</value>
39 [<argument>формат</argument> 39 [<value>формат</value>
40 [<parameter>buffer</parameter>=<argument>размер</argument>]]</syntax> 40 [<literal>buffer</literal>=<value>размер</value>]]</syntax>
41 <syntax><value>off</value></syntax> 41 <syntax><literal>off</literal></syntax>
42 <default>log/access.log combined</default> 42 <default>log/access.log combined</default>
43 <context>http</context> 43 <context>http</context>
44 <context>server</context> 44 <context>server</context>
45 <context>location</context> 45 <context>location</context>
46 <context>if в location</context> 46 <context>if в location</context>
47 <context>limit_except</context> 47 <context>limit_except</context>
48 48
49 <para> 49 <para>
50 Задаёт путь, формат и размер буфера для буферизованной записи в лог. 50 Задаёт путь, формат и размер буфера для буферизованной записи в лог.
51 На одном уровне может использоваться несколько логов. 51 На одном уровне может использоваться несколько логов.
52 Специальное значение <value>off</value> отменяет все директивы 52 Специальное значение <literal>off</literal> отменяет все директивы
53 <code>access_log</code> для текущего уровня. 53 <literal>access_log</literal> для текущего уровня.
54 Если формат не указан, то используется предопределённый формат 54 Если формат не указан, то используется предопределённый формат
55 “<code>combined</code>”. 55 “<literal>combined</literal>”.
56 </para> 56 </para>
57 57
58 <para> 58 <para>
59 Размер буфера должен быть не больше размера атомарной записи в дисковый файл. 59 Размер буфера должен быть не больше размера атомарной записи в дисковый файл.
60 Для FreeBSD 3.0-6.0 этот размер неограничен. 60 Для FreeBSD 3.0-6.0 этот размер неограничен.
78 <listitem> 78 <listitem>
79 файл открывается для каждой записи в лог и сразу же после записи закрывается. 79 файл открывается для каждой записи в лог и сразу же после записи закрывается.
80 Следует однако иметь в виду, что поскольку дескрипторы часто используемых файлов 80 Следует однако иметь в виду, что поскольку дескрипторы часто используемых файлов
81 могут храниться в <link id="open_log_file_cache">кэше</link>, 81 могут храниться в <link id="open_log_file_cache">кэше</link>,
82 то при вращении логов в течение времени, заданного параметром 82 то при вращении логов в течение времени, заданного параметром
83 <parameter>valid</parameter> директивы <link id="open_log_file_cache"/>, 83 <literal>valid</literal> директивы <link id="open_log_file_cache"/>,
84 запись может продолжаться в старый файл. 84 запись может продолжаться в старый файл.
85 </listitem> 85 </listitem>
86 86
87 <listitem> 87 <listitem>
88 при каждой записи в лог проверяется существование 88 при каждой записи в лог проверяется существование
89 <link doc="ngx_http_core_module.xml" id="root">корневого каталога</link> 89 <link doc="ngx_http_core_module.xml" id="root">корневого каталога</link>
90 для запроса — если этот каталог не существует, то лог не создаётся. 90 для запроса — если этот каталог не существует, то лог не создаётся.
91 Поэтому <link doc="ngx_http_core_module.xml" id="root"/> 91 Поэтому <link doc="ngx_http_core_module.xml" id="root"/>
92 и <code>access_log</code> нужно описывать на одном уровне: 92 и <literal>access_log</literal> нужно описывать на одном уровне:
93 <example> 93 <example>
94 server { 94 server {
95 root /spool/vhost/data/$host; 95 root /spool/vhost/data/$host;
96 access_log /spool/vhost/logs/$host; 96 access_log /spool/vhost/logs/$host;
97 ... 97 ...
104 </directive> 104 </directive>
105 105
106 106
107 <directive name="log_format"> 107 <directive name="log_format">
108 <syntax> 108 <syntax>
109 <argument>название</argument> 109 <value>название</value>
110 <argument>строка</argument> ...</syntax> 110 <value>строка</value> ...</syntax>
111 <default>combined "..."</default> 111 <default>combined "..."</default>
112 <context>http</context> 112 <context>http</context>
113 113
114 <para> 114 <para>
115 Задаёт формат лога. 115 Задаёт формат лога.
121 <list type="tag"> 121 <list type="tag">
122 122
123 <tag-name><var>$body_bytes_sent</var></tag-name> 123 <tag-name><var>$body_bytes_sent</var></tag-name>
124 <tag-desc> 124 <tag-desc>
125 число байт, переданных клиенту, за вычетом заголовка ответа; 125 число байт, переданных клиенту, за вычетом заголовка ответа;
126 переменная совместима с параметром “<code>%B</code>” модуля Apache 126 переменная совместима с параметром “<literal>%B</literal>” модуля Apache
127 <code>mod_log_config</code> 127 <literal>mod_log_config</literal>
128 </tag-desc> 128 </tag-desc>
129 129
130 <tag-name><var>$bytes_sent</var></tag-name> 130 <tag-name><var>$bytes_sent</var></tag-name>
131 <tag-desc> 131 <tag-desc>
132 число байт, переданных клиенту 132 число байт, переданных клиенту
142 время в секундах с точностью до миллисекунд на момент записи в лог 142 время в секундах с точностью до миллисекунд на момент записи в лог
143 </tag-desc> 143 </tag-desc>
144 144
145 <tag-name><var>$pipe</var></tag-name> 145 <tag-name><var>$pipe</var></tag-name>
146 <tag-desc> 146 <tag-desc>
147 “<code>p</code>” если запрос был pipelined, иначе “<code>.</code>” 147 “<literal>p</literal>” если запрос был pipelined, иначе “<literal>.</literal>”
148 </tag-desc> 148 </tag-desc>
149 149
150 <tag-name><var>$request_length</var></tag-name> 150 <tag-name><var>$request_length</var></tag-name>
151 <tag-desc> 151 <tag-desc>
152 длина запроса (включая строку запроса, заголовок и тело запроса) 152 длина запроса (включая строку запроса, заголовок и тело запроса)
177 </list> 177 </list>
178 </para> 178 </para>
179 179
180 <para> 180 <para>
181 Строки заголовка, переданные клиенту, начинаются с префикса 181 Строки заголовка, переданные клиенту, начинаются с префикса
182 “<code>sent_http_</code>”, например, 182 “<literal>sent_http_</literal>”, например,
183 <var>$sent_http_content_range</var>. 183 <var>$sent_http_content_range</var>.
184 </para> 184 </para>
185 185
186 <para> 186 <para>
187 В конфигурации всегда существует предопределённый формат 187 В конфигурации всегда существует предопределённый формат
188 “<code>combined</code>”: 188 “<literal>combined</literal>”:
189 <example> 189 <example>
190 log_format combined '$remote_addr - $remote_user [$time_local] ' 190 log_format combined '$remote_addr - $remote_user [$time_local] '
191 '"$request" $status $body_bytes_sent ' 191 '"$request" $status $body_bytes_sent '
192 '"$http_referer" "$http_user_agent"'; 192 '"$http_referer" "$http_user_agent"';
193 </example> 193 </example>
196 </directive> 196 </directive>
197 197
198 <directive name="open_log_file_cache"> 198 <directive name="open_log_file_cache">
199 199
200 <syntax> 200 <syntax>
201 <parameter>max</parameter>=<argument>N</argument> 201 <literal>max</literal>=<value>N</value>
202 [<parameter>inactive</parameter>=<argument>время</argument>] 202 [<literal>inactive</literal>=<value>время</value>]
203 [<parameter>min_uses</parameter>=<argument>N</argument>] 203 [<literal>min_uses</literal>=<value>N</value>]
204 [<parameter>valid</parameter>=<argument>время</argument>]</syntax> 204 [<literal>valid</literal>=<value>время</value>]</syntax>
205 <syntax><value>off</value></syntax> 205 <syntax><literal>off</literal></syntax>
206 <default>off</default> 206 <default>off</default>
207 <context>http</context> 207 <context>http</context>
208 <context>server</context> 208 <context>server</context>
209 <context>location</context> 209 <context>location</context>
210 210
212 Задаёт кэш, в котором хранятся дескрипторы файлов часто используемых 212 Задаёт кэш, в котором хранятся дескрипторы файлов часто используемых
213 логов, имена которых заданы с использованием переменных. 213 логов, имена которых заданы с использованием переменных.
214 Параметры директивы: 214 Параметры директивы:
215 <list type="tag"> 215 <list type="tag">
216 216
217 <tag-name><parameter>max</parameter></tag-name> 217 <tag-name><literal>max</literal></tag-name>
218 <tag-desc> 218 <tag-desc>
219 задаёт максимальное число дескрипторов в кэше; 219 задаёт максимальное число дескрипторов в кэше;
220 при переполнении кэша наиболее давно не используемые (LRU) 220 при переполнении кэша наиболее давно не используемые (LRU)
221 дескрипторы закрываются 221 дескрипторы закрываются
222 </tag-desc> 222 </tag-desc>
223 223
224 <tag-name><parameter>inactive</parameter></tag-name> 224 <tag-name><literal>inactive</literal></tag-name>
225 <tag-desc> 225 <tag-desc>
226 задаёт время, после которого закэшированный дескриптор закрывается, 226 задаёт время, после которого закэшированный дескриптор закрывается,
227 если к нему не было обращений в течение этого времени; 227 если к нему не было обращений в течение этого времени;
228 по умолчанию 10 секунд 228 по умолчанию 10 секунд
229 </tag-desc> 229 </tag-desc>
230 230
231 <tag-name><parameter>min_uses</parameter></tag-name> 231 <tag-name><literal>min_uses</literal></tag-name>
232 <tag-desc> 232 <tag-desc>
233 задаёт минимальное число использований файла в течение 233 задаёт минимальное число использований файла в течение
234 времени, заданного параметром <parameter>inactive</parameter>, 234 времени, заданного параметром <literal>inactive</literal>,
235 после которого дескриптор файла будет оставаться открытым в кэше; 235 после которого дескриптор файла будет оставаться открытым в кэше;
236 по умолчанию 1 236 по умолчанию 1
237 </tag-desc> 237 </tag-desc>
238 238
239 <tag-name><parameter>valid</parameter></tag-name> 239 <tag-name><literal>valid</literal></tag-name>
240 <tag-desc> 240 <tag-desc>
241 задаёт, через какое время нужно проверять, что файл ещё 241 задаёт, через какое время нужно проверять, что файл ещё
242 существует под тем же именем; 242 существует под тем же именем;
243 по умолчанию 60 секунд 243 по умолчанию 60 секунд
244 </tag-desc> 244 </tag-desc>
245 245
246 <tag-name><value>off</value></tag-name> 246 <tag-name><literal>off</literal></tag-name>
247 <tag-desc> 247 <tag-desc>
248 запрещает кэш 248 запрещает кэш
249 </tag-desc> 249 </tag-desc>
250 250
251 </list> 251 </list>