Merge pull request #11 from CodeForAfrica/use-json-format-for-nginx-logs

Switch to JSON format for Nginx logs

Author: maquchizi

contrib/compose/nginx_medium_rewrite_urls.conf

@@ -33,10 +33,29 @@ map $uri $needs_conversion {
     default        "no";
 }
 
+# Set up a JSON log format for better structured logging.
+log_format json escape=json
+  '{'
+    '"timestamp": "$time_iso8601",'
+    '"client_ip": "$remote_addr",'
+    '"request_id": "$request_id",'
+    '"http_method": "$request_method",'
+    '"http_path": "$uri",'
+    '"protocol": "$server_protocol",'
+    '"user_agent": "$http_user_agent",'
+    '"referer": "$http_referer",'
+    '"status_code": $status,'
+    '"bytes_sent": $body_bytes_sent,'
+    '"request_time_secs": $request_time'
+  '}';
+
 server {
     listen 8069;
     server_name localhost;
 
+    access_log logs/access.log json;
+    error_log logs/error.log;
+
     client_max_body_size 100M;
 
     # Remove the random ID that Medium appends to post URLs. This effectively does the same redirect recommended by Ghost here:

nginx.conf.sigil

@@ -38,12 +38,28 @@ map $uri $needs_conversion {
   default        "no";
 }
 
+# Set up a JSON log format for better structured logging.
+log_format json escape=json
+  '{'
+    '"timestamp": "$time_iso8601",'
+    '"client_ip": "$remote_addr",'
+    '"request_id": "$request_id",'
+    '"http_method": "$request_method",'
+    '"http_path": "$uri",'
+    '"protocol": "$server_protocol",'
+    '"user_agent": "$http_user_agent",'
+    '"referer": "$http_referer",'
+    '"status_code": $status,'
+    '"bytes_sent": $body_bytes_sent,'
+    '"request_time_secs": $request_time'
+  '}';
+
 server {
   listen      [::]:80;
   listen      80;
   server_name {{ .NOSSL_SERVER_NAME }};
 
-  access_log  /var/log/nginx/{{ .APP }}-access.log;
+  access_log  /var/log/nginx/{{ .APP }}-access.log json;
   error_log   /var/log/nginx/{{ .APP }}-error.log;
   underscores_in_headers off;
 
@@ -70,7 +86,7 @@ server {
   listen      443 ssl http2;
   {{ if .SSL_SERVER_NAME }}server_name {{ .SSL_SERVER_NAME }}; {{ end }}
 
-  access_log  /var/log/nginx/{{ .APP }}-access.log;
+  access_log  /var/log/nginx/{{ .APP }}-access.log json;
   error_log   /var/log/nginx/{{ .APP }}-error.log;
 
   ssl_certificate     {{ .APP_SSL_PATH }}/server.crt;