changeset 1175:a05d9fa73ce2

Documented the syslog support in "error_log" and "access_log".
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 30 Apr 2014 19:39:37 +0400
parents f121a423a6dd
children 4eea26b34ea5
files xml/ru/docs/http/ngx_http_log_module.xml xml/ru/docs/ngx_core_module.xml
diffstat 2 files changed, 145 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/xml/ru/docs/http/ngx_http_log_module.xml	Tue Apr 29 07:37:52 2014 +0000
+++ b/xml/ru/docs/http/ngx_http_log_module.xml	Wed Apr 30 19:39:37 2014 +0400
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_log_module"
         link="/ru/docs/http/ngx_http_log_module.html"
         lang="ru"
-        rev="10">
+        rev="11">
 
 <section id="summary">
 
@@ -59,6 +59,9 @@
     <literal>gzip[=<value>степень</value>]</literal>
     [<literal>buffer</literal>=<value>размер</value>]
     [<literal>flush</literal>=<value>время</value>]</syntax>
+<syntax>
+    <literal>syslog:</literal><literal>server</literal>=<value>адрес</value>[,<value>параметр</value>=<value>значение</value>]
+    [<value>формат</value>]</syntax>
 <syntax><literal>off</literal></syntax>
 <default>logs/access.log combined</default>
 <context>http</context>
@@ -70,6 +73,8 @@
 <para>
 Задаёт путь, формат и настройки буферизованной записи в лог.
 На одном уровне может использоваться несколько логов.
+Запись в syslog настраивается указанием префикса
+“<literal>syslog:</literal>” в первом параметре.
 Специальное значение <literal>off</literal> отменяет все директивы
 <literal>access_log</literal> для текущего уровня.
 Если формат не указан, то используется предопределённый формат
@@ -171,6 +176,78 @@
 </list>
 </para>
 
+<para>
+Запись в syslog настраивается при помощи следующих параметров:
+<list type="tag">
+
+<tag-name><literal>server=</literal><value>адрес</value></tag-name>
+<tag-desc>
+Задаёт адрес сервера syslog.
+Адрес может быть указан в виде доменного имени, IP-адреса или
+в виде пути UNIX-сокета (указывается после префикса
+“<literal>unix:</literal>”).
+Вместе с именем или адресом может быть указан порт.
+Если порт не указан, используется порт 514.
+Если доменному имени соответствует несколько IP-адресов,
+используется только первый адрес.
+</tag-desc>
+
+<tag-name><literal>facility=</literal><value>строка</value></tag-name>
+<tag-desc>
+Задаёт категорию сообщений syslog в соответствии с
+<link url="http://tools.ietf.org/html/rfc3164#section-4.1.1">RFC 3164</link>.
+В качестве категории может быть указано одно из следующих значений:
+“<literal>kern</literal>”, “<literal>user</literal>”,
+“<literal>mail</literal>”, “<literal>daemon</literal>”,
+“<literal>auth</literal>”, “<literal>intern</literal>”,
+“<literal>lpr</literal>”, “<literal>news</literal>”, “<literal>uucp</literal>”,
+“<literal>clock</literal>”, “<literal>authpriv</literal>”,
+“<literal>ftp</literal>”, “<literal>ntp</literal>”, “<literal>audit</literal>”,
+“<literal>alert</literal>”, “<literal>cron</literal>”,
+“<literal>local0</literal>”..“<literal>local7</literal>”.
+По умолчанию используется “<literal>local7</literal>”.
+</tag-desc>
+
+<tag-name><literal>severity=</literal><value>строка</value></tag-name>
+<tag-desc>
+Задаёт важность сообщений syslog в соответствии с
+<link url="http://tools.ietf.org/html/rfc3164#section-4.1.1">RFC 3164</link>.
+Возможны те же самые значения, что и у второго параметра (уровень)
+директивы <link doc="../ngx_core_module.xml" id="error_log"/>.
+По умолчанию используется “<literal>info</literal>”.
+</tag-desc>
+
+<tag-name><literal>tag=</literal><value>строка</value></tag-name>
+<tag-desc>
+Задаёт метку сообщений syslog.
+По умолчанию используется “<literal>nginx</literal>”.
+</tag-desc>
+
+<!--
+<tag-name><literal>bare=</literal><literal>on</literal> |
+<literal>off</literal></tag-name>
+<tag-desc>
+Если включено, сообщения отправляются без заголовка syslog.
+По умолчанию выключено.
+</tag-desc>
+-->
+
+</list>
+Пример конфигурации syslog:
+<example>
+access_log syslog:server=192.168.1.1;
+access_log syslog:server=unix:/var/log/nginx.sock;
+access_log syslog:server=[2001:db8::1]:12345,facility=local7,tag=nginx,severity=info combined;
+</example>
+</para>
+
+<para>
+<note>
+Запись в syslog доступна как часть
+<commercial_version>коммерческой подписки</commercial_version>.
+</note>
+</para>
+
 </directive>
 
 
--- a/xml/ru/docs/ngx_core_module.xml	Tue Apr 29 07:37:52 2014 +0000
+++ b/xml/ru/docs/ngx_core_module.xml	Wed Apr 30 19:39:37 2014 +0400
@@ -10,7 +10,7 @@
 <module name="Основная функциональность"
         link="/ru/docs/ngx_core_module.html"
         lang="ru"
-        rev="8">
+        rev="9">
 
 <section id="example" name="Пример конфигурации">
 
@@ -144,7 +144,8 @@
 
 <directive name="error_log">
 <syntax>
-<value>файл</value> | <literal>stderr</literal>
+<value>файл</value> | <literal>stderr</literal> |
+<literal>syslog:</literal><literal>server</literal>=<value>адрес</value>[,<value>параметр</value>=<value>значение</value>]
 [<literal>debug</literal> |
 <literal>info</literal> |
 <literal>notice</literal> |
@@ -170,6 +171,8 @@
 Если имя файла не абсолютное, к нему добавляется в начало путь префикса.
 -->
 Специальное значение <literal>stderr</literal> выбирает стандартный файл ошибок.
+Запись в syslog настраивается указанием префикса
+“<literal>syslog:</literal>”.
 </para>
 
 <para>
@@ -188,6 +191,68 @@
 </note>
 </para>
 
+<para>
+Запись в syslog настраивается при помощи следующих параметров:
+<list type="tag">
+
+<tag-name><literal>server=</literal><value>адрес</value></tag-name>
+<tag-desc>
+Задаёт адрес сервера syslog.
+Адрес может быть указан в виде доменного имени или IP-адреса,
+и необязательного порта, или в виде пути UNIX-сокета, который
+указывается после префикса “<literal>unix:</literal>”.
+Если порт не указан, используется порт 514.
+Если доменному имени соответствует несколько IP-адресов,
+используется только первый адрес.
+</tag-desc>
+
+<tag-name><literal>facility=</literal><value>строка</value></tag-name>
+<tag-desc>
+Задаёт категорию сообщений syslog в соответствии с
+<link url="http://tools.ietf.org/html/rfc3164#section-4.1.1">RFC 3164</link>.
+В качестве категории может быть указано одно из следующих значений:
+“<literal>kern</literal>”, “<literal>user</literal>”,
+“<literal>mail</literal>”, “<literal>daemon</literal>”,
+“<literal>auth</literal>”, “<literal>intern</literal>”,
+“<literal>lpr</literal>”, “<literal>news</literal>”, “<literal>uucp</literal>”,
+“<literal>clock</literal>”, “<literal>authpriv</literal>”,
+“<literal>ftp</literal>”, “<literal>ntp</literal>”, “<literal>audit</literal>”,
+“<literal>alert</literal>”, “<literal>cron</literal>”,
+“<literal>local0</literal>”..“<literal>local7</literal>”.
+По умолчанию используется “<literal>local7</literal>”.
+</tag-desc>
+
+<tag-name><literal>tag=</literal><value>строка</value></tag-name>
+<tag-desc>
+Задаёт метку сообщений syslog.
+По умолчанию используется “<literal>nginx</literal>”.
+</tag-desc>
+
+<!--
+<tag-name><literal>bare=</literal><literal>on</literal> |
+<literal>off</literal></tag-name>
+<tag-desc>
+Если включено, сообщения отправляются без заголовка syslog.
+По умолчанию выключено.
+</tag-desc>
+-->
+
+</list>
+Пример конфигурации syslog:
+<example>
+error_log syslog:server=192.168.1.1 debug;
+error_log syslog:server=unix:/var/log/nginx.sock;
+error_log syslog:server=[2001:db8::1]:12345,facility=local7,tag=nginx error;
+</example>
+</para>
+
+<para>
+<note>
+Запись в syslog доступна как часть
+<commercial_version>коммерческой подписки</commercial_version>.
+</note>
+</para>
+
 </directive>