Medishn-logger

A customizable and modular logger designed for both console and file-based logging with support for file rotation, buffering, color personalization, and modular transport handling.

Features

• Console and File Logging: Log messages to both console and file with custom formats.
• File Rotation: Automatically rotate log files based on size.
• Buffering: Buffer logs and flush them at intervals or when reaching a buffer size.
• Color Personalization: Customize log message colors for better console readability.
• Modular Transports: Easily configure and extend logging transports (console, file).
• Customizable Log Levels: Use predefined log levels (info, warn, error, debug) or set your own.
• Default Levels: The default log level is info if not specified.

Installation

1npm install @medishn/logger

Usage

Basic Setup

1import { Logger } from '@medishn/logger';
2
3const logger = new Logger({
4  transports: ['console', 'file'],
5  file: 'app.log',
6});
7
8logger.log({
9  message: 'Application started',
10  level: 'info',
11  category: 'APP',
12});

Customizing Log Colors

You can personalize console log colors for each log level.

1const logger = new Logger({
2  transports: ['console'],
3  console: {
4    colors: {
5      info: '\x1b[32m', // green
6      warn: '\x1b[33m', // yellow
7      error: '\x1b[31m', // red
8      debug: '\x1b[34m', // blue
9    },
10  },
11});
12
13logger.log({ message: 'Server started', level: 'info' });

File Rotation and Buffering

You can specify file rotation settings, such as maximum file size, and buffer log entries to be flushed at regular intervals.

1const logger = new Logger({
2  transports: ['file'],
3  file: 'app.log',
4  rotation: { maxSize: 1024 * 1024 }, // 1MB file size before rotating
5});
6
7logger.log({ message: 'Logging to file with rotation', level: 'debug' });

API

Logger Class

• Constructor:
  • opts: Options
    • transports: Array<"console" | "file">: Specifies where to log (console, file, or both).
    • file?: string: The path for the log file.
    • format?: "iso" | "locale": Log date format (default is "iso").
    • rotation?: { maxSize: number }: File rotation settings.
    • console?: { colors: Record<LogLevel, string> }: Custom console log colors.
• Methods:
  • log(args: Arguments.Log): Log a message.
  • close(): Closes the file transport and flushes any remaining logs.

License

This project is licensed under the MIT License.