@vvlad1973/simple-logger

A simple logger module for Node.js applications with support for various logging levels.

Installation

npm install vvlad1973-simple-logger

Features

• Supports logging at different levels: TRACE, DEBUG, INFO, WARN, ERROR, FATAL.
• Allows integration with external logging libraries like Pino.

Usage

Simple Logger

import SimpleLogger from 'vvlad1973-simple-logger';

const logger = new SimpleLogger('DEBUG');

logger.debug('Debug message');
logger.info('Info message');
logger.warn('Warning message');
logger.error('Error message');
logger.fatal('Fatal error message');

Integration with Pino

import pino from 'pino';
import SimpleLogger from 'vvlad1973-simple-logger';

// Initialize Pino logger
const pinoLogger = pino({
  prettyPrint: true,
});

// Use Pino logger with SimpleLogger
const logger = new SimpleLogger('DEBUG', pinoLogger);

logger.debug('Debug message');
logger.info('Info message');
logger.warn('Warning message');
logger.error('Error message');
logger.fatal('Fatal error message');

API

new SimpleLogger(level, externalLogger)

Creates a new instance of SimpleLogger.

• level (optional): Initial logging level. Defaults to 'INFO'.
• externalLogger (optional): External logger instance. Can be an object with methods (trace, debug, info, warn, error, fatal) or any other logger compatible with these methods.

setLevel(level)

Sets the logging level of the logger instance.

• level: The logging level to set ('TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL').

setExternalLogger(logger)

Sets an external logger instance to be used by SimpleLogger.

• logger: External logger instance. Should be an object with methods (trace, debug, info, warn, error, fatal) or any other logger compatible with these methods.

logFunctionStart(functionName?)

Logs the start of a function.

• functionName (optional): Name of the function to log. If not provided, attempts to retrieve the caller function name.

logFunctionEnd(functionName?)

Logs the end of a function.

• functionName (optional): Name of the function to log. If not provided, attempts to retrieve the caller function name.

Documentation

Full information about the package is available in the ./docs directory

License

This project is licensed under the MIT License with Commercial Use.

Author

Vladislav Vnukovskiy [email protected]