@emartech/json-logger 9.1.0 → 9.2.0

package/README.md

@@ -193,6 +193,8 @@ The separate steps of the logging process can be configured here.
 These modifications affect all the instances of the library.
 With transformers we can alter the data to be logged before passing to the formatter and then to the output.
 It is a perfect place to add the name of the machine is running on or the request id associated with the current thread stored on a continuation local storage. 
+With the 'enhancedStackTrace' option set to true, the error stack traces will include the causes of the errors as well (if any) including their stack traces 
+with a significantly improved truncation limit.
 
 ```javascript
 const { createLogger } = require('@emartech/json-logger');
@@ -201,7 +203,8 @@ createLogger.configure({
   formatter: JSON.stringify,
   output: console.log,
   transformers: [],
-  outputFormat: 'ecs'
+  outputFormat: 'ecs',
+  enhancedStackTrace: true
 });
 
 ```

package/dist/logger/logger.d.ts

@@ -4,6 +4,7 @@ export interface LoggerConfig {
     output: Function;
     transformers: Function[];
     outputFormat: string;
+    enhancedStackTrace: boolean;
 }
 export declare class Logger {
     private readonly namespace;
@@ -29,6 +30,6 @@ export declare class Logger {
     private shortenData;
     private getErrorDetails;
     private getBaseErrorDetails;
-    private extractError;
+    private getEnhancedStackTrace;
     private getAxiosErrorDetails;
 }

package/dist/logger/logger.js

@@ -7,8 +7,9 @@ const json_1 = require("../formatter/json");
 const console_1 = require("../output/console");
 const timer_1 = require("../timer/timer");
 const STACK_TRACE_LIMIT = 3000;
+const ENHANCED_STACK_TRACE_LIMIT = 15000;
 const DATA_LIMIT = 3000;
-const allowedKeys = ['output', 'formatter', 'transformers', 'outputFormat'];
+const allowedKeys = ['output', 'formatter', 'transformers', 'outputFormat', 'enhancedStackTrace'];
 /* eslint-enable @typescript-eslint/no-unsafe-function-type */
 class Logger {
     namespace;
@@ -33,6 +34,7 @@ class Logger {
         output: console_1.consoleOutput,
         transformers: [],
         outputFormat: 'ecs',
+        enhancedStackTrace: false,
     };
     isEnabled() {
         return this.enabled;
@@ -117,30 +119,82 @@ class Logger {
         return (0, lodash_1.merge)(this.getBaseErrorDetails(error), this.getAxiosErrorDetails(error));
     }
     getBaseErrorDetails(error) {
+        const shortenedData = this.shortenData(error.data);
         if (Logger.config.outputFormat === 'legacy') {
             return {
                 error_name: error.name,
                 error_stack: this.shortenStackTrace(error.stack || ''),
                 error_message: error.message,
-                error_data: this.shortenData(error.data),
+                error_data: shortenedData,
             };
         }
+        const stackTrace = Logger.config.enhancedStackTrace
+            ? this.getEnhancedStackTrace(error)
+            : this.shortenStackTrace(error.stack || '');
         return {
-            error: this.extractError(error),
+            error: {
+                type: error.name,
+                message: error.message,
+                ...(shortenedData && { context: shortenedData }),
+                stack_trace: stackTrace,
+            },
             event: {
                 reason: error.message,
             },
         };
     }
-    extractError(error) {
-        const shortenedData = this.shortenData(error.data);
-        return {
-            type: error.name,
-            message: error.message,
-            ...(shortenedData && { context: shortenedData }),
-            stack_trace: this.shortenStackTrace(error.stack || ''),
-            ...(error.cause instanceof Error && { cause: this.extractError(error.cause) }),
+    getEnhancedStackTrace(error) {
+        const getNumberOfCommonFrames = (ownTrace, enclosingTrace) => {
+            let m = ownTrace.length - 1;
+            let n = enclosingTrace.length - 1;
+            while (m > 0 && n > 0 && ownTrace[m] === enclosingTrace[n]) {
+                m--;
+                n--;
+            }
+            return ownTrace.length - 1 - m;
         };
+        const getEnclosedStackTrace = (error, enclosingTrace, caption) => {
+            const output = [];
+            let errorName;
+            let errorStack;
+            const errorStackLines = error.stack ? error.stack.split('\n') : [];
+            const firstLine = errorStackLines.at(0);
+            if (error.stack) {
+                if (firstLine?.includes(error.name)) {
+                    errorName = firstLine;
+                    errorStack = errorStackLines.slice(1);
+                }
+                else {
+                    errorName = error.name;
+                    errorStack = errorStackLines;
+                }
+            }
+            else {
+                errorName = error.name;
+                errorStack = [];
+            }
+            const commonFrames = getNumberOfCommonFrames(errorStack, enclosingTrace);
+            const uniqueFrames = errorStack.length - commonFrames;
+            output.push(caption + errorName);
+            errorStack.slice(0, uniqueFrames).forEach((line) => output.push(line));
+            if (commonFrames > 0) {
+                output.push(`\t... ${commonFrames} more`);
+            }
+            if (error.cause instanceof Error) {
+                output.push(...getEnclosedStackTrace(error.cause, errorStackLines, 'Caused by: '));
+            }
+            return output;
+        };
+        const stackTrace = getEnclosedStackTrace(error, [], '');
+        const joinedStackTrace = stackTrace.join('\n');
+        let resultStackTraceStr;
+        if (joinedStackTrace.length > ENHANCED_STACK_TRACE_LIMIT) {
+            resultStackTraceStr = joinedStackTrace.substring(0, ENHANCED_STACK_TRACE_LIMIT) + ' ...';
+        }
+        else {
+            resultStackTraceStr = joinedStackTrace;
+        }
+        return resultStackTraceStr;
     }
     getAxiosErrorDetails(error) {
         if (!error.isAxiosError) {

package/package.json

@@ -68,5 +68,5 @@
     "ts-node": "10.9.2",
     "typescript": "5.9.3"
   },
-  "version": "9.1.0"
+  "version": "9.2.0"
 }