@mimik/sumologic-winston-logger 2.1.3 → 2.1.5

package/README.md

@@ -5,15 +5,15 @@ 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 |
-| LOG_LEVEL | Log level of the running instance | debug |
-| CONSOLE_LEVEL | Log level for the console of the running instance | debug |
-| FILTER_FILE | Filename containing filter rules | null |
-| EXIT_DELAY | Delay when existing gracefully | 2000 | in millisecond
-| NO_STACK | Indicatior to log th stack on all log message | no |
-| LOG_MODE | String with comma separated words defining the logmode for the running instance | sumologic | (enum: awsS3, awsKinesis, sumologic, all, none)
+| SERVER_TYPE | Type of the server that is logged | null
+| SERVER_ID | Id of the server that is logged | null
+| NODE_ENV | Environment of the running instance | local
+| LOG_LEVEL | Log level of the running instance | debug
+| CONSOLE_LEVEL | Log level for the console of the running instance | debug
+| FILTER_FILE | Filename containing filter rules | null
+| EXIT_DELAY | Delay when exiting gracefully | 2000 | in millisecond
+| NO_STACK | Indicator to log the call stack on all log messages | no
+| LOG_MODE | String with comma separated words defining the log mode for the running instance | sumologic | (enum: awsS3, awsKinesis, sumologic, all, none)
 
 If `LOG_MODE` includes `sumologic` the following environment variables are needed:
 
@@ -32,7 +32,8 @@ If `LOG_MODE` includes `awsKinesis` the following environment variables are need
 | KINESIS_AWS_REGION | Region of the stream
 | KINESIS_AWS_TIMEOUT | Maximum time before flushing | 1000 | in millisecond
 | KINESIS_AWS_MAX_SIZE | Maximum size of the accumulated logs before flushing | 5 | in mByte
-| KINESIS_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |
+| KINESIS_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000
+| KINESIS_AWS_MAX_RETRIES | Maximum retries to connect to Kinesis | 4
 | KINESIS_AWS_ACCESS_KEY_ID | Access key id of the stream
 | KINESIS_AWS_SECRET_ACCESS_KEY | Access key secret of the stream
 | KINESIS_AWS_HTTP_OPTIONS_SOCKET_TIMEOUT | Socket timeout for the http handler | 5000 | in millisecond
@@ -46,7 +47,7 @@ If `LOG_MODE` includes `awsS3` the following environment variables are needed:
 | S3_AWS_REGION | Region of the bucket
 | S3_AWS_TIMEOUT | Maximum time before flushing | 5 | in minute
 | S3_AWS_MAX_SIZE | Maximum size of the accumulated logs before flushing | 5 | in mByte
-| S3_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |
+| S3_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000
 | S3_AWS_ACCESS_KEY_ID | Access key id of the bucket
 | S3_AWS_SECRET_ACCESS_KEY | Access key secret of the bucket
 

package/configuration/config.js

@@ -10,6 +10,7 @@ import {
   DEFAULT_KINESIS_HTTP_OPTIONS_CONNECTION_TIMEOUT,
   DEFAULT_KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT,
   DEFAULT_KINESIS_MAX_EVENTS,
+  DEFAULT_KINESIS_MAX_RETRIES,
   DEFAULT_KINESIS_MAX_SIZE,
   DEFAULT_KINESIS_TIMEOUT,
   DEFAULT_LEVEL,
@@ -29,10 +30,6 @@ import process from 'process';
 import split from 'lodash.split';
 
 const DECIMAL = 10;
-const EXISTING_ERRORS = 1;
-const NO_MODE = 0;
-const KNOWN_MODE = 0;
-const SINGLE_MODE = 1;
 
 /**
  *
@@ -44,15 +41,15 @@ const SINGLE_MODE = 1;
  *
  * | 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 |
- * | LOG_LEVEL | Log level of the running instance | debug |
- * | CONSOLE_LEVEL | Log level for the console of the running instance | debug |
- * | FILTER_FILE | Filename containing filter rules | null |
- * | EXIT_DELAY | Delay when existing gracefully | 2000 | in millisecond
- * | NO_STACK | Indicatior to log th stack on all log message | no |
- * | LOG_MODE | String with comma separated words defining the logmode for the running instance | sumologic | (enum: awsS3, awsKinesis, sumologic, all, none)
+ * | SERVER_TYPE | Type of the server that is logged | null
+ * | SERVER_ID | Id of the server that is logged | null
+ * | NODE_ENV | Environment of the running instance | local
+ * | LOG_LEVEL | Log level of the running instance | debug
+ * | CONSOLE_LEVEL | Log level for the console of the running instance | debug
+ * | FILTER_FILE | Filename containing filter rules | null
+ * | EXIT_DELAY | Delay when exiting gracefully | 2000 | in millisecond
+ * | NO_STACK | Indicator to log the call stack on all log messages | no
+ * | LOG_MODE | String with comma separated words defining the log mode for the running instance | sumologic | (enum: awsS3, awsKinesis, sumologic, all, none)
  *
  * If `LOG_MODE` includes `sumologic` the following environment variables are needed:
  *
@@ -71,7 +68,8 @@ const SINGLE_MODE = 1;
  * | KINESIS_AWS_REGION | Region of the stream
  * | KINESIS_AWS_TIMEOUT | Maximum time before flushing | 1000 | in millisecond
  * | KINESIS_AWS_MAX_SIZE | Maximum size of the accumulated logs before flushing | 5 | in mByte
- * | KINESIS_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |
+ * | KINESIS_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000
+ * | KINESIS_AWS_MAX_RETRIES | Maximum retries to connect to Kinesis | 4
  * | KINESIS_AWS_ACCESS_KEY_ID | Access key id of the stream
  * | KINESIS_AWS_SECRET_ACCESS_KEY | Access key secret of the stream
  * | KINESIS_AWS_HTTP_OPTIONS_SOCKET_TIMEOUT | Socket timeout for the http handler | 5000 | in millisecond
@@ -85,7 +83,7 @@ const SINGLE_MODE = 1;
  * | S3_AWS_REGION | Region of the bucket
  * | S3_AWS_TIMEOUT | Maximum time before flushing | 5 | in minute
  * | S3_AWS_MAX_SIZE | Maximum size of the accumulated logs before flushing | 5 | in mByte
- * | S3_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |
+ * | S3_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000
  * | S3_AWS_ACCESS_KEY_ID | Access key id of the bucket
  * | S3_AWS_SECRET_ACCESS_KEY | Access key secret of the bucket
  *
@@ -110,7 +108,7 @@ const checkConfig = (config) => {
   };
 
   traverseNodeSync(config, 'configuration');
-  if (errs.length > EXISTING_ERRORS) {
+  if (errs.length > 1) {
     throw new Error(`Missing values for ${errs}`);
   }
 };
@@ -120,9 +118,9 @@ const checkMode = (mode) => {
 
   if (mode) {
     logMode = split(mode.trim(), /\s*,\s*/u);
-    if (logMode.length === NO_MODE) throw new Error('Invalid LOG_MODE: cannot be an empty array');
-    if (difference(logMode, ALL_MODES).length !== KNOWN_MODE) throw new Error(`Invalid items in LOG_MODE: ${mode}`);
-    if (logMode.includes(NONE_MODE) && logMode.length !== SINGLE_MODE) throw new Error(`Cannot have multiple modes when ${NONE_MODE} is selected`);
+    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_MODE) && logMode.length !== 1) throw new Error(`Cannot have multiple modes when ${NONE_MODE} is selected`);
     if (logMode.includes(ALL_MODE)) logMode = [SUMOLOGIC, AWS_S3]; // legacy support
   }
   return logMode;
@@ -161,6 +159,7 @@ if (configuration.mode.includes(AWS_KINESIS)) {
     timeout: parseInt(process.env.KINESIS_AWS_TIMEOUT, DECIMAL) || DEFAULT_KINESIS_TIMEOUT, // in millisecond
     maxSize: parseInt(process.env.KINESIS_AWS_MAX_SIZE, DECIMAL) || DEFAULT_KINESIS_MAX_SIZE, // in mByte
     maxEvents: parseInt(process.env.KINESIS_AWS_MAX_EVENTS, DECIMAL) || DEFAULT_KINESIS_MAX_EVENTS,
+    maxRetries: parseInt(process.env.KINESIS_AWS_MAX_RETRIES, DECIMAL) || DEFAULT_KINESIS_MAX_RETRIES,
     httpOptions: {
       socketTimeout: parseInt(process.env.KINESIS_AWS_HTTP_OPTIONS_SOCKET_TIMEOUT, DECIMAL) || DEFAULT_KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT,
       connectionTimeout: parseInt(process.env.KINESIS_AWS_HTTP_OPTIONS_CONNECTION_TIMEOUT, DECIMAL) || DEFAULT_KINESIS_HTTP_OPTIONS_CONNECTION_TIMEOUT,

package/eslint.config.js

@@ -10,6 +10,8 @@ const MAX_LINES_IN_FUNCTION = 150;
 const MAX_STATEMENTS_IN_FUNCTION = 45;
 const MIN_KEYS_IN_OBJECT = 10;
 const MAX_COMPLEXITY = 30;
+const ECMA_VERSION = 2022;
+const ALLOWED_CONSTANTS = [0, 1, -1];
 
 export default [
   {
@@ -23,7 +25,7 @@ export default [
       processDoc,
     },
     languageOptions: {
-      ecmaVersion: 2022,
+      ecmaVersion: ECMA_VERSION,
       globals: {
         console: 'readonly',
         describe: 'readonly',
@@ -44,13 +46,14 @@ export default [
       'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
       'init-declarations': ['off'],
       'linebreak-style': ['off'],
-      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true }],
+      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true, ignoreRegExpLiterals: true }],
       'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true }],
       'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true }],
       'max-params': ['error', MAX_FUNCTION_PARAMETERS],
       'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
-      'no-confusing-arrow': ['off'], // arrow isnt confusing
+      'no-confusing-arrow': ['off'],
       'no-inline-comments': ['off'],
+      'no-magic-numbers': ['error', { ignore: ALLOWED_CONSTANTS, enforceConst: true, detectObjects: true }],
       'no-process-env': ['error'],
       'no-ternary': ['off'],
       'no-undefined': ['off'],

package/index.js

@@ -94,6 +94,7 @@ if (config.mode.includes(AWS_KINESIS)) {
     },
     level: config.level.log,
     maxEvents: config[AWS_KINESIS].maxEvents,
+    maxRetries: config[AWS_KINESIS].maxRetries,
     maxSize: config[AWS_KINESIS].maxSize,
     region: config[AWS_KINESIS].region,
     secretAccessKey: config[AWS_KINESIS].secretAccessKey,

package/lib/awsKinesisTransport.js

@@ -7,6 +7,7 @@ import {
   MESSAGE,
   OTHER,
   PARTITION_KEY,
+  SYSTEM_ERROR,
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
@@ -27,7 +28,6 @@ import Transport from 'winston-transport';
 const RANDOM_MIN = 0;
 const RANDOM_LIMIT = 100;
 const MEGA = 1048576; // 2^20 conversion to mega
-const SYSTEM_ERROR = 500;
 
 const events = {};
 
@@ -55,7 +55,7 @@ export default class AwsKinesis extends Transport {
       };
     }
 
-    this.kinesisClientConfig.maxAttempts = 5;
+    this.kinesisClientConfig.maxAttempts = options.maxRetries + 1;
     this.kinesisClientConfig.requestHandler = new NodeHttpHandler(
       {
         connectionTimeout: options.httpOptions.connectionTimeout,

package/lib/awsS3Transport.js

@@ -3,6 +3,7 @@ import {
   CLIENTS,
   LOG,
   MESSAGE,
+  SYSTEM_ERROR,
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
@@ -21,11 +22,8 @@ import Transport from 'winston-transport';
 const events = {};
 const typeEvents = {};
 
-const INCR = 1;
-const NONE = 0;
 const MEGA = 1048576; // 2^20 conversion to mega
 const MILLI_MIN = 60000; // 1000*60 conversion to minute
-const SYSTEM_ERROR = 500;
 
 export default class AwsS3 extends Transport {
   constructor(options = {}) {
@@ -71,7 +69,7 @@ export default class AwsS3 extends Transport {
   put(data, lvl, date) {
     const command = new PutObjectCommand({
       Bucket: this.bucketname,
-      Key: `${lvl}/${this.server}/${date.getFullYear()}/${date.getMonth() + INCR}/${date.getDate()}/${date.toISOString()}.json`,
+      Key: `${lvl}/${this.server}/${date.getFullYear()}/${date.getMonth() + 1}/${date.getDate()}/${date.toISOString()}.json`,
       Body: JSON.stringify(data),
     });
 
@@ -95,13 +93,13 @@ export default class AwsS3 extends Transport {
     return Promise.map(Object.keys(data), sType => Promise.each(Object.keys(data[sType]), (sId) => {
       const command = new PutObjectCommand({
         Bucket: this.bucketname,
-        Key: `${lvl}/${sType}/${sId}/${date.getFullYear()}/${date.getMonth() + INCR}/${date.getDate()}/${date.toISOString()}.json`,
+        Key: `${lvl}/${sType}/${sId}/${date.getFullYear()}/${date.getMonth() + 1}/${date.getDate()}/${date.toISOString()}.json`,
         Body: JSON.stringify(data[sType][sId]),
       });
 
       return this.s3.send(command)
         .then(() => {
-          count += INCR;
+          count += 1;
         })
         .catch(err => errors.push({
           data: data[sType][sId],
@@ -117,8 +115,8 @@ export default class AwsS3 extends Transport {
         const { count, errors } = result;
         const errorCount = errors.length;
 
-        if (errorCount === NONE) return this.emit(LOG, { message: `${count} logs sent to ${AWS_S3}` });
-        if (count === NONE) {
+        if (errorCount === 0) return this.emit(LOG, { message: `${count} logs sent to ${AWS_S3}` });
+        if (count === 0) {
           return this.emit(WARN, {
             errors,
             nblogs: errorCount,
@@ -161,8 +159,8 @@ export default class AwsS3 extends Transport {
             const { count, errors } = result;
             const errorCount = errors.length;
 
-            if (errorCount === NONE) return this.emit(LOG, { message: `${count} logs sent to ${AWS_S3}` });
-            if (count === NONE) {
+            if (errorCount === 0) return this.emit(LOG, { message: `${count} logs sent to ${AWS_S3}` });
+            if (count === 0) {
               return this.emit(WARN, {
                 errors,
                 nblogs: errorCount,

package/lib/common.js

@@ -20,6 +20,7 @@ const DEFAULT_KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT = 5000; // socket timeout for
 const DEFAULT_KINESIS_HTTP_OPTIONS_CONNECTION_TIMEOUT = 5000; // connection timeout for the http handler, in millisecond
 const DEFAULT_KINESIS_MAX_SIZE = 5; // max size of the data before sending to Kinesis, in mByte
 const DEFAULT_KINESIS_MAX_EVENTS = 1000; // max number of events before sending to Kinesis
+const DEFAULT_KINESIS_MAX_RETRIES = 4; // max retries to connect to Kinesis
 const DEFAULT_KINESIS_TIMEOUT = 1000; // max time before sending events to Kinesis, in millisecond
 
 const DEFAULT_EXIT_DELAY = 2000; // delay for flushing the transports and exiting, in millisecond
@@ -43,6 +44,8 @@ const INFO = 'info';
 const ERROR = 'error';
 const OTHER = 'other';
 
+const SYSTEM_ERROR = 500;
+
 export {
   ALL_MODE,
   ALL_MODES,
@@ -53,6 +56,7 @@ export {
   DEFAULT_EXIT_DELAY,
   DEFAULT_FILTER_FILE,
   DEFAULT_KINESIS_MAX_EVENTS,
+  DEFAULT_KINESIS_MAX_RETRIES,
   DEFAULT_KINESIS_MAX_SIZE,
   DEFAULT_KINESIS_TIMEOUT,
   DEFAULT_KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT,
@@ -77,6 +81,7 @@ export {
   PARTITION_KEY,
   SPLAT,
   SUMOLOGIC,
+  SYSTEM_ERROR,
   UNKNOWN_TYPE,
   UNKNOWN_ID,
   WARN,

package/manual-test/eventsMock.js

@@ -2,24 +2,24 @@
 import bodyParser from 'body-parser';
 import express from 'express';
 
-const INCR = 1;
-
 let i = 0;
+const MOCK_PORT = 9000;
+const CREATED_RESPONSE = 201;
 
 const app = express();
 const config = {
-  port: 9000,
+  port: MOCK_PORT,
   base: '/checkthat',
 };
 
 app.use(bodyParser.json());
 app.post(`${config.base}`, (req, res) => {
-  i += INCR;
+  i += 1;
   console.log('Recieved a POST:', i);
   // console.log('headers:', req.headers)
   console.log(req.body);
 
-  res.statusCode = 201;
+  res.statusCode = CREATED_RESPONSE;
   res.send(req.body);
 });
 

package/manual-test/testLogAndQuit.js

@@ -1,4 +1,5 @@
 import '../test/testEnv';
+import { SYSTEM_ERROR } from '../lib/common.js';
 import logger from '../index.js';
 
 const ISSUE_EXIT = 1;
@@ -16,7 +17,7 @@ const complexObject = {
 complexObject.propG = complexObject;
 const error = new Error('an error');
 error.name = 'this is a complex error';
-error.statusCode = 500;
+error.statusCode = SYSTEM_ERROR;
 error.title = 'System error';
 
 logger.info('this is a test', { user: complexObject }, '12345678');

package/manual-test/testManyLogs.js

@@ -6,7 +6,6 @@ import { getCorrelationId } from '@mimik/request-helper';
 import logger from '../index.js';
 
 const MAX_ITEMS = 100000;
-const INCR = 1;
 
 const complexObject = {
   key: 'property a',
@@ -28,7 +27,7 @@ const object = {
 };
 const objects = [];
 
-for (let i = 0; i < MAX_ITEMS; i += INCR) {
+for (let i = 0; i < MAX_ITEMS; i += 1) {
   const clonedObject = clone(object);
 
   clonedObject.index = i;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "./index.js",
   "type": "module",