NOTE: since v0.2.0 require('log4js') returns a function, so you need to call that function in your code before you can use it. I've done this to make testing easier (allows dependency injection).
npm install log4js
Tests now use vows, run with
vows test/logging.js. I am slowly porting the previous tests from jspec (run those with
node tests.js), since jspec is no longer maintained.
Minimalist version: var log4js = require('log4js')(); var logger = log4js.getLogger(); logger.debug("Some debug messages"); By default, log4js outputs to stdout with the coloured layout (thanks to masylum), so for the above you would see: [2010-01-17 11:43:37.987] [DEBUG] [default] - Some debug messages
var log4js = require('log4js')(); //note the need to call the function log4js.addAppender(log4js.consoleAppender()); log4js.addAppender(log4js.fileAppender('logs/cheese.log'), 'cheese'); var logger = log4js.getLogger('cheese'); logger.setLevel('ERROR'); logger.trace('Entering cheese testing'); logger.debug('Got cheese.'); logger.info('Cheese is Gouda.'); logger.warn('Cheese is quite smelly.'); logger.error('Cheese is too ripe!'); logger.fatal('Cheese was breeding ground for listeria.');
Output [2010-01-17 11:43:37.987] [ERROR] cheese - Cheese is too ripe! [2010-01-17 11:43:37.990] [FATAL] cheese - Cheese was breeding ground for listeria.
You can either configure the appenders and log levels manually (as above), or provide a
configuration file (
log4js.configure('path/to/file.json')) explicitly, or just let log4js look for a file called
log4js.json (it looks in the current directory first, then the require paths, and finally looks for the default config included in the same directory as the
An example file can be found in
test/log4js.json. An example config file with log rolling is in
patternLayout has no tests. This is mainly because I haven't found a use for it yet, and am not entirely sure what it was supposed to do. It is more-or-less intact from the original log4js.
author (of this node version)
Gareth Jones (csausdev - firstname.lastname@example.org)
The original log4js was distributed under the Apache 2.0 License, and so is this. I've tried to keep the original copyright and author credits in place, except in sections that I have rewritten extensively.