Improve request/response log field names

package.json

@@ -57,7 +57,7 @@
       "minimatch@<3.1.3": "3.1.3",
       "minimatch@>=5.0.0 <5.1.8": "5.1.8",
       "minimatch@>=9.0.0 <9.0.7": "9.0.7",
-      "tar": "^7.5.16",
+      "tar": "^7.5.21",
       "brace-expansion@>=2.0.0 <2.0.3": "2.0.3",
       "picomatch@^2": "2.3.2",
       "yaml": "^2.8.3",
@@ -70,7 +70,9 @@
       "sigstore": "^4.1.1",
       "@sigstore/core": "^3.2.1",
       "@opentelemetry/core": "^2.8.0",
-      "ws": "^8.21.0"
+      "ws": "^8.21.0",
+      "find-my-way": "^9.7.0",
+      "@fastify/static": "^10.1.2"
     }
   }
 }

src/app.ts

@@ -16,6 +16,7 @@ import fastifySwagger from '@fastify/swagger';
 import fastifySwaggerUI from '@fastify/swagger-ui';
 
 import { Config } from './config';
+import { AppLogController } from './logging';
 
 const { name: pkgName, version: pkgVersion } = JSON.parse(
     readFileSync(join(__dirname, '..', 'package.json'), 'utf8')
@@ -33,6 +34,7 @@ export const initApp = async (config: Config, logger: pino.Logger) => {
         trustProxy: true,
         bodyLimit: 1024,
         genReqId: () => randomUUID(),
+        logController: new AppLogController(),
     });
     app.setValidatorCompiler(validatorCompiler);
     app.setSerializerCompiler(serializerCompiler);

src/logging.ts

@@ -1,8 +1,71 @@
-import pino from "pino";
-import { Config } from "./config";
+import pino from 'pino';
+import {
+    FastifyReply,
+    FastifyRequest,
+    LogController,
+} from 'fastify';
+
+import { Config } from './config';
+
+export const REQUEST_ID_LOG_LABEL = 'request_id';
+export const DURATION_MS_LOG_LABEL = 'duration_ms';
+
+export const serializeRequest = (req: FastifyRequest) => ({
+    method: req.method,
+    path: req.url,
+    route: req.routeOptions?.url,
+    host: req.host,
+    remote_address: req.ip,
+    remote_port: req.socket?.remotePort,
+    user_agent: req.headers['user-agent'],
+});
+
+export const serializeResponse = (reply: FastifyReply) => ({
+    status_code: reply.statusCode,
+});
+
+export class AppLogController extends LogController {
+    constructor(options?: ConstructorParameters<typeof LogController>[0]) {
+        super({
+            ...options,
+            requestIdLogLabel: REQUEST_ID_LOG_LABEL,
+        });
+    }
+
+    requestCompleted(
+        error: Error | null,
+        request: FastifyRequest,
+        reply: FastifyReply
+    ) {
+        if (this.isLogDisabled(request)) return;
+
+        if (error) {
+            reply.log.error(
+                {
+                    res: reply,
+                    err: error,
+                    [DURATION_MS_LOG_LABEL]: reply.elapsedTime,
+                },
+                'request errored'
+            );
+        } else {
+            reply.log.info(
+                {
+                    res: reply,
+                    [DURATION_MS_LOG_LABEL]: reply.elapsedTime,
+                },
+                'request completed'
+            );
+        }
+    }
+}
 
 export const initLogging = async (config: Config): Promise<pino.Logger> => {
     return pino({
         level: config.logLevel,
+        serializers: {
+            req: serializeRequest,
+            res: serializeResponse,
+        },
     });
-}
+};