Implement HTTP access logging

Author: nodeexx

src/hooks.server.ts

@@ -1,5 +1,6 @@
 import {
   checkMandatoryPrivateEnvVarsHandle,
+  httpLogHandle,
   maintenanceModeHandle,
 } from '$lib/server/core/hooks';
 import { addAuthDataToLocalHandle } from '$lib/server/lucia/hooks';
@@ -27,10 +28,14 @@ setupSentryClient({
 roarr.info('Starting the app server...');
 
 export const handle = (async (input) => {
-  const maintenanceModeHandles: Handle[] = [maintenanceModeHandle];
+  const maintenanceModeHandles: Handle[] = [
+    httpLogHandle,
+    maintenanceModeHandle,
+  ];
   const nonMaintenanceModeHandles: Handle[] = [
     checkMandatoryPrivateEnvVarsHandle,
     addAuthDataToLocalHandle,
+    httpLogHandle,
   ];
 
   if (sentry) {

src/lib/server/core/config/index.ts

@@ -65,5 +65,8 @@ export const config = {
     get isDebugContextShown(): boolean {
       return privateEnv.ROARR_SHOW_DEBUG_CONTEXT === 'true';
     },
+    get isAccessLoggingEnabled(): boolean {
+      return privateEnv.ROARR_ACCESS_LOG === 'true';
+    },
   },
 };

src/lib/server/core/hooks/http-log.handle.ts

@@ -0,0 +1,40 @@
+import type { Handle } from '@sveltejs/kit';
+import { roarr } from '$lib/server/roarr';
+import { config } from '$lib/server/core/config';
+
+export const httpLogHandle = (async ({ event, resolve }) => {
+  if (!config.roarr.isAccessLoggingEnabled) {
+    return resolve(event);
+  }
+
+  const requestTimestamp = Date.now();
+  const response = await resolve(event);
+  const responseTimeInMs = Date.now() - requestTimestamp;
+
+  const { method, url, headers: requestHeaders } = event.request;
+  const { status, headers: responseHeaders } = response;
+
+  const contentLengthBytesString = responseHeaders.get('content-length');
+  const contentLengthInBytes: number | null =
+    Number(contentLengthBytesString) || 0;
+
+  roarr.info('Access log', {
+    logType: 'http',
+    request: {
+      address: event.getClientAddress(),
+      userId: event.locals.authUser?.userId ?? null,
+      userAgent: requestHeaders.get('user-agent'),
+      method,
+      url,
+      route: event.route.id,
+      referrer: requestHeaders.get('referer') ?? requestHeaders.get('referrer'),
+    },
+    response: {
+      status: status,
+      contentLengthInBytes,
+      responseTimeInMs,
+    },
+  });
+
+  return response;
+}) satisfies Handle;

src/lib/server/core/hooks/index.ts

@@ -1,2 +1,3 @@
 export * from './check-mandatory-private-env-vars.handle';
 export * from './maintenance-mode.handle';
+export * from './http-log.handle';

src/lib/server/roarr/client.ts

@@ -23,6 +23,7 @@ export const roarr = (function () {
       }
 
       let contextClone = serializeErrorInContext(context);
+      contextClone = enrichContextWithLogType(contextClone);
       contextClone = enrichContextWithSentryTraceId(contextClone);
 
       Roarr[methodName](
@@ -118,6 +119,13 @@ function enrichContextWithDebugInfo(
   };
 }
 
+function enrichContextWithLogType(context: LoggerContext): LoggerContext {
+  return {
+    logType: 'app',
+    ...context,
+  };
+}
+
 function getCallName(stackLevel: number = 3): string {
   const typeName = callsites()[stackLevel]?.getTypeName() ?? '';
   const functionName =