Introduction to Kosher Logger

Kosher Logger is a robust and flexible logging library designed to simplify the process of recording events during the execution of your applications. It offers a comprehensive set of APIs that help developers log information, warnings, errors, and debug messages with ease.

Getting Started with Kosher Logger

First, you need to install Kosher Logger in your project:

  npm install kosher-logger

Basic Usage

Here is a basic example of how to use Kosher Logger:

  const KosherLogger = require('kosher-logger');

  const logger = new KosherLogger({
    level: 'info',
    transports: [
      new KosherLogger.transports.Console(),
      new KosherLogger.transports.File({ filename: 'app.log' })
    ]
  });

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

API Examples

Setting Log Level

  logger.setLevel('debug');

Customizing Log Format

  logger.setFormat((info) => {
    return `${info.timestamp} [${info.level.toUpperCase()}]: ${info.message}`;
  });

Handling Exceptions

  logger.handleExceptions(
    new KosherLogger.transports.Console(),
    new KosherLogger.transports.File({ filename: 'exceptions.log' })
  );

Adding Metadata to Logs

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

Using Different Transports

  logger.add(new KosherLogger.transports.Http({
    host: 'log-server.example.com',
    path: '/logs',
    ssl: true
  }));

Application Example

Below is an example of a small application utilizing Kosher Logger for robust logging:

  const express = require('express');
  const KosherLogger = require('kosher-logger');

  const app = express();
  const logger = new KosherLogger({
    level: 'info',
    transports: [
      new KosherLogger.transports.Console(),
      new KosherLogger.transports.File({ filename: 'app.log' })
    ]
  });

  app.use((req, res, next) => {
    logger.info(`Received request: ${req.method} ${req.url}`);
    next();
  });

  app.get('/', (req, res) => {
    logger.debug('Handling root route');
    res.send('Hello, world!');
  });

  app.use((err, req, res, next) => {
    logger.error('Unexpected error', err);
    res.status(500).send('Something went wrong');
  });

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

In this example, Kosher Logger is used to log various events such as incoming requests, route handling, and errors. This ensures that we have a clear and comprehensive log of what is happening within our application.

Hash: 7b126ecbfb099c7ac721d3b4d3aee164b15089289dd773c4788f3dfc6b153ce6