Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

how to use inside a filter #243

Closed
rubiin opened this issue Oct 14, 2020 · 10 comments
Closed

how to use inside a filter #243

rubiin opened this issue Oct 14, 2020 · 10 comments
Labels
documentation May improve documentation

Comments

@rubiin
Copy link

rubiin commented Oct 14, 2020

I want to use this inside a filter where i am catching all 500 exceptions. can anyone provide me with some snippet to get going

@gremo
Copy link
Owner

gremo commented Oct 19, 2020

Hi, what do you mean "Use this inside a filter"?

@rubiin
Copy link
Author

rubiin commented Oct 20, 2020

i want to use the logger as to log response inside a filter

@gremo gremo added the documentation May improve documentation label Nov 11, 2020
@gremo
Copy link
Owner

gremo commented Dec 30, 2020

There is no built-in method to log request and response, it's up to the developer. However, you can use any third party library like @algoan/nestjs-logging-interceptor (or try to just google for a more popular one).

Also take a look at #268 where I provide an example to log request and response using that libray.

EDIT: if you are talking about generic Nest filters, here is the way (copy/paste from Nest documentation, adding the logger with the dependency injection):

src/HttpExceptionFilter.ts

import {
  ExceptionFilter,
  Catch,
  ArgumentsHost,
  HttpException,
  Inject,
  LoggerService
} from '@nestjs/common';
import { Request, Response } from 'express';
import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  constructor(@Inject(WINSTON_MODULE_NEST_PROVIDER) private readonly logger: LoggerService) { }

  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const request = ctx.getRequest<Request>();
    const status = exception.getStatus();

    response
      .status(status)
      .json({
        statusCode: status,
        timestamp: new Date().toISOString(),
        path: request.url,
      });
  }
}

Use this way (src/app.controller.ts):

import { Controller, Get, UseFilters } from '@nestjs/common';
import { AppService } from './app.service';
import { HttpExceptionFilter } from './HttpExceptionFilter';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  @UseFilters(HttpExceptionFilter)
  getHello(): string {
    return this.appService.getHello();
  }
}

@gremo gremo closed this as completed Dec 30, 2020
@rubiin
Copy link
Author

rubiin commented Dec 30, 2020

@gremo can we make file transports optional. I only want them when NODE_ENV = production . for other environments, I only want console transaport

@gremo
Copy link
Owner

gremo commented Dec 30, 2020

@rubiin have you see my example? Is this what you want? For making transport optional it fairly easy with a conditional.

@rubiin
Copy link
Author

rubiin commented Dec 30, 2020

@rubiin have you see my example? Is this what you want? For making transport optional it fairly easy with a conditional.

yeah , I used the other i@algoan/nestjs-logging-interceptor works out of the box for my need

@gremo
Copy link
Owner

gremo commented Dec 30, 2020

Good to know!

@rubiin
Copy link
Author

rubiin commented Dec 30, 2020

can you provide me a snippet for making transport optional, i cannot seem to get it up

@gremo
Copy link
Owner

gremo commented Dec 30, 2020

It could work this way (not tested) assuming app.modules.ts:

// Common Winston transports
let transports: winston.transport[] = [
  new winston.transports.Console({
    format: winston.format.combine(
      winston.format.timestamp(),
      nestWinstonModuleUtilities.format.nestLike(),
    ),
  }),
];

// Production Winston transports (common + custom)
if ('production' === process.env.NODE_ENV) {
  transports = [
    ...transports, new winston.transports.File({
      filename: 'logs/error.log',
      level: 'error',
    }),
  ]
}

@Module({
  imports: [
    WinstonModule.forRoot({
      transports: transports
    }),
  ],
})
export class AppModule {}

@rubiin
Copy link
Author

rubiin commented Dec 30, 2020

cool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation May improve documentation
Projects
None yet
Development

No branches or pull requests

2 participants