1.0.2 • Published 8 months ago

nest-logger-plus v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

📌 Installation

npm install nest-logger-plus winston winston-daily-rotate-file

🚀 Usage

1️⃣ Import the Logger Module

Register the module in your root module (AppModule) using forRoot() and specify the log path.

import { Module } from '@nestjs/common';
import { LoggerModule } from 'nest-logger-plus';

@Module({
  imports: [LoggerModule.forRoot({ logPath: `${process.cwd()}/logs` })],
})
export class AppModule {}

2️⃣ Inject and Use Logger Service

You can inject LoggerService into any provider and use its methods:

import { Injectable } from '@nestjs/common';
import { LoggerService } from 'nest-logger-plus';

@Injectable()
export class SomeService {
  constructor(private readonly logger: LoggerService) {}

  someMethod() {
    this.logger.log('This is an info message', 'SomeService');
    this.logger.error('This is an error message', 'Error stack trace', 'SomeService');
    this.logger.warn('This is a warning message', 'SomeService');
    this.logger.debug('This is a debug message', 'SomeService');
  }
}

🎯 Logger Methods

MethodDescription
log(message: string, context?: string)Logs an info level message
error(message: string, trace?: string, context?: string)Logs an error level message with optional stack trace
warn(message: string, context?: string)Logs a warning level message
debug(message: string, context?: string)Logs a debug level message

⚙️ Configuration

OptionTypeDefaultDescription
logPathstringlogs/Path where log files will be stored

📂 Log File Rotation

  • Logs are stored in daily rotating files.
  • Maximum size per file: 10MB.
  • Logs older than 14 days are automatically deleted.

🤝 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

📜 License

This project is licensed under the MIT License.

1.0.2

8 months ago

1.0.1

8 months ago

1.0.0

8 months ago