@emartech/json-logger 5.0.2 → 6.0.0

package/README.md

@@ -11,10 +11,13 @@ npm install @emartech/json-logger
 
 ### Usage
 
+#### Script
+
 ```javascript
 process.env.DEBUG = 'redis';
-const mongoLogger = require('@emartech/json-logger')('mongo');
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+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"}
@@ -26,6 +29,47 @@ 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"}
 ```
 
+#### Class
+
+```javascript
+const { createLogger } = require('@emartech/json-logger');
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+```typescript
+import { createLogger } from '@emartech/json-logger';
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+#### Tests
+
+```javascript
+import { Logger } from '@emartech/json-logger';
+
+describe('Exporter', () => {
+  it('should log', () => {
+    jest.spyOn(Logger.prototype, 'info').mockReturnValue();
+    const exporter = new Exporter();
+    
+    exporter.export();
+
+    expect(Logger.prototype.info).toHaveBeenCalledWith('export', { customer_id: 123 });
+  })
+});
+```
+
 More examples can be found in the `examples` directory.
 
 ### API
@@ -39,11 +83,12 @@ Disabled instances output no logs.
 
 ```javascript
 process.env.DEBUG = 'redis,mysql';
+const { createLogger } = require('@emartech/json-logger');
 
-const mongoLogger = require('@emartech/json-logger')('mongo');
+const mongoLogger = createLogger('mongo');
 // mongo instance will be disabled
 
-const redisLogger = require('@emartech/json-logger')('redis');
+const redisLogger = createLogger('redis');
 // redis instance will be enabled
 ```
 
@@ -52,7 +97,8 @@ const redisLogger = require('@emartech/json-logger')('redis');
 Prints the provided data to the console in JSON format.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+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"}
@@ -92,7 +138,8 @@ The displayed line contains the stack trace, the name and the message of the err
 The log level defaults to error.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+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"}
@@ -109,7 +156,8 @@ but also logs the elapsed time in milliseconds from the creation of the instance
 The elapsed time will be logged into the `duration` field.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
 const timer = redisLogger.timer();
 
@@ -127,9 +175,9 @@ With transformers we can alter the data to be logged before passing to the forma
 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. 
 
 ```javascript
-const Logger = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 
-Logger.configure({
+createLogger.configure({
   formatter: JSON.stringify,
   output: console.log,
   transformers: []
@@ -160,11 +208,11 @@ For automating
 
 ```javascript
 const Koa = require('koa');
-const logFactory = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 const clsAdapter = require('@emartech/cls-adapter');
-const logger = logFactory('redis');
+const logger = createLogger('redis');
 
-logFactory.configure({
+createLogger.configure({
   transformers: [
     clsAdapter.addContextStorageToInput()
   ]

package/dist/index.d.ts

@@ -1,10 +1,8 @@
 import { Logger, LoggerConfig } from './logger/logger';
 export { Logger, LoggerConfig } from './logger/logger';
 export { Timer } from './timer/timer';
-export declare function logFactory(namespace: string): Logger;
-export declare namespace logFactory {
-    var Logger: typeof import("./logger/logger").Logger;
-    var Timer: typeof import("./timer/timer").Timer;
+export declare function createLogger(namespace: string): Logger;
+export declare namespace createLogger {
     var getNamespaces: () => string;
     var configure: (options: LoggerConfig) => void;
     var formatter: {
@@ -13,4 +11,3 @@ export declare namespace logFactory {
         logentries: typeof import("./formatter/logentries").logentriesFormatter;
     };
 }
-export default logFactory;

package/dist/index.js

@@ -1,26 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logFactory = exports.Timer = exports.Logger = void 0;
+exports.createLogger = exports.Timer = exports.Logger = void 0;
 const logger_1 = require("./logger/logger");
 var logger_2 = require("./logger/logger");
 Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_2.Logger; } });
-const timer_1 = require("./timer/timer");
-var timer_2 = require("./timer/timer");
-Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return timer_2.Timer; } });
+var timer_1 = require("./timer/timer");
+Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return timer_1.Timer; } });
 const enabled_1 = require("./enabled/enabled");
 const formatter_1 = require("./formatter");
-function logFactory(namespace) {
-    return new logger_1.Logger(namespace, (0, enabled_1.isNamespaceEnabled)(logFactory.getNamespaces(), namespace));
+function createLogger(namespace) {
+    return new logger_1.Logger(namespace, (0, enabled_1.isNamespaceEnabled)(createLogger.getNamespaces(), namespace));
 }
-exports.logFactory = logFactory;
-logFactory.Logger = logger_1.Logger;
-logFactory.Timer = timer_1.Timer;
-logFactory.getNamespaces = function () {
+exports.createLogger = createLogger;
+createLogger.getNamespaces = function () {
     return process.env.DEBUG || '';
 };
-logFactory.configure = function (options) {
+createLogger.configure = function (options) {
     logger_1.Logger.configure(options);
 };
-logFactory.formatter = formatter_1.formatter;
-exports.default = logFactory;
-module.exports = logFactory;
+createLogger.formatter = formatter_1.formatter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emartech/json-logger",
-  "version": "5.0.2",
+  "version": "6.0.0",
   "description": "Tiny and fast json logger with namespace support",
   "main": "dist/index.js",
   "scripts": {