Comprehensive Guide to Logging with log4js in Node.js

Photo by James Harrison on Unsplash

Introduction: Effective logging becomes more important for monitoring and debugging as applications become more complicated. One of the most extensively used libraries for logging in Node.js, a well-liked runtime environment, is log4js. The logging capabilities of your Node.js applications can be improved by setting up and configuring log4js, a robust and adaptable logging framework for Node.js, as we will see in this blog post.

1. What is log4js? Log4js is a logging framework for Node.js inspired by the widely known Apache log4j library. As well as categorising logs into different levels and directing them to different locations, such files, the console, or distant servers, it enables developers to manage the output and format of log messages. Given its wide range of functionality, log4js is a well-liked option for Node.js developers looking to deploy logging effectively.
2. Installing log4js: To begin using log4js in your Node.js project, you first need to install it. Open your terminal or command prompt and execute the following command:

npm install log4js

3. Basic Configuration: Once you have installed log4js, the next step is to set up the basic configuration. Create a log4js.json or log4js.js file to define the loggers, appenders, and layouts. This configuration file allows you to control various aspects of logging, such as log levels, log file paths, and log message formats.
A simple log4js.json configuration might look like this:

{
  "appenders": {
    "console": { "type": "console" },
    "file": {
      "type": "file",
      "filename": "logs/app.log",
      "maxLogSize": 10485760, // 10MB
      "backups": 3,
      "compress": true
    }
  },
  "categories": {
    "default": { "appenders": ["console", "file"], "level": "info" }
  }
}

4. Logging Levels: Log4js supports multiple logging levels to categorize log messages based on their importance and severity. The standard logging levels are (in increasing order of severity):

• TRACE
• DEBUG
• INFO
• WARN
• ERROR
• FATAL

Developers can set the desired logging level for each logger or category, allowing them to control the verbosity of log messages.

5. Logging in Node.js: After configuring log4js, you can start logging messages in your Node.js application. Import the log4js module, create a logger based on the category defined in the configuration, and use the logging methods accordingly:

const log4js = require('log4js');
const logger = log4js.getLogger();

// Logging messages with different levels
logger.trace('This is a TRACE message.');
logger.debug('This is a DEBUG message.');
logger.info('This is an INFO message.');
logger.warn('This is a WARN message.');
logger.error('This is an ERROR message.');
logger.fatal('This is a FATAL message.');

6. Appenders and Layouts: Log4js allows developers to direct log messages to different appenders, which are responsible for handling the output. Appenders can be console, file, or even remote destinations like databases or log aggregation services.

Additionally, log4js supports different layouts to format the log messages, including basic, JSON, and pattern layouts. You can choose the appropriate layout based on your logging requirements.

7. Advanced Configurations: More complex setups are now available with log4js, including log rolling, which lets you divide log files according to size or date, and employing several categories and appenders for finer-grained control over logging.

Conclusion: In this blog post, we explored log4js, a powerful logging framework for Node.js. We learned how to set up log4js, configure logging levels, and use different appenders and layouts. With log4js, developers can implement effective logging in their Node.js applications, making it easier to monitor application behavior and identify potential issues.

Developers may maintain a thorough log of their application’s actions by utilising the adaptability and rich capabilities of log4js, which improves troubleshooting and increases overall application stability. When it comes to reliable and effective logging in Node.js, log4js may be a useful tool whether you are working on a small project or a large-scale application.

Happy Learning! Feel free to connect with me on LinkedIn!