esrol-logger

esrol-logger

Write different type of messages, create daily log files and output colored messages to the console.

Part of Esrol

Installation

$ npm install --save esrol-logger

Node Version Compatibility

Node Version
>= 4.x

Examples

'use strict';
let Logger = require('esrol-logger');
let logger = new Logger('your-namespace');

// The following will write messages into log file
// You can use LOGGER_TYPES=* node dummy.js or LOGGER_TYPES=info,error node dummy.js
// to output message into console
logger.warning('w', 'Warning message');
logger.alert('a', 'Alert message');
logger.error('e', 'Error message');
logger.critical('c', 'Critical message');
logger.info('i', 'Info message');
logger.notice('n', 'Notice message');
logger.success('s', 'Success message');
logger.badrequest('b', 'Badrequest message');
logger.unauthorized('login', {username: 'dummy', password: 'qwerty123'});
// The debug behave just like node debug module
// and you should use the DEBUG variable
// DEBUG=your-namespace node dummy.js or DEBUG=* node dummy.js
// Note: the debug method does not write message into log file
logger.debug('Debug message');
// Or you can combine all of them like:
// DEBUG=* LOGGER_TYPES=* node dummy.js
// ENJOY THE RAINBOW :D

Logger

Methods

setLogDir(directory)

set logs directory

alert(kind, message) ⇒ string

Alert message, yellow color

critical(kind, message) ⇒ string

Critical message, red color

error(kind, message) ⇒ string

Error message, red color

warning(kind, message) ⇒ string

Warning message, yellow color

notice(kind, message) ⇒ string

Notice message, cyan color

info(kind, message) ⇒ string

Info message, cyan color

success(kind, message) ⇒ string

Success message, green color

unauthorized(kind, message) ⇒ string

Unauthorized message, yellow color

badrequest(kind, message) ⇒ string

Badrequest message, white color

static method setLogDir(directory)

set logs directory

Param	Type	Description
directory	string	abs path to the folder

alert(kind, message) ⇒ string

Alert message, yellow color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

critical(kind, message) ⇒ string

Critical message, red color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

error(kind, message) ⇒ string

Error message, red color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

warning(kind, message) ⇒ string

Warning message, yellow color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

notice(kind, message) ⇒ string

Notice message, cyan color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

info(kind, message) ⇒ string

Info message, cyan color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

success(kind, message) ⇒ string

Success message, green color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

unauthorized(kind, message) ⇒ string

Unauthorized message, yellow color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

badrequest(kind, message) ⇒ string

Badrequest message, white color

Returns: string - message - formatted message

Param	Type	Description
kind	string	additional info about the operation
message	mixed	the message to be written

Note

If NODE_ENV=production the message will not be shown in the console

Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

License

MIT