BAU: Add DT trace id to logs

Author: Joe-Edwards-GDS

package-lock.json

@@ -79,6 +79,7 @@
   "dependencies": {
     "@aws-sdk/client-dynamodb": "3.799.0",
     "@aws-sdk/client-ssm": "3.799.0",
+    "@dynatrace/oneagent-sdk": "1.5.0",
     "@govuk-one-login/data-vocab": "1.9.2",
     "@govuk-one-login/frontend-analytics": "3.3.0",
     "@govuk-one-login/frontend-device-intelligence": "1.1.0",

package.json

@@ -18,7 +18,7 @@ import vcReceiptStatusRouter from "./app/vc-receipt-status/router";
 import oauthRouter from "./app/oauth2/router";
 import config from "./config/config";
 import { setLocals } from "./lib/locals";
-import { loggerMiddleware, logger } from "./lib/logger";
+import { loggerMiddleware, logger, getLogRequestContext } from "./lib/logger";
 import { i18nextConfigurationOptions } from "./config/i18next";
 import serverErrorHandler from "./handlers/internal-server-error-handler";
 import journeyEventErrorHandler from "./handlers/journey-event-error-handler";
@@ -175,14 +175,6 @@ app.use((req, res, next) => {
 
 app.use(notificationBannerHandler);
 
-app.use((req, res, next) => {
-  req.log = logger.child({
-    requestId: req.id,
-    ipvSessionId: req.session?.ipvSessionId,
-    sessionId: req.session?.id,
-  });
-  next();
-});
 app.use(loggerMiddleware);
 
 // Must be added to the app after the session and logging, and before the routers.
@@ -200,15 +192,6 @@ app.set("etag", false);
 
 const router = express.Router();
 
-router.use((req, res, next) => {
-  req.log = logger.child({
-    requestId: req.id,
-    ipvSessionId: req.session?.ipvSessionId,
-    sessionId: req.session?.id,
-  });
-  next();
-});
-
 router.use("/oauth2", oauthRouter);
 router.use("/credential-issuer", criRouter);
 router.use("/app", mobileAppRouter);

src/app.ts

@@ -1,3 +1,4 @@
+import { createInstance } from "@dynatrace/oneagent-sdk"
 import { Request, RequestHandler, Response } from "express";
 import pino, { Logger } from "pino";
 import pinoHttp, { ReqId } from "pino-http";
@@ -69,17 +70,26 @@ export const generateRequestId = (req: Request, res: Response): ReqId => {
   return newId;
 };
 
-const addRequestContext = (
-  req: Request,
-  res: Response,
-  val: object,
-): object => ({
-  ...val,
-  requestId: req.id,
-  ipvSessionId: req.session?.ipvSessionId,
-  sessionId: req.session?.id,
-  context: req.session?.context ?? undefined,
-});
+const getDynatraceContext = (): object | undefined => {
+  const dynatraceApi = createInstance();
+  const contextInfo = dynatraceApi.getTraceContextInfo();
+  if (contextInfo?.isValid) {
+    return {
+      "dt.trace_id": contextInfo.traceid,
+      "dt.span_id": contextInfo.spanid,
+    };
+  }
+};
+
+export const getLogRequestContext = (req: Request): object => {
+  return {
+    requestId: req.id,
+    ipvSessionId: req.session?.ipvSessionId,
+    sessionId: req.session?.id,
+    context: req.session?.context ?? undefined,
+    ...getDynatraceContext(),
+  };
+};
 
 export const loggerMiddleware: RequestHandler = pinoHttp({
   // Reuse an existing logger instance
@@ -90,20 +100,18 @@ export const loggerMiddleware: RequestHandler = pinoHttp({
   wrapSerializers: false,
   // Define a custom receive message
   customReceivedMessage: (req) => `REQUEST RECEIVED: ${req.method}`,
-  customReceivedObject: addRequestContext,
   customErrorMessage: (req, res) =>
     `REQUEST FAILED WITH STATUS CODE: ${res.statusCode}`,
   customErrorObject: (req, res, error, val) => {
     // Ignore errors that have already been handled by the error handler
     if (val.err === HANDLED_ERROR) {
       delete val.err;
     }
-
-    return addRequestContext(req, res, val);
+    return val;
   },
+  customProps: getLogRequestContext,
   customSuccessMessage: (req, res) =>
     `REQUEST ${res.statusCode >= 400 ? "FAILED" : "COMPLETED"} WITH STATUS CODE OF: ${res.statusCode}`,
-  customSuccessObject: addRequestContext,
   customAttributeKeys: {
     responseTime: "timeTaken",
   },