Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brettlangdon/ledger

Ledger is an event based NodeJS module used for logging events to stdout, files or MongoDB.
https://github.com/brettlangdon/ledger

Last synced: about 1 month ago
JSON representation

Ledger is an event based NodeJS module used for logging events to stdout, files or MongoDB.

Awesome Lists containing this project

README

        

#Ledger
Ledger is an event based NodeJS module used for logging to various locations.

By default Ledger can overwrite `console.log`, `console.info`, `console.warn` and `console.error` to allow all output, even output from other modules.

##Installation:
```
npm install ledger
```

##Usage:
```
//this will output all messages to the file "my/file.log"
var ledger = (require('ledger');
var logger = ledger.createLogger( {}, [
new ledger.transactions.file( { logFile: 'my/file.log' } ),
]);

ledger.on('log::error', function(time, msg){
//do something special with errors
});

ledger.on('log::*', function(time, msg){
//log catchall
});

console.log('log');
console.info('info');
console.warn('warn');
console.error('error');
```

##Options:

* `separator`: String //separator used when building messages, Default: ' > '
* `timeFormatter`: Function(date) //function used when formatting Date object to a string, Default: function(date){ return date.toString(); }

##Methods:

* `log(msg)` //mapped to console.log
* `info(msg)` //mapped to console.info
* `warn(msg)` //mapped to console.warn
* `error(msg)` //mapped to console.error
* `now()` //get the current time using timeFormatter setting
* `_log(msg,parts)` // raw logging, do not use

##Events:

* `log::log`: (time, msg) //event that gets called after a call to console.log
* `log::info`: (time, msg) //event that gets called after a call to console.info
* `log::warn`: (time, msg) //event that gets called after a call to console.warn
* `log::error`: (time, msg) //event that gets called after a call to console.error