Introduction to Jade Logger

Jade Logger is a comprehensive logging library designed to meet the demands of modern application development. It offers a plethora of powerful APIs to log any range of information, from basic console logs to complex debugging information. Whether you’re developing a small script or managing a large-scale application, Jade Logger provides the tools you need to effectively capture and manage log data.

Basic Usage

  
    import { Logger } from 'jade-logger';
    const logger = new Logger();
    logger.info('This is an info message');
    logger.error('This is an error message');
  

Configurable Log Levels

You can configure different log levels to control the verbosity of your logs.

  
    import { Logger, LogLevel } from 'jade-logger';
    const logger = new Logger();
    logger.setLevel(LogLevel.DEBUG);
    logger.debug('This is a debug message');
  

Conditional Logging

Sometimes you only want to log certain information under specific conditions. Jade Logger allows you to do that effortlessly.

  
    if (logger.isLevelEnabled(LogLevel.DEBUG)) {
        logger.debug('This debug message will only be logged if DEBUG level is enabled');
    }
  

Tagged Logging

Tags can be assigned to logs for better categorization.

  
    logger.info('This is a general info', { tag: 'general' });
    logger.error('This is an error with tag', { tag: 'authentication' });
  

Custom Transports

Custom transports can be defined to output logs to various destinations, such as files or remote servers.

  
    import { FileTransport, Logger } from 'jade-logger';
    const fileTransport = new FileTransport('app.log');
    const logger = new Logger([ fileTransport ]);
    logger.info('This log is saved to a file');
  

Formatting Logs

Customize the format of your log messages.

  
    import { Logger, LogFormat } from 'jade-logger';
    const logger = new Logger({
        format: LogFormat.JSON,
        styles: false
    });
    logger.info('This log is in JSON format');
  

Embedding Metadata

Add metadata to the logs for additional context.

  
    logger.info('User logged in', { userId: 123, sessionId: 'abc123' });
  

Real-World Application Example

Here’s an example of how you might use Jade Logger in a full Express.js application.

  
    import express from 'express';
    import { Logger, LogLevel } from 'jade-logger';
    
    const app = express();
    const logger = new Logger();
    
    logger.setLevel(LogLevel.INFO);
    
    app.use((req, res, next) => {
        logger.info('Incoming request', { method: req.method, url: req.url });
        next();
    });
    
    app.get('/', (req, res) => {
        logger.info('Home page accessed');
        res.send('Welcome to the home page');
    });
    
    app.listen(3000, () => {
        logger.info('Server is running on port 3000');
    });
  

Using Jade Logger, you can maintain a comprehensive log of your application’s behavior, helping you to debug issues and monitor performance.

Hash: dc6359792a0b963e0e33840f5adac1f43629d06c765ed07a6202c5479526d569