dankopayk

danpayk

one_eye_jackei

@payk/nestjs-winston

  "description": "Winston for Nest has never been this easy",

"author": "Dan Shapir <danshapir89@gmail.com>",

    "lint": "tslint --project tsconfig.json",

    "test-juint": "mocha --opts .mocharc --reporter mocha-junit-reporter",

    "@nestjs/platform-express": "^6.6.7",

    "@nestjs/common": "^5.0.0 || ^6.6.0",

  "homepage": "https://github.com/pay-k/nestjs-winston#readme",

    "url": "git+https://github.com/pay-k/nestjs-winston.git"

    "url": "https://github.com/pay-k/nestjs-winston/issues"

Winston for <a href="https://github.com/nestjs/nest">NestJS</a> has never been this easy!

This package not only wraps winston into a Nest Module like other packages, it also creates a Nest LoggerService, so you can keep using the default NestJS logger, which enjoying winston.

But that's not all, it also takes those great things from the NestJS Logger. It adds the context into the winston meta (so it can later be search and indexed in your ELK/Datadog).

Another great feature is the winston formatter add to the class that in local mode allows easy and readable logs to the console.

Import `WinstonModule` 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:

import { WinstonModule } from 'nest-winston';

> **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).

Maybe 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:

The factory might be async, can inject dependencies with `inject` option and import other modules using the `imports` option.

## Use as the main Nest Logger (preferred way)

If you want to use winston logger across the whole app, including bootstrapping and error handling, use the following:

import { WINSTON_MODULE_NEST_PROVIDER } from '@payk/nestjs-winston';

  const app = await NestFactory.create(AppModule);

  app.useLogger(app.get(WINSTON_MODULE_NEST_PROVIDER));

  private readonly logger = new Logger(ClassName.name);

`WinstonModule` is a global module, it will be available in all you feature modules.

A provider will then be exposed to allow easy injection.

import { Controller, Inject } from '@nestjs/common';

import { Controller, Inject, Logger } from '@nestjs/common';

import { WINSTON_MODULE_PROVIDER } from '@payk/nestjs-winston';

  constructor(@Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger) { }

  // To send metadata we need to pass the message inside an object

  // since the nestjs logger doesn't support meta by default

  this.logger.log({ message: 'Your message here', { meta: 'data', goes: 'here'}});

  // If we just want a message, it can be passed as it

  this.logger.log('Only a message if no metadata is needed')

To allow a better visibility a unique formatter is provided

import { winstonConsoleFormat } from '@payk/nestjs-winston';

  defaultMeta: { service: 'user-service' },

      format: winston.format.combine(winston.format.timestamp(), winston.format.colorize({ all: true }), winstonConsoleFormat

                winston.format.timestamp(),

                winston.format.colorize({ all: true }),

		{
		"name": "@payk/nestjs-winston",
		"version": "1.1.3",
		"version": "1.1.4",
		"license": "MIT",
		@@ -5,0 +5,0 @@ "description": "Winston for Nest has never been this easy",

		@@ -16,2 +16,8 @@ <p align="center">

		## What does it do?
		This package not only wraps winston into a Nest Module like other packages, it also creates a <b>Nest LoggerService</b>, so you can keep using the default NestJS logger, which enjoying winston.
		But that's not all, it also takes those great things from the NestJS Logger. It adds the context into the winston meta (so it can later be search and indexed in your <b>ELK/Datadog</b>).

		Another great feature is the <b>winston formatter</b> add to the class that in local mode allows easy and readable logs to the console.

		## Quick Start
		@@ -91,4 +97,3 @@
		```typescript
		import { Controller, Inject } from '@nestjs/common';
		import { Logger } from 'winston';
		import { Controller, Inject, Logger } from '@nestjs/common';
		import { WINSTON_MODULE_PROVIDER } from '@payk/nestjs-winston';
		@@ -100,2 +105,12 @@
		}

		@Get()
		public getCats() {
		// To send metadata we need to pass the message inside an object
		// since the nestjs logger doesn't support meta by default
		this.logger.log({ message: 'Your message here', { meta: 'data', goes: 'here'}});

		// If we just want a message, it can be passed as it
		this.logger.log('Only a message if no metadata is needed')
		}
		```
		@@ -114,3 +129,7 @@ ## Nest Winston Formatter
		new winston.transports.Console({
		format: winston.format.combine(winston.format.timestamp(), winston.format.colorize({ all: true }), winstonConsoleFormat
		format: winston.format.combine(
		winston.format.timestamp(),
		winston.format.colorize({ all: true }),
		winstonConsoleFormat
		)
		})
		@@ -117,0 +136,0 @@ ]

Improved metrics