Class: LoggerModule

Logger Module imports all configuration needed for logger and sentry With classes for request interceptor and Exceptions filters where will automatically log for any request or unhandled exceptions.

Example

// app.module.ts
@Module({
  imports: [
    LoggerModule.forRoot({logLevel: ['log', 'error']})
  ]
})
export class AppModule {}
 
// main.ts
async function bootstrap() {
  // create the app
  const app = await NestFactory.create(AppModule);
 
  // custom logger
  const customLoggerService = app.get(LoggerService);
  customLoggerService.addTransport(app.get(LoggerSentryTransport));
 
  // inform app of the custom logger
  app.useLogger(customLoggerService);
}
 
// test.class.ts
@Injectable()
class TestClass {
  // Inject Logger Service
  constructor(@Inject(LoggerService) private loggerService: LoggerService) {}
 
  doSomething() {
    this.loggerService.log('Did something');
  }
}
 
// my.util.ts
function myHelper() {
  const logger = new Logger(); // <-- using the global logger
  logger.log('My helper ran'); // <-- LoggerService.log will be called
}

Extends

• LoggerModuleClass

Constructors

new LoggerModule()

new LoggerModule(): LoggerModule

Returns

LoggerModule

Inherited from

LoggerModuleClass.constructor

Defined in

node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Methods

forFeature()

static forFeature(options): DynamicModule

Parameters

Returns

DynamicModule

Defined in

packages/nestjs-logger/src/logger.module.ts:76 (opens in a new tab)

forRoot()

static forRoot(options): DynamicModule

Parameters

Returns

DynamicModule

Defined in

packages/nestjs-logger/src/logger.module.ts:68 (opens in a new tab)

forRootAsync()

static forRootAsync(options): DynamicModule

Parameters

Returns

DynamicModule

Defined in

packages/nestjs-logger/src/logger.module.ts:72 (opens in a new tab)

register()

static register(options): DynamicModule

Parameters

Returns

DynamicModule

Overrides

LoggerModuleClass.register

Defined in

packages/nestjs-logger/src/logger.module.ts:60 (opens in a new tab)

registerAsync()

static registerAsync(options): DynamicModule

Parameters

Returns

DynamicModule

Overrides

LoggerModuleClass.registerAsync

Defined in

packages/nestjs-logger/src/logger.module.ts:64 (opens in a new tab)