xcally-nest-library 0.0.15 → 0.0.17

package/index.ts

@@ -9,3 +9,4 @@ export * from './src/decorators/utils.decorators';
 export * from './src/config/env.validation';
 export * from './src/modules/logger/pino/logger.service';
 export * from './src/modules/logger/pino/logger.module';
+export * from './src/modules/logger/pino/logger.default';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xcally-nest-library",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -44,6 +44,7 @@
     "nestjs-paginate": "^8.6.2",
     "nestjs-pino": "^4.1.0",
     "pino": "^9.4.0",
+    "pino-pretty": "^11.2.2",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "typeorm": "^0.3.20",

package/src/modules/logger/pino/logger.default.ts

@@ -0,0 +1 @@
+export { Logger } from 'nestjs-pino';

package/src/modules/logger/pino/logger.module.ts

@@ -1,23 +1,74 @@
-import { Module } from '@nestjs/common';
-import { LoggerService } from './logger.service';
+import { DynamicModule, Global, Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
 import { LoggerModule as LoggerModulePino } from 'nestjs-pino';
-import api from '@opentelemetry/api';
+import { LoggerService } from './logger.service';
 
-@Module({
-  providers: [LoggerService],
-  exports: [LoggerService],
-  imports: [
-    LoggerModulePino.forRoot({
-      pinoHttp: {
-        genReqId: () => {
-          const activeSpan = api.trace.getSpan(api.context.active());
-          return activeSpan.spanContext().traceId;
-        },
-        redact: {
-          paths: ['req.headers.cookie', 'req.headers.authorization'],
-        },
-      },
-    }),
-  ],
-})
-export class LoggerModule {}
+@Global()
+@Module({})
+export class LoggerModule {
+  static forRoot(): DynamicModule {
+    return {
+      module: LoggerModule,
+      providers: [LoggerService],
+      exports: [LoggerService],
+      imports: [
+        LoggerModulePino.forRootAsync({
+          imports: [ConfigModule],
+          inject: [ConfigService],
+          useFactory: async (config: ConfigService) => {
+            const projectName = process.env.npm_package_name || 'default_project';
+            return {
+              pinoHttp: {
+                level: config.get('LOG_LEVEL') || 'info',
+                // customErrorMessage?: ((req: IM, res: SR, error: Error) => string) | undefined;
+                // customErrorMessage: (req, res, error) => {
+                //   return 'Auto generated error' + error?.message;
+                // },
+                // customSuccessMessage(req, res, responseTime) {
+                //   return 'Auto generated success';
+                // },
+                // autoLogging: true,
+                // level: config.get('LOG_LEVEL') || 'info',
+                // stream: pino.destination(`./logs/info.log`),
+                redact: {
+                  paths: ['req.headers.cookie', 'req.headers.authorization'],
+                },
+                transport: {
+                  targets: [
+                    {
+                      level: 'debug',
+                      target: 'pino-pretty',
+                      options: {
+                        colorize: true,
+                      },
+                    },
+                    // {
+                    //   level: 'error',
+                    //   target: 'pino/file',
+                    //   options: {
+                    //     destination: './logs/error.log',
+                    //   },
+                    // },
+                    {
+                      level: 'info',
+                      target: 'pino/file',
+                      options: {
+                        destination: `./logs/${projectName}-info.log`,
+                        mkdir: true,
+                        append: process.env.NODE_ENV !== 'production' ? false : true,
+                      },
+                    },
+                  ],
+                },
+                // genReqId: () => { // Non't needed with pino instrumentation
+                //   const activeSpan = api.trace.getSpan(api.context.active());
+                //   return activeSpan.spanContext().traceId;
+                // },
+              },
+            };
+          },
+        }),
+      ],
+    };
+  }
+}

package/src/modules/logger/pino/logger.service.ts

@@ -1,43 +1,36 @@
 import { Injectable } from '@nestjs/common';
 import { PinoLogger } from 'nestjs-pino';
-import pino from 'pino';
 import api from '@opentelemetry/api';
 
-type PinoMethods = Pick<pino.Logger, 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal'>;
-
 @Injectable()
-export class LoggerService implements PinoMethods {
+export class LoggerService {
   constructor(private readonly logger: PinoLogger) {}
-  trace(msg: string, ...args: any[]): void {
-    const activeSpan = api.trace.getSpan(api.context.active());
-    activeSpan.addEvent(msg, ...args);
-    this.logger.trace(msg, ...args);
-  }
-  debug(msg: string, ...args: any[]): void {
+
+  debug(msg: string, meta?: any): void {
     const activeSpan = api.trace.getSpan(api.context.active());
-    activeSpan.addEvent(msg, ...args);
-    this.logger.debug(msg, ...args);
+    activeSpan.addEvent(msg);
+    this.logger.debug({ meta }, msg);
   }
-  warn(msg: string, ...args: any[]): void {
+  warn(msg: string, meta?: any): void {
     const activeSpan = api.trace.getSpan(api.context.active());
-    activeSpan.addEvent(msg, ...args);
-    this.logger.warn(msg, ...args);
+    activeSpan.addEvent(msg);
+    this.logger.warn({ meta }, msg);
   }
-  error(msg: string, ...args: any[]): void {
+  error(msg: string, meta?: any): void {
     const activeSpan = api.trace.getSpan(api.context.active());
-    activeSpan.addEvent(msg, ...args);
-    this.logger.error(msg, ...args);
+    activeSpan.addEvent(msg);
+    this.logger.error({ meta }, msg);
   }
-  fatal(msg: string, ...args: any[]): void {
+  fatal(msg: string, meta?: any): void {
     const activeSpan = api.trace.getSpan(api.context.active());
-    activeSpan.addEvent(msg, ...args);
-    this.logger.fatal(msg, ...args);
+    activeSpan.addEvent(msg);
+    this.logger.fatal({ meta }, msg);
   }
 
-  info(msg: string, ...args: any[]): void {
+  info(msg: string, meta?: any): void {
     // LOG EVENTS
     const activeSpan = api.trace.getSpan(api.context.active());
-    activeSpan.addEvent(msg, ...args);
+    activeSpan.addEvent(msg);
 
     // // LOG CORRELATION -- You can see correlation between spans and logs
     // const tracer = api.trace.getTracer(process.env.npm_package_name, process.env.npm_package_version);
@@ -46,14 +39,6 @@ export class LoggerService implements PinoMethods {
     //   span.end();
     // });
 
-    this.logger.info(msg, ...args);
-  }
-
-  log(msg: string, ...args: any[]): void {
-    const activeSpan = api.trace.getSpan(api.context.active());
-    if (activeSpan) {
-      activeSpan.addEvent(msg, ...args);
-    }
-    this.logger.info(msg, ...args);
+    this.logger.info({ meta }, msg);
   }
 }