feat(api): add correlationIds to logger#info & logger#error

1024pix · Jul 4, 2024 · f913844 · f913844
1 parent b8a9039
commit f913844
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 47 deletions.
diff --git a/api/lib/infrastructure/monitoring-tools.js b/api/lib/infrastructure/monitoring-tools.js
@@ -1,13 +1,13 @@
+import async_hooks from 'node:async_hooks';
+
 import Request from '@hapi/hapi/lib/request.js';
 import lodash from 'lodash';
 
+import { logErrorWithCorrelationIds, logInfoWithCorrelationIds } from '../../src/shared/infrastructure/utils/logger.js';
+import * as requestResponseUtils from '../../src/shared/infrastructure/utils/request-response-utils.js';
 import { config } from '../config.js';
 
-const { get, set, update, omit } = lodash;
-import async_hooks from 'node:async_hooks';
-
-import { logger } from '../../src/shared/infrastructure/utils/logger.js';
-import * as requestResponseUtils from '../../src/shared/infrastructure/utils/request-response-utils.js';
+const { get, set, update } = lodash;
 
 const { AsyncLocalStorage } = async_hooks;
 
@@ -25,46 +25,6 @@ function getCorrelationContext() {
   };
 }
 
-function logInfoWithCorrelationIds(data) {
-  const context = getCorrelationContext();
-  logger.info(
-    {
-      ...context,
-      ...omit(data, 'message'),
-    },
-    get(data, 'message', '-'),
-  );
-}
-
-/**
- * In order to be displayed properly in Datadog,
- * the parameter "data" should contain
- * - a required property message as string
- * - all other properties you need to pass to Datadog
- *
- * @example
- * const data = {
- *   message: 'Error message',
- *   context: 'My Context',
- *   data: { more: 'data', if: 'needed' },
- *   event: 'Event which trigger this error',
- *   team: 'My Team',
- * };
- * monitoringTools.logErrorWithCorrelationIds(data);
- *
- * @param {object} data
- */
-function logErrorWithCorrelationIds(data) {
-  const context = getCorrelationContext();
-  logger.error(
-    {
-      ...context,
-      ...omit(data, 'message'),
-    },
-    get(data, 'message', '-'),
-  );
-}
-
 function extractUserIdFromRequest(request) {
   let userId = get(request, 'auth.credentials.userId');
   if (!userId && get(request, 'headers.authorization')) userId = requestResponseUtils.extractUserIdFromRequest(request);
@@ -138,6 +98,7 @@ export {
   asyncLocalStorage,
   extractUserIdFromRequest,
   getContext,
+  getCorrelationContext,
   getInContext,
   incrementInContext,
   installHapiHook,

diff --git a/api/src/shared/infrastructure/utils/logger.js b/api/src/shared/infrastructure/utils/logger.js
@@ -1,8 +1,12 @@
+import lodash from 'lodash';
 import pino from 'pino';
 import pretty from 'pino-pretty';
 
+import { getCorrelationContext } from '../../../../lib/infrastructure/monitoring-tools.js';
 import { config } from '../../config.js';
 
+const { get, omit } = lodash;
+
 const { logging } = config;
 
 let prettyPrint;
@@ -16,7 +20,7 @@ if (logging.logForHumans) {
   });
 }
 
-const logger = pino(
+const internalLogger = pino(
   {
     level: logging.logLevel,
     redact: ['req.headers.authorization'],
@@ -25,4 +29,68 @@ const logger = pino(
   prettyPrint,
 );
 
-export { logger };
+function parseDataForLogger(data) {
+  return typeof data === 'string' || data instanceof String ? {
+    message: data
+  } : data;
+}
+
+function _logErrorWithCorrelationIds(logger) {
+  return function(data) {
+    const parsedData = parseDataForLogger(data);
+    const context = getCorrelationContext();
+    logger.error(
+      {
+        ...context,
+        ...omit(parsedData, 'message'),
+      },
+      get(parsedData, 'message', '-'),
+    );
+  }
+}
+
+function _logInfoWithCorrelationIds(logger) {
+  return function(data) {
+    const parsedData = parseDataForLogger(data);
+    const context = getCorrelationContext();
+    logger.info(
+      {
+        ...context,
+        ...omit(parsedData, 'message'),
+      },
+      get(parsedData, 'message', '-'),
+    );
+  }
+}
+
+/**
+ * In order to be displayed properly in Datadog,
+ * the parameter "data" should contain
+ * - a required property message as string
+ * - all other properties you need to pass to Datadog
+ *
+ * @example
+ * const data = {
+ *   message: 'Error message',
+ *   context: 'My Context',
+ *   data: { more: 'data', if: 'needed' },
+ *   event: 'Event which trigger this error',
+ *   team: 'My Team',
+ * };
+ * monitoringTools.logErrorWithCorrelationIds(data);
+ *
+ * @param {object} data
+ */
+const logErrorWithCorrelationIds = _logErrorWithCorrelationIds(internalLogger);
+const logInfoWithCorrelationIds = _logInfoWithCorrelationIds(internalLogger);
+
+const logger = {
+  error: logErrorWithCorrelationIds,
+  info: logInfoWithCorrelationIds,
+  warn: internalLogger.warn.bind(internalLogger),
+  trace: internalLogger.trace.bind(internalLogger),
+  fatal: internalLogger.fatal.bind(internalLogger),
+  debug: internalLogger.debug.bind(internalLogger),
+};
+
+export { logger, logErrorWithCorrelationIds, logInfoWithCorrelationIds };