kdts-simple-logger

A very compact logging and debugging package

Installation

$ npm install kdts-simple-logger

Usage

Debugger - standalone

// use only the debugger 
const debug = require('kdts-simple-logger').kdtsDebug;


/**
 * Debug your code
 *
 * In order to see you debug outputs, you need to insert "DEBUG=*" 
 * or at least "DEBUG=your_package_name:*" into to the script part of your package.json file
 * 
 * i.e.:
 * 	"scripts": {
 * 		...
 * 		"start:debug": "clear && NODE_ENV=development LOG_LEVEL= DEBUG=* node server.js",
 * 		...
 *	}
 */
 
debug.info('Some debug info message')
debug.warn('Some debug warning message')
debug.error('Some debug error message')

Optional step for the logger and morganLogger

The logger and morganLogger accept and object as argument which provide the path to an existing directory where logfiles can be stored

/**
 * Making sure the log-directory exists
 */
const fs = require('fs')
const path = require('path');
const logDirectory = path.join(__dirname, '../log');

// ensure the log directory exists
fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory);

const opt = {
    pathToLogDir: logDirectory
};

Logger - standalone

// without any argument
const log1 = require('kdts-simple-logger').kdtsLog()

// with an argument (of type object as defined above) specifying the path to the directory where the the log can be stored
const log1 = require('kdts-simple-logger').kdtsLog(opt)


log1.silly('Some silly log...');
log1.debug('Some debug log...');
log1.verbose('Some verbose log...');
log1.info('Some info log...');
log1.warn('Some warning log...');
log1.error('Some error log...');

// alternative logging 
log1.log('silly', 'Some silly log...');
log1.log('debug', 'Some debug log...');
log1.log('verbose', 'Some verbose log...');
log1.log('info', 'Some info log...');
log1.log('warn', 'Some warning log...');
log1.log('error', 'Some error log...');

MorganLogger - standalone

// without any argument: defaults to process.stdout and process.stderr
const log2 = require('kdts-simple-logger').kdtsMorgan()

// with an argument (of type object as defined above) specifying the path to the directory where the the log can be stored
const log2 = require('kdts-simple-logger').kdtsMorgan(opt)

// Middleware HTTP request logger using morgen under the hood
app.use(log2.morganAccessLogger);
app.use(log2.morganErrorLogger);

All at once

// without any argument
const kdtsSimpleLogger = require('kdts-simple-logger').simpleLogger();

// with an argument (of type object as defined above) specifying the path to the directory where the the log can be stored
const kdtsSimpleLogger = require('kdts-simple-logger').simpleLogger(opt);


const debug = kdtsSimpleLogger.debug;
const log1 = kdtsSimpleLogger.log;
const morganAccessLogger = kdtsSimpleLogger.morganAccessLogger;
const morganErrorLogger = kdtsSimpleLogger.morganErrorLogger;

// use them now as defined above...

Deprecated

• Defining the path to a log dir is now optional and can be left out

const options = {
    pathToLogDir: logDirectory
};

const kdtsSimpleLogger = require('kdts-simple-logger').simpleLogger(options);

• Misspelled morgenAccessLogger -> is now -> morganAccessLogger

• Misspelled morgenErrorLogger -> is now -> morganErrorLogger