fix(log format): log format doesn't uphold opentelemetry field naming (MAPCO-8460) (#17)

* fix: log format doesn't uphold opentelemetry field naming

* chore: simplify nginx.conf network_protocol regex

* chore: quote upstream_response_length in log_format.conf

* Update helm/config/log_format.conf

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update helm/config/log_format.conf

* fix(log format): move host name to resources

* update Helm documentation

* Update helm/config/log_format.conf

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix(log format): incorrect opentelemetry span variable names

* chore(log format): remove spaces before values

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: 3 people

helm/config/log_format.conf

@@ -11,37 +11,45 @@ log_format main escape=json
         '"mapcolonies.http.auth.token.client_name":"$jwt_payload_sub",'
         {{ end }}
         '"http.request.method":"$request_method",'
+        '"http.request.header.host":"$host",'
         '"http.request.header.referer":"$http_referer",'
+        '"http.request.header.content-type":"$content_type",'
         '"http.request.body.size":"$content_length",'
-        '"http.response.body.size":"$body_bytes_sent",'
+        '"http.request.size": $request_length,'
+        '"http.response.body.size": $body_bytes_sent,'
         '"http.response.header.x_forwarded_for":"$proxy_add_x_forwarded_for",'
         '"http.response.status_code":"$status",'
         '"user_agent.original":"$http_user_agent",'
-        '"network.protocol":"$server_protocol",'
+        '"network.protocol.name":"$otel_network_protocol_name",'
+        '"network.protocol.version":"$otel_network_protocol_version",'
         '"mapcolonies.request_time":"$request_time",'
-        '"mapcolonies.http.upstream_connect_time":"$upstream_connect_time",'
-        '"mapcolonies.http.upstream_response_time":"$upstream_response_time",'
         '"mapcolonies.http.upstream_addr":"$upstream_addr",'
         '"mapcolonies.http.upstream_status_code":"$upstream_status",'
+        '"mapcolonies.http.upstream_connect_time":"$upstream_connect_time",'
+        '"mapcolonies.http.upstream_response_time":"$upstream_response_time",'
+        '"mapcolonies.http.upstream_response_length":"$upstream_response_length",'
+        '"mapcolonies.http.upstream_bytes_sent": $upstream_bytes_sent,'
+        '"mapcolonies.http.upstream_bytes_received": $upstream_bytes_received,'
         '"mapcolonies.http.upstream_cache_status":"$upstream_cache_status",'
-        '"mapcolonies.server":"$hostname",'
         '"server.address":"$host",'
         '"server.port":"$server_port",'
         '"client.address":"$remote_addr",'
         '"client.port":"$remote_port",'
         '"url.scheme":"$scheme",'
         '"url.path":"$uri",'
-        '"url.full":"$request_uri"'
+        '"url.full":"$request_uri",'
+        '"url.query":"$query_string"'
     '},'
     '"Resource":{'
         # Additional important log details should be added here
+        '"host.name":"$hostname",'
         '"service.name":"{{ .Values.image.repository }}",'
         '"service.version":"{{ .Values.image.tag }}"'
     '},'
     '"TraceId":"$otel_trace_id",' ## this is a byte sequence (hex-encoded in JSON)
     '"SpanId":"$otel_span_id",'
     '"SeverityText":"INFO",'
-    '"SeverityNumber":9,'
+    '"SeverityNumber": 9,'
     '"InstrumentationScope":"access.log",'
     '"Body":"$request"'
 '}';

helm/config/nginx.conf

@@ -18,6 +18,16 @@ http {
         endpoint {{ .Values.opentelemetry.exporterHost }}:{{ .Values.opentelemetry.exporterPort }};
     }
 
+    map $server_protocol $otel_network_protocol_name {
+        (.+)/.+$  $1;
+        default     "http";
+    }
+
+    map $server_protocol $otel_network_protocol_version {
+        .+/(.+)$  $1;
+        default     "1.1";
+    }
+
     include       /etc/nginx/mime.types;
     default_type  application/octet-stream;