logger-facade-nodejs v2.0.0

Logger Facade Nodejs

Simple node module to work as logger facade.

This simple logger facade allows you to hook plugins to execute async logging.

The logger facade contract:

// register a plugin on logger
Logger.use(plugin);
// retrieve the list of plugin names
Logger.plugins();
// clean  up the list of plugins
Logger.clearPlugins();
// retrieve a logger with the specified name
var log = Logger.getLogger("Log Name");

The logger contract is:

log.isDebug(); // return if in debug or trace level
log.trace("Message to log %s and should be hidden due to log level", 'with args');
log.trace({someinfo: true}, "Message to log %s and should be hidden due to log level", 'with args');
log.debug("Message to log %s", 'with args');
log.debug({someinfo: true}, "Message to log %s", 'with args');
log.info("Message to log %s", 'with args');
log.info({someinfo: true}, "Message to log %s", 'with args');
log.warn("Message to log %s", 'with args');
log.warn({someinfo: true}, "Message to log %s", 'with args');
log.error("Message to log %s", 'with args');
log.error({someinfo: true}, "Message to log %s", 'with args');

The logger uses util.format to build log message.

The plugins must follow this contract:

plugin = {
  name: 'mock',
  isDebug: Function.apply(),
  trace: Function.apply(),
  debug: Function.apply(),
  info: Function.apply(),
  warn: Function.apply(),
  error: Function.apply()
};

How to use it

Install it:

npm install logger-facade-nodejs

Set up plugins

var Logger = require('logger-facade');

var plugin = {
  name: 'mock',
  isDebug: Function.apply(),
  trace: Function.apply(),
  debug: Function.apply(),
  info: Function.apply(),
  warn: Function.apply(),
  error: Function.apply()
};

Logger.use(plugin);

var log = Logger.getLogger("Log Name");

log.debug("something to log");

log.info("something to log in %s", 'info');

Available plugins

• Console
• Airbrake (Will be developed soon)
• Elasticsearch (Will be developed soon)

Do you need some other plugin?

Feel free to create one and get in touch with me, that i will add it to this list.

Using peer dependency

This module work as singleton, if you need to distribute a library that uses it due to npm Module Cache Caveats you need to add it as peer dependency.

Example:

// The App module
{
  "name": "app",
  "version": "0.0.1",
  "dependencies": {
    "logger-facade-nodejs": "0.0.1",
    "framework": "0.0.1"
  }
}
// The framework module
{
  "name": "framework",
  "version": "0.0.1",
  "peerDependencies": {
    "logger-facade-nodejs": "0.0.1",
  }
}

Contributing

Bug fixes and new features are of course very welcome!

To get started developing:

• Install Grunt
• Install dependencies with npm install
• Run the test suite with npm test

Please accompany any Pull Requests with the relevant test cases and make sure everything else still passes :).

Credits

Shout out to @pjanuario.