@mimik/sumologic-winston-logger 2.1.13 → 2.2.0

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

package/eslint.config.js

@@ -1,70 +0,0 @@
-import globals from 'globals';
-import importPlugin from 'eslint-plugin-import';
-import js from '@eslint/js';
-import processDoc from '@mimik/eslint-plugin-document-env';
-import stylistic from '@stylistic/eslint-plugin';
-
-const MAX_LENGTH_LINE = 180;
-const MAX_FUNCTION_PARAMETERS = 6;
-const MAX_LINES_IN_FILES = 600;
-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 = 'latest';
-const MAX_DEPTH = 6;
-const ALLOWED_CONSTANTS = [0, 1, -1];
-
-export default [
-  {
-    ignores: ['coverage/**', 'mochawesome-report/**', 'node_modules/**', 'dist/**'],
-  },
-  importPlugin.flatConfigs.recommended,
-  stylistic.configs.recommended,
-  js.configs.all,
-  {
-    plugins: {
-      processDoc,
-    },
-    languageOptions: {
-      ecmaVersion: ECMA_VERSION,
-      globals: {
-        ...globals.mocha,
-        ...globals.nodeBuiltin,
-      },
-      sourceType: 'module',
-    },
-    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/quotes': ['warn', 'single'],
-      '@stylistic/semi': ['error', 'always'],
-      'capitalized-comments': ['off'],
-      'complexity': ['error', MAX_COMPLEXITY],
-      'curly': ['off'],
-      'id-length': ['error', { exceptions: ['x', 'y', 'z', 'i', 'j', 'k'] }],
-      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
-      'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
-      'init-declarations': ['off'],
-      'linebreak-style': ['off'],
-      'max-depth': ['error', MAX_DEPTH],
-      'max-len': ['off'],
-      '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'],
-      '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': ['off'],
-      'sort-imports': ['error', { allowSeparatedGroups: true }],
-      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false, allowLineSeparatedGroups: true }],
-    },
-  },
-];

package/test/filterConfig.json

@@ -1,5 +0,0 @@
-[
-  "$..references[0]", 
-  "$..references[1].serverType",
-  "$..email"
-]