# HG changeset patch # User Yaroslav Zhuravlev # Date 1589317572 -3600 # Node ID b686736680e3be4eb24a73ba1e844301847dd7f1 # Parent 5a5a791b3166b53e8e27611c94e76d70b716747f Documented escaping rules in log_format. diff --git a/xml/en/docs/http/ngx_http_log_module.xml b/xml/en/docs/http/ngx_http_log_module.xml --- a/xml/en/docs/http/ngx_http_log_module.xml +++ b/xml/en/docs/http/ngx_http_log_module.xml @@ -10,7 +10,7 @@ + rev="20">
@@ -210,6 +210,33 @@ in variables, by default, defau The none value (1.13.10) disables escaping. + +For default escaping, +characters “"”, “\”, +and other characters with values less than 32 (0.7.0) or above 126 (1.1.6) +are escaped as “\xXX”. +If the variable value is not found, +a hyphen (“-”) will be logged. + + + +For json escaping, +all characters not allowed +in JSON strings +will be escaped: +characters “"” and +“\” are escaped as +“\"” and “\\”, +characters with values less than 32 are escaped as +“\n”, +“\r”, +“\t”, +“\b”, +“\f”, or +“\u00XX”. + + + The log format can contain common variables, and variables that exist only at the time of a log write: diff --git a/xml/en/docs/stream/ngx_stream_log_module.xml b/xml/en/docs/stream/ngx_stream_log_module.xml --- a/xml/en/docs/stream/ngx_stream_log_module.xml +++ b/xml/en/docs/stream/ngx_stream_log_module.xml @@ -9,7 +9,7 @@ + rev="7">
@@ -177,6 +177,32 @@ in variables, by default, defau The none parameter (1.13.10) disables escaping. + +For default escaping, +characters “"”, “\”, +and other characters with values less than 32 or above 126 +are escaped as “\xXX”. +If the variable value is not found, +a hyphen (“-”) will be logged. + + + +For json escaping, +all characters not allowed +in JSON strings +will be escaped: +characters “"” and +“\” are escaped as +“\"” and “\\”, +characters with values less than 32 are escaped as +“\n”, +“\r”, +“\t”, +“\b”, +“\f”, or +“\u00XX”. + + diff --git a/xml/ru/docs/http/ngx_http_log_module.xml b/xml/ru/docs/http/ngx_http_log_module.xml --- a/xml/ru/docs/http/ngx_http_log_module.xml +++ b/xml/ru/docs/http/ngx_http_log_module.xml @@ -10,7 +10,7 @@ + rev="20">
@@ -209,6 +209,31 @@ access_log /path/to/access.log combined экранирование символов. + +При использовании default +символы “"”, “\”, +a также символы со значениями меньше 32 (0.7.0) или больше 126 (1.1.6) +экранируются как “\xXX”. +Если значение переменной не найдено, +то в качестве значения в лог будет записываться дефис (“-”). + + + +При использовании json +экранируются все символы, недопустимые +в JSON строках: +символы “"” и +“\” экранируются как +“\"” и “\\”, +символы со значениями меньше 32 экранируются как +“\n”, +“\r”, +“\t”, +“\b”, +“\f” или +“\u00XX”. + + Кроме общих переменных в формате можно использовать переменные, существующие только на момент записи в лог: diff --git a/xml/ru/docs/stream/ngx_stream_log_module.xml b/xml/ru/docs/stream/ngx_stream_log_module.xml --- a/xml/ru/docs/stream/ngx_stream_log_module.xml +++ b/xml/ru/docs/stream/ngx_stream_log_module.xml @@ -9,7 +9,7 @@ + rev="7">
@@ -178,6 +178,31 @@ log_format proxy '$remote_addr [$time_lo экранирование символов. + +При использовании default +символы “"”, “\”, +a также символы со значениями меньше 32 или больше 126 +экранируются как “\xXX”. +Если значение переменной не найдено, +то в качестве значения в лог будет записываться дефис (“-”). + + + +При использовании json +экранируются все символы, недопустимые +в JSON строках: +символы “"” и +“\” экранируются как +“\"” и “\\”, +символы со значениями меньше 32 экранируются как +“\n”, +“\r”, +“\t”, +“\b”, +“\f” или +“\u00XX”. + +