feat: add custom logger (#29)

* feat: add custom logger

* feat: add custom logger

* feat: add custom logger

* feat: add custom logger

Author: Sebastian-Iwanczyszyn

README.md

@@ -322,19 +322,58 @@ export class CustomExceptionListener implements ExceptionListener {
 }
 ```
 
+---
+
+## 📝 Custom Logger
+
+By default, the messaging system uses Nest’s built-in `NestLogger` for logging.  
+However, you can plug in your own **custom logger** to gain more control over how messages and errors are recorded.
+
+A custom logger must implement the interface `MessagingLogger` interface:
+
+### Providing a custom logger
+
+When configuring the **messaging module**, you can pass your own logger instance via options `customLogger`.
+```ts
+@Module({
+  imports: [
+    MessagingModule.forRoot({
+      customLogger: new MyCustomLogger(),
+       ...
+    }),
+  ],
+})
+export class AppModule {}
+```
+or if you defined it as provider
+```ts
+@Module({
+  imports: [
+    MessagingModule.forRoot({
+      customLogger: MyCustomLogger,
+       ...
+    }),
+  ],
+   providers: [
+      MyCustomLogger,
+   ],
+})
+export class AppModule {}
+```
+
 ## Configuration options
 Here’s a table with the documentation for the `MessagingModule.forRoot` configuration you requested, breaking it into **buses**, **channels** (with descriptions of both channels), and their respective properties, descriptions, and default values:
 
 ### `MessagingModule.forRoot` Configuration
 <br>
 
-| **Property**   | **Description**                                                        | **Default Value**             |
-|----------------|------------------------------------------------------------------------|-------------------------------|
-| **`buses`**    | Array of message buses that define routing and processing of messages. | `[]` (empty array by default) |
-| **`channels`** | Array of channel configurations used by the message buses.             | `[]` (empty array by default) |
-| **`debug`**    | Enables or disables debug mode for logging additional messages.        | `false`                       |
-| **`logging`**  | Enables or disables logging for bus activity (e.g., message dispatch). | `true`                        |
-
+| **Property**       | **Description**                                                                  | **Default Value**             |
+|--------------------|----------------------------------------------------------------------------------|-------------------------------|
+| **`buses`**        | Array of message buses that define routing and processing of messages.           | `[]` (empty array by default) |
+| **`channels`**     | Array of channel configurations used by the message buses.                       | `[]` (empty array by default) |
+| **`debug`**        | Enables or disables debug mode for logging additional messages.                  | `false`                       |
+| **`logging`**      | Enables or disables logging for bus activity (e.g., message dispatch).           | `true`                        |
+| **`customLogger`** | Instance of a class implements `MessagingLogger` for custom logging integration. | `NestLogger`                  |
 ---
 
 ### Buses

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjstools/messaging",
-  "version": "2.21.0",
+  "version": "2.22.0",
   "description": "Simplifies asynchronous and synchronous message handling with support for buses, handlers, channels, and consumers. Build scalable, decoupled applications with ease and reliability.",
   "author": "Sebastian Iwanczyszyn",
   "license": "MIT",

src/config.ts

@@ -2,6 +2,7 @@ import { ObjectForwardMessageNormalizer } from './normalizer/object-forward-mess
 import { Type } from '@nestjs/common';
 import { DynamicModule } from '@nestjs/common/interfaces/modules/dynamic-module.interface';
 import { ForwardReference } from '@nestjs/common/interfaces/modules/forward-reference.interface';
+import { MessagingLogger } from './logger/messaging-logger';
 
 export type DefineChannels = ChannelConfig[];
 
@@ -162,4 +163,5 @@ export interface MandatoryMessagingModuleOptions {
   debug?: boolean;
   logging?: boolean;
   global?: boolean;
+  customLogger?: MessagingLogger | object;
 }

src/index.ts

@@ -28,3 +28,6 @@ export * from './normalizer/message-normalizer';
 export * from './exception-listener/exception-listener';
 export * from './exception-listener/exception-context';
 export * from './exception/handlers.exception';
+export * from './logger/log';
+export * from './logger/messaging-logger';
+export * from './logger/nest-logger';

src/messaging.module.ts

@@ -4,7 +4,6 @@ import {
   Logger as NestCommonLogger,
   Module,
   OnApplicationBootstrap,
-  OnApplicationShutdown,
   OnModuleDestroy,
   Provider,
 } from '@nestjs/common';
@@ -20,7 +19,6 @@ import { Service } from './dependency-injection/service';
 import { CompositeChannelFactory } from './channel/factory/composite-channel.factory';
 import { ChannelRegistry } from './channel/channel.registry';
 import { CompositeMessageBusFactory } from './bus/composite-message-bus.factory';
-import { MessagingLogger } from './logger/messaging-logger';
 import { DistributedMessageBus } from './bus/distributed-message.bus';
 import { DiscoveryModule, DiscoveryService, ModuleRef } from '@nestjs/core';
 import { InMemoryMessageBus } from './bus/in-memory-message.bus';
@@ -44,6 +42,7 @@ import { NormalizerRegistry } from './normalizer/normalizer.registry';
 import { ObjectForwardMessageNormalizer } from './normalizer/object-forward-message.normalizer';
 import { ExceptionListenerRegistry } from './exception-listener/exception-listener.registry';
 import { ExceptionListenerHandler } from './exception-listener/exception-listener-handler';
+import { MessagingLogger } from './logger/messaging-logger';
 
 @Module({})
 export class MessagingModule
@@ -168,6 +167,21 @@ export class MessagingModule
       };
     };
 
+    const loggerProvider = (
+      options.customLogger && typeof options.customLogger === 'function'
+        ? { provide: Service.LOGGER, useClass: options.customLogger }
+        : {
+            provide: Service.LOGGER,
+            useValue:
+              options.customLogger ??
+              new NestLogger(
+                new NestCommonLogger(),
+                options.debug ?? false,
+                options.logging ?? true,
+              ),
+          }
+    ) as Provider;
+
     return {
       global: options.global ?? true,
       module: MessagingModule,
@@ -203,14 +217,7 @@ export class MessagingModule
           },
           inject: [Service.CHANNELS, Service.LOGGER],
         },
-        {
-          provide: Service.LOGGER,
-          useValue: new NestLogger(
-            new NestCommonLogger(),
-            options.debug ?? false,
-            options.logging ?? true,
-          ),
-        },
+        loggerProvider,
         HandlerMiddleware,
         CompositeChannelFactory,
         CompositeMessageBusFactory,