log4js

What is log4js?

The log4js npm package is a logging library for Node.js, inspired by the Java-based Log4j. It provides a flexible logging system that can be configured to log to the console, to files, or to external logging services. It supports multiple log levels, categories, and appenders, allowing for fine-grained control over logging output.

What are log4js's main functionalities?

Basic Logging

This code sets up log4js to log messages to the standard output (console). It configures an appender named 'out' that writes to stdout and sets the default logging level to 'info'.

const log4js = require('log4js');
log4js.configure({
  appenders: { 'out': { type: 'stdout' } },
  categories: { default: { appenders: ['out'], level: 'info' } }
});
const logger = log4js.getLogger();
logger.info('Informational message');

File Appender

This code configures log4js to write log messages to a file named 'app.log' in the 'logs' directory. It creates a file appender and sets the logging level to 'warn'.

const log4js = require('log4js');
log4js.configure({
  appenders: { 'file': { type: 'file', filename: 'logs/app.log' } },
  categories: { default: { appenders: ['file'], level: 'info' } }
});
const logger = log4js.getLogger();
logger.warn('Warning message');

Log Levels

This code demonstrates the use of different log levels available in log4js. Each level represents a different severity of logging, with 'trace' being the least severe and 'fatal' being the most severe.

const log4js = require('log4js');
const logger = log4js.getLogger('myCategory');
logger.trace('Trace message');
logger.debug('Debug message');
logger.info('Info message');
logger.warn('Warn message');
logger.error('Error message');
logger.fatal('Fatal message');

Multiple Appenders and Categories

This code shows how to configure multiple appenders and categories. The 'default' category logs to both the console and a file, while the 'special' category logs only to a file and only logs messages at the 'error' level or higher.

const log4js = require('log4js');
log4js.configure({
  appenders: {
    'out': { type: 'stdout' },
    'file': { type: 'file', filename: 'logs/app.log' }
  },
  categories: {
    default: { appenders: ['out', 'file'], level: 'info' },
    special: { appenders: ['file'], level: 'error' }
  }
});
const defaultLogger = log4js.getLogger();
defaultLogger.info('Default category, logged to console and file');
const specialLogger = log4js.getLogger('special');
specialLogger.error('Special category, logged to file only');

Other packages similar to log4js

winston

Winston is a multi-transport async logging library for Node.js. Like log4js, it supports multiple transports (e.g., file, console, HTTP) and custom log levels. It is highly configurable and is considered one of the most popular logging solutions in the Node.js ecosystem, often compared to log4js for its rich features and flexibility.

bunyan

Bunyan is a simple and fast JSON logging library for Node.js services. It includes a CLI tool for pretty-printing log files. Bunyan's focus on JSON logging format makes it particularly suitable for use in large-scale distributed systems where log aggregation and analysis are important. It is less configurable than log4js and winston but is valued for its simplicity and streaming capabilities.

pino

Pino is a very low-overhead Node.js logger that outputs logs in JSON format. It is designed for performance and can be significantly faster than other logging libraries like log4js, especially in high-throughput scenarios. Pino's API is relatively minimal compared to log4js, focusing on delivering the best performance possible.

README

log4js-node

This is a conversion of the log4js framework to work with node. I've mainly stripped out the browser-specific code and tidied up some of the javascript. It includes a basic file logger, with log rolling based on file size. It also enhances the default console logging functions (console.log, console.debug, etc) so that they use log4js and can be directed to a file, with log rolling etc - which is handy if you have some third party modules that use console.log but want that output included in your application log files.

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).

installation

npm install log4js

tests

Tests now use vows, run with vows test/logging.js.

usage

Minimalist version: var log4js = require('log4js')(); var logger = log4js.getLogger(); logger.debug("Some debug messages"); Even more minimalist version: require('log4js')(); console.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

See example.js:

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.

configuration

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 log4js.js file). An example file can be found in test/log4js.json. An example config file with log rolling is in test/with-log-rolling.json You can also pass an object to the configure function, which has the same properties as the json versions.

todo

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 - [e-mail])

License

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.