feat: add trace to logs (#405)

* chore: install express-request-id * chore: update types * chore: use addRequestId() middleware * feat: add trace to logs * chore: add more traces * chore: include trace in loggingMiddleware
opengovsg · Oct 5, 2020 · 306800f · 306800f
1 parent 373761d
commit 306800f
Show file tree

Hide file tree

Showing 17 changed files with 125 additions and 16 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -71,6 +71,8 @@
     "@sentry/browser": "^5.24.2",
     "@sentry/integrations": "^5.24.2",
     "@stablelib/base64": "^1.0.0",
+    "@types/express-request-id": "^1.4.1",
+    "@types/express-serve-static-core": "^4.17.13",
     "JSONStream": "^1.3.5",
     "angular": "~1.8.0",
     "angular-animate": "^1.8.0",
@@ -112,6 +114,7 @@
     "ejs": "^3.1.5",
     "express": "^4.16.4",
     "express-device": "~0.4.2",
+    "express-request-id": "^1.4.1",
     "express-session": "^1.15.6",
     "express-winston": "^4.0.5",
     "fetch-readablestream": "^0.2.0",

diff --git a/src/app/controllers/admin-console.server.controller.js b/src/app/controllers/admin-console.server.controller.js
@@ -20,7 +20,7 @@ const Form = getFormModel(mongoose)
 const _ = require('lodash')
 
 const logger = require('../../config/logger').createLoggerWithLabel(module)
-const { getRequestIp } = require('../utils/request')
+const { getRequestIp, getTrace } = require('../utils/request')
 
 // Examples search-specific constants
 const PAGE_SIZE = 16 // maximum number of results to return
@@ -577,6 +577,7 @@ exports.getExampleFormsUsingAggregateCollection = function (req, res) {
           meta: {
             action: 'getExampleFormsUsingAggregateCollection',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },
@@ -609,6 +610,7 @@ exports.getExampleFormsUsingSubmissionsCollection = function (req, res) {
           meta: {
             action: 'getExampleFormsUsingSubmissionsCollection',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },
@@ -699,6 +701,7 @@ exports.getSingleExampleFormUsingSubmissionCollection = function (req, res) {
           meta: {
             action: 'getSingleExampleFormUsingSubmissionCollection',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },
@@ -727,6 +730,7 @@ exports.getSingleExampleFormUsingAggregateCollection = function (req, res) {
           meta: {
             action: 'getSingleExampleFormUsingAggregateCollection',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },
@@ -808,6 +812,7 @@ exports.getLoginStats = function (req, res) {
           meta: {
             action: 'getLoginStats',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },
@@ -827,6 +832,7 @@ exports.getLoginStats = function (req, res) {
           }`,
           meta: {
             action: 'getLoginStats',
+            trace: getTrace(req),
           },
         })
 

diff --git a/src/app/controllers/admin-forms.server.controller.js b/src/app/controllers/admin-forms.server.controller.js
@@ -11,7 +11,7 @@ const { StatusCodes } = require('http-status-codes')
 
 const logger = require('../../config/logger').createLoggerWithLabel(module)
 const errorHandler = require('./errors.server.controller')
-const { getRequestIp } = require('../utils/request')
+const { getRequestIp, getTrace } = require('../utils/request')
 const { FormLogoState } = require('../../types')
 
 const {
@@ -69,6 +69,7 @@ function makeModule(connection) {
         meta: {
           action: 'respondOnMongoError',
           ip: getRequestIp(req),
+          trace: getTrace(req),
           url: req.url,
           headers: req.headers,
         },
@@ -290,6 +291,7 @@ function makeModule(connection) {
             meta: {
               action: 'makeModule.update',
               ip: getRequestIp(req),
+              trace: getTrace(req),
               formId: form._id,
             },
           })
@@ -307,6 +309,7 @@ function makeModule(connection) {
               meta: {
                 action: 'makeModule.update',
                 ip: getRequestIp(req),
+                trace: getTrace(req),
                 formId: form._id,
               },
               error,
@@ -521,6 +524,7 @@ function makeModule(connection) {
             meta: {
               action: 'makeModule.countFeedback',
               ip: getRequestIp(req),
+              trace: getTrace(req),
               url: req.url,
               headers: req.headers,
             },
@@ -550,6 +554,7 @@ function makeModule(connection) {
             meta: {
               action: 'makeModule.streamFeedback',
               ip: getRequestIp(req),
+              trace: getTrace(req),
             },
             error: err,
           })
@@ -564,6 +569,7 @@ function makeModule(connection) {
             meta: {
               action: 'makeModule.streamFeedback',
               ip: getRequestIp(req),
+              trace: getTrace(req),
             },
             error: err,
           })
@@ -578,6 +584,7 @@ function makeModule(connection) {
             meta: {
               action: 'makeModule.streamFeedback',
               ip: getRequestIp(req),
+              trace: getTrace(req),
             },
             error: err,
           })
@@ -689,6 +696,7 @@ function makeModule(connection) {
               meta: {
                 action: 'makeModule.streamFeedback',
                 ip: getRequestIp(req),
+                trace: getTrace(req),
               },
               error: err,
             })
@@ -736,6 +744,7 @@ function makeModule(connection) {
               meta: {
                 action: 'makeModule.streamFeedback',
                 ip: getRequestIp(req),
+                trace: getTrace(req),
               },
               error: err,
             })
@@ -764,6 +773,7 @@ function makeModule(connection) {
           meta: {
             action: 'makeModule.transferOwner',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },

diff --git a/src/app/controllers/authentication.server.controller.js b/src/app/controllers/authentication.server.controller.js
@@ -5,7 +5,7 @@
  */
 const { StatusCodes } = require('http-status-codes')
 const PERMISSIONS = require('../utils/permission-levels').default
-const { getRequestIp } = require('../utils/request')
+const { getRequestIp, getTrace } = require('../utils/request')
 const logger = require('../../config/logger').createLoggerWithLabel(module)
 
 /**
@@ -50,6 +50,7 @@ const logUnauthorizedAccess = (req, action, requiredPermission) => {
     meta: {
       action: action,
       ip: getRequestIp(req),
+      trace: getTrace(req),
       url: req.url,
       headers: req.headers,
     },

diff --git a/src/app/controllers/core.server.controller.js b/src/app/controllers/core.server.controller.js
@@ -3,7 +3,7 @@ const _ = require('lodash')
 const { StatusCodes } = require('http-status-codes')
 
 const config = require('../../config/config')
-const { getRequestIp } = require('../utils/request')
+const { getRequestIp, getTrace } = require('../utils/request')
 const logger = require('../../config/logger').createLoggerWithLabel(module)
 
 const getFormStatisticsTotalModel = require('../models/form_statistics_total.server.model')
@@ -53,6 +53,7 @@ exports.formCountUsingAggregateCollection = (req, res) => {
           meta: {
             action: 'formCountUsingAggregateCollection',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },
@@ -97,6 +98,7 @@ exports.formCountUsingSubmissionsCollection = (req, res) => {
           meta: {
             action: 'formCountUsingSubmissionsCollection',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             url: req.url,
             headers: req.headers,
           },
@@ -124,6 +126,7 @@ exports.userCount = (req, res) => {
         meta: {
           action: 'userCount',
           ip: getRequestIp(req),
+          trace: getTrace(req),
           url: req.url,
           headers: req.headers,
         },
@@ -149,6 +152,7 @@ exports.submissionCount = (req, res) => {
         meta: {
           action: 'submissionCount',
           ip: getRequestIp(req),
+          trace: getTrace(req),
           url: req.url,
           headers: req.headers,
         },

diff --git a/src/app/controllers/email-submissions.server.controller.js b/src/app/controllers/email-submissions.server.controller.js
@@ -9,7 +9,7 @@ const mongoose = require('mongoose')
 const { getEmailSubmissionModel } = require('../models/submission.server.model')
 const emailSubmission = getEmailSubmissionModel(mongoose)
 const { StatusCodes } = require('http-status-codes')
-const { getRequestIp } = require('../utils/request')
+const { getRequestIp, getTrace } = require('../utils/request')
 const { ConflictError } = require('../modules/submission/submission.errors')
 const { MB } = require('../constants/filesize')
 const {
@@ -57,6 +57,7 @@ exports.receiveEmailSubmissionUsingBusBoy = function (req, res, next) {
       meta: {
         action: 'receiveEmailSubmissionUsingBusBoy',
         ip: getRequestIp(req),
+        trace: getTrace(req),
         formId: _.get(req, 'form._id'),
       },
       error: err,
@@ -108,6 +109,7 @@ exports.receiveEmailSubmissionUsingBusBoy = function (req, res, next) {
           meta: {
             action: 'receiveEmailSubmissionUsingBusBoy',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             formId: req.form._id,
           },
           error: err,
@@ -125,6 +127,7 @@ exports.receiveEmailSubmissionUsingBusBoy = function (req, res, next) {
         meta: {
           action: 'receiveEmailSubmissionUsingBusBoy',
           ip: getRequestIp(req),
+          trace: getTrace(req),
           formId: req.form._id,
         },
       })
@@ -155,6 +158,7 @@ exports.receiveEmailSubmissionUsingBusBoy = function (req, res, next) {
         action: 'receiveEmailSubmissionUsingBusBoy',
         formId: req.form._id,
         ip: getRequestIp(req),
+        trace: getTrace(req),
         uin: hashedUinFin,
         submission: hashedSubmission,
       },
@@ -168,6 +172,7 @@ exports.receiveEmailSubmissionUsingBusBoy = function (req, res, next) {
           meta: {
             action: 'receiveEmailSubmissionUsingBusBoy',
             ip: getRequestIp(req),
+            trace: getTrace(req),
             formId: req.form._id,
           },
         })
@@ -192,6 +197,7 @@ exports.receiveEmailSubmissionUsingBusBoy = function (req, res, next) {
         meta: {
           action: 'receiveEmailSubmissionUsingBusBoy',
           ip: getRequestIp(req),
+          trace: getTrace(req),
           formId: req.form._id,
           uin: hashedUinFin,
           submission: hashedSubmission,
@@ -210,6 +216,7 @@ exports.receiveEmailSubmissionUsingBusBoy = function (req, res, next) {
       meta: {
         action: 'receiveEmailSubmissionUsingBusBoy',
         ip: getRequestIp(req),
+        trace: getTrace(req),
         formId: req.form._id,
       },
       error: err,
@@ -246,6 +253,7 @@ exports.validateEmailSubmission = function (req, res, next) {
         meta: {
           action: 'validateEmailSubmission',
           ip: getRequestIp(req),
+          trace: getTrace(req),
           formId: req.form._id,
         },
         error: err,
@@ -502,6 +510,7 @@ function onSubmissionEmailFailure(err, req, res, submission) {
     meta: {
       action: 'onSubmissionEmailFailure',
       ip: getRequestIp(req),
+      trace: getTrace(req),
       url: req.url,
       headers: req.headers,
     },
@@ -601,6 +610,7 @@ exports.saveMetadataToDb = function (req, res, next) {
           submissionId: submission.id,
           formId: form._id,
           ip: getRequestIp(req),
+          trace: getTrace(req),
           responseHash: submission.responseHash,
         },
       })
@@ -643,6 +653,7 @@ exports.sendAdminEmail = async function (req, res, next) {
         submissionId: submission.id,
         formId: form._id,
         ip: getRequestIp(req),
+        trace: getTrace(req),
         submissionHash: submission.responseHash,
       },
     })
@@ -665,6 +676,7 @@ exports.sendAdminEmail = async function (req, res, next) {
         submissionId: submission.id,
         formId: form._id,
         ip: getRequestIp(req),
+        trace: getTrace(req),
         submissionHash: submission.responseHash,
       },
       error: err,