I get from logger.info method [object Object] about nest-winston HOT 5 CLOSED

Hi, let's see if @vorotech can help, he made some changes to the logging system a few days ago.

from nest-winston.

hi @MegaRoks will try to reproduce

from nest-winston.

@gremo @MegaRoks

I can reproduce and think it's misconfiguration. Might be README need to be adjusted slightly. Take a look at the existing example:

// src\logger\interceptor\logger.interceptor.ts
import { Logger } from 'winston';
...
@Injectable()
export class LoggerInterceptor implements NestInterceptor {
    constructor(@Inject(WINSTON_MODULE_PROVIDER) private logger: Logger) {}
...

And

// src\logger\winston.config.ts
...
    transports: [
        new transports.Console({
            format: format.combine(format.timestamp(), utilities.format.nestLike()),
...

The problem here is that you inject the instance of the Winston Logger, which doesn't use the nest-winston Logger to format message. So the utilities.format.nestLike() cannot output it properly.

This can be fixed in few ways.

Stay with a Winston Logger

If you want to use Winston logger the configuration Console transport formater should be adjusted, e.g. format: winston.format.json()

[Nest] 22444   - 18.09.2020, 21:29:16   [NestApplication] Nest application successfully started +2ms
{
  timestamp: '2020-09-18T18:29:16.931Z',
  method: 'GET',
  route: '/',
  data: { body: {}, query: {}, params: {} },
  from: '::1',
  madeBy: null
}
{"message":{"timestamp":"2020-09-18T18:29:16.931Z","method":"GET","route":"/","data":{"body":{},"query":{},"params":{}},"from":"::1","madeBy":null},"level":"info"}

Use Winston Nest Logger

// src\logger\interceptor\logger.interceptor.ts
import { ..., LoggerService } from '@nestjs/common';
...
@Injectable()
export class LoggerInterceptor implements NestInterceptor {
    constructor(
        @Inject(WINSTON_MODULE_NEST_PROVIDER) private readonly logger: LoggerService
    ) {}

The message would be processed by Nest Logger classes and gives the following output in combination with nestLike format:

[Nest] 28216   - 18.09.2020, 21:33:19   [NestApplication] Nest application successfully started +2ms
{
  timestamp: '2020-09-18T18:33:19.703Z',
  method: 'GET',
  route: '/',
  data: { body: {}, query: {}, params: {} },
  from: '::1',
  madeBy: null
}
[NestWinston] Info      18.09.2020, 21:33:19  - {"method":"GET","route":"/","data":{"body":{},"query":{},"params":{}},"from":"::1","madeBy":null}

Compromise solution

According to Winston documentation the transport can accept info object, every info must have at least the level and message properties.

You can provide the missed message property with the data ={} object, and get the message prepared by native Winston Logger which nestLike formatter can print.

// src\logger\interceptor\logger.interceptor.ts
...
        const data = {
            message: 'Request intercepted',
            timestamp: new Date().toISOString(),
            method: req.method,
            route: req.route.path,
            data: {
                body: body,
                query: req.query,
                params: req.params,
            },
            from: req.ip,
            madeBy: userEmail,
        };
        console.log(data);

        this.logger.info(data); 

[Nest] 18340   - 18.09.2020, 21:39:23   [NestApplication] Nest application successfully started +2ms
{
  message: 'Request intercepted',
  timestamp: '2020-09-18T18:39:25.514Z',
  method: 'GET',
  route: '/',
  data: { body: {}, query: {}, params: {} },
  from: '::1',
  madeBy: null
}
[NestWinston] Info      18.09.2020, 21:39:25 Request intercepted - {"method":"GET","route":"/","data":{"body":{},"query":{},"params":{}},"from":"::1","madeBy":null}

As you can see the message is important bit here.

from nest-winston.

@vorotech thanks for your time. If this is a documentation fault feel free to open a PR to improve it!

from nest-winston.

@vorotech Thanks for the answer and explanation.

from nest-winston.