Merge pull request #30 from internxt/feat/add-pino-logger

[_] feat(logger): add pino logger with abstraction

Author: apsantiso

package.json

@@ -41,9 +41,12 @@
     "cross-env": "^7.0.3",
     "helmet": "^8.1.0",
     "jsonwebtoken": "^9.0.2",
+    "nestjs-pino": "^4.4.0",
     "passport": "^0.7.0",
     "passport-jwt": "^4.0.1",
     "pg": "^8.14.1",
+    "pino-http": "^10.5.0",
+    "pino-pretty": "^13.1.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "sequelize": "^6.37.6",

src/app.module.ts

@@ -7,6 +7,7 @@ import { SequelizeModule, SequelizeModuleOptions } from '@nestjs/sequelize';
 import { format } from 'sql-formatter';
 import { UserModule } from './modules/user/user.module';
 import { WebhookModule } from './modules/webhook/webhook.module';
+import { LoggerModule } from './common/logger/logger.module';
 
 const defaultDbConfig = (
   configService: ConfigService,
@@ -49,6 +50,7 @@ const defaultDbConfig = (
       load: [configuration],
       isGlobal: true,
     }),
+    LoggerModule,
     SequelizeModule.forRootAsync({
       imports: [ConfigModule],
       inject: [ConfigService],

src/common/logger/logger.module.ts

@@ -0,0 +1,42 @@
+import { Global, Module } from '@nestjs/common';
+import { LoggerModule as PinoLoggerModule } from 'nestjs-pino';
+import { Request } from 'express';
+import { AppLoggerService } from './pino-logger.service';
+
+const isDevelopment = process.env.NODE_ENV === 'development';
+
+@Global()
+@Module({
+  imports: [
+    PinoLoggerModule.forRoot({
+      pinoHttp: {
+        level: isDevelopment ? 'debug' : 'info',
+        transport: isDevelopment
+          ? {
+              target: 'pino-pretty',
+              options: {
+                colorize: true,
+                singleLine: false,
+                ignore: 'pid,hostname',
+                messageFormat: '{context} {msg}',
+                errorLikeObjectKeys: ['err', 'error'],
+              },
+            }
+          : undefined,
+        formatters: {
+          level: (label: string) => ({ level: label }),
+        },
+        serializers: {
+          req: (req: Request) => ({
+            id: req.id,
+          }),
+          res: undefined,
+        },
+        autoLogging: false,
+      },
+    }),
+  ],
+  providers: [AppLoggerService],
+  exports: [AppLoggerService],
+})
+export class LoggerModule {}

src/common/logger/pino-logger.service.ts

@@ -0,0 +1,5 @@
+import { Injectable, LoggerService } from '@nestjs/common';
+import { Logger } from 'nestjs-pino';
+
+@Injectable()
+export class AppLoggerService extends Logger implements LoggerService {}

src/main.ts

@@ -8,20 +8,18 @@ import {
 import configuration from './config/configuration';
 import helmet from 'helmet';
 import { NestExpressApplication } from '@nestjs/platform-express';
-import { ConsoleLogger } from '@nestjs/common';
+import { AppLoggerService } from './common/logger/pino-logger.service';
 
 const config = configuration();
 const APP_PORT = config.port || 3000;
 
 async function bootstrap() {
   const app = await NestFactory.create<NestExpressApplication>(AppModule, {
-    logger: new ConsoleLogger({
-      colors: config.isDevelopment,
-      prefix: 'meet-server',
-      compact: config.isProduction,
-    }),
+    bufferLogs: true,
   });
 
+  app.useLogger(app.get(AppLoggerService));
+
   app.enableCors();
   app.use(helmet());
   app.disable('x-powered-by');