@infineit/winston-logger 1.0.25 → 1.0.26

package/README.md

@@ -10,9 +10,14 @@
 
 ## Introduction
 
-This project implements a production-ready logger for Nest.js applications using Winston and Morgan on a clean architecture (Hexagonal Architecture).
+`@infineit/winston-logger` is a lightweight project for implements a production-ready logger for Nest.js applications using Winston, Morgan and Prisma. This package simplifies the setup of logger and provides configurable options for instrumenting your application.
 
-You can read a detailed explanation of the project on the following article: https://medium.com/p/d03e3bb56772/edit
+
+## Features
+
+- **Easy Integration**: Quickly integrate logger with winston for distributed log.
+- **Configurable**: Provides options to customize logger configuration.
+- **Lightweight**: Minimal dependencies and overhead.
 
 That implements a production-ready system advanced or basic Microservices or Monoliths projects applying concepts like:
 
@@ -22,42 +27,98 @@ That implements a production-ready system advanced or basic Microservices or Mon
 * Logging Rules
 * Log formatters
 
-## Project structure
+## Installation
 
-The project is structured in a Nest.js monorepo.
+* You can install this package using npm:
+  ```bash
+  npm install @infineit/winston-logger
+  ```
 
-The folder structure is as follows:
+  Or using Yarn:
+  ```bash
+  yarn add @infineit/winston-logger
+  ```  
 
-* **apps**: It contains the project's executable applications, in this case, the REST API.
-    * **api**: It contains the REST API developed with Nest.js.
-* **libs**: It contains the project packages or Bounded Contexts on a DDD language.
-  * **shared**: It contains the code of the Shared Kernel.
-      * **src**: It contains the source code.
-          * **config**: It contains de config module.
-          * **context**: It contains the context module.
-          * **logger**: It contains the logger module.
 
-## Key concepts
+## Usage
+
+### Basic Setup
+
+  To use `@infineit/winston-logger` in your NestJS application, simply import it of your `main.ts` file:
+
+  ```sh
+    import { NestjsLoggerServiceAdapter } from '@infineit/winston-logger';;
+  ```
+
+### Prerequisites
+
+- NestJS
+- Winston
+- morgon
+- prisma
+
+
+### Getting Started
+
+Follow these steps to set up and run logger. If all steps are followed correctly, logger should start without any issues:
+
+1. use logger after import in main.ts:
+
+    ```bash
+        const app = await NestFactory.create(AppModule, {bufferLogs: true });
+
+        app.useLogger(app.get(NestjsLoggerServiceAdapter));
+    ```
+
+2. import in app.module.ts:
+
+    ```bash
+      import { ContextModule, LoggerModule } from '@infineit/winston-logger';
+
+      @Module({
+        imports: [
+          ContextModule,
+          LoggerModule.forRoot(PrismaService),
+        ]
+      })
+    ```
+
+3. app.service.ts:
 
-### Architecture
+    ```bash
+      import Logger, { LoggerKey } from '@infineit/winston-logger';
 
-The project is structured on a Hexagonal Architecture, so it has the following layers:
+      constructor(@Inject(LoggerKey) private logger: Logger) {}
 
-* **Application**
-* **Domain**
-* **Infrastructure**
+      this.logger.info('I am an info message!', {
+            props: {
+                foo: 'bar',
+                baz: 'qux',
+            },
+        });
+    ```
 
-### Logging Libraries
+**Reminder**: Make sure prisma is initialize and winstonlog modal is running before starting your NestJS application to avoid initialization errors.
 
-We use Winston to manage the logs and Morgan to log the HTTP requests. All that is managed by the `LoggerModule`.
+## Configuration
 
-To manage Winston transports, we use the `WinstonLoggerTransportsKey` DI token that is defined on the `LoggerModule`.
+You can configure the Logger using environment variables in your `.env` file:
 
-### Decoupling Logging library
+- `NODE_ENV`: development / staging / testing / production.
+- `LOGGER_ORGANIZATION`: The name of your organization as it will appear in log.
+- `LOGGER_CONTEXT`: The name of your context as it will appear in log.
+- `LOGGER_APP`: The name of your app as it will appear in log.
+- `LOGGER_DATABASE_STORAGE`: True/False. Default True for production or testing, It will store log to database.
+- `LOGGER_LOG_LEVEL`: Default log level warn,error,fatal for production or testing, It will log.
+- `LOGGER_DURATION`: True/False. Default False, It will store request duration in database.
+- `LOGGER_DURATION_LOG_LEVEL`: Default log level warn,error,fatal for production or testing, It will calculate duration for request.
+- `LOGGER_CONSOLE_PRINT`: True/False. Default False for production or testing.
+- `LOGGER_LOG_IN_FILE`: True/False. Default False for production or testing.
+- `LOGGER_SLACK_INC_WEBHOOK_URL`: Slack url, eg. https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX.
 
-To decouple the Logging library from our domain, we have created a `Logger` interface that is implemented by the `WinstonLogger` class.
+## Project structure
 
-If we want to change the logging library, we only have to implement the `Logger` interface and update the dependecy on the `LoggerModule`.
+## Key concepts
 
 ### NestJS Logger
 
@@ -77,78 +138,47 @@ To add custom data to all the logs, we use a wrapper `LoggerContextWrapper`.
 
 That class is injected with a Transient scope. By that, we can get the caller class and add it to the logs.
 
-## Installation
-
-* Install dependencies
-  ```sh
-  yarn install
-  ```
-
-* Copy file .env.example a .env
-  ```sh
-  cp .env.example .env
-  ```
-
-* Start REST API
-  ```sh
-  yarn start:dev api
-  ```
-  
-* Test REST API
-  ```sh
-  curl -X GET http://localhost:3000
-  ```
-  
-* Test REST API with correlation ID
-  ```sh
-    curl -X GET http://localhost:3000 -H "x-correlation-id: 87815cc5-d0f2-41e5-a731-ac55bbb733e8"
-  ```
-## Publish on npm
+## Prisma Table
 
-* Build file through nestjs-logger/libs/shared/src
-  ```sh
-    yarn build
   ```
-
-* got to nestjs-logger/dist/libs/nestjs
-  ```sh
-    npm publish --access public
+      model winstonlog {
+          id_log        String   @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
+          level         String   @db.VarChar(80)
+          message       String   @db.Text
+          context       String?  @db.VarChar(255)
+          correlationId String?  @db.Uuid
+          sourceClass   String?  @db.VarChar(255)
+          props         Json?
+          organization  String?  @db.VarChar(40)
+          app           String?  @db.VarChar(40)
+          durationMs    Decimal? @default(0) @db.Decimal(10, 4)
+          stack         String?  @db.Text
+          label         String?  @db.VarChar(40)
+          timestamp     DateTime @default(now()) @db.Timestamptz(6)
+
+          @@schema("public")
+      }
   ```
+## Inspiration
 
-## Inspire by
+This project is inspired by the excellent work from:
 
-* https://github.com/jnm733/nestjs-logger/tree/main
- 
-* https://medium.com/@jose-luis-navarro/logging-on-nestjs-like-a-pro-with-correlation-ids-log-aggregation-winston-morgan-and-more-d03e3bb56772
+- [Medium](https://medium.com/@jose-luis-navarro/logging-on-nestjs-like-a-pro-with-correlation-ids-log-aggregation-winston-morgan-and-more-d03e3bb56772)
+- [Logger GitHub Repository](https://github.com/SigNoz/signoz)
+- [winston-pg GitHub Repository](https://github.com/InnovA2/winston-pg/tree/main)
 
-* https://github.com/InnovA2/winston-pg/tree/main
 
-## Prisma Table
+## Support
 
-  ```
-    model winstonlog {
-      id_log        String   @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
-      level         String   @db.VarChar(80)
-      message       String   @db.Text
-      context       String?  @db.VarChar(255)
-      correlationId String?  @db.Uuid
-      sourceClass   String?  @db.VarChar(255)
-      props         Json?
-      organization  String?  @db.VarChar(40)
-      app           String?  @db.VarChar(40)
-      durationMs    Decimal? @default(0) @db.Decimal(10, 4)
-      stack         String?  @db.Text
-      label         String?  @db.VarChar(40)
-      timestamp     DateTime @default(now()) @db.Timestamptz(6)
-
-      @@schema("public")
-    }
-  ```
+NestJS is an MIT-licensed open-source project that thrives with support from the community. If you’d like to contribute or sponsor, please [learn more here](https://docs.nestjs.com/support).
 
-## To do
+## License
 
-We will continue working on this project to add new features
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
 
-PRs are welcome!
+## Author
 
-- [ ] Add testing.
+Dharmesh Patel 🇮🇳 <br>
+- [GitHub](https://github.com/dharmesh-r-patel/nestjs-starter)
+- [LinkedIn](https://www.linkedin.com/in/dharmeshbbay)
+- [Instagram](https://www.instagram.com/dharmesh_numbertank)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infineit/winston-logger",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "description": "Enterprise-level logger integration package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",