@mimik/sumologic-winston-logger 2.1.4 → 2.1.6

package/README.md

@@ -1,64 +1,66 @@
 <a name="config"></a>
 
 ## config() ⇒ <code>object</code>
-The following environment variables are needed to configure logger:
+The following environment variables are used to configure the logger:
 
 | Env variable name | Description | Default | Comments |
 | ----------------- | ----------- | ------- | -------- |
-| 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:
+| SERVER_TYPE | Type of the server being logged | null |  |
+| SERVER_ID | ID of the server being logged | null |  |
+| NODE_ENV | Environment of the running instance | local |  |
+| LOG_LEVEL | Log level for the running instance | debug |  |
+| CONSOLE_LEVEL | Console log level | debug |  |
+| FILTER_FILE | Filename containing filter rules | null |  |
+| EXIT_DELAY | Delay before exiting gracefully | 2000 | in milliseconds |
+| NO_STACK | Whether to include call stacks in all log messages | no | expected: yes/no |
+| LOG_MODE | Comma-separated list defining the log mode/backends | sumologic | enum: awsS3, awsKinesis, sumologic, all, none |
+
+If `LOG_MODE` includes `sumologic`, the following environment variables are required:
 
 | Env variable name | Description | Default | Comments |
 | ----------------- | ----------- | ------- | -------- |
-| SUMO_LOGIC_ENDPOINT | URL of the sumologic collector
-| SUMO_LOGIC_COLLECTOR_CODE | Code of the sumologic collector
+| SUMO_LOGIC_ENDPOINT | URL of the Sumo Logic collector |  |  |
+| SUMO_LOGIC_COLLECTOR_CODE | Code of the Sumo Logic collector |  |  |
 
-If `LOG_MODE` includes `awsKinesis` the following environment variables are needed:
+If `LOG_MODE` includes `awsKinesis`, the following environment variables are required:
 
 | 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 | 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_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
-| KINESIS_AWS_HTTP_OPTIONS_CONNECTION_TIMEOUT | Connection timeout for the http handler | 5000 | in millisecond
-
-If `LOG_MODE` includes `awsS3` the following environment variables are needed:
+| KINESIS_AWS_STREAM_NAME_INFO | Stream name for `info` level logs |  |  |
+| KINESIS_AWS_STREAM_NAME_ERROR | Stream name for `error` level logs |  |  |
+| KINESIS_AWS_STREAM_NAME_OTHER | Stream name for any other level |  |  |
+| KINESIS_AWS_REGION | AWS region of the stream |  |  |
+| KINESIS_AWS_TIMEOUT | Maximum time before flushing | 1000 | in millisecond |
+| KINESIS_AWS_MAX_SIZE | Maximum accumulated log size before flushing | 5 | in MB |
+| KINESIS_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |  |
+| KINESIS_AWS_MAX_RETRIES | Maximum connection retries | 4 |  |
+| KINESIS_AWS_ACCESS_KEY_ID | AWS access key ID |  |  |
+| KINESIS_AWS_SECRET_ACCESS_KEY | AWS secret access key |  |  |
+| KINESIS_AWS_HTTP_OPTIONS_SOCKET_TIMEOUT | HTTP handler socket timeout | 5000 | in millisecond |
+| KINESIS_AWS_HTTP_OPTIONS_CONNECTION_TIMEOUT | HTTP handler connection timeout | 5000 | in millisecond |
+
+If `LOG_MODE` includes `awsS3`, the following environment variables are required:
 
 | 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 | 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_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`.
+| S3_AWS_BUCKET_NAME | S3 bucket name for storing logs |  |  |
+| S3_AWS_REGION | AWS region of the bucket |  |  |
+| S3_AWS_TIMEOUT | Maximum time before flushing | 5 | in minute |
+| S3_AWS_MAX_SIZE | Maximum accumulated log size before flushing | 5 | in MB |
+| S3_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |  |
+| S3_AWS_ACCESS_KEY_ID | AWS access key ID |  |  |
+| S3_AWS_SECRET_ACCESS_KEY | AWS secret access key |  |  |
+
+When `LOG_MODE` is `none`, logs are written to the console only.
+When `LOG_MODE` is `all`, it is equivalent to `sumologic,awsS3`.
+
+`SERVER_TYPE` and `SERVER_ID` are used to build the S3 filename and are included in the
+log payload for S3 and Kinesis.
+If `global.serverType` is set, it overrides `SERVER_TYPE`.
+If `global.serverId` is set, it overrides `SERVER_ID`.
 
 **Kind**: global function  
-**Returns**: <code>object</code> - configuration - logger configuration.  
+**Returns**: <code>object</code> - configuration - Logger configuration.  
 
 ## Synopsis ##
 

package/configuration/config.js

@@ -4,97 +4,82 @@ import {
   ALL_MODES,
   AWS_KINESIS,
   AWS_S3,
-  DEFAULT_ENV,
-  DEFAULT_EXIT_DELAY,
-  DEFAULT_FILTER_FILE,
-  DEFAULT_KINESIS_HTTP_OPTIONS_CONNECTION_TIMEOUT,
-  DEFAULT_KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT,
-  DEFAULT_KINESIS_MAX_EVENTS,
-  DEFAULT_KINESIS_MAX_SIZE,
-  DEFAULT_KINESIS_TIMEOUT,
-  DEFAULT_LEVEL,
-  DEFAULT_MODE,
-  DEFAULT_NO_STACK,
-  DEFAULT_S3_MAX_EVENTS,
-  DEFAULT_S3_MAX_SIZE,
-  DEFAULT_S3_TIMEOUT,
+  DEFAULT,
   NONE_MODE,
   SUMOLOGIC,
 } from '../lib/common.js';
 import difference from 'lodash.difference';
-import fs from 'fs';
 import isNil from 'lodash.isnil';
 import isUndefined from 'lodash.isundefined';
-import process from 'process';
+import process from 'node:process';
+import { readFileSync } from 'node:fs';
 import split from 'lodash.split';
 
 const DECIMAL = 10;
-const EXISTING_ERRORS = 1;
-const NO_MODE = 0;
-const KNOWN_MODE = 0;
-const SINGLE_MODE = 1;
 
 /**
  *
- * logger Configuration.
+ * Logger configuration.
  *
  * @function config
- * @return {object} configuration - logger configuration.
- * @description The following environment variables are needed to configure logger:
+ * @return {object} configuration - Logger configuration.
+ * @description The following environment variables are used to configure the logger:
  *
  * | Env variable name | Description | Default | Comments |
  * | ----------------- | ----------- | ------- | -------- |
- * | 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)
+ * | SERVER_TYPE | Type of the server being logged | null |  |
+ * | SERVER_ID | ID of the server being logged | null |  |
+ * | NODE_ENV | Environment of the running instance | local |  |
+ * | LOG_LEVEL | Log level for the running instance | debug |  |
+ * | CONSOLE_LEVEL | Console log level | debug |  |
+ * | FILTER_FILE | Filename containing filter rules | null |  |
+ * | EXIT_DELAY | Delay before exiting gracefully | 2000 | in milliseconds |
+ * | NO_STACK | Whether to include call stacks in all log messages | no | expected: yes/no |
+ * | LOG_MODE | Comma-separated list defining the log mode/backends | sumologic | enum: awsS3, awsKinesis, sumologic, all, none |
  *
- * If `LOG_MODE` includes `sumologic` the following environment variables are needed:
+ * If `LOG_MODE` includes `sumologic`, the following environment variables are required:
  *
  * | Env variable name | Description | Default | Comments |
  * | ----------------- | ----------- | ------- | -------- |
- * | SUMO_LOGIC_ENDPOINT | URL of the sumologic collector
- * | SUMO_LOGIC_COLLECTOR_CODE | Code of the sumologic collector
+ * | SUMO_LOGIC_ENDPOINT | URL of the Sumo Logic collector |  |  |
+ * | SUMO_LOGIC_COLLECTOR_CODE | Code of the Sumo Logic collector |  |  |
  *
- * If `LOG_MODE` includes `awsKinesis` the following environment variables are needed:
+ * If `LOG_MODE` includes `awsKinesis`, the following environment variables are required:
  *
  * | 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 | 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_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
- * | KINESIS_AWS_HTTP_OPTIONS_CONNECTION_TIMEOUT | Connection timeout for the http handler | 5000 | in millisecond
+ * | KINESIS_AWS_STREAM_NAME_INFO | Stream name for `info` level logs |  |  |
+ * | KINESIS_AWS_STREAM_NAME_ERROR | Stream name for `error` level logs |  |  |
+ * | KINESIS_AWS_STREAM_NAME_OTHER | Stream name for any other level |  |  |
+ * | KINESIS_AWS_REGION | AWS region of the stream |  |  |
+ * | KINESIS_AWS_TIMEOUT | Maximum time before flushing | 1000 | in millisecond |
+ * | KINESIS_AWS_MAX_SIZE | Maximum accumulated log size before flushing | 5 | in MB |
+ * | KINESIS_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |  |
+ * | KINESIS_AWS_MAX_RETRIES | Maximum connection retries | 4 |  |
+ * | KINESIS_AWS_ACCESS_KEY_ID | AWS access key ID |  |  |
+ * | KINESIS_AWS_SECRET_ACCESS_KEY | AWS secret access key |  |  |
+ * | KINESIS_AWS_HTTP_OPTIONS_SOCKET_TIMEOUT | HTTP handler socket timeout | 5000 | in millisecond |
+ * | KINESIS_AWS_HTTP_OPTIONS_CONNECTION_TIMEOUT | HTTP handler connection timeout | 5000 | in millisecond |
  *
- * If `LOG_MODE` includes `awsS3` the following environment variables are needed:
+ * If `LOG_MODE` includes `awsS3`, the following environment variables are required:
  *
  * | 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 | 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_ACCESS_KEY_ID | Access key id of the bucket
- * | S3_AWS_SECRET_ACCESS_KEY | Access key secret of the bucket
+ * | S3_AWS_BUCKET_NAME | S3 bucket name for storing logs |  |  |
+ * | S3_AWS_REGION | AWS region of the bucket |  |  |
+ * | S3_AWS_TIMEOUT | Maximum time before flushing | 5 | in minute |
+ * | S3_AWS_MAX_SIZE | Maximum accumulated log size before flushing | 5 | in MB |
+ * | S3_AWS_MAX_EVENTS | Maximum number of accumulated logs before flushing | 1000 |  |
+ * | S3_AWS_ACCESS_KEY_ID | AWS access key ID |  |  |
+ * | S3_AWS_SECRET_ACCESS_KEY | AWS secret access key |  |  |
  *
- * 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`.
+ * When `LOG_MODE` is `none`, logs are written to the console only.
+ * When `LOG_MODE` is `all`, it is equivalent 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`.
+ * `SERVER_TYPE` and `SERVER_ID` are used to build the S3 filename and are included in the
+ * log payload for S3 and Kinesis.
+ * If `global.serverType` is set, it overrides `SERVER_TYPE`.
+ * If `global.serverId` is set, it overrides `SERVER_ID`.
  */
 
 const checkConfig = (config) => {
@@ -110,7 +95,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 +105,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;
@@ -133,18 +118,18 @@ const configuration = {
     type: process.env.SERVER_TYPE || null,
     id: process.env.SERVER_ID || null,
   },
-  env: process.env.NODE_ENV || DEFAULT_ENV,
+  env: process.env.NODE_ENV || DEFAULT.ENV,
   level: {
-    log: process.env.LOG_LEVEL || DEFAULT_LEVEL,
-    console: process.env.CONSOLE_LEVEL || DEFAULT_LEVEL,
+    log: process.env.LOG_LEVEL || DEFAULT.LEVEL,
+    console: process.env.CONSOLE_LEVEL || DEFAULT.LEVEL,
   },
   filter: {
-    file: process.env.FILTER_FILE || DEFAULT_FILTER_FILE,
+    file: process.env.FILTER_FILE || DEFAULT.FILTER_FILE,
   },
-  exitDelay: parseInt(process.env.EXIT_DELAY, DECIMAL) || DEFAULT_EXIT_DELAY, // in millisecond
-  noStack: process.env.NO_STACK || DEFAULT_NO_STACK,
+  exitDelay: parseInt(process.env.EXIT_DELAY, DECIMAL) || DEFAULT.EXIT_DELAY, // in millisecond
+  noStack: process.env.NO_STACK || DEFAULT.NO_STACK,
 };
-configuration.mode = checkMode(process.env.LOG_MODE) || DEFAULT_MODE;
+configuration.mode = checkMode(process.env.LOG_MODE) || DEFAULT.MODE;
 
 if (configuration.mode.includes(SUMOLOGIC)) {
   configuration[SUMOLOGIC] = {
@@ -158,12 +143,13 @@ if (configuration.mode.includes(AWS_KINESIS)) {
     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, 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,
+    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,
+      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,
     },
   };
 
@@ -174,9 +160,9 @@ if (configuration.mode.includes(AWS_S3)) {
   configuration[AWS_S3] = {
     bucketname: process.env.S3_AWS_BUCKET_NAME,
     region: process.env.S3_AWS_REGION,
-    timeout: parseInt(process.env.S3_AWS_TIMEOUT, DECIMAL) || DEFAULT_S3_TIMEOUT, // in minute
-    maxSize: parseInt(process.env.S3_AWS_MAX_SIZE, DECIMAL) || DEFAULT_S3_MAX_SIZE, // in mByte
-    maxEvents: parseInt(process.env.S3_AWS_MAX_EVENTS, DECIMAL) || DEFAULT_S3_MAX_EVENTS,
+    timeout: parseInt(process.env.S3_AWS_TIMEOUT, DECIMAL) || DEFAULT.S3_TIMEOUT, // in minute
+    maxSize: parseInt(process.env.S3_AWS_MAX_SIZE, DECIMAL) || DEFAULT.S3_MAX_SIZE, // in mByte
+    maxEvents: parseInt(process.env.S3_AWS_MAX_EVENTS, DECIMAL) || DEFAULT.S3_MAX_EVENTS,
   };
 
   if (!isNil(process.env.S3_AWS_ACCESS_KEY_ID)) configuration[AWS_S3].accessKeyId = process.env.S3_AWS_ACCESS_KEY_ID;
@@ -187,10 +173,10 @@ let filterConfig = [];
 
 if (filter.file) {
   try {
-    filterConfig = JSON.parse(fs.readFileSync(filter.file).toString());
+    filterConfig = JSON.parse(readFileSync(filter.file).toString());
   }
   catch (err) {
-    throw new Error(`Invalid file for logger config: ${filter.file}, error: ${err.message}`);
+    throw new Error(`Invalid file for logger config: ${filter.file}`, { cause: err });
   }
 }
 filter.config = filterConfig;

package/eslint.config.js

@@ -10,6 +10,9 @@ 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 MAX_DEPTH = 6;
+const ALLOWED_CONSTANTS = [0, 1, -1];
 
 export default [
   {
@@ -23,7 +26,7 @@ export default [
       processDoc,
     },
     languageOptions: {
-      ecmaVersion: 2022,
+      ecmaVersion: ECMA_VERSION,
       globals: {
         console: 'readonly',
         describe: 'readonly',
@@ -35,6 +38,7 @@ export default [
     rules: {
       '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
       '@stylistic/line-comment-position': ['off'],
+      '@stylistic/max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true, ignoreStrings: true, ignoreRegExpLiterals: true }],
       '@stylistic/semi': ['error', 'always'],
       'capitalized-comments': ['off'],
       'complexity': ['error', MAX_COMPLEXITY],
@@ -44,20 +48,22 @@ 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-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true }],
-      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true }],
+      'max-depth': ['error', MAX_DEPTH],
+      'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true, skipBlankLines: true }],
+      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true, skipBlankLines: 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'],
       'one-var': ['error', 'never'],
       'processDoc/validate-document-env': ['error'],
       'quotes': ['warn', 'single'],
-      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+      'sort-imports': ['error', { allowSeparatedGroups: true }],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false, allowLineSeparatedGroups: true }],
     },
   },
 ];

package/index.js

@@ -18,13 +18,12 @@ import {
   format,
   transports,
 } from 'winston';
-
 import AwsKinesis from './lib/awsKinesisTransport.js';
 import AwsS3 from './lib/awsS3Transport.js';
 import Sumologic from './lib/sumologicTransport.js';
 import config from './configuration/config.js';
-import process from 'process';
-import { setTimeout } from 'timers';
+import process from 'node:process';
+import { setTimeout } from 'node:timers';
 
 let sumo;
 let awsS3;
@@ -94,6 +93,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

@@ -4,9 +4,11 @@ import {
   ERROR,
   INFO,
   LOG,
+  MEGA,
   MESSAGE,
   OTHER,
   PARTITION_KEY,
+  SYSTEM_ERROR,
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
@@ -18,16 +20,14 @@ import {
 import {
   setImmediate,
   setInterval,
-} from 'timers';
-import { Buffer } from 'buffer';
+} from 'node:timers';
+import { Buffer } from 'node:buffer';
 import { NodeHttpHandler } from '@smithy/node-http-handler';
 import Promise from 'bluebird';
 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

@@ -2,7 +2,9 @@ import {
   AWS_S3,
   CLIENTS,
   LOG,
+  MEGA,
   MESSAGE,
+  SYSTEM_ERROR,
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
@@ -14,18 +16,14 @@ import {
 import {
   setImmediate,
   setInterval,
-} from 'timers';
+} from 'node:timers';
 import Promise from 'bluebird';
 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

@@ -1,29 +1,32 @@
+/* eslint-disable no-magic-numbers */
 const ENV_DEV = ['development', 'dev'];
 const ENV_LOCAL = 'local';
 
-const DEFAULT_LEVEL = 'debug';
-const DEFAULT_ENV = ENV_LOCAL;
-const DEFAULT_FILTER_FILE = null;
-
 const ALL_MODE = 'all'; // legacy support
 const NONE_MODE = 'none';
 const AWS_S3 = 'awsS3';
 const SUMOLOGIC = 'sumologic';
 const AWS_KINESIS = 'awsKinesis';
-const DEFAULT_MODE = [NONE_MODE];
 const ALL_MODES = [AWS_S3, SUMOLOGIC, AWS_KINESIS, ALL_MODE, NONE_MODE];
 
-const DEFAULT_S3_MAX_SIZE = 5; // max size of the data before sending to S3, in mByte
-const DEFAULT_S3_MAX_EVENTS = 1000; // max number of events before sending to S3
-const DEFAULT_S3_TIMEOUT = 5; // max time before sending events to S3, in minute
-const DEFAULT_KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT = 5000; // socket timeout for the http handler, in millisecond
-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_TIMEOUT = 1000; // max time before sending events to Kinesis, in millisecond
+const DEFAULT = {
+  ENV: ENV_LOCAL,
+  FILTER_FILE: null,
+  LEVEL: 'debug',
+  MODE: [NONE_MODE],
+  NO_STACK: 'yes',
 
-const DEFAULT_EXIT_DELAY = 2000; // delay for flushing the transports and exiting, in millisecond
-const DEFAULT_NO_STACK = 'yes';
+  EXIT_DELAY: 2000, // delay for flushing the transports and exiting, in millisecond
+  KINESIS_HTTP_OPTIONS_CONNECTION_TIMEOUT: 5000, // connection timeout for the http handler, in millisecond
+  KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT: 5000, // socket timeout for the http handler, in millisecond
+  KINESIS_MAX_EVENTS: 1000, // max number of events before sending to Kinesis
+  KINESIS_MAX_RETRIES: 4, // max retries to connect to Kinesis
+  KINESIS_MAX_SIZE: 5, // max size of the data before sending to Kinesis, in mByte
+  KINESIS_TIMEOUT: 1000, // max time before sending events to Kinesis, in millisecond
+  S3_MAX_EVENTS: 1000, // max number of events before sending to S3
+  S3_MAX_SIZE: 5, // max size of the data before sending to S3, in mByte
+  S3_TIMEOUT: 5, // max time before sending events to S3, in minute
+};
 
 const SPLAT = Symbol.for('splat');
 const LEVEL = Symbol.for('level');
@@ -43,40 +46,44 @@ const INFO = 'info';
 const ERROR = 'error';
 const OTHER = 'other';
 
+const UNAUTHORIZED_ERROR = 401;
+const NOT_FOUND_ERROR = 404;
+const SYSTEM_ERROR = 500;
+
+const START_TIMEOUT = 30000; // in millisecond
+const FLUSH_TIMEOUT = 1000; // in millisecond
+const OK_EXIT = 0;
+
+const MEGA = 1048576; // 2^20 conversion to mega
+
 export {
   ALL_MODE,
   ALL_MODES,
   AWS_KINESIS,
   AWS_S3,
   CLIENTS,
-  DEFAULT_ENV,
-  DEFAULT_EXIT_DELAY,
-  DEFAULT_FILTER_FILE,
-  DEFAULT_KINESIS_MAX_EVENTS,
-  DEFAULT_KINESIS_MAX_SIZE,
-  DEFAULT_KINESIS_TIMEOUT,
-  DEFAULT_KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT,
-  DEFAULT_KINESIS_HTTP_OPTIONS_CONNECTION_TIMEOUT,
-  DEFAULT_LEVEL,
-  DEFAULT_MODE,
-  DEFAULT_NO_STACK,
-  DEFAULT_S3_MAX_EVENTS,
-  DEFAULT_S3_MAX_SIZE,
-  DEFAULT_S3_TIMEOUT,
+  DEFAULT,
   ENV_DEV,
   ENV_LOCAL,
   ERROR,
   FLUSH,
   FLUSH_EXIT,
+  FLUSH_TIMEOUT,
   INFO,
   LEVEL,
   LOG,
+  MEGA,
   MESSAGE,
   NONE_MODE,
+  NOT_FOUND_ERROR,
+  OK_EXIT,
   OTHER,
   PARTITION_KEY,
   SPLAT,
+  START_TIMEOUT,
   SUMOLOGIC,
+  SYSTEM_ERROR,
+  UNAUTHORIZED_ERROR,
   UNKNOWN_TYPE,
   UNKNOWN_ID,
   WARN,

package/lib/stackLib.js

@@ -1,8 +1,6 @@
-import crypto from 'crypto';
-import {
-  fileURLToPath,
-} from 'url';
-import path from 'path';
+import { basename } from 'node:path';
+import { createHash } from 'node:crypto';
+import { fileURLToPath } from 'node:url';
 import reject from 'lodash.reject';
 
 // Stack trace format :
@@ -43,10 +41,10 @@ const parseStack = (newError) => {
     path: stackParts[PATH],
     line: stackParts[LINE],
     pos: stackParts[POSITION],
-    file: path.basename(stackParts[PATH]),
+    file: basename(stackParts[PATH]),
     stack: `${SHIFT}${truncatedList.join('\n').trimStart()}`,
   };
-  stackInfo.hash = crypto.createHash('sha256', SECRET)
+  stackInfo.hash = createHash('sha256', SECRET)
     .update(stackInfo.stack)
     .digest('hex');
   // this is a hash of the stacktrace for easier searching for the stacktrace

package/lib/sumologicTransport.js

@@ -1,21 +1,18 @@
 import {
   CLIENTS,
   LOG,
+  NOT_FOUND_ERROR,
   SPLAT,
   SUMOLOGIC,
+  SYSTEM_ERROR,
+  UNAUTHORIZED_ERROR,
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
 } from './common.js';
 import Transport from 'winston-transport';
 import axios from 'axios';
-import {
-  setImmediate,
-} from 'timers';
-
-const UNAUTHORIZED_ERROR = 401;
-const NOTFOUND_ERROR = 404;
-const SYSTEM_ERROR = 500;
+import { setImmediate } from 'node:timers';
 
 export default class Sumo extends Transport {
   constructor(options = {}) {
@@ -65,7 +62,7 @@ export default class Sumo extends Transport {
           resp.error.message = `invalid ${SUMOLOGIC} code`;
           resp.code = this.code;
         }
-        else if (status === NOTFOUND_ERROR) resp.error.message = `invalid ${SUMOLOGIC} endpoint`;
+        else if (status === NOT_FOUND_ERROR) resp.error.message = `invalid ${SUMOLOGIC} endpoint`;
         else resp.error.message = `could not log to ${SUMOLOGIC}`;
         return this.emit(WARN, resp);
       });

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/testLog.js

@@ -1,9 +1,8 @@
 /* eslint-disable no-console */
 import '../test/testEnv.js';
-import clone from 'lodash.clone';
 import { getCorrelationId } from '@mimik/request-helper';
 import logger from '../index.js';
-import process from 'process';
+import process from 'node:process';
 
 const user = {
   name: 'a name',
@@ -28,7 +27,7 @@ logger.debug('This is a test with error', { user }, correlationId);
 logger.error('This is a test, error', { user }, correlationId);
 
 stdin.addListener('data', () => {
-  const clonedObject = clone(user);
+  const clonedObject = { ...user };
 
   clonedObject.index = 'manual';
   console.log('manual logging');

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

@@ -1,12 +1,10 @@
 /* eslint-disable no-console */
 import '../test/testEnv.js';
 import Promise from 'bluebird';
-import clone from 'lodash.clone';
 import { getCorrelationId } from '@mimik/request-helper';
 import logger from '../index.js';
 
 const MAX_ITEMS = 100000;
-const INCR = 1;
 
 const complexObject = {
   key: 'property a',
@@ -28,8 +26,8 @@ const object = {
 };
 const objects = [];
 
-for (let i = 0; i < MAX_ITEMS; i += INCR) {
-  const clonedObject = clone(object);
+for (let i = 0; i < MAX_ITEMS; i += 1) {
+  const clonedObject = { ...object };
 
   clonedObject.index = i;
   objects.push(clonedObject);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "2.1.4",
+  "version": "2.1.6",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "./index.js",
   "type": "module",
@@ -34,10 +34,10 @@
   },
   "dependencies": {
     "@mimik/lib-filters": "^2.0.4",
-    "@aws-sdk/client-s3": "3.878.0",
-    "@aws-sdk/client-kinesis": "3.876.0",
-    "@smithy/node-http-handler": "4.1.1",
-    "axios": "1.11.0",
+    "@aws-sdk/client-s3": "3.888.0",
+    "@aws-sdk/client-kinesis": "3.888.0",
+    "@smithy/node-http-handler": "4.2.1",
+    "axios": "1.12.1",
     "bluebird": "3.7.2",
     "lodash.difference": "4.5.0",
     "lodash.foreach": "4.5.0",
@@ -51,20 +51,19 @@
     "winston-transport": "4.9.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.34.0",
+    "@eslint/js": "9.35.0",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
     "@mimik/request-helper": "^2.0.2",
-    "@stylistic/eslint-plugin": "5.2.3",
+    "@stylistic/eslint-plugin": "5.3.1",
     "body-parser": "2.2.0",
     "c8": "10.1.3",
     "chai": "6.0.1",
-    "eslint": "9.34.0",
+    "eslint": "9.35.0",
     "eslint-plugin-import": "2.32.0",
     "express": "5.1.0",
     "husky": "9.1.7",
     "jsdoc-to-markdown": "9.1.2",
-    "lodash.clone": "4.5.0",
-    "mocha": "11.7.1",
+    "mocha": "11.7.2",
     "mochawesome": "7.1.3",
     "sinon": "21.0.0",
     "supertest": "7.1.4"

package/test/logger.spec.js

@@ -1,16 +1,13 @@
 import './testEnv.js';
+import { FLUSH_TIMEOUT, OK_EXIT, START_TIMEOUT } from '../lib/common.js';
 import { before, describe, it } from 'mocha';
 import { getCorrelationId } from '@mimik/request-helper';
 import logger from '../index.js';
-import process from 'process';
-import { setTimeout } from 'timers';
+import process from 'node:process';
+import { setTimeout } from 'node:timers';
 import { should } from 'chai';
 import { stub } from 'sinon';
 
-const START_TIMEOUT = 30000;
-const FLUSH_TIMEOUT = 1000;
-const OK_EXIT = 0;
-
 const correlationId = getCorrelationId('--sumologic-winston-logger-test--');
 
 should();

package/test/loggerProd.spec.js

@@ -1,16 +1,13 @@
 import './testEnvProdFilter.js';
+import { FLUSH_TIMEOUT, OK_EXIT, START_TIMEOUT } from '../lib/common.js';
 import { before, describe, it } from 'mocha';
 import { getCorrelationId } from '@mimik/request-helper';
 import logger from '../index.js';
-import process from 'process';
-import { setTimeout } from 'timers';
+import process from 'node:process';
+import { setTimeout } from 'node:timers';
 import { should } from 'chai';
 import { stub } from 'sinon';
 
-const START_TIMEOUT = 30000;
-const FLUSH_TIMEOUT = 1000;
-const OK_EXIT = 0;
-
 const correlationId = getCorrelationId('--sumologic-winston-logger-prod-test--');
 
 const user = {

package/test/testEnv.js

@@ -1,6 +1,6 @@
 /* eslint no-process-env: "off" */
+import process from 'node:process';
 
-import process from 'process';
 /**
  *
  * Test logger Configuration.

package/test/testEnvProdFilter.js

@@ -1,6 +1,6 @@
 /* eslint no-process-env: "off" */
+import process from 'node:process';
 
-import process from 'process';
 /**
  *
  * Test logger prod with filter Configuration.