improve logging

Author: dglowinski

package.json

@@ -35,6 +35,7 @@
     "dotenv": "16.4.5",
     "ethers": "5.7.2",
     "express": "4.21.1",
+    "express-http-context": "^1.2.5",
     "express-rate-limit": "7.4.1",
     "helmet": "8.0.0",
     "http-status-codes": "2.3.0",

pnpm-lock.yaml

@@ -2,11 +2,13 @@ import express, { type Request, type Response, type Router } from "express"
 
 import { ServiceResponse } from "@/common/models/serviceResponse"
 import { handleServiceResponse } from "@/common/utils/httpHandlers"
+import { logProd } from "@/common/utils/logs"
+import { logger } from "ethers"
 
 export const logRouter: Router = express.Router()
 
 logRouter.post("", (req: Request, res: Response) => {
-  console.log("[LOG]", JSON.stringify(req.body))
+  logProd({ name: "[LOG]", ...req.body })
 
   const serviceResponse = ServiceResponse.success({ msg: "success" })
   return handleServiceResponse(serviceResponse, res)

src/api/routes/log/logRouter.ts

@@ -8,6 +8,7 @@ import {
   handleServiceResponse,
   validateRequest,
 } from "@/common/utils/httpHandlers"
+import { log, logProd, logRouteTime } from "@/common/utils/logs"
 import { findSwaps } from "@/swapService/runner"
 import type { SwapParams } from "@/swapService/types"
 import {
@@ -53,15 +54,22 @@ swapRouter.get(
   validateRequest(getSwapSchema),
   async (req: Request, res: Response) => {
     try {
-      const swaps = await findSwaps(parseRequest(req))
+      const swapParams = parseRequest(req)
+
+      const startTime = process.hrtime()
+      const swaps = await findSwaps(swapParams)
+      const elapsedSeconds = parseHrtimeToSeconds(process.hrtime(startTime))
+
+      logRouteTime(swapParams, elapsedSeconds)
+
       return handleServiceResponse(
         ServiceResponse.success<SwapResponseSingle>(swaps[0]),
         res,
       )
     } catch (error) {
       return handleServiceResponse(createFailureResponse(req, error), res)
     } finally {
-      console.log("===== SWAP END =====")
+      log("===== SWAP END =====")
     }
   },
 )
@@ -71,49 +79,35 @@ swapRouter.get(
   validateRequest(getSwapSchema),
   async (req: Request, res: Response) => {
     try {
-      const startTime = process.hrtime()
       const swapParams = parseRequest(req)
+
+      const startTime = process.hrtime()
       const swaps = await findSwaps(swapParams)
       const elapsedSeconds = parseHrtimeToSeconds(process.hrtime(startTime))
-      console.log("ROUTE EXECUTING")
-      if (elapsedSeconds > 10) {
-        console.log(
-          `SLOW ROUTE [10]: ${swapParams.swapperMode} ${elapsedSeconds}s`,
-        )
-      } else if (elapsedSeconds > 5) {
-        console.log(
-          `SLOW ROUTE [5]: ${swapParams.swapperMode} ${elapsedSeconds}s`,
-        )
-      } else if (elapsedSeconds > 3) {
-        console.log(
-          `SLOW ROUTE [3]: ${swapParams.swapperMode} ${elapsedSeconds}s`,
-        )
-      } else if (elapsedSeconds > 1) {
-        console.log(
-          `SLOW ROUTE [1]: ${swapParams.swapperMode} ${elapsedSeconds}s`,
-        )
-      }
+
+      logRouteTime(swapParams, elapsedSeconds)
+
       return handleServiceResponse(
         ServiceResponse.success<SwapResponse>(swaps),
         res,
       )
     } catch (error) {
       return handleServiceResponse(createFailureResponse(req, error), res)
     } finally {
-      console.log("===== SWAPS END =====")
+      log("===== SWAPS END =====")
     }
   },
 )
 
 function createFailureResponse(req: Request, error: any) {
-  console.log(
-    "error: ",
-    error.statusCode,
-    error.message,
-    error.errorMessage,
-    JSON.stringify(error.data),
-    req.url,
-  )
+  logProd({
+    name: "[ERROR]",
+    statusCode: error.statusCode,
+    message: error.message,
+    errorMessage: error.errorMessage,
+    data: error.data,
+    url: req.url,
+  })
   if (error instanceof ApiError) {
     return ServiceResponse.failure(error.message, error.statusCode, error.data)
   }