jokesterfr / nestjs-pino-stackdriver

nestjs-pino-stackdriver

NestJS Stackdriver

Using the logger

Configured to be stackdriver compliant.

Using as default logger

import { Logger } from 'nestjs-pino-stackdriver';
// In your main JS
async function bootstrap() {
  const app = await NestFactory.create(AppModule, {
    logger: new Logger(),
  });
  await app.listen(3000);
}
bootstrap();

Using inside the app

Import it in your module

Configure it using pino options https://github.com/pinojs/pino/blob/master/docs/api.md#options

import { LoggerModule } from 'nestjs-pino-stackdriver';
@Module({
  // You can leave config empty
  imports: [LoggerModule.forRoot({ name: 'example' })],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {
}

Inject it from everywhere

import { Controller, Get, Logger } from '@nestjs/common';
@Controller()
export class AppController {
  constructor(
    private readonly logger: Logger,
  ) {
    this.logger.log('app controller booted');
  }

  @Get()
  getHello(): string {
    this.logger.log(headers);
    return 'hello';
  }
}

Correlation ID and optionnal tracer

Add in your request a correlation id if none provided

import { CorrelationTracerMiddleware } from 'nestjs-pino-stackdriver';
async function bootstrap() {
  app.use(
    CorrelationTracerMiddleware({
      // To generate logger on each request and inject correlation id
      app: app,
      // Optionnal to start tracing
      agent: require('@google-cloud/trace-agent').start(),
    }),
  );

  await app.listen(3000);
}
bootstrap();

Use log with trace and correlation id

import { Controller, Get, Headers, Query } from '@nestjs/common';

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

  @Get()
  getHello(@Headers() headers, @Query('logger') logger): string {
    logger.log('request received', 'app.getHello', headers);
    return this.appService.getHello();
  }
}

Output in production

 {"severity":"info","correlation_id":"4NTtNp4X","logging.googleapis.com/trace":"281fe620078d4562b311712cf42faefd","context":"app.getHello","message":"request received {\"host\":\"localhost:3000\",\"user-agent\":\"curl/7.64.1\",\"accept\":\"*/*\",\"x-correlation-id\":\"4NTtNp4X\"}","v":1}

Or locally

[2020-03-03 19:24:00.673 +0000] INFO : request received {"host":"localhost:3000","user-agent":"curl/7.64.1","accept":"*/*","x-correlation-id":"51eLtfXz"}
       correlation_id: "51eLtfXz"
       logging.googleapis.com/trace: "9b25e09ac8be4e0c93ba40304bf80fe8"
       context: "app.getHello"