1.0.1 • Published 3 years ago

logification v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

logification

Simple logger using console.log(), console.group(), some funky ASCII, coloring and custom delimiters - supports log-levels acc. to RFC5424.

Simple logger using console.log(), console.group() and some funky ASCII, please note that additionally to the severity-level according to RFC5424, another distinction is made here via 'type' This allows better fine-tuning of the logger. Lets assume you encounter a warning (level 4), but you still want to display the console-log with an error-decoration in some special cases in order to draw attention when looking at the log, you can use the type 'err'.

To additionally write the log to file, set the value for 'writeToFile' in 'loggly-config.json' to true and set the correct path for 'logFileLocation'

//      .------.     _______________ 
//     /  _)  __\   |  E R R O R !  |
//    |      ( )/   |_  ____________|
//     \___     \     |/
//         ``||||      

INFO:

Installation:

npm i logification --save

Logging levels/priorities according to RFC5424:

Levelpriority
emerg0
alert1
crit2
error3
warning4
notice5
info6
debug7

Logging states of the app in './loggly-config.json' (can be changed at runtime):

Logging-statebehaviour
verboseLog msgs of all priorities (0-7)
normalLog msgs of the priorities 0-4
silentNo logging at all

Logging source-types (adapt/extend as needed):

Log-statement sources can be added/edited/removed, will be shown with source-specififc delimiters for differentiation.

SourceExplanation
dbdatabase related msgs
appmain app module related msgs
routeroute related msgs
mqttmqtt related msgs

Usage Example

In this case we are logging an error if the env-vars can't be required, calling loggly with three arguments (msg, level, source).

const dotenvAbsolutePath = path.join(__dirname, '.env');
const dotenv = require('dotenv').config({
  path: dotenvAbsolutePath
});
if (dotenv.error) {
  loggly.error(`ERROR WHILE READING ENV-VARS: \n${dotenv.error}`, 'err', 'app.js');
  throw dotenv.error;
}