@mimik/sumologic-winston-logger 1.2.1 → 1.6.7

package/.eslintrc

@@ -1,21 +1,33 @@
-// Use this file as a starting point for your project's .eslintrc.
-// Copy this file, and add rule overrides as needed.
 {
+  "plugins": [
+    "@mimik/document-env",
+    "@mimik/dependencies"
+  ],
   "env": {
     "node": true
   },
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
   "extends": "airbnb",
   "rules": {
+    "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
+    "import/no-unresolved": ["error", { "amd": true, "commonjs": true, "caseSensitiveStrict": true }],
     "brace-style": [1, "stroustrup", {"allowSingleLine": true}],
     "no-confusing-arrow": [0], // arrow isnt confusing
     "max-len": [1, 180, { "ignoreComments": true }],
     "linebreak-style": 0,
     "quotes": [1, "single"],
-    "semi": [1, "always"]
+    "semi": [1, "always"],
+    "no-process-env": ["error"],
+    "@mimik/document-env/validate-document-env": 2,
+    "@mimik/dependencies/case-sensitive": 2,
+    "@mimik/dependencies/no-cycles": 2,
+    "@mimik/dependencies/require-json-ext": 2
   },
   "settings":{
     "react": {
-      "version": "latest"
+      "version": "detect"
     }
   },
   "globals": {

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run commit-ready

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run test

package/README.md

@@ -1,164 +0,0 @@
-## Synopsis ##
-
-Sumologic-Winston-Logger is a log wrapper that can write to multiple logging services.
-Currently, Winston, SumoLogic, and AWS S2 are supported.
-The package also adds strackTrace info.
-StackTrace information gets tacked on to Sumologic calls, In addition and method, module, and line info or
-concatenated is added to the end of winston lines.  **Line formatting is not currently configrable.**
-The package also allow 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 sumologic-winston-logger --save
-
-## Configuration - Environment Variables: ##
-
-The logger expects certain environment variables to be present in order to be operational. If they environment variables are not set, the logger will not load.
-
-The expected environment variables are:
-
-* `LOG_LEVEL`
-* `LOG_MODE`
-* `SUMO_LOGIC_ENDPOINT`
-* `SUMO_LOGIC_COLLECTOR_CODE`
-* `CONSOLE_LEVEL`
-* `FILTER_FILE`
-* `S3_AWS_ACCESS_KEY_ID`
-* `S3_AWS_SECRET_ACCESS_KEY`
-* `S3_AWS_BUCKET_NAME`
-* `S3_AWS_REGION`
-* `S3_AWS_TIMEOUT`
-* `S3_AWS_MAX_SIZE`
-* `S3_AWS_MAX_EVENTS`
-* `NO_STACK`
-
-`SUMOLOGIC_xxxx` is used to set up sumologic collector.
-`S3_AWS_xxx` is used to setup S3 bucket.
-`LOG_MODE` can be set to `sumologic` to only log to sumologic collector or `awsS3` to only log to S3 bucket or `all` to log in sumologic and S3 bucket. The default is `sumologic`.
-`S3_AWS_xxx` are parameters to set when to send logs to S3 bucket. 
-* `S3_AWS_TIMEOUT` indicates in minutes that logs have to be send when timout expires, the default is `5 minutes`. 
-* `S3_AWS_MAX_SIZE` indicates the max memory size the block of logs can be before being sent to S3, the default is `5 Mb`. 
-* `S3_AWS_MAX_EVENTS` indicates the max amount of logs in a block of logs before being sent to S3, the default is `1000`.
-
-The following sections decribe 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 varible `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 varible `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 encrypted 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 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 refered by the FILTER_FILE valiable. 
-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 arguements 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 is use for message
-* only one object can be passed as parameter
-* structured stackTrace info is added to every log except is `NO_STACK` is set the 'yes'
-* if the last parameter is a string it will be considered as a `correlationId`
-
-
-### Logging Examples ###
-Listing 2 below show 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
-const logger = require('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 ###
-
-Trailing 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 logging to `error()` are added the stack trace.
-All other log levels will include a line number and file name.
-
-## License ##
-ISC

package/README_Supplement.md

@@ -0,0 +1,139 @@
+
+## 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 strackTrace info.
+StackTrace information gets tacked on to Sumologic calls, In addition and method, module, and line info or
+concatenated is added to the end of winston lines.  **Line formatting is not currently configrable.**
+The package also allow 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 sumologic-winston-logger --save
+```
+
+## Configuration - Details ##
+
+The following sections decribe 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 varible `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 varible `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 encrypted 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 refered by the FILTER_FILE valiable. 
+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 arguements 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 is use for message
+* only one object can be passed as parameter
+* structured stackTrace info is added to every log except is `NO_STACK` is set the 'yes'
+* if the last parameter is a string it will be considered as a `correlationId`
+
+
+### Logging Examples ###
+Listing 2 below show 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
+const logger = require('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 ###
+
+Trailing 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 logging to `error()` are added the stack trace.
+All other log levels will include a line number and file name.
+
+## License ##
+ISC

package/configuration/config.js

@@ -1,20 +1,87 @@
+/* eslint no-process-env: "off" */
 const _ = require('lodash');
 const fs = require('fs');
 
+/**
+ *
+ * logger Configuration.
+ *
+ * @function config
+ * @return {object} configuration - logger configuration.
+ * @description The following environment variables are needed to configure logger:
+ *
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | SERVER_TYPE | type of the server that is logged | null
+ * | SERVER_ID |id of the servier that is logged | null
+ * | NODE_ENV | environment of the running instance | local | DEFAULT_ENV
+ * | LOG_LEVEL | log level of the running instance | debug | DEFAULT_LEVEL
+ * | CONSOLE_LEVEL | log level for the console of the running instance | debug | DEFAULT_LEVEL
+ * | FILTER_FILE | filename containing filter rules | null | DEFAULT_FILTER_FILE
+ * | EXIT_DELAY | delay when existing gracefully | 2000 | DEFAULT_EXIT_DELAY in ms
+ * | NO_STACK | indicatior to log th stack on all log message | no | DEFAULT_NO_STACK
+ * | LOG_MODE | string with comma separated words defining the logmode for the running instance | sumologic | DEFAULT_SUMOLOGIC (enum: awsS3, awsKinesis, sumologic, all, none)
+ *
+ * If `LOG_MODE` includes `sumologic` the following environment variables are needed:
+ *
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | SUMO_LOGIC_ENDPOINT | url of the sumologic collector
+ * | SUMO_LOGIC_COLLECTOR_CODE | code of the sumologic collector
+ *
+ * If `LOG_MODE` includes `awsKinesis` the following environment variables are needed:
+ *
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | KINESIS_AWS_STREAM_NAME_INFO | name of the stream for info level logs
+ * | KINESIS_AWS_STREAM_NAME_ERROR | name of the stream for error level logs
+ * | KINESIS_AWS_STREAM_NAME_OTHER | name of the stream for any other level logs
+ * | KINESIS_AWS_REGION | region of the stream
+ * | KINESIS_AWS_TIMEOUT | maximum time before flushing | 1000 | DEFAULT_KINESIS_TIMEOUT in ms
+ * | KINESIS_AWS_MAX_SIZE | maximum size of the accumulated logs before flushing | 5 | DEFAULT_KINESIS_MAX_SIZE in mB
+ * | KINESIS_AWS_MAX_EVENTS | maximum number of accumulated logs before flushing | 1000 | DEFAULT_KINESIS_MAX_EVENTS
+ * | KINESIS_AWS_ACCESS_KEY_ID | access key id of the stream
+ * | KINESIS_AWS_SECRET_ACCESS_KEY | access key secret of the stream
+ *
+ * If `LOG_MODE` includes `awsS3` the following environment variables are needed:
+ *
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | S3_AWS_BUCKET_NAME | name of the bucket for storing the logs
+ * | S3_AWS_REGION | region of the bucket
+ * | S3_AWS_TIMEOUT | maximum time before flushing | 5 | DEFAULT_S3_TIMEOUT in minutes
+ * | S3_AWS_MAX_SIZE | maximum size of the accumulated logs before flushing | 5 | DEFAULT_S3_MAX_SIZE in mB
+ * | S3_AWS_MAX_EVENTS | maximum number of accumulated logs before flushing | 1000 | DEFAULT_S3_MAX_EVENTS
+ * | S3_AWS_ACCESS_KEY_ID | access key id of the bucket
+ * | S3_AWS_SECRET_ACCESS_KEY | access key secret of the bucket
+ *
+ * When `LOG_MODE` is `none` the logs will only be on `console`.
+ * When `LOG_MODE` is `all` LOG_MODE will be set to `sumologic, awsS3`.
+ *
+ * The SERVER_TYPE and SERVER_ID are used to create the S3 filename and are inserted in the payload of the log for S3 and Kinesis.
+ * If `global.serverType` is set, this value is used over SERVER_TYPE.
+ * If `global.serverType` is set, the value of `global.serverId` is used over `SERVER_ID`.
+ */
 const {
   DEFAULT_LEVEL,
   DEFAULT_ENV,
   DEFAULT_FILTER_FILE,
-  DEFAULT_MAX_SIZE,
-  DEFAULT_MAX_EVENTS,
-  DEFAULT_TIMEOUT,
+  DEFAULT_S3_MAX_SIZE,
+  DEFAULT_S3_MAX_EVENTS,
+  DEFAULT_S3_TIMEOUT,
+  DEFAULT_KINESIS_MAX_SIZE,
+  DEFAULT_KINESIS_MAX_EVENTS,
+  DEFAULT_KINESIS_TIMEOUT,
   DEFAULT_MODE,
   DEFAULT_EXIT_DELAY,
   DEFAULT_NO_STACK,
   SUMOLOGIC,
   AWS_S3,
+  AWS_KINESIS,
   ALL,
-} = require('../lib/common.js');
+  NONE,
+  ALL_MODES,
+} = require('../lib/common');
 
 const checkConfig = (config) => {
   const errs = [];
@@ -34,6 +101,19 @@ const checkConfig = (config) => {
   }
 };
 
+const checkMode = (mode) => {
+  let logMode = null;
+
+  if (mode) {
+    logMode = _.split(_.trim(mode), /\s*,\s*/);
+    if (logMode.length === 0) throw new Error('Invalid LOG_MODE: cannot be an empty array');
+    if (_.difference(logMode, ALL_MODES).length !== 0) throw new Error(`Invalid items in LOG_MODE: ${mode}`);
+    if (logMode.includes(NONE) && logMode.length !== 1) throw new Error(`Cannot have multiple modes when ${NONE} is selected`);
+    if (logMode.includes(ALL)) logMode = [SUMOLOGIC, AWS_S3]; // legacy support
+  }
+  return logMode;
+};
+
 const configuration = {
   server: {
     type: process.env.SERVER_TYPE || null,
@@ -42,32 +122,47 @@ const configuration = {
   env: process.env.NODE_ENV || DEFAULT_ENV,
   level: {
     log: process.env.LOG_LEVEL || DEFAULT_LEVEL,
-    console: process.env.CONSOLE_LEVEL || process.env.LOG_LEVEL || DEFAULT_LEVEL,
+    console: process.env.CONSOLE_LEVEL || DEFAULT_LEVEL,
   },
-  mode: process.env.LOG_MODE || DEFAULT_MODE,
   filter: {
     file: process.env.FILTER_FILE || DEFAULT_FILTER_FILE,
   },
   exitDelay: parseInt(process.env.EXIT_DELAY, 10) || DEFAULT_EXIT_DELAY, // in ms
   noStack: process.env.NO_STACK || DEFAULT_NO_STACK,
 };
+configuration.mode = checkMode(process.env.LOG_MODE) || DEFAULT_MODE;
 
-if (configuration.mode === SUMOLOGIC || configuration.mode === ALL) {
+if (configuration.mode.includes(SUMOLOGIC)) {
   configuration[SUMOLOGIC] = {
     endpoint: process.env.SUMO_LOGIC_ENDPOINT,
     code: process.env.SUMO_LOGIC_COLLECTOR_CODE,
   };
 }
-if (configuration.mode === AWS_S3 || configuration.mode === ALL) {
+if (configuration.mode.includes(AWS_KINESIS)) {
+  configuration[AWS_KINESIS] = {
+    streamNameInfo: process.env.KINESIS_AWS_STREAM_NAME_INFO,
+    streamNameError: process.env.KINESIS_AWS_STREAM_NAME_ERROR,
+    streamNameOther: process.env.KINESIS_AWS_STREAM_NAME_OTHER,
+    region: process.env.KINESIS_AWS_REGION,
+    timeout: parseInt(process.env.KINESIS_AWS_TIMEOUT, 10) || DEFAULT_KINESIS_TIMEOUT, // in ms
+    maxSize: parseInt(process.env.KINESIS_AWS_MAX_SIZE, 10) || DEFAULT_KINESIS_MAX_SIZE, // in mB
+    maxEvents: parseInt(process.env.KINESIS_AWS_MAX_EVENTS, 10) || DEFAULT_KINESIS_MAX_EVENTS,
+  };
+
+  if (!_.isNil(process.env.KINESIS_AWS_ACCESS_KEY_ID)) configuration[AWS_KINESIS].accessKeyId = process.env.KINESIS_AWS_ACCESS_KEY_ID;
+  if (!_.isNil(process.env.KINESIS_AWS_SECRET_ACCESS_KEY)) configuration[AWS_KINESIS].secretAccessKey = process.env.KINESIS_AWS_SECRET_ACCESS_KEY;
+}
+if (configuration.mode.includes(AWS_S3)) {
   configuration[AWS_S3] = {
-    accessKeyId: process.env.S3_AWS_ACCESS_KEY_ID,
-    secretAccessKey: process.env.S3_AWS_SECRET_ACCESS_KEY,
     bucketname: process.env.S3_AWS_BUCKET_NAME,
     region: process.env.S3_AWS_REGION,
-    timeout: parseInt(process.env.S3_AWS_TIMEOUT, 10) || DEFAULT_TIMEOUT, // in minutes
-    maxSize: parseInt(process.env.S3_AWS_MAX_SIZE, 10) || DEFAULT_MAX_SIZE, // in mB
-    maxEvents: parseInt(process.env.S3_AWS_MAX_EVENTS, 10) || DEFAULT_MAX_EVENTS,
+    timeout: parseInt(process.env.S3_AWS_TIMEOUT, 10) || DEFAULT_S3_TIMEOUT, // in minutes
+    maxSize: parseInt(process.env.S3_AWS_MAX_SIZE, 10) || DEFAULT_S3_MAX_SIZE, // in mB
+    maxEvents: parseInt(process.env.S3_AWS_MAX_EVENTS, 10) || DEFAULT_S3_MAX_EVENTS,
   };
+
+  if (!_.isNil(process.env.S3_AWS_ACCESS_KEY_ID)) configuration[AWS_S3].accessKeyId = process.env.S3_AWS_ACCESS_KEY_ID;
+  if (!_.isNil(process.env.S3_AWS_SECRET_ACCESS_KEY)) configuration[AWS_S3].secretAccessKey = process.env.S3_AWS_SECRET_ACCESS_KEY;
 }
 const { filter } = configuration;
 let filterConfig = [];

package/index.js

@@ -2,6 +2,7 @@ const { createLogger, format, transports } = require('winston');
 
 const Sumologic = require('./lib/sumologicTransport');
 const AwsS3 = require('./lib/awsS3Transport');
+const AwsKinesis = require('./lib/awsKinesisTransport');
 const {
   stackInfo,
   errorStack,
@@ -12,14 +13,16 @@ const config = require('./configuration/config');
 const {
   SUMOLOGIC,
   AWS_S3,
-  ALL,
+  AWS_KINESIS,
+  NONE,
   WARN,
   // LOG,
   FLUSH,
 } = require('./lib/common');
 
 let sumo;
-let aws;
+let awsS3;
+let awsKinesis;
 
 const miniLog = createLogger({
   format: format.combine(format.metadata(), correlationId(), format.timestamp(), format.prettyPrint({ colorize: true })),
@@ -31,7 +34,13 @@ const miniLog = createLogger({
 });
 
 const logger = createLogger({
-  format: format.combine(filterMeta({ env: config.env, config: config.filter.config }), errorStack(), format.metadata(), stackInfo({ env: config.env, noStack: config.noStack }), correlationId()),
+  format: format.combine(
+    filterMeta({ env: config.env, config: config.filter.config }),
+    errorStack(),
+    format.metadata(),
+    stackInfo({ env: config.env, noStack: config.noStack }),
+    correlationId(),
+  ),
   transports: [
     new transports.Console({
       level: config.level.console,
@@ -40,19 +49,20 @@ const logger = createLogger({
   ],
 });
 
-if (config.mode === SUMOLOGIC || config.mode === ALL) {
+if (config.mode.includes(SUMOLOGIC)) {
   sumo = new Sumologic({
     level: config.level.log,
     endpoint: config[SUMOLOGIC].endpoint,
     code: config[SUMOLOGIC].code,
+    serverType: config.server.type,
+    serverId: config.server.id,
   });
-
-  sumo.on(WARN, (data) => miniLog.warn('Could not send logs: ', data));
-  // sumo.on(LOG, () => console.log('sumo done')); // miniLog.info('Information sent to sumologic: ', data));
+  sumo.on(WARN, (data) => miniLog.warn('Could not send logs: ', data, data.correlationId));
+  // sumo.on(LOG, (data) => console.log('sumo done')); // miniLog.info('Information sent: ', data));
   logger.add(sumo);
 }
-if (config.mode === AWS_S3 || config.mode === ALL) {
-  aws = new AwsS3({
+if (config.mode.includes(AWS_S3)) {
+  awsS3 = new AwsS3({
     level: config.level.log,
     bucketname: config[AWS_S3].bucketname,
     region: config[AWS_S3].region,
@@ -65,33 +75,60 @@ if (config.mode === AWS_S3 || config.mode === ALL) {
     serverId: config.server.id,
     format: format.combine(format.timestamp(), format.json()),
   });
-
-  aws.on(WARN, (data) => miniLog.warn('Could not send logs: ', data));
-  // aws.on(LOG, () => console.log('aws done')); // miniLog.info('Information sent to S3: ', data));
-  logger.add(aws);
+  awsS3.on(WARN, (data) => miniLog.warn('Could not send logs: ', data));
+  // awsS3.on(LOG, (data) => console.log('awsS3 done')); // miniLog.info('Information sent : ', data));
+  logger.add(awsS3);
+}
+if (config.mode.includes(AWS_KINESIS)) {
+  awsKinesis = new AwsKinesis({
+    level: config.level.log,
+    streamNameInfo: config[AWS_KINESIS].streamNameInfo,
+    streamNameError: config[AWS_KINESIS].streamNameError,
+    streamNameOther: config[AWS_KINESIS].streamNameOther,
+    region: config[AWS_KINESIS].region,
+    accessKeyId: config[AWS_KINESIS].accessKeyId,
+    secretAccessKey: config[AWS_KINESIS].secretAccessKey,
+    serverType: config.server.type,
+    serverId: config.server.id,
+    format: format.combine(format.timestamp(), format.json()),
+  });
+  awsKinesis.on(WARN, (data) => miniLog.warn('Could not send logs: ', data));
+  // awsKinesis.on(LOG, (data) => console.log('awsKinesis done')); // miniLog.info('Information sent: ', data));
+  logger.add(awsKinesis);
 }
 
 logger.flushAndExit = (code) => {
   const flushing = () => {
     let sumoDone = false;
-    let awsDone = false;
+    let awsS3Done = false;
+    let awsKinesisDone = false;
 
-    if (aws) {
-      aws.flush();
-      aws.on(FLUSH, () => {
-        if (!sumo || sumoDone) return process.exit(code);
-        awsDone = true;
+    if (config.mode.includes(NONE)) return process.exit(code);
+    if (awsS3) {
+      awsS3.flush();
+      awsS3.on(FLUSH, () => {
+        if ((!sumo || sumoDone) && (!awsKinesis || awsKinesisDone)) return process.exit(code);
+        awsS3Done = true;
         return null;
       });
     }
     if (sumo) {
       sumo.flush();
       sumo.on(FLUSH, () => {
-        if (!aws || awsDone) return process.exit(code);
+        if ((!awsS3 || awsS3Done) && (!awsKinesis || awsKinesisDone)) return process.exit(code);
         sumoDone = true;
         return null;
       });
     }
+    if (awsKinesis) {
+      awsKinesis.flush();
+      awsKinesis.on(FLUSH, () => {
+        if ((!awsS3 || awsS3Done) && (!sumo || sumoDone)) return process.exit(code);
+        awsKinesisDone = true;
+        return null;
+      });
+    }
+    return null;
   };
 
   setTimeout(flushing, config.exitDelay);