Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(): add a constant for each log level #20

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(): add a constant for each log level #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a506b7
add a constant for each log level
cvscarlos Sep 11, 2023
2181c8d
npm update
cvscarlos Sep 11, 2023
3b57157
Merge branch 'master' into constants-for-log-level
cvscarlos Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 4 additions & 65 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,67 +1,6 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.DS_Store
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

# next.js build output
.next

# ide config
.vscode

# npm dist
#lib/
coverage
lib-cov
node_modules
58 changes: 36 additions & 22 deletions lib/logger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.Logger = exports.logToConsole = undefined;
exports.logLevel = exports.Logger = exports.logToConsole = undefined;

var _level;

var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

var _util = require('./util');

function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

var os = require('os');
Expand Down Expand Up @@ -36,9 +40,18 @@ var logger = {
slackHook: process.env.LOG_SLACK_HOOK || null
},
graylogger: null
};

var logLevel = {
TRACE: 'TRACE',
DEBUG: 'DEBUG',
INFO: 'INFO',
WARN: 'WARN',
ERROR: 'ERROR',
CRITICAL: 'CRITICAL'

// order is important! (severe ==> verbose)
};var logLevels = ['CRITICAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE'];
};var logLevelsSorted = [logLevel.CRITICAL, logLevel.ERROR, logLevel.WARN, logLevel.INFO, logLevel.DEBUG, logLevel.TRACE];

//to enable logger instances have a default sender - shit's mainly singletonic otherwise

Expand All @@ -52,32 +65,32 @@ var Logger = function () {
_createClass(Logger, [{
key: 'critical',
value: function critical(msg, extra, sender) {
this.loggerPassToConsole('CRITICAL', sender, msg, extra);
this.loggerPassToConsole(logLevel.CRITICAL, sender, msg, extra);
}
}, {
key: 'error',
value: function error(msg, extra, sender) {
this.loggerPassToConsole('ERROR', sender, msg, extra);
this.loggerPassToConsole(logLevel.ERROR, sender, msg, extra);
}
}, {
key: 'warn',
value: function warn(msg, extra, sender) {
this.loggerPassToConsole('WARN', sender, msg, extra);
this.loggerPassToConsole(logLevel.WARN, sender, msg, extra);
}
}, {
key: 'info',
value: function info(msg, extra, sender) {
this.loggerPassToConsole('INFO', sender, msg, extra);
this.loggerPassToConsole(logLevel.INFO, sender, msg, extra);
}
}, {
key: 'debug',
value: function debug(msg, extra, sender) {
this.loggerPassToConsole('DEBUG', sender, msg, extra);
this.loggerPassToConsole(logLevel.DEBUG, sender, msg, extra);
}
}, {
key: 'trace',
value: function trace(msg, extra, sender) {
this.loggerPassToConsole('TRACE', sender, msg, extra);
this.loggerPassToConsole(logLevel.TRACE, sender, msg, extra);
}
}, {
key: 'loggerPassToConsole',
Expand Down Expand Up @@ -130,14 +143,7 @@ var colors = {

var colorconf = {
'timestamp': colors.Dim + colors.FgBlack + colors.BgWhite,
'level': {
'TRACE': colors.Dim + colors.BgMagenta + colors.FgBlack,
'DEBUG': colors.Dim + colors.FgBlack + colors.BgGreen,
'INFO': colors.FgBlue + colors.BgCyan,
'WARN': colors.Bright + colors.FgYellow + colors.BgBlack + ' ⚠️ ',
'ERROR': colors.Bright + colors.FgRed + colors.BgBlack + ' ❌',
'CRITICAL': colors.Bright + colors.BgRed + colors.FgYellow + colors.Blink + ' ☠️ '
},
'level': (_level = {}, _defineProperty(_level, logLevel.TRACE, colors.Dim + colors.BgMagenta + colors.FgBlack), _defineProperty(_level, logLevel.DEBUG, colors.Dim + colors.FgBlack + colors.BgGreen), _defineProperty(_level, logLevel.INFO, colors.FgBlue + colors.BgCyan), _defineProperty(_level, logLevel.WARN, colors.Bright + colors.FgYellow + colors.BgBlack + ' ⚠️ '), _defineProperty(_level, logLevel.ERROR, colors.Bright + colors.FgRed + colors.BgBlack + ' ❌'), _defineProperty(_level, logLevel.CRITICAL, colors.Bright + colors.BgRed + colors.FgYellow + colors.Blink + ' ☠️ '), _level),
'sender': colors.Underscore + colors.FgCyan,
'extra': colors.FgWhite + colors.BgBlue
};
Expand All @@ -150,7 +156,7 @@ function objToString(obj) {
str = JSON.stringify(obj, null, 4);
}
} catch (err) {
logToConsole('WARN', 'logger-module', 'stringification of object failed', err);
logToConsole(logLevel.WARN, 'logger-module', 'stringification of object failed', err);
str = '~(Obj)~[un-stringifiable]~~';
}
return str;
Expand Down Expand Up @@ -181,19 +187,19 @@ logger.initGraylog = function () {
console.log(' 👾 !ERROR! while trying to write to graylog2:', error);
});
logger.graylogger = graylogger;
logToConsole('INFO', 'logger.initGraylog', 'Connection to Graylog log Server initialized', options);
logToConsole(logLevel.INFO, 'logger.initGraylog', 'Connection to Graylog log Server initialized', options);
//if (logger.settings.verboseLocal) console.log(logger)
};

function checkType(type) {
if (logLevels.indexOf(type) !== -1) return true;
if (logLevelsSorted.indexOf(type) !== -1) return true;
console.log('unknown logging type: "' + type + '"');
console.log('known logging types are: ' + logLevels.join(','));
console.log('known logging types are: ' + logLevelsSorted.join(','));
return false;
}

function logThis(type) {
return logLevels.indexOf(logger.settings.level.toUpperCase()) >= logLevels.indexOf(type);
return logLevelsSorted.indexOf(logger.settings.level.toUpperCase()) >= logLevelsSorted.indexOf(type);
}

function logLocal(type, sender, msgShort, msgLong, extras) {
Expand Down Expand Up @@ -260,5 +266,13 @@ function logToConsole(type, sender, msgShort, _extras) {
}
}

logToConsole.TRACE = logLevel.TRACE;
logToConsole.DEBUG = logLevel.DEBUG;
logToConsole.INFO = logLevel.INFO;
logToConsole.WARN = logLevel.WARN;
logToConsole.ERROR = logLevel.ERROR;
logToConsole.CRITICAL = logLevel.CRITICAL;

exports.logToConsole = logToConsole;
exports.Logger = logger;
exports.Logger = logger;
exports.logLevel = logLevel;
Loading