feat(logger): new feature esTransformer

packages/logger/README.md

@@ -12,16 +12,18 @@ Opinionated wrapper and configurator for the
 
 The following transports are supported:
 
-- [Elasticsearch transport](https://github.com/vanthome/winston-elasticsearch) using a [specific transformer](https://github.com/restorecommerce/winston-elasticsearch-transformer) and ES data streams.
+- [Elasticsearch transport](https://github.com/vanthome/winston-elasticsearch) using a local transformer function and ES data streams.
 - Console (Winston built-in transport).
 - File (Winston built-in transport).
 
 These transports can be added and configured with a corresponding property in
 the options hash:
 
 ```json
-  "loggerName": "somelogger",   // Optional name
-  "sourcePointer": true,        // Whether the source file and line where the log statement was issued should be logged [default: `false`]
+{
+  "loggerName": "somelogger",        // Optional name
+  "sourcePointer": true,             // Whether the source file and line where the log statement was issued should be logged [default: `false`]
+  "esTransformer": function()  //
   "console": {
     "handleExceptions": false,
     "level": "silly",
@@ -34,6 +36,7 @@ the options hash:
   "elasticsearch": {
     ...
   }
+}
 ```
 
 The logger returns a Winston logger instance which has methods that correspond
@@ -54,6 +57,7 @@ In addition there is a generic `log()` function.
 - Source pointer logging -- show the source code file and line where the log statement was issued.
 - Implicit Request ID logging based on [cls-rtracer](https://github.com/puzpuzpuz/cls-rtracer).
 - Logger `AsyncLocalStorage` logger context to log implicit context information.
+- Supports local transformer function for the `fields`.
 
 An example how to use the `AsyncLocalStorage` logger context can be found [here](test/test.js#L4-L11).
 

packages/logger/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/logger",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Opinionated wrapper and configurator for the winston logging toolkit",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -20,18 +20,18 @@
     "cls-rtracer": "^2.6.0",
     "source-map-support": "^0.5.19",
     "winston": "^3.3.3",
-    "winston-elasticsearch": "^0.15.7"
+    "winston-elasticsearch": "^0.15.8"
   },
   "devDependencies": {
     "@types/jest": "^26.0.24",
-    "@types/node": "^16.3.2",
+    "@types/node": "^16.4.2",
     "@types/should": "^13.0.0",
     "coveralls": "^3.1.1",
     "jest": "^27.0.6",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
-    "ts-jest": "^27.0.3",
+    "ts-jest": "^27.0.4",
     "tslint": "^6.1.3",
     "typescript": "^4.3.5"
   },

packages/logger/src/elasticsearch.ts

@@ -49,12 +49,29 @@ function createTransformer(opts: RestoreLoggerElasticsearchTransportOptions) {
     if (typeof transformed.fields !== 'object') {
       transformed.fields = { 0: transformed.fields };
     }
+
+    if (opts.esTransformer && typeof opts.esTransformer === 'function') {
+      opts.esTransformer(transformed);
+    }
+
     return transformed;
   };
 }
 
+// Fields transformer to convert all values into strings
+// function toString(o: any) {
+//   Object.keys(o).forEach(k => {
+//     if (typeof o[k] === 'object') {
+//       return toString(o[k]);
+//     }
+//     o[k] = '' + o[k];
+//   });
+//   return o;
+// }
+
 export interface RestoreLoggerElasticsearchTransportOptions extends ElasticsearchTransportOptions {
   sourcePointer?: any;
+  esTransformer?: Function;
 }
 
 export function createElasticSearchTransport(opts: RestoreLoggerElasticsearchTransportOptions) {

packages/logger/src/index.ts

@@ -35,7 +35,11 @@ export function createLogger(opts: RestoreLoggerOptions = {}) {
   }
   if (opts.elasticsearch) {
     opts.elasticsearch.dataStream = true;
-    transports.push(createElasticSearchTransport({ ...opts.elasticsearch, sourcePointer: opts.sourcePointer }));
+    const esTransport = createElasticSearchTransport({ ...opts.elasticsearch, sourcePointer: opts.sourcePointer });
+    esTransport.on('error', (error) => {
+      console.error('Elasticsearch indexing error', error);
+    });
+    transports.push(esTransport);
   }
   if (transports.length === 0) {
     transports.push(createConsoleTransport());
@@ -46,6 +50,10 @@ export function createLogger(opts: RestoreLoggerOptions = {}) {
     ...opts
   });
 
+  logger.on('error', (error) => {
+    console.error('Logger error', error);
+  });
+
   return logger;
 };