@prommoto/execution-trace-logger

install

npm i @prommoto/execution-trace-logger

configure

1. import LoggerModule into app module and provide winston transport instance in LoggerModule configuration using forRootAsync method to add LoggerService into nest IoC system.

``ts
import * as CloudWatchTransport from 'winston-cloudwatch';
import { CloudWatchLogs } from 'aws-sdk';
import { LoggerModule } from '../logger';

import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
imports: [
LoggerModule.forRootAsync({
inject: [],
imports: [],
useFactory: () => {
return new CloudWatchTransport({
cloudWatchLogs: new CloudWatchLogs({
apiVersion: '2014-03-28',
region: 'aws-region',
credentials: {
accessKeyId: 'aws-access-key-id',
secretAccessKey: 'aws-secret-key-id',
},
}),
logGroupName: 'myLoggerGroup',
logStreamName: 'myLoggerStream',
});
},
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}
`

2. connect traceMiddleware to application module for request tracing.

`ts
export class AppModule implements NestModule {
configure(consumer: MiddlewareConsumer) {
consumer.apply(traceMiddleware).forRoutes('*');
}
}
`

usage

use LogFunctionIO decorator on class methods where you want to log function arguments and return values.

`ts
import { Controller, Post } from '@nestjs/common';
import { ApiResponse } from '@nestjs/swagger';

import { AppService } from './app.service';

import { LogFunctionIO } from '../logger';
import { CreateResourceDto } from './dto/create-resource.dto';

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

@LogFunctionIO()
@Post()
@ApiResponse({ type: CreateResourceDto })
public async getHello(): Promise {
return new CreateResourceDto();
}
}
``

useful resources

nestJS customer providers: https://docs.nestjs.com/fundamentals/custom-providers

nestJS dynamic modules: https://docs.nestjs.com/fundamentals/dynamic-modules

nestJS middleware: https://docs.nestjs.com/middleware#applying-middleware

request tracing: https://opentracing.io/docs/overview/what-is-tracing

winston: https://www.npmjs.com/package/winston