Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to use nestjs Logging service

I tried to use the internal Logger of nestjs (described on https://docs.nestjs.com/techniques/logger -> but with no description of how to use it)

But I had problems (tried to inject LoggerService and so on)

Can anybody explain how to do this?

like image 815
maku_at Avatar asked Oct 04 '18 15:10

maku_at


People also ask

What logger does Nestjs use?

Nest comes with a built-in text-based logger which is used during application bootstrapping and several other circumstances such as displaying caught exceptions (i.e., system logging). This functionality is provided via the Logger class in the @nestjs/common package.

What does Nest build do?

nest build is a wrapper on top of the standard tsc compiler (for standard projects) or the webpack compiler (for monorepos). It does not add any other compilation features or steps except for handling tsconfig-paths out of the box.


1 Answers

Best practice

Better than accessing the Logger statically is to create an instance for your class:

@Controller() export class AppController {   private readonly logger = new Logger(AppController.name);    @Get()   async get() {     this.logger.log('Getting stuff');   } } 

Why is this better?

  1. You can provide a context in the constructor like new Logger(AppController.name) so that the class name (or anything else) will be part of all log messages in this class.

  2. If you at some point want to extend or replace the default LoggerService, you do not need to change any of your application code besides setting the new logger. Your new logger will automatically be used. If you access it statically it will continue to take the default implementation.

const app = await NestFactory.create(AppModule, {logger: new MyLogger()}); 
  1. You can mock the Logger in your tests:
module.useLogger(new NoOpLogger()); 
like image 130
Kim Kern Avatar answered Sep 20 '22 21:09

Kim Kern