chore: update environment configuration and dependencies

- Updated .env.sample with new logging and tracing configurations, including Grafana Loki and OpenTelemetry settings.
- Bumped dependencies for @opentelemetry packages to the latest versions, enhancing monitoring capabilities.
- Modified logger configuration to support basic authentication for Loki.
- Updated README to reflect new features and setup instructions for Grafana Cloud integration.
- Removed deprecated preview features from Prisma schema.

This commit improves the overall observability and configuration management of the NestJS Prisma API project.

Author: iamnivekx

.env.sample

@@ -3,34 +3,32 @@
 
 # Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
 # See the documentation for all the connection string options: https://pris.ly/d/connection-strings
-
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD=postgres
-POSTGRES_DB=nestjs_api
-POSTGRES_HOST="127.0.0.1"
-DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:5432/${POSTGRES_DB}?schema=public
-# DATABASE_URL="postgresql://[email protected]:5432/nestjs_api?schema=public"
+DATABASE_URL="postgresql://postgres:[email protected]:5432/nestjs-api?schema=public"
 
 # HTTP
 NODE_ENV=development
 HTTP_PORT=4000
 
 # Log
-LOG_LOKI="http://192.168.1.4:3100"
 LOG_LEVEL=debug
-LOG_FILE=./logs/combined.log
+LOG_FILE="./logs/combined.log"
+LOG_LOKI_HOST="https://logs-prod-020.grafana.net"
+LOG_LOKI_USERNAME="you id"
+LOG_LOKI_PASSWORD="token"
 
 # OTLP
-OTLP_SERVICE_NAME="prisma-api"
+OTLP_SERVICE_NAME='prisma-api'
 OTLP_PROM_PORT=8081
-OTLP_TRACES_ENDPOINT="http://192.168.1.4:4318/v1/traces"
+OTEL_EXPORTER_OTLP_ENDPOINT="https://otlp-gateway-prod-ap-southeast-1.grafana.net/otlp"
+OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
+OTEL_EXPORTER_OTLP_HEADERS="Authorization=Basic you key"
 
 # JWT
 JWT_SECRET_KEY=jwt_secret
-JWT_EXPIRE_IN="7d"
+JWT_EXPIRE_IN='7d'
 
 # Redis
-REDIS_URL="redis://192.168.1.4:6379"
+REDIS_URL="redis://127.0.0.1:6379"
 
 # Google auth
 GOOGLE_CLIENT_ID=

README.md

@@ -1,130 +1,210 @@
-# Nestjs Prisma Template
+# NestJS Prisma API Template
 
-This is an opinionated template for Nestjs prisma restful projects.
+A modern RESTful API template built with NestJS and Prisma, featuring comprehensive monitoring, logging, and deployment solutions.
 
-## Features
+## ✨ Features
 
-- [x] Platform: [Express](https://expressjs.com/)
-- [x] Database:
-  - [x] ORM: [Prisma](https://prisma.io)
-  - [ ] Redis: [Redis](https://github.com/songkeys/nestjs-redis)
-- Cache Manager: [cache-manager](https://github.com/nestjs/cache-manager)
-- [x] Logger: [Pino](https://github.com/pinojs/pino)
+### 🚀 Core Technology Stack
 
-  - [nestjs-pino](https://github.com/iamolegga/nestjs-pino)
-  - [rotating-file-stream](https://github.com/iccicci/rotating-file-stream)
-  - [pino-pretty](https://github.com/pinojs/pino-pretty) in development
-  - [pino-loki](https://github.com/Julien-R44/pino-loki)
+- **Framework**: [NestJS](https://nestjs.com/) + [Express](https://expressjs.com/)
+- **Database**: [Prisma](https://prisma.io) ORM
+- **Logging**: [Pino](https://github.com/pinojs/pino) + [nestjs-pino](https://github.com/iamolegga/nestjs-pino)
+- **Caching**: [cache-manager](https://github.com/nestjs/cache-manager)
 
-- [x] health
-- [x] Authentication: [Passport](https://github.com/nestjs/passport)
-  - JWT: [passport-jwt](https://www.passportjs.org/packages/passport-jwt/)
-  - Google: [passport-google-oauth20](https://www.passportjs.org/packages/passport-google-oauth20/)
-- [x] Swagger: [@nestjs/swagger](https://github.com/nestjs/swagger)
-- [x] Tracing: [nestjs-otel](https://github.com/pragmaticivan/nestjs-otel)
-  - [x] [grafana](https://grafana.com/docs/grafana/latest/)
-  - [x] [loki](https://grafana.com/docs/loki/latest/)
-  - [x] [prometheus](https://prometheus.io/)
-  - [x] [promtail](https://grafana.com/docs/loki/latest/send-data/promtail/)
-  - [x] [tempo](https://grafana.com/docs/tempo/latest)
-  - [x] [alertmanager](https://grafana.com/docs/grafana/latest/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/alertmanager/)
-- [x] k8s
+### 🔐 Authentication & Authorization
 
-## Guide
+- **Auth Strategy**: [Passport](https://github.com/nestjs/passport)
+  - JWT Authentication: [passport-jwt](https://www.passportjs.org/packages/passport-jwt/)
+  - Google OAuth: [passport-google-oauth20](https://www.passportjs.org/packages/passport-google-oauth20/)
 
-### Development
+### 📊 Monitoring & Observability
 
-Init environment variables:
+- **API Documentation**: [Swagger](https://github.com/nestjs/swagger)
+- **Distributed Tracing**: [OpenTelemetry](https://github.com/pragmaticivan/nestjs-otel)
+- **Metrics**: [Prometheus](https://prometheus.io/)
+- **Log Aggregation**: [Grafana Loki](https://grafana.com/docs/loki/latest/)
+- **Alerting**: [Alertmanager](https://grafana.com/docs/grafana/latest/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/alertmanager/)
+
+### 🐳 Deployment & Operations
+
+- **Containerization**: Docker + Docker Compose
+- **Orchestration**: Kubernetes configurations
+- **Health Checks**: Built-in health check endpoints
+
+## 🚀 Quick Start
+
+### Environment Setup
+
+1. **Clone the project**
 
 ```bash
-cp .env.example .env
+git clone <your-repo-url>
+cd nestjs-prisma-api
 ```
 
-Install dependencies:
+2. **Install dependencies**
 
 ```bash
 pnpm install
 ```
 
-Generate Prisma client:
+3. **Environment configuration**
 
 ```bash
-pnpm run prisma:migrate
+cp .env.example .env
+# Edit .env file to configure database connection and other settings
 ```
 
-Migrate database:
+4. **Database initialization**
 
 ```bash
+# Generate Prisma client
+pnpm run prisma:generate
+
+# Run database migrations
 pnpm run prisma:migrate:dev
 ```
 
-Run the app:
+5. **Start development server**
 
 ```bash
 pnpm run start:dev
 ```
 
-### Deployment with docker
+The application will start at `http://localhost:3000`, with Swagger documentation available at `http://localhost:3000/api`.
+
+## ⚙️ Configuration Guide
+
+### Grafana Cloud Configuration
+
+#### 1. Configure Loki Log Collection
+
+Visit [Grafana Cloud Logs]`https://grafana.com/orgs/{your-org-id}/hosted-logs/{your-dashboard-id}#sending-logs` to get configuration information.
+
+Configure in your `.env` file:
+
+```bash
+LOG_LOKI_HOST="your-loki-url"
+LOG_LOKI_USERNAME="your-username"
+LOG_LOKI_PASSWORD="Basic <Your Grafana.com API Token>"
+```
+
+#### 2. Configure OpenTelemetry Tracing
+
+Visit [Grafana Cloud OTLP]`https://grafana.com/orgs/{your-org-id}/stacks/{your-stack-id}/otlp-info` to get configuration information.
+
+Configure in your `.env` file:
+
+```bash
+OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
+OTEL_EXPORTER_OTLP_ENDPOINT="https://otlp-gateway-prod-ap-southeast-1.grafana.net/otlp"
+OTEL_EXPORTER_OTLP_HEADERS="Authorization=Basic {your-api-key}"
+```
+
+![Grafana Cloud](./docs/cloud.png)
+
+### Grafana Docker Environment
+
+Use [dockotlp](https://github.com/iamnivekx/dockotlp) to quickly set up a local monitoring environment:
+
+```bash
+git clone https://github.com/iamnivekx/dockotlp.git
+cd dockotlp
+docker compose up -d
+```
+
+## 🐳 Deployment
+
+### Docker Deployment
 
-Docker:
+1. **Build image**
 
 ```bash
 docker-compose build
 ```
 
-### start docker-compose
+2. **Start services**
 
 ```bash
 docker-compose up -d
 ```
 
-In Node.js Environment:
+### Production Deployment
+
+1. **Install dependencies and build**
 
 ```bash
 pnpm install
 pnpm run build
-pnpm run start:prod
 ```
 
-### Migrate database
-
-Development:
+2. **Start production service**
 
 ```bash
-pnpm run prisma:migrate:dev
+pnpm run start:prod
 ```
 
-Production:
+### Database Migrations
 
-```bash
-pnpm run prisma:migrate:deploy
-```
+- **Development**: `pnpm run prisma:migrate:dev`
+- **Production**: `pnpm run prisma:migrate:deploy`
+
+## 📸 Feature Preview
+
+### API Documentation (Swagger)
+
+![Swagger API Documentation](./docs/swagger.jpg)
+
+### OpenTelemetry Distributed Tracing
+
+![OpenTelemetry Tracing](./docs/opentelemetry.jpg)
 
-## Overview
+### Prometheus Metrics Monitoring
 
-swagger
+![Prometheus Monitoring](./docs/prom.jpg)
 
-![swagger](./docs/swagger.jpg)
+### Alert Management
 
-`opentelemetry`
+![Alert Management](./docs/alert.jpg)
 
-![opentelemetry](./docs/opentelemetry.jpg)
+### Kubernetes Deployment
 
-`prometheus`
+![Kubernetes](./docs/k8s.jpg)
+
+### Ingress Configuration
+
+![Ingress](./docs/ingress.jpg)
+
+## 📁 Project Structure
+
+```
+src/
+├── api/                    # API modules
+│   ├── auth/             # Authentication module
+│   ├── health/           # Health checks
+│   └── users/            # User management
+├── common/                # Common modules
+│   ├── constants/        # Constant definitions
+│   ├── decorators/       # Custom decorators
+│   └── guards/           # Guards
+├── config/                # Configuration module
+├── entities/              # Data entities
+├── prisma/                # Prisma configuration
+└── services/              # Business services
+```
 
-![prom](./docs/prom.jpg)
+## 🤝 Contributing
 
-`alerting`
-![alert](./docs/alert.jpg)
+Issues and Pull Requests are welcome!
 
-`k8s`
-![k8s](./docs/k8s.jpg)
+## 📄 License
 
-`ingress`
-![ingress](./docs/ingress.jpg)
+This project is licensed under the MIT License.
 
-## Acknowledgements
+## 🙏 Acknowledgments
 
-- [nestjs-prisma](https://github.com/notiz-dev/nestjs-prisma)
-- [nestjs-otel](https://github.com/pragmaticivan/nestjs-otel)
-- [nestjs-otel-prom-grafana-tempo](https://github.com/pragmaticivan/nestjs-otel-prom-grafana-tempo)
+- [grafana](https://grafana.com) - Grafana
+- [dockotlp](https://github.com/iamnivekx/dockotlp) - Docker OpenTelemetry Prometheus Loki Grafana environment
+- [nestjs-prisma](https://github.com/notiz-dev/nestjs-prisma) - NestJS Prisma integration
+- [nestjs-otel](https://github.com/pragmaticivan/nestjs-otel) - OpenTelemetry integration
+- [nestjs-otel-prom-grafana-tempo](https://github.com/pragmaticivan/nestjs-otel-prom-grafana-tempo) - Monitoring stack integration examples

docs/cloud.png

@@ -31,7 +31,7 @@
     "prisma:generate": "pnpm dlx prisma generate",
     "prisma:studio": "pnpm dlx prisma studio",
     "prisma:seed": "pnpm dlx prisma db seed",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "dependencies": {
     "@nestjs/cache-manager": "^2.3.0",
@@ -46,20 +46,20 @@
     "@nestjs/swagger": "^8.1.1",
     "@nestjs/terminus": "^10.3.0",
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.56.1",
-    "@opentelemetry/context-async-hooks": "1.30.1",
-    "@opentelemetry/core": "1.30.1",
-    "@opentelemetry/exporter-prometheus": "^0.200.0",
-    "@opentelemetry/exporter-trace-otlp-http": "^0.200.0",
-    "@opentelemetry/propagator-b3": "1.30.1",
-    "@opentelemetry/propagator-jaeger": "1.30.1",
-    "@opentelemetry/resources": "1.30.1",
-    "@opentelemetry/sdk-metrics": "1.30.1",
-    "@opentelemetry/sdk-node": "^0.200.0",
-    "@opentelemetry/sdk-trace-base": "1.30.1",
-    "@opentelemetry/semantic-conventions": "1.30.0",
-    "@prisma/client": "^5.22.0",
-    "@prisma/instrumentation": "^6.5.0",
+    "@opentelemetry/auto-instrumentations-node": "0.62.1",
+    "@opentelemetry/context-async-hooks": "2.0.1",
+    "@opentelemetry/core": "2.0.1",
+    "@opentelemetry/exporter-prometheus": "0.203.0",
+    "@opentelemetry/exporter-trace-otlp-http": "0.203.0",
+    "@opentelemetry/propagator-b3": "2.0.0",
+    "@opentelemetry/propagator-jaeger": "2.0.1",
+    "@opentelemetry/resources": "2.0.1",
+    "@opentelemetry/sdk-metrics": "2.0.1",
+    "@opentelemetry/sdk-node": "0.203.0",
+    "@opentelemetry/sdk-trace-base": "2.0.1",
+    "@opentelemetry/semantic-conventions": "1.36.0",
+    "@prisma/client": "^6.15.0",
+    "@prisma/instrumentation": "^6.15.0",
     "cache-manager": "^5.7.6",
     "cache-manager-ioredis-yet": "^2.1.2",
     "class-transformer": "^0.5.1",