Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.68 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.68 KB

node-logger

http://github.com/quirkey/node-logger

SUMMARY

A simple logging library that combines the simple APIs of Ruby's logger.rb and browser-js console.log()

USAGE

A logger has 5 different levels of logging in a specific order:

'fatal', 'error', 'warn', 'info', 'debug'

Each of these log levels has its own method on the logging instance. You can set the maximum log level on a logger at runtime.

By default, a logger writes to STDOUT, but given a writeable file path, it will log directly to a file.

Instantiation:

// node/common.js style 
var logger = require('./logger').createLogger(); // logs to STDOUT
var logger = require('./logger').createLogger('development.log'); // logs to a file

Logging:

Any of the logging methods take n arguments, which are each joined by ' ' (similar to console.log()). If an argument is not a string, it is string-ified by sys.inspect()

logger.info('loading an array', [1,2,3], 'now!');
//=> info [Sat Jun 12 2010 01:12:05 GMT-0400 (EDT)]  loading an array [ 1, 2, 3, [length]: 3 ] now!
logger.debug('this wont be logged');
//=> false
logger.setLevel('debug');
logger.debug('this will be logged now');
//=> debug [Sat Jun 12 2010 01:12:54 GMT-0400 (EDT)]  this will be logged now

Customization:

You can completely customize the look of the log by overriding the format() method on a logger.

logger.format = function(level, date, message) {
  return date.getTime().toString() + "; " + message;
};
logger.debug('message');
//=> 1276365362167;  message

COMMENTS/ISSUES:

F-f-fork it, baby.

LICENSE

MIT, see the source.