Welcome to Sample Logger: Your Comprehensive Logging Solution

Logging is a crucial aspect of modern applications, enabling developers to track, diagnose, and debug issues efficiently. The sample-logger library offers a versatile and robust solution for your logging needs. This guide introduces sample-logger and provides detailed explanations of its API, accompanied by practical code snippets.

Getting Started

To begin using sample-logger, install it via npm:

npm install sample-logger

Basic Usage

Initialize and configure the logger:

    const logger = require('sample-logger');

    // Initialize with default settings
    const log = logger.createLogger();
    

Logging Levels

sample-logger comes with multiple logging levels:

    log.info('This is an info message');
    log.warn('This is a warning message');
    log.error('This is an error message');
    log.debug('This is a debug message');
    

Custom Configuration

Configure the logger according to your preferences:

    const log = logger.createLogger({
        level: 'debug',
        format: logger.format.simple(),
        transports: [
          new logger.transports.Console(),
          new logger.transports.File({ filename: 'app.log' })
        ]
    });
    

Advanced Features

Log Rotation

Enable log rotation to manage log file sizes:

    const log = logger.createLogger({
        transports: [
          new logger.transports.File({ 
            filename: 'app.log', 
            maxsize: 1024, 
            maxFiles: 3 
          })
        ]
    });
    

Custom Formats

Define custom log formats:

    const { combine, timestamp, printf } = logger.format;

    const customFormat = printf(({ level, message, timestamp }) => {
        return `${timestamp} [${level}] : ${message}`;
    });

    const log = logger.createLogger({
        format: combine(
            timestamp(),
            customFormat
        ),
        transports: [new logger.transports.Console()]
    });
    

Real-World Application Example

Here is an example of integrating sample-logger into a simple Node.js application:

    const express = require('express');
    const logger = require('sample-logger');

    const app = express();
    const log = logger.createLogger({
        level: 'info',
        format: logger.format.json(),
        transports: [new logger.transports.Console()]
    });

    app.use((req, res, next) => {
        log.info(`Request received: ${req.method} ${req.url}`);
        next();
    });

    app.get('/', (req, res) => {
        log.info('Handling root endpoint');
        res.send('Hello, world!');
    });

    app.listen(3000, () => {
        log.info('Server is running on port 3000');
    });
    

With sample-logger, your applications can benefit from enhanced logging capabilities, leading to better monitoring and faster issue resolution. Leveraging these features, you can ensure your application runs smoothly with comprehensive logs to back you up.

Hash: ac4e420647e15a279b17fbf0786982b04fd93b53957d4bc39b56a7de773230f0