changeset 1874:33f742032155

Documented support for json escaping in log_format.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 20 Dec 2016 18:44:33 +0300
parents 2f851f71ff08
children 4687cbd3c933
files xml/en/docs/http/ngx_http_log_module.xml xml/en/docs/stream/ngx_stream_log_module.xml xml/ru/docs/http/ngx_http_log_module.xml xml/ru/docs/stream/ngx_stream_log_module.xml
diffstat 4 files changed, 34 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_log_module.xml	Wed Dec 21 22:52:16 2016 +0300
+++ b/xml/en/docs/http/ngx_http_log_module.xml	Tue Dec 20 18:44:33 2016 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_log_module"
         link="/en/docs/http/ngx_http_log_module.html"
         lang="en"
-        rev="15">
+        rev="16">
 
 <section id="summary">
 
@@ -194,6 +194,7 @@
 <directive name="log_format">
 <syntax>
     <value>name</value>
+    [<literal>escape</literal>=<value>default</value>|<value>json</value>]
     <value>string</value> ...</syntax>
 <default>combined "..."</default>
 <context>http</context>
@@ -202,6 +203,12 @@
 Specifies log format.
 </para>
 
+<para id="log_format_escape">
+The <literal>escape</literal> parameter (1.11.8) allows setting
+<value>json</value> or <value>default</value> characters escaping in variables,
+by default, <value>default</value> escaping is used.
+</para>
+
 <para>
 The log format can contain common variables, and variables that
 exist only at the time of a log write:
--- a/xml/en/docs/stream/ngx_stream_log_module.xml	Wed Dec 21 22:52:16 2016 +0300
+++ b/xml/en/docs/stream/ngx_stream_log_module.xml	Tue Dec 20 18:44:33 2016 +0300
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_log_module"
         link="/en/docs/stream/ngx_stream_log_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -155,6 +155,7 @@
 <directive name="log_format">
 <syntax>
     <value>name</value>
+    [<literal>escape</literal>=<value>default</value>|<value>json</value>]
     <value>string</value> ...</syntax>
 <default></default>
 <context>stream</context>
@@ -169,6 +170,12 @@
 </example>
 </para>
 
+<para id="log_format_escape">
+The <literal>escape</literal> parameter (1.11.8) allows setting
+<value>json</value> or <value>default</value> characters escaping in variables,
+by default, <value>default</value> escaping is used.
+</para>
+
 </directive>
 
 
--- a/xml/ru/docs/http/ngx_http_log_module.xml	Wed Dec 21 22:52:16 2016 +0300
+++ b/xml/ru/docs/http/ngx_http_log_module.xml	Tue Dec 20 18:44:33 2016 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_log_module"
         link="/ru/docs/http/ngx_http_log_module.html"
         lang="ru"
-        rev="15">
+        rev="16">
 
 <section id="summary">
 
@@ -192,6 +192,7 @@
 <directive name="log_format">
 <syntax>
     <value>название</value>
+    [<literal>escape</literal>=<value>default</value>|<value>json</value>]
     <value>строка</value> ...</syntax>
 <default>combined "..."</default>
 <context>http</context>
@@ -200,6 +201,13 @@
 Задаёт формат лога.
 </para>
 
+<para id="log_format_escape">
+Параметр <literal>escape</literal> (1.11.8) позволяет задать
+экранирование символов <value>json</value> или <value>default</value>
+в переменных,
+по умолчанию используется <value>default</value>.
+</para>
+
 <para>
 Кроме общих переменных в формате можно использовать переменные,
 существующие только на момент записи в лог:
--- a/xml/ru/docs/stream/ngx_stream_log_module.xml	Wed Dec 21 22:52:16 2016 +0300
+++ b/xml/ru/docs/stream/ngx_stream_log_module.xml	Tue Dec 20 18:44:33 2016 +0300
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_log_module"
         link="/ru/docs/stream/ngx_stream_log_module.html"
         lang="ru"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -155,6 +155,7 @@
 <directive name="log_format">
 <syntax>
     <value>название</value>
+    [<literal>escape</literal>=<value>default</value>|<value>json</value>]
     <value>строка</value> ...</syntax>
 <default></default>
 <context>stream</context>
@@ -169,6 +170,13 @@
 </example>
 </para>
 
+<para id="log_format_escape">
+Параметр <literal>escape</literal> (1.11.8) позволяет задать
+экранирование символов <value>json</value> или <value>default</value>
+в переменных,
+по умолчанию используется <value>default</value>.
+</para>
+
 </directive>