feat: standardise logs

supabase · Sep 29, 2023 · 4e98ef5 · 4e98ef5
1 parent f1076a0
commit 4e98ef5
Show file tree

Hide file tree

Showing 30 changed files with 207 additions and 200 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "description": "Supabase storage middleend",
   "main": "index.js",
   "scripts": {
-    "dev": "ts-node-dev --log-error --files ./src/server.ts --stack_trace_limit=100 -r trace -r clarify",
+    "dev": "ts-node-dev --log-error --files ./src/server.ts --stack_trace_limit=100 -r trace -r clarify | pino-pretty",
     "build": "tsc -p tsconfig.json",
     "start": "NODE_ENV=production node dist/server.js",
     "migration:run": "ts-node-dev ./src/scripts/migrate-call.ts",
@@ -58,7 +58,7 @@
     "pg-boss": "^8.1.1",
     "pg-listen": "^1.7.0",
     "pino": "^8.2.0",
-    "pino-logflare": "^0.3.12",
+    "pino-logflare": "^0.4.2",
     "postgres-migrations": "^5.3.0",
     "prom-client": "^14.0.1"
   },

diff --git a/src/http/error-handler.ts b/src/http/error-handler.ts
@@ -14,10 +14,6 @@ export const setErrorHandler = (app: FastifyInstance) => {
     // it will be logged in the request log plugin
     reply.executionError = error
 
-    if (process.env.NODE_ENV !== 'production') {
-      console.error(error)
-    }
-
     if (isRenderableError(error)) {
       const renderableError = error.render()
       const statusCode = error.userStatusCode

diff --git a/src/http/plugins/db.ts b/src/http/plugins/db.ts
@@ -3,6 +3,7 @@ import { TenantConnection } from '../../database/connection'
 import { getServiceKeyUser } from '../../database/tenant'
 import { getPostgresConnection } from '../../database'
 import { verifyJWT } from '../../auth'
+import { logSchema } from '../../monitoring'
 
 declare module 'fastify' {
   interface FastifyRequest {
@@ -33,21 +34,38 @@ export const db = fastifyPlugin(async (fastify) => {
   fastify.addHook('onSend', async (request, reply, payload) => {
     if (request.db) {
       request.db.dispose().catch((e) => {
-        request.log.error(e, 'Error disposing db connection')
+        logSchema.error(request.log, 'Error disposing db connection', {
+          type: 'db-connection',
+          error: e,
+        })
       })
     }
     return payload
   })
 
   fastify.addHook('onTimeout', async (request) => {
     if (request.db) {
-      await request.db.dispose()
+      try {
+        await request.db.dispose()
+      } catch (e) {
+        logSchema.error(request.log, 'Error disposing db connection', {
+          type: 'db-connection',
+          error: e,
+        })
+      }
     }
   })
 
   fastify.addHook('onRequestAbort', async (request) => {
     if (request.db) {
-      await request.db.dispose()
+      try {
+        await request.db.dispose()
+      } catch (e) {
+        logSchema.error(request.log, 'Error disposing db connection', {
+          type: 'db-connection',
+          error: e,
+        })
+      }
     }
   })
 })
@@ -72,7 +90,10 @@ export const dbSuperUser = fastifyPlugin(async (fastify) => {
   fastify.addHook('onSend', async (request, reply, payload) => {
     if (request.db) {
       request.db.dispose().catch((e) => {
-        request.log.error(e, 'Error disposing db connection')
+        logSchema.error(request.log, 'Error disposing db connection', {
+          type: 'db-connection',
+          error: e,
+        })
       })
     }
 
@@ -81,13 +102,27 @@ export const dbSuperUser = fastifyPlugin(async (fastify) => {
 
   fastify.addHook('onTimeout', async (request) => {
     if (request.db) {
-      await request.db.dispose()
+      try {
+        await request.db.dispose()
+      } catch (e) {
+        logSchema.error(request.log, 'Error disposing db connection', {
+          type: 'db-connection',
+          error: e,
+        })
+      }
     }
   })
 
   fastify.addHook('onRequestAbort', async (request) => {
     if (request.db) {
-      await request.db.dispose()
+      try {
+        await request.db.dispose()
+      } catch (e) {
+        logSchema.error(request.log, 'Error disposing db connection', {
+          type: 'db-connection',
+          error: e,
+        })
+      }
     }
   })
 })
diff --git a/src/http/plugins/log-request.ts b/src/http/plugins/log-request.ts
@@ -1,6 +1,5 @@
 import fastifyPlugin from 'fastify-plugin'
-import { redactQueryParamFromRequest } from '../../monitoring'
-import { normalizeRawError } from '../../storage'
+import { logSchema, redactQueryParamFromRequest } from '../../monitoring'
 
 interface RequestLoggerOptions {
   excludeUrls?: string[]
@@ -30,15 +29,13 @@ export const logRequest = (options: RequestLoggerOptions) =>
 
       const buildLogMessage = `${tenantId} | ${rMeth} | ${statusCode} | ${cIP} | ${rId} | ${rUrl} | ${uAgent}`
 
-      req.log.info(
-        {
-          req,
-          res: reply,
-          responseTime: reply.getResponseTime(),
-          error,
-          rawError: normalizeRawError(error),
-        },
-        buildLogMessage
-      )
+      logSchema.request(req.log, buildLogMessage, {
+        type: 'request',
+        req,
+        res: reply,
+        responseTime: reply.getResponseTime(),
+        error: error,
+        owner: req.owner,
+      })
     })
   })
diff --git a/src/http/plugins/log-tenant-id.ts b/src/http/plugins/log-tenant-id.ts
@@ -5,6 +5,7 @@ export const logTenantId = fastifyPlugin(async (fastify) => {
     reply.log = request.log = request.log.child({
       tenantId: request.tenantId,
       project: request.tenantId,
+      reqId: request.id,
     })
   })
 })