@emartech/json-logger 7.2.3 → 8.0.0

package/README.md

@@ -9,9 +9,21 @@ It has the same namespace based enabling/disabling mechanism as [debug].
 npm install @emartech/json-logger
 ```
 
+### Usage
 
+Since 8.0.0, by default ECS fields will be used when logging. 
 
-### Usage
+If for reason you still need the old format, you need to override the `outputFormat` config.
+`configure` will apply this setting globally, for all instances of the logger.
+
+```javascript
+const { createLogger } = require('@emartech/json-logger');
+
+createLogger.configure({
+  outputFormat: 'legacy'
+});
+
+```
 
 #### Script
 
@@ -22,13 +34,15 @@ const mongoLogger = createLogger('mongo');
 const redisLogger = createLogger('redis');
 
 redisLogger.info('connected', { domain: 'yahoo' });
-// {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
+// ECS format: {"event":{"action":"connected"},"log":{"logger":"redis","level":30},"@timestamp":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
+// Legacy format: {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
 
 mongoLogger.info('connected', { domain: 'google' });
 // no output, because 'mongo' is not within namespaces (process.env.DEBUG)
 
 redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
-// {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
+// ECS format: {"event":{"action":"query"},"log":{"logger":"redis","level":50},"@timestamp":"2016-08-15T08:50:23.569Z","error":{"type":"Error","message":"Unauthorized","stack_trace":"..."},"problem":"mismatch"}
+// Legacy format: {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
 ```
 
 #### Class
@@ -103,10 +117,12 @@ const { createLogger } = require('@emartech/json-logger');
 const redisLogger = createLogger('redis');
 
 redisLogger.info('connected', { domain: 'yahoo' });
-// {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
+// ECS format: {"event":{"action":"connected"},"log":{"logger":"redis","level":30},"@timestamp":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
+// Legacy format: {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
 
 redisLogger.info('connected');
-// {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z"}
+// ECS format: {"event":{"action":"connected"},"log":{"logger":"redis","level":30},"@timestamp":"2016-08-15T08:50:23.566Z"}
+// Legacy format: {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z"}
 ```
 
 By default displays the namespace of the instance (`name`), the current time in ISO8601 format (`time`),
@@ -144,7 +160,8 @@ const { createLogger } = require('@emartech/json-logger');
 const redisLogger = createLogger('redis');
 
 redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
-// {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
+// ECS format: {"event":{"action":"query"},"log":{"logger":"redis","level":50},"@timestamp":"2016-08-15T08:50:23.569Z","error":{"type":"Error","message":"Unauthorized","stack_trace":"..."},"problem":"mismatch"}
+// Legacy format: {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
 ```
 
 ##### JsonLogger.prototype.warnFromError(action, data)
@@ -166,7 +183,8 @@ const timer = redisLogger.timer();
 // heavy task
 
 timer.info('completed');
-// {"name":"redis","action":"completed","level":30,"time":"2016-08-15T08:50:23.566Z","duration": 1500}
+// Legacy format: {"name":"redis","action":"completed","level":30,"time":"2016-08-15T08:50:23.566Z","duration": 1500}
+// ECS format: {"event":{"action":"completed","duration":"1500"},"log":{"logger":"redis","level":30},"@timestamp":"2016-08-15T08:50:23.566Z"}
 ```
 
 ##### JsonLogger.configure(options)
@@ -182,7 +200,8 @@ const { createLogger } = require('@emartech/json-logger');
 createLogger.configure({
   formatter: JSON.stringify,
   output: console.log,
-  transformers: []
+  transformers: [],
+  outputFormat: 'ecs'
 });
 
 ```
@@ -225,7 +244,7 @@ app.use(clsAdapter.getKoaMiddleware());
 
 app.use(async () => {
   logger.info('connected');
-  // {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","request_id":"d5caaa0e-b04e-4d94-bc88-3ed3b62dc94a"}
+  // Legacy format: {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","request_id":"d5caaa0e-b04e-4d94-bc88-3ed3b62dc94a"}
 })
 ```
 

package/dist/logger/logger.d.ts

@@ -3,6 +3,7 @@ export interface LoggerConfig {
     formatter: Function;
     output: Function;
     transformers: Function[];
+    outputFormat: String;
 }
 export declare class Logger {
     private readonly namespace;
@@ -23,8 +24,10 @@ export declare class Logger {
     warnFromError(action: string, error: unknown, data?: unknown): void;
     timer(): Timer;
     private log;
+    private getBaseLogFields;
     private shortenStackTrace;
     private shortenData;
     private getErrorDetails;
+    private getBaseErrorDetails;
     private getAxiosErrorDetails;
 }

package/dist/logger/logger.js

@@ -7,7 +7,8 @@ const DATA_LIMIT = 3000;
 const timer_1 = require("../timer/timer");
 const json_1 = require("../formatter/json");
 const console_1 = require("../output/console");
-const allowedKeys = ['output', 'formatter', 'transformers'];
+const lodash_1 = require("lodash");
+const allowedKeys = ['output', 'formatter', 'transformers', 'outputFormat'];
 class Logger {
     constructor(namespace, enabled) {
         this.namespace = namespace;
@@ -20,7 +21,7 @@ class Logger {
     static validate(options) {
         Object.keys(options).forEach((key) => {
             if (!allowedKeys.includes(key)) {
-                throw new Error('Only the following keys are allowed: formatter, output');
+                throw new Error('Only the following keys are allowed: ' + allowedKeys);
             }
         });
     }
@@ -46,7 +47,7 @@ class Logger {
         this.log('fatal', action, data);
     }
     customError(severity, action, error, data = {}) {
-        this.log(severity, action, Object.assign(this.getErrorDetails(error), data));
+        this.log(severity, action, (0, lodash_1.merge)(this.getErrorDetails(error), data));
     }
     fromError(action, error, data = {}) {
         this.customError('error', action, error, data);
@@ -61,17 +62,32 @@ class Logger {
         if (!this.enabled) {
             return;
         }
-        let dataToLog = Object.assign({
-            name: this.namespace,
-            action: action,
-            level: config_1.config.levels[level].number,
-            time: new Date().toISOString(),
-        }, data);
+        let dataToLog = (0, lodash_1.merge)(this.getBaseLogFields(level, action), data);
         Logger.config.transformers.forEach((transform) => {
             dataToLog = transform(dataToLog);
         });
         Logger.config.output(Logger.config.formatter(dataToLog));
     }
+    getBaseLogFields(level, action) {
+        if (Logger.config.outputFormat === 'legacy') {
+            return {
+                name: this.namespace,
+                action: action,
+                level: config_1.config.levels[level].number,
+                time: new Date().toISOString(),
+            };
+        }
+        return {
+            '@timestamp': new Date().toISOString(),
+            event: {
+                action: action,
+            },
+            log: {
+                logger: this.namespace,
+                level: config_1.config.levels[level].number,
+            },
+        };
+    }
     shortenStackTrace(stack) {
         if (!stack) {
             return;
@@ -89,24 +105,54 @@ class Logger {
         if (!(error instanceof Object)) {
             return {};
         }
-        const baseDetails = {
-            error_name: error.name,
-            error_stack: this.shortenStackTrace(error.stack || ''),
-            error_message: error.message,
-            error_data: this.shortenData(error.data),
+        return (0, lodash_1.merge)(this.getBaseErrorDetails(error), this.getAxiosErrorDetails(error));
+    }
+    getBaseErrorDetails(error) {
+        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),
+            };
+        }
+        return {
+            error: {
+                type: error.name,
+                message: error.message,
+                context: this.shortenData(error.data),
+                stack_trace: this.shortenStackTrace(error.stack || ''),
+            },
         };
-        return Object.assign(baseDetails, this.getAxiosErrorDetails(error));
     }
     getAxiosErrorDetails(error) {
         if (!error.isAxiosError) {
             return {};
         }
+        if (Logger.config.outputFormat === 'legacy') {
+            return {
+                request_method: error.config.method,
+                request_url: error.config.url,
+                response_status: error.response ? error.response.status : undefined,
+                response_status_text: error.response ? error.response.statusText : undefined,
+                response_data: error.response ? this.shortenData(error.response.data) : undefined,
+            };
+        }
         return {
-            request_method: error.config.method,
-            request_url: error.config.url,
-            response_status: error.response ? error.response.status : undefined,
-            response_status_text: error.response ? error.response.statusText : undefined,
-            response_data: error.response ? this.shortenData(error.response.data) : undefined,
+            url: {
+                full: error.config.url,
+            },
+            http: {
+                request: {
+                    method: error.config.method,
+                },
+                response: {
+                    status_code: error.response ? error.response.status : undefined,
+                    body: {
+                        content: error.response ? this.shortenData(error.response.data) : undefined,
+                    },
+                },
+            },
         };
     }
 }
@@ -115,4 +161,5 @@ Logger.config = {
     formatter: json_1.jsonFormatter,
     output: console_1.consoleOutput,
     transformers: [],
+    outputFormat: 'ecs',
 };

package/dist/timer/timer.d.ts

@@ -11,5 +11,6 @@ export declare class Timer {
     fatal(action: string, data?: unknown): void;
     fromError(action: string, error: unknown, data?: unknown): void;
     warnFromError(action: string, error: unknown, data?: unknown): void;
+    private getData;
     private duration;
 }

package/dist/timer/timer.js

@@ -1,34 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Timer = void 0;
+const logger_1 = require("../logger/logger");
+const lodash_1 = require("lodash");
 class Timer {
     constructor(logger) {
         this.logger = logger;
         this.start = new Date().getTime();
     }
     trace(action, data = {}) {
-        this.logger.trace(action, Object.assign({ duration: this.duration() }, data));
+        this.logger.trace(action, this.getData(data));
     }
     debug(action, data = {}) {
-        this.logger.debug(action, Object.assign({ duration: this.duration() }, data));
+        this.logger.debug(action, this.getData(data));
     }
     info(action, data = {}) {
-        this.logger.info(action, Object.assign({ duration: this.duration() }, data));
+        this.logger.info(action, this.getData(data));
     }
     warn(action, data = {}) {
-        this.logger.warn(action, Object.assign({ duration: this.duration() }, data));
+        this.logger.warn(action, this.getData(data));
     }
     error(action, data = {}) {
-        this.logger.error(action, Object.assign({ duration: this.duration() }, data));
+        this.logger.error(action, this.getData(data));
     }
     fatal(action, data = {}) {
-        this.logger.fatal(action, Object.assign({ duration: this.duration() }, data));
+        this.logger.fatal(action, this.getData(data));
     }
     fromError(action, error, data = {}) {
-        this.logger.fromError(action, error, Object.assign({ duration: this.duration() }, data));
+        this.logger.fromError(action, error, this.getData(data));
     }
     warnFromError(action, error, data = {}) {
-        this.logger.warnFromError(action, error, Object.assign({ duration: this.duration() }, data));
+        this.logger.warnFromError(action, error, this.getData(data));
+    }
+    getData(data) {
+        if (logger_1.Logger.config.outputFormat === 'legacy') {
+            return Object.assign({ duration: this.duration() }, data);
+        }
+        return (0, lodash_1.merge)({ event: { duration: this.duration() } }, data);
     }
     duration() {
         const end = new Date().getTime();

package/package.json

@@ -28,6 +28,7 @@
   ],
   "devDependencies": {
     "@types/chai": "4.3.3",
+    "@types/lodash": "4.14.198",
     "@types/mocha": "10.0.0",
     "@types/node": "18.7.23",
     "@types/sinon": "10.0.13",
@@ -60,5 +61,8 @@
     "url": "https://github.com/emartech/json-logger-js/issues"
   },
   "homepage": "https://github.com/emartech/json-logger-js#readme",
-  "version": "7.2.3"
+  "dependencies": {
+    "lodash": "4.17.21"
+  },
+  "version": "8.0.0"
 }

package/repo-info.json

@@ -0,0 +1,7 @@
+{
+   "is_in_production": true,
+   "is_scannable": true,
+   "is_critical": false,
+   "contact": "guild-javascript@emarsys.com",
+   "hosted": null
+}