![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n\n \n
\n ![\"NPM](\"https://img.shields.io/npm/v/nest-winston.svg\")
\n ![\"NPM](\"https://img.shields.io/npm/dw/nest-winston.svg\")
\n ![\"GitHub](\"https://img.shields.io/github/commit-activity/m/gremo/nest-winston\")
![\"Contributors\"](\"https://img.shields.io/github/contributors/gremo/nest-winston\")
\n ![\"GitHub](\"https://img.shields.io/github/last-commit/gremo/nest-winston\")
![\"GitHub](\"https://img.shields.io/github/actions/workflow/status/gremo/nest-winston/ci.yaml\")
![\"GitHub](\"https://img.shields.io/github/issues/gremo/nest-winston.svg\")
\n ![\"GitHub](\"https://img.shields.io/github/issues-pr/gremo/nest-winston\")
\n A Nest module wrapper for winston logger.\n
\n\n\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [Quick start](#quick-start)\n- [Async configuration](#async-configuration)\n- [Replacing the Nest logger](#replacing-the-nest-logger)\n- [Replacing the Nest logger (also for bootstrapping)](#replacing-the-nest-logger-also-for-bootstrapping)\n- [Injection and usage summary](#injection-and-usage-summary)\n- [Utilities](#utilities)\n- [Logger methods](#logger-methods)\n- [Upgrade](#upgrade)\n- [Contributing](#contributing)\n- [License](#license)\n\n\n\n## Installation\n\n```bash\nnpm install --save nest-winston winston\n```\n\nRequirements: NestJS 11 or 12 and Node.js 20 or later (matching NestJS' own `engines`). For older NestJS versions (5 to 10) use `nest-winston@1.x`.\n\nHaving troubles configuring `nest-winston`? Clone this repository and `cd` in a sample:\n\n```bash\ncd sample/quick-start\nnpm install\nnpm run start:dev\n```\n\nIf you want to upgrade to a major or minor version, have a look at the [upgrade](#upgrade) section.\n\n## Quick start\n\nImport `WinstonModule` into the root `AppModule` and use the `forRoot()` method to configure it. This method accepts the same options object as [`createLogger()`](https://github.com/winstonjs/winston#usage) function from the winston package:\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { WinstonModule } from 'nest-winston';\nimport * as winston from 'winston';\n\n@Module({\n imports: [\n WinstonModule.forRoot({\n // options\n }),\n ],\n})\nexport class AppModule {}\n```\n\nAfterward, the winston instance will be available to inject across entire project (and in your feature modules, being `WinstonModule` a global one) using the `WINSTON_MODULE_PROVIDER` injection token:\n\n```typescript\nimport { Controller, Inject } from '@nestjs/common';\nimport { WINSTON_MODULE_PROVIDER } from 'nest-winston';\nimport { Logger } from 'winston';\n\n@Controller('cats')\nexport class CatsController {\n constructor(@Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger) { }\n}\n```\n\n## Async configuration\n\n> **Caveats**: because the way Nest works, you can't inject dependencies exported from the root module itself (using `exports`). If you use `forRootAsync()` and need to inject a service, that service must be either imported using the `imports` options or exported from a [global module](https://docs.nestjs.com/modules#global-modules).\n\nMaybe you need to asynchronously pass your module options, for example when you need a configuration service. In such case, use the `forRootAsync()` method, returning an options object from the `useFactory` method:\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { WinstonModule } from 'nest-winston';\nimport * as winston from 'winston';\n\n@Module({\n imports: [\n WinstonModule.forRootAsync({\n useFactory: () => ({\n // options\n }),\n inject: [],\n }),\n ],\n})\nexport class AppModule {}\n```\n\nThe factory might be async, can inject dependencies with `inject` option and import other modules using the `imports` option.\n\nAlternatively, you can use the `useClass` syntax:\n\n```typescript\nWinstonModule.forRootAsync({\n useClass: WinstonConfigService,\n})\n```\n\nWith the above code, Nest will create a new instance of `WinstonConfigService` and its method `createWinstonModuleOptions` will be called in order to provide the module options.\n\n## Replacing the Nest logger\n\nThis module also provides the `WinstonLogger` class (custom implementation of the [`LoggerService`](https://github.com/nestjs/nest/blob/main/packages/common/services/logger.service.ts#L10) interface) to be used by Nest for system logging. This will ensure consistent behavior and formatting across both Nest system logging and your application event/message logging.\n\nChange your `main.ts` as shown below:\n\n```typescript\nimport { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';\n\nasync function bootstrap() {\n const app = await NestFactory.create(AppModule);\n app.useLogger(app.get(WINSTON_MODULE_NEST_PROVIDER));\n await app.listen(3000);\n}\nbootstrap();\n```\n\nThen inject the logger using the `WINSTON_MODULE_NEST_PROVIDER` token and the `LoggerService` typing:\n\n```typescript\nimport { Controller, Inject, LoggerService } from '@nestjs/common';\nimport { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';\n\n@Controller('cats')\nexport class CatsController {\n constructor(@Inject(WINSTON_MODULE_NEST_PROVIDER) private readonly logger: LoggerService) { }\n}\n```\n\nUnder the hood, the `WinstonLogger` class uses the configured winston logger instance (through `forRoot` or `forRootAsync`), forwarding all calls to it.\n\n## Replacing the Nest logger (also for bootstrapping)\n\n> **Important**: by doing this, you give up the dependency injection, meaning that `forRoot` and `forRootAsync` are not needed and shouldn't be used. Remove them from your main module.\n\nUsing the dependency injection has one minor drawback. Nest has to bootstrap the application first (instantiating modules and providers, injecting dependencies, etc.) and during this process the instance of `WinstonLogger` is not yet available, which means that Nest falls back to the internal logger.\n\nOne solution is to create the logger outside of the application lifecycle, using the `createLogger` function, and pass it to `NestFactory.create`. Nest will then wrap our winston logger (the same instance returned by the `createLogger` method) into the `Logger` class, forwarding all calls to it:\n\n```typescript\nimport { WinstonModule } from 'nest-winston';\n\nasync function bootstrap() {\n const app = await NestFactory.create(AppModule, {\n logger: WinstonModule.createLogger({\n // options (same as WinstonModule.forRoot() options)\n })\n });\n await app.listen(3000);\n}\nbootstrap();\n```\n\nAn alternative is to provide directly an instance of Winston in the options. This allows you to keep a reference to the instance and interact with it.\n\n```typescript\nimport { createLogger } from 'winston';\nimport { WinstonModule } from 'nest-winston';\n\nasync function bootstrap() {\n // createLogger of Winston\n const instance = createLogger({\n // options of Winston\n });\n const app = await NestFactory.create(AppModule, {\n logger: WinstonModule.createLogger({\n instance,\n }),\n });\n await app.listen(3000);\n}\nbootstrap();\n```\n\nThe usage afterwards for both solutions is the same. First, change your main module to provide the `Logger` service:\n\n```typescript\nimport { Logger, Module } from '@nestjs/common';\n\n@Module({\n providers: [Logger],\n})\nexport class AppModule {}\n```\n\nThen inject the logger simply by type hinting it with `Logger` from `@nestjs/common`:\n\n```typescript\nimport { Controller, Logger } from '@nestjs/common';\n\n@Controller('cats')\nexport class CatsController {\n constructor(private readonly logger: Logger) {}\n}\n```\n\nAlternative syntax using the `LoggerService` typing and the `@Inject` decorator:\n\n```typescript\nimport { Controller, Inject, Logger, LoggerService } from '@nestjs/common';\n\n@Controller('cats')\nexport class CatsController {\n constructor(@Inject(Logger) private readonly logger: LoggerService) {}\n}\n```\n\n## Injection and usage summary\n\nHere is a summary of the three techniques explained above:\n\n| Injection token | Typing | Module config | Usage |\n| :----------------------------- | :------------------------------------ | :------------ | :--------------------------------------------------------------------- |\n| `WINSTON_MODULE_PROVIDER` | `Logger` from `winston` | Yes | + Your application/message logging |\n| `WINSTON_MODULE_NEST_PROVIDER` | `LoggerService` from `@nestjs/common` | Yes | + Your application/message logging