feat: Enable nginx access logging in json format (#1086)

* Enable json access logformat in nginx
* Add required variables to the main log format
* Update nginx chapter

.vscode/intershop.txt

@@ -198,3 +198,5 @@ foobars
 asdf
 qwertz
 appr
+
+logformat

docs/concepts/logging.md

@@ -10,6 +10,8 @@ kb_sync_latest_only
 ## nginx
 
 The nginx image providing [PageSpeed](https://www.modpagespeed.com/) and multi-channel configuration uses the default logging capabilities of [nginx](https://www.nginx.com/).
+You can enable `json` formatted logging by passing environment variable `LOGFORMAT=json` to the container.
+When no `LOGFORMAT` variable is passed the container uses `main` as its default format.
 
 - [Configure Logging](https://docs.nginx.com/nginx/admin-guide/monitoring/logging/)
 - [Debugging Nginx Configuration](https://easyengine.io/tutorials/nginx/debugging/)

nginx/Dockerfile

@@ -34,6 +34,7 @@ ENV DEVICE_DETECTION=on
 ENV SSR=on
 ENV CACHE_DURATION_NGINX_OK=10m
 ENV CACHE_DURATION_NGINX_NF=60m
+ENV LOGFORMAT=main
 
 EXPOSE 80 443 9113
 

nginx/nginx.conf

@@ -16,13 +16,52 @@ events {
 http {
     include /etc/nginx/mime.types;
     default_type application/octet-stream;
+    log_format json escape=json '{'
+                                  '"time_local": "$time_local", '
+                                  '"core":'
+                                    '{'
+                                      '"remote_addr": "$remote_addr", '
+                                      '"remote_user": "$remote_user", '
+                                      '"request": "$request", '
+                                      '"status": "$status", '
+                                      '"body_bytes_sent": "$body_bytes_sent", '
+                                      '"http_referer": "$http_referer", '
+                                      '"http_user_agent": "$http_user_agent" ,'
+                                      '"http_x_forwarded_for": "$http_x_forwarded_for", '
+                                      '"request_method": "$request_method", '
+                                      '"request_time": "$request_time", '
+                                      '"host": "$host", '
+                                      '"server_name": "$server_name"'
+                                    '},'
+                                  '"ssl":'
+                                    '{'
+                                      '"ssl_cipher": "$ssl_cipher",'
+                                      '"ssl_client_cert": "$ssl_client_cert",'
+                                      '"ssl_client_fingerprint": "$ssl_client_fingerprint",'
+                                      '"ssl_client_i_dn": "$ssl_client_i_dn",'
+                                      '"ssl_client_raw_cert": "$ssl_client_raw_cert",'
+                                      '"ssl_client_s_dn": "$ssl_client_s_dn",'
+                                      '"ssl_client_serial": "$ssl_client_serial",'
+                                      '"ssl_client_verify": "$ssl_client_verify",'
+                                      '"ssl_protocol": "$ssl_protocol",'
+                                      '"ssl_server_name": "$ssl_server_name",'
+                                      '"ssl_session_id": "$ssl_session_id",'
+                                      '"ssl_session_reused": "$ssl_session_reused"'
+                                    '},'
+                                  '"upstream":'
+                                    '{'
+                                      '"address": "$upstream_addr", '
+                                      '"status": "$upstream_status", '
+                                      '"response_time": "$upstream_response_time", '
+                                      '"response_length": "$upstream_response_length", '
+                                      '"cache_status": "$upstream_cache_status"'
+                                    '}'
+                                '}';
 
     log_format main '$remote_addr - $remote_user [$time_local] "$request" '
                     '$status $body_bytes_sent "$http_referer" '
-                    '"$http_user_agent" "$http_x_forwarded_for"';
-
-    access_log /var/log/nginx-access.log main;
-    access_log /dev/stdout;
+                    '"$http_user_agent" "$http_x_forwarded_for" '
+                    '$upstream_response_time "$upstream_cache_status"';
 
     sendfile on;
 

nginx/templates/multi-channel.conf.tmpl

@@ -94,6 +94,9 @@ server {
     listen 80;
   {{- end }}
 
+    access_log /var/log/nginx-access.log {{ getenv "LOGFORMAT" }};
+    access_log /dev/stdout {{ getenv "LOGFORMAT" }};
+
     include /etc/nginx/conf.d/cache-blacklist.conf;