Skip to content

Commit

Permalink
Add doc for json escaping in logs
Browse files Browse the repository at this point in the history
Add the doc for #845
  • Loading branch information
pleshakov committed Mar 30, 2020
1 parent 1ba0791 commit 3b5bc6d
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs-web/configuration/global-configuration/configmap-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,13 +203,21 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres
- ``False``
-
* - ``log-format``
- Sets the custom `log format <http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format>`_ for HTTP and HTTPS traffic.
- Sets the custom `log format <http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format>`_ for HTTP and HTTPS traffic. For convenience, it is possible to define the log format across multiple lines (each line separated by ``\n``). In that case, the Ingress Controller will replace every ``\n`` character with a space character. All ``'`` characters must be escaped.
- See the `template file <https://github.com/nginxinc/kubernetes-ingress/blob/master/internal/configs/version1/nginx.tmpl>`_ for the access log.
-
* - ``log-format-escaping``
- Sets the characters escaping for the variables of the log format. Supported values: ``json`` (JSON escaping), ``default`` (the default escaping) ``none`` (disables escaping).
- ``default``
-
* - ``stream-log-format``
- Sets the custom `log format <http://nginx.org/en/docs/stream/ngx_stream_log_module.html#log_format>`_ for TCP, UDP, and TLS Passthrough traffic.
- Sets the custom `log format <http://nginx.org/en/docs/stream/ngx_stream_log_module.html#log_format>`_ for TCP, UDP, and TLS Passthrough traffic. For convenience, it is possible to define the log format across multiple lines (each line separated by ``\n``). In that case, the Ingress Controller will replace every ``\n`` character with a space character. All ``'`` characters must be escaped.
- See the `template file <https://github.com/nginxinc/kubernetes-ingress/blob/master/internal/configs/version1/nginx.tmpl>`_.
-
* - ``stream-log-format-escaping``
- Sets the characters escaping for the variables of the stream log format. Supported values: ``json`` (JSON escaping), ``default`` (the default escaping) ``none`` (disables escaping).
- ``default``
-
```

### Request URI/Header Manipulation
Expand Down

0 comments on commit 3b5bc6d

Please sign in to comment.