@mimik/sumologic-winston-logger 2.1.14 → 2.2.0

package/README.md

@@ -1,6 +1,10 @@
-<a name="config"></a>
+# @mimik/sumologic-winston-logger
 
-## config() ⇒ <code>object</code>
+Log wrapper for sumo, s3, kinesis and winston.
+
+<a name="module_configuration"></a>
+
+## configuration
 The following environment variables are used to configure the logger:
 
 | Env variable name | Description | Default | Comments |
@@ -13,7 +17,7 @@ The following environment variables are used to configure the logger:
 | FILTER_FILE | Filename containing filter rules | null |  |
 | FLUSH_EXIT_DELAY | Delay for flushing the transports and exiting | 2000 | in millisecond |
 | FLUSH_EXIT_TIMEOUT | Timeout safety net in case flush never completes | 5000 | in millisecond |
-| NO_STACK | Whether to include call stacks in all log messages | yes | expected: yes/no |
+| NO_STACK | Set to 'yes' to suppress stack info on non-error logs | yes | expected: yes/no |
 | LOG_MODE | Comma-separated list defining the log mode/backends | none | enum: awsS3, awsKinesis, sumologic, all, none |
 
 If `LOG_MODE` includes `sumologic`, the following environment variables are required:
@@ -60,15 +64,49 @@ log payload for S3 and Kinesis.
 If `globalThis.serverType` is set, it overrides `SERVER_TYPE`.
 If `globalThis.serverId` is set, it overrides `SERVER_ID`.
 
-**Kind**: global function  
-**Returns**: <code>object</code> - configuration - Logger configuration.  
+
+* [configuration](#module_configuration)
+    * [~checkConfig(config)](#module_configuration..checkConfig)
+    * [~checkMode(mode)](#module_configuration..checkMode) ⇒ <code>Array.&lt;string&gt;</code> \| <code>null</code>
+
+<a name="module_configuration..checkConfig"></a>
+
+### configuration~checkConfig(config)
+Validates that no property in the configuration tree is undefined.
+
+**Kind**: inner method of [<code>configuration</code>](#module_configuration)  
+**Throws**:
+
+- <code>Error</code> If any property value is undefined.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| config | <code>object</code> | The configuration object to validate. |
+
+<a name="module_configuration..checkMode"></a>
+
+### configuration~checkMode(mode) ⇒ <code>Array.&lt;string&gt;</code> \| <code>null</code>
+Parses and validates the LOG_MODE string.
+
+**Kind**: inner method of [<code>configuration</code>](#module_configuration)  
+**Returns**: <code>Array.&lt;string&gt;</code> \| <code>null</code> - Array of validated mode strings, or null if mode is falsy.  
+**Throws**:
+
+- <code>Error</code> If the mode string contains invalid values.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| mode | <code>string</code> \| <code>undefined</code> | Comma-separated list of log modes. |
+
 
 ## Synopsis ##
 
 Sumologic-Winston-Logger is a log wrapper that can write to multiple logging services.
 Currently, Winston, SumoLogic, AWS Kinesis and AWS S3 are supported.
 The package also adds stackTrace info.
-StackTrace information is included in all log entries. For error-level logs, the full stack trace is added. For other log levels, method name, file name, and line number are appended.  **Line formatting is not currently configurable.**
+StackTrace information is included in all log entries. For error-level logs, the full stack trace is added. For other log levels, method name, file name, and line number are appended. **Line formatting is not currently configurable.**
 The package also allows some level of filtering.
 
 ## Motivation ##
@@ -118,11 +156,11 @@ The collector code as defined in SumoLogic. The Collector Code is the Base64 str
 |`export SUMO_LOGIC_COLLECTOR_CODE=AhfheisdcOllectorCodeInSumoLogicuZw==`|
 
 
-To learn more about setting this environment variable, see the section,  _Finding SumoLogic endpoint and collector code_, below.
+To learn more about setting this environment variable, see the section, _Finding SumoLogic endpoint and collector code_, below.
 
 #### Finding SumoLogic endpoint and collector code ####
 
-To find the values that you will apply the environment variables, `SUMO_LOGIC_ENDPOINT` and `SUMO_LOGIC_COLLECTOR_CODE`, in the SumoLogic Control Panel, goto: Manage > Collection, and get the source category 
+To find the values that you will apply the environment variables, `SUMO_LOGIC_ENDPOINT` and `SUMO_LOGIC_COLLECTOR_CODE`, in the SumoLogic Control Panel, goto: Manage > Collection, and get the source category
 
 ![Screen Shot 2016-10-10 at 2.03.31 PM.png](https://bitbucket.org/repo/xbXGRo/images/3258406172-Screen%20Shot%202016-10-10%20at%202.03.31%20PM.png)
 
@@ -137,7 +175,7 @@ To find the values that you will apply the environment variables, `SUMO_LOGIC_EN
 
 **Figure 3: The HTTP Source Address dialog shows collector's URL. The collector code is a Base64 string appended after the last slash in the Source Address URL**
 
-The endpoint is the part of the url that ends with a slash.  i.e.
+The endpoint is the part of the url that ends with a slash. i.e.
 `https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/`
 
 The collector code is the Base64 encoded part of the URL that follows the last slash in the url.
@@ -145,7 +183,7 @@ The collector code is the Base64 encoded part of the URL that follows the last s
 ### `FILTER_FILE` ###
 
 FILTER_FILE is the location where the definition of the filtering configuration is. The location has to be a full file name.
-When the environment (NODE_ENV) in which the logger is used is `prod` or `production`, the content of the log will be filtered according to the log filtering configuration included in the file referred by the FILTER_FILE variable. 
+When a `FILTER_FILE` is specified, the content of the log will be filtered according to the log filtering configuration included in the file referred by the FILTER_FILE variable.
 The filter will replace values of the designated property names to '-----'.
 
 ## Sample Use ##
@@ -157,9 +195,10 @@ Formatting console logs is left to winston, except that some stackTrace info is
 Formatting of SumoLogic logs is handled by this module in the following ways:
 
 * only the first argument is used as the message
-* only one object can be passed as parameter
+* one metadata object can be passed as a parameter; its properties are included in the log entry
 * structured stackTrace info is added to every log except when NO_STACK is set to 'yes'
 * if the last parameter is a string it will be considered as a `correlationId`
+* if the last parameter is a plain object **and** there is already an earlier metadata object, its properties are merged into the log entry at the top level (alongside `serverType`/`serverId`) — this is the _extra fields_ feature
 
 
 ### Logging Examples ###
@@ -177,9 +216,14 @@ logger.info('this is an info statement', { meta: 'data' });
 logger.verbose('this is a verbose statement');
 logger.silly('this is a silly statement o_O');
 logger.debug('this is a debug statement with 2 params', { meta: 'data' });
-logger.debug('this is a debug statement with 2 params and a correlationId',  { meta: 'data' }, '123456')
+logger.debug('this is a debug statement with 2 params and a correlationId', { meta: 'data' }, '123456');
+
+// Extra fields — the trailing plain object is merged into the log entry at the top level.
+// Works with or without a correlationId.
+logger.info('this is an info statement with extra fields', { meta: 'data' }, { type: 'myService' });
+logger.info('this is an info statement with extra fields and a correlationId', { meta: 'data' }, '123456', { type: 'myService', version: '1.0' });
 ```
-**Listing 2: Examples of using the logger to make a log entry, using the log levels, log, silly, verbose, debug, info, warn, and error** 
+**Listing 2: Examples of using the logger to make a log entry, using the log levels, log, silly, verbose, debug, info, warn, and error**
 
 By default, log entries are logged to console.
 The log() method is also supported, and adds a level parameter in position 1.
@@ -194,9 +238,19 @@ To trail in SumoLogic go to Search > Live Tail in the SumoLogic user interface a
 |---|
 |`sourceCategory=local/node/challengeAPI/logs`|
 
+### Logger API ###
+
+In addition to the standard Winston log methods (`error`, `warn`, `info`, `verbose`, `debug`, `silly`), the logger exposes the following:
+
+| Property / Method | Description |
+| --- | --- |
+| `logger.LEVELS` | Array of supported log levels in severity order: `['error', 'warn', 'info', 'verbose', 'debug', 'silly']` |
+| `logger.flush()` | Flushes all active transports (SumoLogic, S3, Kinesis). Completes asynchronously after the configured `FLUSH_EXIT_DELAY`. |
+| `logger.flushAndExit(code)` | Flushes all active transports and then calls `process.exit(code)`. A safety-net timer (`FLUSH_EXIT_TIMEOUT`) ensures the process exits even if a transport never responds. |
+
 ### Stack Trace ###
 All calls to `error()` include the stack trace.
-All other log levels will include a line number and file name.
+When `NO_STACK` is not set to `'yes'` and the environment is development or local, other log levels will include a line number and file name.
 
 ## License ##
 MIT

package/configuration/config.js

@@ -17,8 +17,7 @@ import { readFileSync } from 'node:fs';
  *
  * Logger configuration.
  *
- * @function config
- * @return {object} configuration - Logger configuration.
+ * @module configuration
  * @description The following environment variables are used to configure the logger:
  *
  * | Env variable name | Description | Default | Comments |
@@ -31,7 +30,7 @@ import { readFileSync } from 'node:fs';
  * | FILTER_FILE | Filename containing filter rules | null |  |
  * | FLUSH_EXIT_DELAY | Delay for flushing the transports and exiting | 2000 | in millisecond |
  * | FLUSH_EXIT_TIMEOUT | Timeout safety net in case flush never completes | 5000 | in millisecond |
- * | NO_STACK | Whether to include call stacks in all log messages | yes | expected: yes/no |
+ * | NO_STACK | Set to 'yes' to suppress stack info on non-error logs | yes | expected: yes/no |
  * | LOG_MODE | Comma-separated list defining the log mode/backends | none | enum: awsS3, awsKinesis, sumologic, all, none |
  *
  * If `LOG_MODE` includes `sumologic`, the following environment variables are required:
@@ -79,6 +78,12 @@ import { readFileSync } from 'node:fs';
  * If `globalThis.serverId` is set, it overrides `SERVER_ID`.
  */
 
+/**
+ * Validates that no property in the configuration tree is undefined.
+ *
+ * @param {object} config - The configuration object to validate.
+ * @throws {Error} If any property value is undefined.
+ */
 const checkConfig = (config) => {
   const errs = [];
 
@@ -97,6 +102,13 @@ const checkConfig = (config) => {
   }
 };
 
+/**
+ * Parses and validates the LOG_MODE string.
+ *
+ * @param {string|undefined} mode - Comma-separated list of log modes.
+ * @returns {string[]|null} Array of validated mode strings, or null if mode is falsy.
+ * @throws {Error} If the mode string contains invalid values.
+ */
 const checkMode = (mode) => {
   let logMode = null;
 

package/index.js

@@ -10,6 +10,7 @@ import {
 } from './lib/common.js';
 import {
   correlationId,
+  extraFields,
   filterMeta,
   stackInfo,
 } from './lib/formatLib.js';
@@ -42,6 +43,7 @@ const logger = createLogger({
   format: format.combine(
     filterMeta({ env: config.env, config: config.filter.config }),
     format.metadata(),
+    extraFields(),
     stackInfo({ env: config.env, noStack: config.noStack }),
     correlationId(),
   ),

package/lib/awsKinesisTransport.js

@@ -73,7 +73,7 @@ export default class AwsKinesis extends Transport {
           events[level].size = 0;
         }
       });
-    }, this.timeInterval);
+    }, this.timeInterval).unref();
   }
 
   put(Records, lvl) {
@@ -103,13 +103,14 @@ export default class AwsKinesis extends Transport {
   flushEvent() {
     return Promise.all(Object.keys(events).map((level) => {
       if (events[level].Records.length) {
-        return this.put(events[level].Records, level)
+        const failedRecords = events[level].Records;
+        return this.put(failedRecords, level)
           .then(() => {
             events[level].Records = []; // we may lose some logs due to concurrency issues
             events[level].size = 0;
           })
           .catch(err => this.emit(WARN, {
-            data: events[level].Records,
+            data: failedRecords,
             message: `could not log to ${AWS_KINESIS}`,
             error: { message: err.message, statusCode: err.statusCode || SYSTEM_ERROR, details: err },
           }));
@@ -124,7 +125,7 @@ export default class AwsKinesis extends Transport {
     let { level } = info;
     const { serverType } = globalThis;
     let { serverId } = globalThis;
-    const data = { ...info };
+    const data = Object.fromEntries(Object.entries(info));
 
     if (serverType) {
       if (!serverId) serverId = `${UNKNOWN_ID}${CLIENTS}`;

package/lib/awsS3Transport.js

@@ -62,7 +62,7 @@ export default class AwsS3 extends Transport {
           typeEvents[level].nbEvents = 0;
         }
       });
-    }, this.timeInterval);
+    }, this.timeInterval).unref();
   }
 
   put(data, lvl, date) {
@@ -184,7 +184,7 @@ export default class AwsS3 extends Transport {
     const { level } = info;
     const { serverType } = globalThis;
     let { serverId } = globalThis;
-    const data = { ...info };
+    const data = Object.fromEntries(Object.entries(info));
 
     if (serverType) {
       if (!serverId) serverId = `${UNKNOWN_ID}${CLIENTS}`;

package/lib/common.js

@@ -65,6 +65,7 @@ export {
   AWS_KINESIS,
   AWS_S3,
   CLIENTS,
+  DECIMAL,
   DEBUG_LEVEL,
   ENV_DEV,
   ENV_LOCAL,

package/lib/formatLib.js

@@ -1,4 +1,5 @@
 import {
+  DECIMAL,
   ENV_DEV,
   ENV_LOCAL,
   LEVEL,
@@ -10,6 +11,7 @@ import { logs } from '@mimik/lib-filters';
 import { parseStack } from './stackLib.js';
 
 const INDEX_ADJUST = 1;
+const MIN_EXTRA_FIELDS_ARGS = 2;
 
 const isReserved = (value) => {
   if (value === LEVEL || value === 'level') return true;
@@ -49,8 +51,7 @@ const correlationId = format((origInfo) => {
 
     ([info.correlationId, info.step] = resultsSteps);
   }
-  else info.step = undefined;
-  if (info.step) info.step = parseInt(info.step, 10);
+  if (info.step) info.step = parseInt(info.step, DECIMAL);
   return info;
 });
 
@@ -99,8 +100,33 @@ const filterMeta = format((origInfo, opts) => {
   return info;
 });
 
+const extraFields = format((origInfo) => {
+  const info = { ...origInfo };
+  const meta = info[SPLAT] ? [...info[SPLAT]] : undefined;
+
+  if (!meta || meta.length < MIN_EXTRA_FIELDS_ARGS) return info;
+
+  const last = meta[meta.length - 1];
+  if (typeof last !== 'object' || last === null || Array.isArray(last)) return info;
+
+  const hasOtherObject = meta.slice(0, -1).some(
+    item => typeof item === 'object' && item !== null && !Array.isArray(item),
+  );
+  if (!hasOtherObject) return info;
+
+  Object.entries(last).forEach(([key, value]) => {
+    if (!isReserved(key)) {
+      info[key] = value;
+    }
+  });
+
+  info[SPLAT] = meta.slice(0, -1);
+  return info;
+});
+
 export {
   stackInfo,
   correlationId,
+  extraFields,
   filterMeta,
 };

package/lib/stackLib.js

@@ -2,7 +2,7 @@ import { basename } from 'node:path';
 import { createHash } from 'node:crypto';
 import { fileURLToPath } from 'node:url';
 
-// Stack trace format :
+// Stack trace format:
 // https://github.com/v8/v8/wiki/Stack%20Trace%20API
 // these regexes are used to pull out the parts of the stack trace like method name, line number, etc.
 const STACKREG = /at\s+(?<method>.*)\s+\((?<path>.*):(?<line>\d*):(?<position>\d*)\)/iu;
@@ -34,20 +34,16 @@ const parseStack = (newError) => {
   const stackParts = STACKREG.exec(firstLine) || STACKREG2.exec(firstLine);
 
   if (!stackParts || stackParts.length !== ALL_STACK) return null;
-  const stackInfo = {
+  const stack = `${SHIFT}${truncatedList.join('\n').trimStart()}`;
+  return {
     method: stackParts[METHOD],
     path: stackParts[PATH],
     line: stackParts[LINE],
     pos: stackParts[POSITION],
     file: basename(stackParts[PATH]),
-    stack: `${SHIFT}${truncatedList.join('\n').trimStart()}`,
+    stack,
+    hash: createHash('sha256').update(stack).digest('hex'),
   };
-  stackInfo.hash = createHash('sha256')
-    .update(stackInfo.stack)
-    .digest('hex');
-  // this is a hash of the stack trace for easier searching for the stack trace
-  // security of this is not a concern since the stack trace is also sent unencrypted
-  return stackInfo;
 };
 
 export {

package/lib/sumologicTransport.js

@@ -28,7 +28,8 @@ export default class Sumo extends Transport {
   log(info, callback) {
     const { serverType } = globalThis;
     let { serverId } = globalThis;
-    const data = { ...info };
+    const splatArgs = info[SPLAT];
+    const data = Object.fromEntries(Object.entries(info));
 
     if (serverType) {
       if (!serverId) serverId = `${UNKNOWN_ID}${CLIENTS}`;
@@ -51,8 +52,8 @@ export default class Sumo extends Transport {
         const resp = { endpoint: this.endpoint, data, message: `could not log to ${SUMOLOGIC}` };
 
         if (data.correlationId) resp.correlationId = data.correlationId;
-        else if (data[SPLAT] && Array.isArray(data[SPLAT])) {
-          const last = data[SPLAT][data[SPLAT].length - 1];
+        else if (splatArgs && Array.isArray(splatArgs)) {
+          const last = splatArgs[splatArgs.length - 1];
 
           if (typeof last === 'string') resp.correlationId = last;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "2.1.14",
+  "version": "2.2.0",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "./index.js",
   "type": "module",
@@ -10,7 +10,7 @@
   },
   "scripts": {
     "lint": "eslint . --no-error-on-unmatched-pattern",
-    "docs": "jsdoc2md configuration/config.js > README.md && cat README_Supplement.md >> README.md",
+    "docs": "jsdoc2md --template docs/README.hbs configuration/config.js > README.md",
     "test": "mocha --reporter mochawesome --bail --exit --check-leaks --global serverType,serverId test/logger.spec.js test/loggerProd.spec.js",
     "test-ci": "c8 --reporter=lcov --reporter=text npm test",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
@@ -32,29 +32,30 @@
   },
   "dependencies": {
     "@mimik/lib-filters": "^2.0.7",
-    "@aws-sdk/client-s3": "3.998.0",
-    "@aws-sdk/client-kinesis": "3.998.0",
-    "@smithy/node-http-handler": "4.4.12",
-    "axios": "1.13.5",
+    "@aws-sdk/client-s3": "3.1006.0",
+    "@aws-sdk/client-kinesis": "3.1006.0",
+    "@smithy/node-http-handler": "4.4.14",
+    "axios": "1.13.6",
     "winston": "3.19.0",
     "winston-transport": "4.9.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.2",
+    "@eslint/js": "9.39.4",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
+    "@mimik/eslint-plugin-logger": "^1.0.2",
     "@mimik/request-helper": "^2.0.5",
-    "@stylistic/eslint-plugin": "5.9.0",
+    "@stylistic/eslint-plugin": "5.10.0",
     "aws-sdk-client-mock": "4.1.0",
     "c8": "11.0.0",
     "chai": "6.2.2",
-    "eslint": "9.39.2",
+    "eslint": "9.39.4",
     "eslint-plugin-import": "2.32.0",
     "express": "5.2.1",
-    "globals": "17.3.0",
+    "globals": "17.4.0",
     "husky": "9.1.7",
     "jsdoc-to-markdown": "9.1.3",
     "mocha": "11.7.5",
     "mochawesome": "7.1.4",
-    "sinon": "21.0.1"
+    "sinon": "21.0.2"
   }
 }

package/.claude/settings.local.json

@@ -1,10 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npx mocha:*)",
-      "Bash(done)",
-      "Bash(npm test)",
-      "Bash(git status -u)"
-    ]
-  }
-}

package/.husky/pre-commit

@@ -1,2 +0,0 @@
-#!/bin/sh
-npm run commit-ready

package/.husky/pre-push

@@ -1,2 +0,0 @@
-#!/bin/sh
-npm run test

package/README_Supplement.md

@@ -1,138 +0,0 @@
-
-## Synopsis ##
-
-Sumologic-Winston-Logger is a log wrapper that can write to multiple logging services.
-Currently, Winston, SumoLogic, AWS Kinesis and AWS S3 are supported.
-The package also adds stackTrace info.
-StackTrace information is included in all log entries. For error-level logs, the full stack trace is added. For other log levels, method name, file name, and line number are appended.  **Line formatting is not currently configurable.**
-The package also allows some level of filtering.
-
-## Motivation ##
-To centralize logging in a single npm node package
-
-## Installation ##
-
-The logger is discoverable on npmjs.org.
-
-To install:
-```
-npm install @mimik/sumologic-winston-logger --save
-```
-
-## Configuration - Details ##
-
-The following sections describe the details of each of the environment variables listed above.
-
-### `LOG_LEVEL` ###
-Log levels supported inclusively according to the following list, as borrowed from winston:
-
-* silly
-* verbose
-* debug
-* info
-* warn
-* error
-
-Thus, if one declares a log level of silly, the levels error, warn, info, debug, and verbose are reported too.
-
-|Example to set the environment variable `LOG_LEVEL`|
-|---|
-|`export LOG_LEVEL=error`|
-
-### `SUMO_LOGIC_ENDPOINT` ###
-The endpoint defined in SumoLogic to where log information will be sent. See the section, _Finding SumoLogic endpoint and collector code_, below to find the value to assign to this environment variable.
-
-|Example to set the environment variable `SUMO_LOGIC_ENDPOINT`|
-|---|
-|`export SUMO_LOGIC_ENDPOINT=https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/`|
-
-### `SUMO_LOGIC_COLLECTOR_CODE` ###
-The collector code as defined in SumoLogic. The Collector Code is the Base64 string that appears after the last slash in the URL defined in the SumoLogic Control Panel.
-
-|Example to set the environment variable `SUMO_LOGIC_COLLECTOR_CODE`|
-|---|
-|`export SUMO_LOGIC_COLLECTOR_CODE=AhfheisdcOllectorCodeInSumoLogicuZw==`|
-
-
-To learn more about setting this environment variable, see the section,  _Finding SumoLogic endpoint and collector code_, below.
-
-#### Finding SumoLogic endpoint and collector code ####
-
-To find the values that you will apply the environment variables, `SUMO_LOGIC_ENDPOINT` and `SUMO_LOGIC_COLLECTOR_CODE`, in the SumoLogic Control Panel, goto: Manage > Collection, and get the source category 
-
-![Screen Shot 2016-10-10 at 2.03.31 PM.png](https://bitbucket.org/repo/xbXGRo/images/3258406172-Screen%20Shot%202016-10-10%20at%202.03.31%20PM.png)
-
-**Figure 1: Select the Manage -> Collection to display a list of collectors in force**
-
-
-![Screen Shot 2016-10-10 at 2.03.57 PM.png](https://bitbucket.org/repo/xbXGRo/images/1501199325-Screen%20Shot%202016-10-10%20at%202.03.57%20PM.png)
-
-**Figure 2: Click the link, Show URL to display the URL configuration for the given collector**
-
-![Screen Shot 2016-10-10 at 2.04.18 PM.png](https://bitbucket.org/repo/xbXGRo/images/1913524258-Screen%20Shot%202016-10-10%20at%202.04.18%20PM.png)
-
-**Figure 3: The HTTP Source Address dialog shows collector's URL. The collector code is a Base64 string appended after the last slash in the Source Address URL**
-
-The endpoint is the part of the url that ends with a slash.  i.e.
-`https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/`
-
-The collector code is the Base64 encoded part of the URL that follows the last slash in the url.
-
-### `FILTER_FILE` ###
-
-FILTER_FILE is the location where the definition of the filtering configuration is. The location has to be a full file name.
-When the environment (NODE_ENV) in which the logger is used is `prod` or `production`, the content of the log will be filtered according to the log filtering configuration included in the file referred by the FILTER_FILE variable. 
-The filter will replace values of the designated property names to '-----'.
-
-## Sample Use ##
-
-The intent of this package is to support all the behavior common to console.log while also including support of multiple arguments and all data types.
-
-Formatting console logs is left to winston, except that some stackTrace info is appended to each line.
-
-Formatting of SumoLogic logs is handled by this module in the following ways:
-
-* only the first argument is used as the message
-* only one object can be passed as parameter
-* structured stackTrace info is added to every log except when NO_STACK is set to 'yes'
-* if the last parameter is a string it will be considered as a `correlationId`
-
-
-### Logging Examples ###
-Listing 2 below shows you how to declare a logger to run under ECMAScript 6 and then log using the various log levels supported by the Sumologic-Winston-Logger.
-
-``` javascript
-import logger from '@mimik/sumologic-winston-logger';
-
-logger.log('debug', 'this is a debug statement using log');
-logger.debug({ message: 'this is a debug statement using an object'});
-logger.error('this is an error statement');
-logger.error(new Error('this is an error statement'));
-logger.warn('this is a warning statement', { meta: 'data' });
-logger.info('this is an info statement', { meta: 'data' });
-logger.verbose('this is a verbose statement');
-logger.silly('this is a silly statement o_O');
-logger.debug('this is a debug statement with 2 params', { meta: 'data' });
-logger.debug('this is a debug statement with 2 params and a correlationId',  { meta: 'data' }, '123456')
-```
-**Listing 2: Examples of using the logger to make a log entry, using the log levels, log, silly, verbose, debug, info, warn, and error** 
-
-By default, log entries are logged to console.
-The log() method is also supported, and adds a level parameter in position 1.
-
-### Tailing ###
-
-Tailing allows you to scroll through log output in real time. You can trail log data in SumoLogic.
-
-To trail in SumoLogic go to Search > Live Tail in the SumoLogic user interface and enter `sourceCategory=<source category>` in the search bar, where `<source category>` is the log you want to trail. Then click, Run
-
-|Example|
-|---|
-|`sourceCategory=local/node/challengeAPI/logs`|
-
-### Stack Trace ###
-All calls to `error()` include the stack trace.
-All other log levels will include a line number and file name.
-
-## License ##
-MIT